diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d0a47ef --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +# temporary files +*~ +.*.swp # vim +*.flc # xemacs +.DS_Store # MacOS +Thumbs.db # Windows + + +# removing dist folder : folder receiving the compilation products +/dist +/.build + +/python/sequenceParser.py +/python/sequenceParser_wrap.cxx diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..06e85cf --- /dev/null +++ b/INSTALL @@ -0,0 +1,63 @@ +sequenceParser - install HOWTO + + +Why Boost.Build ? +================= + + sequenceParser relies heavily on the Boost library, so instead of using one of + the many multiplatform build system available like Scons, CMake, Autotools + we're simply using Boost.Build, the build system embedded within Boost. + + Boost.Build is powerful yet very expressive and terse. It's a weapon of + choice when building large pieces of code with a lot of dependencies. + + An excellent introduction to Boost.Build can be found here + http://www.highscore.de/cpp/boostbuild/ + + And the official documentation is available online + http://www.boost.org/boost-build2/doc/html/ + or in your boost copy at $(BOOST_ROOT)/tools/build/index.html + + +Setting up the build process +============================ + + * Building the building tool (the build-ception...) + + - First grab Boost from the website ( http://www.boost.org/ ) + - Uncompress the archive somewhere. + - Open a terminal and go to the boost root folder, then type + Linux / MacOsX : ./bootstrap.sh + Windows : bootstrap.bat + + This will generate a 'b2' executable. + + * Setting up environment variables + + In order to use Boost.Build you have to set the BOOST_ROOT + environment variable. + + Linux / MacOsX : export BOOST_ROOT=/your/path/to/boost/root + Windows : set BOOST_ROOT=C:\your\path\to\boost\root + + Note : You can add it to your ~/.bashrc, ~/.profile + or to your Windows environment to make it persistent. + + +Building +======== + + * Choose the appropriate script depending on your platform + Linux : ./build-linux-gcc.sh + MacOSX : comming soon + Windows : comming soon + + * Run it with one or more of the following command line arguments + --help : Display help message + --clean : Remove targets instead of building + variant=release : build the release version ( by default is the debug version ) + + : without argument, full build & installation (without unit test) + sequenceLibrary : Build only the C++ library + test : Build & run unit test suite + diff --git a/Jamroot b/Jamroot new file mode 100644 index 0000000..4c95a6d --- /dev/null +++ b/Jamroot @@ -0,0 +1,83 @@ + +import type ; + +local BOOST_ROOT = [ modules.peek : BOOST_ROOT ] ; + +use-project /boost : $(BOOST_ROOT) ; +use-project /test : test ; + +if ! [ type.registered BINDINGPYTHON ] +{ + type.register BINDINGPYTHON : : SHARED_LIB ; + type.change-generated-target-prefix BINDINGPYTHON : : "_" ; +} + +project + : requirements + src + include + /boost//system + /boost//filesystem + /boost//regex + : usage-requirements + include + /boost//system + /boost//filesystem + /boost//regex + : + build-dir .build/ + ; + +lib sequence + : + [ glob src/*.cpp ] + ; + +make buildBindingSwig : python/sequenceParser.i : @swigCpptoPython ; +actions swigCpptoPython +{ + swig -c++ -python -I. $(>) +} + +bindingpython sequenceParser + : + [ glob python/*.cxx ] + sequence + /python + : + . + ; + +install sequenceLibrary + : + sequence + : + on + SHARED_LIB + debug:dist/debug + release:dist/release + ; + +install bindingPython + : + [ glob python/sequenceParser.py ] + : + debug:dist/debug + release:dist/release + ; + +install bindingPythonLibrary + : + sequenceParser + : + debug:dist/debug + release:dist/release + off + BINDINGPYTHON + + ; + + + + +explicit test ; diff --git a/LICENSE.GPL b/LICENSE.GPL new file mode 100644 index 0000000..bc08fe2 --- /dev/null +++ b/LICENSE.GPL @@ -0,0 +1,619 @@ + 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. diff --git a/LICENSE.LGPL b/LICENSE.LGPL new file mode 100644 index 0000000..bdf8db0 --- /dev/null +++ b/LICENSE.LGPL @@ -0,0 +1,166 @@ + GNU LESSER 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. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser 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 +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. + diff --git a/LICENSE.sequenceParser b/LICENSE.sequenceParser new file mode 100644 index 0000000..6eaf9b7 --- /dev/null +++ b/LICENSE.sequenceParser @@ -0,0 +1,18 @@ +sequenceParser Public License +Version 1.0, October 17, 2011 + +sequenceParser license is the GNU Lesser Public License (LGPL) version 3, with some exclusions regarding “derived work” definition, see below. Put simply, it’s a less restrictive version of LGPL. + +Under the LGPL you may use sequenceParser for any purpose you wish, and modify it if you require, as long as you: + 1. Pass on the (modified) sequenceParser source code with your software, with original copyrights intact. + a. If you distribute electronically, the source can be a separate download (either from your own site if you modified sequenceParser, or to the sequenceParser site if you used an unmodified version) – just include a link in your documentation. + b. If you distribute physical media, the sequenceParser source code that you used to build your application should be included on that media. + 2. Make it clear where you have customised it. + +In addition to the LGPL license text, the following exclusions and clarifications to the LGPL conditions apply to sequenceParser: + 1. Making modifications to sequenceParser configuration files, build scripts and configuration headers in order to create a customised build setup of sequenceParser with the otherwise unmodified source code, does not constitute a derived work. + 2. Building against sequenceParser headers which have inlined code does not constitute a derived work. + 3. Code which inherits sequenceParser classes outside of the sequenceParser libraries does not form a derived work. + 4. Statically linking the sequenceParser libraries into a user application does not make the user application a derived work. + +As per the terms of the LGPL, a “derived work” is one for which you have to distribute source code for, so when the clauses above define something as not a derived work, it means you don’t have to distribute source code for it. However, the original sequenceParser source code with all modifications must always be made available. diff --git a/README b/README index e69de29..152fb76 100644 --- a/README +++ b/README @@ -0,0 +1,52 @@ +SequenceParser version 0.0.1 + + SequenceParser library is a C++ library to detect sequences, files and folders + +Licence +======= + + see COPYING files + +Compilation +=========== + + * Getting the source + git clone git://github.com/mikrosimage/SequenceParser.git + cd SerquenceParser + + * Compilation + see INSTALL file + +Tested compilers +================ + + * Linux + - GCC 4.4.1 on OpenSUSE 11.2 64bits + + * MacOS + + * Windows + + + +External Libraries +================== + * Boost + - version 1.48.0 + * Swig ( for Python Binding ) + - 1.3.36 + * Python + - version 2.6 + + +Definitions +=========== + +Sequence: +it's many files with a common pattern of numbers + +File: +it's all file without numbers in the filname and sequences with only one file + +Folders: +Just folders diff --git a/build-linux-gcc.sh b/build-linux-gcc.sh new file mode 100755 index 0000000..54e62c2 --- /dev/null +++ b/build-linux-gcc.sh @@ -0,0 +1,15 @@ +#!/bin/bash + +if [ ! $BOOST_ROOT ] +then + echo + echo "In order to use bjam and build Duke, the BOOST_ROOT environment variable have to be set" + echo "Edit and type the following command: export BOOST_ROOT=/your/path/to/boost/root/directory" + echo "See README file for more informations." + echo "Quit." + exit 1; +fi + +# boost build configuration +export BOOST_BUILD_PATH=$BOOST_ROOT/tools/build/v2 +$BOOST_ROOT/bjam --toolset=gcc cflags=-fPIC cxxflags=-fPIC python=2.6 $* diff --git a/examples/lsFile.py b/examples/lsFile.py new file mode 100755 index 0000000..ecae582 --- /dev/null +++ b/examples/lsFile.py @@ -0,0 +1,20 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +import os, sys +import sequenceParser + +if len(sys.argv) > 2: + print( 'lsFile took only one path' ) + sys.exit() + +detector = sequenceParser.Detector() + +path = os.curdir +if len(sys.argv) == 2 : + path = sys.argv[1] + +files = detector.fileInDirectory( path ) + +for f in files : + print f + diff --git a/examples/lsFolder.py b/examples/lsFolder.py new file mode 100755 index 0000000..46a6d00 --- /dev/null +++ b/examples/lsFolder.py @@ -0,0 +1,20 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +import os, sys +import sequenceParser + +if len(sys.argv) > 2: + print( 'lsFile took only one path' ) + sys.exit() + +detector = sequenceParser.Detector() + +path = os.curdir +if len(sys.argv) == 2 : + path = sys.argv[1] + +files = detector.folderInDirectory( path ) + +for f in files : + print f + diff --git a/examples/lsSequence.py b/examples/lsSequence.py new file mode 100755 index 0000000..afb59e5 --- /dev/null +++ b/examples/lsSequence.py @@ -0,0 +1,20 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +import os, sys +import sequenceParser + +if len(sys.argv) > 2: + print( 'lsFile took only one path' ) + sys.exit() + +detector = sequenceParser.Detector() + +path = os.curdir +if len(sys.argv) == 2 : + path = sys.argv[1] + +files = detector.sequenceInDirectory( path ) + +for f in files : + print f + diff --git a/examples/printFile.py b/examples/printFile.py new file mode 100755 index 0000000..1335f08 --- /dev/null +++ b/examples/printFile.py @@ -0,0 +1,17 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +import os, sys +import sequenceParser + +if len(sys.argv) > 2: + print( 'lsFile took only one path' ) + sys.exit() + +detector = sequenceParser.Detector() + +path = os.curdir +if len(sys.argv) == 2 : + path = sys.argv[1] + +detector.printFileInDirectory( path ) + diff --git a/examples/printFolder.py b/examples/printFolder.py new file mode 100755 index 0000000..778abb9 --- /dev/null +++ b/examples/printFolder.py @@ -0,0 +1,17 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +import os, sys +import sequenceParser + +if len(sys.argv) > 2: + print( 'lsFile took only one path' ) + sys.exit() + +detector = sequenceParser.Detector() + +path = os.curdir +if len(sys.argv) == 2 : + path = sys.argv[1] + +detector.printFolderInDirectory( path ) + diff --git a/examples/printSequence.py b/examples/printSequence.py new file mode 100755 index 0000000..1204bb0 --- /dev/null +++ b/examples/printSequence.py @@ -0,0 +1,17 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +import os, sys +import sequenceParser + +if len(sys.argv) > 2: + print( 'lsFile took only one path' ) + sys.exit() + +detector = sequenceParser.Detector() + +path = os.curdir +if len(sys.argv) == 2 : + path = sys.argv[1] + +detector.printSequenceInDirectory( path ) + diff --git a/include/Detector.hpp b/include/Detector.hpp new file mode 100644 index 0000000..42c4e84 --- /dev/null +++ b/include/Detector.hpp @@ -0,0 +1,110 @@ +#ifndef _DETECTOR_HPP_ +#define _DETECTOR_HPP_ + +#include +#include +#include +#include +#include +#include +#include +#include + +namespace sequenceParser { + +class Detector +{ +public : + Detector(); + ~Detector(); + + std::list > fileInDir ( const boost::filesystem::path& directory, + const sequenceParser::EMaskOptions desc = eMaskOptionsDefault ) + { + std::vector filters; + return fileInDir( directory, filters, desc ); + } + + std::list > fileInDir ( const boost::filesystem::path& directory, + std::vector& filters, + const sequenceParser::EMaskOptions desc = eMaskOptionsDefault ); + + std::list > sequenceInDir ( const boost::filesystem::path& directory, + const sequenceParser::EMaskOptions desc = eMaskOptionsDefault ) + { + std::vector filters; + return sequenceInDir( directory, filters, desc ); + } + + std::list > sequenceInDir ( const boost::filesystem::path& directory, + std::vector& filters, + const sequenceParser::EMaskOptions desc = eMaskOptionsDefault ); + + std::list > fileAndSequenceInDir ( const boost::filesystem::path& directory, + const sequenceParser::EMaskOptions desc = eMaskOptionsDefault ) + { + std::vector filters; + return fileAndSequenceInDir( directory, filters, desc ); + } + + std::list > fileAndSequenceInDir ( const boost::filesystem::path& directory, + std::vector& filters, + const sequenceParser::EMaskOptions desc = eMaskOptionsDefault ); + + std::list > folderInDir ( const boost::filesystem::path& directory, + const sequenceParser::EMaskOptions desc = eMaskOptionsDefault ) + { + std::vector filters; + return folderInDir( directory, filters, desc ); + } + + std::list > folderInDir ( const boost::filesystem::path& directory, + std::vector& filters, + const sequenceParser::EMaskOptions desc = eMaskOptionsDefault ); + + std::list > fileObjectsInDir ( const boost::filesystem::path& directory, + const sequenceParser::EMaskType mask = eMaskTypeDefault, + const sequenceParser::EMaskOptions desc = eMaskOptionsDefault ) + { + std::vector filters; + return fileObjectsInDir( directory, filters, mask, desc ); + } + + std::list > fileObjectsInDir ( const boost::filesystem::path& directory, + std::vector& filters, + const sequenceParser::EMaskType mask = eMaskTypeDefault, + const sequenceParser::EMaskOptions desc = eMaskOptionsDefault ); + +private: + /** + * Detect if the filename is filtered by one of the filter + * + * @param[in] filename filename need to be check if it filtered + * @param[in] filters vector of filters + * + * @return return true if the filename is filtered by filter(s) + */ + bool isNotFilter( std::string filename, std::vector& filters ); + + /** + * @brief Create a sequence + * @param[in] id: the sequence identifier + * @param[inout] nums: the list of sequence of number inside each filename + * @warning We modify nums in place, because we don't use it after + * so there is no reason to create a copy. + * @return a sequence object with all informations + */ + std::list buildSequence( const boost::filesystem::path& directory, const sequenceParser::FileStrings& id, std::list& nums, const sequenceParser::EMaskOptions& desc ); + + /** + * @brief Construct id and nums from a filename. + * @param[in] str: the string to process (filename) + * @param[out] id: list of strings + * @param[out] nums: list of integers + * @return number of decteted numbers + */ + std::size_t seqConstruct( const std::string& str, FileStrings& id, FileNumbers& nums ); +}; + +} +#endif diff --git a/project-config.jam b/project-config.jam new file mode 100644 index 0000000..ecc4f7d --- /dev/null +++ b/project-config.jam @@ -0,0 +1,41 @@ + +import path ; +import os ; + +local rule check-required-env ( var ) { + if ! $($(var)) { + EXIT Missing variable $(var) ; + } +} + +local BOOST_ROOT = [ modules.peek : BOOST_ROOT ] ; +check-required-env BOOST_ROOT ; + +######################### +# Python configuration. # +######################### + +# Configure specific Python version. + +using python + : 2.6 # version + : /usr/bin/python2.6 # bin directory + : /usr/include/python2.6 # includes + : /usr/lib64 # libs + : + LINUX + 64 + ; + +using python + : 2.6 # version + : /usr/bin/python2.6 # bin directory + : /usr/include/python2.6 # includes + : /usr/lib # libs + : + LINUX + 32 + ; + + + diff --git a/python/sequenceParser.i b/python/sequenceParser.i new file mode 100644 index 0000000..8651577 --- /dev/null +++ b/python/sequenceParser.i @@ -0,0 +1,126 @@ + +%module sequenceParser + +%include +%include +%include + +%{ +#include +#include +#include +#include +#include +%} + + +namespace std { +%template(StringVector) vector; +%template(StringList) list; +} + +%ignore fileInDir; +%ignore sequenceInDir; +%ignore folderInDir; +%ignore fileAndSequenceInDir; +%ignore fileObjectsInDir; +%include + + + + +namespace sequenceParser { +%extend Detector +{ + // c++ code + std::vector fileInDirectory( std::string path ) + { + boost::filesystem::path p (path); + std::list > outputFiles; + std::vector filenames; + + outputFiles = $self->fileInDir ( p ); + for (std::list >::iterator it = outputFiles.begin(); it != outputFiles.end(); it++) + { + boost::shared_ptr f = *it; + filenames.push_back( f->getAbsoluteFilename().c_str() ); + } + return filenames; + } + + void printFileInDirectory( std::string path ) + { + boost::filesystem::path p (path); + std::list > outputFiles; + std::vector filenames; + + outputFiles = $self->fileInDir ( p, sequenceParser::eMaskOptionsColor ); + for (std::list >::iterator it = outputFiles.begin(); it != outputFiles.end(); it++) + { + boost::shared_ptr f = *it; + std::cout << *f << std::endl; + } + } + + std::vector sequenceInDirectory( std::string path ) + { + boost::filesystem::path p (path); + std::list > outputFiles; + std::vector filenames; + + outputFiles = $self->sequenceInDir ( p ); + for (std::list >::iterator it = outputFiles.begin(); it != outputFiles.end(); it++) + { + boost::shared_ptr f = *it; + filenames.push_back( f->getAbsoluteStandardPattern().c_str() ); + } + return filenames; + } + + void printSequenceInDirectory( std::string path ) + { + boost::filesystem::path p (path); + std::list > outputFiles; + std::vector filenames; + + outputFiles = $self->sequenceInDir ( p, sequenceParser::eMaskOptionsColor ); + for (std::list >::iterator it = outputFiles.begin(); it != outputFiles.end(); it++) + { + boost::shared_ptr f = *it; + std::cout << *f << std::endl; + } + } + + std::vector folderInDirectory( std::string path ) + { + boost::filesystem::path p (path); + std::list > outputFiles; + std::vector filenames; + + outputFiles = $self->folderInDir ( p ); + for (std::list >::iterator it = outputFiles.begin(); it != outputFiles.end(); it++) + { + boost::shared_ptr f = *it; + std::vector pathDir = f->getFiles (); + filenames.push_back( pathDir.at(0).c_str() ); + } + return filenames; + } + + void printFolderInDirectory( std::string path ) + { + boost::filesystem::path p (path); + std::list > outputFiles; + std::vector filenames; + + outputFiles = $self->folderInDir ( p, sequenceParser::eMaskOptionsColor ); + for (std::list >::iterator it = outputFiles.begin(); it != outputFiles.end(); it++) + { + boost::shared_ptr f = *it; + std::cout << *f << std::endl; + } + } + +} +} + diff --git a/src/Detector.cpp b/src/Detector.cpp new file mode 100644 index 0000000..da841c4 --- /dev/null +++ b/src/Detector.cpp @@ -0,0 +1,567 @@ +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include + +namespace bfs = boost::filesystem; + +namespace sequenceParser { + +// NOTE How we can replace this with a wrapper? +// Like boost::function, boost::bind,... +struct SeqIdHash : std::unary_function +{ + std::size_t operator()( const FileStrings& p ) const + { + return p.getHash(); + } +}; + + +Detector::Detector() +{ +} + +Detector::~Detector() +{ +} + +std::list > Detector::fileInDir( const bfs::path& directory, std::vector& filters, const EMaskOptions desc ) +{ + std::list > outputFiles; + + if ( ! exists ( directory ) ) + return outputFiles; + + // variables for sequence detection + typedef boost::unordered_map, SeqIdHash> SeqIdMap; + SeqIdMap sequences; + FileStrings id; // an object uniquely identify a sequence + FileNumbers nums; // the list of numbers inside one filename + + // for all files in the directory + bfs::directory_iterator itEnd; + for (bfs::directory_iterator iter(directory); iter != itEnd; ++iter) + { + // clear previous infos + id.clear(); + nums.clear(); // (clear but don't realloc the vector inside) + + if ( !(iter->path().filename().string()[0] == '.') || (desc & eMaskOptionsDotFile) ) // if we ask to show hidden files and if it is hidden + { + + if ( ! bfs::is_directory( iter->status() ) ) // detect if isn't a folder + { + // it's a file or a file of a sequence + if ( isNotFilter( iter->path().filename().string(), filters ) ) // filtering of entries with filters strings + { + // if at least one number detected + if ( seqConstruct(iter->path().filename().string(), id, nums ) ) + { + // need to construct sequence to detect file with a pattern but with only one image + const SeqIdMap::iterator it( sequences.find( id ) ); + if (it != sequences.end()) // is already in map + { + // append the list of numbers + sequences.at(id).push_back(nums); + } + else + { + // create an entry in the map + std::list li; + li.push_back(nums); + sequences.insert(SeqIdMap::value_type(id, li)); + } + } + else + { + boost::shared_ptr f( new File( directory, iter->path().filename().string(), desc ) ); + outputFiles.push_back(f); + } + } + } + } + } + // add sequences in the output list + BOOST_FOREACH( SeqIdMap::value_type & p, sequences ) + { + const std::list ss = buildSequence( directory, p.first, p.second, desc ); + BOOST_FOREACH( const std::list::value_type & s, ss ) + { + // don't detect sequence of directories + if ( ! bfs::is_directory( s.getAbsoluteFirstFilename() ) ) + { + if ( s.getNbFiles() == 1 ) // if it's a sequence of 1 file, it isn't a sequence but only a file + { + boost::shared_ptr file( new File( directory, s.getFirstFilename(), s.getMaskOptions() ) ); + outputFiles.push_back(file); + } + } + } + } + + return outputFiles; +} + +std::list > Detector::sequenceInDir( const bfs::path& directory, std::vector& filters, const EMaskOptions desc ) +{ + std::list > outputSequences; + + if ( !exists( directory ) ) + return outputSequences; + + // variables for sequence detection + typedef boost::unordered_map, SeqIdHash> SeqIdMap; + SeqIdMap sequences; + FileStrings id; // an object uniquely identify a sequence + FileNumbers nums; // the list of numbers inside one filename + + // for all files in the directory + bfs::directory_iterator itEnd; + for (bfs::directory_iterator iter(directory); iter != itEnd; ++iter) + { + // clear previous infos + id.clear(); + nums.clear(); // (clear but don't realloc the vector inside) + + if (!(iter->path().filename().string()[0] == '.') || (desc & eMaskOptionsDotFile)) // if we ask to show hidden files and if it is hidden + { + // detect if isn't a folder + if ( ! bfs::is_directory( iter->status() ) ) + { // it's a file or a file of a sequence + if ( isNotFilter( iter->path().filename().string(), filters ) ) // filtering of entries with filters strings + { + // if at least one number detected + if (seqConstruct(iter->path().filename().string(), id, nums)) + { + const SeqIdMap::iterator it(sequences.find(id)); + if (it != sequences.end()) // is already in map + { + // append the list of numbers + sequences.at(id).push_back(nums); + } + else + { + // create an entry in the map + std::list li; + li.push_back(nums); + sequences.insert(SeqIdMap::value_type(id, li)); + } + } + } + } + } + } + // add sequences in the output list + BOOST_FOREACH( SeqIdMap::value_type & p, sequences ) + { + const std::list ss = buildSequence(directory, p.first, p.second, desc); + BOOST_FOREACH( const std::list::value_type & s, ss ) + { + // don't detect sequence of directories + if (!bfs::is_directory(s.getAbsoluteFirstFilename())) + { + if ( ! ( s.getNbFiles() == 1 ) ) // if it's a sequence of 1 file, it isn't a sequence but only a file + { + boost::shared_ptr seq(new Sequence(directory, s, desc)); + outputSequences.push_back(seq); + } + } + } + } + + return outputSequences; +} + +std::list > Detector::fileAndSequenceInDir( const bfs::path& directory, std::vector& filters, const EMaskOptions desc ) +{ + std::list > output; + std::list > outputFiles; + std::list > outputSequences; + + if (!exists(directory)) + return output; + + // variables for sequence detection + typedef boost::unordered_map, SeqIdHash> SeqIdMap; + SeqIdMap sequences; + FileStrings id; // an object uniquely identify a sequence + FileNumbers nums; // the list of numbers inside one filename + + // for all files in the directory + bfs::directory_iterator itEnd; + for (bfs::directory_iterator iter(directory); iter != itEnd; ++iter) + { + // clear previous infos + id.clear(); + nums.clear(); // (clear but don't realloc the vector inside) + + if (!(iter->path().filename().string()[0] == '.') || (desc & eMaskOptionsDotFile)) // if we ask to show hidden files and if it is hidden + { + // detect if isn't a folder + if ( ! bfs::is_directory( iter->status() ) ) + { // it's a file or a file of a sequence + + if ( isNotFilter( iter->path().filename().string(), filters ) ) // filtering of entries with filters strings + { + // if at least one number detected + if (seqConstruct(iter->path().filename().string(), id, nums)) + { + const SeqIdMap::iterator it(sequences.find(id)); + if (it != sequences.end()) // is already in map + { + // append the list of numbers + sequences.at(id).push_back(nums); + } + else + { + // create an entry in the map + std::list li; + li.push_back(nums); + sequences.insert(SeqIdMap::value_type(id, li)); + } + } + else + { + boost::shared_ptr f( new File( directory, iter->path().filename().string(), desc ) ); + outputFiles.push_back(f); + } + } + } + } + } + // add sequences in the output list + BOOST_FOREACH( SeqIdMap::value_type & p, sequences ) + { + const std::list ss = buildSequence(directory, p.first, p.second, desc); + BOOST_FOREACH( const std::list::value_type & s, ss ) + { + // don't detect sequence of directories + if (!bfs::is_directory(s.getAbsoluteFirstFilename())) + { + if (s.getNbFiles() == 1) // if it's a sequence of 1 file, it isn't a sequence but only a file + { + boost::shared_ptr file( new File( directory, s.getFirstFilename(), s.getMaskOptions() ) ); + outputFiles.push_back(file); + } + else + { + boost::shared_ptr seq( new Sequence( directory, s, desc ) ); + outputSequences.push_back(seq); + } + } + } + } + + output.merge(outputFiles); + output.merge(outputSequences); + return output; +} + +std::list > Detector::folderInDir( const bfs::path& directory, std::vector& filters, const EMaskOptions desc ) +{ + std::list > outputFolders; + + if ( ! exists( directory ) ) + return outputFolders; + + // for all files in the directory + bfs::directory_iterator itEnd; + for ( bfs::directory_iterator iter( directory ); iter != itEnd; ++iter ) + { + if (!(iter->path().filename().string()[0] == '.') || (desc & eMaskOptionsDotFile)) // if we ask to show hidden files and if it is hidden + { + // detect if is a folder + if ( bfs::is_directory( iter->status() ) ) + { + boost::shared_ptr d(new Folder(directory, iter->path().filename().string(), desc)); + outputFolders.push_back(d); + } + } + } + return outputFolders; +} + +std::list > Detector::fileObjectsInDir( const bfs::path& directory, std::vector& filters, const EMaskType mask, const EMaskOptions desc ) +{ + std::list > output; + std::list > outputFolders; + std::list > outputFiles; + std::list > outputSequences; + + if (!exists(directory)) + return output; + + // variables for sequence detection + typedef boost::unordered_map, SeqIdHash> SeqIdMap; + SeqIdMap sequences; + FileStrings id; // an object uniquely identify a sequence + FileNumbers nums; // the list of numbers inside one filename + + // for all files in the directory + bfs::directory_iterator itEnd; + for (bfs::directory_iterator iter(directory); iter != itEnd; ++iter) + { + // clear previous infos + id.clear(); + nums.clear(); // (clear but don't realloc the vector inside) + + if (!(iter->path().filename().string()[0] == '.') || (desc & eMaskOptionsDotFile)) // if we ask to show hidden files and if it is hidden + { + // detect if is a folder + if ( bfs::is_directory( iter->status() ) ) + { + boost::shared_ptr d(new Folder(directory, iter->path().filename().string(), desc)); + outputFolders.push_back(d); + } + else // it's a file or a file of a sequence + { + if ( isNotFilter( iter->path().filename().string(), filters ) ) // filtering of entries with filters strings + { + // if at least one number detected + if (seqConstruct(iter->path().filename().string(), id, nums)) + { + const SeqIdMap::iterator it(sequences.find(id)); + if (it != sequences.end()) // is already in map + { + // append the list of numbers + sequences.at(id).push_back(nums); + } + else + { + // create an entry in the map + std::list li; + li.push_back(nums); + sequences.insert(SeqIdMap::value_type(id, li)); + } + } + else + { + boost::shared_ptr f( new File( directory, iter->path().filename().string(), desc ) ); + outputFiles.push_back(f); + } + } + } + } + } + // add sequences in the output list + BOOST_FOREACH( SeqIdMap::value_type & p, sequences ) + { + const std::list ss = buildSequence(directory, p.first, p.second, desc); + BOOST_FOREACH( const std::list::value_type & s, ss ) + { + // don't detect sequence of directories + if (!bfs::is_directory(s.getAbsoluteFirstFilename())) + { + if (s.getNbFiles() == 1) // if it's a sequence of 1 file, it isn't a sequence but only a file + { + boost::shared_ptr file( new File( directory, s.getFirstFilename(), s.getMaskOptions() ) ); + outputFiles.push_back( file ); + } + else + { + boost::shared_ptr seq( new Sequence(directory, s, desc ) ); + outputSequences.push_back( seq ); + } + } + } + } + + if (mask & eMaskTypeDirectory) + { + output.merge(outputFolders); + } + // add files in the output list + if (mask & eMaskTypeFile) + { + output.merge(outputFiles); + } + // add sequences in the output list + if (mask & eMaskTypeSequence) + { + output.merge(outputSequences); + } + return output; +} + +bool Detector::isNotFilter(std::string filename, std::vector& filters) +{ + if (filters.size() == 0) + return true; + + for (std::size_t i = 0; i < filters.size(); i++) + { + std::string filter(filters.at(i)); + filter = boost::regex_replace(filter, boost::regex("\\*"), "(.*)"); + filter = boost::regex_replace(filter, boost::regex("\\@"), "(.*)"); + filter = boost::regex_replace(filter, boost::regex("\\?"), "(.)"); + filter = boost::regex_replace(filter, boost::regex("\\#"), "(.)"); + if (regex_match(filename, boost::regex(filter))) + return true; + } + return false; +} + +/** + * @brief Create a sequence + * @param[in] id: the sequence identifier + * @param[inout] nums: the list of sequence of number inside each filename + * @warning We modify nums in place, because we don't use it after + * so there is no reason to create a copy. + * @return a sequence object with all informations + */ +std::list Detector::buildSequence( const boost::filesystem::path& directory, const FileStrings& id, std::list& nums, const EMaskOptions& desc ) +{ + nums.sort(); + BOOST_ASSERT( nums.size() > 0 ); + // assert all FileNumbers have the same size... + BOOST_ASSERT( nums.front().size() == nums.back().size() ); + std::size_t len = nums.front().size(); + + // detect which part is the sequence number + // for the moment, accept only one sequence + // but we can easily support multi-sequences + std::vector allIds; // list of ids (with 0 result; + if (allIds.size() <= 1) { + // standard case, one sequence detected + seqCommon._firstTime = nums.front().getTime( idChangeEnd ); + seqCommon._lastTime = nums.back().getTime( idChangeEnd ); + seqCommon._nbFiles = nums.size(); + + seqCommon.extractStep ( nums, idChangeEnd ); + seqCommon.extractPadding ( nums, idChangeEnd ); + seqCommon.extractIsStrictPadding ( nums, idChangeEnd, seqCommon._padding ); + result.push_back( seqCommon ); + return result; + } + // it's a multi-sequence... + const FileNumbers* previous = &nums.front(); + Sequence s = seqCommon; + s._prefix += previous->getString( idChangeBegin ); + for ( std::size_t i = idChangeBegin + 1; i < idChangeEnd; ++i ) + { + s._prefix += id[i]; + s._prefix += previous->getString( i ); + } + s._prefix += id[idChangeEnd]; + result.push_back(s); + std::list