diff --git a/COPYING.txt b/COPYING.txt new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/COPYING.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is 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. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + 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. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + 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 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. Use with the GNU Affero General Public License. + + 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 Affero 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 special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 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 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 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 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + 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 GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Info.plist b/Info.plist new file mode 100644 index 0000000..71930ba --- /dev/null +++ b/Info.plist @@ -0,0 +1,44 @@ + + + + + CFBundleGetInfoString + ramanpdf + CFBundleExecutable + ramanpdf + CFBundleIdentifier + org.ramanpdf.www + CFBundleDisplayName + ramanpdf + CFBundleName + ramanpdf + CFBundleIconFile + ramanpdf.icns + CFBundleDocumentTypes + + + CFBundleTypeName + PDF + CFBundleTypeRole + Viewer + LSItemContentTypes + + com.adobe.pdf + + LSHandlerRank + Alternate + + + CFBundleShortVersionString + 0.01 + CFBundleInfoDictionaryVersion + 6.0 + CFBundlePackageType + APPL + IFMajorVersion + 0 + IFMinorVersion + 1 + + diff --git a/README.md b/README.md new file mode 100644 index 0000000..169404e --- /dev/null +++ b/README.md @@ -0,0 +1,185 @@ +# README +A toy PDF viewer I made as a learning project -- `ramanpdf.app`. + +Since I do not have the xcode IDE, I explored alternatives and found +the trio of Vala compiler, GTK4, and Poppler. +This project took me on a happy journey of discovery. +To share the lessons I learnt, I put it here on github for like-minded +people who are possibly in search of a similar solution. + +## What I wanted +1. A PDF viewer with simple key-press control. +2. GUI application that runs on OSX Big Sur without showing the terminal. +3. Able to call it from OSX Finder's "Open With" context menu. +4. Can switch between a "light" and a "dark" mode. +5. Can be put on one side of the screen, so that I can take notes with + another app on the other side. +6. Able to rotate and zoom the pdf page. + +## Features +1. No menu. +2. Key-press commands: + * 'o' opens a FileDialog to choose the PDF file. + * '=' to zoom in. + * '-' to zoom out. + * '0' to reset zoom. + * ' ' (space) to cycle forward through the pages. + * 't' to rotate 90 degrees clockwise each time. + * 'd' to toggle between color and grayscale. + * 'i' to flip color or grayscale to their opposites. + * 'q' to quit. +3. Scrolling is restricted to panning the one page within the window. + Scrollbar(s) appear when the page is too big for the window. +4. Grey background when no file; or when PDF is a damaged file (or not PDF). +5. Handles opening of file from Finder (ie., it is *registered*). +6. Does not open multiple windows. + The single application window is recycled for each new file opened. +7. User can see highlights (but cannot add new highlight). +8. Window title can be empty, a document file name, or an error message. +9. Resizable window. + +## Limitations +1. Not app-sandboxed, hardened, notarised, or evaluated by gatekeeper. +2. No security measures to protect against cyber-attacks. +3. Not much error-handling. +4. A lag when rendering a 'busy' page (colorful or large image). +5. No key-press command to go back one page. +6. Content does not resize to window (ie., cannot zoom by resizing window). +7. User cannot select text or images for copying. +8. User cannot add highlights, annotations, bookmarks, or anything. +9. Does not respond to clicking URL inside the pdf. +10. Does not support "drag and drop". +11. In essence, whatever not mentioned in "Features" above. +12. Not tested on any OS besides Apple OSX 11.7.10 (Big Sur). + +## Ingredients +1. Compiler, tools, and libraries: Vala, GTK4, Poppler, pkg-config. +2. Code: `ramanpdf.vala`, `ramanpdf.icns`, `Info.plist`, `makefile`. +3. Optional: `svg2icns.sh` and `ramanpdf.svg`. + +## Mac App Bundling +* The makefile makes the app (`ramanpdf`) and packages it into + an app bundle (`ramanpdf.app`). + * An "App Bundle" is the result of Apple's way of arranging an app, + its linked libraries, app icon, and "configuration" file (pList) into + a folder structure with a `.app` suffix -- that we have come to know + as an OSX Application. + * When a app bundle is run, it no longer shows a Terminal window. + * The makefile simply copies `ramanpdf`, `ramanpdf.icns`, and `Info.plist`; + and pastes them into the folder structure of an app bundle. + * It also copies the relevant dynamic libraries (of GTK4 and Poppler) + and pastes them to the folder structure; and finally tells `ramanpdf` + how to find them within the app bundle. + * To tell `ramanpdf` how to find the libraries, it uses OSX's `otool` to + find the libraries that `ramanpdf` links to, then it selects the ones + that are not built-in (which would be the GTK and Poppler libraries), + and uses OSX's `install_name_tool` to tell `ramanpdf` about the new + paths of the libraries. + * Although 'otool' and 'install_name_tool' are both built-in OSX programs, + I am not certain whether this part of the make process will work for + other OSX versions. + (Easy to check whether your OSX have these, by typing `which otool` in + the Terminal. Similarly, for install_name_tool). + * The `list.txt` is generated by the makefile and it lists all the + libraries that are to be copied to the app bundle. +* Accessories: + * Inkscape (for designing the app bundle icon as an Inkscape SVG file). + * zsh shell file [svg2icns.sh]( + https://gist.github.com/ikey4u/659f38b4d7b3484d0b55de85a55a8154) + (for making icns file from the SVG above). + It uses Inkscape to convert the SVG into multiple PNG files, each of + a different size, and after that it uses OSX built-in `iconutil` to + group these PNG files into a single ICNS file. + +## How I built the application and the OSX app bundle +1. Set up: + * I developed on OSX Big Sur (and not sure if it works on others). + * I used [homebrew](https://brew.sh) to install Vala, GTK4, and Poppler. + * I used [homebrew](https://brew.sh) to install `pkg-config`. + * Since I am using homebrew's version of pkg-config, I must export a + PKG_CONFIG_PATH environment variable for each of `libffi` and `glib` + to ensure pkg-config looks for the correct libraries in the correct + paths. + This has been incorporated in the makefile. + * Optional (for designing the icon SVG file): + I used Inkscape to make `ramanpdf.svg`. + Then I used `svg2icns.sh` to make `ramanpdf.icns`. +2. Build: + * I used `make` instead of the `meson` and `ninja` that came with the + homebrew installation of `gtk4`. + (It might be easier to build by using the latter two but I am less + familiar with them than with `make`). + * Run `make` to build *everything*: + * `ramanpdf` - this runs with Terminal showing. + * `list.txt` - this is just a by-product of the build process. + * `ramanpdf.app` - this runs without Terminal showing. + * Instead, to just build the app that can be called from Terminal + and not for registering with OSX Finder, run `make ramanpdf`. + If things go well, a file named `ramanpdf` should appear. + You can then run it using the command `./ramanpdf` in Terminal. + Or, double-click on `ramanpdf` in Finder. + * The Terminal `ramanpdf` accepts a single argument of file name. + For example, run `./ramanpdf filename.pdf` to open said pdf file. + +## Install App Bundle and Register with OSX Finder +1. Copy `ramanpdf.app` to the Applications folder to install. + And then double-click on it (ie., run it inside the Applications folder) + to register. +2. I take it as registered when the app window appears. +3. If registration went well, you should be able to see `ramanpdf.app` in + the context menu (test right-click on a file in Finder - look under + "Open With"). + +## Clean-up +1. To start over, run `make clean` to remove everything that was made. +2. The 'ramanpdf.app' can be removed from the Applications folder + the usual way if you do not want it anymore -- just delete it. + +## Release +I have uploaded my build of `ramanpdf` and `ramanpdf.app`. +But your OSX *might* say it comes from another computer and refuse to run +it for security reasons. +I mean, I have not tested on other people's Apple computers, so that is +why I included the word "might". + +My OSX did not complain about security, but probably because I build the +App Bundle on my OSX. +If you build it yourself on your own OSX, your OSX security *might* not +complain. + +## Acknowledgements +1. [Vala](https://vala-language.org) for taking the pain out of working + with C coding. +2. [GTK4](https://www.gtk.org) for making the GUI look like the native + OSX GUI and can be easily registered with OSX Finder. +3. [Poppler](https://poppler.freedesktop.org) for making it so easy to + incorporate PDF rendering into GTK4, using the poppler-glib API. +4. [Inkscape](https://inkscape.org) for making it possible to quickly + design a simple image file in SVG. +5. Many thanks to zhq/ikey4u, the author of [svg2icns.sh]( + https://gist.github.com/ikey4u/659f38b4d7b3484d0b55de85a55a8154) + for a wonderful shell script that streamlines my icon design workflow to + Inkscape and `iconutil` only. +6. This [GNOME discourse]( + https://discourse.gnome.org/t/using-filedialog-in-vala/15376) pointed + the way how to use the file dialog in Vala. +7. [Stackoverflow.com](https://stackoverflow.com). +8. [Apple StackExchange](https://apple.stackexchange.com). +9. Many other sources on the web that I have not mentioned here. + +## Bugs +1. Poppler (Cairo backend) [bug]( + https://gitlab.freedesktop.org/poppler/poppler/-/issues/1443) + related to an image in PDF file. + + +## DISCLAIMER +I am not a professional programmer; and I do not have any real software +industry exposure or experience. +I do not know what the relevant standards are; and I have not done strong +testing of this code and of this application. +As a consequence, I cannot guarantee that this application or the code +provided here is safe, error-free, or even harmless. + +Use at your own risk! + diff --git a/makefile b/makefile new file mode 100644 index 0000000..c83f4a6 --- /dev/null +++ b/makefile @@ -0,0 +1,29 @@ +DEST_DIR := ramanpdf.app/Contents/MacOS + +.PHONY: clean copying + +copying: list.txt ramanpdf + cp ramanpdf $(DEST_DIR)/ramanpdf + for lib in $$(cat list.txt); do \ + APP_LIB=$$(basename $$lib) ; \ + cp $$lib $(DEST_DIR)/ ; \ + install_name_tool -change $$lib @executable_path/$$APP_LIB $(DEST_DIR)/ramanpdf ; \ + done + cp Info.plist ramanpdf.app/Contents/Info.plist + mkdir ramanpdf.app/Contents/Resources + cp ramanpdf.icns ramanpdf.app/Contents/Resources/ramanpdf.icns + +list.txt: ramanpdf + $(eval USR_OPT=$(shell otool -L ramanpdf | cut -f 1 -d " " | tr -d "[:blank:]" | grep '^\/usr\/local\/opt' )) + echo $(USR_OPT) > list.txt + +ramanpdf: ramanpdf.vala + export PKG_CONFIG_PATH=$$PKG_CONFIG_PATH:/usr/local/opt/libffi/lib/pkgconfig ; \ + export PKG_CONFIG_PATH=$$PKG_CONFIG_PATH:/usr/local/Cellar/glib/2.78.0/lib/pkgconfig; \ + valac --Xcc=-headerpad_max_install_names --pkg poppler-glib --pkg glib-2.0 --pkg gtk4 -o ramanpdf ramanpdf.vala + mkdir -p $(DEST_DIR) + +clean: + rm -f ramanpdf + rm -fr ramanpdf.app + rm -f list.txt diff --git a/ramanpdf.icns b/ramanpdf.icns new file mode 100644 index 0000000..b57bcf8 Binary files /dev/null and b/ramanpdf.icns differ diff --git a/ramanpdf.vala b/ramanpdf.vala new file mode 100644 index 0000000..48b16d1 --- /dev/null +++ b/ramanpdf.vala @@ -0,0 +1,318 @@ +/* + +ramanpdf.vala + +Copyright 2023 Roland Chee + +This program is distributed under the terms of the +GNU General Public Licence. + +This program is free software: you can redistribute it +and/or modify it under the terms of the GNU 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 General Public License for more details. + +You should have received a copy of the GNU General +Public License along with this program. If not, see +. + +*/ + +using Gtk; +using Poppler; + +int +main (string[] argv) +{ + + GLib.File gfile = null; + string doc_name = ""; + int rotate = 0; + int index = 0; + int n_pages = 0; + bool invert = false; + bool grayscale = false; + double scale = 1.0; + double pgw = 0.0; + double pgh = 0.0; + + Gtk.Application application = + new Gtk.Application ( + "org.ramanpdf.www", + GLib.ApplicationFlags.HANDLES_OPEN); + + // register with OSX to open file from Finder + // must be done here and + // cannot be done under startup + Value val = Value (GLib.Type.BOOLEAN); + val.set_boolean (true); + application.set_property ("register-session", val); + val.unset (); + + application.startup.connect (()=>{ + + // application accelerator action + GLib.SimpleAction action1 = + new GLib.SimpleAction ("actiona", null); + action1.activate.connect (()=>{ + //print("Action1\n"); + application.quit();}); + action1.set_enabled (true); + application.add_action (action1); + const string[] key1 = {"q"}; + application.set_accels_for_action ("app.actiona", key1); + + }); + + application.activate.connect (()=>{ + + // does not open any window + // but passes this to application.open + if (argv.length > 1) + { + GLib.File file = + GLib.File.new_for_commandline_arg (argv[1]); + application.open ({file},""); + return; + } + else { + application.open ({null},""); + return; + }; + + }); + + application.open.connect ((files, hint)=>{ + + // opens the window + gfile = files[0]; + + Gtk.ApplicationWindow window = null; + if (application.get_active_window () != null) + { + window = application.get_active_window () as + Gtk.ApplicationWindow; + } + else { + window = new Gtk.ApplicationWindow (application); + window.set_default_size (480, 360); + }; + + Gtk.ScrolledWindow screen = + new Gtk.ScrolledWindow (); + window.set_child (screen); + + Gtk.DrawingArea da = + new Gtk.DrawingArea (); + screen.set_child (da); + + da.set_draw_func ((da,cr,w,h)=>{ + + if (gfile == null) + { + cr.set_source_rgb (0.7,0.7,0.7); + cr.rectangle (0,0,w,h); + cr.fill (); + } + else + { + + try + { + Poppler.Document popdoc = + new Poppler.Document.from_gfile (gfile, + null, null); + + if (popdoc != null) + { + + // whether run from commandline or from inside app + // window title is set here + doc_name = gfile.get_basename (); + window.set_title (doc_name); + + n_pages = popdoc.get_n_pages (); + index %= n_pages; + + Poppler.Page poppage = + popdoc.get_page (index); + poppage.get_size (out pgw, out pgh); + + if ((rotate % 2) ==0) + { + da.set_content_width ((int)(pgw * scale)); + da.set_content_height((int)(pgh * scale)); + } + else + { + da.set_content_height((int)(pgw * scale)); + da.set_content_width ((int)(pgh * scale)); + }; + + Cairo.ImageSurface surface = + new Cairo.ImageSurface ( + Cairo.Format.ARGB32, + (int)(scale * pgw), + (int)(scale * pgh)); + Cairo.Context context = + new Cairo.Context (surface); + context.scale (scale,scale); + poppage.render (context); + switch (rotate) { + case 1: + cr.translate ( + (double)(scale*pgh), + (double)(scale*0)); + cr.rotate ((double)( 90*GLib.Math.PI/180)); + break; + case 2: + cr.translate ( + (double)(scale*pgw), + (double)(scale*pgh)); + cr.rotate ((double)(180*GLib.Math.PI/180)); + break; + case 3: + cr.translate ( + (double)(scale*0), + (double)(scale*pgw)); + cr.rotate ((double)(270*GLib.Math.PI/180)); + break; + default: + break; + }; + // lays an opaque white background + // because some PDF has transparent parts + cr.set_operator (Cairo.Operator.SOURCE); + cr.set_source_rgba (1,1,1,1); + cr.paint (); + // lays the PDF over the background + cr.set_operator (Cairo.Operator.OVER); + cr.set_source_surface (context.get_target (), 0, 0); + cr.paint (); + if (invert==true) + { + cr.set_operator (Cairo.Operator.DIFFERENCE); + cr.set_source_rgba (1,1,1,1); + cr.paint (); + }; + if (grayscale==true) + { + cr.set_operator (Cairo.Operator.HSL_SATURATION); + cr.set_source_rgba(0,0,0,1); + cr.paint (); + }; +/* + print("%d of %d pages\n", index+1, n_pages); + print("Cairo scale: %f\n", scale); + print("Cairo rotate: %d\n", rotate); + print("Poppler page width: %d, height: %d\n", + (int)pgw, (int)pgh); + print("DA Content width: %d, height: %d\n", + da.get_content_width (), + da.get_content_height ()); + print("Widget width: %d, height: %d\n", + screen.get_width(), + screen.get_height()); + print("R:%1.1f G:%1.1f B:%1.1f A:%1.1f\n", + red, green, blue, alpha); +*/ + + }; + + } + catch (GLib.Error e) + { + //print("Poppler: %s\n", e.message); + gfile = null; // stop repeating same error + doc_name = ""; + window.set_title (e.message); + }; + }; + }); + + Gtk.EventControllerKey eventkey = + new Gtk.EventControllerKey (); + eventkey.key_pressed.connect ((keyval, keycode, state)=>{ + //print ("keyval: %3u keycode: %3u\n", keyval, keycode); + //print ("keyval_name: %s\n", Gdk.keyval_name(keyval)); + switch (Gdk.keyval_name (keyval)){ + case "o": + FileDialog fileDialog = + new FileDialog (); + Cancellable cancellable = null; + fileDialog.set_accept_label ("open"); + fileDialog.open.begin (window, cancellable, + (obj,res)=>{ + try + { + gfile = fileDialog.open.end (res); + if (gfile != null) + { + //print ("File: %s\n", gfile.get_path ()); + da.queue_draw (); // window title is set there + }; + } + catch (GLib.Error e) + { + //print ("Open error: %s\n", e.message); + string error_message = e.message; + window.set_title (error_message); + } + }); + break; + case "equal": + scale += 0.1; + da.queue_draw (); + break; + case "minus": + scale -= 0.1; + if (scale < 0.1) {scale = 0.1;}; + da.queue_draw (); + break; + case "0": + scale = 1.0; + da.queue_draw (); + break; + case "space": + if ((gfile != null) && (n_pages != 0)) + { + index++; + index %= n_pages; + da.queue_draw (); + } + break; + case "i": + invert = !invert; + da.queue_draw (); + break; + case "t": + rotate++; + rotate %= 4; + da.queue_draw (); + break; + case "d": + grayscale = !grayscale; + da.queue_draw (); + break; + default: + break; + + }; + return true; + }); + screen.add_controller (eventkey); + + window.present (); + + }); + + var status = application.run (argv); + return status; +}