ckfactory.hpp

Go to the documentation of this file.

/*
 * libxcks
 * Copyright (C) 2022 Julien Couot
 *
 * 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/>.
 */
 
#ifndef INC_CKFACTORY_HPP_BD675BE3_CCFF_4396_B7D2_C9BBC2529A71
#define INC_CKFACTORY_HPP_BD675BE3_CCFF_4396_B7D2_C9BBC2529A71
 
//---------------------------------------------------------------------------
#include <map>
 
#include "libxcks/checksum.hpp"
#include "libxcks/ckvalue.hpp"
//---------------------------------------------------------------------------
 
 
namespace libxcks
{
class LIBXCKS_SO_EXPORT ChecksumFactory final
{
 private:
  // Represents an entry of the checksum or hash algorithms that the application
  // knows.
  class ChecksumEntry;
 
  using ChecksumEntries = std::map<ChecksumAlgoId, ChecksumEntry>;
 
  static ChecksumEntries checksumAlgorithms;  
 
  ChecksumFactory() {}
 
 public:
  ChecksumFactory(const ChecksumFactory&) = delete;
 
  ChecksumFactory& operator=(const ChecksumFactory&) = delete;
 
  // Initializes the static members of the class.
  static void initialise();
 
  // Cleans-up the static members of the class.
  static void cleanUp();
 
  // Gives a pointer on a new instance of the specified checksum or hash identifier.
  static Checksum* getNewInstance(const ChecksumAlgoId id);
 
  // Gives a pointer on a new instance of the specified checksum or hash name.
  static Checksum* getNewInstance(const std::string& name, const bool lookInAltNames = true);
 
  // Gives a null value of the specified checksum or hash identifier.
  static ChecksumValue getNullValue(const ChecksumAlgoId id);
 
  // Gives a null value of the specified checksum or hash name.
  static ChecksumValue getNullValue(const std::string& name, const bool lookInAltNames = true);
 
  // Gets the size in bytes of the specified checksum or hash identifier.
  static size_t getSize(const ChecksumAlgoId id);
 
  // Gets the size in bytes of the specified checksum or hash name.
  static size_t getSize(const std::string& name, const bool lookInAltNames = true);
 
  // Returns true if the given identifier of the checksum or hash algorithm exists.
  static bool exists(const ChecksumAlgoId id);
 
  // Returns true if the given name of the checksum or hash algorithm exists.
  static bool exists(const std::string& name, const bool lookInAltNames = true);
 
  // Returns true if the given name of the checksum or hash algorithm exists.
  static bool existsNoCase(const std::string& name, const bool lookInAltNames = true);
 
  // Returns all the identifiers of the available checksum or hash algorithms.
  static ArrayChecksumAlgoId getAlgorithmsIds();
 
  // Returns all the names of the available checksum or hash algorithms.
  static ArrayString getAlgorithmsNames();
 
  // Returns the number of available checksum or hash algorithms.
  static int getAlgorithmsCount();
 
  // Gets the identifier of a checksum or hash algorithm from its name.
  static bool getAlgorithmId(ChecksumAlgoId& id, const std::string& name, const bool lookInAltNames = true);
 
  // Gets the identifier of a checksum or hash algorithm from its name.
  static bool getAlgorithmIdNoCase(ChecksumAlgoId& id, const std::string& name, const bool lookInAltNames = true);
 
  // Gets the name of a checksum or hash algorithm from its identifier.
  static bool getAlgorithmName(std::string& name, const ChecksumAlgoId id);
 
  // Gets the name of a checksum or hash algorithm from one of its alternatives names.
  static bool getAlgorithmName(std::string& name, const std::string& altName);
 
  // Gets the alternatives names of a checksum or hash algorithm from its identifier.
  static bool getAlgorithmAltNames(ArrayString& altNames, const ChecksumAlgoId id, const bool giveName = false);
 
  // Gets the alternatives names of a checksum or hash algorithm from its name or one of its alternative names.
  static bool getAlgorithmAltNames(ArrayString& altNames, const std::string& name, const bool nameCouldBeAlt = true, const bool giveName = false);
 
  // Returns the description of a checksum or hash algorithm from its identifier.
  static std::string getAlgorithmDescription(const ChecksumAlgoId id);
 
  // Returns the description of a checksum or hash algorithm from its name.
  static std::string getAlgorithmDescription(const std::string& name, const bool lookInAltNames = true);
};
//---------------------------------------------------------------------------
}  // namespace libxcks
//---------------------------------------------------------------------------
 
#endif  // INC_CKFACTORY_HPP_BD675BE3_CCFF_4396_B7D2_C9BBC2529A71