1 #ifndef OSMIUM_OSM_CRC_ZLIB_HPP
2 #define OSMIUM_OSM_CRC_ZLIB_HPP
3 
4 /*
5 
6 This file is part of Osmium (https://osmcode.org/libosmium).
7 
8 Copyright 2013-2021 Jochen Topf <jochen@topf.org> and others (see README).
9 
10 Boost Software License - Version 1.0 - August 17th, 2003
11 
12 Permission is hereby granted, free of charge, to any person or organization
13 obtaining a copy of the software and accompanying documentation covered by
14 this license (the "Software") to use, reproduce, display, distribute,
15 execute, and transmit the Software, and to prepare derivative works of the
16 Software, and to permit third-parties to whom the Software is furnished to
17 do so, all subject to the following:
18 
19 The copyright notices in the Software and this entire statement, including
20 the above license grant, this restriction and the following disclaimer,
21 must be included in all copies of the Software, in whole or in part, and
22 all derivative works of the Software, unless such copies or derivative
23 works are solely in the form of machine-executable object code generated by
24 a source language processor.
25 
26 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28 FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
29 SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
30 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
31 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
32 DEALINGS IN THE SOFTWARE.
33 
34 */
35 
36 #include <zlib.h>
37 
38 #include <cstddef>
39 
40 namespace osmium {
41 
42     /**
43      * This class is used together with the CRC class to implement a CRC32
44      * checksum based on the implementation from zlib.
45      *
46      * Usage:
47      *
48      * @code
49      * osmium::CRC<osmium::CRC_zlib> crc32;
50      * const osmium::Node& node = ...;
51      * crc32.update(node);
52      * std::cout << crc32.checksum() << '\n';
53      * @endcode
54      */
55     class CRC_zlib {
56 
57         unsigned long m_crc32 = ::crc32(0, nullptr, 0); // NOLINT(google-runtime-int)
58 
59     public:
60 
process_byte(const unsigned char byte)61         void process_byte(const unsigned char byte) noexcept {
62             m_crc32 = ::crc32(m_crc32, &byte, 1U);
63         }
64 
process_bytes(const void * buffer,std::size_t byte_count)65         void process_bytes(const void* buffer, std::size_t byte_count) noexcept {
66             m_crc32 = ::crc32(m_crc32, reinterpret_cast<const unsigned char*>(buffer), static_cast<unsigned int>(byte_count));
67         }
68 
checksum() const69         unsigned long checksum() const noexcept { // NOLINT(google-runtime-int)
70             return m_crc32;
71         }
72 
73     }; // class CRC_zlib
74 
75 } // namespace osmium
76 
77 #endif // OSMIUM_OSM_CRC_ZLIB_HPP
78