diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -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/example.py b/example.py index 62bcf2c..7919950 100644 --- a/example.py +++ b/example.py @@ -1,93 +1,229 @@ """ """ - +import json def test(): from idl_parser import parser _parser = parser.IDLParser() idl_str = ''' -module my_module { - struct Time { - long sec; - long usec; - }; - - enum UNION_DESCRIMINATOR_KIND - { - DESCRIMINATOR_UNKNOWN, - DESCRIMINATOR_ULONGLONG, - DESCRIMINATOR_LONGLONG, - DESCRIMINATOR_DOUBLE, - DESCRIMINATOR_STRING, - DESCRIMINATOR_KIND_COUNT - }; - - union UnionType switch( UNION_DESCRIMINATOR_KIND ) - { - case DESCRIMINATOR_UNKNOWN: - case DESCRIMINATOR_KIND_COUNT: - case DESCRIMINATOR_ULONGLONG: - unsigned long long ull_value; - case DESCRIMINATOR_LONGLONG: - long long ll_value; - case DESCRIMINATOR_DOUBLE: - double d_value; - case DESCRIMINATOR_STRING: - sequence str_value; - }; - - typedef sequence DoubleSeq; - - struct TimedDoubleSeq { - Time tm; - DoubleSeq data; - }; - - enum RETURN_VALUE { - RETURN_OK, - RETURN_FAILED, - }; - - interface DataGetter { - RETURN_VALUE getData(out TimedDoubleSeq data); - }; +#ifndef _JAUS_GLOBALLOITERDRIVER_INCLUDED_ +#define _JAUS_GLOBALLOITERDRIVER_INCLUDED_ + +module ext { + @annotation jaus_extends { + string value; + }; + @annotation jaus_presence_vector_field { + }; + @annotation jaus_recommended_query{ + string value; + }; +}; +struct Empty {}; + +struct JausAddress +{ + uint16 subsystem; + uint8 node; + uint8 component; +}; + +const JausAddress ANY_JAUS_ADDRESS = {0xff, 0xf, 0xf}; + +typedef uint16 JausMessageId; + +const JausMessageId ANY_JAUS_MESSAGE = 0xff; + +struct JausService { + //! Service URI + string<255> uRI; + //! Major version number of the service + @unit("one") uint8 majorVersionNumber; + //! Minor version number of the service + @unit("one") uint8 minorVersionNumber; +}; + +typedef map> JausServiceMap; + +struct HeaderRec +{ + short id; + sequence spoolIDRec_; +}; + + +@ext::jaus_extends("events") +module VelocityStateSensor { + struct QueryVelocityStateData { + + //! See Report Velocity State Message + @ext::jaus_presence_vector_field @unit("one") uint16 presenceVector; + }; + + struct QueryVelocityStateExtData { + struct QueryVelocityStateExtRec { + + //! Requested presence vector associated with the velocity variant + @ext::jaus_presence_vector_field @unit("one") uint8 velocityVarPresenceVector; + + //! Requested presence vector associated with the ReportVelocityStateExtRec + @ext::jaus_presence_vector_field @unit("one") uint16 reportVelocityStateExtRecPresenceVector; + }; + + QueryVelocityStateExtRec queryVelocityStateExtRec_; + }; + + struct ReportVelocityStateData { + @ext::jaus_presence_vector(16) + struct ReportVelocityStateRec { + @optional @range(min=-327.68, max=327.67) @bit_bound(32) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("meter per second") double gPSVelocityDown; + + //! An RMS value indicating the validity of the velocity data. + @optional @range(min=0.0, max=100.0) @bit_bound(32) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("meter per second") double velocity_RMS; + @optional @range(min=-32.768, max=32.767) @bit_bound(16) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("radian per second") double yawRate; + + //! An RMS value indicating the validity of the rotational velocity data. + @optional @range(min=0.0, max=3.141592653589793) @bit_bound(16) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("radian per second") double rate_RMS; + + /// {name="Milliseconds", from_index=0, to_index=9, lower_limit=0, upper_limit=999} + /// {name="Seconds", from_index=10, to_index=15, lower_limit=0, upper_limit=59} + /// {name="Minutes", from_index=16, to_index=21, lower_limit=0, upper_limit=59} + /// {name="Hour", from_index=22, to_index=26, lower_limit=0, upper_limit=23} + /// {name="Day", from_index=27, to_index=31, lower_limit=1, upper_limit=31} + //! + @optional uint32 timeStamp; + }; + + ReportVelocityStateRec reportVelocityStateRec_; + }; + + struct ReportVelocityStateExtData { + struct ReportVelocityStateExtSeq { + struct VelocityVehicleXYZRec { + @optional @range(min=-327.68, max=327.67) @bit_bound(32) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("meter per second") double gPSVelocityDown; + }; + + struct VelocityLocalXYZRec { + @optional @range(min=-327.68, max=327.67) @bit_bound(32) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("meter per second") double gPSVelocityDown; + }; + + struct VelocityNEDRec { + @optional @range(min=-327.68, max=327.67) @bit_bound(32) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("meter per second") double gPSVelocityDown; + }; + + union VelocityVar switch(uint8) { + case 0: VelocityVehicleXYZRec VelocityVehicleXYZRec_; + case 1: VelocityLocalXYZRec VelocityLocalXYZRec_; + case 2: VelocityNEDRec VelocityNEDRec_; + }; + + @ext::jaus_presence_vector(16) + struct ReportVelocityStateExtRec { + + //! An RMS value indicating the validity of the velocity data. + @optional @range(min=0.0, max=100.0) @bit_bound(32) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("meter per second") double velocity_RMS; + @optional @range(min=-32.768, max=32.767) @bit_bound(32) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("radian per second") double yawRate; + + //! An RMS value indicating the validity of the rotational velocity data. + @optional @range(min=0.0, max=100.0) @bit_bound(16) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("radian per second") double rate_RMS; + + //! Scalar speed measured relative to fixed coordinate system + @optional @range(min=-327.68, max=327.67) @bit_bound(16) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("meter per second") double speedOverGround; + + //! Scalar speed measured relative to medium, such as air or water currents + @optional @range(min=-327.68, max=327.67) @bit_bound(16) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("meter per second") double speedRelativeToMedium; + @optional @range(min=-1000.0, max=1000.0) @bit_bound(16) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("rotations per minute") double rotationsPerMinute; + @optional @range(min=-327.68, max=327.67) @bit_bound(16) @ext::jaus_integer @ext::jaus_integer_function("round") @unit("meter per second") double indicatedSpeed; + + //! UTC POSIX-style time in seconds since 1 January 1970 + @unit("second") uint32 gPSFixTimeSeconds; + + //! Nanoseconds component of POSIX-style time + @unit("one") uint32 gPSFixTimeNanoSeconds; + }; + + VelocityVar velocityVar_; + ReportVelocityStateExtRec reportVelocityStateExtRec_; + }; + + ReportVelocityStateExtSeq reportVelocityStateExtSeq_; + }; + + + @topic(name="QueryVelocityState", qosprofile="jaus_query", id=0x2404) + //! + //! This message shall cause the receiving component to reply to the requestor with a ID 4404h: + //! ReportVelocityState + //! (Deprecated) message. A logical AND shall be performed on the requested presence vector and + //! that representing + //! the available fields from the responder. The resulting message shall contain the fields + //! indicated by the result + //! of this logical AND operation. + //! + struct QueryVelocityState { + @key JausAddress source; + JausAddress destination; + @default(0x2404) int32 id; + QueryVelocityStateData value; + }; + + + + @topic(name="QueryVelocityStateExt", qosprofile="jaus_query", id=0x24A4) + //! + //! This message shall cause the receiving component to reply to the requestor with a ID 44A4h: + //! ReportVelocityStateExt + //! message. A logical AND shall be performed on the requested presence vector and that + //! representing the available + //! fields from the responder. The resulting message shall contain the fields indicated by the + //! result of this logical + //! AND operation. + //! + struct QueryVelocityStateExt { + @key JausAddress source; + JausAddress destination; + @default(0x24A4) int32 id; + QueryVelocityStateExtData value; + }; + + + + @topic(name="ReportVelocityState", qosprofile="jaus_report", id=0x4404) + //! + //! This message is used to provide the receiver the linear velocity and rotational rate of the + //! platform. + //! + struct ReportVelocityState { + @key JausAddress source; + JausAddress destination; + @default(0x4404) int32 id; + ReportVelocityStateData value; + }; + + + + @topic(name="ReportVelocityStateExt", qosprofile="jaus_report", id=0x44A4) + @ext::jaus_recommended_query("QueryGlobalLoiter") + //! + //! This message is used to provide the receiver the linear velocity and rotational rate of the + //! platform. All times are in Coordinated Universal Time (UTC). + //! + struct ReportVelocityStateExt { + @key JausAddress source; + JausAddress destination; + @default(0x44A4) int32 id; + ReportVelocityStateExtData value; + }; + + }; +#endif ''' global_module = _parser.load(idl_str) - my_module = global_module.module_by_name('my_module') - dataGetter = my_module.interface_by_name('DataGetter') - print 'DataGetter interface' - for m in dataGetter.methods: - print '- method:' - print ' name:', m.name - print ' returns:', m.returns.name - print ' arguments:' - for a in m.arguments: - print ' name:', a.name - print ' type:', a.type - print ' direction:', a.direction - - doubleSeq = my_module.typedef_by_name('DoubleSeq') - print 'typedef %s %s' % (doubleSeq.type.name, doubleSeq.name) - - unionType = my_module.union_by_name('UnionType') - print 'descriminator kind: %s' % unionType.descriminator_kind - for m in unionType.members: - print '- member:' - print ' name:', m.name - print ' type:', m.type.name - print 'descriminator value associations:' - for a in m.descriminator_value_associations: - print ' %s' % a - - timedDoubleSeq = my_module.struct_by_name('TimedDoubleSeq') - print 'TimedDoubleSeq' - for m in timedDoubleSeq.members: - print '- member:' - print ' name:', m.name - print ' type:', m.type.name + my_module = global_module.module_by_name('AccelerationStateSensor') + print (json.dumps(global_module.to_dic(), indent=3)) if __name__ == '__main__': test() diff --git a/idl_parser/const.py b/idl_parser/const.py index f35840e..15d28ee 100644 --- a/idl_parser/const.py +++ b/idl_parser/const.py @@ -6,11 +6,26 @@ class IDLConst(node.IDLNode): - def __init__(self, name, typename, value, parent, filepath=None): - super(IDLConst, self).__init__('IDLConst', name, parent) + def __init__(self, values, parent, filepath=None): + super(IDLConst, self).__init__('IDLConst', values[values.index('=')-1], parent) + value_ = values[values.index('=')+1:] + for i in [',' , '{', '}']: + while True: + if i in value_: + value_.remove(i) + else: break + if len(value_) == 1: + value_ = value_[0].strip('"') + else: + value_ = [v.strip('"') for v in value_] + name_ = values[values.index('=')-1] + typename = '' + for t in values[:values.index(name_)]: + typename = typename + ' ' + t + typename = typename.strip() self._typename = typename self._verbose = True - self._value = value + self._value = value_ self._filepath= filepath def to_simple_dic(self, quiet=False, full_path=False, recursive=False, member_only=False): diff --git a/idl_parser/enum.py b/idl_parser/enum.py index 5db232a..7e2a1d5 100644 --- a/idl_parser/enum.py +++ b/idl_parser/enum.py @@ -1,6 +1,7 @@ import os, sys, traceback from . import node +from . import exception sep = '::' class IDLEnumValue(node.IDLNode): @@ -71,20 +72,20 @@ def parse_tokens(self, token_buf, filepath=None): ln, fn, kakko = token_buf.pop() if not kakko == '{': if self._verbose: sys.stdout.write('# Error. No kakko "{".\n') - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() block_tokens = [] while True: ln, fn, token = token_buf.pop() if token == None: if self._verbose: sys.stdout.write('# Error. No kokka "}".\n') - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() elif token == '}': ln, fn, token = token_buf.pop() if not token == ';': if self._verbose: sys.stdout.write('# Error. No semi-colon after "}".\n') - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() if len(block_tokens) > 0: self._parse_block(block_tokens) diff --git a/idl_parser/interface.py b/idl_parser/interface.py index 562fc2a..d07ac68 100644 --- a/idl_parser/interface.py +++ b/idl_parser/interface.py @@ -2,7 +2,7 @@ from . import node from . import type as idl_type - +from . import exception sep = '::' class IDLArgument(node.IDLNode): @@ -185,13 +185,13 @@ def parse_tokens(self, token_buf, filepath=None): ln, fn, token = token_buf.pop() if token == None: if self._verbose: sys.stdout.write('# Error. No kokka "}".\n') - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() elif token == '}': ln, fn, token = token_buf.pop() if not token == ';': if self._verbose: sys.stdout.write('# Error. No semi-colon after "}".\n') - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() break if token == ';': diff --git a/idl_parser/module.py b/idl_parser/module.py index 482dd91..4f8fa67 100644 --- a/idl_parser/module.py +++ b/idl_parser/module.py @@ -1,6 +1,6 @@ import os, sys, traceback -from . import node, type +from . import node, type, exception from . import struct, typedef, interface, enum, const, union global_namespace = '__global__' sep = '::' @@ -12,7 +12,14 @@ def __init__(self, name=None, parent = None): self._verbose = False if name is None: self._name = global_namespace - + if parent: + self._global_module = self._parent + while self._global_module: + if self._global_module.name == '__global__': + break + self._global_module = self._global_module._parent + else: + self._global_module = self self._interfaces = [] self._typedefs = [] self._structs = [] @@ -20,19 +27,23 @@ def __init__(self, name=None, parent = None): self._unions = [] self._consts = [] self._modules = [] - + self._forward_decls = [] + self._processed_modules = [global_namespace] + self._found_types = {} + self._full_path = '' + if self.parent is None: + self._full_path = '' # self.name + else: + if len(self.parent.full_path) == 0: + self._full_path = self.name + self._full_path = self.parent.full_path + sep + self.name @property def is_global(self): return self.name == global_namespace @property def full_path(self): - if self.parent is None: - return '' # self.name - else: - if len(self.parent.full_path) == 0: - return self.name - return self.parent.full_path + sep + self.name + return self._full_path def to_simple_dic(self, quiet=False): dic = {'module %s' % self.name : [s.to_simple_dic(quiet) for s in self.structs] + @@ -54,7 +65,8 @@ def to_dic(self): 'enums' : [e.to_dic() for e in self.enums], 'unions' : [u.to_dic() for u in self.unions], 'modules' : [m.to_dic() for m in self.modules], - 'consts' : [c.to_dic() for c in self.consts] } + 'consts' : [c.to_dic() for c in self.consts], + 'annotations':[a.to_dic() for a in self._annotations] } return dic @@ -64,28 +76,53 @@ def parse_tokens(self, token_buf, filepath=None): ln, fn, kakko = token_buf.pop() if not kakko == '{': if self._verbose: sys.stdout.write('# Error. No kakko "{".\n') - raise InvalidIDLSyntaxError() - + raise exception.InvalidIDLSyntaxError() + annotation_found = False + annotations = '' + keywords = ['module', 'typedef', 'struct', 'interface', 'enum', 'union', 'const'] + if self.full_path == 'stanag4817::p7::catl_json::core::basic_types::contact': + print('stop') while True: - ln, fn, token = token_buf.pop() + ln, fn, token = token_buf.pop() + if token != None: + if token.find('@') > -1 and token != '@annotation': + annotation_found = True + annotations += token + while True: + ln, fn, t = token_buf.pop() + if t in keywords: + token = t + break + annotations += ' '+ t if token == None: - if self.name == global_namespace: + if self.name in self._global_module._processed_modules: break if self._verbose: sys.stdout.write('# Error. No kokka "}".\n') - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() elif token == 'module': ln, fn, name_ = token_buf.pop() - m = self.module_by_name(name_) + m = self.module_by_name(name_) if m == None: m = IDLModule(name_, self) self._modules.append(m) - m.parse_tokens(token_buf, filepath=filepath) + self._global_module._processed_modules +=[name_] + m.parse_tokens(token_buf, filepath=filepath) + if annotation_found: + parts = annotations.strip().split('@') + for part in parts: + v = node.IDLAnnotation('@'+part) + if v.annotation_type != node.AnnotationType.UNKNOWN: + m._annotations += [v] + annotations = '' + annotation_found = False + else: + m.parse_tokens(token_buf, filepath=filepath) elif token == 'typedef': blocks = [] while True: ln, fn, t = token_buf.pop() if t == None: - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() elif t == ';': break else: @@ -94,16 +131,26 @@ def parse_tokens(self, token_buf, filepath=None): self._typedefs.append(t) t.parse_blocks(blocks, filepath=filepath) elif token == 'struct': - ln, fn, name_ = token_buf.pop() + ln, fn, name_ = token_buf.pop() s_ = self.struct_by_name(name_) s = struct.IDLStruct(name_, self) s.parse_tokens(token_buf, filepath=filepath) - if s_: - if self._verbose: sys.stdout.write('# Error. Same Struct Defined (%s)\n' % name_) - # raise InvalidIDLSyntaxError + if s.forward_decl == False: + if annotation_found: + parts = annotations.strip().split('@') + for part in parts: + v = node.IDLAnnotation('@'+part) + if v.annotation_type != node.AnnotationType.UNKNOWN: + s._annotations += [v] + annotations = '' + annotation_found = False + if s_: + if self._verbose: sys.stdout.write('# Error. Same Struct Defined (%s)\n' % name_) + raise exception.InvalidIDLSyntaxError() + else: + self._structs.append(s) else: - self._structs.append(s) - + self._forward_decls.append(s) elif token == 'interface': ln, fn, name_ = token_buf.pop() s = interface.IDLInterface(name_, self) @@ -112,10 +159,9 @@ def parse_tokens(self, token_buf, filepath=None): s_ = self.interface_by_name(name_) if s_: if self._verbose: sys.stdout.write('# Error. Same Interface Defined (%s)\n' % name_) - # raise InvalidIDLSyntaxError + raise exception.InvalidIDLSyntaxError() else: self._interfaces.append(s) - elif token == 'enum': ln, fn, name_ = token_buf.pop() s = enum.IDLEnum(name_, self) @@ -123,21 +169,22 @@ def parse_tokens(self, token_buf, filepath=None): s_ = self.enum_by_name(name_) if s_: if self._verbose: sys.stdout.write('# Error. Same Enum Defined (%s)\n' % name_) - # raise InvalidIDLSyntaxError + raise exception.InvalidIDLSyntaxError() else: self._enums.append(s) - elif token == 'union': ln, fn, name_ = token_buf.pop() s = union.IDLUnion(name_, self) s.parse_tokens(token_buf, filepath) - s_ = self.union_by_name(name_) - if s_: - if self._verbose: sys.stdout.write('# Error. Same Union Defined (%s)\n' % name_) - # raise InvalidIDLSyntaxError + if s.forward_decl == False: + s_ = self.union_by_name(name_) + if s_: + if self._verbose: sys.stdout.write('# Error. Same Union Defined (%s)\n' % name_) + raise exception.InvalidIDLSyntaxError() + else: + self._unions.append(s) else: - self._unions.append(s) - + self._forward_decls.append(s) elif token == 'const': values = [] while True: @@ -145,20 +192,25 @@ def parse_tokens(self, token_buf, filepath=None): if t == ';': break values.append(t) - - value_ = values[-1] - name_ = values[-3] - typename = '' - for t in values[:-3]: - typename = typename + ' ' + t - typename = typename.strip() - s = const.IDLConst(name_, typename, value_, self, filepath=filepath) + s = const.IDLConst(values, self, filepath=filepath) s_ = self.const_by_name(name_) if s_: if self._verbose: sys.stdout.write('# Error. Same Const Defined (%s)\n' % name_) else: self._consts.append(s) - + elif token == '@annotation': + #skip annotation definitions + while True: + ln, fn, token = token_buf.pop() + if token == None: + if self._verbose: sys.stdout.write('# Error. No kokka "}".\n') + raise exception.InvalidIDLSyntaxError() + elif token == '}': + ln, fn, token = token_buf.pop() + if not token == ';': + if self._verbose: sys.stdout.write('# Error. No semi-colon after "}".\n') + raise exception.InvalidIDLSyntaxError() + break elif token == '}': break @@ -218,7 +270,11 @@ def for_each_struct(self, func, filter=None): else: retval.append(func(m)) return retval - + def for_each_forward_decl(self, func): + retval = [] + for m in self._forward_decls: + retval.append(func(m)) + return retval @property def enums(self): return self._enums @@ -287,14 +343,22 @@ def find_types(self, full_typename, parent=None): if type.is_primitive(full_typename): return [type.IDLType(full_typename, self)] typenode = [] - + res = self._found_types.get(full_typename, None) + if res: + return res def parse_node(s, name=str(full_typename)): if parent: if parent.full_path + '::' + name.strip() == s.full_path or name.strip() == s.full_path: typenode.append(s) + else: + if s.name.find(name.strip()) > -1 or s.full_path.find(name.strip()) > -1: + typenode.append(s) else: if s.name == name.strip() or s.full_path == name.strip(): typenode.append(s) + else: + if s.name.find(name.strip()) > -1 or s.full_path.find(name.strip()) > -1: + typenode.append(s) def parse_module(m): m.for_each_module(parse_module) @@ -303,7 +367,9 @@ def parse_module(m): m.for_each_enum(parse_node) m.for_each_union(parse_node) m.for_each_interface(parse_node) + m.for_each_forward_decl(parse_node) parse_module(self) - + if len(typenode) > 0: + self._found_types[full_typename] = typenode return typenode diff --git a/idl_parser/node.py b/idl_parser/node.py index 8380685..a85763a 100644 --- a/idl_parser/node.py +++ b/idl_parser/node.py @@ -1,15 +1,102 @@ + +from enum import Enum +from typing import Any +class AnnotationType(Enum): + UNKNOWN=-1 + KEY = 0 + OPTIONAL = 1 + RANGE = 2 + BIT_BOUND = 3 + UNIT = 4 + DEFAULT = 5 + TOPIC = 6 + JAUS_DOUBLE = 7 + JAUS_INTEGER = 8 + JAUS_INTEGER_FUNCTION = 9 + JAUS_PRESENCE_VECTOR = 10 + JAUS_EXTENDS = 11 + JAUS_PRESENCE_VECTOR_FIELD = 12 + JAUS_RECOMMENDED_QUERY = 13 + +class IDLAnnotation(object): + def __init__(self, value) -> None: + self.tokens = [] + self.data_ = {} + self.value_ = None + if len(value) == 0 or value.lower() == 'struct': + self.type_ = AnnotationType.UNKNOWN + else: + self.tokens = value.split() + self.name_ = self.tokens[0].strip('@').split('::')[-1] + self.tokens = self.tokens[1:] + if self.name_.upper() in AnnotationType.__dict__.keys(): + self.type_ = AnnotationType[self.name_.upper()] + else: + self.type_ = AnnotationType.UNKNOWN + if self.type_ in [AnnotationType.UNIT, AnnotationType.DEFAULT]: + self.tokens = self.tokens[self.tokens.index('(')+1:self.tokens.index(')')] + self.value_ = ' '.join(self.tokens).strip('"') + elif self.type_ == AnnotationType.RANGE: + self.tokens = self.tokens[self.tokens.index('(')+1:self.tokens.index(')')] + self.data_['min'] = float(self.tokens[0].split('=')[-1]) + self.data_['max'] = float(self.tokens[2].split('=')[-1]) + elif self.type_ in [AnnotationType.BIT_BOUND]: + self.tokens = self.tokens[self.tokens.index('(')+1:self.tokens.index(')')] + self.value_ = int(self.tokens[0]) + elif self.type_ == AnnotationType.TOPIC: + self.tokens = self.tokens[self.tokens.index('(')+1:self.tokens.index(')')] + val = ''.join(self.tokens) + self.tokens = val.split(',') + for t in self.tokens: + t = t.split('=') + self.data_[t[0]] = t[1].strip('"') + elif self.type_ in [ AnnotationType.JAUS_EXTENDS, AnnotationType.JAUS_RECOMMENDED_QUERY, AnnotationType.JAUS_INTEGER_FUNCTION]: + self.tokens = self.tokens[self.tokens.index('(')+1:self.tokens.index(')')] + self.value_ = self.tokens[0].strip('"') + else: + pass + for k in self.data_.keys(): + setattr(self, k, self.data_[k]) + @property + def type(self): + return self.type_.name + @property + def annotation_type(self): + return self.type_ + @property + def value(self): + return self.value_ + def __str__(self) -> str: + data = self.to_dic() + return str(data) + def to_dic(self): + data = {} + data['type'] = self.type + if self.value: + data['value'] = self.value + data.update(self.data_) + return data class IDLNode(object): def __init__(self, classname, name, parent): self._classname = classname self._parent = parent self._name = name self._filepath = None - self.sep = '::' - + self._sep = '::' + self._annotations = [] + self._full_path = '' + if self.parent is None: + self._full_path = self.name + else: + if len(self.parent.full_path) == 0: + self._full_path = self.name + self._full_path = (self.parent.full_path + self._sep + self.name).strip() @property def filepath(self): return self._filepath - + @property + def full_path(self): + return self._full_path @property def is_array(self): return self._classname == 'IDLArray' @@ -62,17 +149,17 @@ def name(self): @property def basename(self): - return self._name.split(self.sep)[-1] + return self._name.split(self._sep)[-1] @property def basename(self): - if self.name.find(self.sep) > 0: + if self.name.find(self._sep) > 0: return self.name[self.name.rfind('::')+2:] return self.name @property def pathname(self): - if self.name.find(self.sep) > 0: + if self.name.find(self._sep) > 0: return self.name[:self.name.rfind('::')] return '' @@ -83,11 +170,26 @@ def parent(self): def _name_and_type(self, blocks): name = blocks[-1] - type = '' + type_ = '' for t in blocks[:-1]: - type = type + ' ' + t - type = type.strip() - return (name, type) + type_ = type_ + ' ' + t + type_ = type_.strip() + if type_.find('@') >=0: + ann = type_.split('@') + for a in ann: + if len(a)>0: + v = IDLAnnotation(('@'+a).strip()) + if v.annotation_type != AnnotationType.UNKNOWN: + self._annotations += [v] + k = type_.rfind(')') + if k > 0: + type_ = type_[k+1:].strip() + else: + type_ = ' '.join(type_.split()[1:]) + if type_.find('struct') >=0: + type_ = type_[type_.find('struct')+len('struct'):].strip() + + return (name, type_) @property def is_root(self): diff --git a/idl_parser/parser.py b/idl_parser/parser.py index 0a4bd15..79fba5e 100644 --- a/idl_parser/parser.py +++ b/idl_parser/parser.py @@ -114,7 +114,8 @@ def parse_lines(self, lines, filepath=None): lines = self._clear_ifdef(lines) self._token_buf = token_buffer.TokenBuffer(lines) - self._global_module.parse_tokens(self._token_buf, filepath=filepath) + while self._token_buf.offset < self._token_buf.size: + self._global_module.parse_tokens(self._token_buf, filepath=filepath) def includes(self, idl_path): included_filepaths = [] diff --git a/idl_parser/struct.py b/idl_parser/struct.py index 957e1bf..ea5efda 100644 --- a/idl_parser/struct.py +++ b/idl_parser/struct.py @@ -1,19 +1,17 @@ import os, sys, traceback - from . import node from . import type as idl_type from . import exception - +from . import union class IDLMember(node.IDLNode): def __init__(self, parent): super(IDLMember, self).__init__('IDLMember', '', parent) self._verbose = True self._type = None - self.sep = '::' - + self._full_path = self.parent.full_path + self._sep + self.name @property def full_path(self): - return self.parent.full_path + self.sep + self.name + return self._full_path def parse_blocks(self, blocks, filepath=None): self._filepath = filepath @@ -41,7 +39,8 @@ def to_dic(self): dic = { 'name' : self.name, 'filepath' : self.filepath, 'classname' : self.classname, - 'type' : str(self.type) } + 'type' : str(self.type), + 'annotations' : [a.to_dic() for a in self._annotations]} return dic @property @@ -57,10 +56,15 @@ def type(self): print('Can not find Data Type (%s)\n' % self._type.name) raise exception.InvalidDataTypeException() - return typs[0] - return self._type - - + return typs[0].name + return self._type.name + @property + def key(self): + return len([a for a in self._annotations if a.type == node.AnnotationType.KEY ]) > 0 + @property + def optional(self): + return len([a for a in self._annotations if a.type == node.AnnotationType.OPTIONAL ]) > 0 + def get_type(self, extract_typedef=False): if extract_typedef: if self.type.is_typedef: @@ -69,20 +73,28 @@ def get_type(self, extract_typedef=False): def post_process(self): - self._type._name = self.refine_typename(self.type) + try: + self._type._name = self.refine_typename(self.type) + except: + pass class IDLStruct(node.IDLNode): def __init__(self, name, parent): - super(IDLStruct, self).__init__('IDLStruct', name.strip(), parent) + super(IDLStruct, self).__init__('IDLStruct', name.split()[-1].strip(), parent) self._verbose = False #True self._members = [] - self.sep = '::' - + self._sep = '::' + self.base = None + self.forward_decl = False + self._full_path = (self.parent.full_path + self._sep + self.name).strip() + @property + def baseclass(self): + return self.base @property def full_path(self): - return (self.parent.full_path + self.sep + self.name).strip() + return self._full_path def to_simple_dic(self, quiet=False, full_path=False, recursive=False, member_only=False): name = self.full_path if full_path else self.name @@ -99,12 +111,22 @@ def to_simple_dic(self, quiet=False, full_path=False, recursive=False, member_on def to_dic(self): dic = { 'name' : self.name, 'classname' : self.classname, - 'members' : [v.to_dic() for v in self.members] } + 'full_path' : self.full_path, + 'members' : [v.to_dic() for v in self.members], + 'annotations': [str(a) for a in self._annotations]} return dic def parse_tokens(self, token_buf, filepath=None): self._filepath = filepath ln, fn, kakko = token_buf.pop() + if kakko == ';': + self.forward_decl = True + return + if kakko == ':': + ln, fn, kakko = token_buf.pop() + self.base = kakko + ln, fn, kakko = token_buf.pop() + if not kakko == '{': if self._verbose: sys.stdout.write('# Error. No kakko "{".\n') raise exception.InvalidIDLSyntaxError() @@ -116,6 +138,30 @@ def parse_tokens(self, token_buf, filepath=None): if token == None: if self._verbose: sys.stdout.write('# Error. No kokka "}".\n') raise exception.InvalidIDLSyntaxError() + elif token == 'struct': + ln, fn, name_ = token_buf.pop() + s = IDLStruct(name_, self) + s.parse_tokens(token_buf, filepath=filepath) + v = node.IDLAnnotation(' '.join(block_tokens)) + if v.annotation_type != node.AnnotationType.UNKNOWN: + s._annotations += [v] + a = self.parent.classname + if self.parent.classname == 'IDLModule': + self.parent._structs +=[s] + else: + self.parent.parent._structs +=[s] + block_tokens=[] + elif token == 'union': + ln, fn, name_ = token_buf.pop() + s = union.IDLUnion(name_, self) + s.parse_tokens(token_buf, filepath=filepath) + s._annotations = [' '.join(block_tokens)] + a = self.parent.classname + if self.parent.classname == 'IDLModule': + self.parent._structs +=[s] + else: + self.parent.parent._structs +=[s] + block_tokens=[] elif token == '}': ln2, fn2, token = token_buf.pop() @@ -139,11 +185,14 @@ def _parse_block(self, blocks): def _post_process(self): self.forEachMember(lambda m : m.post_process()) - @property def members(self): return self._members - + + @property + def topic(self): + return len([a for a in self._annotations if a.type == node.AnnotationType.TOPIC ]) > 0 + def member_by_name(self, name): for m in self._members: if m.name == name: diff --git a/idl_parser/token_buffer.py b/idl_parser/token_buffer.py index 838bf64..d96efcb 100644 --- a/idl_parser/token_buffer.py +++ b/idl_parser/token_buffer.py @@ -14,7 +14,17 @@ def __init__(self, lines): @property def t_debug(self): return self._tokens - + @property + def size(self): + return len(self._tokens) + @property + def offset(self): + return self._token_offset + def peek(self): + if len(self._tokens) == self._token_offset: + return (-1, '', None) + t = self._tokens[self._token_offset] + return t def pop(self): if len(self._tokens) == self._token_offset: return (-1, '', None) diff --git a/idl_parser/type.py b/idl_parser/type.py index 4333007..0196f0e 100644 --- a/idl_parser/type.py +++ b/idl_parser/type.py @@ -13,7 +13,9 @@ 'float', 'double', 'string', - 'wstring'] + 'wstring', + 'int8', 'uint8', 'int16', 'uint16', 'int32', 'uint32', + 'int64', 'uint64'] def is_primitive(name): for n in name.split(' '): @@ -24,12 +26,14 @@ def is_primitive(name): def IDLType(name, parent): if name == 'void': return IDLVoid(name, parent) - - elif name.find('sequence') >= 0: + elif name.find('sequence') == 0: return IDLSequence(name, parent) + elif name.find('map') ==0: + return IDLMap(name, parent) elif name.find('[') >= 0: return IDLArray(name, parent) - + elif name.find('<') >=0: + return IDLSequence(name, parent) if is_primitive(name): return IDLPrimitive(name, parent) @@ -40,7 +44,6 @@ def __init__(self, classname, name, parent): super(IDLTypeBase, self).__init__(classname, name, parent.root_node) self._is_sequence = False self._is_primitive = False - def __str__(self): return self.name @@ -57,14 +60,67 @@ class IDLVoid(IDLTypeBase): def __init__(self, name, parent): super(IDLVoid, self).__init__('IDLVoid', name, parent.root_node) self._verbose = True +class IDLMap(IDLTypeBase): + def __init__(self, name, parent): + super(IDLMap, self).__init__('IDLMap', name, parent.root_node) + self._verbose = True + if name.find('map') < 0 and name.find('<') < 0: + raise exception.InvalidIDLSyntaxError() + typ_ = name[name.find('<')+1 : name.find('>')+1].strip() + typ_ = typ_.split(',') + self._key_type = typ_[0] + self._type = IDLType(typ_[1], parent) + self._is_primitive = False #self.inner_type.is_primitive + self._is_sequence = False + + @property + def key_type(self): + return self._key_type + def __str__(self): + return f'map<{str(self.key_type)}, {str(self.type)}>' + + @property + def obj(self): + return self + + @property + def type(self): + return self._type + + @property + def full_path(self): + return self.parent.full_path + sep + self.name + + def to_simple_dic(self, quiet=False, full_path=False, recursive=False, member_only=False): + name = self.full_path if full_path else self.name + return f'map<{str(self.key_type)}, {str(self.type)}>' + + def to_dic(self): + dic = { 'name' : self.name, + 'classname' : self.classname, + 'type' : str(self.type), + 'key_type' : str(self.key_type) } + return dic class IDLSequence(IDLTypeBase): def __init__(self, name, parent): super(IDLSequence, self).__init__('IDLSequence', name, parent.root_node) self._verbose = True - if name.find('sequence') < 0: - raise InvalidIDLSyntaxError() - typ_ = name[name.find('<')+1 : name.find('>')].strip() + if name.find('sequence') < 0 and name.find('<') < 0: + raise exception.InvalidIDLSyntaxError() + self._size = 0 + if name.find('sequence') >=0: + typ_ = name[name.find('<')+1 : name.find('>')].strip() + tokens = typ_.split(',') + typ_ = tokens[0] + if len(tokens) > 1: + self._size = int(tokens[1]) + else: + typ_ = name[:name.find('<')].strip() + try: + self._size = int(name[name.find('<')+1 : name.find('>')].strip()) + except: + pass self._type = IDLType(typ_, parent) self._is_primitive = False #self.inner_type.is_primitive self._is_sequence = True @@ -72,9 +128,15 @@ def __init__(self, name, parent): @property def inner_type(self): return self._type - + @property + def size(self): + return self._size + def __str__(self): - return 'sequence<%s>' % str(self.inner_type) + if self.size > 0: + return f'sequence<{str(self.inner_type)}, {self.size}>' + else: + return f'sequence<{str(self.inner_type)}>' @property def obj(self): @@ -86,10 +148,8 @@ def __hoge(self): typs = global_module.find_types(self.inner_type) # print self.inner_type if len(typs) == 0: - # print 'None' return None else: - # print typs[0] return typs[0] @property @@ -136,7 +196,7 @@ def __init__(self, name, parent): self._verbose = True if name.find('[') < 0: - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() primitive_type_name = name[:name.find('[')] size = name[name.find('[')+1 : name.find(']')] inner_type_name = primitive_type_name + name[name.find(']')+1:] @@ -182,12 +242,9 @@ def size(self): def __hoge(self): global_module = self.root_node typs = global_module.find_types(self.inner_type) - # print self.inner_type if len(typs) == 0: - # print 'None' return None else: - # print typs[0] return typs[0] def parse_size(self, size): diff --git a/idl_parser/union.py b/idl_parser/union.py index de43a27..2739642 100644 --- a/idl_parser/union.py +++ b/idl_parser/union.py @@ -10,12 +10,14 @@ def __init__(self, parent): self._verbose = True self._type = None self._descriminator_value_associations = [] - self.sep = '::' - + self._discriminator = '0' + self._full_path = self.parent.full_path + self._sep + self.name @property def full_path(self): - return self.parent.full_path + self.sep + self.name - + return self._full_path + @property + def discriminator(self): + return self._discriminator def parse_blocks(self, blocks, filepath=None): self._filepath = filepath @@ -25,6 +27,7 @@ def parse_blocks(self, blocks, filepath=None): blocks.pop(0) token = blocks.pop(0) self._descriminator_value_associations.append(token) + self._discriminator = token token = blocks.pop(0) if token != ':': if self._verbose: sys.stdout.write('# Error. No ":" after case value.\n') @@ -64,7 +67,7 @@ def type(self): typs = self.root_node.find_types(self._type.name) if len(typs) == 0: print('Can not find Data Type (%s)\n' % self._type.name) - raise InvalidDataTypeException() + raise exception.InvalidDataTypeException() return typs[0] return self._type @@ -88,11 +91,12 @@ def __init__(self, name, parent): self._verbose = True self._descriminator_kind = None self._members = [] - self.sep = '::' - + self._sep = '::' + self.forward_decl = False + self._full_path = (self.parent.full_path + self._sep + self.name).strip() @property def full_path(self): - return (self.parent.full_path + self.sep + self.name).strip() + return self._full_path def to_simple_dic(self, quiet=False, full_path=False, recursive=False, member_only=False): name = self.full_path if full_path else self.name @@ -114,13 +118,19 @@ def to_dic(self): def parse_tokens(self, token_buf, filepath=None): self._filepath = filepath - + + ln, fn, token = token_buf.peek() + if token == ';': + ln, fn, kakko = token_buf.pop() + self.forward_decl = True; + return self.parse_descriminator_kind(token_buf) ln, fn, token = token_buf.pop() + if token != '{': if self._verbose: sys.stdout.write('# Error. No kokka "{".\n') - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() block_tokens = [] while True: @@ -128,13 +138,13 @@ def parse_tokens(self, token_buf, filepath=None): ln, fn, token = token_buf.pop() if token == None: if self._verbose: sys.stdout.write('# Error. No kokka "}".\n') - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() elif token == '}': ln, fn, token = token_buf.pop() if not token == ';': if self._verbose: sys.stdout.write('# Error. No semi-colon after "}".\n') - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() break if token == ';': @@ -149,17 +159,17 @@ def parse_descriminator_kind(self, token_buf): ln, fn, token = token_buf.pop() if token != 'switch': if self._verbose: sys.stdout.write('# Error. Union definition missing "switch".\n') - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() ln, fn, token = token_buf.pop() if token != '(': if self._verbose: sys.stdout.write('# Error. No "(".\n') - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() ln, fn, token = token_buf.pop() self._descriminator_kind = token ln, fn, token = token_buf.pop() if token != ')': if self._verbose: sys.stdout.write('# Error. No ")".\n') - raise InvalidIDLSyntaxError() + raise exception.InvalidIDLSyntaxError() def _parse_block(self, blocks): v = IDLUnionMember(self)