Teuchos_ParameterEntryValidator.hpp

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER


#ifndef TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H
#define TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H

#include "Teuchos_RCP.hpp"
#include "Teuchos_Array.hpp"
#include "Teuchos_XMLObject.hpp"
#include "Teuchos_Describable.hpp"

namespace Teuchos {


#ifndef DOXYGEN_SHOULD_SKIP_THIS
class ParameterEntry;
#endif

class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ParameterEntryValidator : public Describable
{
public:


  typedef unsigned int ValidatorID;

  typedef RCP<const Array<std::string> > ValidStringsList;


  ParameterEntryValidator() {}

  virtual const std::string getXMLTypeName() const=0;

  virtual void printDoc(
    std::string const& docString,
    std::ostream &out
    ) const = 0;

  virtual ValidStringsList validStringValues() const = 0;

  virtual void validate(
    ParameterEntry  const& entry,
    std::string const& paramName,
    std::string const& sublistName
    ) const = 0;

  virtual void validateAndModify(
    std::string const& paramName,
    std::string const& sublistName,
    ParameterEntry * entry
    ) const
    {
      TEUCHOS_TEST_FOR_EXCEPT(0==entry);
      this->validate(*entry,paramName,sublistName);
    }

  double convertStringToDouble(std::string str) const
  {
    #ifdef HAVE_TEUCHOSCORE_CXX11
      size_t idx = 0;
      double result = std::stod(str, &idx); // can throw std::invalid_argument
      if(idx != str.length()) { // check for extra bad format characters
        throw std::invalid_argument( "String: '" + str + "' had bad formatting for converting to a double." );
      }
      return result;
    #else
      return std::atof(str.c_str());
    #endif
  }

  int convertStringToInt(std::string str) const
  {
    #ifdef HAVE_TEUCHOSCORE_CXX11
      size_t idx = 0;
      int result = std::stoi(str, &idx); // can throw std::invalid_argument
      if(idx != str.length()) { // check for extra bad format characters
        throw std::invalid_argument( "String: '" + str + "' had bad formatting for converting to an int." );
      }
      return result;
    #else
      return std::atoi(str.c_str());
    #endif
  }

  int convertStringToLongLong(std::string str) const
  {
    size_t idx = 0;
    long long result = std::stoll(str, &idx); // can throw std::invalid_argument
    if(idx != str.length()) { // check for extra bad format characters
      throw std::invalid_argument( "String: '" + str + "' had bad formatting for converting to a long long." );
    }
    return result;
  }

};


} // namespace Teuchos


#endif // TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H