From 678b506a8cf1b1d572125f52fc79f9ab010d86fe Mon Sep 17 00:00:00 2001 From: tastytea Date: Thu, 20 May 2021 04:30:31 +0200 Subject: [PATCH] Initial commit. - Add skeleton - Add command-line parsing --- .drone.yml | 85 ++++++ .editorconfig | 24 ++ .gitignore | 3 + AUTHORS | 1 + CMakeLists.txt | 28 ++ CODE_OF_CONDUCT.adoc | 49 +++ CONTRIBUTING.adoc | 37 +++ CREDITS | 20 ++ LICENSE | 661 ++++++++++++++++++++++++++++++++++++++++ README.adoc | 67 ++++ cmake/debug_flags.cmake | 62 ++++ src/CMakeLists.txt | 22 ++ src/main.cpp | 36 +++ src/options.cpp | 69 +++++ src/options.hpp | 32 ++ src/version.hpp.in | 20 ++ tests/CMakeLists.txt | 28 ++ tests/main.cpp | 3 + 18 files changed, 1247 insertions(+) create mode 100644 .drone.yml create mode 100644 .editorconfig create mode 100644 .gitignore create mode 100644 AUTHORS create mode 100644 CMakeLists.txt create mode 100644 CODE_OF_CONDUCT.adoc create mode 100644 CONTRIBUTING.adoc create mode 100644 CREDITS create mode 100644 LICENSE create mode 100644 README.adoc create mode 100644 cmake/debug_flags.cmake create mode 100644 src/CMakeLists.txt create mode 100644 src/main.cpp create mode 100644 src/options.cpp create mode 100644 src/options.hpp create mode 100644 src/version.hpp.in create mode 100644 tests/CMakeLists.txt create mode 100644 tests/main.cpp diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000..ea7b65b --- /dev/null +++ b/.drone.yml @@ -0,0 +1,85 @@ +# -*- fill-column: 1000 -*- +kind: pipeline +name: Build x86_64 + +volumes: +- name: debian-package-cache + host: + path: /var/cache/debian-package-cache + +trigger: + event: + exclude: + - tag + +steps: +- name: GCC 10 / clang 11 + image: debian:bullseye-slim + pull: always + environment: + CXX: g++-10 + CXXFLAGS: -pipe -O2 + DEBIAN_FRONTEND: noninteractive + LANG: C.utf8 + commands: + - rm /etc/apt/apt.conf.d/docker-clean + - alias apt-get='rm -f /var/cache/apt/archives/lock && apt-get' + - apt-get update -q + - apt-get install -qq build-essential cmake clang + - apt-get install -qq catch + - rm -rf build && mkdir -p build && cd build + - cmake -G "Unix Makefiles" -DWITH_TESTS=YES .. + - make VERBOSE=1 + - make install DESTDIR=install + - cd tests && ctest -V + - cd ../../ + - rm -rf build && mkdir -p build && cd build + - CXX="clang++" cmake -G "Unix Makefiles" -DWITH_TESTS=YES .. + - make VERBOSE=1 + - make install DESTDIR=install + - cd tests && ctest -V + volumes: + - name: debian-package-cache + path: /var/cache/apt/archives + +- name: GCC 7 / clang 6 + image: ubuntu:bionic + pull: always + environment: + CXX: g++-7 + CXXFLAGS: -pipe -O2 + DEBIAN_FRONTEND: noninteractive + LANG: C.utf8 + commands: + - rm /etc/apt/apt.conf.d/docker-clean + - alias apt-get='rm -f /var/cache/apt/archives/lock && apt-get' + - apt-get update -q + - apt-get install -qq build-essential cmake clang + - apt-get install -qq catch + - rm -rf build && mkdir -p build && cd build + - cmake -G "Unix Makefiles" -DWITH_TESTS=YES .. + - make VERBOSE=1 + - make install DESTDIR=install + - cd tests && ctest -V + - cd ../../ + - rm -rf build && mkdir -p build && cd build + - CXX="clang++" cmake -G "Unix Makefiles" -DWITH_TESTS=YES .. + - make VERBOSE=1 + - make install DESTDIR=install + - cd tests && ctest -V + volumes: + - name: debian-package-cache + path: /var/cache/apt/archives + +- name: notify + image: drillster/drone-email + pull: always + settings: + host: mail.tzend.de + from: drone@tzend.de + username: + from_secret: email_username + password: + from_secret: email_password + when: + status: [ changed, failure ] diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..fe6c4d8 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,24 @@ +# Configuration file for EditorConfig. +# More information is available under . + +root = true + +[*] +indent_style = space +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true +max_line_length = 80 + +[*.?pp] +indent_size = 4 +tab_width = 4 + +[{CMakeLists.txt,*.cmake}] +indent_size = 2 +tab_width = 2 + +[{*.qml,*.qrc}] +indent_size = 4 +tab_width = 4 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..830cc83 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/build/ +/doc/ +/examples/example99* diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..2369e6f --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +tastytea diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..8b661d1 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,28 @@ +cmake_minimum_required(VERSION 3.12...3.18) + +# Global build options. +set(CMAKE_BUILD_TYPE "Release" CACHE STRING "The type of build.") + +project(epubgrep + VERSION 0.0.0 + DESCRIPTION "Search tool for EPUB ebooks" + LANGUAGES CXX) + +list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake") + +# Project build options. +option(WITH_TESTS "Compile tests." NO) + +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +set(CMAKE_CXX_EXTENSIONS OFF) + +include(cmake/debug_flags.cmake) + +find_package(Boost 1.75.0 REQUIRED COMPONENTS program_options) + +add_subdirectory(src) + +if(WITH_TESTS) + add_subdirectory(tests) +endif() diff --git a/CODE_OF_CONDUCT.adoc b/CODE_OF_CONDUCT.adoc new file mode 100644 index 0000000..7a5d03c --- /dev/null +++ b/CODE_OF_CONDUCT.adoc @@ -0,0 +1,49 @@ +:contact-coc: tastytea@tastytea.de +:uri-coc-original: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +== Code of Conduct + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, education, ethnicity, gender identity and expression, level of +experience, nationality, personal appearance, race, religion, sex +characteristics, sexual identity and orientation or socio-economic status. + +=== Examples + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language. +* Being respectful of differing viewpoints and experiences. +* Gracefully accepting constructive criticism. +* Focusing on what is best for the community. +* Showing empathy towards other community members. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances. +* Trolling, insulting/derogatory comments, and personal attacks. +* Public or private harassment. +* Publishing others’ private information, such as a physical or electronic + address, without explicit permission. + +=== Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at {contact-coc}. + +All complaints will be reviewed and investigated and will result in a response +that is deemed necessary and appropriate to the circumstances. The project team +is obligated to maintain confidentiality with regard to the reporter of an +incident. + +=== Attribution + +This Code of Conduct is adapted from the link:{uri-coc-original}[Contributor +Covenant, version 1.4]. + +For answers to common questions about this code of conduct, see +link:https://www.contributor-covenant.org/faq[]. diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc new file mode 100644 index 0000000..cb04b24 --- /dev/null +++ b/CONTRIBUTING.adoc @@ -0,0 +1,37 @@ +:project: epubgrep +:uri-base: https://schlomp.space/tastytea/{project} +:uri-branch-main: {uri-base}/src/branch/main +:uri-coc: {uri-branch-main}/CODE_OF_CONDUCT.adoc +:contact-email: tastytea@tastytea.de +:contact-xmpp: {contact-email} +:contact-fediverse: https://likeable.space/users/tastytea +:uri-git-format-patch: https://git-scm.com/docs/git-format-patch +:uri-git-send-email: https://git-scm.com/docs/git-send-email + +== How to contribute + +Read the link:{uri-coc}[Code of Conduct]. + +=== Reporting bugs or suggesting enhancements + +Before reporting a bug, please +https://schlomp.space/tastytea/{project}/issues[perform a search] to see if the +problem has already been reported. If it has, add a comment to the existing +issue instead of opening a new one. Same for enhancements. + +You can also contact me via mailto:{contact-email}[E-Mail], +link:xmpp:{contact-xmpp}[XMPP] or the {contact-fediverse}[Fediverse] if you +don't want to open an account. + +=== Pull requests + +Please use similar coding conventions as the rest of the project. The basic rule +to remember is to write code in the same style as the existing/surrounding +code. + +Add a copyright line with the year, your name and your email address to the +files you edited. Add your name and email to +link:{uri-branch-main}/AUTHORS[AUTHORS]. Unless you don't want to. + +You can also send me your patches via mailto:{contact-email}[E-Mail], ideally +using link:{uri-git-send-email}[git send-email]. diff --git a/CREDITS b/CREDITS new file mode 100644 index 0000000..a8d4319 --- /dev/null +++ b/CREDITS @@ -0,0 +1,20 @@ +epubgrep makes direct use of the following libraries and programs: + + C++ and the C++ standard library + From: The C++ committee and community, implemented by various projects. + https://isocpp.org/ + + CMake + From: Kitware and community + https://cmake.org/ + License: Custom license + https://github.com/Kitware/CMake/blob/master/Copyright.txt + + Catch + From: Martin Hořeňovský and community + https://github.com/catchorg/Catch2 + License: BSL-1.0 + + Boost + From: Boost organization and community + License: BSL-1.0 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..cc90223 --- /dev/null +++ b/README.adoc @@ -0,0 +1,67 @@ += epubgrep +:showtitle: +:toc: preamble +:project: epubgrep +:uri-base: https://schlomp.space/tastytea/{project} +:uri-branch-main: {uri-base}/src/branch/main + +:uri-gcc: https://gcc.gnu.org/ +:uri-clang: https://clang.llvm.org/ +:uri-cmake: https://cmake.org/ +:uri-catch: https://github.com/catchorg/Catch2 + +*{project}* is a search tool for EPUB ebooks. + +== Install + +[alt="Packaging status" link=https://repology.org/project/epubgrep/versions] +image::https://repology.org/badge/vertical-allrepos/epubgrep.svg[] + +// === Gentoo + +// [source,shell] +// -------------------------------------------------------------------------------- +// eselect repository enable tastytea +// echo 'app-text/epubgrep' >> /etc/portage/package.accept_keywords/epubgrep +// emaint sync -r tastytea +// emerge -a app-text/epubgrep +// -------------------------------------------------------------------------------- + +=== From source + +==== Dependencies + +* Tested OS: Linux +* C\++ compiler with C++17 support (tested: link:{uri-gcc}[GCC] 7/10, + link:{uri-clang}[clang] 6/11) +* link:{uri-cmake}[CMake] (at least: 3.12) +* Optional + ** Tests: link:{uri-catch}[Catch] (tested: 2.5 / 1.2) + +==== Get sourcecode + +// ===== Release + +// Download the current release at link:{uri-base}/releases[schlomp.space]. + +===== Development version + +[source,shell] +-------------------------------------------------------------------------------- +git clone https://schlomp.space/tastytea/epubgrep.git +-------------------------------------------------------------------------------- + +==== Compile + +[source,shell] +-------------------------------------------------------------------------------- +mkdir -p build && cd build +cmake .. +cmake --build . -- --jobs=$(nproc --ignore=1) +-------------------------------------------------------------------------------- + +.CMake options: +* `-DCMAKE_BUILD_TYPE=Debug` for a debug build. +* `-DWITH_TESTS=YES` if you want to compile the tests. + +include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[] diff --git a/cmake/debug_flags.cmake b/cmake/debug_flags.cmake new file mode 100644 index 0000000..7390512 --- /dev/null +++ b/cmake/debug_flags.cmake @@ -0,0 +1,62 @@ +# Set compiler flags for Debug builds. +# Only has an effect on GCC/Clang >= 5.0. + +set(tmp_CXXFLAGS "") +set(tmp_LDFLAGS "") + +if(CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang" + AND NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "5") + list(APPEND tmp_CXXFLAGS + "-Wall" + "-Wextra" + "-Wpedantic" + "-Wuninitialized" + "-Wshadow" + "-Wnon-virtual-dtor" + "-Wconversion" + "-Wsign-conversion" + "-Wold-style-cast" + "-Wzero-as-null-pointer-constant" + "-Wmissing-declarations" + "-Wcast-align" + "-Wunused" + "-Woverloaded-virtual" + "-Wdouble-promotion" + "-Wformat=2" + "-ftrapv" + "-fsanitize=undefined" + "-Og" + "-fno-omit-frame-pointer") + if(CMAKE_CXX_COMPILER_ID MATCHES "GNU") + list(APPEND tmp_CXXFLAGS + "-Wlogical-op" + "-Wuseless-cast") + if(NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "6") + list(APPEND tmp_CXXFLAGS + "-Wmisleading-indentation" + "-Wduplicated-cond" + "-Wnull-dereference") + if(NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "7") + list(APPEND tmp_CXXFLAGS + "-Wduplicated-branches") + endif() + endif() + endif() + add_compile_options("$<$:${tmp_CXXFLAGS}>") + + list(APPEND tmp_LDFLAGS + "-fsanitize=undefined") + # add_link_options was introduced in version 3.13. + if(${CMAKE_VERSION} VERSION_LESS 3.13) + set(CMAKE_SHARED_LINKER_FLAGS_DEBUG "${tmp_LDFLAGS}") + else() + add_link_options("$<$:${tmp_LDFLAGS}>") + endif() +else() + message(STATUS + "No additional compiler flags were set, " + "because your compiler was not anticipated.") +endif() + +unset(tmp_CXXFLAGS) +unset(tmp_LDFLAGS) diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt new file mode 100644 index 0000000..38162f2 --- /dev/null +++ b/src/CMakeLists.txt @@ -0,0 +1,22 @@ +include(GNUInstallDirs) + +configure_file("version.hpp.in" + "${CMAKE_CURRENT_BINARY_DIR}/version.hpp" @ONLY) + +add_executable(${PROJECT_NAME} main.cpp) + +file(GLOB_RECURSE sources_src *.cpp) +file(GLOB_RECURSE headers_src *.hpp) +target_sources(${PROJECT_NAME} + PRIVATE "${sources_src}" "${headers_src}") +unset(sources_src) +unset(headers_src) + +target_link_libraries(${PROJECT_NAME} + Boost::program_options) + +target_include_directories(${PROJECT_NAME} + PRIVATE "$") + +install(TARGETS ${PROJECT_NAME} + RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}") diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..2817a6a --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,36 @@ +/* This file is part of epubgrep. + * Copyright © 2021 tastytea + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, version 3. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +#include "options.hpp" + +#include +#include + +int main(int argc, char *argv[]) +{ + using std::cout; + + auto vm{epubgrep::parse_options(argc, argv)}; + + if (vm.count("help") + vm.count("version") > 0) + { + return EXIT_SUCCESS; + } + + cout << "extended-regexp: " << vm.count("extended-regexp") << '\n'; + cout << "perl-regexp: " << vm.count("perl-regexp") << '\n'; + cout << "ignore-case: " << vm.count("ignore-case") << '\n'; +} diff --git a/src/options.cpp b/src/options.cpp new file mode 100644 index 0000000..06f6081 --- /dev/null +++ b/src/options.cpp @@ -0,0 +1,69 @@ +/* This file is part of epubgrep. + * Copyright © 2021 tastytea + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, version 3. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +#include "options.hpp" + +#include "version.hpp" + +#include +#include +#include + +#include + +namespace epubgrep +{ + +namespace po = boost::program_options; +using std::cout; + +po::variables_map parse_options(int argc, char *argv[]) +{ + po::options_description desc("Available options"); + // clang-format off + desc.add_options() + ("help", "Prints help information") + ("version", "Prints version information") + ("extended-regexp", "PATTERNS are extended regular expressions") + ("perl-regexp", "PATTERNS are Perl regular expressions") + ("ignore-case", "Ignore case distinctions in patterns and data") + ; + // clang-format on + po::variables_map vm; + po::store(po::parse_command_line(argc, argv, desc), vm); + po::notify(vm); + + if (vm.count("help") != 0) + { + cout << "Usage: epubgrep [OPTION]… PATTERNS [FILE]…\n"; + cout << desc << '\n'; + } + else if (vm.count("version") != 0) + { + cout << "epubgrep " << epubgrep::version << '\n'; + cout << "Copyright © 2021 tastytea \n" + "License AGPLv3: GNU AGPL version 3 " + ".\n" + "This program comes with ABSOLUTELY NO WARRANTY. This is free " + "software,\n" + "and you are welcome to redistribute it under certain " + "conditions.\n"; + } + + return vm; +} + +} // namespace epubgrep diff --git a/src/options.hpp b/src/options.hpp new file mode 100644 index 0000000..aea8f2f --- /dev/null +++ b/src/options.hpp @@ -0,0 +1,32 @@ +/* This file is part of epubgrep. + * Copyright © 2021 tastytea + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, version 3. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +#ifndef EPUBGREP_OPTIONS_HPP +#define EPUBGREP_OPTIONS_HPP + +#include + +namespace epubgrep +{ + +namespace po = boost::program_options; + +//! Parse options and return them. +po::variables_map parse_options(int argc, char *argv[]); + +} // namespace epubgrep + +#endif // EPUBGREP_OPTIONS_HPP diff --git a/src/version.hpp.in b/src/version.hpp.in new file mode 100644 index 0000000..30b065c --- /dev/null +++ b/src/version.hpp.in @@ -0,0 +1,20 @@ +/*! + * @file + * + * @brief Version variables. + */ + +#ifndef EPUBGREP_VERSION_HPP +#define EPUBGREP_VERSION_HPP + +#include + +namespace epubgrep +{ + +//! The version of the program. +inline constexpr std::string_view version{"@PROJECT_VERSION@"}; + +} // namespace epubgrep + +#endif // EPUBGREP_VERSION_HPP diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt new file mode 100644 index 0000000..8261b1c --- /dev/null +++ b/tests/CMakeLists.txt @@ -0,0 +1,28 @@ +include(CTest) + +file(GLOB sources_tests test_*.cpp) + +find_package(Catch2 CONFIG) + +if(Catch2_FOUND) # Catch 2.x + include(Catch) + add_executable(all_tests main.cpp ${sources_tests}) + target_link_libraries(all_tests + PRIVATE Catch2::Catch2) + target_include_directories(all_tests PRIVATE "/usr/include/catch2") + catch_discover_tests(all_tests EXTRA_ARGS "${EXTRA_TEST_ARGS}") +else() # Catch 1.x + if(EXISTS "/usr/include/catch.hpp") + message(STATUS "Catch 1.x found.") + foreach(src ${sources_tests}) + get_filename_component(bin ${src} NAME_WE) + add_executable(${bin} main.cpp ${src}) + add_test(${bin} ${bin} "${EXTRA_TEST_ARGS}") + endforeach() + else() + message(FATAL_ERROR + "Neither Catch 2.x nor Catch 1.x could be found.") + endif() +endif() + +unset(sources_tests) diff --git a/tests/main.cpp b/tests/main.cpp new file mode 100644 index 0000000..e48147e --- /dev/null +++ b/tests/main.cpp @@ -0,0 +1,3 @@ +#define CATCH_CONFIG_MAIN + +#include