diff --git a/.travis.yml b/.travis.yml
index 9a80acd6e..f474b634d 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,26 +1,30 @@
# Travis CI configuration file
# http://about.travis-ci.org/docs/
-dist: trusty
+dist: bionic
language: python
# Available Python versions:
# http://about.travis-ci.org/docs/user/ci-environment/#Python-VM-images
python:
- - "3.5"
- "3.6"
+ - "3.7"
# Dependencies installation commands
install:
- pip install -U pip
- pip install -r requirements.txt
+ - pip install -r requirements-ci.txt
-#before_script:
-# - "if [[ $TRAVIS_PYTHON_VERSION != 2.6 ]]; then flake8 --config=config/flake8rc asm_collect.py asmtest tests; fi"
-# - "if [[ $TRAVIS_PYTHON_VERSION != 2.6 ]]; then pylint --rcfile=config/pylintrc asm_collect.py asmtest tests; fi"
+before_script:
+ - "flake8 --config=config/flake8rc *.py commands index_transform gadgets/standard_revisions_tests/*.py tests"
+ - "pylint --rcfile=config/pylintrc *.py commands index_transform gadgets/standard_revisions_tests/*.py tests"
script:
- "python -m unittest discover"
+ - "mkdir -p tmp"
+ - "python index2browser.py index-functions-c.xml tmp/index-functions-c-web.html"
+ - "python index2browser.py index-functions-cpp.xml tmp/index-functions-cpp-web.html"
notifications:
email: false
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 000000000..f288702d2
--- /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/Makefile b/Makefile
index fe8ab3310..644e3a566 100644
--- a/Makefile
+++ b/Makefile
@@ -28,7 +28,7 @@ qhelpgenerator = qhelpgenerator
#Version
-VERSION=20180311
+VERSION=20190607
#STANDARD RULES
@@ -175,13 +175,13 @@ output/cppreference-doc-en-cpp.devhelp2: \
#build the .qch (QT help) file
output/cppreference-doc-en-cpp.qch: output/qch-help-project-cpp.xml
#qhelpgenerator only works if the project file is in the same directory as the documentation
- cp "output/qch-help-project-cpp.xml" "output/reference_cssless/qch.xml"
+ cp "output/qch-help-project-cpp.xml" "output/reference_cssless/qch.qhp"
pushd "output/reference_cssless" > /dev/null; \
- $(qhelpgenerator) "qch.xml" -o "../cppreference-doc-en-cpp.qch"; \
+ $(qhelpgenerator) "qch.qhp" -o "../cppreference-doc-en-cpp.qch"; \
popd > /dev/null
- rm -f "output/reference_cssless/qch.xml"
+ rm -f "output/reference_cssless/qch.qhp"
output/qch-help-project-cpp.xml: \
output/cppreference-doc-en-cpp.devhelp2 \
@@ -257,4 +257,4 @@ source:
http://en.cppreference.com/w/ ; \
popd > /dev/null
- ./export.py --url=http://en.cppreference.com/mwiki reference/cppreference-export-ns0,4,8,10.xml 0 4 8 10
+ ./export.py --url=https://en.cppreference.com/mwiki reference/cppreference-export-ns0,4,8,10.xml 0 4 8 10
diff --git a/build_link_map.py b/build_link_map.py
index 851c8ee1e..c5fa89092 100755
--- a/build_link_map.py
+++ b/build_link_map.py
@@ -21,10 +21,12 @@
# filename -> title mapping to a xml file.
import fnmatch
-import re
import os
+import re
+
from link_map import LinkMap
+
# returns a dict { title -> filename }.
# directory - either 'output/reference' or 'reference'
def build_link_map(directory):
@@ -41,26 +43,30 @@ def build_link_map(directory):
text = f.read()
f.close()
- m = re.search('', text)
+ m = re.search(r'', text) # noqa
if not m:
continue
text = m.group(1)
- text = re.sub('\s*', '', text)
+ text = re.sub(r'\s*', '', text)
m = re.search('"wgPageName":"([^"]*)"', text)
if not m:
continue
title = m.group(1)
- target = os.path.relpath(os.path.abspath(fn), os.path.abspath(directory))
+ target = os.path.relpath(os.path.abspath(fn),
+ os.path.abspath(directory))
link_map.add_link(title, target)
return link_map
+
def main():
link_map = build_link_map('output/reference')
- # create an xml file containing mapping between page title and actual location
+ # create an xml file containing mapping between page title and actual
+ # location
link_map.write('output/link-map.xml')
+
if __name__ == "__main__":
main()
diff --git a/commands/preprocess.py b/commands/preprocess.py
index 2412aa631..45682f54f 100644
--- a/commands/preprocess.py
+++ b/commands/preprocess.py
@@ -19,23 +19,25 @@
import fnmatch
import io
-from lxml import etree
-import re
import os
-import sys
+import re
import shutil
import urllib.parse
-from xml_utils import xml_escape, xml_unescape
+
+from lxml import etree
+
def rmtree_if_exists(dir):
if os.path.isdir(dir):
shutil.rmtree(dir)
+
def move_dir_contents_to_dir(srcdir, dstdir):
for fn in os.listdir(srcdir):
shutil.move(os.path.join(srcdir, fn),
os.path.join(dstdir, fn))
+
def rearrange_archive(root):
# rearrange the archive. {root} here is output/reference
@@ -71,8 +73,10 @@ def rearrange_archive(root):
move_dir_contents_to_dir(src_data_path, data_path)
# also copy the custom fonts
- shutil.copy(os.path.join(path, 'DejaVuSansMonoCondensed60.ttf'), data_path)
- shutil.copy(os.path.join(path, 'DejaVuSansMonoCondensed75.ttf'), data_path)
+ shutil.copy(os.path.join(path, 'DejaVuSansMonoCondensed60.ttf'),
+ data_path)
+ shutil.copy(os.path.join(path, 'DejaVuSansMonoCondensed75.ttf'),
+ data_path)
# remove what's left
shutil.rmtree(path)
@@ -81,79 +85,76 @@ def rearrange_archive(root):
for fn in fnmatch.filter(os.listdir(root), 'cppreference-export*.xml'):
os.remove(os.path.join(root, fn))
-def add_file_to_rename_map(rename_map, dir, fn, new_fn):
- path = os.path.join(dir, fn)
- if not os.path.isfile(path):
- print("ERROR: Not renaming '{0}' because path does not exist".format(path))
- return
- rename_map.append((dir, fn, new_fn))
-# Converts complex URL to resources supplied by MediaWiki loader to a simplified
-# name
def convert_loader_name(fn):
+ # Converts complex URL to resources supplied by MediaWiki loader to a
+ # simplified name
if "modules=site&only=scripts" in fn:
return "site_scripts.js"
- elif "modules=site&only=styles" in fn:
+ if "modules=site&only=styles" in fn:
return "site_modules.css"
- elif "modules=startup&only=scripts" in fn:
+ if "modules=startup&only=scripts" in fn:
return "startup_scripts.js"
- elif re.search("modules=skins.*&only=scripts", fn):
+ if re.search("modules=skins.*&only=scripts", fn):
return "skin_scripts.js"
- elif re.search("modules=.*ext.*&only=styles", fn):
+ if re.search("modules=.*ext.*&only=styles", fn):
return "ext.css"
- else:
- raise Exception('Loader file {0} does not match any known files'.format(fn))
+ msg = 'Loader file {0} does not match any known files'.format(fn)
+ raise Exception(msg)
+
-def find_files_to_be_renamed(root):
- # Returns a rename map: array of tuples each of which contain three strings:
- # the directory the file resides in, the source and destination filenames.
+def build_rename_map(root):
+ # Returns a rename map: a map from old to new file name
+ loader = re.compile(r'load\.php\?.*')
+ query = re.compile(r'\?.*')
+ result = dict()
- # The rename map specifies files to be renamed in order to support them on
- # windows filesystems which don't support certain characters in file names
- rename_map = []
+ # find files with invalid names -> rename all occurrences
+ for fn in set(fn for _, _, filenames in os.walk(root) for fn in filenames):
+ if loader.match(fn):
+ result[fn] = convert_loader_name(fn)
- files_rename = [] # general files to be renamed
- files_loader = [] # files served by load.php. These should map to
- # consistent and short file names because we
- # modify some of them later in the pipeline
+ elif any((c in fn) for c in '?*"'):
+ new_fn = query.sub('', fn)
+ new_fn = new_fn.replace('"', '_q_')
+ new_fn = new_fn.replace('*', '_star_')
+ result[fn] = new_fn
+ # find files that conflict on case-insensitive filesystems
for dir, _, filenames in os.walk(root):
- filenames_loader = set(fnmatch.filter(filenames, 'load.php[?]*'))
- # match any filenames with '?"*' characters
- filenames_rename = set(fnmatch.filter(filenames, '*[?"*]*'))
-
- # don't process load.php files in general rename handler
- filenames_rename -= filenames_loader
-
- for fn in filenames_loader:
- files_loader.append((dir, fn))
- for fn in filenames_rename:
- files_rename.append((dir, fn))
-
- for dir, orig_fn in files_rename:
- fn = orig_fn
- fn = re.sub(r'\?.*', '', fn)
- fn = fn.replace('"', '_q_')
- fn = fn.replace('*', '_star_')
- add_file_to_rename_map(rename_map, dir, orig_fn, fn)
-
- # map loader names to more recognizable names
- for dir, fn in files_loader:
- new_fn = convert_loader_name(fn)
- add_file_to_rename_map(rename_map, dir, fn, new_fn)
-
- # rename filenames that conflict on case-insensitive filesystems
- # TODO: perform this automatically
- add_file_to_rename_map(rename_map, os.path.join(root, 'en/cpp/numeric/math'), 'NAN.html', 'NAN.2.html')
- add_file_to_rename_map(rename_map, os.path.join(root, 'en/c/numeric/math'), 'NAN.html', 'NAN.2.html')
- return rename_map
-
-def rename_files(rename_map):
- for dir, old_fn, new_fn in rename_map:
+ seen = dict()
+ for fn in (result.get(s, s) for s in filenames):
+ low = fn.lower()
+ num = seen.setdefault(low, 0)
+ if num > 0:
+ name, ext = os.path.splitext(fn)
+ # add file with its path -> only rename that occurrence
+ result[os.path.join(dir, fn)] = \
+ "{}.{}{}".format(name, num + 1, ext)
+ seen[low] += 1
+
+ return result
+
+
+def rename_files(root, rename_map):
+ for dir, old_fn in ((dir, fn)
+ for dir, _, filenames in os.walk(root)
+ for fn in filenames):
src_path = os.path.join(dir, old_fn)
- dst_path = os.path.join(dir, new_fn)
- print("Renaming '{0}' to \n '{1}'".format(src_path, dst_path))
- shutil.move(src_path, dst_path)
+
+ new_fn = rename_map.get(old_fn)
+ if new_fn:
+ # look for case conflict of the renamed file
+ new_path = os.path.join(dir, new_fn)
+ new_fn = rename_map.get(new_path, new_fn)
+ else:
+ # original filename unchanged, look for case conflict
+ new_fn = rename_map.get(src_path)
+ if new_fn:
+ dst_path = os.path.join(dir, new_fn)
+ print("Renaming {0}\n to {1}".format(src_path, dst_path))
+ shutil.move(src_path, dst_path)
+
def find_html_files(root):
# find files that need to be preprocessed
@@ -163,21 +164,25 @@ def find_html_files(root):
html_files.append(os.path.join(dir, filename))
return html_files
+
def is_loader_link(target):
if re.match(r'https?://[a-z]+\.cppreference\.com/mwiki/load\.php', target):
return True
return False
+
def transform_loader_link(target, file, root):
# Absolute loader.php links need to be made relative
- abstarget = os.path.join(root, "common/" + convert_loader_name(target))
+ abstarget = os.path.join(root, "common", convert_loader_name(target))
return os.path.relpath(abstarget, os.path.dirname(file))
+
def is_ranges_placeholder(target):
- if re.match(r'https?://[a-z]+\.cppreference\.com/w/cpp/ranges(-[a-z]+)?-placeholder/.+', target):
+ if re.match(r'https?://[a-z]+\.cppreference\.com/w/cpp/ranges(-[a-z]+)?-placeholder/.+', target): # noqa
return True
return False
+
def transform_ranges_placeholder(target, file, root):
# Placeholder link replacement is implemented in the MediaWiki site JS at
# https://en.cppreference.com/w/MediaWiki:Common.js
@@ -186,9 +191,9 @@ def transform_ranges_placeholder(target, file, root):
repl = (r'\1/cpp/experimental/ranges/\2' if ranges else r'\1/cpp/\2')
if 'ranges-placeholder' in target:
- match = r'https?://([a-z]+)\.cppreference\.com/w/cpp/ranges-placeholder/(.+)'
+ match = r'https?://([a-z]+)\.cppreference\.com/w/cpp/ranges-placeholder/(.+)' # noqa
else:
- match = r'https?://([a-z]+)\.cppreference\.com/w/cpp/ranges-([a-z]+)-placeholder/(.+)'
+ match = r'https?://([a-z]+)\.cppreference\.com/w/cpp/ranges-([a-z]+)-placeholder/(.+)' # noqa
repl += (r'/\3' if ranges else r'/ranges/\3')
# Turn absolute placeholder link into site-relative link
@@ -198,27 +203,38 @@ def transform_ranges_placeholder(target, file, root):
abstarget = os.path.join(root, reltarget)
return os.path.relpath(abstarget, os.path.dirname(file))
+
def is_external_link(target):
- external_link_patterns = [
- 'http://',
- 'https://',
- 'ftp://'
- ]
- for pattern in external_link_patterns:
- if target.startswith(pattern):
- return True
- return False
+ url = urllib.parse.urlparse(target)
+ return url.scheme != '' or url.netloc != ''
+
+
+def trasform_relative_link(rename_map, target, file):
+ # urlparse returns (scheme, host, path, params, query, fragment)
+ _, _, path, params, _, fragment = urllib.parse.urlparse(target)
+ assert params == ''
+
+ path = urllib.parse.unquote(path)
+ path = path.replace('../../upload.cppreference.com/mwiki/', '../common/')
+ path = path.replace('../mwiki/', '../common/')
+
+ dir, fn = os.path.split(path)
+ new_fn = rename_map.get(fn)
+ if new_fn:
+ # look for case conflict of the renamed file
+ abstarget = os.path.normpath(
+ os.path.join(os.path.dirname(file), dir, new_fn))
+ new_fn = rename_map.get(abstarget, new_fn)
+ else:
+ # original filename unchanged, look for case conflict
+ abstarget = os.path.normpath(os.path.join(os.path.dirname(file), path))
+ new_fn = rename_map.get(abstarget)
+ if new_fn:
+ path = os.path.join(dir, new_fn)
+
+ path = urllib.parse.quote(path)
+ return urllib.parse.urlunparse(('', '', path, params, '', fragment))
-def trasform_relative_link(rename_map, target):
- target = urllib.parse.unquote(target)
- for _, fn, new_fn in rename_map:
- target = target.replace(fn, new_fn)
- target = target.replace('../../upload.cppreference.com/mwiki/','../common/')
- target = target.replace('../mwiki/','../common/')
- target = re.sub(r'(\.php|\.css)\?.*', r'\1', target)
- target = urllib.parse.quote(target)
- target = target.replace('%23', '#')
- return target
# Transforms a link in the given file according to rename map.
# target is the link to transform.
@@ -234,7 +250,8 @@ def transform_link(rename_map, target, file, root):
if is_external_link(target):
return target
- return trasform_relative_link(rename_map, target)
+ return trasform_relative_link(rename_map, target, file)
+
def has_class(el, *classes_to_check):
value = el.get('class')
@@ -246,6 +263,7 @@ def has_class(el, *classes_to_check):
return True
return False
+
# remove non-printable elements
def remove_noprint(html):
for el in html.xpath('//*'):
@@ -254,20 +272,22 @@ def remove_noprint(html):
elif el.get('id') in ['toc', 'catlinks']:
el.getparent().remove(el)
+
# remove see also links between C and C++ documentations
def remove_see_also(html):
for el in html.xpath('//tr[@class]'):
- if not has_class(el, 't-dcl-list-item'):
+ if not has_class(el, 't-dcl-list-item', 't-dsc'):
continue
child_tds = el.xpath('.//td/div[@class]')
- if not any(has_class(td, 't-dcl-list-see') for td in child_tds):
+ if not any(has_class(td, 't-dcl-list-see', 't-dsc-see')
+ for td in child_tds):
continue
# remove preceding separator, if any
prev = el.getprevious()
if prev is not None:
- child_tds = prev.xpath('.//td[@class')
+ child_tds = prev.xpath('.//td[@class]')
if any(has_class(td, 't-dcl-list-sep') for td in child_tds):
prev.getparent().remove(prev)
@@ -280,65 +300,85 @@ def remove_see_also(html):
next = el.getnext()
if next is None:
el.getparent().remove(el)
- continue
-
- if next.tag != 'table':
- continue
-
- if not has_class(next, 't-dcl-list-begin'):
- continue
-
- if len(next.xpath('.//tr')) > 0:
- continue
+ elif next.tag == 'table' and has_class(next, 't-dcl-list-begin') and \
+ len(next.xpath('.//tr')) == 0:
+ el.getparent().remove(el)
+ next.getparent().remove(next)
- el.getparent().remove(el)
- next.getparent().remove(next)
# remove Google Analytics scripts
def remove_google_analytics(html):
for el in html.xpath('/html/body/script'):
- if el.get('src') is not None and 'google-analytics.com/ga.js' in el.get('src'):
- el.getparent().remove(el)
- elif el.text is not None and ('google-analytics.com/ga.js' in el.text or 'pageTracker' in el.text):
- el.getparent().remove(el)
+ if el.get('src') is not None:
+ if 'google-analytics.com/ga.js' in el.get('src'):
+ el.getparent().remove(el)
+ elif el.text is not None:
+ if 'google-analytics.com/ga.js' in el.text or \
+ 'pageTracker' in el.text:
+ el.getparent().remove(el)
-# remove Carbon ads
+
+# remove ads
def remove_ads(html):
+ # Carbon Ads
for el in html.xpath('//script[@src]'):
if 'carbonads.com/carbon.js' in el.get('src'):
el.getparent().remove(el)
for el in html.xpath('/html/body/style'):
if el.text is not None and '#carbonads' in el.text:
el.getparent().remove(el)
+ # BuySellAds
+ for el in html.xpath('//script[@type]'):
+ if 'buysellads.com' in el.text:
+ el.getparent().remove(el)
+ for el in html.xpath('//div[@id]'):
+ if el.get('id').startswith('bsap_'):
+ el.getparent().remove(el)
+
+
+# remove links to file info pages (e.g. on images)
+def remove_fileinfo(html):
+ info = etree.XPath(r"//a[re:test(@href, 'https?://[a-z]+\.cppreference\.com/w/File:')]/..", # noqa
+ namespaces={'re':'http://exslt.org/regular-expressions'}) # noqa
+ for el in info(html):
+ el.getparent().remove(el)
+
+
+# remove external links to unused resources
+def remove_unused_external(html):
+ for el in html.xpath('/html/head/link'):
+ if el.get('rel') in ('alternate', 'search', 'edit', 'EditURI'):
+ el.getparent().remove(el)
+ elif el.get('rel') == 'shortcut icon':
+ (head, tail) = os.path.split(el.get('href'))
+ el.set('href', os.path.join(head, 'common', tail))
+
def preprocess_html_file(root, fn, rename_map):
parser = etree.HTMLParser()
html = etree.parse(fn, parser)
output = io.StringIO()
- # remove external links to unused resources
- for el in html.xpath('/html/head/link'):
- if el.get('rel') in [ 'alternate', 'search', 'edit', 'EditURI' ]:
- el.getparent().remove(el)
-
+ remove_unused_external(html)
remove_noprint(html)
remove_see_also(html)
remove_google_analytics(html)
remove_ads(html)
+ remove_fileinfo(html)
# apply changes to links caused by file renames
- for el in html.xpath('//*[@src or @href]'):
- if el.get('src') is not None:
- el.set('src', transform_link(rename_map, el.get('src'), fn, root))
- elif el.get('href') is not None:
- el.set('href', transform_link(rename_map, el.get('href'), fn, root))
+ for el in html.xpath('//*[@src]'):
+ el.set('src', transform_link(rename_map, el.get('src'), fn, root))
+ for el in html.xpath('//*[@href]'):
+ el.set('href', transform_link(rename_map, el.get('href'), fn, root))
- for err in parser.error_log:
+ for err in list(parser.error_log):
print("HTML WARN: {0}".format(err), file=output)
html.write(fn, encoding='utf-8', method='html')
return output.getvalue()
+
def preprocess_css_file(fn):
f = open(fn, "r", encoding='utf-8')
text = f.read()
@@ -346,8 +386,13 @@ def preprocess_css_file(fn):
# note that query string is not used in css files
- text = text.replace('../DejaVuSansMonoCondensed60.ttf', 'DejaVuSansMonoCondensed60.ttf')
- text = text.replace('../DejaVuSansMonoCondensed75.ttf', 'DejaVuSansMonoCondensed75.ttf')
+ text = text.replace('../DejaVuSansMonoCondensed60.ttf',
+ 'DejaVuSansMonoCondensed60.ttf')
+ text = text.replace('../DejaVuSansMonoCondensed75.ttf',
+ 'DejaVuSansMonoCondensed75.ttf')
+
+ text = text.replace('../../upload.cppreference.com/mwiki/images/',
+ 'images/')
# QT Help viewer doesn't understand nth-child
text = text.replace('nth-child(1)', 'first-child')
@@ -355,3 +400,13 @@ def preprocess_css_file(fn):
f = open(fn, "w", encoding='utf-8')
f.write(text)
f.close()
+
+
+def preprocess_startup_script(fn):
+ with open(fn, "r", encoding='utf-8') as f:
+ text = f.read()
+
+ text = re.sub(r'document\.write\([^)]+\);', '', text)
+
+ with open(fn, "w", encoding='utf-8') as f:
+ f.write(text)
diff --git a/commands/preprocess_cssless.py b/commands/preprocess_cssless.py
index 960ffaf30..e6f9e0220 100644
--- a/commands/preprocess_cssless.py
+++ b/commands/preprocess_cssless.py
@@ -15,16 +15,18 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see http://www.gnu.org/licenses/.
-from premailer import Premailer
-import cssutils
-from lxml import html
-from lxml import etree
-from io import StringIO
-from lxml.etree import strip_elements
+import copy
+import functools
+import io
import logging
import os
import warnings
-import io
+
+import cssutils
+from lxml import etree
+from lxml.etree import strip_elements
+from premailer import Premailer
+
def preprocess_html_merge_cssless(src_path, dst_path):
with open(src_path, 'r') as a_file:
@@ -46,9 +48,11 @@ def preprocess_html_merge_cssless(src_path, dst_path):
os.makedirs(head, exist_ok=True)
with open(dst_path, 'wb') as a_file:
- root.getroottree().write(a_file, pretty_print=True, method="html", encoding='utf-8')
+ root.getroottree().write(a_file, pretty_print=True, method="html",
+ encoding='utf-8')
return output
+
def silence_cssutils_warnings():
log = logging.Logger('ignore')
output = io.StringIO()
@@ -60,6 +64,7 @@ def silence_cssutils_warnings():
return output
+
def preprocess_html_merge_css(root, src_path):
# cssutils_logging_handler of Premailer.__init__ is insufficient to silence
# warnings to stderr in non-verbose mode
@@ -73,9 +78,11 @@ def preprocess_html_merge_css(root, src_path):
return output.getvalue()
+
def strip_style_tags(root):
strip_elements(root, 'style')
+
def needs_td_wrapper(element):
# element has table:row
if len(element.getchildren()) == 0:
@@ -86,31 +93,62 @@ def needs_td_wrapper(element):
return False
return True
-def remove_css_property(element, property_name):
- atrib = cssutils.parseStyle(element.get('style'))
- atrib.removeProperty(property_name)
- element.set('style', atrib.getCssText(separator=''))
- if len(element.get('style')) == 0:
- element.attrib.pop('style')
-def get_css_property_value(el, prop_name):
- atrib = cssutils.parseStyle(el.get('style'))
+@functools.lru_cache(maxsize=None)
+def cssutils_parse_style_cached_nocopy(style):
+ return cssutils.parseStyle(style)
+
+
+def cssutils_parse_style_cached(style):
+ return copy.deepcopy(cssutils_parse_style_cached_nocopy(style))
+
+
+@functools.lru_cache(maxsize=None)
+def get_css_style_property_value(style, prop_name):
+ atrib = cssutils_parse_style_cached_nocopy(style)
value = atrib.getPropertyCSSValue(prop_name)
if value:
return value.cssText
return None
-def has_css_property_value(el, prop_name, prop_value):
- value = get_css_property_value(el, prop_name)
+
+@functools.lru_cache(maxsize=None)
+def has_css_style_property_value(style, prop_name, prop_value):
+ value = get_css_style_property_value(style, prop_name)
if value and value == prop_value:
return True
return False
+
+@functools.lru_cache(maxsize=None)
+def remove_css_style_property(style, property_name):
+ atrib = cssutils_parse_style_cached(style)
+ atrib.removeProperty(property_name)
+ return atrib.getCssText(separator='')
+
+
+def remove_css_property(element, property_name):
+ new_style = remove_css_style_property(element.get('style'), property_name)
+ if len(new_style) > 0:
+ element.set('style', new_style)
+ elif 'style' in element.attrib:
+ element.attrib.pop('style')
+
+
+def get_css_property_value(el, prop_name):
+ return get_css_style_property_value(el.get('style'), prop_name)
+
+
+def has_css_property_value(el, prop_name, prop_value):
+ return has_css_style_property_value(el.get('style'), prop_name, prop_value)
+
+
def set_css_property_value(el, prop_name, prop_value):
- atrib = cssutils.parseStyle(el.get('style'))
+ atrib = cssutils_parse_style_cached(el.get('style'))
atrib.setProperty(prop_name, prop_value)
el.set('style', atrib.getCssText(separator=''))
+
def convert_display_property_to_html_tag(element, element_tag, display_value):
str_attrib_value = element.get('style')
if str_attrib_value is None:
@@ -120,12 +158,14 @@ def convert_display_property_to_html_tag(element, element_tag, display_value):
remove_css_property(element, 'display')
return True
+
def convert_span_table_to_tr_td(table_el):
table_el.tag = 'table'
remove_css_property(table_el, 'display')
for element in table_el.getchildren():
- tag_renamed = convert_display_property_to_html_tag(element, 'tr', 'table-row')
+ tag_renamed = convert_display_property_to_html_tag(
+ element, 'tr', 'table-row')
if tag_renamed:
if needs_td_wrapper(element):
td = etree.Element('td')
@@ -137,7 +177,9 @@ def convert_span_table_to_tr_td(table_el):
element.text = None
else:
for child in element:
- convert_display_property_to_html_tag(child, 'td', 'table-cell')
+ convert_display_property_to_html_tag(
+ child, 'td', 'table-cell')
+
def wrap_element(el, tag_name, style):
new_el = etree.Element(tag_name)
@@ -145,11 +187,13 @@ def wrap_element(el, tag_name, style):
el.addprevious(new_el)
new_el.insert(0, el)
+
def remove_display_none(root_el):
for el in root_el.xpath('//*[contains(@style, "display")]'):
if has_css_property_value(el, 'display', 'none'):
el.getparent().remove(el)
+
def convert_span_tables_to_tr_td(root_el):
# note that the following xpath expressions match only the prefix of the
# CSS property value
@@ -158,11 +202,12 @@ def convert_span_tables_to_tr_td(root_el):
for table_el in table_els:
if has_css_property_value(table_el, 'display', 'table'):
convert_span_table_to_tr_td(table_el)
- #wrap_element(table_el, 'div', 'display:inline')
- #convert_span_table_to_tr_td(table_el)
+ # wrap_element(table_el, 'div', 'display:inline')
+ # convert_span_table_to_tr_td(table_el)
return root_el
+
def convert_inline_block_elements_to_table(root_el):
for el in root_el.xpath('//*[contains(@style, "display")]'):
if not has_css_property_value(el, 'display', 'inline-block') and \
@@ -198,6 +243,7 @@ def convert_inline_block_elements_to_table(root_el):
el.getparent().remove(el)
td.append(el)
+
def get_table_rows(table_el):
for el in table_el.iterchildren(['th', 'tr']):
yield el
@@ -205,28 +251,33 @@ def get_table_rows(table_el):
for el2 in el.iterchildren(['th', 'tr']):
yield el2
+
def get_max_number_of_columns(table_el):
max_tds = 0
for row_el in get_table_rows(table_el):
max_tds = max(max_tds, len(list(row_el.iterchildren('td'))))
return max_tds
+
def clear_tr_border_top(tr_el):
for td_el in tr_el.iterchildren('td'):
remove_css_property(td_el, 'border-top')
+
def has_tr_border_top(tr_el):
for td_el in tr_el.iterchildren('td'):
if get_css_property_value(td_el, 'border-top') is not None:
return True
return False
+
def has_table_border_top(table_el):
for tr_el in get_table_rows(table_el):
if has_tr_border_top(tr_el):
return True
return False
+
def convert_table_border_top_to_tr_background(root_el):
for table_el in root_el.iter('table'):
if not has_table_border_top(table_el):
@@ -244,6 +295,7 @@ def convert_table_border_top_to_tr_background(root_el):
'background-color: #ccc;')
tr_el.addprevious(border_tr)
+
def convert_zero_td_width_to_nonzero(root_el):
for el in root_el.xpath('//*[contains(@style, "width")]'):
if has_css_property_value(el, 'width', '0%'):
@@ -253,6 +305,7 @@ def convert_zero_td_width_to_nonzero(root_el):
for el in root_el.xpath('//*[contains(@width, "0%")]'):
el.attrib['width'] = "1px"
+
def apply_font_size(size, parent_size_pt):
size = size.strip()
@@ -269,8 +322,9 @@ def apply_font_size(size, parent_size_pt):
return parent_size_pt
+
def convert_font_size_property_to_pt_recurse(el, parent_size_pt):
- size_value = get_css_property_value(el,"font-size")
+ size_value = get_css_property_value(el, "font-size")
if size_value:
el_size_pt = apply_font_size(size_value, parent_size_pt)
@@ -281,5 +335,6 @@ def convert_font_size_property_to_pt_recurse(el, parent_size_pt):
for child in el.getchildren():
convert_font_size_property_to_pt_recurse(child, el_size_pt)
+
def convert_font_size_property_to_pt(root_el, default_size):
- convert_font_size_property_to_pt_recurse(root_el, default_size)
+ convert_font_size_property_to_pt_recurse(root_el, default_size)
diff --git a/config/flake8rc b/config/flake8rc
new file mode 100644
index 000000000..d12aac637
--- /dev/null
+++ b/config/flake8rc
@@ -0,0 +1,6 @@
+[flake8]
+
+show-source = yes
+statistics = yes
+count = yes
+max-line-length = 80
diff --git a/config/pylintrc b/config/pylintrc
new file mode 100644
index 000000000..373c6473f
--- /dev/null
+++ b/config/pylintrc
@@ -0,0 +1,392 @@
+[MASTER]
+
+# Profiled execution.
+profile=no
+
+# Add files or directories to the blacklist. They should be base names, not
+# paths.
+ignore=
+
+# Pickle collected data for later comparisons.
+persistent=no
+
+# List of plugins (as comma separated values of python modules names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+
+[MESSAGES CONTROL]
+
+# For now disable bunch of checks that does not pass. Some of them should be
+# re-enabled and reported issues fixed, while most are bugs in pylint and could
+# be re-enabled when those are fixed.
+
+# Following are the checks we don't care about, and thus should remain disabled
+#
+# blacklisted-name
+# missing-docstring
+# too-many-lines
+# no-self-use
+# duplicate-code
+# too-many-ancestors
+# too-many-instance-attributes
+# too-few-public-methods
+# too-many-public-methods
+# too-many-return-statements
+# too-many-branches
+# too-many-arguments
+# too-many-locals
+# too-many-statements
+# abstract-class-not-used
+# abstract-class-little-used
+# exec-used
+# star-args
+# deprecated-module
+# fixme
+# global-variable-undefined
+# unused-argument
+# unpacking-non-sequence
+# maybe-no-member
+
+# "bad-continuation" disabled due to conflict with flake8 (and PEP8)
+# See
+# flake8 wants:
+# func("..."
+# )
+# pylint wants:
+# func("..."
+# )
+
+disable=
+ blacklisted-name,
+ invalid-name,
+ missing-docstring,
+ too-many-lines,
+ no-self-use,
+ chained-comparison,
+ duplicate-code,
+ too-many-ancestors,
+ too-many-instance-attributes,
+ too-few-public-methods,
+ too-many-public-methods,
+ too-many-return-statements,
+ too-many-branches,
+ too-many-arguments,
+ too-many-locals,
+ too-many-statements,
+ abstract-class-not-used,
+ abstract-class-little-used,
+ deprecated-module,
+ fixme,
+ global-variable-undefined,
+ unused-argument,
+ maybe-no-member,
+ locally-disabled,
+ bad-classmethod-argument,
+ line-too-long,
+ old-style-class,
+ method-hidden,
+ no-name-in-module,
+ no-member,
+ not-callable,
+ too-many-function-args,
+ unexpected-keyword-arg,
+ redundant-keyword-arg,
+ import-error,
+ cyclic-import,
+ exec-used,
+ star-args,
+ unreachable,
+ dangerous-default-value,
+ pointless-statement,
+ pointless-string-statement,
+ expression-not-assigned,
+ unnecessary-pass,
+ unnecessary-lambda,
+ deprecated-lambda,
+ useless-else-on-loop,
+ bad-builtin,
+ attribute-defined-outside-init,
+ protected-access,
+ arguments-differ,
+ signature-differs,
+ abstract-method,
+ super-init-not-called,
+ no-init,
+ non-parent-init-called,
+ bad-indentation,
+ relative-import,
+ global-statement,
+ unused-variable,
+ redefined-outer-name,
+ redefined-builtin,
+ redefined-variable-type,
+ unidiomatic-typecheck,
+ undefined-loop-variable,
+ unbalanced-tuple-unpacking,
+ unpacking-non-sequence,
+ raising-string,
+ broad-except,
+ nonstandard-exception,
+ anomalous-unicode-escape-in-string,
+ bad-open-mode,
+ superfluous-parens,
+ no-self-argument,
+ no-value-for-parameter,
+ interface-not-implemented,
+ bad-continuation,
+ keyword-arg-before-vararg,
+ unsubscriptable-object,
+ inconsistent-return-statements, # (implicit return None)
+ len-as-condition,
+ too-many-boolean-expressions,
+ useless-object-inheritance
+
+[REPORTS]
+
+# Set the output format. Available formats are text, parseable, colorized, msvs
+# (visual studio) and html. You can also give a reporter class, eg
+# mypackage.mymodule.MyReporterClass.
+output-format=text
+
+# Change the default error message template.
+msg-template={path}:{line}:{column}: error: {msg} [{symbol}]
+
+# Include message's id in output
+include-ids=yes
+
+# Include symbolic ids of messages in output
+symbols=yes
+
+# Put messages in a separate file for each module / package specified on the
+# command line instead of printing them on stdout. Reports (if any) will be
+# written in a file name "pylint_global.[txt|html]".
+files-output=no
+
+# Tells whether to display a full report or only the messages
+reports=no
+
+# Python expression which should return a note less than 10 (10 is the highest
+# note). You have access to the variables errors warning, statement which
+# respectively contain the number of errors / warnings messages and the total
+# number of statements analyzed. This is used by the global evaluation report
+# (RP0004).
+evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
+
+# Add a comment according to your evaluation note. This is used by the global
+# evaluation report (RP0004).
+comment=no
+
+
+[SPELLING]
+
+# Spelling dictionary name.
+# If this value will be non-empty (e.g. 'en_US') and pyenchant will not be
+# installed, pylint will fail.
+# If this will be left empty pylint will ignore all spelling errors.
+spelling-dict=
+
+# List of comma separated words that should not be checked.
+spelling-ignore-words=
+
+# A path to a file that contains private dictionary; one word per line.
+# Path relative to current working directory.
+spelling-private-dict-file=../common/code_spelling_ignore_words.txt
+
+# Tells whether to store unknown words to indicated private dictionary in
+# --spelling-private-dict-file option instead of raising a message.
+spelling-store-unknown-words=no
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,XXX,TODO
+
+
+[SIMILARITIES]
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+# Ignore imports when computing similarities.
+ignore-imports=no
+
+
+[FORMAT]
+
+# Maximum number of characters on a single line.
+max-line-length=80
+
+# Maximum number of lines in a module
+max-module-lines=1000
+
+# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
+# tab).
+indent-string=' '
+
+
+[TYPECHECK]
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# List of classes names for which member attributes should not be checked
+# (useful for classes with attributes dynamically set).
+ignored-classes=SQLObject
+
+# When zope mode is activated, add a predefined set of Zope acquired attributes
+# to generated-members.
+zope=no
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E0201 when accessed. Python regular
+# expressions are accepted.
+generated-members=REQUEST,acl_users,aq_parent
+
+
+[BASIC]
+
+# Will be removed in PyLint 2.0
+# Required attributes for module, separated by a comma
+#required-attributes=
+
+# List of builtins function names that should not be used, separated by a comma
+bad-functions=map,filter,apply,input
+
+# Regular expression which should only match correct module names
+module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
+
+# Regular expression which should only match correct module level names
+const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
+
+# Regular expression which should only match correct class names
+class-rgx=[A-Z_][a-zA-Z0-9_]+$
+
+# Regular expression which should only match correct function names
+function-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct method names
+method-rgx=[_]{0,2}[a-z_][a-z0-9_]{2,30}[_]{0,2}$
+
+# Regular expression which should only match correct instance attribute names
+attr-rgx=[a-z_][a-z0-9]{2,30}$
+
+# Regular expression which should only match correct argument names
+argument-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct variable names
+variable-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct list comprehension /
+# generator expression variable names
+inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
+
+# Good variable names which should always be accepted, separated by a comma
+good-names=i,j,k,ex,_
+
+# Bad variable names which should always be refused, separated by a comma
+bad-names=
+
+# Regular expression which should only match functions or classes name which do
+# not require a docstring
+no-docstring-rgx=__.*__
+
+
+[VARIABLES]
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# A regular expression matching the beginning of the name of dummy variables
+# (i.e. not used).
+dummy-variables-rgx=_|dummy
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid to define new builtins when possible.
+additional-builtins=
+
+
+[CLASSES]
+
+# This option will be removed in PyLint 2.0.
+# List of interface methods to ignore, separated by a comma. This is used for
+# instance to not check methods defines in Zope's Interface base class.
+# ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,__new__,setUp
+
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls
+
+# List of valid names for the first argument in a metaclass class method.
+valid-metaclass-classmethod-first-arg=mcs
+
+
+[IMPORTS]
+
+# Deprecated modules which should not be used, separated by a comma
+deprecated-modules=
+
+# Create a graph of every (i.e. internal and external) dependencies in the
+# given file (report RP0402 must not be disabled)
+import-graph=
+
+# Create a graph of external dependencies in the given file (report RP0402 must
+# not be disabled)
+ext-import-graph=
+
+# Create a graph of internal dependencies in the given file (report RP0402 must
+# not be disabled)
+int-import-graph=
+
+
+[DESIGN]
+
+# Maximum number of arguments for function / method
+max-args=5
+
+# Argument names that match this expression will be ignored. Default to name
+# with leading underscore
+ignored-argument-names=_.*
+
+# Maximum number of locals for function / method body
+max-locals=15
+
+# Maximum number of return / yield for function / method body
+max-returns=6
+
+# Maximum number of branch for function / method body
+max-branchs=12
+
+# Maximum number of statements in function / method body
+max-statements=50
+
+# Maximum number of parents for a class (see R0901).
+max-parents=7
+
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=2
+
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=20
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "Exception"
+overgeneral-exceptions=Exception
+
+extension-pkg-whitelist=lxml
diff --git a/ddg_parse_html.py b/ddg_parse_html.py
index 12d8ab79e..7e30df69d 100644
--- a/ddg_parse_html.py
+++ b/ddg_parse_html.py
@@ -1,4 +1,4 @@
- #!/usr/bin/env python3
+#!/usr/bin/env python3
'''
Copyright (C) 2013 Povilas Kanapickas
@@ -18,23 +18,26 @@
along with this program. If not, see http://www.gnu.org/licenses/.
'''
-import lxml.etree as e
import re
from copy import deepcopy
+import lxml.etree as e
+
+
class DdgException(Exception):
pass
-''' Returns the element in which the content is stored.
-'''
+
def get_content_el(root_el):
+ # Returns the element in which the content is stored.
try:
return root_el.xpath('''/html/body/div[@id="cpp-content-base"]
/div[@id="content"]
/div[@id="bodyContent"]
/div[@class="mw-content-ltr"]''')[0]
- except:
- raise DdgException("Could not find content element")
+ except Exception as e:
+ raise DdgException("Could not find content element") from e
+
VERSION_C89 = 0
VERSION_C99 = 1
@@ -44,18 +47,20 @@ def get_content_el(root_el):
VERSION_CXX11 = 102
VERSION_CXX14 = 103
-''' Returns the declaration of the feature with name 'name'.
- If several declarations with the same name are present, and entries
- superseded in the later standards (as determined by the presence of until
- XXX marker) are ignored. The rest of declarations are returned as a list of
- tuples, each of which the two elements:
- 1) the code of the declaration
- 2) the version as defined by the 'num' dcl template parameter, or None
- if no version was specified.
- If no declaration is found, an exception of type DdgException is raised
-'''
def get_declarations(root_el, name):
+ ''' Returns the declaration of the feature with name 'name'.
+ If several declarations with the same name are present, and entries
+ superseded in the later standards (as determined by the presence of
+ until XXX marker) are ignored. The rest of declarations are returned
+ as a list of tuples, each of which the two elements:
+ 1) the code of the declaration
+ 2) the version as defined by the 'num' dcl template parameter, or
+ None if no version was specified.
+
+ If no declaration is found, an exception of type DdgException is raised
+ '''
+
content_el = get_content_el(root_el)
dcl_tables = content_el.xpath('table[contains(@class, "t-dcl-begin")]')
@@ -77,12 +82,12 @@ def get_declarations(root_el, name):
# skip entries that don't contain name
if re.search('[^a-zA-Z0-9_]' + re.escape(name) + '[^a-zA-Z0-9_]',
- code) == None:
+ code) is None:
ignored = True
continue
# skip deleted functions
- if re.search('=\s*delete\s*;', code) != None:
+ if re.search(r'=\s*delete\s*;', code) is not None:
ignored = True
continue
@@ -97,9 +102,9 @@ def get_declarations(root_el, name):
version = None
try:
version_str = dcl.xpath('td[2]')[0].text_content()
- version_str = re.search('\((\d*)\)', version_str).group(1)
+ version_str = re.search(r'\((\d*)\)', version_str).group(1)
version = int(version_str)
- except:
+ except Exception:
pass
dcls.append((code, version))
@@ -107,15 +112,16 @@ def get_declarations(root_el, name):
if len(dcls) == 0:
if not ignored:
raise DdgException("dcl table contains no declarations")
- else:
- raise DdgException("All entries in dcl table were ignored")
+ raise DdgException("All entries in dcl table were ignored")
return dcls
+
def del_all_attrs(el):
for key in el.attrib:
del el.attrib[key]
+
def iterate_top_text(text, on_text=None):
last_close = 0
open_count = 0
@@ -134,6 +140,7 @@ def iterate_top_text(text, on_text=None):
if open_count == 0:
on_text(last_close, text[last_close:])
+
def remove_parentheses(desc, max_paren_text_size):
open_paren_count = 0
@@ -143,7 +150,7 @@ def remove_parentheses(desc, max_paren_text_size):
def on_text(pos, text):
nonlocal open_paren_count, last_paren_open, del_ranges
- for match in re.finditer('(\(|\))', text):
+ for match in re.finditer(r'(\(|\))', text):
gr = match.group(1)
if gr == '(':
if open_paren_count == 0:
@@ -162,10 +169,11 @@ def on_text(pos, text):
del_ranges.append((last_paren_open, end))
for r in reversed(del_ranges):
- begin,end = r
+ begin, end = r
desc = desc[:begin] + desc[end:]
return desc
+
def split_sentences(desc):
sentences = []
@@ -187,9 +195,11 @@ def on_text(pos, text):
return sentences
+
def remove_punctuation_at_end(sentence):
return sentence.rstrip(' .,:;')
+
def trim_single_sentence_at_word(sentence, max_chars):
last_valid_chunk = None
@@ -217,6 +227,7 @@ def on_text(pos, text):
return sentence[:last_valid_chunk_pos] + last_valid_chunk
+
def trim_single_sentence(text, max_chars):
if len(text) <= max_chars:
return text
@@ -225,7 +236,7 @@ def trim_single_sentence(text, max_chars):
# if present. Otherwise, cut desc in the middle of the sentence, preferably
# at the end of a word
- #find the first match
+ # find the first match
ie_pos = None
def on_ie_text(pos, match_text):
@@ -250,21 +261,23 @@ def on_ie_text(pos, match_text):
text = trim_single_sentence_at_word(text, max_chars)
return remove_punctuation_at_end(text) + '...'
-''' Processes description text. Drops all tags except and . Replaces
- with . Replaces span.mw-geshi with . Returns the processed
- description as str.
-
- The description is limited to max_sentences number of sentences and
- max_chars number of characters (each delimited by a dot).
- If a single sentence is longer than max_chars characters, '...' is appended.
- Setting max_paren_text_size to controls the maximum number of characters in
- parenthesized text. If the size of parenthesized block exceeds that, it is
- removed. Such blocks within , or tag are ignored.
-'''
def process_description(el, max_sentences, max_chars,
max_paren_text_size, debug=False):
-
+ ''' Processes description text. Drops all tags except and .
+ Replaces with . Replaces span.mw-geshi with . Returns the
+ processed description as str.
+
+ The description is limited to max_sentences number of sentences and
+ max_chars number of characters (each delimited by a dot).
+ If a single sentence is longer than max_chars characters, '...' is
+ appended.
+
+ Setting max_paren_text_size to controls the maximum number of
+ characters in parenthesized text. If the size of parenthesized block
+ exceeds that, it is removed. Such blocks within , or tag
+ are ignored.
+ '''
el = deepcopy(el) # we'll modify the tree
el.tag = 'root'
del_all_attrs(el)
@@ -278,12 +291,12 @@ def process_description(el, max_sentences, max_chars,
else:
t.drop_tag()
desc = e.tostring(el, method='html', encoding=str, with_tail=False)
- desc = desc.replace('','').replace('','')
+ desc = desc.replace('', '').replace('', '')
if debug:
print("ROOT: " + desc)
# description must never contain newlines
- desc = desc.replace('\n',' ')
+ desc = desc.replace('\n', ' ')
# Handle 'i.e.' and 'that is' as a special case
desc = desc.replace('i.e.', 'ᚃ')
@@ -293,9 +306,6 @@ def process_description(el, max_sentences, max_chars,
# remove text in parentheses (except when it's within some tag)
# get the position of the cut of the description
- open_count = 0
- open_paren_count = 0
-
desc = remove_parentheses(desc, max_paren_text_size)
sentences = split_sentences(desc)
@@ -326,38 +336,38 @@ def process_description(el, max_sentences, max_chars,
return desc
-''' Returns a short description of a feature. This is the first sentence after
- the declaration (dcl template). If a list follows immediately, then the
- description is picked from a list item identified by num
- Raises DdgException on error
-'''
def get_short_description(root_el, num, max_sentences=1, max_chars=200,
max_paren_text_size=40, debug=False):
+ ''' Returns a short description of a feature. This is the first sentence
+ after the declaration (dcl template). If a list follows immediately,
+ then the description is picked from a list item identified by num
+ Raises DdgException on error
+ '''
content_el = get_content_el(root_el)
dcl_tables = content_el.xpath('table[@class="t-dcl-begin"]')
if len(dcl_tables) == 0:
raise DdgException("No dcl table found")
- #todo debug
+ # todo debug
dcl_table = dcl_tables[0]
desc_el = dcl_table.getnext()
- if desc_el == None:
+ if desc_el is None:
raise DdgException("No elements after dcl table")
if desc_el.tag == 'p':
return process_description(desc_el, max_sentences, max_chars,
max_paren_text_size, debug=debug)
- elif desc_el.tag == 'div' and desc_el.get('class') == 't-li1':
- if num == None:
+ if desc_el.tag == 'div' and desc_el.get('class') == 't-li1':
+ if num is None:
raise DdgException("Versioned summary with no version supplied")
- while (desc_el != None and desc_el.tag == 'div' and
- desc_el.get('class') == 't-li1'):
+ while (desc_el is not None and desc_el.tag == 'div' and
+ desc_el.get('class') == 't-li1'):
index_els = desc_el.xpath('span[@class="t-li"]')
if len(index_els) == 0:
desc_el = desc_el.getnext()
@@ -366,19 +376,19 @@ def get_short_description(root_el, num, max_sentences=1, max_chars=200,
index = e.tostring(index_el, encoding=str,
method='text', with_tail=False)
- m = re.match('^\s*(\d+)\)\s*$', index)
+ m = re.match(r'^\s*(\d+)\)\s*$', index)
if m and int(m.group(1)) == num:
index_el.drop_tree()
return process_description(desc_el, max_sentences, max_chars,
max_paren_text_size, debug=debug)
- m = re.match('^\s*(\d+)-(\d+)\)\s*$', index)
+ m = re.match(r'^\s*(\d+)-(\d+)\)\s*$', index)
if m and int(m.group(1)) <= num and int(m.group(2)) >= num:
index_el.drop_tree()
return process_description(desc_el, max_sentences, max_chars,
max_paren_text_size, debug=debug)
- m = re.match('^\s*(\d+),(\d+)\)\s*$', index)
+ m = re.match(r'^\s*(\d+),(\d+)\)\s*$', index)
if m and num in [int(m.group(1)), int(m.group(2))]:
index_el.drop_tree()
return process_description(desc_el, max_sentences, max_chars,
diff --git a/devhelp2qch.py b/devhelp2qch.py
index d6b8da475..44904c82a 100755
--- a/devhelp2qch.py
+++ b/devhelp2qch.py
@@ -17,21 +17,24 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see http://www.gnu.org/licenses/.
-# devhelp2qch.py script converts 'in_root' xml source file to 'out_root' xml output
-# including files list from library 'files_root' at the end.
-from lxml import etree
-from copy import deepcopy
-import sys
import argparse
+
+from lxml import etree
+
from index_transform.devhelp_qch import convert_devhelp_to_qch
+
def main():
parser = argparse.ArgumentParser(prog='devhelp2qch.py')
- parser.add_argument('--src', type=str, help='The path to the XML input file')
- parser.add_argument('--dst', type=str, help='The path to the destination XML file')
- parser.add_argument('--virtual_folder', type=str, help='Virtual folder name')
- parser.add_argument('--file_list', type=str, help='The path to the file list in XML file')
+ parser.add_argument('--src', type=str,
+ help='The path to the XML input file')
+ parser.add_argument('--dst', type=str,
+ help='The path to the destination XML file')
+ parser.add_argument('--virtual_folder', type=str,
+ help='Virtual folder name')
+ parser.add_argument('--file_list', type=str,
+ help='The path to the file list in XML file')
args = parser.parse_args()
src_path = args.src
@@ -44,8 +47,10 @@ def main():
file_tree = etree.parse(file_path, parser)
out_f = open(dst_path, 'wb')
- out_f.write(convert_devhelp_to_qch(in_tree.getroot(), file_tree.getroot(), v_folder))
+ out_f.write(convert_devhelp_to_qch(in_tree.getroot(), file_tree.getroot(),
+ v_folder))
out_f.close()
+
if __name__ == "__main__":
main()
diff --git a/export.py b/export.py
index bc449bce7..b4d5b4241 100755
--- a/export.py
+++ b/export.py
@@ -19,9 +19,10 @@
'''
import argparse
+import json
import urllib.parse
import urllib.request
-import json
+
def retrieve_page_names(root, ns_index):
@@ -30,11 +31,11 @@ def retrieve_page_names(root, ns_index):
while True:
params = {
- 'action' : 'query',
- 'list' : 'allpages',
- 'apnamespace' : ns_index,
- 'aplimit' : 500,
- 'format' : 'json'
+ 'action': 'query',
+ 'list': 'allpages',
+ 'apnamespace': ns_index,
+ 'aplimit': 500,
+ 'format': 'json'
}
if begin is not None:
params['apcontinue'] = begin
@@ -43,19 +44,21 @@ def retrieve_page_names(root, ns_index):
with urllib.request.urlopen(url) as f:
data = json.loads(f.read().decode('utf-8'))
- pages += [ p['title'] for p in data['query']['allpages'] ]
+ pages += [p['title'] for p in data['query']['allpages']]
- if ('query-continue' in data and 'allpages' in data['query-continue'] and
- 'apcontinue' in data['query-continue']['allpages']):
+ if ('query-continue' in data and
+ 'allpages' in data['query-continue'] and
+ 'apcontinue' in data['query-continue']['allpages']):
begin = data['query-continue']['allpages']['apcontinue']
else:
return pages
+
def export_pages(root, pages, output_path):
params = {
- 'wpDownload' : '',
- 'curonly' : 1,
- 'pages' : '\n'.join(pages)
+ 'wpDownload': '',
+ 'curonly': 1,
+ 'pages': '\n'.join(pages)
}
data = urllib.parse.urlencode(params)
@@ -64,21 +67,28 @@ def export_pages(root, pages, output_path):
urllib.request.urlretrieve(url, output_path, data=data)
+
def main():
parser = argparse.ArgumentParser(prog='export.py')
- parser.add_argument('--url', type=str, help='The URL to the root of the MediaWiki installation')
- parser.add_argument('output_path', type=str, help='The path to the XML file to save output to')
- parser.add_argument('ns_index', type=str, nargs='+', help='The indices of the namespaces to retrieve')
+ parser.add_argument('--url', type=str,
+ help='The URL to the root of the MediaWiki '
+ 'installation')
+ parser.add_argument('output_path', type=str,
+ help='The path to the XML file to save output to')
+ parser.add_argument('ns_index', type=str, nargs='+',
+ help='The indices of the namespaces to retrieve')
args = parser.parse_args()
pages = []
for ns_index in args.ns_index:
new_pages = retrieve_page_names(args.url, ns_index)
- print("Retrieved {0} pages for namespace {1}".format(len(new_pages), ns_index))
+ print("Retrieved {0} pages for namespace {1}".format(len(new_pages),
+ ns_index))
pages += new_pages
pages = sorted(pages)
export_pages(args.url, pages, args.output_path)
+
if __name__ == "__main__":
main()
diff --git a/fix_devhelp-links.py b/fix_devhelp-links.py
index 10c555f19..87e71c73e 100755
--- a/fix_devhelp-links.py
+++ b/fix_devhelp-links.py
@@ -18,9 +18,11 @@
along with this program. If not, see http://www.gnu.org/licenses/.
'''
+import sys
+
import lxml.etree as e
+
from link_map import LinkMap
-import sys
if len(sys.argv) != 3:
print('''Please provide the following 2 argument:
@@ -40,7 +42,7 @@
for el in el_mod:
link = el.get('link')
target = mapping.get_dest(link)
- if target == None:
+ if target is None:
print('Could not find ' + link + ' in mapping')
target = '404'
el.set('link', target)
@@ -49,4 +51,3 @@
out_f.write(e.tostring(root, encoding='utf-8', pretty_print=True,
xml_declaration=True))
out_f.close()
-
diff --git a/gadgets/replace_tests_base.py b/gadgets/replace_tests_base.py
index f7322eeb6..353d927b1 100755
--- a/gadgets/replace_tests_base.py
+++ b/gadgets/replace_tests_base.py
@@ -24,6 +24,7 @@
import re
import sys
+
def get_html_files(root):
files = []
for dir, dirnames, filenames in os.walk(root):
diff --git a/gadgets/standard_revisions-tests/README b/gadgets/standard_revisions_tests/README
similarity index 100%
rename from gadgets/standard_revisions-tests/README
rename to gadgets/standard_revisions_tests/README
diff --git a/gadgets/standard_revisions-tests/base.py b/gadgets/standard_revisions_tests/base.py
similarity index 91%
rename from gadgets/standard_revisions-tests/base.py
rename to gadgets/standard_revisions_tests/base.py
index 848d43188..8b1269c84 100644
--- a/gadgets/standard_revisions-tests/base.py
+++ b/gadgets/standard_revisions_tests/base.py
@@ -17,13 +17,11 @@
along with this program. If not, see http://www.gnu.org/licenses/.
'''
+import unittest
+
from selenium import webdriver
-from selenium.webdriver.common.by import By
-from selenium.webdriver.common.keys import Keys
from selenium.webdriver.support.ui import Select
-from selenium.common.exceptions import NoSuchElementException
-from selenium.common.exceptions import NoAlertPresentException
-import unittest, time, re
+
class Driver:
def __init__(self):
@@ -31,8 +29,8 @@ def __init__(self):
driver = webdriver.Firefox()
driver.implicitly_wait(30)
try:
- driver.get(base_url + "/mwiki/index.php?title=Special:UserLogout&returnto=Main+Page")
- driver.get(base_url + "/mwiki/index.php?title=Special:UserLogin&returnto=Main+Page")
+ driver.get(base_url + "/mwiki/index.php?title=Special:UserLogout&returnto=Main+Page") # noqa
+ driver.get(base_url + "/mwiki/index.php?title=Special:UserLogin&returnto=Main+Page") # noqa
driver.find_element_by_id("wpName1").clear()
driver.find_element_by_id("wpName1").send_keys("test5")
driver.find_element_by_id("wpPassword1").clear()
@@ -40,18 +38,19 @@ def __init__(self):
driver.find_element_by_id("wpLoginAttempt").click()
if driver.find_element_by_link_text("Test5").text != "Test5":
raise Exception("Could not login")
- except:
+ except Exception:
driver.quit()
raise
self.driver = driver
self.base_url = base_url
-
def __del__(self):
self.driver.quit()
+
driver_instance = Driver()
+
class CppTestCase(unittest.TestCase):
@classmethod
def setUpClass(self):
diff --git a/gadgets/standard_revisions-tests/test.sh b/gadgets/standard_revisions_tests/test.sh
similarity index 100%
rename from gadgets/standard_revisions-tests/test.sh
rename to gadgets/standard_revisions_tests/test.sh
diff --git a/gadgets/standard_revisions-tests/test_dcl.py b/gadgets/standard_revisions_tests/test_dcl.py
similarity index 99%
rename from gadgets/standard_revisions-tests/test_dcl.py
rename to gadgets/standard_revisions_tests/test_dcl.py
index effeedd9c..aa7f9c7f3 100644
--- a/gadgets/standard_revisions-tests/test_dcl.py
+++ b/gadgets/standard_revisions_tests/test_dcl.py
@@ -17,7 +17,8 @@
along with this program. If not, see http://www.gnu.org/licenses/.
'''
-from base import *
+from base import CppTestCase
+
class TestDcl(CppTestCase):
def test_hides_dcl_items_in_dcl_rev(self):
diff --git a/gadgets/standard_revisions-tests/test_dsc.py b/gadgets/standard_revisions_tests/test_dsc.py
similarity index 97%
rename from gadgets/standard_revisions-tests/test_dsc.py
rename to gadgets/standard_revisions_tests/test_dsc.py
index 314182ba3..8ca30d99c 100644
--- a/gadgets/standard_revisions-tests/test_dsc.py
+++ b/gadgets/standard_revisions_tests/test_dsc.py
@@ -17,7 +17,8 @@
along with this program. If not, see http://www.gnu.org/licenses/.
'''
-from base import *
+from base import CppTestCase
+
class TestDsc(CppTestCase):
def test_hides_dsc_items_with_explicit_mark(self):
@@ -32,4 +33,3 @@ def test_hides_dsc_items_with_explicit_mark(self):
self.select_cxx11()
self.assert_text_in_body("std::not_visible_in_cxx98")
self.assert_text_not_in_body("std::not_visible_in_cxx11")
-
diff --git a/gadgets/standard_revisions-tests/test_rev.py b/gadgets/standard_revisions_tests/test_rev.py
similarity index 99%
rename from gadgets/standard_revisions-tests/test_rev.py
rename to gadgets/standard_revisions_tests/test_rev.py
index 8287b51be..e522571a5 100644
--- a/gadgets/standard_revisions-tests/test_rev.py
+++ b/gadgets/standard_revisions_tests/test_rev.py
@@ -17,8 +17,8 @@
along with this program. If not, see http://www.gnu.org/licenses/.
'''
-import unittest, time, re
-from base import *
+from base import CppTestCase
+
class TestRev(CppTestCase):
def test_revlist_works_in_dsc_item(self):
@@ -48,7 +48,6 @@ def test_rev_inl_works_in_text(self):
self.assert_text_not_in_body("not_visible_in_cxx11")
def test_rev_works_with_fully_closed_ranges(self):
- driver = self.driver
self.get_page("test-gadget-stdrev/rev-works-with-fully-closed-ranges")
self.assert_text_in_body("since-cxx03-until-none")
self.assert_text_in_body("since-cxx11-until-none")
diff --git a/gadgets/standard_revisions-tests/test_section_hierarchy.py b/gadgets/standard_revisions_tests/test_section_hierarchy.py
similarity index 74%
rename from gadgets/standard_revisions-tests/test_section_hierarchy.py
rename to gadgets/standard_revisions_tests/test_section_hierarchy.py
index ae246c314..a88ee01cf 100644
--- a/gadgets/standard_revisions-tests/test_section_hierarchy.py
+++ b/gadgets/standard_revisions_tests/test_section_hierarchy.py
@@ -16,69 +16,70 @@
You should have received a copy of the GNU General Public License
along with this program. If not, see http://www.gnu.org/licenses/.
'''
+# noqa
+
+from base import CppTestCase
-import unittest, time, re
-from base import *
class TestSectionHierarchy(CppTestCase):
def test_hides_h3_when_section_contains_dsc_with_removed_elems(self):
driver = self.driver
- self.get_page("test-gadget-stdrev/hides-h3-when-section-contains-dsc-with-removed-elems")
- self.assertTrue(driver.find_element_by_id("Should_be_removed_when_c.2B.2B98").is_displayed())
+ self.get_page("test-gadget-stdrev/hides-h3-when-section-contains-dsc-with-removed-elems") # noqa
+ self.assertTrue(driver.find_element_by_id("Should_be_removed_when_c.2B.2B98").is_displayed()) # noqa
self.select_cxx98()
- self.assertFalse(driver.find_element_by_id("Should_be_removed_when_c.2B.2B98").is_displayed())
+ self.assertFalse(driver.find_element_by_id("Should_be_removed_when_c.2B.2B98").is_displayed()) # noqa
self.select_cxx11()
- self.assertTrue(driver.find_element_by_id("Should_be_removed_when_c.2B.2B98").is_displayed())
+ self.assertTrue(driver.find_element_by_id("Should_be_removed_when_c.2B.2B98").is_displayed()) # noqa
def test_hides_h3_when_section_contains_dsc_with_removed_until(self):
driver = self.driver
- self.get_page("test-gadget-stdrev/hides-h3-when-section-contains-dsc-with-removed-until")
- self.assertTrue(driver.find_element_by_id("Should_be_removed_when_c.2B.2B11").is_displayed())
+ self.get_page("test-gadget-stdrev/hides-h3-when-section-contains-dsc-with-removed-until") # noqa
+ self.assertTrue(driver.find_element_by_id("Should_be_removed_when_c.2B.2B11").is_displayed()) # noqa
self.select_cxx98()
- self.assertTrue(driver.find_element_by_id("Should_be_removed_when_c.2B.2B11").is_displayed())
+ self.assertTrue(driver.find_element_by_id("Should_be_removed_when_c.2B.2B11").is_displayed()) # noqa
self.select_cxx11()
- self.assertFalse(driver.find_element_by_id("Should_be_removed_when_c.2B.2B11").is_displayed())
+ self.assertFalse(driver.find_element_by_id("Should_be_removed_when_c.2B.2B11").is_displayed()) # noqa
def test_hides_h3_when_section_contains_only_stdrev(self):
driver = self.driver
- self.get_page("test-gadget-stdrev/hides-h3-when-section-contains-only-stdrev")
- self.assertTrue(driver.find_element_by_id("Should_be_removed_in_cxx98").is_displayed())
+ self.get_page("test-gadget-stdrev/hides-h3-when-section-contains-only-stdrev") # noqa
+ self.assertTrue(driver.find_element_by_id("Should_be_removed_in_cxx98").is_displayed()) # noqa
self.select_cxx98()
- self.assertFalse(driver.find_element_by_id("Should_be_removed_in_cxx98").is_displayed())
+ self.assertFalse(driver.find_element_by_id("Should_be_removed_in_cxx98").is_displayed()) # noqa
self.select_cxx11()
- self.assertTrue(driver.find_element_by_id("Should_be_removed_in_cxx98").is_displayed())
+ self.assertTrue(driver.find_element_by_id("Should_be_removed_in_cxx98").is_displayed()) # noqa
def test_preserves_h3_when_section_visible(self):
driver = self.driver
- self.get_page("test-gadget-stdrev/preserves-h3-when-section-with-h5-visible")
- self.assertTrue(driver.find_element_by_id("Should_always_be_visible").is_displayed())
+ self.get_page("test-gadget-stdrev/preserves-h3-when-section-with-h5-visible") # noqa
+ self.assertTrue(driver.find_element_by_id("Should_always_be_visible").is_displayed()) # noqa
self.select_cxx98()
- self.assertTrue(driver.find_element_by_id("Should_always_be_visible").is_displayed())
+ self.assertTrue(driver.find_element_by_id("Should_always_be_visible").is_displayed()) # noqa
self.select_cxx11()
- self.assertTrue(driver.find_element_by_id("Should_always_be_visible").is_displayed())
+ self.assertTrue(driver.find_element_by_id("Should_always_be_visible").is_displayed()) # noqa
def test_preserves_h3_when_section_with_h5_visible(self):
driver = self.driver
- self.get_page("test-gadget-stdrev/preserves-h3-when-section-with-h5-visible")
- self.assertTrue(driver.find_element_by_id("Should_always_be_visible").is_displayed())
- self.assertTrue(driver.find_element_by_id("Should_always_be_visible2").is_displayed())
- self.assertTrue(driver.find_element_by_id("Should_not_be_visible_in_cxx98").is_displayed())
+ self.get_page("test-gadget-stdrev/preserves-h3-when-section-with-h5-visible") # noqa
+ self.assertTrue(driver.find_element_by_id("Should_always_be_visible").is_displayed()) # noqa
+ self.assertTrue(driver.find_element_by_id("Should_always_be_visible2").is_displayed()) # noqa
+ self.assertTrue(driver.find_element_by_id("Should_not_be_visible_in_cxx98").is_displayed()) # noqa
self.select_cxx98()
- self.assertTrue(driver.find_element_by_id("Should_always_be_visible").is_displayed())
- self.assertTrue(driver.find_element_by_id("Should_always_be_visible2").is_displayed())
- self.assertFalse(driver.find_element_by_id("Should_not_be_visible_in_cxx98").is_displayed())
+ self.assertTrue(driver.find_element_by_id("Should_always_be_visible").is_displayed()) # noqa
+ self.assertTrue(driver.find_element_by_id("Should_always_be_visible2").is_displayed()) # noqa
+ self.assertFalse(driver.find_element_by_id("Should_not_be_visible_in_cxx98").is_displayed()) # noqa
self.select_cxx11()
- self.assertTrue(driver.find_element_by_id("Should_always_be_visible").is_displayed())
- self.assertTrue(driver.find_element_by_id("Should_always_be_visible2").is_displayed())
- self.assertTrue(driver.find_element_by_id("Should_not_be_visible_in_cxx98").is_displayed())
+ self.assertTrue(driver.find_element_by_id("Should_always_be_visible").is_displayed()) # noqa
+ self.assertTrue(driver.find_element_by_id("Should_always_be_visible2").is_displayed()) # noqa
+ self.assertTrue(driver.find_element_by_id("Should_not_be_visible_in_cxx98").is_displayed()) # noqa
diff --git a/gadgets/sync_tests_mwiki.py b/gadgets/sync_tests_mwiki.py
index 9aa3fc70b..b9e13374b 100755
--- a/gadgets/sync_tests_mwiki.py
+++ b/gadgets/sync_tests_mwiki.py
@@ -29,17 +29,17 @@
# command line.
os.environ['PYWIKIBOT2_NO_USER_CONFIG']='1'
-import pywikibot
-import pywikibot.config2
-import pywikibot.pagegenerators
-import pywikibot.data.api
-
import argparse
import itertools
import shutil
import sys
import urllib
+import pywikibot
+import pywikibot.config2
+import pywikibot.data.api
+import pywikibot.pagegenerators
+
SYNC_DIRECTION_UPLOAD = 1
SYNC_DIRECTION_DOWNLOAD = 2
diff --git a/headers/README.md b/headers/README.md
index b3de6dfa2..e44dd4452 100644
--- a/headers/README.md
+++ b/headers/README.md
@@ -1,50 +1,56 @@
Information
-----------
-
+
This directory contains dummy C++ standard library that contains only the
declarations of the C++ standard library interface, to be used as an aid in
code completion.
-Real standard library implementations often use complex C++ techniques in order
-to provide full compliance and perform optimizations. This leads to code
-completion implementations being unable to resolve typedef result and function
-return types, and thus being unable to provide code completion of class members
-when given instance variable. This issue becomes more and more important with
+Real standard library implementations often use complex C++ techniques in order
+to provide full compliance and perform optimizations. This leads to code
+completion implementations being unable to resolve typedef result and function
+return types, and thus being unable to provide code completion of class members
+when given instance variable. This issue becomes more and more important with
widespread use of C++ 'auto' type specifier, because code completion of members
of such variables depend on function return types being correctly resolved.
This dummy library performs various steps to simplify the exposed interface, to
make code completion more useful. In addition to that, descriptive parameter
names are exposed instead of uglified identifiers used in real standard library
-implementations. The parameter names correspond to those provided for
+implementations. The parameter names correspond to those provided for
respective functions in the cppreference.com C++ reference.
+To simplify, noexcept specifiers are omitted from declarations.
+
Configuration
-------------
-The exposed interface depends on the values of the following preprocessor
+The exposed interface depends on the values of the following preprocessor
macros:
- CPPREFERENCE_STDVER: defines the standard version of the interface. Possible
values are 1998, 2003, 2011, 2014, 2017 which correspond to the respective
C++ standards.
-
- - CPPREFERENCE_SIMPLIFY_TYPEDEFS: non-zero value results in simplified
- typedefs being exposed. Usage of various traits is greatly reduced; the
- typedefs refer to types that would be resolved in most common cases.
+
+ - CPPREFERENCE_INT_TYPES_ONLY_IN_STD: non-zero value results in integer types
+ such as std::size_t, std::uint16_t and so on being defined only in std
+ namespace.
+
+ - CPPREFERENCE_SIMPLIFY_TYPEDEFS: non-zero value results in simplified
+ typedefs being exposed. Usage of various traits is greatly reduced; the
+ typedefs refer to types that would be resolved in most common cases.
Enabling this is recommended.
Usage
-----
-The primary target for this dummy C++ standard library is the Qt Creator IDE,
+The primary target for this dummy C++ standard library is the Qt Creator IDE,
though the code might be useful in other IDEs.
-For each Qt Creator project, perform the following steps to replace the
+For each Qt Creator project, perform the following steps to replace the
C++ library used by code completion:
- Add the path to this directory to the $PROJECT.includes file
- Define CPPREFERENCE_STDVER and/or CPPREFERENCE_SIMPLIFY_TYPEDEFS to correct
- values in the $PROJECT.config file.
\ No newline at end of file
+ values in the $PROJECT.config file.
diff --git a/headers/algorithm b/headers/algorithm
index 596f60ce9..86a1ef42d 100644
--- a/headers/algorithm
+++ b/headers/algorithm
@@ -19,6 +19,7 @@
#include
#endif
#include // for std::pair
+#include // for std::iterator_traits
namespace std {
@@ -33,379 +34,446 @@ template
bool none_of(InputIt first, InputIt last, UnaryPredicate p);
#endif
-template
+template
UnaryFunction for_each(InputIt first, InputIt last, UnaryFunction f);
-template
+template
typename iterator_traits::difference_type
-count(InputIt first, InputIt last, const T& value);
+ count(InputIt first, InputIt last, const T& value);
-template
+template
typename iterator_traits::difference_type
-count_if(InputIt first, InputIt last, UnaryPredicate p);
+ count_if(InputIt first, InputIt last, UnaryPredicate p);
+
+#if CPPREFERENCE_STDVER >= 2020
+template
+std::pair
+constexpr mismatch(InputIt1 first1, InputIt1 last1,
+ InputIt2 first2);
+
+template
+std::pair
+constexpr mismatch(InputIt1 first1, InputIt1 last1,
+ InputIt2 first2,
+ BinaryPredicate p);
+#else
+template
+std::pair
+ mismatch(InputIt1 first1, InputIt1 last1,
+ InputIt2 first2);
+
+template
+std::pair
+ mismatch(InputIt1 first1, InputIt1 last1,
+ InputIt2 first2,
+ BinaryPredicate p);
+#endif
-template
+#if CPPREFERENCE_STDVER >= 2017
+template
std::pair
-mismatch(InputIt1 first1, InputIt1 last1,
- InputIt2 first2);
+ mismatch(ExecutionPolicy&& policy,
+ InputIt1 first1, InputIt1 last1,
+ InputIt2 first2);
-template
+template
std::pair
-mismatch(InputIt1 first1, InputIt1 last1,
- InputIt2 first2,
- BinaryPredicate p);
+ mismatch(ExecutionPolicy&& policy,
+ InputIt1 first1, InputIt1 last1,
+ InputIt2 first2,
+ BinaryPredicate p);
+#endif
#if CPPREFERENCE_STDVER >= 2014
-template
+template
+std::pair
+ mismatch(InputIt1 first1, InputIt1 last1,
+ InputIt2 first2, InputIt2 last2);
+
+template
+std::pair
+ mismatch(InputIt1 first1, InputIt1 last1,
+ InputIt2 first2, InputIt2 last2,
+ BinaryPredicate p);
+#endif
+
+#if CPPREFERENCE_STDVER >= 2017
+template
std::pair
-mismatch(InputIt1 first1, InputIt1 last1,
- InputIt2 first2, InputIt2 last2);
+ mismatch(ExecutionPolicy&& policy,
+ InputIt1 first1, InputIt1 last1,
+ InputIt2 first2, InputIt2 last2);
-template
+template
std::pair
-mismatch(InputIt1 first1, InputIt1 last1,
- InputIt2 first2, InputIt2 last2,
- BinaryPredicate p);
+ mismatch(ExecutionPolicy&& policy,
+ InputIt1 first1, InputIt1 last1,
+ InputIt2 first2, InputIt2 last2,
+ BinaryPredicate p);
#endif
-template
+
+template
bool equal(InputIt1 first1, InputIt1 last1,
InputIt2 first2);
-template
+template
bool equal(InputIt1 first1, InputIt1 last1,
InputIt2 first2, BinaryPredicate p);
#if CPPREFERENCE_STDVER >= 2014
-template
+template
bool equal(InputIt1 first1, InputIt1 last1,
InputIt2 first2, InputIt2 last2);
-template
+template
bool equal(InputIt1 first1, InputIt1 last1,
InputIt2 first2, InputIt2 last2,
BinaryPredicate p);
#endif
-template
+#if CPPREFERENCE_STDVER >= 2017
+template
+bool equal(ExecutionPolicy&& policy,
+ InputIt1 first1, InputIt1 last1,
+ InputIt2 first2);
+
+template
+bool equal(ExecutionPolicy&& policy,
+ InputIt1 first1, InputIt1 last1,
+ InputIt2 first2, BinaryPredicate p);
+
+template
+bool equal(ExecutionPolicy&& policy,
+ InputIt1 first1, InputIt1 last1,
+ InputIt2 first2, InputIt2 last2);
+
+template
+bool equal(ExecutionPolicy&& policy,
+ InputIt1 first1, InputIt1 last1,
+ InputIt2 first2, InputIt2 last2,
+ BinaryPredicate p);
+#endif
+
+template
InputIt find(InputIt first, InputIt last, const T& value);
-template
+template
InputIt find_if(InputIt first, InputIt last,
UnaryPredicate p);
#if CPPREFERENCE_STDVER >= 2011
-template
+template
InputIt find_if_not(InputIt first, InputIt last,
UnaryPredicate q);
#endif
-template
+template
ForwardIt1 find_end(ForwardIt1 first, ForwardIt1 last,
ForwardIt2 s_first, ForwardIt2 s_last);
-template
+template
ForwardIt1 find_end(ForwardIt1 first, ForwardIt1 last,
ForwardIt2 s_first, ForwardIt2 s_last, BinaryPredicate p);
#if CPPREFERENCE_STDVER >= 2011
-template
+template
InputIt find_first_of(InputIt first, InputIt last,
ForwardIt s_first, ForwardIt s_last);
-template
+template
InputIt find_first_of(InputIt first, InputIt last,
ForwardIt s_first, ForwardIt s_last, BinaryPredicate p);
#else
-template
+template
ForwardIt1 find_first_of(ForwardIt1 first, ForwardIt1 last,
ForwardIt2 s_first, ForwardIt2 s_last);
-template
+template
ForwardIt1 find_first_of(ForwardIt1 first, ForwardIt1 last,
ForwardIt2 s_first, ForwardIt2 s_last, BinaryPredicate p);
#endif
-template
+template
ForwardIt adjacent_find(ForwardIt first, ForwardIt last);
template
ForwardIt adjacent_find(ForwardIt first, ForwardIt last, BinaryPredicate p);
-template
+template
ForwardIt1 search(ForwardIt1 first, ForwardIt1 last,
ForwardIt2 s_first, ForwardIt2 s_last);
-template
+template
ForwardIt1 search(ForwardIt1 first, ForwardIt1 last,
ForwardIt2 s_first, ForwardIt2 s_last, BinaryPredicate p);
-template
+template
ForwardIt search_n(ForwardIt first, ForwardIt last, Size count, const T& value);
-template
+template
ForwardIt search_n(ForwardIt first, ForwardIt last, Size count, const T& value,
BinaryPredicate p);
-template
+template
OutputIt copy(InputIt first, InputIt last, OutputIt d_first);
#if CPPREFERENCE_STDVER >= 2011
-template
+template
OutputIt copy_if(InputIt first, InputIt last,
OutputIt d_first,
UnaryPredicate pred);
#endif
#if CPPREFERENCE_STDVER >= 2011
-template
+template
OutputIt copy_n(InputIt first, Size count, OutputIt result);
#endif
-template
+template
BidirIt2 copy_backward(BidirIt1 first, BidirIt1 last, BidirIt2 d_last);
#if CPPREFERENCE_STDVER >= 2011
-template
+template
OutputIt move(InputIt first, InputIt last, OutputIt d_first);
#endif
#if CPPREFERENCE_STDVER >= 2011
-template
+template
OutputIt move(InputIt first, InputIt last, OutputIt d_first);
#endif
-template
+template
void fill(ForwardIt first, ForwardIt last, const T& value);
#if CPPREFERENCE_STDVER >= 2011
-template
+template
OutputIt fill_n(OutputIt first, Size count, const T& value);
#else
-template
+template
void fill_n(OutputIt first, Size count, const T& value);
#endif
-template
+template
OutputIt transform(InputIt first1, InputIt last1, OutputIt d_first,
UnaryOperation unary_op);
-template
+template
OutputIt transform(InputIt1 first1, InputIt1 last1, InputIt2 first2,
OutputIt d_first, BinaryOperation binary_op);
-template
+template
void generate(ForwardIt first, ForwardIt last, Generator g);
#if CPPREFERENCE_STDVER >= 2011
-template
+template
OutputIt generate_n(OutputIt first, Size count, Generator g);
#else
-template
+template
void generate_n(OutputIt first, Size count, Generator g);
#endif
-template
+template
ForwardIt remove(ForwardIt first, ForwardIt last, const T& value);
-template
+template
ForwardIt remove_if(ForwardIt first, ForwardIt last, UnaryPredicate p);
-template
+template
OutputIt remove_copy(InputIt first, InputIt last, OutputIt d_first,
const T& value);
-template
+template
OutputIt remove_copy_if(InputIt first, InputIt last, OutputIt d_first,
UnaryPredicate p);
-template
+template
OutputIt remove_copy_if(InputIt first, InputIt last, OutputIt d_first,
UnaryPredicate p);
-template
+template
void replace_if(ForwardIt first, ForwardIt last,
UnaryPredicate p, const T& new_value);
-template
+template
OutputIt replace_copy(InputIt first, InputIt last, OutputIt d_first,
const T& old_value, const T& new_value);
-template
+template
OutputIt replace_copy_if(InputIt first, InputIt last, OutputIt d_first,
UnaryPredicate p, const T& new_value);
// defined in in C++11
#if CPPREFERENCE_STDVER >= 2011
-template
+template
void swap(T& a, T& b);
#endif
-template
+template
ForwardIt2 swap_ranges(ForwardIt1 first1, ForwardIt1 last1, ForwardIt2 first2);
-template
+template
void iter_swap(ForwardIt1 a, ForwardIt2 b);
-template
+template
void reverse(BidirIt first, BidirIt last);
-template
+template
OutputIt reverse_copy(BidirIt first, BidirIt last, OutputIt d_first);
#if CPPREFERENCE_STDVER >= 2011
-template
+template
ForwardIt rotate(ForwardIt first, ForwardIt n_first, ForwardIt last);
#else
-template
+template
void rotate(ForwardIt first, ForwardIt n_first, ForwardIt last);
#endif
-template
+template
OutputIt rotate_copy(ForwardIt first, ForwardIt n_first,
ForwardIt last, OutputIt d_first);
#if CPPREFERENCE_STDVER <2017
// deprecated in C++14
-template
+template
void random_shuffle(RandomIt first, RandomIt last);
#endif
#if CPPREFERENCE_STDVER <2011
-template
+template
void random_shuffle(RandomIt first, RandomIt last, RandomFunc&& r);
#elif CPPREFERENCE_STDVER >= 2011 && CPPREFERENCE_STDVER <2017
// deprecated in C++14
-template
+template
void random_shuffle(RandomIt first, RandomIt last, RandomFunc& r);
#endif
#if CPPREFERENCE_STDVER >= 2011
-template
+template
void shuffle(RandomIt first, RandomIt last, URNG&& g);
#endif
-template
+template
ForwardIt unique(ForwardIt first, ForwardIt last);
-template
+template
ForwardIt unique(ForwardIt first, ForwardIt last, BinaryPredicate p);
-template
+template
OutputIt unique_copy(InputIt first, InputIt last,
OutputIt d_first);
-template
+template
OutputIt unique_copy(InputIt first, InputIt last,
OutputIt d_first, BinaryPredicate p);
#if CPPREFERENCE_STDVER >= 2011
-template
+template
bool is_partitioned(InputIt first, InputIt last, UnaryPredicate p);
#endif
#if CPPREFERENCE_STDVER <2011
-template
+template
BidirIt partition(BidirIt first, BidirIt last, UnaryPredicate p);
#else
-template
+template
ForwardIt partition(ForwardIt first, ForwardIt last, UnaryPredicate p);
#endif
#if CPPREFERENCE_STDVER >= 2011
template
+ class OutputIt2, class UnaryPredicate>
std::pair
partition_copy(InputIt first, InputIt last,
OutputIt1 d_first_true, OutputIt2 d_first_false,
UnaryPredicate p);
#endif
-template
+template
BidirIt stable_partition(BidirIt first, BidirIt last, UnaryPredicate p);
#if CPPREFERENCE_STDVER >= 2011
-template
+template
ForwardIt partition_point(ForwardIt first, ForwardIt last, UnaryPredicate p);
#endif
#if CPPREFERENCE_STDVER >= 2011
-template
+template
bool is_sorted(ForwardIt first, ForwardIt last);
-template
+template
bool is_sorted(ForwardIt first, ForwardIt last, Compare comp);
-template
+template
ForwardIt is_sorted_until(ForwardIt first, ForwardIt last);
-template
+template
ForwardIt is_sorted_until(ForwardIt first, ForwardIt last,
Compare comp);
#endif
-template
+template
void sort(RandomIt first, RandomIt last);
-template
+template
void sort(RandomIt first, RandomIt last, Compare comp);
-template
+template
void partial_sort(RandomIt first, RandomIt middle, RandomIt last);
-template
+template
void partial_sort(RandomIt first, RandomIt middle, RandomIt last, Compare comp);
-template
+template
RandomIt partial_sort_copy(InputIt first, InputIt last,
RandomIt d_first, RandomIt d_last);
-template
+template
RandomIt partial_sort_copy(InputIt first, InputIt last,
RandomIt d_first, RandomIt d_last,
Compare comp);
-template
+template
void stable_sort(RandomIt first, RandomIt last);
-template
+template
void stable_sort(RandomIt first, RandomIt last, Compare comp);
-template
+template
void nth_element(RandomIt first, RandomIt nth, RandomIt last);
-template
+template
void nth_element(RandomIt first, RandomIt nth, RandomIt last, Compare comp);
-template
+template
ForwardIt lower_bound(ForwardIt first, ForwardIt last, const T& value);
-template
+template
ForwardIt lower_bound(ForwardIt first, ForwardIt last, const T& value, Compare comp);
-template
+template
ForwardIt upper_bound(ForwardIt first, ForwardIt last, const T& value);
-template
+template
ForwardIt upper_bound(ForwardIt first, ForwardIt last, const T& value, Compare comp);
-template
+template
bool binary_search(ForwardIt first, ForwardIt last, const T& value);
-template
+template
bool binary_search(ForwardIt first, ForwardIt last, const T& value, Compare comp);
-template
+template
std::pair
equal_range(ForwardIt first, ForwardIt last,
const T& value);
-template
+template
std::pair
equal_range(ForwardIt first, ForwardIt last,
const T& value, Compare comp);
-template
+template
OutputIt merge(InputIt1 first1, InputIt1 last1,
InputIt2 first2, InputIt2 last2,
OutputIt d_first);
@@ -415,274 +483,299 @@ OutputIt merge(InputIt1 first1, InputIt1 last1,
InputIt2 first2, InputIt2 last2,
OutputIt d_first, Compare comp);
-template
+template
void inplace_merge(BidirIt first, BidirIt middle, BidirIt last);
template
void inplace_merge(BidirIt first, BidirIt middle, BidirIt last, Compare comp);
-template
+template
bool includes(InputIt1 first1, InputIt1 last1,
InputIt2 first2, InputIt2 last2);
-template
+template
bool includes(InputIt1 first1, InputIt1 last1,
InputIt2 first2, InputIt2 last2, Compare comp);
-template
+template
OutputIt set_difference(InputIt1 first1, InputIt1 last1,
InputIt2 first2, InputIt2 last2,
OutputIt d_first);
template
+ class OutputIt, class Compare>
OutputIt set_difference(InputIt1 first1, InputIt1 last1,
InputIt2 first2, InputIt2 last2,
OutputIt d_first, Compare comp);
-template
+template
OutputIt set_intersection(InputIt1 first1, InputIt1 last1,
InputIt2 first2, InputIt2 last2,
OutputIt d_first);
template
+ class OutputIt, class Compare>
OutputIt set_intersection(InputIt1 first1, InputIt1 last1,
InputIt2 first2, InputIt2 last2,
OutputIt d_first, Compare comp);
-template
+template
OutputIt set_symmetric_difference(InputIt1 first1, InputIt1 last1,
InputIt2 first2, InputIt2 last2,
OutputIt d_first);
template