Teuchos_ParameterEntryXMLConverterDB.hpp

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

#ifndef TEUCHOS_PARAMETERENTRYXMLCONVERTERDB_HPP
#define TEUCHOS_PARAMETERENTRYXMLCONVERTERDB_HPP

#include "Teuchos_StandardParameterEntryXMLConverters.hpp"
#include "Teuchos_XMLParameterListExceptions.hpp"
#include "Teuchos_XMLParameterListWriter.hpp"


namespace Teuchos {

class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ParameterEntryXMLConverterDB {
public:


  static void addConverter(RCP<ParameterEntryXMLConverter> converterToAdd){
    getConverterMap().insert(
      ConverterPair(converterToAdd->getTypeAttributeValue(), converterToAdd));
  }




  static RCP<const ParameterEntryXMLConverter>
    getConverter(RCP<const ParameterEntry> entry);

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

  static RCP<const ParameterEntryXMLConverter> getDefaultConverter();


  // 2010/07/30: rabarlt: The above two functions should be moved into
  // Teuchos_ParameterEntryXMLConvergerDB.cpp.  These functions don't need to
  // be inlined and it will be easier to set breakpoints in the debugger if
  // they are in a *.cpp file.


  static XMLObject convertEntry(
    RCP<const ParameterEntry> entry,
    const std::string& name,
    const ParameterEntry::ParameterEntryID& id,
    const ValidatortoIDMap& validatorIDsMap)
  {
    return getConverter(entry)->fromParameterEntrytoXML(
      entry, name, id, validatorIDsMap);
  }

  static ParameterEntry convertXML(const XMLObject& xmlObj)
  {
    return getConverter(xmlObj)->fromXMLtoParameterEntry(xmlObj);
  }



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

private:


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

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


  static ConverterMap& getConverterMap();


};


} // namespace Teuchos

//
// Helper Macros
//


#define TEUCHOS_ADD_TYPE_CONVERTER(T) \
  \
  Teuchos::ParameterEntryXMLConverterDB::addConverter( \
    Teuchos::rcp(new Teuchos::StandardTemplatedParameterConverter< T >));

#define TEUCHOS_ADD_ARRAYTYPE_CONVERTER(T) \
  Teuchos::ParameterEntryXMLConverterDB::addConverter( \
    Teuchos::rcp(new Teuchos::StandardTemplatedParameterConverter< Teuchos::Array< T > >)); \
  Teuchos::ParameterEntryXMLConverterDB::addConverter( \
    Teuchos::rcp(new Teuchos::StandardTemplatedParameterConverter< Teuchos::TwoDArray< T > >));

#define TEUCHOS_ADD_TYPE_AND_ARRAYTYPE_CONVERTER(T) \
  \
  TEUCHOS_ADD_TYPE_CONVERTER(T); \
  TEUCHOS_ADD_ARRAYTYPE_CONVERTER(T);


#endif // TEUCHOS_PARAMETERENTRYXMLCONVERTERDB_HPP