squeeze (empty) → 1.0.1.4
raw patch · 16 files changed
+1728/−0 lines, 16 filesdep +Cabaldep +QuickCheckdep +basesetup-changed
Dependencies added: Cabal, QuickCheck, base, directory, filepath, haskell98, parallel, toolshed, unix
Files
- LICENSE +675/−0
- Setup.hs +5/−0
- changelog +37/−0
- copyright +11/−0
- debian/DEBIAN/control +14/−0
- makefile +75/−0
- man/man1/squeeze.1 +118/−0
- squeeze.cabal +58/−0
- squeeze.spec +47/−0
- src/Main.hs +149/−0
- src/Squeeze/CommandOptions.hs +74/−0
- src/Squeeze/File.hs +97/−0
- src/Squeeze/FileCombination.hs +76/−0
- src/Squeeze/FileSizeBounds.hs +56/−0
- src/Squeeze/QC.hs +80/−0
- src/Squeeze/Squeeze.hs +156/−0
+ LICENSE view
@@ -0,0 +1,675 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ 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.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ 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 <http://www.gnu.org/licenses/>.++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:++ <program> Copyright (C) <year> <name of author>+ 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+<http://www.gnu.org/licenses/>.++ 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+<http://www.gnu.org/philosophy/why-not-lgpl.html>.+
+ Setup.hs view
@@ -0,0 +1,5 @@+#!/usr/bin/env runhaskell++import qualified Distribution.Simple++main = Distribution.Simple.defaultMain
+ changelog view
@@ -0,0 +1,37 @@+2010-11-18 Dr. Alistair Ward <squeeze at functionalley dot eu>++1.0.0.0+ * First version of the package.+1.0.0.1+ * Created "src/Squeeze/" sub-directory & then modified module-names accordingly.+ * Pacified 'hlint'.+ * Added a makefile.+1.0.0.2+ * Tested with ghc-7.0.1+ * Added RPM-spec file.+1.0.1.0+ * Improved the basic algorithm, by permitting the file-list to be bisected; each file-combination resulting from the LHS, is then concatenated with each of those resulting from the recursively bisected RHS.+ * Used "Control.Parallel.Strategies" to parallelize the concatenation of each combination from the LH-list, with each of those from the RH-list.+ * Added default values of command-line flags, to usage-message.+ * Used new "ToolShed.Package" module.+ (1.0.1.1)+ * Replaced 'Data.List.subsequences' with a tailored version which terminates combinations when they've grown too large, providing a better and more predictable performance-gain than recursive list-bisection.+ * Reduced recursive list-bisection to a single bisection, for the sole purpose of facilitating parallelisation.+ * Added module "Squeeze.QC" to define "Test.QuickCheck" tests and command-line option "--verbose", to govern level of output.+ * Split of new modules; "Squeeze.File", "Squeeze.FileSizeBounds" and "Squeeze.FileCombination".+1.0.1.2+ * Fixed typo in CPP-statement in 'QC.hs'.+ * Fixed negated reference to unparenthesised CPP-macro 'MIN_VERSION'.+ * Protected reference in "Main.hs", to 'Test.QuickCheck.verboseCheck', using CPP-statement.+1.0.1.3+ * Amended "squeeze.spec" to define RPM-package, to install under "/usr", rather than "/usr/local".+ * Renamed package from 'Squeeze' to 'squeeze', for compatibility with Debian's ".deb"-format.+ * Added directory-structure required to build ".deb" package.+1.0.1.4+ * Corrected command-line processing of the special file "-", which read standard-input as requested, but disregarded any other command-line options.+ * Refined man-page to be an 'extra-source-file' in .cabal & .spec files.+ * Ported to compile against alternative integral definitions of 'File.FileSize'.+ * Added manually controlled "llvm" flag to "squeeze.cabal".+ * Replaced references to the module "ToolShed.Package" with "Distribution.Package".+ * Reacted to the creation of module "ToolShed.Defaultable".+
+ copyright view
@@ -0,0 +1,11 @@+Author:+ Dr. Alistair Ward <squeeze at functionalley dot eu>.++Copyright:+ Copyright (C) 2010-2011 Dr. Alistair Ward. All Rights Reserved.++Home-page:+ http://functionalley.eu++License:+ GNU GENERAL PUBLIC LICENSE Version 3; see '/usr/share/common-licenses/GPL-3' or '/usr/share/doc/licenses/gpl-3.0.txt' where available, or the local packaged file 'LICENSE'.
+ debian/DEBIAN/control view
@@ -0,0 +1,14 @@+Package: squeeze+Version: 1.0.1.4-1+Section: utils+Priority: optional+Architecture: i386+Depends: libc6 (>= 2.3.6-6~), libgmp3c2+Installed-size: 1036+Maintainer: Dr. Alistair Ward+Provides:+Homepage: http://functionalley.eu+Description: Finds the optimal subset of the specified files, to fit into a limited space.+ Returns progressively better subsets of the specified files,+ to fit into a limited space, without wasting more than the specific ratio.+
+ makefile view
@@ -0,0 +1,75 @@+# Copyright (C) 2010 Dr. Alistair Ward+# +# 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 <http://www.gnu.org/licenses/>.++.PHONY: all build clean clobber configure copy deb haddock help hlint install lintian prof rpm rpmlint sdist ++all: install++install: build haddock+ @[ -z "$$CABAL_INSTALL_OPTIONS" ] || echo "INFO: CABAL_INSTALL_OPTIONS='$$CABAL_INSTALL_OPTIONS'"+ runhaskell Setup.hs $@ $$CABAL_INSTALL_OPTIONS++prof:+ CABAL_CONFIGURE_OPTIONS="--enable-executable-profiling $$CABAL_CONFIGURE_OPTIONS" make install++copy: build+ @[ -z "$$CABAL_COPY_OPTIONS" ] || echo "INFO: CABAL_COPY_OPTIONS='$$CABAL_COPY_OPTIONS'"+ runhaskell Setup.hs $@ $$CABAL_COPY_OPTIONS++build: configure+ @[ -z "$$CABAL_BUILD_OPTIONS" ] || echo "INFO: CABAL_BUILD_OPTIONS='$$CABAL_BUILD_OPTIONS'"+ runhaskell Setup.hs $@ $$CABAL_BUILD_OPTIONS++configure: squeeze.cabal Setup.hs+ @[ -z "$$CABAL_CONFIGURE_OPTIONS" ] || echo "INFO: CABAL_CONFIGURE_OPTIONS='$$CABAL_CONFIGURE_OPTIONS'"+ runhaskell Setup.hs $@ $$CABAL_CONFIGURE_OPTIONS #--user++haddock: configure+ PATH=~/.cabal/bin:$$PATH runhaskell Setup.hs $@ --hyperlink-source --executables #Amend path to find 'HsColour', as required for 'hyperlink-source'.++hlint:+ @$@ src/++sdist: configure+ runhaskell Setup.hs $@++rpm: squeeze.spec+ rpmbuild -bb -- $^+ mv -- `find /usr/src/packages/ -type f -name 'squeeze*.rpm' -mtime 0 -print` ./++rpmlint: squeeze.spec+ @$@ $^++deb: build+ mkdir -p 'debian/usr/bin/' && strip --strip-all 'dist/build/squeeze/squeeze' && mv 'dist/build/squeeze/squeeze' 'debian/usr/bin/'+ mkdir -p 'debian/usr/share/doc/squeeze/' && cp 'changelog' 'changelog.Debian' 'LICENSE' 'debian/usr/share/doc/squeeze/' && gzip --best debian/usr/share/doc/squeeze/*+ cp 'copyright' 'debian/usr/share/doc/squeeze/'+ mkdir -p 'debian/usr/share/man/man1/' && cp 'man/man1/squeeze.1' 'debian/usr/share/man/man1/' && gzip --best debian/usr/share/man/man1/*.1+ cd 'debian' && md5sum `find usr -type f -print` >'DEBIAN/md5sums'+ fakeroot dpkg-deb --build debian .++lintian:+ lintian -v *.deb++clean:+ runhaskell Setup.hs $@+ rm -rf 'debian/usr/' 'debian/DEBIAN/md5sums'++clobber: clean+ rm -f -- *.rpm *.deb++help:+ @grep '^[a-zA-Z].*:' makefile | sed -e 's/:.*//'+
+ man/man1/squeeze.1 view
@@ -0,0 +1,118 @@+.TH squeeze 1+.SH NAME+\fBsqueeze\fR - Finds the best subset, of the specified files, which fits into a given space.+.SH SYNOPSIS+\fBsqueeze\fR [\fIOPTIONS\fR] \fIFILE\fR ...+.SH DESCRIPTION+.PP+Finds the subset of the named \fIFILE\fRs, which fits into \fIBYTES\fR, with least room to spare, whilst meeting \fBminimumUsageRatio\fR.+.PP+Any directories amongst the specified \fIFILE\fRs are treated as atomic units, & therefore only solutions which involve either all or none of the files in that directory, are returned.+.PP+Because of its exponential time-complexity, solutions of increasing suitability are continuously returned, rather than waiting until the optimal solution is known; which might take an inordinately long time.+.SH OPTIONS+.SS "Selection"+.TP+\fB-b\fR, \fB--bisectionRatio=\fR\fILHS/Total\fR+Defines the ratio (in the range 0.0 .. 1.0, defaulting to 0.5), at which the file-list will be bisected.+The first combination from the LHS is then concatenated with each combination from the RHS, in parallel with the same operation on subsequent combinations from the LHS.+This option leads to a performance-gain when used on a multi-core machine, in combination with GHC-runtime flags \fB+RTS -N -H\fR\fIHEAP-SIZE\fR \fB-RTS\fR; (e.g. \fB-H100M\fR).+On a single-core machine, \fB-b0\fR is slightly faster.+Because the order in which file-combinations are assessed, depends on this ratio, the set of suitable combinations returned may differ, though the optimum value remains the same.+.TP+\fB-M\fR, \fB--maximumBytes=\fR\fIBYTES\fR+Define the maximum available space, in bytes, defaulting to the space available on a DVD; i.e. \fB4700000000\fR bytes.+.TP+\fB-m\fR, \fB--minimumUsageRatio=\fR\fIRATIO\fR+Define the minimum acceptable usage-ratio of \fBmaximumBytes\fR,+from 0.0 .. 1.0, defaulting to \fB0.99\fR, i.e. 99%.+.TP+\fB-q\fR, \fB--runQuickChecks\fR+Run Quick-checks using arbitrary data & then exit.+Specify '\fB--verbose\fR' before this option, for additional output.+.TP+\fB-v\fR, \fB--verbose\fR+Produce additional explanatory output where appropriate.+.SS "Generic Program-information"+.TP+\fB--version\fR+Output version-information & exit.+.TP+\fB-?\fR, \fB--help\fR+Display help & exit.+.SS "File-list"+.TP+When a \fIFILE\fR is defined as a single hyphen-minus (\fB-\fR), replace it with the list of file-names read from standard-input.+.SH EXIT-STATUS+\fB0\fR on success, and >\fB0\fR if an error occurs.+.SH EXAMPLES+.SS Trial 1+Say we've a directory of audio-files, categorised by artist.+.TP+\fBls -p\fR+ArabStrap/ BobDylan/ JeffBuckley/ JohnMartyn/ JoniMitchell/ ReservoirDogsOST/ RichardThompson/ SethLakeman/ SusheelaRaman/ TeddyThompson/ Vangelis/+.PP+.TP+\fBsqueeze -M 700000000 -m 0.999 *\fR++699871313 ["BobDylan","RichardThompson","SethLakeman","TeddyThompson"]++.br+699893320 ["ArabStrap","BobDylan","JeffBuckley","JohnMartyn","SethLakeman","SusheelaRaman"]++.br+\fI699998310\fR ["ArabStrap","BobDylan","JoniMitchell","ReservoirDogsOST","SethLakeman","TeddyThompson","Vangelis"]+.PP +Note that the proposed solutions don't split any of the directories, into their constituent files.+.PP+We can confirm the validity of the optimal result:+.TP+\fBfind ArabStrap BobDylan JoniMitchell ReservoirDogsOST SethLakeman TeddyThompson Vangelis -type f -print | perl -e 'use List::Util qw(sum); printf(qq(%d\\n), sum map { chomp; (stat)[7] } <>);'\fR+699998310+.PP+NB: \fBdu\fR will return a slightly larger size, since it includes the space required for directory-structures.+.SS Trial 2+We can improve on that result if we're prepared to split some of the artist-specific directories into individual albums.+.TP+\fBsqueeze -M 700000000 -m 0.99999 ArabStrap BobDylan/* JeffBuckley JohnMartyn JoniMitchell ReservoirDogsOST RichardThompson SethLakeman SusheelaRaman TeddyThompson Vangelis\fR+699995815 ["ArabStrap","BobDylan/BlondeOnBlonde","BobDylan/Highway61Revisited","BobDylan/ModernTimes","BobDylan/StreetLegal","BobDylan/SubterraneanHomesickBlues","JoniMitchell","RichardThompson","SusheelaRaman","TeddyThompson","Vangelis"]++.br+699998578 ["BobDylan/Desire","BobDylan/Highway61Revisited","BobDylan/Infidels","BobDylan/StreetLegal","JeffBuckley","JohnMartyn","JoniMitchell","RichardThompson","SethLakeman","SusheelaRaman","TeddyThompson","Vangelis"]++.br+\fI699999112\fR ["BobDylan/BlondeOnBlonde","BobDylan/Desire","BobDylan/Highway61Revisited","BobDylan/Infidels","BobDylan/ModernTimes","JeffBuckley","JohnMartyn","ReservoirDogsOST","RichardThompson","SusheelaRaman","TeddyThompson","Vangelis"]+.SS Trial 3+If we're prepared to add individual files from another artist:+.TP+\fBsqueeze -M 700000000 -m 0.9999999 ArabStrap BobDylan/* JeffBuckley JohnMartyn JoniMitchell ReservoirDogsOST $(find RichardThompson -type f) SethLakeman SusheelaRaman TeddyThompson Vangelis\fR++699999964 ["ArabStrap","BobDylan/Desire","BobDylan/Infidels","BobDylan/ModernTimes","BobDylan/OhMercy","BobDylan/SubterraneanHomesickBlues","BobDylan/TimeOutOfMind","JeffBuckley","JohnMartyn","JoniMitchell","ReservoirDogsOST","RichardThompson/FrontParlourBallads/RichardThompson-06-MySoulMySoul.ogg","RichardThompson/RumorAndSigh/RichardThompson-12-MotherKnowsBest.ogg","RichardThompson/TheOldKitBag/RichardThompson-01-Gethsemane.ogg","RichardThompson/TheOldKitBag/RichardThompson-11-OutsideOfTheInside.ogg","SethLakeman","SusheelaRaman","TeddyThompson","Vangelis"]++.br+699999987 ["BobDylan/BlondeOnBlonde","BobDylan/BloodOnTheTracks","BobDylan/Desire","BobDylan/ModernTimes","BobDylan/OhMercy","BobDylan/StreetLegal","BobDylan/SubterraneanHomesickBlues","BobDylan/TimeOutOfMind","JoniMitchell","ReservoirDogsOST","RichardThompson/FrontParlourBallads/RichardThompson-01-LetItBlow.ogg","RichardThompson/IWantToSeeTheBrightLightsTonight/RichardAndLindaThompson-13-TheCalvaryCross[Live-Bonus].ogg","RichardThompson/TheOldKitBag/RichardThompson-01-Gethsemane.ogg","RichardThompson/TheOldKitBag/RichardThompson-06-FirstBreath.ogg","RichardThompson/TheOldKitBag/RichardThompson-11-OutsideOfTheInside.ogg","SethLakeman","SusheelaRaman","TeddyThompson","Vangelis"]++.br+\fI700000000\fR ["ArabStrap","BobDylan/Desire","BobDylan/Highway61Revisited","BobDylan/Infidels","BobDylan/ModernTimes","BobDylan/StreetLegal","BobDylan/SubterraneanHomesickBlues","BobDylan/TimeOutOfMind","JeffBuckley","JoniMitchell","ReservoirDogsOST","RichardThompson/FrontParlourBallads/RichardThompson-01-LetItBlow.ogg","RichardThompson/RumorAndSigh/RichardThompson-08-BacklashLoveAffair.ogg","RichardThompson/RumorAndSigh/RichardThompson-12-MotherKnowsBest.ogg","RichardThompson/TheOldKitBag/RichardThompson-01-Gethsemane.ogg","RichardThompson/TheOldKitBag/RichardThompson-04-ALoveYouCantSurvive.ogg","RichardThompson/TheOldKitBag/RichardThompson-06-FirstBreath.ogg","SusheelaRaman","TeddyThompson","Vangelis"]+.PP+^C+.PP+The exact match isn't unexpected, given the 2^71 possible combinations.+The process was terminated after this solution was found, though where time permits, one may choose to wait for alternative exact matches.+.SH AUTHOR+Written by Dr. Alistair Ward.+.SH BUGS+.SS "REPORTING BUGS"+Report bugs to \fBsqueeze\fR \fIat\fR \fBfunctionalley\fR \fIdot\fR \fBeu\fR+.PP+Home page: \fBhttp://functionalley.eu\fR+.SH COPYRIGHT+Copyright \(co 2010 Dr. Alistair Ward+.PP+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.+.PP+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.+.PP+You should have received a copy of the GNU General Public License along with this program. If not, see \fB<http://www.gnu.org/licenses/>\fR.+.SH "SEE ALSO"+The full documentation for \fBsqueeze\fR is generated by \fBHaddock\fR, & is available in the distribution.
+ squeeze.cabal view
@@ -0,0 +1,58 @@+--Package-properties+Name: squeeze+Version: 1.0.1.4+Cabal-Version: >= 1.6+Copyright: (C) 2010 Dr. Alistair Ward+License: GPL+License-file: LICENSE+Author: Dr. Alistair Ward+Stability: Stable interface, incomplete features.+Synopsis: A file-packing application.+Build-Type: Simple+Description: Returns progressively better subsets of the specified files, selected to fit into a limited space, without wasting more than the specific ratio.+Category: Utils+Tested-With: GHC == 6.10, GHC == 6.12, GHC == 7.0+Homepage: http://functionalley.eu+Maintainer: squeeze <at> functionalley <dot> eu+Bug-reports: squeeze <at> functionalley <dot> eu+Data-files:+Extra-Source-Files: man/man1/*.1, *.spec, changelog, copyright, debian/DEBIAN/control, makefile++flag threaded+ Description: Link with the threaded runtime.+ default: True++flag llvm+ Description: Whether the 'llvm' backend has been installed and is required for code-generation.+ manual: True+ default: False++Executable squeeze+ hs-source-dirs: src+ Main-Is: Main.hs+ Other-modules: Squeeze.CommandOptions Squeeze.File Squeeze.FileSizeBounds Squeeze.FileCombination Squeeze.QC Squeeze.Squeeze+ Build-depends:+ base == 4.*,+ Cabal >= 1.6 && < 2,+ directory,+ filepath,+ haskell98,+ QuickCheck >= 2.4,+ unix,+ toolshed == 0.11.*++ GHC-options: -Wall -O2+ GHC-prof-options: -prof -auto-all -caf-all++ if flag(threaded)+ Build-depends: parallel >= 3.0+ GHC-options: -threaded -feager-blackholing+ else+ Build-depends: parallel++ if impl(ghc >= 7.0)+ GHC-options: -rtsopts++ if flag(llvm)+ GHC-options: -fllvm+
+ squeeze.spec view
@@ -0,0 +1,47 @@+%define package %name-%version+%define tarBall %package.tar.gz+%define _bindir %prefix/bin+%define _datadir %prefix/share/%package+%define _docdir %prefix/share/doc/%package+%define _mandir %prefix/share/man++Summary: Finds the optimal subset of the specified files, to fit into a limited space, with minimal wastage.+Name: squeeze+Version: 1.0.1.4+Release: 1+License: GPLv3+#From '/usr/share/doc/packages/rpm/GROUPS'.+Group: Applications/File+Source0: http://functionalley.eu/Downloads/sdist/%tarBall+URL: http://functionalley.eu+Prefix: /usr++%description+Returns progressively better subsets of the specified files, to fit into a limited space, without wasting more than the specific ratio.++%prep+#NB: we've changed directory to %_builddir+rm -rf -- '%package/'+CABAL_CONFIGURE_OPTIONS='--user' make --directory="$OLDPWD/" sdist && mv -- "$OLDPWD/dist/%tarBall" '%_sourcedir/' && tar -zxf '%_sourcedir/%tarBall' #Build & copy the tar-ball into the source-directory, then unpack it into the build-directory.++%build++%install+rm -rf -- '%buildroot' #Clean any previous build. CAVEAT: the user might have specified '--buildroot', for which I can't account.+CABAL_CONFIGURE_OPTIONS='--user --prefix=%buildroot%prefix/' make --directory='%package/' install #Which regrettably also builds 'Haddock', which then requires 'HsColour'.+mkdir -p -- '%buildroot%_mandir/' && mv -- '%_builddir/%package/man/man1' '%buildroot%_mandir/'+mkdir -p -- '%buildroot%_docdir/' && mv -- %_builddir/%package/{changelog,copyright,LICENSE} '%buildroot%_docdir/'+rm -rf -- '%buildroot%_docdir/html' #We don't need source-code documentation in a binary package.++%clean+make --directory='%package/' clobber+rm -- '%_sourcedir/%tarBall'+rm -rf -- '%_builddir/%package' '%buildroot'++%files+%attr(0755, root, root) %_bindir/squeeze+%attr(0644, root, root) %doc %_mandir/man1/*.1.gz+%attr(0644, root, root) %doc %_docdir/changelog+%attr(0644, root, root) %doc %_docdir/copyright+%attr(0644, root, root) %doc %_docdir/LICENSE+
+ src/Main.hs view
@@ -0,0 +1,149 @@+{-# LANGUAGE CPP #-}+{-+ Copyright (C) 2010 Dr. Alistair Ward++ 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 <http://www.gnu.org/licenses/>.+-}+{- |+ [@AUTHOR@] Dr. Alistair Ward++ [@DESCRIPTION@]++ * Contains the entry-point of the application.++ * Processes the command-line arguments.+-}++module Main(+-- * Type-classes+-- CommandLineAction,+-- * Functions+ main+) where++import Control.Applicative((<*>), (<$>))+import qualified Control.Exception+import qualified Data.List+import qualified Distribution.Package+import qualified Distribution.Text+import qualified Distribution.Version+import qualified Squeeze.CommandOptions as CommandOptions+import qualified Squeeze.File as File+import qualified Squeeze.FileCombination as FileCombination+import qualified Squeeze.Squeeze as Squeeze+import qualified Squeeze.QC as QC+import qualified System+import qualified System.Console.GetOpt as G+import qualified System.IO+import qualified System.IO.Error+import qualified Test.QuickCheck+import qualified ToolShed.Defaultable as Defaultable++-- | Used to thread user-defined command-line options, though the list of functions which implement them.+type CommandLineAction = (CommandOptions.CommandOptions -> IO CommandOptions.CommandOptions) --Supplied as the type-argument to 'G.OptDescr'.++{- |+ * Parses the command-line arguments, to determine 'CommandOptions.CommandOptions', some of which may over-ride the 'Defaultable.defaultValue'.++ * Arguments following known 'CommandOptions.CommandOptions', are interpreted as file-names to consider when attempting to find a suitable fit for the specified space-constraints.++ * If the specified file-name is @-@, then 'System.IO.stdin' is read, to augment other non-options specified.++ * Delegates the donkey-work to 'Squeeze.squeeze', then formats & prints the resulting list of candidate solutions, each at least as good as the last.+-}+main :: IO ()+main = do+ progName <- System.getProgName+ args <- System.getArgs++ let+ usage :: String+ usage = "Usage:\t" ++ G.usageInfo progName optDescrList ++ " [<file/directory-name>, ...]\n\nExamples:\n\t" ++ progName ++ " -M 700000000 *.ogg\t\t#Find the best-fit for the globbed file-names, into the space available on a CD.\n\t" ++ progName ++ " Directory/ *.avi +RTS -N -H100M\t#Find the best-fit, for an atomic directory & the globbed files, into the default space, (ie that available on a DVD), using multiple cores, with extra heap pre-allocated."++ optDescrList :: [G.OptDescr CommandLineAction]+ optDescrList = [+-- String [String] (G.ArgDescr CommandLineAction) String+ G.Option "b" ["bisectionRatio"] (setBisectionRatio `G.ReqArg` "<Double>") ("To facilitate parallelization, the file-list is bisected at LHS/Total, and combinations from the LHS are concatenated in parallel with each of those from the RHS; default '" ++ show (CommandOptions.bisectionRatio Defaultable.defaultValue) ++ "'. Requires runtime-flags '+RTS -N -H100M -RTS'."),+ G.Option "M" ["maximumBytes"] (setMaximumBytes `G.ReqArg` "<Int>") ("The maximum bytes of available space; default '" ++ show (CommandOptions.maximumBytes Defaultable.defaultValue) ++ "'."),+ G.Option "m" ["minimumUsageRatio"] (setMinimumUsageRatio `G.ReqArg` "<Double>") ("The minimum acceptable space usage-ratio; default '" ++ show (CommandOptions.minimumUsageRatio Defaultable.defaultValue) ++ "'."),+ G.Option "q" ["runQuickChecks"] (G.NoArg runQuickChecks) "Run Quick-checks using arbitrary data & then exit. Specify '--verbose' before this option, for detailed output.",+ G.Option "v" ["verbose"] (G.NoArg $ return . CommandOptions.setVerbose) "Produce additional explanatory output where appropriate.",+ G.Option "" ["version"] (G.NoArg $ const printVersion) "Print version-information & then exit.",+ G.Option "?" ["help"] (G.NoArg $ const printUsage) "Display this help & then exit."+ ] where+ setBisectionRatio, setMaximumBytes, setMinimumUsageRatio :: String -> CommandLineAction+ setBisectionRatio arg commandLineArgs+ | ratio < 0.0 = Control.Exception.throw $ System.IO.Error.mkIOError System.IO.Error.illegalOperationErrorType ("bisectionRatio='" ++ arg ++ "' must be >= 0.0") Nothing Nothing+ | ratio > 1.0 = Control.Exception.throw $ System.IO.Error.mkIOError System.IO.Error.illegalOperationErrorType ("bisectionRatio='" ++ arg ++ "' must be <= 1.0") Nothing Nothing+ | otherwise = return {-to IO-monad-} commandLineArgs {CommandOptions.bisectionRatio = ratio}+ where+ ratio = read arg++ setMaximumBytes arg commandLineArgs+ | bytes <= 0 = Control.Exception.throw $ System.IO.Error.mkIOError System.IO.Error.illegalOperationErrorType ("maximumBytes='" ++ arg ++ "' must be > 0") Nothing Nothing+ | otherwise = return {-to IO-monad-} commandLineArgs {CommandOptions.maximumBytes = bytes}+ where+ bytes = read arg++ setMinimumUsageRatio arg commandLineArgs+ | ratio < 0.0 = Control.Exception.throw $ System.IO.Error.mkIOError System.IO.Error.illegalOperationErrorType ("minimumUsageRatio='" ++ arg ++ "' must be >= 0.0") Nothing Nothing+ | ratio > 1.0 = Control.Exception.throw $ System.IO.Error.mkIOError System.IO.Error.illegalOperationErrorType ("minimumUsageRatio='" ++ arg ++ "' must be <= 1.0") Nothing Nothing+ | otherwise = return {-to IO-monad-} commandLineArgs {CommandOptions.minimumUsageRatio = ratio}+ where+ ratio = read arg++ runQuickChecks :: CommandOptions.CommandOptions -> IO CommandOptions.CommandOptions+ runQuickChecks commandOptions = QC.quickChecks (+ if CommandOptions.verbose commandOptions+ then+#if MIN_VERSION_QuickCheck(2,4,0)+ Test.QuickCheck.verboseCheck+#else+ error "'Test.QuickCheck.verboseCheck' is only available as of 'QuickCheck-2.4'."+#endif+ else Test.QuickCheck.quickCheck+ ) >> System.exitWith System.ExitSuccess++ printVersion, printUsage :: IO CommandOptions.CommandOptions+ printVersion = System.IO.hPutStrLn System.IO.stderr (Distribution.Text.display packageIdentifier ++ "\n\nCopyright (C) 2010 Dr. Alistair Ward.\nThis program comes with ABSOLUTELY NO WARRANTY.\nThis is free software, and you are welcome to redistribute it under certain conditions.\n\nWritten by Dr. Alistair Ward.") >> System.exitWith System.ExitSuccess where+ packageIdentifier :: Distribution.Package.PackageIdentifier+ packageIdentifier = Distribution.Package.PackageIdentifier {+ Distribution.Package.pkgName = Distribution.Package.PackageName "squeeze",+ Distribution.Package.pkgVersion = Distribution.Version.Version [1, 0, 1, 4] []+ }++ printUsage = System.IO.hPutStrLn System.IO.stderr usage >> System.exitWith System.ExitSuccess++-- G.getOpt :: G.ArgOrder CommandLineAction -> [G.OptDescr CommandLineAction] -> [String] -> ([CommandLineAction], [String], [String])+ case G.getOpt G.RequireOrder optDescrList args of+ (commandLineActions, nonOptions, [{-errors-}]) -> do+ commandOptions <- Data.List.foldl' (>>=) (+ return {-to IO-monad-} Defaultable.defaultValue+ ) {-transform using CommandLineAction-mutators-} commandLineActions --ie: do o1 <- CommandLineAction[0] commandOptions[0]; o2 <- CommandLineAction[1] o1; ...++ mapM_ (putStrLn . (`FileCombination.showFileCombination` "")) =<< Squeeze.squeeze commandOptions =<< if null nonOptions+ then Control.Exception.throw $ System.IO.Error.mkIOError System.IO.Error.doesNotExistErrorType "No files specified" Nothing Nothing+ else {-files specified-} if "-" `elem` nonOptions+ then let+ getFilePaths :: IO File.FilePathList+ getFilePaths = do+ eof <- System.IO.isEOF++ if eof+ then return {-to IO-monad-} []+ else {-more to read-} (:) <$> getLine <*> getFilePaths {-recurse-}+ in (filter (/= "-") nonOptions ++) <$> getFilePaths+ else {-real fileNames-} return {-to IO-monad-} nonOptions+ (_, _, errors) -> System.IO.Error.ioError . System.IO.Error.userError $ concatMap init {-chop-} errors+
+ src/Squeeze/CommandOptions.hs view
@@ -0,0 +1,74 @@+{-+ Copyright (C) 2010 Dr. Alistair Ward++ 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 <http://www.gnu.org/licenses/>.+-}+{- |+ [@AUTHOR@] Dr. Alistair Ward++ [@DESCRIPTION@]++ * Defines options for program-operation, which are expected to be set from the command-line.++ * Defines appropriate default values.+-}++module Squeeze.CommandOptions(+-- * Types+-- ** Data-types+ CommandOptions(+-- MkCommandOptions,+ bisectionRatio,+ maximumBytes,+ minimumUsageRatio,+ verbose+ ),+-- * Functions+ fileSizeBounds,+ minimumBytes,+ setVerbose+) where++import qualified Squeeze.File as File+import qualified Squeeze.FileSizeBounds as FileSizeBounds+import qualified ToolShed.Defaultable as Defaultable++-- | Declare a record used to contain command-line options.+data CommandOptions = MkCommandOptions {+ bisectionRatio :: Double, -- ^ To facilitate parallelization, the file-list is bisected at LHS/Total, and combinations from the LHS are concatenated in parallel with each of those from the RHS.+ maximumBytes :: File.FileSize, -- ^ The maximum space (in bytes) available in which to store a subset of the specified files.+ minimumUsageRatio :: Double, -- ^ The minimum acceptable usage of 'maximumBytes'.+ verbose :: Bool -- ^ The minimum acceptable usage of 'maximumBytes'.+}++instance Defaultable.Defaultable CommandOptions where+ defaultValue = MkCommandOptions {+ bisectionRatio = 0.5, --Setting this this option to 'Nothing', will prevent parallelization, but will return solutions in a more predictable order.+ maximumBytes = 4700000000, --DVD-size; just under 4.4GiB.+ minimumUsageRatio = 0.99, --99% full.+ verbose = False+ }++-- | Derives the minimum number of bytes, from other options.+minimumBytes :: CommandOptions -> File.FileSize+minimumBytes commandOptions = floor $ minimumUsageRatio commandOptions * fromIntegral (maximumBytes commandOptions)++-- | The permissible bounds on the size of a file, or set of files.+fileSizeBounds :: CommandOptions -> FileSizeBounds.FileSizeBounds+fileSizeBounds commandOptions = (minimumBytes commandOptions, maximumBytes commandOptions)++-- | Mutator.+setVerbose :: CommandOptions -> CommandOptions+setVerbose commandOptions = commandOptions { verbose = True }+
+ src/Squeeze/File.hs view
@@ -0,0 +1,97 @@+{-+ Copyright (C) 2010 Dr. Alistair Ward++ 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 <http://www.gnu.org/licenses/>.+-}+{- |+ [@AUTHOR@] Dr. Alistair Ward++ [@DESCRIPTION@] Defines file-related type-synonyms, and associated operations.+-}++module Squeeze.File (+-- * Types+-- ** Type-synonyms+ FilePathList,+ FileSize,+ FileSizeAndPath,+-- * Functions+ aggregateSize,+-- findSize,+ findSizes,+ getPath,+ getSize,+ hasSize,+ order+) where++import Control.Applicative((<$>))+import System.FilePath((</>))+import qualified Control.Exception+--import qualified Data.Int+import qualified Data.List+import qualified Data.Ord+import qualified System.IO+import qualified System.Directory+import qualified System.IO.Error+import qualified System.Posix.Files++-- | A type suitable for containing an arbitrary set of file-paths.+type FilePathList = [System.IO.FilePath]++-- | A type-synonym specifically to hold file-sizes (in bytes); 'Integer' matches the return-type of 'IO.hFileSize', but 'Data.Int.Int64' is about 4% faster.+--type FileSize = Data.Int.Int64+type FileSize = Integer++-- | A type suitable for containing a file-path, qualified by the corresponding 'FileSize'.+type FileSizeAndPath = (FileSize, System.IO.FilePath)++-- | Accessor.+getSize :: FileSizeAndPath -> FileSize+getSize = fst++-- | Accessor.+getPath :: FileSizeAndPath -> System.IO.FilePath+getPath = snd++-- | Sum the 'FileSize's contained in the specified list.+aggregateSize :: [FileSizeAndPath] -> FileSize+aggregateSize = Data.List.foldl' (\accumulator -> (accumulator +) . getSize) 0 --Three times faster than 'sum' & marginally faster than 'foldr'.++-- | Get the size of a file, treating a directory as an atomic unit.+findSize :: System.IO.FilePath -> IO FileSize+findSize f = do+ stat <- System.Posix.Files.getFileStatus f --CAVEAT: throws if user unauthorised, or file non-existent.++ if System.Posix.Files.isRegularFile stat+ then Control.Exception.bracket (System.IO.openFile f System.IO.ReadMode) System.IO.hClose $ \handle -> fromInteger <$> System.IO.hFileSize handle+ else {-not a regular file-} if System.Posix.Files.isDirectory stat+ then System.Directory.getDirectoryContents f >>= fmap {-into IO-monad-} aggregateSize . findSizes . map (f </>) . filter (`notElem` [".", ".."]) --Treat any directory as an atomic unit.+ else {-non-directory-} Control.Exception.throw $ System.IO.Error.mkIOError System.IO.Error.illegalOperationErrorType ("file='" ++ f ++ "' has unexpected type") Nothing (Just f)++-- | Finds file-sizes.+findSizes :: FilePathList -> IO [FileSizeAndPath]+findSizes filePathList = (`zip` filePathList) <$> {-lift into IO-monad-} mapM findSize filePathList++-- | Sorts list of 'FileSizeAndPath' by size, largest first.+order :: [FileSizeAndPath] -> [FileSizeAndPath]+order = Data.List.sortBy (flip $ Data.Ord.comparing getSize)++-- | 'True' if the specified file has the required size according to the specified predicate.+hasSize ::+ (FileSize -> Bool) -- ^ The predicate.+ -> FileSizeAndPath -- ^ The file parameters to be tested.+ -> Bool+hasSize f = f . getSize+
+ src/Squeeze/FileCombination.hs view
@@ -0,0 +1,76 @@+{-+ Copyright (C) 2010 Dr. Alistair Ward++ 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 <http://www.gnu.org/licenses/>.+-}+{- |+ [@AUTHOR@] Dr. Alistair Ward++ [@DESCRIPTION@] A type-synonym for a combination of files, and associated operations.+-}++module Squeeze.FileCombination (+-- * Types+-- ** Type-synonyms+ FileCombination,+-- * Constants+ nullFileCombination,+-- * Functions+ concatenate,+ hasSize,+ mkCombination,+ prepend,+ singleton,+ showFileCombination+) where++import Control.Arrow((***), (&&&))+import qualified Control.Arrow+import qualified Data.List+import qualified Squeeze.File as File++-- | Declare a list of files qualified by its aggregate size.+type FileCombination = (File.FileSize, File.FilePathList)++-- | A constant.+nullFileCombination :: FileCombination+nullFileCombination = (0, [])++-- | Create a 'FileCombination' from a list of 'File.FileSizeAndPath'.+mkCombination :: [File.FileSizeAndPath] -> FileCombination+mkCombination = File.aggregateSize &&& map File.getPath++-- | Construct a 'FileCombination' from a single 'File.FileSizeAndPath'.+singleton :: File.FileSizeAndPath -> FileCombination+singleton = Control.Arrow.second return++-- | Prepend a 'File.FileSizeAndPath' to an existing 'FileCombination'.+prepend ::+ File.FileSizeAndPath -- ^ The new path to prepend to the existing file-combination.+ -> FileCombination -- ^ The incumbent combination of files.+ -> FileCombination+prepend (fileSize, filePath) = (fileSize +) *** (filePath :)++-- | Concatenate two 'FileCombination's.+concatenate :: FileCombination -> FileCombination -> FileCombination+concatenate (fileSize, filePathList) = (fileSize +) *** (filePathList ++)++-- | Output.+showFileCombination :: FileCombination -> ShowS+showFileCombination (fileSize, filePathList) = shows fileSize . showChar '\t' . shows (Data.List.sort filePathList)++-- | Predicate used to determine whether a specific file-combination matches a size-related requirement.+hasSize :: (File.FileSize -> Bool) -> FileCombination -> Bool+hasSize f = f . fst+
+ src/Squeeze/FileSizeBounds.hs view
@@ -0,0 +1,56 @@+{-+ Copyright (C) 2010 Dr. Alistair Ward++ 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 <http://www.gnu.org/licenses/>.+-}+{- |+ [@AUTHOR@] Dr. Alistair Ward++ [@DESCRIPTION@] Defines a type-synonym for the permissible bounds on the size of a file or set of files, and associated operations.+-}++module Squeeze.FileSizeBounds (+-- * Types+-- ** Type-synonyms+ FileSizeBounds,+-- * Functions+ inside,+ precisely,+ shift+) where++import Control.Arrow((&&&), (***))+import qualified Squeeze.File as File++-- | Used to define the minimum and maximum permissible bounds on the size of a file or set of files.+type FileSizeBounds = (File.FileSize, File.FileSize)++-- | Predicate.+inside ::+ FileSizeBounds -- ^ The bounds defining /inside/ from /outside/.+ -> File.FileSize -- ^ The file-parameters to be tested.+ -> Bool+inside (i, j) x = ($ x) `all` [(>= i), (<= j)]++-- | Construct the bounds from a single 'FileSize'.+precisely :: File.FileSize -> FileSizeBounds+precisely = id &&& id++-- | Shift of both bounds by the specified amount.+shift ::+ File.FileSize -- ^ The magnitude of the require shift.+ -> FileSizeBounds -- ^ The input set of bounds.+ -> FileSizeBounds+shift i = (+ i) *** (+ i)+
+ src/Squeeze/QC.hs view
@@ -0,0 +1,80 @@+{-# OPTIONS_GHC -fno-warn-orphans #-}+{-+ Copyright (C) 2010 Dr. Alistair Ward++ 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 <http://www.gnu.org/licenses/>.+-}+{- |+ [@AUTHOR@] Dr. Alistair Ward++ [@DESCRIPTION@] Defines tests to dynamically verify the module "Squeeze.Squeeze" against arbitrary data.+-}++module Squeeze.QC(+-- * Types+-- ** Type-synonyms+-- Testable,+-- * Functions+ quickChecks+) where++import qualified Control.Arrow+import qualified Data.List+import qualified Test.QuickCheck+import qualified Squeeze.File as File+import qualified Squeeze.FileSizeBounds as FileSizeBounds+import qualified Squeeze.Squeeze as Squeeze++type Testable = [File.FileSizeAndPath] -> Test.QuickCheck.Property++-- | Defines invariant properties, which must hold for any 'FileSizeAndPath'.+quickChecks :: (Testable -> IO ()) -> IO ()+quickChecks = (`mapM_` [prop_bisectionRatio, prop_totalCombinations, prop_bounds, prop_all]) where+ translate :: [File.FileSizeAndPath] -> [File.FileSizeAndPath]+ translate = Data.List.nub . map (Control.Arrow.first abs)++ prop_bisectionRatio, prop_totalCombinations, prop_bounds, prop_all :: Testable+ prop_bisectionRatio fileSizeAndPathList = Test.QuickCheck.label "prop_bisectionRatio" $ (== 1) . length . Data.List.nub . map (+ \bisectionRatio -> Data.List.sort . Squeeze.distribute bisectionRatio fileSizeBounds $ File.order l+ ) . take 8 {-arbitrarily-} $ map ((1.0 /) . fromInteger) [1 ..] where+ l :: [File.FileSizeAndPath]+ l = take 10 {-arbitrarily-} $ translate fileSizeAndPathList --CAVEAT: may be shorter than requested.++ fileSizeBounds :: FileSizeBounds.FileSizeBounds+ fileSizeBounds = (minimumBytes, maximumBytes) where+ maximumBytes, minimumBytes :: File.FileSize+ maximumBytes = round $ fromIntegral (File.aggregateSize l) / (4.0 :: Double) --Arbitrarily.+ minimumBytes = maximumBytes `div` 2 --Arbitrarily.++ prop_totalCombinations fileSizeAndPathList = Test.QuickCheck.label "prop_totalCombinations" $ (length . Data.List.nub . Squeeze.findCombinations (0, fromIntegral (maxBound :: Int)) $ File.order l) == 2 ^ length l where+ l :: [File.FileSizeAndPath]+ l = take 10 {-arbitrarily-} $ translate fileSizeAndPathList --CAVEAT: may be shorter than requested.++ prop_bounds fileSizeAndPathList = Test.QuickCheck.label "prop_bounds" $ all (FileSizeBounds.inside fileSizeBounds) . map fst . Squeeze.findCombinations fileSizeBounds $ File.order l where+ l :: [File.FileSizeAndPath]+ l = take 16 {-arbitrarily-} $ translate fileSizeAndPathList --CAVEAT: may be shorter than requested.++ fileSizeBounds :: FileSizeBounds.FileSizeBounds+ fileSizeBounds = (minimumBytes, maximumBytes) where+ maximumBytes, minimumBytes :: File.FileSize+ maximumBytes = round $ fromIntegral (File.aggregateSize l) / (4.0 :: Double) --Arbitrarily.+ minimumBytes = maximumBytes `div` 2 --Arbitrarily.++ prop_all fileSizeAndPathList = Test.QuickCheck.label "prop_all" $ (== bytes) . last . map fst $ Squeeze.findBestFit 0.5 (FileSizeBounds.precisely bytes) l where+ l :: [File.FileSizeAndPath]+ l = take 16 {-arbitrarily-} . translate $ fileSizeAndPathList --CAVEAT: may be shorter than requested.++ bytes :: File.FileSize+ bytes = File.aggregateSize l+
+ src/Squeeze/Squeeze.hs view
@@ -0,0 +1,156 @@+{-# LANGUAGE CPP #-}+{-+ Copyright (C) 2010 Dr. Alistair Ward++ 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 <http://www.gnu.org/licenses/>.+-}+{- |+ [@AUTHOR@] Dr. Alistair Ward++ [@DESCRIPTION@]++ * Returns combinations of the specified files, which fit into the available space, without wasting more than the specified ratio.++ * Any directory-names are treated as atomic units, rather than individual files.++ * Because of the explosion of possible combinations,+ an /exact/ match for the available space is frequently found with a surprisingly small set of files.++ [@CAVEATS@]++ Though it runs in constant space, the algorithm has @O(2^n)@ time-complexity, & may take an excessive time to calculate all possibilities.+ Because of this, it prints progressively better matches as they're found, rather than waiting to find the best.+-}++module Squeeze.Squeeze(+-- * Functions+ distribute,+ findBestFit,+ findCombinations,+-- risingFilter,+ squeeze+) where++import Control.Applicative((<$>))+import qualified Control.Arrow+import qualified Data.List+import qualified Squeeze.CommandOptions as CommandOptions+import qualified Squeeze.File as File+import qualified Squeeze.FileCombination as FileCombination+import qualified Squeeze.FileSizeBounds as FileSizeBounds++#if MIN_VERSION_parallel(3,0,0)+import qualified Control.Parallel.Strategies+#endif++-- | Progressively raises the selection-criterion, as each match is found.+risingFilter ::+ File.FileSize -- ^ The initial minimum byte-size of file to accept.+ -> [FileCombination.FileCombination] -- ^ The input list of files to filter.+ -> [FileCombination.FileCombination] -- ^ The resulting list of files, which have met rising criterion.+risingFilter minimumBytes (x@(size, _) : xs)+ | size >= minimumBytes = x : risingFilter size xs+ | otherwise = risingFilter minimumBytes xs+risingFilter _ [] = []++{- |+ * Checks that the total aggregate 'File.FileSize', meets or exceeds 'minimumBytes'.++ * Drops excessively large files, assuming that the file-list has been sorted by size, largest first.++ * Generates up to @2^n@ combinations of the @n@ specified files; the algorithm is similar to 'Data.List.subsequences', except that unproductive lines are immediately terminated.+ This is the performance bottle-neck, and though there may be simpler and faster algorithms, the key attribute is that it operates in constant space.++ * The algorithm is stable, in that it maintains the specified file-order within each combination;+ though the order in which the combinations are concatenated is rather arbitrary.+-}+findCombinations ::+ FileSizeBounds.FileSizeBounds -- ^ The bounds within which to find file-combinations.+ -> [File.FileSizeAndPath] -- ^ The input list of file-names and sizes.+ -> [FileCombination.FileCombination] -- ^ The resulting unordered list of suitable file-combinations.+findCombinations (minimumBytes, maximumBytes) = filter (+ FileCombination.hasSize (>= minimumBytes)+ ) . (+ FileCombination.nullFileCombination :+ ) . nonEmptyCombinations minimumBytes . dropWhile (+ File.hasSize (> maximumBytes)+ ) where+ nonEmptyCombinations :: File.FileSize -> [File.FileSizeAndPath] -> [FileCombination.FileCombination]+ nonEmptyCombinations minimumBytes' fileSizeAndPathList@(x : xs)+ | minimumBytes' > 0 && File.aggregateSize fileSizeAndPathList < minimumBytes' = []+ | otherwise = FileCombination.singleton x : foldr (+ \y -> (y :) . let+ combination = FileCombination.prepend x y+ in if FileCombination.hasSize (<= maximumBytes) combination+ then (combination :)+ else id+ ) [] (nonEmptyCombinations (minimumBytes' - File.getSize x) xs {-recurse-})+ nonEmptyCombinations _ [] = []++-- | Splits up the task, to facilitate parallelization, before calling 'findCombinations'.+distribute ::+ Double -- ^ The ratio at which to bisect the list of files, in a divide and conquer strategy.+ -> FileSizeBounds.FileSizeBounds -- ^ The bounds within which to find file-combinations.+ -> [File.FileSizeAndPath] -- ^ The input list of file-names and sizes.+ -> [FileCombination.FileCombination] -- ^ The complete unordered list of suitable file-combinations.+distribute bisectionRatio fileSizeBounds fileSizeAndPathList+ | bisectionIndex <= 0 || bisectionIndex >= fileSizeAndPathListLength = findCombinations fileSizeBounds fileSizeAndPathList+ | otherwise = distribute' `uncurry` splitAt bisectionIndex fileSizeAndPathList+ where+ fileSizeAndPathListLength, bisectionIndex :: Int+ fileSizeAndPathListLength = length fileSizeAndPathList+ bisectionIndex = round $ bisectionRatio * fromIntegral fileSizeAndPathListLength++ distribute' :: [File.FileSizeAndPath] -> [File.FileSizeAndPath] -> [FileCombination.FileCombination]+ distribute' fileSizeAndPathListL fileSizeAndPathListR =+#if MIN_VERSION_parallel(3,0,0)+ concat $ Control.Parallel.Strategies.parMap (+ Control.Parallel.Strategies.evalList $ Control.Parallel.Strategies.evalTuple2 Control.Parallel.Strategies.rdeepseq Control.Parallel.Strategies.r0 --Evaluate the aggregate size, but not the path-list.+ )+#else+ concatMap+#endif+ (+ \combinationL@(fileSize, _) -> FileCombination.concatenate combinationL `map` findCombinations (negate fileSize `FileSizeBounds.shift` fileSizeBounds) fileSizeAndPathListR+ ) $ Control.Arrow.first (\minimumBytes -> minimumBytes - File.aggregateSize fileSizeAndPathListR) fileSizeBounds `findCombinations` fileSizeAndPathListL++{- |+ * Calls 'File.order' to sort the files by size (largest first), on the empirical basis that the generated file-combinations, will more quickly result in a good match for the available space.++ * Calls 'distribute' to split the job, to facilitate parallelization.++ * Calls the private function 'risingFilter' to progressively select better file-combinations from those returned by 'distribute'.+-}+findBestFit ::+ Double -- ^ The ratio at which to bisect the list of files, in a divide and conquer strategy.+ -> FileSizeBounds.FileSizeBounds -- ^ The bounds within which to find file-combinations.+ -> [File.FileSizeAndPath] -- ^ The input list of file-names and sizes.+ -> [FileCombination.FileCombination] -- ^ A reduced list of suitable file-combinations, sorted best first.+findBestFit bisectionRatio fileSizeBounds@(minimumBytes, _) = risingFilter minimumBytes . distribute bisectionRatio fileSizeBounds . File.order++{- |+ * Removes duplicate file-names.++ * Determines the size of each specified file.++ * Unpacks the command-line options.++ * Calls 'findBestFit' to solve the problem.+-}+squeeze ::+ CommandOptions.CommandOptions -- ^ The the caller's selection-criteria.+ -> File.FilePathList -- ^ The list of file-names from which to select.+ -> IO [FileCombination.FileCombination]+squeeze commandOptions = (CommandOptions.bisectionRatio commandOptions `findBestFit` CommandOptions.fileSizeBounds commandOptions <$>) . File.findSizes . Data.List.nub+