quicklz 1.5.0.6 → 1.5.0.7
raw patch · 7 files changed
+596/−595 lines, 7 filesdep ~test-frameworksetup-changedPVP ok
version bump matches the API change (PVP)
Dependency ranges changed: test-framework
API changes (from Hackage documentation)
Files
- Codec/Compression/QuickLZ.hsc +118/−117
- LICENSE +339/−339
- README.md +19/−19
- Setup.hs +2/−2
- quicklz.cabal +67/−67
- tests/Properties.hs +31/−31
- tests/ex1.hs +20/−20
Codec/Compression/QuickLZ.hsc view
@@ -1,117 +1,118 @@-{-# LANGUAGE CPP, ForeignFunctionInterface #-} --- | --- Module : Codec.Compression.QuickLZ --- Copyright : (c) Austin Seipp 2011 --- License : GPLv2 --- --- Maintainer : as@hacks.yi.org --- Stability : experimental --- Portability : portable --- --- This module provides a high level 'ByteString' interface to --- the QuickLZ library. More info about quicklz can be found here: --- <http://quicklz.com> --- --- QuickLZ is fast and compresses well. --- The library that is bundled with this version is QuickLZ v1.5.0, --- with the compression level set to 1. --- --- The following laws hold: --- --- @(decompress . compress) == id@ --- --- @(decompress xs) == (decompress xs)@ --- --- @(compress xs) == (compress xs)@ --- --- A word of notice: QuickLZ, for inputs of less than 5 bytes in length, will generate --- different compression results for the same input on identical runs. --- --- Because this behavior is not referentially transparent, we use a hack: merely short-circuit --- on an empty input, and always pad the input with 4 extra null bytes otherwise. This yields --- identical compression results for every input, giving compress the above nice law. --- On decompression, after yielding the resulting string from decompression, we cut the characters off. --- --- Arguably this is an abomination; nonetheless, this pure interface is a --- nice abstraction. --- -module Codec.Compression.QuickLZ -( -- * Compressing and decompressing strict 'ByteString's - compress -- :: S.ByteString -> S.ByteString -, decompress -- :: S.ByteString -> S.ByteString -, decompress' -- :: S.ByteString -> S.ByteString -) where - -import Foreign -import Foreign.C - -import qualified Data.ByteString as S -import qualified Data.ByteString.Internal as SI -import qualified Data.ByteString.Unsafe as U - -#include <quicklz.h> - --- --- High-level interface --- - --- | Compresses the input 'ByteString'. -compress :: S.ByteString -> S.ByteString -compress xs' - | S.null xs' = S.empty - | otherwise = - -- hack: always append 4 extra bytes to ensure input len >= 5 - let xs = xs' `S.append` (S.pack [0,0,0,0]) - in unsafePerformIO . allocaBytes qlz_state_compress_sz $ \compress_state -> - SI.createAndTrim (S.length xs + 400) $ \output -> do - U.unsafeUseAsCStringLen xs $ \(cstr,len) -> - c_qlz_compress cstr output len compress_state -{-# INLINEABLE compress #-} - --- | Decompress the input 'ByteString'. -decompress :: S.ByteString -> S.ByteString -decompress xs - | S.null xs = S.empty - | otherwise = - unsafePerformIO . allocaBytes qlz_state_decompress_sz $ \decompress_state -> do - sz <- U.unsafeUseAsCString xs c_qlz_size_decompressed - SI.createAndTrim sz $ \output -> do - U.unsafeUseAsCString xs $ \cstr -> do - c_ <- c_qlz_decompress cstr output decompress_state - return $ c_ - 4 -- hack: remove 4 ending bytes off of output string -{-# INLINEABLE decompress #-} - --- | Decompress the input 'ByteString' and save memory via overlapping decompression. -decompress' :: S.ByteString -> S.ByteString -decompress' xs - | S.null xs = S.empty - | otherwise = - unsafePerformIO . allocaBytes qlz_state_decompress_sz $ \decompress_state -> do - d <- U.unsafeUseAsCString xs c_qlz_size_decompressed - let sz = (d + (d `shiftR` 3) + 400) - SI.createAndTrim sz $ \output -> do - U.unsafeUseAsCStringLen xs $ \(cstr,clen) -> do - let dest = output `plusPtr` (sz - clen) - SI.memcpy dest (castPtr cstr) (fromIntegral clen) - c_ <- c_qlz_decompress dest output decompress_state - return $ c_ - 4 -- hack: remove 4 ending bytes off of output string - --- --- Simple bindings to some constants --- -qlz_state_compress_sz :: Int -qlz_state_compress_sz = #{size qlz_state_compress} -qlz_state_decompress_sz :: Int -qlz_state_decompress_sz = #{size qlz_state_decompress} - --- --- FFI Bindings --- -foreign import ccall unsafe "quicklz.h qlz_compress" - c_qlz_compress :: Ptr a -> Ptr b -> Int -> Ptr c -> IO Int - -foreign import ccall unsafe "quicklz.h qlz_decompress" - c_qlz_decompress :: Ptr a -> Ptr b -> Ptr c -> IO Int - -foreign import ccall unsafe "quicklz.h qlz_size_decompressed" - c_qlz_size_decompressed :: CString -> IO Int +{-# LANGUAGE CPP, ForeignFunctionInterface #-}+-- |+-- Module : Codec.Compression.QuickLZ+-- Copyright : (c) Austin Seipp 2011+-- License : GPLv2+-- +-- Maintainer : as@hacks.yi.org+-- Stability : experimental+-- Portability : portable+-- +-- This module provides a high level 'ByteString' interface to the+-- QuickLZ library. More information about quicklz can be found here:+-- <http://quicklz.com>+-- +-- QuickLZ is fast and compresses well. The library that is bundled+-- with this version is QuickLZ v1.5.0, with the compression level set+-- to 1.+module Codec.Compression.QuickLZ+( -- * Compressing and decompressing strict 'ByteString's+ compress -- :: S.ByteString -> S.ByteString+, decompress -- :: S.ByteString -> S.ByteString+, decompress' -- :: S.ByteString -> S.ByteString+) where++import Foreign+import Foreign.C++import qualified Data.ByteString as S+import qualified Data.ByteString.Internal as SI+import qualified Data.ByteString.Unsafe as U++#include <quicklz.h>+++-- +-- A word of notice: QuickLZ, for inputs of less than 5 bytes in+-- length, will generate different compression results for the same+-- input on identical runs.+--+-- Because this behavior is not referentially transparent, we use a+-- hack: merely short-circuit on an empty input, and always pad the+-- input with 4 extra null bytes otherwise. This yields identical+-- compression results for every input, giving compress the above nice+-- law. On decompression, after yielding the resulting string from+-- decompression, we cut the characters off.+--+-- Arguably this is an abomination; nonetheless, this pure interface+-- is a nice abstraction.+--+++-- +-- High-level interface+-- ++-- | Compresses the input 'ByteString'.+compress :: S.ByteString -> S.ByteString+compress xs'+ | S.null xs' = S.empty+ | otherwise = + -- hack: always append 4 extra bytes to ensure input len >= 5+ let xs = xs' `S.append` (S.pack [0,0,0,0]) + in unsafePerformIO . allocaBytes qlz_state_compress_sz $ \compress_state ->+ SI.createAndTrim (S.length xs + 400) $ \output -> do+ U.unsafeUseAsCStringLen xs $ \(cstr,len) -> + c_qlz_compress cstr output len compress_state+{-# INLINEABLE compress #-}++-- | Decompress the input 'ByteString'.+decompress :: S.ByteString -> S.ByteString+decompress xs+ | S.null xs = S.empty+ | otherwise = + unsafePerformIO . allocaBytes qlz_state_decompress_sz $ \decompress_state -> do+ sz <- U.unsafeUseAsCString xs c_qlz_size_decompressed+ SI.createAndTrim sz $ \output -> do+ U.unsafeUseAsCString xs $ \cstr -> do + c_ <- c_qlz_decompress cstr output decompress_state+ return $ c_ - 4 -- hack: remove 4 ending bytes off of output string+{-# INLINEABLE decompress #-}++-- | Decompress the input 'ByteString' and save memory via overlapping decompression.+decompress' :: S.ByteString -> S.ByteString+decompress' xs+ | S.null xs = S.empty+ | otherwise = + unsafePerformIO . allocaBytes qlz_state_decompress_sz $ \decompress_state -> do+ d <- U.unsafeUseAsCString xs c_qlz_size_decompressed+ let sz = (d + (d `shiftR` 3) + 400)+ SI.createAndTrim sz $ \output -> do+ U.unsafeUseAsCStringLen xs $ \(cstr,clen) -> do+ let dest = output `plusPtr` (sz - clen)+ SI.memcpy dest (castPtr cstr) (fromIntegral clen)+ c_ <- c_qlz_decompress dest output decompress_state+ return $ c_ - 4 -- hack: remove 4 ending bytes off of output string+{-# INLINEABLE decompress' #-}++-- +-- Simple bindings to some constants+-- ++qlz_state_compress_sz :: Int+qlz_state_compress_sz = #{size qlz_state_compress}+qlz_state_decompress_sz :: Int+qlz_state_decompress_sz = #{size qlz_state_decompress}++--+-- FFI Bindings+-- ++foreign import ccall unsafe "quicklz.h qlz_compress"+ c_qlz_compress :: Ptr a -> Ptr b -> Int -> Ptr c -> IO Int++foreign import ccall unsafe "quicklz.h qlz_decompress"+ c_qlz_decompress :: Ptr a -> Ptr b -> Ptr c -> IO Int++foreign import ccall unsafe "quicklz.h qlz_size_decompressed"+ c_qlz_size_decompressed :: CString -> IO Int
LICENSE view
@@ -1,339 +1,339 @@- GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Lesser General Public License instead.) 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 -this service 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 make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. 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. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -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 -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the 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 a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE 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. - - 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 -convey 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 2 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, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision 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, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - <signature of Ty Coon>, 1 April 1989 - Ty Coon, President of Vice - -This 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. + GNU GENERAL PUBLIC LICENSE+ Version 2, June 1991++ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The licenses for most software are designed to take away your+freedom to share and change it. By contrast, the GNU General Public+License is intended to guarantee your freedom to share and change free+software--to make sure the software is free for all its users. This+General Public License applies to most of the Free Software+Foundation's software and to any other program whose authors commit to+using it. (Some other Free Software Foundation software is covered by+the GNU Lesser General Public License instead.) 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+this service 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 make restrictions that forbid+anyone to deny you these rights or to ask you to surrender the rights.+These restrictions translate to certain responsibilities for you if you+distribute copies of the software, or if you modify it.++ For example, if you distribute copies of such a program, whether+gratis or for a fee, you must give the recipients all the rights that+you have. 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.++ We protect your rights with two steps: (1) copyright the software, and+(2) offer you this license which gives you legal permission to copy,+distribute and/or modify the software.++ Also, for each author's protection and ours, we want to make certain+that everyone understands that there is no warranty for this free+software. If the software is modified by someone else and passed on, we+want its recipients to know that what they have is not the original, so+that any problems introduced by others will not reflect on the original+authors' reputations.++ Finally, any free program is threatened constantly by software+patents. We wish to avoid the danger that redistributors of a free+program will individually obtain patent licenses, in effect making the+program proprietary. To prevent this, we have made it clear that any+patent must be licensed for everyone's free use or not licensed at all.++ The precise terms and conditions for copying, distribution and+modification follow.++ GNU GENERAL PUBLIC LICENSE+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION++ 0. This License applies to any program or other work which contains+a notice placed by the copyright holder saying it may be distributed+under the terms of this General Public License. The "Program", below,+refers to any such program or work, and a "work based on the Program"+means either the Program or any derivative work under copyright law:+that is to say, a work containing the Program or a portion of it,+either verbatim or with modifications and/or translated into another+language. (Hereinafter, translation is included without limitation in+the term "modification".) Each licensee is addressed as "you".++Activities other than copying, distribution and modification are not+covered by this License; they are outside its scope. The act of+running the Program is not restricted, and the output from the Program+is covered only if its contents constitute a work based on the+Program (independent of having been made by running the Program).+Whether that is true depends on what the Program does.++ 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the+notices that refer to this License and to the absence of any warranty;+and give any other recipients of the Program a copy of this License+along with the Program.++You may charge a fee for the physical act of transferring a copy, and+you may at your option offer warranty protection in exchange for a fee.++ 2. You may modify your copy or copies of the Program or any portion+of it, thus forming a work based on the Program, and copy and+distribute such modifications or work under the terms of Section 1+above, provided that you also meet all of these conditions:++ a) You must cause the modified files to carry prominent notices+ stating that you changed the files and the date of any change.++ b) You must cause any work that you distribute or publish, that in+ whole or in part contains or is derived from the Program or any+ part thereof, to be licensed as a whole at no charge to all third+ parties under the terms of this License.++ c) If the modified program normally reads commands interactively+ when run, you must cause it, when started running for such+ interactive use in the most ordinary way, to print or display an+ announcement including an appropriate copyright notice and a+ notice that there is no warranty (or else, saying that you provide+ a warranty) and that users may redistribute the program under+ these conditions, and telling the user how to view a copy of this+ License. (Exception: if the Program itself is interactive but+ does not normally print such an announcement, your work based on+ the Program is not required to print an announcement.)++These requirements apply to the modified work as a whole. If+identifiable sections of that work are not derived from the Program,+and can be reasonably considered independent and separate works in+themselves, then this License, and its terms, do not apply to those+sections when you distribute them as separate works. But when you+distribute the same sections as part of a whole which is a work based+on the Program, the distribution of the whole must be on the terms of+this License, whose permissions for other licensees extend to the+entire whole, and thus to each and every part regardless of who wrote it.++Thus, it is not the intent of this section to claim rights or contest+your rights to work written entirely by you; rather, the intent is to+exercise the right to control the distribution of derivative or+collective works based on the Program.++In addition, mere aggregation of another work not based on the Program+with the Program (or with a work based on the Program) on a volume of+a storage or distribution medium does not bring the other work under+the scope of this License.++ 3. You may copy and distribute the Program (or a work based on it,+under Section 2) in object code or executable form under the terms of+Sections 1 and 2 above provided that you also do one of the following:++ a) Accompany it with the complete corresponding machine-readable+ source code, which must be distributed under the terms of Sections+ 1 and 2 above on a medium customarily used for software interchange; or,++ b) Accompany it with a written offer, valid for at least three+ years, to give any third party, for a charge no more than your+ cost of physically performing source distribution, a complete+ machine-readable copy of the corresponding source code, to be+ distributed under the terms of Sections 1 and 2 above on a medium+ customarily used for software interchange; or,++ c) Accompany it with the information you received as to the offer+ to distribute corresponding source code. (This alternative is+ allowed only for noncommercial distribution and only if you+ received the program in object code or executable form with such+ an offer, in accord with Subsection b above.)++The source code for a work means the preferred form of the work for+making modifications to it. For an executable work, complete source+code means all the source code for all modules it contains, plus any+associated interface definition files, plus the scripts used to+control compilation and installation of the executable. However, as a+special exception, the source code distributed need not include+anything that is normally distributed (in either source or binary+form) with the major components (compiler, kernel, and so on) of the+operating system on which the executable runs, unless that component+itself accompanies the executable.++If distribution of executable or object code is made by offering+access to copy from a designated place, then offering equivalent+access to copy the source code from the same place counts as+distribution of the source code, even though third parties are not+compelled to copy the source along with the object code.++ 4. You may not copy, modify, sublicense, or distribute the Program+except as expressly provided under this License. Any attempt+otherwise to copy, modify, sublicense or distribute the Program is+void, and will automatically terminate your rights under this License.+However, parties who have received copies, or rights, from you under+this License will not have their licenses terminated so long as such+parties remain in full compliance.++ 5. You are not required to accept this License, since you have not+signed it. However, nothing else grants you permission to modify or+distribute the Program or its derivative works. These actions are+prohibited by law if you do not accept this License. Therefore, by+modifying or distributing the Program (or any work based on the+Program), you indicate your acceptance of this License to do so, and+all its terms and conditions for copying, distributing or modifying+the Program or works based on it.++ 6. Each time you redistribute the Program (or any work based on the+Program), the recipient automatically receives a license from the+original licensor to copy, distribute or modify the Program subject to+these terms and conditions. You may not impose any further+restrictions on the recipients' exercise of the rights granted herein.+You are not responsible for enforcing compliance by third parties to+this License.++ 7. If, as a consequence of a court judgment or allegation of patent+infringement or for any other reason (not limited to patent issues),+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+distribute so as to satisfy simultaneously your obligations under this+License and any other pertinent obligations, then as a consequence you+may not distribute the Program at all. For example, if a patent+license would not permit royalty-free redistribution of the Program by+all those who receive copies directly or indirectly through you, then+the only way you could satisfy both it and this License would be to+refrain entirely from distribution of the Program.++If any portion of this section is held invalid or unenforceable under+any particular circumstance, the balance of the section is intended to+apply and the section as a whole is intended to apply in other+circumstances.++It is not the purpose of this section to induce you to infringe any+patents or other property right claims or to contest validity of any+such claims; this section has the sole purpose of protecting the+integrity of the free software distribution system, which is+implemented by public license practices. Many people have made+generous contributions to the wide range of software distributed+through that system in reliance on consistent application of that+system; it is up to the author/donor to decide if he or she is willing+to distribute software through any other system and a licensee cannot+impose that choice.++This section is intended to make thoroughly clear what is believed to+be a consequence of the rest of this License.++ 8. If the distribution and/or use of the Program is restricted in+certain countries either by patents or by copyrighted interfaces, the+original copyright holder who places the Program under this License+may add an explicit geographical distribution limitation excluding+those countries, so that distribution is permitted only in or among+countries not thus excluded. In such case, this License incorporates+the limitation as if written in the body of this License.++ 9. The Free Software Foundation may publish revised and/or new versions+of the 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 a version number of this License which applies to it and "any+later version", you have the option of following the terms and conditions+either of that version or of any later version published by the Free+Software Foundation. If the Program does not specify a version number of+this License, you may choose any version ever published by the Free Software+Foundation.++ 10. If you wish to incorporate parts of the Program into other free+programs whose distribution conditions are different, write to the author+to ask for permission. For software which is copyrighted by the Free+Software Foundation, write to the Free Software Foundation; we sometimes+make exceptions for this. Our decision will be guided by the two goals+of preserving the free status of all derivatives of our free software and+of promoting the sharing and reuse of software generally.++ NO WARRANTY++ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.++ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR+REDISTRIBUTE 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.++ 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+convey 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 2 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, write to the Free Software Foundation, Inc.,+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.++Also add information on how to contact you by electronic and paper mail.++If the program is interactive, make it output a short notice like this+when it starts in an interactive mode:++ Gnomovision version 69, Copyright (C) year name of author+ Gnomovision 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, the commands you use may+be called something other than `show w' and `show c'; they could even be+mouse-clicks or menu items--whatever suits your program.++You should also get your employer (if you work as a programmer) or your+school, if any, to sign a "copyright disclaimer" for the program, if+necessary. Here is a sample; alter the names:++ Yoyodyne, Inc., hereby disclaims all copyright interest in the program+ `Gnomovision' (which makes passes at compilers) written by James Hacker.++ <signature of Ty Coon>, 1 April 1989+ Ty Coon, President of Vice++This 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.
README.md view
@@ -1,19 +1,19 @@-# hs-quicklz: haskell bindings to quicklz - -This library implements haskell bindings to [QuickLZ](http://quicklz.com), a fast -compression library. The interface is very simple: - - compress :: ByteString -> ByteString - decompress :: ByteString -> ByteString - decompress' :: ByteString -> ByteString -- overlapping decompression - -As the name states, QuickLZ is fast - very fast at both compression and decompression. -Per its own benchmarks, at compression level 1, QuickLZ 1.5.0 has a compression speed -of 308Mbyte/s, and a decompression speed of 358Mbyte/s (their benchmarks, Core i7 920.) -This package has some benchmarks and tests associated - I would like to expand the benchmarks -to include bigger data sets in the future. - -There is currently only an interface for strict bytestrings. - -I would like to implement the streaming mode functionality sometime in the future, perhaps -tying it to John Millikin's [enumerator](http://hackage.haskell.org/package/enumerator) package. +# hs-quicklz: haskell bindings to quicklz++This library implements haskell bindings to [QuickLZ](http://quicklz.com), a fast+compression library. The interface is very simple:++ compress :: ByteString -> ByteString+ decompress :: ByteString -> ByteString+ decompress' :: ByteString -> ByteString -- overlapping decompression++As the name states, QuickLZ is fast - very fast at both compression and decompression.+Per its own benchmarks, at compression level 1, QuickLZ 1.5.0 has a compression speed+of 308Mbyte/s, and a decompression speed of 358Mbyte/s (their benchmarks, Core i7 920.)+This package has some benchmarks and tests associated - I would like to expand the benchmarks+to include bigger data sets in the future.++There is currently only an interface for strict bytestrings.++I would like to implement the streaming mode functionality sometime in the future, perhaps+tying it to John Millikin's [enumerator](http://hackage.haskell.org/package/enumerator) package.
Setup.hs view
@@ -1,2 +1,2 @@-import Distribution.Simple -main = defaultMain +import Distribution.Simple+main = defaultMain
quicklz.cabal view
@@ -1,67 +1,67 @@-name: quicklz -version: 1.5.0.6 -synopsis: binding to QuickLZ compression library -description: - This package provides a high level binding to the QuickLZ (<http://quicklz.com>) library - for ByteStrings, under the GPLv2 license. QuickLZ is fast and compresses very well. - . - This package includes the QuickLZ 1.5.0 source code, with compression level 1 and streaming - currently disabled. - . - The versioning scheme for this package is unusual. QuickLZ trys to be as fast as possible, - and will break backwards compatibility to achieve it in newer versions. This versioning scheme - reflects the QuickLZ versioning scheme: the first three digits of version w.x.y.z are - the quicklz version, with the 'z' component (and any further needed ones) being updates to this package, - not quicklz. -homepage: http://github.com/thoughtpolice/hs-quicklz -bug-reports: https://github.com/thoughtpolice/hs-quicklz/issues -license: GPL-2 -license-file: LICENSE -author: Austin Seipp -maintainer: as@hacks.yi.org -category: Codec -build-type: Simple -cabal-version: >=1.10 - -extra-source-files: - cbits/quicklz.h, cbits/quicklz.c, - tests/ex1.hs, tests/Properties.hs, - README.md - -source-repository head - type: git - location: https://github.com/thoughtpolice/hs-quicklz.git - -flag memory-safe - description: enable quickLZ memory safety checks - default: False - -library - exposed-modules: Codec.Compression.QuickLZ - build-depends: - base >= 3 && < 5, - bytestring == 0.9.* - - c-sources: cbits/quicklz.c - include-dirs: cbits - - ghc-options: -Wall -O2 -fwarn-tabs - if flag(memory-safe) - cpp-options: -DDEBUG - default-language: Haskell98 - -test-suite properties - hs-source-dirs: tests - main-is: Properties.hs - type: exitcode-stdio-1.0 - - build-depends: - base, - bytestring == 0.9.*, - QuickCheck == 2.4.*, - test-framework == 0.3.*, - test-framework-quickcheck2 == 0.2.*, - quicklz - - ghc-options: -fno-cse - default-language: Haskell98 +name: quicklz+version: 1.5.0.7+synopsis: binding to QuickLZ compression library+description: + This package provides a high level binding to the QuickLZ (<http://quicklz.com>) library+ for ByteStrings, under the GPLv2 license. QuickLZ is fast and compresses very well.+ .+ This package includes the QuickLZ 1.5.0 source code, with compression level 1 and streaming+ currently disabled.+ .+ The versioning scheme for this package is unusual. QuickLZ tries to be as fast as possible,+ and will break backwards compatibility to achieve it in newer versions. This versioning scheme+ reflects the QuickLZ versioning scheme: the first three digits of version w.x.y.z are+ the quicklz version, with the 'z' component (and any further needed ones) being updates to this package,+ not quicklz.+homepage: http://github.com/thoughtpolice/hs-quicklz+bug-reports: https://github.com/thoughtpolice/hs-quicklz/issues+license: GPL-2+license-file: LICENSE+author: Austin Seipp+maintainer: as@hacks.yi.org+category: Codec+build-type: Simple+cabal-version: >=1.10++extra-source-files:+ cbits/quicklz.h, cbits/quicklz.c,+ tests/ex1.hs, tests/Properties.hs,+ README.md++source-repository head+ type: git+ location: https://github.com/thoughtpolice/hs-quicklz.git++flag memory-safe+ description: enable quickLZ memory safety checks+ default: False++library+ exposed-modules: Codec.Compression.QuickLZ + build-depends: + base >= 3 && < 5,+ bytestring == 0.9.*++ c-sources: cbits/quicklz.c+ include-dirs: cbits++ ghc-options: -Wall -O2 -fwarn-tabs+ if flag(memory-safe)+ cpp-options: -DDEBUG+ default-language: Haskell98+ +test-suite properties+ hs-source-dirs: tests+ main-is: Properties.hs+ type: exitcode-stdio-1.0++ build-depends:+ base,+ bytestring == 0.9.*,+ QuickCheck == 2.4.*,+ test-framework == 0.4.*,+ test-framework-quickcheck2 == 0.2.*,+ quicklz++ ghc-options: -fno-cse+ default-language: Haskell98
tests/Properties.hs view
@@ -1,31 +1,31 @@-{-# LANGUAGE ViewPatterns #-} -module Main (main) where - -import qualified Data.ByteString as S -import Codec.Compression.QuickLZ - -import Test.Framework (defaultMain, testGroup) -import Test.Framework.Providers.QuickCheck2 (testProperty) - -main :: IO () -main = defaultMain [ testGroup "simple" [ - testProperty "compression identity" prop_compression_id - , testProperty "decompress is pure" prop_decompress_pure - , testProperty "compress is pure" prop_compress_pure - , testProperty "overlapping is correct" prop_overlap_id - ] - ] - -prop_compression_id (S.pack -> xs) = - xs == (decompress . compress) xs - -prop_decompress_pure (S.pack -> xs) = - let z = compress xs - in (decompress z) == (decompress z) - -prop_compress_pure (S.pack -> xs) = - (compress xs) == (compress xs) - -prop_overlap_id (S.pack -> xs) = - let z = compress xs - in (decompress z) == (decompress' z) +{-# LANGUAGE ViewPatterns #-}+module Main (main) where++import qualified Data.ByteString as S+import Codec.Compression.QuickLZ++import Test.Framework (defaultMain, testGroup)+import Test.Framework.Providers.QuickCheck2 (testProperty)++main :: IO ()+main = defaultMain [ testGroup "simple" [+ testProperty "compression identity" prop_compression_id+ , testProperty "decompress is pure" prop_decompress_pure+ , testProperty "compress is pure" prop_compress_pure+ , testProperty "overlapping is correct" prop_overlap_id+ ]+ ]++prop_compression_id (S.pack -> xs) =+ xs == (decompress . compress) xs++prop_decompress_pure (S.pack -> xs) =+ let z = compress xs+ in (decompress z) == (decompress z)++prop_compress_pure (S.pack -> xs) =+ (compress xs) == (compress xs)++prop_overlap_id (S.pack -> xs) =+ let z = compress xs+ in (decompress z) == (decompress' z)
tests/ex1.hs view
@@ -1,21 +1,21 @@-{-# LANGUAGE OverloadedStrings #-} -module Main where - -import Data.ByteString (ByteString) -import qualified Data.ByteString.Char8 as B -import Codec.Compression.QuickLZ - -main :: IO () -main = do - let xs = "LZ compression is based on finding repeated strings: Five, six, seven, eight, nine, fifteen, sixteen, seventeen, fifteen, sixteen, seventeen." :: ByteString - - putStrLn $ "length of original string: " ++ (show $ B.length xs) - - let ys = compress xs - - putStrLn $ "length of compressed string: " ++ (show $ B.length ys) - - let zs = decompress ys - - putStr $ "decompressed back to " ++ (show $ B.length zs) ++ " bytes, got: " +{-# LANGUAGE OverloadedStrings #-}+module Main where++import Data.ByteString (ByteString)+import qualified Data.ByteString.Char8 as B+import Codec.Compression.QuickLZ++main :: IO ()+main = do+ let xs = "LZ compression is based on finding repeated strings: Five, six, seven, eight, nine, fifteen, sixteen, seventeen, fifteen, sixteen, seventeen." :: ByteString++ putStrLn $ "length of original string: " ++ (show $ B.length xs)++ let ys = compress xs++ putStrLn $ "length of compressed string: " ++ (show $ B.length ys)++ let zs = decompress ys++ putStr $ "decompressed back to " ++ (show $ B.length zs) ++ " bytes, got: " B.putStrLn zs