AttributesTools.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1

#ifndef BPP_UTILS_ATTRIBUTESTOOLS_H
#define BPP_UTILS_ATTRIBUTESTOOLS_H


#include "../Exceptions.h"

// From the STL:
#include <cstdlib>
#include <map>
#include <string>
#include <vector>

namespace bpp
{
class AttributesTools
{
private:
  /*
   * vector of param names already seen, to avoid infinite recursion
   *
   */

  static std::vector<std::string> vParam_;

public:
  AttributesTools() {}
  virtual ~AttributesTools() {}

  static std::vector<std::string> getVector(int argc, char* argv[]);

  static std::map<std::string, std::string> getAttributesMap(
      const std::vector<std::string>& argv,
      const std::string& delimiter = "=");

  static void getAttributesMap(
      const std::vector<std::string>& argv,
      std::map<std::string, std::string>& am,
      const std::string& delimiter = "=");

  static std::map<std::string, std::string> getAttributesMapFromFile(
      const std::string& file,
      const std::string& delimiter);

  static void getAttributesMapFromFile(
      const std::string& file,
      std::map<std::string, std::string>& params,
      const std::string& delimiter);

  static void actualizeAttributesMap(
      std::map<std::string, std::string>& attMap,
      const std::map<std::string, std::string>& atts,
      bool replace = true);

  static void resolveVariables(std::map<std::string, std::string>& am,
      char varCode = '$',
      char varBeg = '(',
      char varEnd = ')');

  static std::map<std::string, std::string> parseOptions(int args, char** argv);

private:
  static std::string removeComments(const std::string& s, const std::string& begin, const std::string& end);
};
} // end of namespace bpp.
#endif // BPP_UTILS_ATTRIBUTESTOOLS_H