commit ccb2fc7ae5b29fdad93b6805235edbf6566f7bc4 Author: King_DuckZ Date: Thu Jul 14 14:59:15 2016 +0100 First import Files taken directly from dindexer diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/include/duckhandy/MaxSizedArray.hpp b/include/duckhandy/MaxSizedArray.hpp new file mode 100644 index 0000000..72d3804 --- /dev/null +++ b/include/duckhandy/MaxSizedArray.hpp @@ -0,0 +1,117 @@ +/* Copyright 2016, Michele Santullo + * This file is part of "duckhandy". + * + * "duckhandy" 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. + * + * "duckhandy" 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 "duckhandy". If not, see . + */ + +#ifndef idBC9F804ADD33468A9C7657E823FFC706 +#define idBC9F804ADD33468A9C7657E823FFC706 + +#include "implem/AutomemBase.hpp" +#include "implem/IteratorOnPtr.hpp" +#include +#include +#include +#include +#include + +namespace dhandy { + const size_t MAXSZARR_MAX_STACK_ALLOC_SIZE = MAX_STACK_ALLOC_SIZE; + + //TODO: add a template parameter to force stack allocation regardless of + //sizeof(T) * S + template > + class MaxSizedArray : + private std::conditional< + (sizeof(T) * S > (MAXSZARR_MAX_STACK_ALLOC_SIZE > 4 * sizeof(T*) ? MAXSZARR_MAX_STACK_ALLOC_SIZE - sizeof(T*) : MAXSZARR_MAX_STACK_ALLOC_SIZE)), + AutomemRawBase_heap, + AutomemRawBase_stack + >::type + { + typedef typename std::conditional< + (sizeof(T) * S > (MAXSZARR_MAX_STACK_ALLOC_SIZE > 4 * sizeof(T*) ? MAXSZARR_MAX_STACK_ALLOC_SIZE - sizeof(T*) : MAXSZARR_MAX_STACK_ALLOC_SIZE)), + AutomemRawBase_heap, + AutomemRawBase_stack + >::type parent_type; + + public: + typedef IteratorOnPtr iterator; + typedef IteratorOnPtr const_iterator; + typedef IteratorOnPtr reverse_iterator; + typedef IteratorOnPtr const_reverse_iterator; + typedef T& reference; + typedef T&& mov_reference; + typedef const T& const_reference; + typedef size_t size_type; + typedef ptrdiff_t difference_type; + typedef T value_type; + typedef T* pointer; + typedef const T* const_pointer; + + enum MAX_SIZE_ENUM { + MAX_SIZE = S + }; + + MaxSizedArray ( void ); + MaxSizedArray ( const MaxSizedArray& parOther ); + MaxSizedArray ( MaxSizedArray&& parOther ); + ~MaxSizedArray ( void ); + + bool empty ( void ) const; + size_type size ( void ) const; + size_type capacity ( void ) const { return S; } + size_type max_size ( void ) const { return S; } + void push_back ( const value_type& parNewItem ); + void push_back ( value_type&& parNewItem ); + void pop_back ( void ); + iterator erase ( const iterator& parDele ); + iterator erase ( const iterator& parFrom, const iterator& parToExcl ); + void clear ( void ); + reference operator[] ( size_type parIndex ) &; + mov_reference operator[] ( size_type parIndex ) &&; + const_reference operator[] ( size_type parIndex ) const &; + MaxSizedArray& operator= ( const MaxSizedArray& parOther ); + bool operator== ( const MaxSizedArray& parOther ) const; + bool operator!= ( const MaxSizedArray& parOther ) const; + pointer GetPointer ( void ); + const_pointer GetPointer ( void ) const; + void reserve ( size_type parReserve ); + + iterator begin ( void ); + const_iterator begin ( void ) const; + iterator end ( void ); + const_iterator end ( void ) const; + reverse_iterator rbegin ( void ); + const_reverse_iterator rbegin ( void ) const; + reverse_iterator rend ( void ); + const_reverse_iterator rend ( void ) const; + reference front ( void ) & { return (*this)[0]; } + reference back ( void ) & { return (*this)[size() - 1]; } + mov_reference front ( void ) && { return (*this)[0]; } + mov_reference back ( void ) && { return (*this)[size() - 1]; } + const_reference front ( void ) const & { return (*this)[0]; } + const_reference back ( void ) const & { return (*this)[size() - 1]; } + + private: + pointer GetPointer_NoAssert ( void ) { return m_localMem; } + const_pointer GetPointer_NoAssert ( void ) const { return m_localMem; } + + T* m_localMem; //A copy of memory pointer is required + size_type m_used; + }; +} //namespace dhandy + +#include "MaxSizedArray.inl" + +#endif diff --git a/include/duckhandy/MaxSizedArray.inl b/include/duckhandy/MaxSizedArray.inl new file mode 100644 index 0000000..6b804cc --- /dev/null +++ b/include/duckhandy/MaxSizedArray.inl @@ -0,0 +1,289 @@ +/* Copyright 2016, Michele Santullo + * This file is part of "duckhandy". + * + * "duckhandy" 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. + * + * "duckhandy" 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 "duckhandy". If not, see . + */ + +namespace dhandy { + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + MaxSizedArray::MaxSizedArray() { + m_localMem = this->AllocMemory(); + m_used = 0; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + MaxSizedArray::MaxSizedArray (const MaxSizedArray& parOther) : + parent_type(), + m_used(0) + { + m_localMem = this->AllocMemory(); + const size_type count = parOther.size(); + for (size_type z = 0; z < count; ++z) { + this->push_back(parOther[z]); + } + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + MaxSizedArray::MaxSizedArray (MaxSizedArray&& parOther) : + parent_type(), + m_used(0) + { + m_localMem = this->AllocMemory(); + const size_type count = parOther.size(); + for (size_type z = 0; z < count; ++z) { + this->push_back(std::move(parOther[z])); + } + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + MaxSizedArray::~MaxSizedArray() { + this->clear(); + this->FreeMemory(); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + bool MaxSizedArray::empty() const { + return 0 == m_used; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::size_type MaxSizedArray::size() const { + return m_used; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + void MaxSizedArray::push_back (value_type&& parNewItem) { + assert(size() < capacity()); + this->GetNewT(m_used, std::move(parNewItem)); + ++m_used; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + void MaxSizedArray::push_back (const value_type& parNewItem) { + assert(size() < capacity()); + this->GetNewT(m_used, parNewItem); + ++m_used; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + void MaxSizedArray::pop_back() { + assert(not empty()); + m_localMem[m_used - 1].~T(); + --m_used; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::reference MaxSizedArray::operator[] (size_type parIndex) & { + assert(parIndex < size()); + return m_localMem[parIndex]; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::mov_reference MaxSizedArray::operator[] (size_type parIndex) && { + assert(parIndex < size()); + return std::move(m_localMem[parIndex]); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::const_reference MaxSizedArray::operator[] (size_type parIndex) const & { + assert(parIndex < size()); + return m_localMem[parIndex]; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + MaxSizedArray& MaxSizedArray::operator= (const MaxSizedArray& parOther) { + m_used = parOther.m_used; + std::copy(parOther.GetMemPtr(), parOther.GetMemPtr() + parOther.size(), this->GetMemPtr()); + return *this; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + bool MaxSizedArray::operator== (const MaxSizedArray& parOther) const { + if (size() != parOther.size()) + return false; + for (size_type z = 0; z < size(); ++z) { + if ((*this)[z] != parOther[z]) + return false; + } + return true; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + bool MaxSizedArray::operator!= (const MaxSizedArray& parOther) const { + return not (*this == parOther); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::pointer MaxSizedArray::GetPointer() { + assert(size() > 0); + return GetPointer_NoAssert(); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::const_pointer MaxSizedArray::GetPointer() const { + assert(size() > 0); + return GetPointer_NoAssert(); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + void MaxSizedArray::clear() { + const size_type count = this->size(); + for (size_type z = 0; z < count; ++z) { + (*this)[z].~T(); + } + m_used = 0; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::iterator MaxSizedArray::begin() { + return iterator(GetPointer_NoAssert(), size()); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::const_iterator MaxSizedArray::begin() const { + return const_iterator(GetPointer_NoAssert(), size()); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::iterator MaxSizedArray::end() { + return iterator(GetPointer_NoAssert() + size(), 0); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::const_iterator MaxSizedArray::end() const { + return const_iterator(GetPointer_NoAssert() + size(), 0); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::reverse_iterator MaxSizedArray::rbegin() { + return reverse_iterator(GetPointer_NoAssert() + size() - 1, size()); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::const_reverse_iterator MaxSizedArray::rbegin() const { + return const_reverse_iterator(GetPointer_NoAssert() + size() - 1, size()); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::reverse_iterator MaxSizedArray::rend() { + return reverse_iterator(GetPointer_NoAssert() - 1, 0); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::const_reverse_iterator MaxSizedArray::rend() const { + return const_reverse_iterator(GetPointer_NoAssert() - 1, 0); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::iterator MaxSizedArray::erase (const iterator& parDele) { + assert(end() != parDele); + return erase(parDele, parDele + 1); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename MaxSizedArray::iterator MaxSizedArray::erase (const iterator& parFrom, const iterator& parToExcl) { + assert(parFrom >= begin()); + assert(parToExcl <= end()); + assert(parToExcl >= parFrom); + + //I'm doing this in two passes: first, I'm deleting as many elements as + //the ones that would be left at the end (that is, delete and move), + //then delete everything to the end of the buffer, if necessary. + const size_type deleCount = static_cast(parToExcl - parFrom); + const size_type firstIndexToDele = static_cast(parFrom - begin()); + const size_type& sz = m_used; + assert(firstIndexToDele + deleCount <= sz); + const size_type deleAndCopyCount = sz - (firstIndexToDele + deleCount); + + //As said, make room and copy from the cut tail + for (size_type z = firstIndexToDele; z < firstIndexToDele + deleAndCopyCount; z++) { + (*this)[z].~T(); + new(&(*this)[z]) T((*this)[z + deleCount]); + } + + //Any leftover is rubbish + for (size_type z = firstIndexToDele + deleAndCopyCount; z < sz; z++) { + (*this)[z].~T(); + } + + m_used -= deleCount; + return begin() + firstIndexToDele; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + void MaxSizedArray::reserve (size_type parReserve) { + assert(parReserve <= S); + if (parReserve > S) { + throw std::length_error("Unable to reserve more memory than the build-time size for MaxSizedArray"); + } + } +} //namespace dhandy diff --git a/include/duckhandy/cmake_on_off.h b/include/duckhandy/cmake_on_off.h new file mode 100644 index 0000000..554aeee --- /dev/null +++ b/include/duckhandy/cmake_on_off.h @@ -0,0 +1,38 @@ +/* Copyright 2016, Michele Santullo + * This file is part of "duckhandy". + * + * "duckhandy" 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. + * + * "duckhandy" 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 "duckhandy". If not, see . + */ + +#ifndef id9B6B373E88404330ADEE51A4EC861787 +#define id9B6B373E88404330ADEE51A4EC861787 + +#if !defined(CMAKE_ON) +# define CMAKE_ON 1 +# define CMAKE_on 1 +# define CMAKE_On 1 +# define CMAKE_oN 1 +#endif +#if !defined(CMAKE_OFF) +# define CMAKE_OFF 0 +# define CMAKE_OFf 0 +# define CMAKE_OfF 0 +# define CMAKE_Off 0 +# define CMAKE_oFF 0 +# define CMAKE_oFf 0 +# define CMAKE_ofF 0 +# define CMAKE_off 0 +#endif + +#endif diff --git a/include/duckhandy/compatibility.h b/include/duckhandy/compatibility.h new file mode 100644 index 0000000..6704b1d --- /dev/null +++ b/include/duckhandy/compatibility.h @@ -0,0 +1,62 @@ +/* Copyright 2016, Michele Santullo + * This file is part of "duckhandy". + * + * "duckhandy" 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. + * + * "duckhandy" 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 "duckhandy". If not, see . + */ + +#ifndef id45CDD1DAEF4F42968E3C89F68FDDA9BC +#define id45CDD1DAEF4F42968E3C89F68FDDA9BC + +#if defined(__GNUC__) +# if defined(__clang__) +# if !defined(__has_attribute) + //Fall back to version number comparing +# else +# if __has_attribute(flatten) +# define a_flatten __attribute__((flatten)) +# else +# define a_flatten +# endif +# if __has_attribute(always_inline) +# define a_always_inline __attribute__((always_inline)) +# else +# define a_always_inline +# endif +# if __has_attribute(pure) +# define a_pure __attribute__((pure)) +# else +# define a_pure +# endif +# if __has_attribute(deprecated) +# define a_deprecated __attribute__((deprecated)) +# else +# define a_deprecated +#endif +# endif +# else + //Fix here if you get warnings about unsupported attributes on your compiler +# define a_flatten __attribute__((flatten)) +# define a_always_inline __attribute__((always_inline)) +# define a_pure __attribute__((pure)) +# define a_deprecated __attribute__((deprecated)) +# endif +#else +# warning "Unsupported compiler, please fill this section or file a bug" +# define a_flatten +# define a_always_inline +# define a_pure +# define a_deprecated +#endif + +#endif diff --git a/include/duckhandy/has_method.hpp b/include/duckhandy/has_method.hpp new file mode 100644 index 0000000..d641771 --- /dev/null +++ b/include/duckhandy/has_method.hpp @@ -0,0 +1,54 @@ +/* + * Copyright 2015 Michele "King_DuckZ" Santullo + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef idFBC29C5127784D35BE62F7BAC16E3687 +#define idFBC29C5127784D35BE62F7BAC16E3687 + +#define define_has_method(method_name,pretty_name) \ + template \ + struct Has ## pretty_name ## Method { \ + private: \ + struct TrueType { int a[2]; }; \ + typedef int FalseType; \ + template static TrueType has_method ( decltype(&C::method_name) ); \ + template static FalseType has_method ( ... ); \ + public: \ + enum { value = sizeof(has_method(0)) == sizeof(TrueType) }; \ + } +#define define_has_typedef(typedef_name,pretty_name) \ + template \ + struct Has ## pretty_name ## Typedef { \ + private: \ + struct TrueType { int a[2]; }; \ + typedef int FalseType; \ + template static TrueType has_typedef ( const typename C::typedef_name* ); \ + template static FalseType has_typedef ( ... ); \ + public: \ + enum { value = sizeof(has_typedef(nullptr)) == sizeof(TrueType) }; \ + } +#define define_has_enum(enum_name,pretty_name) \ + template \ + struct Has ## pretty_name ## Enum { \ + private: \ + struct TrueType { int a[2]; }; \ + typedef int FalseType; \ + template static TrueType has_enum ( decltype(C::enum_name)* ); \ + template static FalseType has_enum ( ... ); \ + public:\ + enum { value = sizeof(has_enum(nullptr)) == sizeof(TrueType) }; \ + } + +#endif diff --git a/include/duckhandy/implem/AutomemBase.hpp b/include/duckhandy/implem/AutomemBase.hpp new file mode 100644 index 0000000..1a25461 --- /dev/null +++ b/include/duckhandy/implem/AutomemBase.hpp @@ -0,0 +1,91 @@ +/* Copyright 2016, Michele Santullo + * This file is part of "duckhandy". + * + * "duckhandy" 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. + * + * "duckhandy" 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 "duckhandy". If not, see . + */ + +#ifndef idDB299AE3079F4830BB1D543C07F7B594 +#define idDB299AE3079F4830BB1D543C07F7B594 + +//Classes in this file are low level and only intended to be used by library +//code. They don't do much by themselves and shoud never be used from outside. + +#include +#include +#include +#include + +#if !defined(NDEBUG) +# define ASSERTIONSENABLED +#endif + +namespace dhandy { + const size_t MAX_STACK_ALLOC_SIZE = 128; + + ///------------------------------------------------------------------------- + ///Heap-based allocation, only gets raw memory + ///------------------------------------------------------------------------- + template > + class AutomemRawBase_heap { + protected: + AutomemRawBase_heap ( void ); + AutomemRawBase_heap ( const AutomemRawBase_heap& ) = delete; //Copy ctor can't be implemented at this level + AutomemRawBase_heap ( AutomemRawBase_heap&& parOther ); + + template + T* GetNewT ( size_t parIndex, Args&&... parArgs ); + T* AllocMemory ( void ); + void FreeMemory ( void ) noexcept; + void swap ( AutomemRawBase_heap& parOther ) noexcept { std::swap(m_localMem, parOther.m_localMem); } + private: + void operator= (const AutomemRawBase_heap&); + +#if defined(ASSERTIONSENABLED) + typedef uintptr_t PTR_INT_TYPE; + static_assert(sizeof(PTR_INT_TYPE) == sizeof(char*), "Wrong uintptr_t size"); +#endif + T* m_localMem; + }; + + ///------------------------------------------------------------------------- + ///Stack-based allocation, only gets raw memory + ///------------------------------------------------------------------------- + template + class AutomemRawBase_stack { + protected: + AutomemRawBase_stack ( void ) = default; + AutomemRawBase_stack ( const AutomemRawBase_stack& ) = delete; //Copy ctor can't be implemented at this level + AutomemRawBase_stack ( AutomemRawBase_stack&& ) = delete; + ~AutomemRawBase_stack ( void ) = default; + + template + T* GetNewT ( size_t parIndex, Args&&... parArgs ); + T* AllocMemory ( void ); + void FreeMemory ( void ) noexcept { return; } + private: +#if defined(ASSERTIONSENABLED) + typedef uintptr_t PTR_INT_TYPE; + static_assert(sizeof(PTR_INT_TYPE) == sizeof(char*), "Wrong uintptr_t size"); +#endif + void operator= (const AutomemRawBase_stack&); + typename std::aligned_storage::type m_localMem[S]; + }; +} //namespace dhandy + +#include "AutomemBase.inl" + +#if defined(ASSERTIONSENABLED) +# undef ASSERTIONSENABLED +#endif +#endif diff --git a/include/duckhandy/implem/AutomemBase.inl b/include/duckhandy/implem/AutomemBase.inl new file mode 100644 index 0000000..65bd579 --- /dev/null +++ b/include/duckhandy/implem/AutomemBase.inl @@ -0,0 +1,118 @@ +/* Copyright 2016, Michele Santullo + * This file is part of "duckhandy". + * + * "duckhandy" 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. + * + * "duckhandy" 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 "duckhandy". If not, see . + */ + +namespace dhandy { + namespace { +#if defined(ASSERTIONSENABLED) + const char g_guard = 0xAB; +#endif + } //unnamed namespace + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + AutomemRawBase_heap::AutomemRawBase_heap() { +#if !defined(NDEBUG) + m_localMem = nullptr; +#endif + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + AutomemRawBase_heap::AutomemRawBase_heap (AutomemRawBase_heap&& parOther) { +#if !defined(NDEBUG) + m_localMem = nullptr; +#endif + this->swap(parOther); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + T* AutomemRawBase_heap::AllocMemory() { +#if !defined(NDEBUG) + assert(nullptr == m_localMem); +#endif + m_localMem = A().allocate(S); +#if defined(ASSERTIONSENABLED) + assert(reinterpret_cast(m_localMem) % alignof(T) == 0); //Make sure alignment is correct + std::fill( + reinterpret_cast(&m_localMem[0]), + reinterpret_cast(&m_localMem[0]) + sizeof(m_localMem), + g_guard + ); +#endif + return m_localMem; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + void AutomemRawBase_heap::FreeMemory() noexcept { +#if !defined(NDEBUG) + assert(nullptr != m_localMem); +#endif + A().deallocate(m_localMem, S); +#if !defined(NDEBUG) + m_localMem = nullptr; +#endif + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + template + T* AutomemRawBase_heap::GetNewT (size_t parIndex, Args&&... parArgs) { + assert(parIndex < S); + T* const location = m_localMem + parIndex; +#if defined(ASSERTIONSENABLED) + assert(reinterpret_cast(location) % alignof(T) == 0); + assert(g_guard == *reinterpret_cast(location)); +#endif + return new(location) T(std::forward(parArgs)...); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + T* AutomemRawBase_stack::AllocMemory() { +#if defined(ASSERTIONSENABLED) + assert(reinterpret_cast(m_localMem) % alignof(T) == 0); //Make sure alignment is correct + std::fill( + reinterpret_cast(&m_localMem[0]), + reinterpret_cast(&m_localMem[0]) + sizeof(m_localMem), + g_guard + ); +#endif + return reinterpret_cast(&m_localMem[0]); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + template + T* AutomemRawBase_stack::GetNewT (size_t parIndex, Args&&... parArgs) { + assert(parIndex < S); + auto* const location = &m_localMem[parIndex]; +#if defined(ASSERTIONSENABLED) + assert(reinterpret_cast(location) % alignof(T) == 0); + assert(g_guard == *reinterpret_cast(location)); +#endif + return new(location) T(std::forward(parArgs)...); + } +} //namespace dhandy diff --git a/include/duckhandy/implem/IteratorOnPtr.hpp b/include/duckhandy/implem/IteratorOnPtr.hpp new file mode 100644 index 0000000..0bddefc --- /dev/null +++ b/include/duckhandy/implem/IteratorOnPtr.hpp @@ -0,0 +1,314 @@ +/* Copyright 2016, Michele Santullo + * This file is part of "duckhandy". + * + * "duckhandy" 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. + * + * "duckhandy" 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 "duckhandy". If not, see . + */ + +#ifndef id1B822B1775424D879AA6AD1739B5BC91 +#define id1B822B1775424D879AA6AD1739B5BC91 + +#include +#include +#include +#include + +namespace dhandy { + namespace implem_iop { + template + class IteratorOnPtr_base : public std::iterator { + typedef std::iterator parent_type; + public: + //Typedefs to be STL-compliant + typedef typename parent_type::iterator_category iterator_category; + typedef typename parent_type::value_type value_type; + typedef typename parent_type::difference_type difference_type; + typedef typename parent_type::pointer pointer; + typedef typename std::remove_reference::type& reference; + + IteratorOnPtr_base ( P parPointer, difference_type parSize ); + IteratorOnPtr_base ( const IteratorOnPtr_base& parOther ); + template + explicit IteratorOnPtr_base ( const IteratorOnPtr_base& parOther ); + ~IteratorOnPtr_base ( void ); + + difference_type operator- ( const IteratorOnPtr_base& parOther ) const; + + bool operator== ( const IteratorOnPtr_base& parOther ) const { return m_pointer == parOther.m_pointer; } + bool operator!= ( const IteratorOnPtr_base& parOther ) const { return not operator==(parOther); } + bool operator< ( const IteratorOnPtr_base& parOther ) const { return m_pointer < parOther.m_pointer; } + bool operator>= ( const IteratorOnPtr_base& parOther ) const { return not operator<(parOther); } + bool operator> ( const IteratorOnPtr_base& parOther ) const { return parOther < *this; } + bool operator<= ( const IteratorOnPtr_base& parOther ) const { return not operator>(parOther); } + + P GetPointer ( void ) { return m_pointer; } + const P GetPointer ( void ) const { return m_pointer; } +#if !defined(NDEBUG) + difference_type GetSize ( void ) const { return GetSize(0); } +#endif + + protected: + enum { + STEP = (I < 0 ? -I : I) + }; + +#if !defined(NDEBUG) + difference_type GetSize ( difference_type parAdvance ) const; + bool CanAdvance ( difference_type parAdvance ) const; + void AlterSize ( difference_type parAdvance ); +#endif + void MoveIterator ( difference_type parAdvance ); + + P m_pointer; + + private: +#if !defined(NDEBUG) + difference_type m_size; +#endif + }; + } //namespace implem_iop + + template + class IteratorOnPtr : public implem_iop::IteratorOnPtr_base { + typedef implem_iop::IteratorOnPtr_base parent_type; + enum { + STEP = parent_type::STEP + }; + public: + typedef typename parent_type::iterator_category iterator_category; + typedef typename parent_type::value_type value_type; + typedef typename parent_type::difference_type difference_type; + typedef typename parent_type::pointer pointer; + typedef typename parent_type::reference reference; + + IteratorOnPtr ( void ); + IteratorOnPtr ( P parPointer, difference_type parSize ); + IteratorOnPtr ( const IteratorOnPtr& parOther ) : parent_type(parOther) { return; } + template + IteratorOnPtr ( const IteratorOnPtr& parOther ) : parent_type(parOther) {} + ~IteratorOnPtr ( void ); + + IteratorOnPtr& operator++ ( void ); //pre + IteratorOnPtr operator++ ( int ); //post + IteratorOnPtr& operator-- ( void ); + IteratorOnPtr operator-- ( int ); + reference operator* ( void ); + pointer operator-> ( void ); + + using parent_type::operator-; + IteratorOnPtr operator+ ( difference_type parOther ) const; + IteratorOnPtr operator- ( difference_type parOther ) const; + IteratorOnPtr& operator+= ( difference_type parOther ); + IteratorOnPtr& operator-= ( difference_type parOther ); + protected: + private: + }; + + namespace implem_iop { + ///--------------------------------------------------------------------- + ///--------------------------------------------------------------------- + template +#if !defined(NDEBUG) + IteratorOnPtr_base::IteratorOnPtr_base (P parPointer, difference_type parSize) : + m_pointer(parPointer), + m_size(parSize) +#else + IteratorOnPtr_base::IteratorOnPtr_base (P parPointer, difference_type) : + m_pointer(parPointer) +#endif + { + static_assert(I != 0, "Step must be non-zero"); + } + + ///--------------------------------------------------------------------- + ///--------------------------------------------------------------------- + template + template + IteratorOnPtr_base::IteratorOnPtr_base (const IteratorOnPtr_base& parOther) { + m_pointer = parOther.GetPointer(); +#if !defined(NDEBUG) + m_size = parOther.GetSize(); +#endif + } + + ///--------------------------------------------------------------------- + ///--------------------------------------------------------------------- + template + IteratorOnPtr_base::IteratorOnPtr_base (const IteratorOnPtr_base& parOther) { + m_pointer = parOther.m_pointer; +#if !defined(NDEBUG) + m_size = parOther.m_size; +#endif + } + + ///--------------------------------------------------------------------- + ///--------------------------------------------------------------------- + template + IteratorOnPtr_base::~IteratorOnPtr_base() { + } + + ///--------------------------------------------------------------------- + ///--------------------------------------------------------------------- + template + typename IteratorOnPtr_base::difference_type IteratorOnPtr_base::operator- (const IteratorOnPtr_base& parOther) const { + if (I > 0) + return m_pointer - parOther.m_pointer; + else + return parOther.m_pointer - m_pointer; + } + +#if !defined(NDEBUG) + ///--------------------------------------------------------------------- + ///--------------------------------------------------------------------- + template + typename IteratorOnPtr_base::difference_type IteratorOnPtr_base::GetSize (difference_type parAdvance) const { + return m_size - STEP * parAdvance; + } + + ///--------------------------------------------------------------------- + ///--------------------------------------------------------------------- + template + bool IteratorOnPtr_base::CanAdvance (difference_type parAdvance) const { + return (m_size >= STEP * parAdvance); + } + + ///--------------------------------------------------------------------- + ///--------------------------------------------------------------------- + template + void IteratorOnPtr_base::AlterSize (difference_type parAdvance) { + m_size = GetSize(parAdvance); + } +#endif + + ///--------------------------------------------------------------------- + ///--------------------------------------------------------------------- + template + void IteratorOnPtr_base::MoveIterator (difference_type parAdvance) { +#if !defined(NDEBUG) + assert(CanAdvance(parAdvance)); + AlterSize(parAdvance); +#endif + m_pointer += I * parAdvance; + } + } //namespace implem_iop + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + IteratorOnPtr::IteratorOnPtr() : + parent_type(NULL, 0) + { + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + IteratorOnPtr::IteratorOnPtr (P parPointer, difference_type parSize) : + parent_type(parPointer, parSize) + { + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + IteratorOnPtr::~IteratorOnPtr() { + } + + ///------------------------------------------------------------------------- + ///Pre-increment. + ///------------------------------------------------------------------------- + template + IteratorOnPtr& IteratorOnPtr::operator++() { + this->MoveIterator(1); + return *this; + } + + ///------------------------------------------------------------------------- + ///Post-increment. + ///------------------------------------------------------------------------- + template + IteratorOnPtr IteratorOnPtr::operator++ (int) { + IteratorOnPtr retVal(*this); + this->MoveIterator(1); + return retVal; + } + + ///------------------------------------------------------------------------- + ///Pre-decrement. + ///------------------------------------------------------------------------- + template + IteratorOnPtr& IteratorOnPtr::operator--() { + this->MoveIterator(-1); + return *this; + } + + ///------------------------------------------------------------------------- + ///Post-decrement. + ///------------------------------------------------------------------------- + template + IteratorOnPtr IteratorOnPtr::operator-- (int) { + IteratorOnPtr retVal(*this); + this->MoveIterator(-1); + return retVal; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename IteratorOnPtr::reference IteratorOnPtr::operator*() { + return *(this->m_pointer); + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + typename IteratorOnPtr::pointer IteratorOnPtr::operator->() { + return this->m_pointer; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + IteratorOnPtr IteratorOnPtr::operator+ (difference_type parOther) const { + IteratorOnPtr retVal(*this); + retVal += parOther; + return retVal; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + IteratorOnPtr IteratorOnPtr::operator- (difference_type parOther) const { + IteratorOnPtr retVal(*this); + retVal -= parOther; + return retVal; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + IteratorOnPtr& IteratorOnPtr::operator+= (difference_type parOther) { + this->MoveIterator(parOther); + return *this; + } + + ///------------------------------------------------------------------------- + ///------------------------------------------------------------------------- + template + IteratorOnPtr& IteratorOnPtr::operator-= (difference_type parOther) { + this->MoveIterator(-parOther); + return *this; + } +} //namespace dhandy + +#endif diff --git a/include/duckhandy/infix_iterator.hpp b/include/duckhandy/infix_iterator.hpp new file mode 100644 index 0000000..ca65e34 --- /dev/null +++ b/include/duckhandy/infix_iterator.hpp @@ -0,0 +1,48 @@ +// see http://stackoverflow.com/questions/3496982/printing-lists-with-commas-c/3497021#3497021 +// infix_iterator.h +// +// Lifted from Jerry Coffin's 's prefix_ostream_iterator +#if !defined(INFIX_ITERATOR_H_) +#define INFIX_ITERATOR_H_ +#include +#include +template > +class infix_ostream_iterator : + public std::iterator +{ + std::basic_ostream *os; + charT const* delimiter; + bool first_elem; +public: + typedef charT char_type; + typedef traits traits_type; + typedef std::basic_ostream ostream_type; + infix_ostream_iterator(ostream_type& s) + : os(&s),delimiter(0), first_elem(true) + {} + infix_ostream_iterator(ostream_type& s, charT const *d) + : os(&s),delimiter(d), first_elem(true) + {} + infix_ostream_iterator& operator=(T const &item) + { + // Here's the only real change from ostream_iterator: + // Normally, the '*os << item;' would come before the 'if'. + if (!first_elem && delimiter != 0) + *os << delimiter; + *os << item; + first_elem = false; + return *this; + } + infix_ostream_iterator &operator*() { + return *this; + } + infix_ostream_iterator &operator++() { + return *this; + } + infix_ostream_iterator &operator++(int) { + return *this; + } +}; +#endif diff --git a/include/duckhandy/lengthof.h b/include/duckhandy/lengthof.h new file mode 100644 index 0000000..f4fdc9e --- /dev/null +++ b/include/duckhandy/lengthof.h @@ -0,0 +1,37 @@ +/* Copyright 2016, Michele Santullo + * This file is part of "duckhandy". + * + * "duckhandy" 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. + * + * "duckhandy" 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 "duckhandy". If not, see . + */ + +#ifndef id19B690A53A9546D5BD95D89FFF388283 +#define id19B690A53A9546D5BD95D89FFF388283 + +#if defined(__cplusplus) +# include +#else +# include +#endif + +#if defined(lengthof) +# undef lengthof +#endif +//http://stackoverflow.com/questions/4415524/common-array-length-macro-for-c#4415646 +#if defined(__cplusplus) +# define lengthof(x) ((sizeof(x)/sizeof(0[x])) / ((std::size_t)(!(sizeof(x) % sizeof(0[x]))))) +#else +# define lengthof(x) ((sizeof(x)/sizeof(0[x])) / ((size_t)(!(sizeof(x) % sizeof(0[x]))))) +#endif + +#endif diff --git a/include/duckhandy/lexical_cast.hpp b/include/duckhandy/lexical_cast.hpp new file mode 100644 index 0000000..33ee80e --- /dev/null +++ b/include/duckhandy/lexical_cast.hpp @@ -0,0 +1,304 @@ +/* Copyright 2016, Michele Santullo + * This file is part of "duckhandy". + * + * "duckhandy" 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. + * + * "duckhandy" 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 "duckhandy". If not, see . + */ + +#ifndef id942A6B5AB2AF443C82D4321775BFC9E8 +#define id942A6B5AB2AF443C82D4321775BFC9E8 + +#include "compatibility.h" +#include "helpers/sequence_bt.hpp" +#include "helpers/MaxSizedArray.hpp" +#include "sprout/math/log10.hpp" +#include "sprout/math/log2.hpp" +#include "sprout/math/pow.hpp" +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +namespace dhandy { + namespace customize { + template + struct index_array_to_string; + + template + struct char_to_int; + } //namespace customize + + namespace implem { + template + typename std::make_unsigned::type abs ( T parValue ) a_pure; + + template int count_leading_zeroes ( typename std::enable_if::is_signed, T>::type parValue ) a_always_inline; + template int count_leading_zeroes ( typename std::enable_if::is_signed, T>::type parValue ) a_always_inline; + int count_leading_zeroes_overload ( unsigned char parValue ) a_always_inline; + int count_leading_zeroes_overload ( unsigned short int parValue ) a_always_inline; + int count_leading_zeroes_overload ( unsigned int parValue ) a_always_inline; + int count_leading_zeroes_overload ( unsigned long parValue ) a_always_inline; + int count_leading_zeroes_overload ( unsigned long long parValue ) a_always_inline; + + template + struct power { + enum { value = Base * power::value }; + }; + template + struct power { + enum { value = 1 }; + }; + + template ::is_signed> + struct is_negative; + template + struct is_negative { + static int check (T parValue) { return (parValue < 0 ? 1 : 0); } + }; + template + struct is_negative { + static constexpr int check (T) { return 0; } + }; + + template