Teuchos_ValidatorXMLConverterDB.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TEUCHOS_VALIDATORXMLCONVERTERDB_HPP
#define TEUCHOS_VALIDATORXMLCONVERTERDB_HPP

#include "Teuchos_ValidatorXMLConverter.hpp"


namespace Teuchos {

class ParameterEntryValidator;

class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ValidatorXMLConverterDB {
public:


  static void addConverter(RCP<const ParameterEntryValidator> validator,
    RCP<ValidatorXMLConverter> converterToAdd);



  static RCP<const ValidatorXMLConverter> getConverter(
    const ParameterEntryValidator& validator);

  static RCP<const ValidatorXMLConverter>
    getConverter(const XMLObject& xmlObject);

  static XMLObject convertValidator(
    RCP<const ParameterEntryValidator> validator,
    const ValidatortoIDMap& validatorIDsMap,
    bool assignedID=true);

  static RCP<ParameterEntryValidator>
    convertXML(
      const XMLObject& xmlObject,
      const IDtoValidatorMap& validatorIDsMap);



  static void printKnownConverters(std::ostream& out);


private:


  typedef std::map<std::string, RCP<ValidatorXMLConverter> > ConverterMap;

  typedef std::pair<std::string, RCP<ValidatorXMLConverter> > ConverterPair;



  static ConverterMap& getConverterMap();



};


} // end namespace Teuchos


//
// Helper Macros
//

// Doing this include so that when people macros like
// TEUCHOS_ADD_STRINGTOINTEGRALCONVERTER below they don't have to bother
// including it themselves. More likely they might not even know they have
// to.
#include "Teuchos_StandardValidatorXMLConverters.hpp"

#define TEUCHOS_ADD_STRINGTOINTEGRALVALIDATOR_CONVERTER(INTEGRALTYPE) \
  \
  Teuchos::ValidatorXMLConverterDB::addConverter( \
    Teuchos::DummyObjectGetter< \
      Teuchos::StringToIntegralParameterEntryValidator< INTEGRALTYPE > >:: \
        getDummyObject(), \
    Teuchos::rcp(new Teuchos::StringToIntegralValidatorXMLConverter< INTEGRALTYPE >));



#define TEUCHOS_ADD_ENHANCEDNUMBERVALIDATOR_CONVERTER(T) \
  \
  Teuchos::ValidatorXMLConverterDB::addConverter( \
    Teuchos::DummyObjectGetter< \
      Teuchos::EnhancedNumberValidator< T > >:: \
        getDummyObject(), \
    Teuchos::rcp(new Teuchos::EnhancedNumberValidatorXMLConverter< T >));


#define TEUCHOS_ADD_ARRAYVALIDATOR_CONVERTER(VALIDATORTYPE, ENTRYTYPE) \
  \
  Teuchos::ValidatorXMLConverterDB::addConverter( \
    Teuchos::DummyObjectGetter< \
      Teuchos::ArrayValidator< VALIDATORTYPE, ENTRYTYPE > >:: \
        getDummyObject(), \
    Teuchos::rcp(new Teuchos::ArrayValidatorXMLConverter< VALIDATORTYPE, ENTRYTYPE >)); \
  Teuchos::ValidatorXMLConverterDB::addConverter( \
    Teuchos::DummyObjectGetter< \
      Teuchos::TwoDArrayValidator< VALIDATORTYPE, ENTRYTYPE > >:: \
        getDummyObject(), \
    Teuchos::rcp(new Teuchos::TwoDArrayValidatorXMLConverter< VALIDATORTYPE, ENTRYTYPE >));


#define TEUCHOS_ADD_NUMBERTYPE_VALIDATOR_CONVERTERS(T) \
  TEUCHOS_ADD_STRINGTOINTEGRALVALIDATOR_CONVERTER(T); \
  TEUCHOS_ADD_ENHANCEDNUMBERVALIDATOR_CONVERTER(T); \
  TEUCHOS_ADD_ARRAYVALIDATOR_CONVERTER(Teuchos::EnhancedNumberValidator< T >, T );

#define TEUCHOS_ADD_VALIDATOR_CONVERTER(VALIDATOR_TYPE, CONVERTER_TYPE) \
  Teuchos::ValidatorXMLConverterDB::addConverter( \
      Teuchos::DummyObjectGetter< VALIDATOR_TYPE > \
      ::getDummyObject(), \
      Teuchos::rcp(new CONVERTER_TYPE ));

#endif // TEUCHOS_VALIDATORXMLCONVERTERDB_HPP