brotli (empty) → 0.0.0.0
raw patch · 7 files changed
+1918/−0 lines, 7 filesdep +HUnitdep +QuickCheckdep +basesetup-changed
Dependencies added: HUnit, QuickCheck, base, brotli, bytestring, tasty, tasty-hunit, tasty-quickcheck, transformers
Files
- LICENSE +676/−0
- Setup.hs +2/−0
- brotli.cabal +76/−0
- cbits/hs_brotli.h +164/−0
- src-tests/brotli-tests.hs +100/−0
- src/Codec/Compression/Brotli.hs +442/−0
- src/LibBrotli.hsc +458/−0
+ LICENSE view
@@ -0,0 +1,676 @@+ 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,2 @@+import Distribution.Simple+main = defaultMain
+ brotli.cabal view
@@ -0,0 +1,76 @@+cabal-version: 1.12+build-type: Simple+name: brotli+version: 0.0.0.0++synopsis: Brotli (RFC7932) compression and decompression+homepage: https://github.com/hvr/brotli+bug-reports: https://github.com/hvr/brotli/issues+license: GPL-3+license-file: LICENSE+author: Herbert Valerio Riedel+maintainer: hvr@gnu.org+copyright: (c) 2016, Herbert Valerio Riedel+category: Codec, Compression+description:+ <http://brotli.org Brotli> (<https://tools.ietf.org/html/rfc7932 RFC7932>) is a generic-purpose lossless compression algorithm suitable for <https://en.wikipedia.org/wiki/HTTP_compression HTTP compression> that compresses data using a combination of a modern variant of the LZ77 algorithm, Huffman coding and 2nd order context modeling.+ .+ This package provides a pure interface for compressing and+ decompressing Brotli streams of data represented as lazy @ByteString@s. A+ monadic incremental interface is provided as well. This package+ relies on Google's C implementation.+ .+ The following packages are based on this package and provide+ API support for popular streaming frameworks:+ .+ * </package/brotli-streams brotli-streams> (for </package/io-streams io-streams>)+ .+ * </package/pipes-brotli pipes-brotli> (for </package/pipes pipes>)+ .+ * </package/brotli-conduit brotli-conduit> (for </package/conduit conduit>)+ .++extra-source-files:+ cbits/hs_brotli.h++source-repository head+ type: git+ location: https://github.com/hvr/brotli.git++library+ hs-source-dirs: src+ exposed-modules: Codec.Compression.Brotli+ other-modules: LibBrotli++ build-depends: base >=4.5 && <4.13+ , bytestring >=0.9.2 && <0.11+ , transformers >=0.3.0.0 && <0.6++ default-language: Haskell2010++ pkgconfig-depends: libbrotlienc+ , libbrotlidec++ include-dirs: cbits++ ghc-options: -Wall++test-suite brotli-tests+ default-language: Haskell2010+ other-extensions: OverloadedStrings+ hs-source-dirs: src-tests+ type: exitcode-stdio-1.0+ main-is: brotli-tests.hs++ -- dependencies with version bounds inherited from the library stanza+ build-depends: brotli+ , base+ , bytestring+ -- additional dependencies that require version bounds+ build-depends: HUnit == 1.6.*+ , QuickCheck == 2.13.*+ , tasty == 1.2.*+ , tasty-hunit == 0.10.*+ , tasty-quickcheck == 0.10.*++ ghc-options: -Wall -threaded
+ cbits/hs_brotli.h view
@@ -0,0 +1,164 @@+// Copyright (C) 2016 Herbert Valerio Riedel+//+// 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/>.++#ifndef HS_BROTLI_H_+#define HS_BROTLI_H_++#include <stddef.h>+#include <stdint.h>+#include <brotli/encode.h>+#include <brotli/decode.h>++typedef enum HsBrotliState+ { HS_BS_NEEDS_INPUT = 0+ , HS_BS_HAS_OUTPUT = 1+ , HS_BS_FINISHED = 2+ , HS_BS_FAIL = 3+ , HS_BS_INTERNAL_ERROR = 4+ } HsBrotliState;++static inline HsBrotliState+HsBrotliEncoderCompressStream (BrotliEncoderState* state,+ BrotliEncoderOperation op,+ size_t* available_in, uint8_t** next_in,+ size_t* available_out, uint8_t** next_out,+ size_t* total_out)+{+ const BROTLI_BOOL ok = BrotliEncoderCompressStream (state, op, available_in, (const uint8_t**) next_in, available_out, next_out, total_out);++ switch(ok) {+ case BROTLI_FALSE: return HS_BS_FAIL;+ case BROTLI_TRUE:+ switch(BrotliEncoderHasMoreOutput(state)) {+ case BROTLI_TRUE: return HS_BS_HAS_OUTPUT;+ case BROTLI_FALSE:+ switch(BrotliEncoderIsFinished(state)) {+ case BROTLI_TRUE: return HS_BS_FINISHED;+ case BROTLI_FALSE: return HS_BS_NEEDS_INPUT;+ }+ }+ }++ return HS_BS_INTERNAL_ERROR; +}++static inline HsBrotliState+HsBrotliDecoderDecompressStream (BrotliDecoderState* state,+ size_t* available_in, uint8_t** next_in,+ size_t* available_out, uint8_t** next_out,+ size_t* total_out)+{+ const BrotliDecoderResult res = BrotliDecoderDecompressStream (state, available_in, (const uint8_t**) next_in, available_out, next_out, total_out);++ switch(res) {+ case BROTLI_DECODER_RESULT_ERROR: return HS_BS_FAIL;+ case BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT: return HS_BS_NEEDS_INPUT;+ case BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT: return HS_BS_HAS_OUTPUT;+ case BROTLI_DECODER_RESULT_SUCCESS:+ // TODO: are all these branches really reachable?+ switch(BrotliDecoderHasMoreOutput(state)) {+ case BROTLI_TRUE: return HS_BS_HAS_OUTPUT;+ case BROTLI_FALSE:+ switch(BrotliDecoderIsFinished(state)) {+ case BROTLI_TRUE: return HS_BS_FINISHED;+ case BROTLI_FALSE: return HS_BS_NEEDS_INPUT;+ }+ }+ }+ return HS_BS_INTERNAL_ERROR;+}+++static inline HsBrotliState+HsBrotliEncoderTakeOutput (BrotliEncoderState* state, size_t* sizep, uint8_t** buf_out)+{+ *buf_out = (uint8_t*) BrotliEncoderTakeOutput(state, sizep);++ const size_t size = *sizep;+ + if (!*buf_out && size != 0) {+ *sizep = 0;+ return HS_BS_INTERNAL_ERROR;+ }++ // empty+ if (size == 0) {+ *buf_out = NULL;+ switch(BrotliEncoderIsFinished(state)) {+ case BROTLI_TRUE: return HS_BS_FINISHED;+ case BROTLI_FALSE: return HS_BS_NEEDS_INPUT;+ }+ return HS_BS_INTERNAL_ERROR; + }++ // non-empty+ switch(BrotliEncoderHasMoreOutput(state)) {+ case BROTLI_TRUE: return HS_BS_HAS_OUTPUT;+ case BROTLI_FALSE:+ switch(BrotliEncoderIsFinished(state)) {+ case BROTLI_TRUE: return HS_BS_FINISHED;+ case BROTLI_FALSE: return HS_BS_NEEDS_INPUT;+ }+ }++ *sizep = 0;+ *buf_out = NULL;+ return HS_BS_INTERNAL_ERROR; +}++static inline HsBrotliState+HsBrotliDecoderTakeOutput (BrotliDecoderState* state, size_t* sizep, uint8_t** buf_out)+{+ *buf_out = (uint8_t*) BrotliDecoderTakeOutput(state, sizep);++ const size_t size = *sizep;+ + if (!*buf_out && size != 0) {+ *sizep = 0;+ return HS_BS_INTERNAL_ERROR;+ }++ // empty+ if (size == 0) {+ *buf_out = NULL;+ switch(BrotliDecoderIsFinished(state)) {+ case BROTLI_TRUE: return HS_BS_FINISHED;+ case BROTLI_FALSE: return HS_BS_NEEDS_INPUT;+ }+ return HS_BS_INTERNAL_ERROR; + }++ // non-empty+ switch(BrotliDecoderHasMoreOutput(state)) {+ case BROTLI_TRUE: return HS_BS_HAS_OUTPUT;+ case BROTLI_FALSE:+ switch(BrotliDecoderIsFinished(state)) {+ case BROTLI_TRUE: return HS_BS_FINISHED;+ case BROTLI_FALSE: return HS_BS_NEEDS_INPUT;+ }+ }++ *sizep = 0;+ *buf_out = NULL;+ return HS_BS_INTERNAL_ERROR; +}++static inline char*+HsBrotliDecoderErrorString (BrotliDecoderErrorCode c)+{+ return (char*) BrotliDecoderErrorString(c);+}++#endif
+ src-tests/brotli-tests.hs view
@@ -0,0 +1,100 @@+{-# LANGUAGE OverloadedStrings #-}++module Main (main) where++import Control.Applicative+import qualified Data.ByteString as BS+import qualified Data.ByteString.Lazy as BL+import Data.ByteString.Lazy.Char8 ()+import Data.List+import Prelude++import Test.Tasty+import Test.Tasty.QuickCheck as QC+import Test.Tasty.HUnit++import Codec.Compression.Brotli as Brotli++main :: IO ()+main = defaultMain tests++-- this is supposed to be equivalent to 'id'+codecompress :: BL.ByteString -> BL.ByteString+codecompress = decompress . compress++newtype ZeroBS = ZeroBS BL.ByteString++instance Show ZeroBS where+ show (ZeroBS s) | BL.length s > 0 = "ZeroBS (replicate " ++ show (BL.length s) ++ " " ++ show (BL.head s) ++ ")"+ | otherwise = "ZeroBS (empty)"++instance Arbitrary ZeroBS where+ arbitrary = do+ len <- choose (0, 1*1024*1024) -- up to 1MiB+ return $ (ZeroBS $ BL.replicate len 0)++-- shrink (ABS bs) = map ABS $ shrinks bs++randBS :: Int -> Gen BS.ByteString+randBS n = BS.pack `fmap` vectorOf n (choose (0, 255))++randBL :: Gen BL.ByteString+randBL = do+ ns <- arbitrary+ chunks <- mapM (randBS . (`mod` 10240)) ns+ return $ BL.fromChunks chunks++newtype RandBLSm = RandBLSm BL.ByteString+ deriving Show++newtype RandBL = RandBL BL.ByteString+ deriving Show++instance Arbitrary RandBL where+ arbitrary = RandBL <$> randBL++instance Arbitrary RandBLSm where+ arbitrary = do+ n <- choose (0,1024)+ RandBLSm . BL.fromChunks . (:[]) <$> randBS n++tests :: TestTree+tests = testGroup "ByteString API" [unitTests, properties]+ where+ unitTests = testGroup "testcases"+ [ testCase "decode-empty" $ decompress nullxz @?= BL.empty+ , testCase "encode-empty" $ codecompress BL.empty @?= BL.empty+ , testCase "encode-hello" $ codecompress "hello" @?= "hello"+ , testCase "encode-hello2" $ codecompress (singletonChunked "hello") @?= "hello"+ , testCase "decode-sample" $ decompress samplexz @?= sampleref+ , testCase "decode-sample2" $ decompress (singletonChunked samplexz) @?= sampleref+ , testCase "encode-sample" $ codecompress sampleref @?= sampleref+ , testCase "encode-empty^50" $ (iterate decompress (iterate (compressWith lowProf) "" !! 50) !! 50) @?= ""+ , testCase "encode-10MiB-zeros" $ let z = BL.replicate (10*1024*1024) 0 in codecompress z @?= z+ ]++ properties = testGroup "properties"+ [ QC.testProperty "decompress . compress === id (zeros)" $+ \(ZeroBS bs) -> codecompress bs == bs++ , QC.testProperty "decompress . compress === id (chunked)" $+ \(RandBL bs) -> codecompress bs == bs++-- We don't support concatenation yet+-- , QC.testProperty "decompress . (compress a <> compress b) === a <> b" $+-- \(RandBLSm a) (RandBLSm b) -> decompress (compress a `mappend` compress b) == a `mappend` b+ ]++ lowProf = defaultCompressParams { compressLevel = CompressionLevel0 }++nullxz :: BL.ByteString+nullxz = BL.singleton 0x3f++samplexz :: BL.ByteString+samplexz = BL.pack [27,149,1,232,37,169,208,210,122,16,67,60,33,76,195,0,85,117,73,135,40,94,219,146,49,252,21,2]++singletonChunked :: BL.ByteString -> BL.ByteString+singletonChunked = BL.fromChunks . map BS.singleton . BL.unpack++sampleref :: BL.ByteString+sampleref = BL.concat (intersperse " " $ replicate 11 "This sentence occurs multiple times.")
+ src/Codec/Compression/Brotli.hs view
@@ -0,0 +1,442 @@+{-# LANGUAGE BangPatterns #-}+{-# LANGUAGE DeriveDataTypeable #-}+{-# LANGUAGE Trustworthy #-}++-- Copyright (C) 2016 Herbert Valerio Riedel+--+-- 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/>.++-- |+-- Module : Codec.Compression.Brotli+-- Copyright : © 2016 Herbert Valerio Riedel+--+-- Maintainer : hvr@gnu.org+--+-- Compression and decompression of data streams in the \"Brotli\" format (<https://tools.ietf.org/html/rfc7932 RFC7932>)+--+module Codec.Compression.Brotli+ ( -- * Simple (de)compression with default parameters+ compress+ , decompress++ , BrotliException(..)++ -- * Extended API with control over parameters+ , compressWith+ , decompressWith++ -- * Monadic incremental (de)compression API+ --+ -- | See <http://hackage.haskell.org/package/zlib-0.6.1.1/docs/Codec-Compression-Zlib-Internal.html#g:2 zlib's incremental API documentation> for more information.++ -- ** Compression+ , CompressStream(..)+ , compressIO+ , compressST++ -- ** Decompression+ , DecompressStream(..)+ , decompressIO+ , decompressST++ , BrotliDecoderErrorCode(..)+ , showBrotliDecoderErrorCode++ -- * Parameters+ -- ** Compression parameters+ , defaultCompressParams++ , CompressParams+ , compressLevel+ , compressWindowSize+ , compressMode+ , compressSizeHint++ , CompressionLevel(..)+ , CompressionWindowSize(..)+ , CompressionMode(..)++ -- ** Decompression parameters+ , defaultDecompressParams++ , DecompressParams+ , decompressDisableRingBufferReallocation+ ) where++import Control.Applicative+import Prelude+import Control.Exception+import Control.Monad+import Control.Monad.ST (stToIO)+import Control.Monad.ST.Lazy (ST, runST, strictToLazyST)+import qualified Control.Monad.ST.Strict as ST.Strict (ST)+import Control.Monad.ST.Unsafe (unsafeIOToST)+import Data.ByteString (ByteString)+import qualified Data.ByteString as BS+import qualified Data.ByteString.Lazy as BSL+import qualified Data.ByteString.Lazy.Internal as BSL+import Data.Monoid (Monoid (mempty))+import Data.Typeable (Typeable)+import GHC.IO (noDuplicate)++import LibBrotli++-- | 'Exception' thrown on decoding errors or internal erros+--+-- Note that 'BrotliDecoderErrorCode' will be thrown instead of+-- 'BrotliException' when possible.+newtype BrotliException = BrotliException String deriving (Typeable,Show)++instance Exception BrotliException++-- | Compress lazy 'ByteString' into Brotli stream using 'defaultCompressParams'.+compress :: BSL.ByteString -> BSL.ByteString+compress = compressWith defaultCompressParams++-- | Like 'compress' but with the ability to specify various compression+-- parameters. Typical usage:+--+-- > compressWith defaultCompressParams { compress... = ... }+compressWith :: CompressParams -> BSL.ByteString -> BSL.ByteString+compressWith parms input = runST (compress' input)+ where+ compress' :: BSL.ByteString -> ST s BSL.ByteString+ compress' ibs0 = loop ibs0 =<< compressST parms+ where+ loop BSL.Empty CompressStreamEnd =+ pure BSL.Empty+ loop (BSL.Chunk _ _) CompressStreamEnd =+ throwST (BrotliException "internal error")+ loop BSL.Empty (CompressInputRequired _ supply) =+ loop BSL.Empty =<< supply BS.empty+ loop (BSL.Chunk c bs') (CompressInputRequired _ supply) =+ loop bs' =<< supply c+ loop ibs (CompressOutputAvailable oc next) = do+ obs <- loop ibs =<< next+ pure (BSL.chunk oc obs)+{-# NOINLINE compressWith #-}+++-- | Decompress lazy 'ByteString' from a Brotli stream.+decompress :: BSL.ByteString -> BSL.ByteString+decompress = decompressWith defaultDecompressParams++-- | Like 'decompress' but with the ability to specify various decompression+-- parameters. Typical usage:+--+-- > decompressWith defaultDecompressParams { decompress... = ... }+decompressWith :: DecompressParams -> BSL.ByteString -> BSL.ByteString+decompressWith parms input = runST (decompress' input)+ where+ decompress' :: BSL.ByteString -> ST s BSL.ByteString+ decompress' ibs0 = loop ibs0 =<< decompressST parms+ where+ loop BSL.Empty (DecompressStreamEnd rest)+ | BS.null rest = pure BSL.Empty+ | otherwise = throwST (BrotliException "extra trailing data")+ loop (BSL.Chunk _ _) (DecompressStreamEnd _) =+ throwST (BrotliException "extra trailing data")+ loop _ (DecompressStreamError ec) =+ throwST ec+ loop BSL.Empty (DecompressInputRequired supply) =+ loop BSL.Empty =<< supply BS.empty+ loop (BSL.Chunk c bs') (DecompressInputRequired supply) =+ loop bs' =<< supply c+ loop ibs (DecompressOutputAvailable oc next) = do+ obs <- loop ibs =<< next+ pure (BSL.chunk oc obs)+{-# NOINLINE decompressWith #-}++----------------------------------------------------------------------------++data CompressStream m =+ CompressInputRequired {- flush -} (m (CompressStream m))+ {- supply -} (ByteString -> m (CompressStream m))+ -- ^ Compression process requires input to proceed. You can+ -- either flush the stream (first field), supply an input chunk+ -- (second field), or signal the end of input (via empty+ -- chunk).+ | CompressOutputAvailable !ByteString (m (CompressStream m)) -- ^ Output chunk available.+ | CompressStreamEnd++-- | Incremental compression in the 'IO' monad.+compressIO :: CompressParams -> IO (CompressStream IO)+compressIO parms = stToIO (newBrotliEncoder parms)+ >>= maybe (throwIO (BrotliException "failed to initialize encoder")) go+ where+ bUFSIZ = 32752++ go ls = pure inputRequired+ where+ inputRequired = CompressInputRequired goFlush (withChunk goFinish goInput)++ unexpectedState = throwIO (BrotliException "internal error (unexpected state)")+ encoderFailure = throwIO (BrotliException "encoder failure")+ internalError = throwIO (BrotliException "internal error")++ goInput chunk = do -- assert (not $ BS.null chunk)+ (rc, unused) <- stToIO (runBrotliEncoder ls chunk BrotliEncOpProcess)++ let chunk' = BS.drop used chunk+ used = BS.length chunk - unused++ case rc of+ BSFail -> encoderFailure+ BSInternalError -> internalError+ BSFinished -> unexpectedState+ BSNeedsInput -> do unless (used > 0) internalError+ withChunk (pure inputRequired) goInput chunk'++ BSHasOutput -> drainOutput (withChunk (pure inputRequired) goInput chunk') unexpectedState++ goFlush = do+ (rc, 0) <- stToIO (runBrotliEncoder ls mempty BrotliEncOpFlush)+ case rc of+ BSFail -> encoderFailure+ BSInternalError -> internalError+ BSFinished -> unexpectedState+ BSNeedsInput -> unexpectedState+ BSHasOutput -> drainOutput (pure inputRequired) unexpectedState++ goFinish = do+ (rc, 0) <- stToIO (runBrotliEncoder ls mempty BrotliEncOpFinish)+ case rc of+ BSFail -> encoderFailure+ BSInternalError -> internalError+ BSFinished -> do+ !() <- stToIO (finalizeBrotliEncoder ls)+ pure CompressStreamEnd+ BSNeedsInput -> unexpectedState+ BSHasOutput -> drainOutput unexpectedState (pure CompressStreamEnd)++ drainOutput needsInputCont finishedCont = do+ (rc, obuf) <- stToIO (readBrotliEncoder ls bUFSIZ)+ case rc of+ BSFail -> encoderFailure+ BSInternalError -> internalError+ BSHasOutput -> do+ pure (CompressOutputAvailable obuf (drainOutput needsInputCont finishedCont))+ BSNeedsInput -> do+ pure (CompressOutputAvailable obuf needsInputCont)+ BSFinished -> do+ !() <- stToIO (finalizeBrotliEncoder ls)+ pure (CompressOutputAvailable obuf finishedCont)+++-- | Incremental compression in the lazy 'ST' monad.+compressST :: CompressParams -> ST s (CompressStream (ST s))+compressST parms = strictToLazyST (newBrotliEncoder parms)+ >>= maybe (throwST (BrotliException "failed to initialize encoder")) go+ where+ bUFSIZ = 32752++ go ls = pure inputRequired+ where+ inputRequired = CompressInputRequired goFlush (withChunk goFinish goInput)++ unexpectedState = throwST (BrotliException "internal error (unexpected state)")+ encoderFailure = throwST (BrotliException "encoder failure")+ internalError = throwST (BrotliException "internal error")++ goInput :: ByteString -> ST s (CompressStream (ST s))+ goInput chunk = do -- assert (not $ BS.null chunk)+ (rc, unused) <- strictToLazyST (noDuplicateST >> runBrotliEncoder ls chunk BrotliEncOpProcess)++ let chunk' = BS.drop used chunk+ used = BS.length chunk - unused++ case rc of+ BSFail -> encoderFailure+ BSInternalError -> internalError+ BSFinished -> unexpectedState+ BSNeedsInput -> do unless (used > 0) internalError+ withChunk (pure inputRequired) goInput chunk'++ BSHasOutput -> drainOutput (withChunk (pure inputRequired) goInput chunk') unexpectedState++ goFlush :: ST s (CompressStream (ST s))+ goFlush = do+ (rc, 0) <- strictToLazyST (noDuplicateST >> runBrotliEncoder ls mempty BrotliEncOpFlush)+ case rc of+ BSFail -> encoderFailure+ BSInternalError -> internalError+ BSFinished -> unexpectedState+ BSNeedsInput -> unexpectedState+ BSHasOutput -> drainOutput (pure inputRequired) unexpectedState++ goFinish :: ST s (CompressStream (ST s))+ goFinish = do+ (rc, 0) <- strictToLazyST (noDuplicateST >> runBrotliEncoder ls mempty BrotliEncOpFinish)+ case rc of+ BSFail -> encoderFailure+ BSInternalError -> internalError+ BSFinished -> do+ !() <- strictToLazyST (noDuplicateST >> finalizeBrotliEncoder ls)+ pure CompressStreamEnd+ BSNeedsInput -> unexpectedState+ BSHasOutput -> drainOutput unexpectedState (pure CompressStreamEnd)++ drainOutput :: ST s (CompressStream (ST s)) -> ST s (CompressStream (ST s)) -> ST s (CompressStream (ST s))+ drainOutput needsInputCont finishedCont = do+ (rc, obuf) <- strictToLazyST (noDuplicateST >> readBrotliEncoder ls bUFSIZ)+ case rc of+ BSFail -> encoderFailure+ BSInternalError -> internalError+ BSHasOutput -> do+ pure (CompressOutputAvailable obuf (drainOutput needsInputCont finishedCont))+ BSNeedsInput -> do+ pure (CompressOutputAvailable obuf needsInputCont)+ BSFinished -> do+ !() <- strictToLazyST (noDuplicateST >> finalizeBrotliEncoder ls)+ pure (CompressOutputAvailable obuf finishedCont)++data DecompressStream m =+ DecompressInputRequired (ByteString -> m (DecompressStream m)) -- ^ Decoding process requires input to proceed. An empty 'ByteString' chunk signals end of input.+ | DecompressOutputAvailable !ByteString (m (DecompressStream m)) -- ^ Decompressed output chunk available.+ | DecompressStreamEnd ByteString -- ^ Decoded stream is finished. Any unconsumed leftovers from the input stream are returned via the 'ByteString' field+ | DecompressStreamError !BrotliDecoderErrorCode++-- | Incremental decompression in the 'IO' monad.+decompressIO :: DecompressParams -> IO (DecompressStream IO)+decompressIO parms = stToIO (newBrotliDecoder parms)+ >>= maybe (throwIO (BrotliException "failed to initialize decoder")) go+ where+ bUFSIZ = 32752++ go ls = pure inputRequired+ where+ inputRequired = DecompressInputRequired (withChunk goFinish goInput)++ unexpectedState = throwIO (BrotliException "internal error (unexpected state)")+ internalError = throwIO (BrotliException "internal error")++ truncatedError = DecompressStreamError (BrotliDecoderErrorCode 2)++ goInput chunk = do -- assert (not $ BS.null chunk)+ (rc, ecode, unused) <- stToIO (runBrotliDecoder ls chunk)++ let chunk' = BS.drop used chunk+ used = BS.length chunk - unused++ case rc of+ BSFail -> pure (DecompressStreamError ecode)+ BSInternalError -> internalError+ BSFinished -> pure (DecompressStreamEnd chunk')+ BSNeedsInput -> do+ unless (used > 0) internalError+ withChunk (pure inputRequired) goInput chunk'++ BSHasOutput -> drainOutput (withChunk (pure inputRequired) goInput chunk')+ (pure (DecompressStreamEnd chunk'))++ goFinish = do+ (rc, ecode, 0) <- stToIO (runBrotliDecoder ls mempty)+ case rc of+ BSFail -> pure (DecompressStreamError ecode)+ BSInternalError -> internalError+ BSFinished -> do+ !() <- stToIO (finalizeBrotliDecoder ls)+ pure (DecompressStreamEnd mempty)+ BSNeedsInput -> pure truncatedError+ BSHasOutput -> drainOutput (pure truncatedError)+ (pure (DecompressStreamEnd mempty))++ drainOutput needsInputCont finishedCont = do+ (rc, obuf) <- stToIO (readBrotliDecoder ls bUFSIZ)+ case rc of+ BSFail -> unexpectedState -- cannot happen+ BSInternalError -> internalError+ BSHasOutput ->+ pure (DecompressOutputAvailable obuf (drainOutput needsInputCont finishedCont))+ BSNeedsInput ->+ pure (DecompressOutputAvailable obuf needsInputCont)+ BSFinished -> do+ !() <- stToIO (finalizeBrotliDecoder ls)+ pure (DecompressOutputAvailable obuf finishedCont)+++-- | Incremental decompression in the lazy 'ST' monad.+decompressST :: DecompressParams -> ST s (DecompressStream (ST s))+decompressST parms = strictToLazyST (newBrotliDecoder parms)+ >>= maybe (throwST (BrotliException "failed to initialize decoder")) go+ where+ bUFSIZ = 32752++ go ls = pure inputRequired+ where+ inputRequired = DecompressInputRequired (withChunk goFinish goInput)++ unexpectedState = throwST (BrotliException "internal error (unexpected state)")+ internalError = throwST (BrotliException "internal error")++ truncatedError = DecompressStreamError (BrotliDecoderErrorCode 2)++ goInput :: ByteString -> ST s (DecompressStream (ST s))+ goInput chunk = do -- assert (not $ BS.null chunk)+ (rc, ecode, unused) <- strictToLazyST (noDuplicateST >> runBrotliDecoder ls chunk)++ let chunk' = BS.drop used chunk+ used = BS.length chunk - unused++ case rc of+ BSFail -> pure (DecompressStreamError ecode)+ BSInternalError -> internalError+ BSFinished -> pure (DecompressStreamEnd chunk')+ BSNeedsInput -> do+ unless (used > 0) internalError+ withChunk (pure inputRequired) goInput chunk'++ BSHasOutput -> drainOutput (withChunk (pure inputRequired) goInput chunk')+ (pure (DecompressStreamEnd chunk'))++ goFinish :: ST s (DecompressStream (ST s))+ goFinish = do+ (rc, ecode, 0) <- strictToLazyST (noDuplicateST >> runBrotliDecoder ls mempty)+ case rc of+ BSFail -> pure (DecompressStreamError ecode)+ BSInternalError -> internalError+ BSFinished -> do+ !() <- strictToLazyST (noDuplicateST >> finalizeBrotliDecoder ls)+ pure (DecompressStreamEnd mempty)+ BSNeedsInput -> pure truncatedError+ BSHasOutput -> drainOutput (pure truncatedError)+ (pure (DecompressStreamEnd mempty))++ drainOutput :: ST s (DecompressStream (ST s)) -> ST s (DecompressStream (ST s)) -> ST s (DecompressStream (ST s))+ drainOutput needsInputCont finishedCont = do+ (rc, obuf) <- strictToLazyST (noDuplicateST >> readBrotliDecoder ls bUFSIZ)+ case rc of+ BSFail -> unexpectedState -- cannot happen+ BSInternalError -> internalError+ BSHasOutput ->+ pure (DecompressOutputAvailable obuf (drainOutput needsInputCont finishedCont))+ BSNeedsInput ->+ pure (DecompressOutputAvailable obuf needsInputCont)+ BSFinished -> do+ !() <- strictToLazyST (noDuplicateST >> finalizeBrotliDecoder ls)+ pure (DecompressOutputAvailable obuf finishedCont)++-- | Small 'maybe'-ish helper distinguishing between empty and+-- non-empty 'ByteString's+withChunk :: t -> (ByteString -> t) -> ByteString -> t+withChunk emptyChunk nemptyChunk chunk+ | BS.null chunk = emptyChunk+ | otherwise = nemptyChunk chunk++-- | See <https://github.com/haskell/zlib/issues/7>+noDuplicateST :: ST.Strict.ST s ()+noDuplicateST = unsafeIOToST noDuplicate++throwST :: Exception e => e -> ST s a+throwST = throw
+ src/LibBrotli.hsc view
@@ -0,0 +1,458 @@+{-# LANGUAGE BangPatterns #-}+{-# LANGUAGE CApiFFI #-}+{-# LANGUAGE DeriveDataTypeable #-}+{-# LANGUAGE RecordWildCards #-}++-- Copyright (C) 2016 Herbert Valerio Riedel+--+-- 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/>.++-- | Internal low-level bindings to libbrotli+module LibBrotli+ ( CompressParams(..), defaultCompressParams+ , CompressionLevel(..), CompressionWindowSize(..), CompressionMode(..)+ , DecompressParams(..), defaultDecompressParams+ , BrotliState(..), BrotliEncOp(..)+ , newBrotliEncoder, newBrotliDecoder+ , finalizeBrotliEncoder, finalizeBrotliDecoder+ , runBrotliEncoder, runBrotliDecoder+ , readBrotliEncoder, readBrotliDecoder+ , brotliEncoderVersion, brotliDecoderVersion+ , BrotliDecoderErrorCode(..), showBrotliDecoderErrorCode+ ) where++import Control.Applicative+import Control.Monad+import Control.Exception+import Control.Monad.ST.Strict (ST)+import Control.Monad.ST.Unsafe (unsafeIOToST)+import Data.ByteString (ByteString)+import Data.Typeable (Typeable)+import Foreign+import Foreign.C+import System.IO.Unsafe as Unsafe (unsafePerformIO)+import Prelude+import qualified Data.ByteString as BS+import qualified Data.ByteString.Unsafe as BS+import Control.Monad.Trans.Maybe (MaybeT(..))++#include "hs_brotli.h"++allocaPoke :: Storable x => x -> (Ptr x -> IO b) -> IO b+allocaPoke v0 act = alloca $ \pv -> do { poke pv v0; act pv }++packBS :: Ptr Word8 -> CSize -> IO ByteString+packBS p sz+ | sz > 0 = BS.packCStringLen (castPtr p, fromIntegral sz)+ | otherwise = pure BS.empty++----------------------------------------------------------------------------++type BrotliBool = #type BROTLI_BOOL++fromBrotliBool :: BrotliBool -> Maybe Bool+fromBrotliBool #{const BROTLI_TRUE} = Just True+fromBrotliBool #{const BROTLI_FALSE} = Just False+fromBrotliBool _ = Nothing++toBrotliBool :: Bool -> BrotliBool+toBrotliBool False = #{const BROTLI_FALSE}+toBrotliBool True = #{const BROTLI_TRUE}++----------------------------------------------------------------------------++-- | Errors signalled by the Brotli decoder. Use 'showBrotliDecoderErrorCode' to convert the numeric code into an error message.+newtype BrotliDecoderErrorCode = BrotliDecoderErrorCode Int deriving (Eq,Show,Typeable)++instance Exception BrotliDecoderErrorCode++-- | Convert numeric 'BrotliDecoderErrorCode' into textual error message.+{-# NOINLINE showBrotliDecoderErrorCode #-}+showBrotliDecoderErrorCode :: BrotliDecoderErrorCode -> String+showBrotliDecoderErrorCode (BrotliDecoderErrorCode ec) = Unsafe.unsafePerformIO $ do+ bufptr <- c_BrotliDecoderErrorString (fromIntegral ec)+ if bufptr == nullPtr then pure "" else peekCAString bufptr++----------------------------------------------------------------------------++-- internal state enumeration+data BrotliState+ = BSNeedsInput -- NB: initial state+ | BSHasOutput+ | BSFinished+ | BSFail+ | BSInternalError -- the impossible happened+ deriving (Eq,Show)++type HsBrotliState = #{type HsBrotliState}++fromHsBrotliState :: HsBrotliState -> BrotliState+fromHsBrotliState x = case x of+ #{const HS_BS_NEEDS_INPUT} -> BSNeedsInput+ #{const HS_BS_HAS_OUTPUT} -> BSHasOutput+ #{const HS_BS_FINISHED} -> BSFinished+ #{const HS_BS_FAIL} -> BSFail+ _ -> BSInternalError++----------------------------------------------------------------------------++-- | Set of parameters for compression. The defaults are 'defaultCompressParams'.+data CompressParams = CompressParams+ { compressLevel :: !CompressionLevel -- ^ 'CompressParams' field: See documentation of 'CompressionLevel'+ , compressWindowSize :: !CompressionWindowSize -- ^ 'CompressParams' field: See documentation of 'CompressionWindowSize'+ , compressMode :: !CompressionMode -- ^ 'CompressParams' field: See documentation of 'CompressionMode'+ , compressSizeHint :: !Word32 -- ^ 'CompressParams' field: Estimated total input size. The default value is @0@, which means that the total input size is unknown.+ }++-- | Set of parameters for decompression. The defaults are+-- 'defaultDecompressParams'.+data DecompressParams = DecompressParams+ { decompressDisableRingBufferReallocation :: !Bool -- ^ 'DecompressParams' field: If 'True', ring buffer is allocated according to window size, despite the real size of the content. (default: 'False')+ }++-- | The default set of parameters for compression. This is typically+-- used with the 'Codec.Compression.Brotli.compressWith' function with specific parameters+-- overridden.+defaultCompressParams :: CompressParams+defaultCompressParams = CompressParams {..}+ where+ compressLevel = maxBound+ compressWindowSize = CompressionWindowBits22+ compressMode = CompressionModeGeneric+ compressSizeHint = 0++-- | The default set of parameters for decompression. This is+-- typically used with the 'Codec.Compression.Brotli.decompressWith' function with specific+-- parameters overridden.+defaultDecompressParams :: DecompressParams+defaultDecompressParams = DecompressParams False++-- | C pointer to @BrotliEncoderState@+newtype BrotliEncoder = BrotliEncoder (ForeignPtr BrotliEncoder)++-- | C pointer to @BrotliDecoderState@+newtype BrotliDecoder = BrotliDecoder (ForeignPtr BrotliDecoder)++newBrotliEncoder :: CompressParams -> ST s (Maybe BrotliEncoder)+newBrotliEncoder CompressParams{..} = unsafeIOToST $ runMaybeT $ do+ fp <- MaybeT createBrotliEncoder++ unless (#{const BROTLI_DEFAULT_QUALITY} == qualityParm) $ do+ rc <- setParm fp #{const BROTLI_PARAM_QUALITY} qualityParm+ unless rc $ fail "invalid BROTLI_PARAM_QUALITY"++ unless (#{const BROTLI_DEFAULT_MODE} == modeParm) $ do+ rc <- setParm fp #{const BROTLI_PARAM_MODE} modeParm+ unless rc $ fail "invalid BROTLI_PARAM_MODE"++ unless (#{const BROTLI_DEFAULT_WINDOW} == winParm) $ do+ unless ((#{const BROTLI_MIN_WINDOW_BITS} <= winParm) && (winParm <= #{const BROTLI_MAX_WINDOW_BITS})) $+ fail "invalid BROTLI_PARAM_LGWIN (internal inconsistency)"++ rc <- setParm fp #{const BROTLI_PARAM_LGWIN} winParm+ unless rc $ fail "invalid BROTLI_PARAM_LGWIN"++ unless (0 == compressSizeHint) $ do+ rc <- setParm fp #{const BROTLI_PARAM_SIZE_HINT} compressSizeHint+ unless rc $ fail "invalid BROTLI_PARAM_SIZE_HINT"++ pure fp+ where+ setParm (BrotliEncoder fp) k v = MaybeT (withForeignPtr fp $ \p -> fromBrotliBool <$> c_BrotliEncoderSetParameter p k v)++ qualityParm = fromIntegral (fromEnum compressLevel)+ winParm = fromIntegral (fromEnum compressWindowSize)+ modeParm = case compressMode of+ CompressionModeGeneric -> #{const BROTLI_MODE_GENERIC}+ CompressionModeText -> #{const BROTLI_MODE_TEXT}+ CompressionModeFont -> #{const BROTLI_MODE_FONT}++newBrotliDecoder :: DecompressParams -> ST s (Maybe BrotliDecoder)+newBrotliDecoder DecompressParams{..} = unsafeIOToST $ runMaybeT $ do+ fp <- MaybeT createBrotliDecoder++ when decompressDisableRingBufferReallocation $ do+ rc <- setParm fp #{const BROTLI_DECODER_PARAM_DISABLE_RING_BUFFER_REALLOCATION}+ (fromIntegral $ toBrotliBool decompressDisableRingBufferReallocation)+ unless rc $ fail "invalid BROTLI_DECODER_PARAM_DISABLE_RING_BUFFER_REALLOCATION"++ pure fp+ where+ setParm (BrotliDecoder fp) k v = MaybeT (withForeignPtr fp $ \p -> fromBrotliBool <$> c_BrotliDecoderSetParameter p k v)++createBrotliEncoder :: IO (Maybe BrotliEncoder)+createBrotliEncoder = mask_ $ do+ p <- c_BrotliEncoderCreateInstance nullPtr nullPtr nullPtr+ case () of+ _ | p == nullPtr -> pure Nothing+ | otherwise -> do+ !fp <- newForeignPtr cp_BrotliEncoderDestroyInstance p+ pure (Just (BrotliEncoder fp))++createBrotliDecoder :: IO (Maybe BrotliDecoder)+createBrotliDecoder = mask_ $ do+ p <- c_BrotliDecoderCreateInstance nullPtr nullPtr nullPtr+ case () of+ _ | p == nullPtr -> pure Nothing+ | otherwise -> do+ !fp <- newForeignPtr cp_BrotliDecoderDestroyInstance p+ pure (Just (BrotliDecoder fp))++finalizeBrotliEncoder :: BrotliEncoder -> ST s ()+finalizeBrotliEncoder (BrotliEncoder s) = unsafeIOToST (finalizeForeignPtr s)++finalizeBrotliDecoder :: BrotliDecoder -> ST s ()+finalizeBrotliDecoder (BrotliDecoder s) = unsafeIOToST (finalizeForeignPtr s)++data BrotliEncOp+ = BrotliEncOpProcess+ | BrotliEncOpFlush+ | BrotliEncOpFinish+-- | BrotliEncOpEmitMetadata -- TODO++runBrotliEncoder :: BrotliEncoder+ -> ByteString+ -> BrotliEncOp+ -> ST s (BrotliState,Int) {- (state, unused-input) -}+runBrotliEncoder (BrotliEncoder fp) ibs action0+ = unsafeIOToST $ withForeignPtr fp $ \encPtr -> do+ BS.unsafeUseAsCStringLen ibs $ \(ibsptr, ibslen) ->+ allocaPoke (fromIntegral ibslen) $ \availIn ->+ allocaPoke ibsptr $ \nextIn -> do+ allocaPoke 0 $ \availOut -> do+ rc <- fromHsBrotliState <$>+ c_BrotliEncoderCompressStream encPtr action availIn (castPtr nextIn) availOut nullPtr nullPtr+ availIn' <- fromIntegral <$> peek availIn+ pure (rc, availIn')+ where+ action = case action0 of+ BrotliEncOpProcess -> #{const BROTLI_OPERATION_PROCESS}+ BrotliEncOpFinish -> #{const BROTLI_OPERATION_FINISH}+ BrotliEncOpFlush -> #{const BROTLI_OPERATION_FLUSH}++runBrotliDecoder :: BrotliDecoder+ -> ByteString+ -> ST s (BrotliState,BrotliDecoderErrorCode,Int {- unused-input -})+runBrotliDecoder (BrotliDecoder fp) ibs+ = unsafeIOToST $ withForeignPtr fp $ \encPtr -> do+ BS.unsafeUseAsCStringLen ibs $ \(ibsptr, ibslen) ->+ allocaPoke (fromIntegral ibslen) $ \availIn ->+ allocaPoke ibsptr $ \nextIn -> do+ allocaPoke 0 $ \availOut -> do+ rc <- fromHsBrotliState <$>+ c_BrotliDecoderDecompressStream encPtr availIn (castPtr nextIn) availOut nullPtr nullPtr+ availIn' <- fromIntegral <$> peek availIn+ ecode <- BrotliDecoderErrorCode <$> if rc == BSFail+ then fromIntegral <$> c_BrotliDecoderGetErrorCode encPtr+ else pure 0+ pure (rc, ecode, availIn')++readBrotliEncoder :: BrotliEncoder -> Int {- max-output -} -> ST s (BrotliState, ByteString)+readBrotliEncoder (BrotliEncoder fp) maxobs+ = unsafeIOToST $ withForeignPtr fp $ \encPtr -> do+ allocaPoke (fromIntegral maxobs) $ \availOutPtr -> do+ alloca $ \obsptrptr -> do+ rc <- fromHsBrotliState <$>+ c_BrotliEncoderTakeOutput encPtr availOutPtr obsptrptr+ availOut' <- peek availOutPtr+ obsptr <- peek obsptrptr+ buf <- packBS obsptr availOut'+ pure (rc, buf)++readBrotliDecoder :: BrotliDecoder -> Int {- max-output -} -> ST s (BrotliState, ByteString)+readBrotliDecoder (BrotliDecoder fp) maxobs+ = unsafeIOToST $ withForeignPtr fp $ \encPtr -> do+ allocaPoke (fromIntegral maxobs) $ \availOutPtr -> do+ alloca $ \obsptrptr -> do+ rc <- fromHsBrotliState <$>+ c_BrotliDecoderTakeOutput encPtr availOutPtr obsptrptr+ availOut' <- peek availOutPtr+ obsptr <- peek obsptrptr+ buf <- packBS obsptr availOut'+ pure (rc, buf)++----------------------------------------------------------------------------++-- | Encoding profile+data CompressionMode+ = CompressionModeGeneric -- ^ Format-agnostic default mode+ | CompressionModeText -- ^ UTF-8 formatted text data+ | CompressionModeFont -- ^ Compression mode used in WOFF 2.0+ deriving (Eq,Read,Show,Typeable)++-- | Compression quality setting+data CompressionLevel+ = CompressionLevel0 -- ^ fastest/lowest compression level+ | CompressionLevel1+ | CompressionLevel2+ | CompressionLevel3+ | CompressionLevel4+ | CompressionLevel5+ | CompressionLevel6+ | CompressionLevel7+ | CompressionLevel8+ | CompressionLevel9+ | CompressionLevel10+ | CompressionLevel11 -- ^ slowest/highest compression level (default)+ deriving (Eq,Ord,Read,Show,Enum,Typeable,Bounded)++-- | Recommended sliding LZ77 window size.+--+-- The encoder may reduce this value (if e.g. input is much smaller than window size).+--+data CompressionWindowSize+ = CompressionWindowBits10 -- ^ 1008 bytes+ | CompressionWindowBits11 -- ^ 2032 bytes+ | CompressionWindowBits12 -- ^ 4080 bytes+ | CompressionWindowBits13 -- ^ 8176 bytes+ | CompressionWindowBits14 -- ^ 16368 bytes+ | CompressionWindowBits15 -- ^ 32752 bytes+ | CompressionWindowBits16 -- ^ 65520 bytes+ | CompressionWindowBits17 -- ^ 131056 bytes+ | CompressionWindowBits18 -- ^ 262128 bytes+ | CompressionWindowBits19 -- ^ 524272 bytes+ | CompressionWindowBits20 -- ^ 1048560 bytes+ | CompressionWindowBits21 -- ^ 2097136 bytes+ | CompressionWindowBits22 -- ^ 4194288 bytes (default)+ | CompressionWindowBits23 -- ^ 8388592 bytes+ | CompressionWindowBits24 -- ^ 16777200 bytes+ deriving (Eq,Ord,Read,Show,Typeable,Bounded)++-- | This 'Enum' instance is offset by 10.+--+-- >>> toEnum CompressionWindowBits10+-- 10+--+-- >>> fromEnum 22 :: CompressionWindowSize+-- CompressionWindowBits22+--+instance Enum CompressionWindowSize where+ toEnum i = case i of+ 10 -> CompressionWindowBits10+ 11 -> CompressionWindowBits11+ 12 -> CompressionWindowBits12+ 13 -> CompressionWindowBits13+ 14 -> CompressionWindowBits14+ 15 -> CompressionWindowBits15+ 16 -> CompressionWindowBits16+ 17 -> CompressionWindowBits17+ 18 -> CompressionWindowBits18+ 19 -> CompressionWindowBits19+ 20 -> CompressionWindowBits20+ 21 -> CompressionWindowBits21+ 22 -> CompressionWindowBits22+ 23 -> CompressionWindowBits23+ 24 -> CompressionWindowBits24+ _ -> error "toEnum(CompressionWindowSize): bad argument"++ fromEnum x = case x of+ CompressionWindowBits10 -> 10+ CompressionWindowBits11 -> 11+ CompressionWindowBits12 -> 12+ CompressionWindowBits13 -> 13+ CompressionWindowBits14 -> 14+ CompressionWindowBits15 -> 15+ CompressionWindowBits16 -> 16+ CompressionWindowBits17 -> 17+ CompressionWindowBits18 -> 18+ CompressionWindowBits19 -> 19+ CompressionWindowBits20 -> 20+ CompressionWindowBits21 -> 21+ CompressionWindowBits22 -> 22+ CompressionWindowBits23 -> 23+ CompressionWindowBits24 -> 24++----------------------------------------------------------------------------+-- FFI imports+--+-- encoder++foreign import capi "hs_brotli.h BrotliEncoderCreateInstance"+ c_BrotliEncoderCreateInstance :: Ptr () -> Ptr () -> Ptr () -> IO (Ptr BrotliEncoder)++-- foreign import capi "hs_brotli.h BrotliEncoderDestroyInstance"+-- c_BrotliEncoderDestroyInstance :: Ptr BrotliEncoder -> IO ()++foreign import capi "hs_brotli.h &BrotliEncoderDestroyInstance"+ cp_BrotliEncoderDestroyInstance :: FunPtr (Ptr BrotliEncoder -> IO ())++foreign import capi "hs_brotli.h HsBrotliEncoderCompressStream"+ c_BrotliEncoderCompressStream :: Ptr BrotliEncoder+ -> #{type BrotliEncoderOperation}+ -> Ptr CSize {- available_in -}+ -> Ptr (Ptr Word8) {- next_in -}+ -> Ptr CSize {- available_out -}+ -> Ptr (Ptr Word8) {- next_out -}+ -> Ptr CSize {- total_out -}+ -> IO HsBrotliState++-- foreign import capi unsafe "hs_brotli.h BrotliEncoderIsFinished"+-- c_BrotliEncoderIsFinished :: Ptr BrotliEncoder -> IO BrotliBool+--+-- foreign import capi unsafe "hs_brotli.h BrotliEncoderHasMoreOutput"+-- c_BrotliEncoderHasMoreOutput :: Ptr BrotliEncoder -> IO BrotliBool++foreign import capi unsafe "hs_brotli.h HsBrotliEncoderTakeOutput"+ c_BrotliEncoderTakeOutput :: Ptr BrotliEncoder -> Ptr CSize -> Ptr (Ptr Word8) -> IO HsBrotliState++-- e.g. 0x01000000+foreign import capi unsafe "hs_brotli.h BrotliEncoderVersion" brotliEncoderVersion :: Word32+++-- BROTLI_BOOL BrotliEncoderSetParameter(BrotliEncoderState *state, BrotliEncoderParameter param, uint32_t value)++foreign import capi unsafe "hs_brotli.h BrotliEncoderSetParameter"+ c_BrotliEncoderSetParameter :: Ptr BrotliEncoder -> #{type BrotliEncoderParameter} -> Word32 -> IO BrotliBool++----------------------------------------------------------------------------+-- decoder++foreign import capi "hs_brotli.h BrotliDecoderCreateInstance"+ c_BrotliDecoderCreateInstance :: Ptr () -> Ptr () -> Ptr () -> IO (Ptr BrotliDecoder)++-- foreign import capi "hs_brotli.h BrotliDecoderDestroyInstance"+-- c_BrotliDecoderDestroyInstance :: Ptr BrotliDecoder -> IO ()++foreign import capi "hs_brotli.h &BrotliDecoderDestroyInstance"+ cp_BrotliDecoderDestroyInstance :: FunPtr (Ptr BrotliDecoder -> IO ())++foreign import capi "hs_brotli.h HsBrotliDecoderDecompressStream"+ c_BrotliDecoderDecompressStream :: Ptr BrotliDecoder+ -> Ptr CSize {- available_in -}+ -> Ptr (Ptr Word8) {- next_in -}+ -> Ptr CSize {- available_out -}+ -> Ptr (Ptr Word8) {- next_out -}+ -> Ptr CSize {- total_out -}+ -> IO #{type HsBrotliState}++-- foreign import capi unsafe "hs_brotli.h BrotliDecoderIsFinished"+-- c_BrotliDecoderIsFinished :: Ptr BrotliDecoder -> IO BrotliBool+--+-- foreign import capi unsafe "hs_brotli.h BrotliDecoderHasMoreOutput"+-- c_BrotliDecoderHasMoreOutput :: Ptr BrotliDecoder -> IO BrotliBool++foreign import capi unsafe "hs_brotli.h HsBrotliDecoderTakeOutput"+ c_BrotliDecoderTakeOutput :: Ptr BrotliDecoder -> Ptr CSize -> Ptr (Ptr Word8) -> IO HsBrotliState++-- e.g. 0x01000000+foreign import capi unsafe "hs_brotli.h BrotliDecoderVersion" brotliDecoderVersion :: Word32++foreign import capi unsafe "hs_brotli.h BrotliDecoderSetParameter"+ c_BrotliDecoderSetParameter :: Ptr BrotliDecoder -> #{type BrotliDecoderParameter} -> Word32 -> IO BrotliBool++foreign import capi unsafe "hs_brotli.h BrotliDecoderGetErrorCode"+ c_BrotliDecoderGetErrorCode :: Ptr BrotliDecoder -> IO #{type BrotliDecoderErrorCode}++foreign import capi unsafe "hs_brotli.h HsBrotliDecoderErrorString"+ c_BrotliDecoderErrorString :: #{type BrotliDecoderErrorCode} -> IO CString