libxcks  0.1.0.1
xcksver.hpp
Go to the documentation of this file.
1 /*
2  * libxcks
3  * Copyright (C) 2022 Julien Couot
4  *
5  * This program is free software: you can redistribute it and/or modify it
6  * under the terms of the GNU Lesser General Public License as published by
7  * the Free Software Foundation, either version 3 of the License, or (at your
8  * option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
13  * License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with this program. If not, see <https://www.gnu.org/licenses/>.
17  */
18 
25 #ifndef INC_XCKSVER_HPP_5D6E6250_2DDC_4506_A6EB_B4D3E1F949E5
26 #define INC_XCKSVER_HPP_5D6E6250_2DDC_4506_A6EB_B4D3E1F949E5
27 
28 //---------------------------------------------------------------------------
29 // #include <string> // Included in "libxcks/types.hpp"
30 
31 #include "libxcks/export.hpp"
32 #include "types.hpp"
33 //---------------------------------------------------------------------------
34 
35 
36 namespace libxcks
37 {
49 LIBXCKS_SO_EXPORT const StringSet getAvailableAlgorithmNames(const Version version);
50 
62 LIBXCKS_SO_EXPORT const ArrayString getAvailableAlgorithmNamesAsArray(const Version version);
63 
71 LIBXCKS_SO_EXPORT const ArrayChecksumAlgoId getAvailableAlgorithmIds(const Version version);
72 //---------------------------------------------------------------------------
73 
74 
82 LIBXCKS_SO_EXPORT const std::string getXCKSVersionName(const Version version);
83 
84 } // namespace libxcks
85 //---------------------------------------------------------------------------
86 
87 #endif // INC_XCKSVER_HPP_5D6E6250_2DDC_4506_A6EB_B4D3E1F949E5
OS dependent exports defines.
Common types for libxcks.
std::vector< ChecksumAlgoId > ArrayChecksumAlgoId
Array of ids of algorithms of checksums.
Definition: types.hpp:92
std::vector< std::string > ArrayString
Array of strings.
Definition: types.hpp:44
std::set< std::string > StringSet
Set of strings.
Definition: types.hpp:39
LIBXCKS_SO_EXPORT const StringSet getAvailableAlgorithmNames(const Version version)
Gets the available names of algorithm for a version of (Z)XCKS file.
Definition: xcksver.cpp:41
LIBXCKS_SO_EXPORT const ArrayChecksumAlgoId getAvailableAlgorithmIds(const Version version)
Gets the available ids of algorithm for a version of (Z)XCKS file.
Definition: xcksver.cpp:69
LIBXCKS_SO_EXPORT const ArrayString getAvailableAlgorithmNamesAsArray(const Version version)
Gets the available names of algorithm for a version of (Z)XCKS file.
Definition: xcksver.cpp:57
LIBXCKS_SO_EXPORT const std::string getXCKSVersionName(const Version version)
Gets the name of an (Z)XCKS file version.
Definition: xcksver.cpp:90