diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..96e3ce7 --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +mimas \ No newline at end of file diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -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/ChangeLog b/ChangeLog new file mode 100644 index 0000000..d827e0b --- /dev/null +++ b/ChangeLog @@ -0,0 +1,448 @@ +2013-08-20 Fabrice THIROUX + + * .hgtags: + Added tag v0.5.0 for changeset c32044967c4d + [b11386081931] [tip] + + * menu.c: + No need to free reload_notify_id, this is done by + menu_cache_remove_reload_notify. + [c32044967c4d] [v0.5.0] + +2013-08-18 Fabrice THIROUX + + * archlinux/PKGBUILD: + removed from PKGBUILD. + [482c6b01756a] + + * Makefile, README.md, menu.c: + Add SVG support. Documentation updated (the unfinished installation + section was dropped off). + [11f48b6a2f4b] + + * README, README.md: + Documentation changed + [ea259bf1ef4d] + +2013-07-26 Fabrice THIROUX + + * archlinux/PKGBUILD: + PKGBUILD updated for Bitbucket + [16fb2c617efb] + +2013-07-16 Fabrice THIROUX + + * .hgtags: + Added tag v0.4.99 for changeset aec5f6b3bb4b + [2e6244b2b2fb] + + * ChangeLog, openbox-menu.h: + Bump to 0.4.99 + [aec5f6b3bb4b] [v0.4.99] + +2013-07-14 Fabrice THIROUX + + * Makefile: + Makefile: Add a test for xml output (xmllint) + [803dcfbcce0d] + +2013-07-13 Fabrice THIROUX + + * archlinux/PKGBUILD: + Add mercurial to makedepends + [0c72409539f6] + + * menu.c: + Fix a structure not zeroed, causing some internal flags to be set + [217aea6dd615] + +2013-06-02 Fabrice THIROUX + + * TODO: + TODO updated + [944c81cdb4e9] + + * Makefile, menu.c, openbox-menu.h: + If no menu is provided in the command line then applications.menu is + used (prefixed by XDG_MENU_PREFIX env. variable content if defined). + The presence of the menu is tested. + [223c0985f5d0] + +2013-05-26 Fabrice THIROUX + + * TODO: + TODO added + [ca7e1b36c225] + + * menu.c: + Fix non persistent mode + header typo causing an invalid xml output + [4059fb079edb] + + * arch/PKGBUILD, archlinux/PKGBUILD: + arch directory renamed as archlinux + [82d6115c0900] + + * arch/PKGBUILD: + PKGBUILD: added conflicts and provides keys + [850f4c8cd3c6] + + * arch/PKGBUILD: + PKGBUILD: updated for mercurial version + [35d948d8b998] + +2013-01-05 Fabrice THIROUX + + * Makefile: + Makefile: set CC to gcc. Stripping extra infos from executable when + invoking 'make install'. + [9b1bd4c57d2c] + +2013-01-03 Fabrice THIROUX + + * menu.c: + Comments + [b54094e2979d] + +2013-01-02 Fabrice THIROUX + + * menu.c: + Fix the type of menu_cache_add_reload_notify callback + [8530e4ad953a] + + * menu.c: + reload_notify_id needed to be freed + [4cee4b95a6bf] + + * menu.c, openbox-menu.h: + Most of global variables were moved into a structure. Now a pointer + is passed to functions that need some of theses values. + [b15eb042ec76] + + * menu.c: + gdk_init () is not needed + [cd40b9606841] + + * menu.c: + Typo + [010a2e5db613] + +2012-12-02 mimas + + * arch/PKGBUILD: + PKGBUILD updated (md5sums) + [015af8afb723] + + * .hgtags: + Added tag v0.3.6.8 for changeset 64441862ddf4 + [ff110661f841] + + * ChangeLog, Makefile, arch/PKGBUILD, menu.c: + Fix the bug causing openbox-menu to not show the menu with menu- + cache 0.4.x + [64441862ddf4] [v0.3.6.8] + +2012-11-25 Pierre Ferry + + * arch/PKGBUILD: + Update PKGBUILD + [3cdda94758d1] + +2012-06-30 mimas + + * Makefile: + Oops, restoring commented line in Makefile + [84d5728c5105] + + * Makefile, menu.c: + -i (--no-icons) makes its comeback + [2506108c7569] + + * arch/PKGBUILD: + Add gtk2 dep in PKGBUILD + [5a0b8f077c35] + + * Makefile, README, menu.c: + Add a flag to compile openbox-menu without icons (it has disapeared + in a misterious way) + [044afe1a1c01] + +2012-05-07 mimas + + * ChangeLog, Makefile: + Add a Makefile rule to build an up-to-date changelog. I may remember + to use it before a new release. :) + [3a4a6b33befb] + + * Makefile: + /usr/local is the prefix by default. It can be changed by using + 'make install DESTDIR=/prefix' + [b7b0442c62e4] + + * Makefile: + Makefile changes + [32e13cd2f4cd] + + * menu.c, openbox-menu.h: + Fix copyright dates + [84f44c77d5f5] + + * Makefile: + Fix an unwanted error in make clean. + [2a651118b437] + +2012-05-06 mimas + + * arch/PKGBUILD: + Add a PKGBUILD for Archlinux. + [b2f1e85c112c] + +2012-05-04 mimas + + * .hgtags: + Added tag v0.3.6.7 for changeset 8aec06a01452 + [101270e8be5a] + + * openbox-menu.h: + Bump to 0.3.6.7 + [8aec06a01452] [v0.3.6.7] + + * THANKS: + THANKS file added + [a1ef762d1bad] + +2012-04-28 mimas + + * Makefile: + An install rule was added (Makefile) + [d7413d3d4f9d] + +2012-02-20 mimas + + * Makefile, menu.c: + Patch for Makefile from Sławomir Nizio + [2096818a39ce] + +2012-01-01 mimas + + * menu.c: + Adding GError for g_option_context_parse + [73ddcc292ef7] + +2011-12-28 mimas + + * menu.c: + Comment removed + [2ff237350f5a] + +2011-12-25 mimas + + * menu.c: + Handle SIGINT & SIGTERM signals to make a g_main_loop_quit + [ed49034d2062] + +2011-12-21 mimas + + * Makefile, menu.c, openbox-generator.c, openbox-menu.h: + Major code modification, nearly a complete rewrite of openbox-menu. + - use of GString for the menupipe content. + - add a persistent mode. + - can write the XML into a file. + - many fixes and code rewrite. + - startup notification is back. + - ... + [e4e3a596ffd9] + +2011-12-18 mimas + + * Makefile, menu.c, openbox-generator.c: + Add a conditional flag that permits to compile openbox-menu without + gtk and icons + [0f22230ff265] + +2011-11-13 Fabrice THIROUX + + * .hgtags: + Added tag v0.3.6.6 for changeset 989c9da7fd1d + [e2e768ef9148] + + * openbox-menu.h: + Bump to 0.3.6.6 + [989c9da7fd1d] [v0.3.6.6] + + * menu.c: + Fix a comment + [df37bffd2646] + + * menu.c: + 2nd fallback added, now every entry should have its icon + [25ef8cb10dae] + + * menu.c: + fallback for icon search + [ce0ba620bc2a] + + * menu.c: + use of strrchr() + [0d0d4fd67e3c] + +2011-11-07 Fabrice THIROUX + + * .hgtags: + Added tag v0.3.6.4 for changeset 2cc5c76a2581 + [a7cd8e156735] + + * .hgtags: + Added tag v0.3.6.5 for changeset a68d53a9e5a3 + [cc713467b019] + + * .hgtags: + Added tag v0.3.6.3 for changeset ce182c3b44d0 + [fbdebfd4f3da] + +2011-11-06 mimas + + * .hgtags: + Added tag v0.3.6.1 for changeset 85b6eda07d65 + [eec07eb13f24] + + * .hgtags: + Added tag v0.3.6 for changeset 607cb011a046 + [15ca70f8c5ef] + +2011-10-15 mimas + + * menu.c: + Change the way Exec field codes should be treated. I have to RTFM + more often, it was written in Freedesktop specification file. Stupid + me! + [20649de297ef] + + * menu.c: + Exec parsing now stops on % or " signs. This prevents this kind of + bug: http://ctkarch.org/forum/viewtopic.php?id=2&t_id=136 + + I'm not very happy with this solution as it may remove some extra + args but arguments between double quotes, not "%X" freedesktop- + likes, should be very rare in .desktop files. + [3d3fa658da9f] + +2011-08-31 mimas + + * openbox-menu.h: + Bump to 0.3.6.5 + [a68d53a9e5a3] [v0.3.6.5] + + * menu.c, openbox-generator.c, openbox-menu.h: + Fix horrible programming syntax (thanks CaliméroTeknik) + get_icon_path() replaced by get_item_icon_path(). It makes calls to + this function a lot shorter. + [006b8a7fc5a0] + + * menu.c: + sakura replaced by xterm + [d933c131cd55] + +2011-08-29 mimas + + * openbox-menu.h: + Bump to 0.3.6.4 + [2cc5c76a2581] [v0.3.6.4] + + * menu.c, openbox-generator.c, openbox-menu.h: + Menu generation is now separated from "core" engine. + [45f256d024ba] + +2011-08-21 mimas + + * menu.c: + Using a sync method for generating the menu + Various minor changes + in code. + [da239c6a084b] + +2011-08-11 mimas + + * menu.c: + Bump to version 0.3.6.3 + [ce182c3b44d0] [v0.3.6.3] + + * menu.c: + gtk_icon_theme_lookup_icon should not fail to lookup current theme + icon. + [fd7a645c3d6f] + +2011-08-06 mimas + + * menu.c: + g_error() -> g_warning() + [8fed260dbbef] + + * menu.c: + Who needs a break here? + [c3ffbf0723fe] + + * menu.c: + Support for startup-notification removed. It is buggy with openbox + 3.50 and I don't even know the real utility of SN. Some old code + related to LXDE desktop removed too. + [9fee09f25373] + +2011-08-06 mimasgpc + + * menu.c: + A menu error message more explicit + [6e00f27f9150] + + * menu.c: + I didn't really love the old code formatting. Get back to a more + concise one + [ce2cf4d5636d] + +2011-08-03 mimas + + * Makefile: + Fix new dependencies in Makefile + [88a797541092] + + * menu.c: + Big code changes, to much to write about it. + + Feature added : icons in menus. Yes ! (openbox 3.5.0 required) New + dependencies : gtk+ 2 and gdk. + [096517229b57] + +2011-03-15 mimas + + * menu.c: + Bump to 0.3.6.1 + [85b6eda07d65] [v0.3.6.1] + + * ChangeLog: + Changelog updated + [4794d87aebbb] + +2011-03-11 mimas + + * menu.c: + (re)fix goption flags + [9e0c23a3e6f9] + + * menu.c: + GOptionContext warning fixes (glib 2.28) + [59eca416e9c0] + +2011-02-20 mimas + + * menu.c: + Fix headers and change some formating + [f1ce9d7a9423] + +2011-02-15 mimas + + * menu.c: + Bump to 0.3.6 + [607cb011a046] [v0.3.6] + + * .hgignore, AUTHORS, COPYING, ChangeLog, Makefile, menu.c: + First commit + [236107f09e6c] + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..b091dca --- /dev/null +++ b/Makefile @@ -0,0 +1,46 @@ +LIBS= `pkg-config --libs glib-2.0 gtk+-2.0 libmenu-cache` +CFLAGS+= -g -Wall `pkg-config --cflags glib-2.0 gtk+-2.0 libmenu-cache` +CC=gcc +#-DG_DISABLE_DEPRECATED + +# Comment this line if you don't want icons to appear in menu +CFLAGS+=-DWITH_ICONS +# Uncomment this line if Openbox can display SVG icons +# Check SVG support with '$ ldd /usr/bin/openbox | grep svg', librsvg must appear.. +# CFLAGS+=-DWITH_SVG + +prefix= /usr/local +DESTDIR ?= $(prefix) +BINDIR= ${DESTDIR}/bin + +SRC= $(shell ls *.c 2> /dev/null) +OBJ= $(SRC:.c=.o) + +all: $(OBJ) openbox-menu + +%.o: %.c + $(CC) $(CFLAGS) -c $< -o $@ + +openbox-menu: $(OBJ) + $(CC) $(OBJ) -o openbox-menu $(LDFLAGS) $(LIBS) + +.PHONY: clean install doc changelog check + +clean: + @rm -f *.o openbox-menu + @rm -rf doc + +install: + @strip -s openbox-menu + @install -Dm 755 openbox-menu $(BINDIR)/openbox-menu + +doc: + robodoc --src . --doc doc/ --multidoc --index --html --cmode + +check: openbox-menu + ./openbox-menu > test.xml + xmllint test.xml + rm test.xml + +changelog: + @hg log --style changelog > ChangeLog diff --git a/README.md b/README.md new file mode 100644 index 0000000..25cf888 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +Openbox-menu is a pipemenu for Openbox window manager. It provides a dynamic +menu listing installed applications. Most of the work is done by the LXDE +library menu-cache. + +# Compilation. + +Type `make` then, with superuser privileges, `make install` to install it. +openbox-menu is installed in /usr/local/bin directory by default.type +`make install DESTDIR=/usr` to install it to /usr/bin/directory. + +## Compile openbox-menu without icons ## + +Openbox-menu shows icons before categories name and applications name (in +fact, the menu and the icons are displayed by Openbox; Openbox-menu +only outputs text content). You can remove icon support by editing the +Makefile and commenting the following line (add a # in the begining) + + CFLAGS+=-DWITH_ICONS + +If errors occur while compiling, remove gtk+-2.0 from lines above the one +you have previously commented. + +## SVG support + +Openbox can displays SVG icons since version 3.5.1. SVG support in openbox-menu +has to be activated in Makefile by decommenting the following line + + CFLAGS+=-DWITH_SVG + +It will be activated by default in the future. + diff --git a/THANKS b/THANKS new file mode 100644 index 0000000..0b8c0ee --- /dev/null +++ b/THANKS @@ -0,0 +1,4 @@ +The author of openbox-menu would like to thank: +- the authors of Openbox, the great WM +- the authors of menucache (LXDE Project) +- the people that helped me to give more love to openbox-menu by providing patches, ideas or by finding bugs. diff --git a/TODO b/TODO new file mode 100644 index 0000000..feb8d72 --- /dev/null +++ b/TODO @@ -0,0 +1,2 @@ +List of things to do: + * fix glib error when aborting openbox-menu diff --git a/debian/README.source b/debian/README.source new file mode 100644 index 0000000..d0ee125 --- /dev/null +++ b/debian/README.source @@ -0,0 +1,7 @@ +openbox-menu for Debian +----------------------- + +Both the "archlinux" directory as well as the Mercuial VCS +files have been removed from the original tarball. + + -- Mateusz Łukasik Fri, 01 Nov 2013 15:59:43 +0100 diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 0000000..d17dd55 --- /dev/null +++ b/debian/changelog @@ -0,0 +1,5 @@ +openbox-menu (0.5.0-1) unstable; urgency=low + + * Initial release. (Closes: #671862) + + -- Mateusz Łukasik Fri, 01 Nov 2013 14:17:43 +0100 diff --git a/debian/compat b/debian/compat new file mode 100644 index 0000000..ec63514 --- /dev/null +++ b/debian/compat @@ -0,0 +1 @@ +9 diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..d409c74 --- /dev/null +++ b/debian/control @@ -0,0 +1,17 @@ +Source: openbox-menu +Section: x11 +Priority: optional +Maintainer: Mateusz Łukasik +Build-Depends: debhelper (>= 9), libgtk2.0-dev, libmenu-cache-dev, libglib2.0-dev +Standards-Version: 3.9.5.0 +Homepage: https://bitbucket.org/fabriceT/openbox-menu +Vcs-Browser: https://github.com/mati75/openbox-menu.git +Vcs-Git: git://github.com/mati75/openbox-menu.git + +Package: openbox-menu +Architecture: any +Depends: ${misc:Depends}, ${shlibs:Depends}, openbox +Description: openbox pipe-menu to display entries in *.desktop files + openbox-menu is a pipemenu for the openbox window manager. It provides + a dynamic menu listing of installed applications. Most of the work is + done by the LXDE library menu-cache. diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 0000000..be0e780 --- /dev/null +++ b/debian/copyright @@ -0,0 +1,28 @@ +Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: openbox-menu +Source: https://bitbucket.org/fabriceT/openbox-menu/downloads + +Files: * +Copyright: 2012-2013, mimas +License: GPL-3+ + +Files: debian/* +Copyright: 2013, Mateusz Łukasik +License: GPL-3+ + +License: GPL-3+ + 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 package; if not, write to the Free Software Foundation, Inc., 51 Franklin + St, Fifth Floor, Boston, MA 02110-1301 USA + . + On Debian systems, the full text of the GNU General Public License version 3 + can be found in the file `/usr/share/common-licenses/GPL-3'. diff --git a/debian/openbox-menu.1 b/debian/openbox-menu.1 new file mode 100644 index 0000000..a496936 --- /dev/null +++ b/debian/openbox-menu.1 @@ -0,0 +1,45 @@ +.TH OPENBOX-MENU "1" "November 2013" +.SH NAME +openbox-menu \- Openbox pipe-menu to display entries in *.desktop files +.SH DESCRIPTION +.SS "Usage:" +.TP +openbox\-menu [OPTION...] [file.menu] +.SS "Help Options:" +.TP +\fB\-h\fR, \fB\-\-help\fR +Show help options +.SS "Application Options:" +.TP +\fB\-c\fR, \fB\-\-comment\fR +Show generic name instead of application name +.TP +\fB\-t\fR, \fB\-\-terminal\fR=\fIcmd\fR +Terminal command (default xterm \fB\-e\fR) +.TP +\fB\-g\fR, \fB\-\-gnome\fR +Show GNOME entries +.TP +\fB\-k\fR, \fB\-\-kde\fR +Show KDE entries +.TP +\fB\-x\fR, \fB\-\-xfce\fR +Show XFCE entries +.TP +\fB\-r\fR, \fB\-\-rox\fR +Show ROX entries +.TP +\fB\-p\fR, \fB\-\-persistent\fR +stay active +.TP +\fB\-s\fR, \fB\-\-sn\fR +Enable startup notification +.TP +\fB\-o\fR, \fB\-\-output\fR +file to write data to +.TP +\fB\-i\fR, \fB\-\-noicons\fR +Don't display icons in menu +.PP +This manual page was written by Mateusz Łukasik , +for the Debian project (and may be used by others). diff --git a/debian/openbox-menu.manpages b/debian/openbox-menu.manpages new file mode 100644 index 0000000..ebcf570 --- /dev/null +++ b/debian/openbox-menu.manpages @@ -0,0 +1 @@ +debian/openbox-menu.1 diff --git a/debian/patches/debian_build.patch b/debian/patches/debian_build.patch new file mode 100644 index 0000000..7dbb1fe --- /dev/null +++ b/debian/patches/debian_build.patch @@ -0,0 +1,32 @@ +Description: Make makefile compatible with Debian's standards. +Author: Mateusz Łukasik + +--- a/Makefile ++++ b/Makefile +@@ -7,9 +7,9 @@ CC=gcc + CFLAGS+=-DWITH_ICONS + # Uncomment this line if Openbox can display SVG icons + # Check SVG support with '$ ldd /usr/bin/openbox | grep svg', librsvg must appear.. +-# CFLAGS+=-DWITH_SVG ++CFLAGS+=-DWITH_SVG + +-prefix= /usr/local ++prefix= /usr + DESTDIR ?= $(prefix) + BINDIR= ${DESTDIR}/bin + +@@ -37,10 +37,10 @@ install: + doc: + robodoc --src . --doc doc/ --multidoc --index --html --cmode + +-check: openbox-menu +- ./openbox-menu > test.xml +- xmllint test.xml +- rm test.xml ++#check: openbox-menu ++# ./openbox-menu > test.xml ++# xmllint test.xml ++# rm test.xml + + changelog: + @hg log --style changelog > ChangeLog diff --git a/debian/patches/series b/debian/patches/series new file mode 100644 index 0000000..b4feaaa --- /dev/null +++ b/debian/patches/series @@ -0,0 +1 @@ +debian_build.patch diff --git a/debian/rules b/debian/rules new file mode 100755 index 0000000..26fc74c --- /dev/null +++ b/debian/rules @@ -0,0 +1,10 @@ +#!/usr/bin/make -f + +%: + dh $@ + +override_dh_installman: + dh_installman + +override_dh_builddeb: + dh_builddeb -- -Zxz -z9 diff --git a/debian/source/format b/debian/source/format new file mode 100644 index 0000000..163aaf8 --- /dev/null +++ b/debian/source/format @@ -0,0 +1 @@ +3.0 (quilt) diff --git a/debian/source/options b/debian/source/options new file mode 100644 index 0000000..74a452b --- /dev/null +++ b/debian/source/options @@ -0,0 +1,2 @@ +compression = "xz" +compression-level = 9 diff --git a/debian/watch b/debian/watch new file mode 100644 index 0000000..a67712f --- /dev/null +++ b/debian/watch @@ -0,0 +1,2 @@ +version=3 +https://bitbucket.org/fabriceT/openbox-menu/downloads/openbox-menu-([\d.]+).tar.bz2 diff --git a/menu.c b/menu.c new file mode 100644 index 0000000..4551f76 --- /dev/null +++ b/menu.c @@ -0,0 +1,579 @@ +// openbox-menu - a dynamic menu for openbox +// Copyright (C) 2010-12 mimas +// +// 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; version 3 of the License. +// +// 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, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +// MA 02110-1301, USA. + +#include +#include +#include +#ifdef WITH_ICONS + #include +#endif +#include +#include +#include +#include +#include + +#include "openbox-menu.h" + +GMainLoop *loop = NULL; +#ifdef WITH_ICONS + GtkIconTheme *icon_theme; +#endif + +/* from lxsession */ +void sig_term_handler (int sig) +{ + g_warning ("Aborting"); + g_main_loop_quit (loop); +} + +/****f* openbox-menu/get_safe_name + * FUNCTION + * Convert &, <, > and " signs to html entities + * + * OUTPUT + * A gchar that needs to be freed. + ****/ +gchar * +get_safe_name (const char *name) +{ + g_return_val_if_fail (name != NULL, NULL); + + GString *cmd = g_string_sized_new (256); + + for (;*name; ++name) + { + switch(*name) + { + case '&': + g_string_append (cmd, "&"); + break; + case '<': + g_string_append (cmd, "<"); + break; + case '>': + g_string_append (cmd, ">"); + break; + case '"': + g_string_append (cmd, ""e;"); + break; + default: + g_string_append_c (cmd, *name); + } + } + return g_string_free (cmd, FALSE); +} + + +/****f* openbox-menu/clean_exec + * FUNCTION + * Remove %f, %F, %u, %U, %i, %c, %k from exec field. + * None of theses codes are interesting to manage here. + * %i, %c and %k codes are implemented but don't ask why we need them. :) + * + * OUTPUT + * A gchar that needs to be freed. + * + * NOTES + * %d, %D, %n, %N, %v and %m are deprecated and should be removed. + * + * SEE ALSO + * http://standards.freedesktop.org/desktop-entry-spec/latest/ar01s06.html + ****/ +gchar * +clean_exec (MenuCacheApp *app) +{ + gchar *filepath = NULL; + const char *exec = menu_cache_app_get_exec (MENU_CACHE_APP(app)); + GString *cmd = g_string_sized_new (64); + + for (;*exec; ++exec) + { + if (*exec == '%') + { + ++exec; + switch (*exec) + { + /* useless and commonly used codes */ + case 'u': + case 'U': + case 'f': + case 'F': break; + /* deprecated codes */ + case 'd': + case 'D': + case 'm': + case 'n': + case 'N': + case 'v': break; + /* Other codes, more or less pointless to implement */ + case 'c': + g_string_append (cmd, menu_cache_item_get_name (MENU_CACHE_ITEM(app))); + break; +#if WITH_ICONS + case 'i': + if (get_item_icon_path (MENU_CACHE_ITEM(app))) + { + g_string_append_printf (cmd, "--icon %s", + get_item_icon_path (MENU_CACHE_ITEM(app))); + } + break; +#endif + case 'k': + filepath = menu_cache_item_get_file_path (MENU_CACHE_ITEM(app)); + if (filepath) + { + g_string_append (cmd, filepath); + g_free (filepath); + } + break; + /* It was not in the freedesktop specification. */ + default: + g_string_append_c (cmd, '%'); + g_string_append_c (cmd, *exec); + break; + + } + } + else + g_string_append_c (cmd, *exec); + } + return g_strchomp (g_string_free (cmd, FALSE)); +} + +#if WITH_ICONS +/****f* openbox-menu/get_item_icon_path + * OUTPUT + * return the path for the themed icon if item. + * If no icon found, it returns the "empty" icon path. + * + * The returned string should be freed when no longer needed + * + * NOTES + * Imlib2, used by OpenBox to display icons, doesn't load SVG graphics. + * We have to use GTK_ICON_LOOKUP_NO_SVG flag to look up icons. + * + * TODO + * The "2nd fallback" is annoying, I have to think about this. + ****/ +gchar * +get_item_icon_path (MenuCacheItem *item) +{ + GtkIconInfo *icon_info = NULL; + gchar *icon = NULL; + gchar *tmp_name = NULL; + + const gchar *name = menu_cache_item_get_icon (MENU_CACHE_ITEM(item)); + + if (name) + { + if (g_path_is_absolute (name)) + return g_strdup (name); + + /* We remove the file extension as gtk_icon_theme_lookup_icon can't + * lookup a theme icon for, ie, 'geany.png'. It has to be 'geany'. + */ + tmp_name = strndup (name, strrchr (name, '.') - name); + #ifdef WITH_SVG + icon_info = gtk_icon_theme_lookup_icon (icon_theme, tmp_name, 16, GTK_ICON_LOOKUP_GENERIC_FALLBACK); + #else + icon_info = gtk_icon_theme_lookup_icon (icon_theme, tmp_name, 16, GTK_ICON_LOOKUP_NO_SVG | GTK_ICON_LOOKUP_GENERIC_FALLBACK); + #endif + g_free (tmp_name); + } + + if (!icon_info) /* 2nd fallback */ + icon_info = gtk_icon_theme_lookup_icon (icon_theme, "empty", 16, GTK_ICON_LOOKUP_NO_SVG); + + icon = g_strdup (gtk_icon_info_get_filename (icon_info)); + gtk_icon_info_free (icon_info); + + return icon; +} +#endif /* WITH_ICONS */ + + +guint +app_is_visible(MenuCacheApp *app, guint32 de_flag) +{ + gint32 flags = menu_cache_app_get_show_flags (app); + + if (flags < 0) + return !(- flags & de_flag); + else + return menu_cache_app_get_is_visible(MENU_CACHE_APP(app), de_flag); +} + + +/****f* openbox-menu/menu_directory + * FUNCTION + * create a menu entry for a directory. + * + * NOTES + * this menu entry has to be closed by "". + ****/ +void +menu_directory (MenuCacheApp *dir, OB_Menu *context) +{ + gchar *dir_id = get_safe_name (menu_cache_item_get_id (MENU_CACHE_ITEM(dir))); + gchar *dir_name = get_safe_name (menu_cache_item_get_name (MENU_CACHE_ITEM(dir))); + +#ifdef WITH_ICONS + if (!context->no_icons) + { + gchar *dir_icon = get_item_icon_path (MENU_CACHE_ITEM(dir)); + + g_string_append_printf (context->builder, + "\n", + dir_id, dir_name, dir_icon); + g_free (dir_icon); + } + else +#endif + { + g_string_append_printf (context->builder, + "\n", + dir_id, dir_name); + } + + g_free (dir_id); + g_free (dir_name); +} + + +/****f* openbox-menu/menu_application + * FUNCTION + * create a menu entry for an application. + ****/ +void +menu_application (MenuCacheApp *app, OB_Menu *context) +{ + gchar *exec_name = NULL; + gchar *exec_icon = NULL; + gchar *exec_cmd = NULL; + + /* is comment (description) or name displayed ? */ + if (context->comment && menu_cache_item_get_comment (MENU_CACHE_ITEM(app))) + exec_name = get_safe_name (menu_cache_item_get_comment (MENU_CACHE_ITEM(app))); + else + exec_name = get_safe_name (menu_cache_item_get_name (MENU_CACHE_ITEM(app))); + + exec_cmd = clean_exec (app); + +#ifdef WITH_ICONS + if (!context->no_icons) + { + exec_icon = get_item_icon_path (MENU_CACHE_ITEM(app)); + g_string_append_printf (context->builder, + "", + exec_name, + exec_icon); + } + else +#endif + { + g_string_append_printf (context->builder, + "", + exec_name); + } + + if (context->sn && menu_cache_app_get_use_sn (app)) + g_string_append (context->builder, + "yes"); + + if (menu_cache_app_get_use_terminal (app)) + g_string_append_printf (context->builder, + "\n\n", + context->terminal_cmd, + exec_cmd); + else + g_string_append_printf (context->builder, + "\n\n", + exec_cmd); + + g_free (exec_name); + g_free (exec_icon); + g_free (exec_cmd); +} + + +/****f* openbox-menu/generate_openbox_menu + * FUNCTION + * main routine of menu creation. + * + * NOTES + * It calls itself when 'dir' type is MENU_CACHE_TYPE_DIR. + ****/ +void +generate_openbox_menu (MenuCacheDir *dir, OB_Menu *context) +{ + GSList *l = NULL; + + for (l = menu_cache_dir_get_children (dir); l; l = l->next) + switch ((guint) menu_cache_item_get_type (MENU_CACHE_ITEM(l->data))) + { + case MENU_CACHE_TYPE_DIR: + menu_directory (l->data, context); + generate_openbox_menu (MENU_CACHE_DIR(l->data), context); + g_string_append (context->builder, "\n"); + break; + + case MENU_CACHE_TYPE_SEP: + g_string_append (context->builder, "\n"); + break; + + case MENU_CACHE_TYPE_APP: + if (app_is_visible (MENU_CACHE_APP(l->data), 0)) + menu_application (l->data, context); + } +} + + +/****f* openbox-menu/display_menu + * FUNCTION + * it begins and closes the menu content, write it into a file or + * display it. + * + * INPUTS + * * menu + * * file, the filename where the menu content should be written to. + * If file is 'NULL' then the menu content is displayed. + * + * NOTES + * A 16 KiB GString is allocated for the content of the pipemenu. + * This should be enough prevent too many allocations while building + * the XML. + * + * The size of the XML file created is around 8 KB in my computer but + * I don't have a lot of applications installed. + ****/ +void +display_menu (MenuCache *menu, OB_Menu *context) +{ + MenuCacheDir *dir = menu_cache_get_root_dir (menu); + if (G_UNLIKELY(dir == NULL)) + { + g_warning ("Can't get menu root dir"); + return; + } + + GSList *l = menu_cache_dir_get_children (dir); + + if (g_slist_length (l) != 0) { + context->builder = g_string_sized_new (16 * 1024); + g_string_append (context->builder, + "\n"); + generate_openbox_menu(dir, context); + g_string_append (context->builder, ""); + + gchar *buff = g_string_free (context->builder, FALSE); + + /* Has menu content to be saved in a file ? */ + if (context->output) + { + if (!g_file_set_contents (context->output, buff, -1, NULL)) + g_warning ("Can't write to %s\n", context->output); + else + g_message ("wrote to %s", context->output); + } + else /* No, so it's displayed on screen */ + g_print ("%s", buff); + + g_free (buff); + } + else + g_warning ("Cannot create menu, check if the .menu file is correct"); +} + + +gchar * +get_application_menu (void) +{ + gchar menu[APPMENU_SIZE]; + + gchar *xdg_prefix = getenv("XDG_MENU_PREFIX"); + if (xdg_prefix) + { + g_snprintf (menu, APPMENU_SIZE, "%sapplications.menu", xdg_prefix); + } + else + g_strlcpy (menu, "applications.menu", APPMENU_SIZE); + + return strdup (menu); +} + + +gboolean +check_application_menu (gchar *menu) +{ + gchar *menu_path = g_build_filename ("/etc","xdg", "menus", menu, NULL); + if (!g_file_test (menu_path, G_FILE_TEST_EXISTS)) + { + g_print ("File %s doesn't exists. Can't create menu\n", menu_path); + g_free (menu_path); + return FALSE; + } + else + { + g_free (menu_path); + return TRUE; + } +} + + +int +main (int argc, char **argv) +{ + + gpointer reload_notify_id = NULL; + GError *error = NULL; + gchar *menu = NULL; + OB_Menu ob_context = { 0 }; + + gboolean show_gnome = FALSE; + gboolean show_kde = FALSE; + gboolean show_xfce = FALSE; + gboolean show_rox = FALSE; + gboolean persistent = FALSE; + gchar **app_menu = NULL; + gchar *output = NULL; + gchar *terminal = "xterm -e"; + /* + * TODO: Registered OnlyShowIn Environments + * Ref: http://standards.freedesktop.org/menu-spec/latest/apb.html + * + * GNOME GNOME Desktop + * KDE KDE Desktop + * LXDE LXDE Desktop + * MATE MATÉ Desktop + * Razor Razor-qt Desktop + * ROX ROX Desktop + * TDE Trinity Desktop + * Unity Unity Shell + * XFCE XFCE Desktop + * Old Legacy menu systems + */ + GOptionEntry entries[] = { + { "comment", 'c', 0, G_OPTION_ARG_NONE, &ob_context.comment, + "Show generic name instead of application name", NULL }, + { "terminal", 't', 0, G_OPTION_ARG_STRING, &terminal, + "Terminal command (default xterm -e)", "cmd" }, + { "gnome", 'g', 0, G_OPTION_ARG_NONE, &show_gnome, + "Show GNOME entries", NULL }, + { "kde", 'k', 0, G_OPTION_ARG_NONE, &show_kde, + "Show KDE entries", NULL }, + { "xfce", 'x', 0, G_OPTION_ARG_NONE, &show_xfce, + "Show XFCE entries", NULL }, + { "rox", 'r', 0, G_OPTION_ARG_NONE, &show_rox, + "Show ROX entries", NULL }, + { "persistent",'p', 0, G_OPTION_ARG_NONE, &persistent, + "stay active", NULL }, + { "sn", 's', 0, G_OPTION_ARG_NONE, &ob_context.sn, + "Enable startup notification", NULL }, + { "output", 'o', 0, G_OPTION_ARG_STRING, &output, + "file to write data to", NULL }, + { "noicons", 'i', 0, G_OPTION_ARG_NONE, &ob_context.no_icons, + "Don't display icons in menu", NULL }, + { G_OPTION_REMAINING, 0, 0, G_OPTION_ARG_STRING_ARRAY, &app_menu, + NULL, "[file.menu]" }, + {NULL} + }; + GOptionContext *help_context = NULL; + + setlocale (LC_ALL, ""); + + help_context = g_option_context_new (" - Openbox menu generator " VERSION); + g_option_context_set_help_enabled (help_context, TRUE); + g_option_context_add_main_entries (help_context, entries, NULL); + g_option_context_parse (help_context, &argc, &argv, &error); + + if (error) + { + g_print ("%s\n", error->message); + g_error_free (error); + return 1; + } + + g_option_context_free (help_context); + +#ifdef WITH_ICONS + gtk_init (&argc, &argv); + icon_theme = gtk_icon_theme_get_default (); +#endif + + if (output) + ob_context.output = g_build_filename (g_get_user_cache_dir (), output, NULL); + else + ob_context.output = NULL; + + if (terminal) + ob_context.terminal_cmd = terminal; + + if (show_gnome) ob_context.show_flag |= SHOW_IN_GNOME; + if (show_kde) ob_context.show_flag |= SHOW_IN_KDE; + if (show_xfce) ob_context.show_flag |= SHOW_IN_XFCE; + if (show_rox) ob_context.show_flag |= SHOW_IN_ROX; + + if (!app_menu) + menu = get_application_menu (); + else + menu = strdup (*app_menu); + + if (!check_application_menu (menu)) + return 1; + + // wait for the menu to get ready + MenuCache *menu_cache = menu_cache_lookup_sync (menu); + if (!menu_cache ) + { + g_free (menu); + g_warning ("Cannot connect to menu-cache :/"); + return 1; + } + + // display the menu anyway + display_menu(menu_cache, &ob_context); + + if (persistent) + { + // menucache used to reload the cache after a call to menu_cache_lookup* () + // It's not true anymore with version >= 0.4.0. + reload_notify_id = menu_cache_add_reload_notify (menu_cache, + (MenuCacheReloadNotify) display_menu, + &ob_context); + + // install signals handler + signal (SIGTERM, sig_term_handler); + signal (SIGINT, sig_term_handler); + + // run main loop + loop = g_main_loop_new (NULL, FALSE); + g_main_loop_run (loop); + g_main_loop_unref (loop); + + menu_cache_remove_reload_notify (menu_cache, reload_notify_id); + } + + menu_cache_unref (menu_cache); + g_free (menu); + g_free (ob_context.output); + + return 0; +} diff --git a/openbox-menu.h b/openbox-menu.h new file mode 100644 index 0000000..9e36d6e --- /dev/null +++ b/openbox-menu.h @@ -0,0 +1,36 @@ +/* + * openbox-menu.h - this file is part of openbox-menu + * Copyright (C) 2011,12 mimas + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published + * by the Free Software Foundation; version 3.0 only. + * + * 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#define VERSION "0.5.0" + +#define APPMENU_SIZE 30 + +guint app_is_visible(MenuCacheApp *, guint32); +gchar *get_item_icon_path (MenuCacheItem*); + +typedef struct { + /* Configuration */ + gchar *output; + guint32 show_flag; + GString *builder; /* */ + gchar *terminal_cmd; /* command to launch program in a terminal */ + gboolean comment; /* display description instead of name */ + gboolean sn; /* startup notification */ + gboolean no_icons; /* icons disabled */ +} OB_Menu;