diff --git a/Codec/Compression/Snappy.hs b/Codec/Compression/Snappy.hs --- a/Codec/Compression/Snappy.hs +++ b/Codec/Compression/Snappy.hs @@ -2,15 +2,15 @@ -- | -- Module: Codec.Compression.Snappy --- Copyright: (c) 2011 MailRank, Inc. +-- Copyright: © 2011 MailRank, Inc. -- License: Apache --- Maintainer: Bryan O'Sullivan +-- Maintainer: ARJANEN Loïc Jean David -- Stability: experimental -- Portability: portable -- --- This module provides fast, pure Haskell bindings to Google's +-- This module provides fast, pure Haskell bindings to Google’s -- Snappy compression and decompression library: --- +-- . -- -- These functions operate on strict bytestrings, and thus use as much -- memory as both the entire compressed and uncompressed data. diff --git a/Codec/Compression/Snappy/Internal.hs b/Codec/Compression/Snappy/Internal.hs --- a/Codec/Compression/Snappy/Internal.hs +++ b/Codec/Compression/Snappy/Internal.hs @@ -2,15 +2,15 @@ -- | -- Module: Codec.Compression.Snappy --- Copyright: (c) 2011 MailRank, Inc. +-- Copyright: © 2011 MailRank, Inc. -- License: Apache --- Maintainer: Bryan O'Sullivan +-- Maintainer: ARJANEN Loïc Jean David -- Stability: experimental -- Portability: portable -- --- This module provides fast, pure Haskell bindings to Google's +-- This module provides fast, pure Haskell bindings to Google’s -- Snappy compression and decompression library: --- +-- . -- -- These functions operate on strict bytestrings, and thus use as much -- memory as both the entire compressed and uncompressed data. diff --git a/Codec/Compression/Snappy/Lazy.hsc b/Codec/Compression/Snappy/Lazy.hsc --- a/Codec/Compression/Snappy/Lazy.hsc +++ b/Codec/Compression/Snappy/Lazy.hsc @@ -2,9 +2,9 @@ -- | -- Module: Codec.Compression.Snappy --- Copyright: (c) 2011 MailRank, Inc. +-- Copyright: © 2011 MailRank, Inc. -- License: Apache --- Maintainer: Bryan O'Sullivan +-- Maintainer: ARJANEN Loïc Jean David -- Stability: experimental -- Portability: portable -- @@ -31,11 +31,11 @@ import Codec.Compression.Snappy.Internal (check, maxCompressedLength) import Control.Exception (bracket) -import Data.ByteString.Internal hiding (ByteString) +import Data.ByteString.Internal hiding (ByteString(BS)) import Data.ByteString.Lazy.Internal (ByteString(..)) import Data.Word (Word8, Word32) import Foreign.C.Types (CInt(..), CSize(..)) -import Foreign.ForeignPtr (touchForeignPtr, withForeignPtr) +import Foreign.ForeignPtr (touchForeignPtr, withForeignPtr, newForeignPtr_) import Foreign.Marshal.Alloc (alloca) import Foreign.Marshal.Array (withArray) import Foreign.Marshal.Utils (with) @@ -57,6 +57,13 @@ (#poke struct BS, off) ptr (0::CSize) (#poke struct BS, len) ptr len {-# INLINE poke #-} + peek p = do + pointer <- (#peek struct BS, ptr) p + foreignPointer <- newForeignPtr_ pointer + offset <- (#peek struct BS, off) p + peekedLength <- (#peek struct BS, len) p + return (BS (PS foreignPointer offset peekedLength)) + {-# INLINE peek #-} -- | Compress data into the Snappy format. compress :: ByteString -> ByteString diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,29 +1,201 @@ -Copyright (c) 2011, MailRank Inc. -All rights reserved. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions -are met: + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - * Redistributions of source code must retain the above copyright -notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above -copyright notice, this list of conditions and the following disclaimer -in the documentation and/or other materials provided with the -distribution. - * Neither the name of MailRank Inc. nor the names of its -contributors may be used to endorse or promote products derived -from this software without specific prior written permission. + 1. Definitions. -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS -FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE -COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, -INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, -BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; -LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN -ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE. + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2011 MailRank Inc., 2024 ARJANEN Loïc Jean David + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Welcome to snappy snappy is a fast Haskell library for working with data compressed -using Google's Snappy format. It is implemented as a binding to the -[Snappy library](http://code.google.com/p/snappy/). +using Google’s Snappy format. It is implemented as a binding to the +[Snappy library](http://github.com/google/snappy). It implements zero-copy compression and decompression of both strict -and lazy [bytestring](http://hackage.haskell.org/package/bytestring)s, +and lazy [bytestrings](http://hackage.haskell.org/package/bytestring), the standard Haskell types for managing binary data efficiently. # Join in! @@ -14,20 +14,14 @@ and other improvements. Please report bugs via the -[github issue tracker](http://github.com/bos/snappy/issues). - -Master [git repository](http://github.com/bos/snappy): - -* `git clone git://github.com/bos/snappy.git` - -There's also a [Mercurial mirror](http://bitbucket.org/bos/snappy): +[Framagit issue tracker](http://framagit.org/ljdarj/snappy/-/issues). -* `hg clone http://bitbucket.org/bos/snappy` +Master [git repository](http://framagit.org/ljdarj/snappy): -(You can create and contribute changes using either git or Mercurial.) +* `git clone https://framagit.org/ljdarj/snappy.git` Authors ------- -This library is written and maintained by Bryan O'Sullivan, -. +This library was written by Bryan O'Sullivan () and +is maintained by ARJANEN Loïc Jean David (). diff --git a/cbits/hs_snappy.cpp b/cbits/hs_snappy.cpp --- a/cbits/hs_snappy.cpp +++ b/cbits/hs_snappy.cpp @@ -1,6 +1,6 @@ #include "hs_snappy.h" -#include "snappy.h" -#include "snappy-sinksource.h" +#include +#include using namespace snappy; @@ -28,16 +28,16 @@ return RawUncompress(compressed, compressed_length, uncompressed); } -class BSSource : public Source +class BSSourceImpl : public Source { public: - BSSource(BS *chunks, size_t nchunks, size_t size) + BSSourceImpl(BS *chunks, size_t nchunks, size_t size) : chunks_(chunks), nchunks_(nchunks), size_(size), cur_(chunks), left_(size) { } - size_t Available() const { return left_; } + size_t Available() const override { return left_; } - const char *Peek(size_t *len) { + const char *Peek(size_t *len) override { if (left_ > 0) { *len = cur_->len - cur_->off; return cur_->ptr + cur_->off; @@ -47,7 +47,7 @@ } } - void Skip(size_t n) { + void Skip(size_t n) override { if (n > 0) { left_ -= n; cur_->off += n; @@ -74,7 +74,7 @@ void _hsnappy_CompressChunks(BS *chunks, size_t nchunks, size_t length, char *compressed, size_t *compressed_length) { - BSSource reader(chunks, nchunks, length); + BSSourceImpl reader(chunks, nchunks, length); UncheckedByteArraySink writer(compressed); Compress(&reader, &writer); @@ -82,24 +82,25 @@ *compressed_length = writer.CurrentDestination() - compressed; } -BSSource *_hsnappy_NewSource(BS *chunks, size_t nchunks, size_t length) +struct BSSource *_hsnappy_NewSource(BS *chunks, size_t nchunks, size_t length) { - return new BSSource(chunks, nchunks, length); + return reinterpret_cast(new BSSourceImpl(chunks, nchunks, length)); } -void _hsnappy_DeleteSource(BSSource *src) +void _hsnappy_DeleteSource(struct BSSource *src) { - delete src; + delete reinterpret_cast(src); } -int _hsnappy_UncompressChunks(BSSource *reader, char *uncompressed) +int _hsnappy_UncompressChunks(struct BSSource *reader, char *uncompressed) { - return RawUncompress(reader, uncompressed); + return RawUncompress(reinterpret_cast(reader), uncompressed); } -int _hsnappy_GetUncompressedLengthChunks(BSSource *reader, uint32_t *result) +int _hsnappy_GetUncompressedLengthChunks(struct BSSource *reader, uint32_t *result) { - int n = GetUncompressedLength(reader, result); - reader->Rewind(); + BSSourceImpl* true_reader = reinterpret_cast(reader); + int n = GetUncompressedLength(true_reader, result); + true_reader->Rewind(); return n; } diff --git a/include/hs_snappy.h b/include/hs_snappy.h --- a/include/hs_snappy.h +++ b/include/hs_snappy.h @@ -27,8 +27,6 @@ int _hsnappy_RawUncompress(const char *compressed, size_t compressed_length, char *uncompressed); -struct BS; - void _hsnappy_CompressChunks(struct BS *chunks, size_t count, size_t length, char *compressed, size_t *compressed_length); diff --git a/snappy.cabal b/snappy.cabal --- a/snappy.cabal +++ b/snappy.cabal @@ -1,20 +1,20 @@ +cabal-version: 2.2 name: snappy -version: 0.2.0.2 -homepage: http://github.com/bos/snappy -bug-reports: http://github.com/bos/snappy/issues +version: 0.2.0.3 +homepage: http://framagit.org/ljdarj/snappy +bug-reports: http://framagit.org/ljdarj/snappy/-/issues synopsis: - Bindings to the Google Snappy library for fast compression/decompression + Fast Haskell bindings to Google’s Snappy compression library. description: - This library provides fast, pure Haskell bindings to Google's Snappy - compression and decompression library: -license: BSD3 + This library provides fast, pure Haskell bindings to Google’s Snappy + compression and decompression library: . +license: Apache-2.0 license-file: LICENSE author: Bryan O'Sullivan -maintainer: Bryan O'Sullivan +maintainer: ARJANEN Loïc Jean David copyright: Copyright 2011 MailRank, Inc. category: Codec, Compression build-type: Simple -cabal-version: >= 1.8 extra-source-files: README.md include/hs_snappy.h @@ -23,16 +23,22 @@ tests/Speedy.hs library - c-sources: cbits/hs_snappy.cpp - include-dirs: include - extra-libraries: snappy stdc++ - - cc-options: -Wall - ghc-options: -Wall + cxx-sources: cbits/hs_snappy.cpp + include-dirs: include + extra-libraries: snappy + cxx-options: -Wall -fno-rtti + ghc-options: -Wall + default-language: Haskell2010 build-depends: base < 5, bytestring if impl(ghc >= 6.10) build-depends: base >= 4 + if impl(ghc >= 9.4) + build-depends: system-cxx-std-lib + elif os(linux) + extra-libraries: stdc++ + else + extra-libraries: c++ exposed-modules: Codec.Compression.Snappy @@ -42,9 +48,10 @@ Codec.Compression.Snappy.Internal test-suite tests - type: exitcode-stdio-1.0 - hs-source-dirs: tests - main-is: Properties.hs + type: exitcode-stdio-1.0 + hs-source-dirs: tests + main-is: Properties.hs + default-language: Haskell2010 ghc-options: -Wall -threaded -O0 -rtsopts @@ -54,12 +61,15 @@ build-depends: base < 5, - bytestring, + bytestring >= 0.11, QuickCheck >= 2.4, snappy, test-framework, test-framework-quickcheck2 + other-modules: + Functions + source-repository head type: git - location: http://github.com/bos/snappy + location: https://framagit.org/ljdarj/snappy diff --git a/tests/Functions.hs b/tests/Functions.hs new file mode 100644 --- /dev/null +++ b/tests/Functions.hs @@ -0,0 +1,15 @@ +module Functions + ( + rechunk + ) where + +import qualified Data.ByteString as B +import qualified Data.ByteString.Lazy as L + +rechunk :: Int -> B.ByteString -> L.ByteString +rechunk n + | n <= 0 = error "rechunk: wtf!?" + | otherwise = L.fromChunks . go + where go bs | B.null bs = [] + | otherwise = case B.splitAt n bs of + (x,y) -> x : go y