libxcks Documentation

Description

libxcks is a C++17 library that:

• computes and verifies checksums.
• reads and writes XCKS and ZXCKS checksums' files.

This documentation is for programmers only.

XCKS and ZXCKS checksums' files have a specification.

Overview

Attention

All inputted and outputted strings (std::string) of the public interface of libxcks must be UTF-8 encoded. It will never reminded in the rest of the documentation.

libxcks provides:

• Checksums algorithms (see libxcks::Checksum, libxcks::ChecksumFactory, libxcks::ChecksumValue and libxcks::ChecksumFormatter).
• XCKS and ZXCKS checksums' files reader (see libxcks::XCKSReader, libxcks::ZXCKSReader and its handlers libxcks::XCKSReaderHandler and libxcks::XCKSReaderDefaultHandler).
• XCKS and ZXCKS checksums' files writer (see libxcks::XCKSWriter, libxcks::ZXCKSWriter, its handlers libxcks::XCKSWriterChecksumProvider, libxcks::XCKSWriterDefaultHandler, its configurations libxcks::XCKSWriterOptions and libxcks::ZXCKSWriterOptions, and finally its checksums' provider libxcks::XCKSWriterChecksumProvider).
• Version of specification of (Z)XCKS handling (xcksver.hpp).
• Version of libxcks (version.hpp).

Before using libxcks, an instance of LibXCKSInitialiser must be created and alive while you use libxcks functionalities.

libxcks depends on:

• Expat for parsing XML structure of XCKS files.
• UTF8-CPP for handling Unicode encoded strings.
• Boost.Iostreams for handling Gzip streams for ZXCKS checksums' files.
• Boost.Locale for translating messages.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/.