Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Teuchos_YamlParser_decl.hpp
Go to the documentation of this file.
1// @HEADER
2//
3// ***********************************************************************
4//
5// Teuchos: Common Tools Package
6// Copyright (2004) Sandia Corporation
7//
8// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9// the U.S. Government retains certain rights in this software.
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17//
18// 2. Redistributions in binary form must reproduce the above copyright
19// notice, this list of conditions and the following disclaimer in the
20// documentation and/or other materials provided with the distribution.
21//
22// 3. Neither the name of the Corporation nor the names of the
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Questions? Contact
39// Jonathan Hu (jhu@sandia.gov)
40// Andrey Prokopenko (aprokop@sandia.gov)
41// Ray Tuminaro (rstumin@sandia.gov)
42//
43// ***********************************************************************
44//
45// @HEADER
46
47#ifndef TEUCHOS_YAMLPARSER_DECL_H_
48#define TEUCHOS_YAMLPARSER_DECL_H_
49
140#include "Teuchos_RCP.hpp"
141#include "Teuchos_PtrDecl.hpp"
143
144#include <iostream>
145#include <string>
146
147namespace Teuchos
148{
149
150std::string convertXmlToYaml(const std::string& xmlFileName); //returns filename of produced YAML file
151void convertXmlToYaml(const std::string& xmlFileName, const std::string& yamlFileName); //writes to given filename
152void convertXmlToYaml(std::istream& xmlStream, std::ostream& yamlStream);
153
154//Functions modeled after Teuchos::XMLParameterListReader
155namespace YAMLParameterList
156{
158 const std::string& name);
159 Teuchos::RCP<Teuchos::ParameterList> parseYamlFile(const std::string& yamlFile);
161 void writeYamlStream(std::ostream& yamlFile, const Teuchos::ParameterList& pl);
162 void writeYamlFile(const std::string& yamlFile, const Teuchos::ParameterList& pl);
163 void writeParameterList(const Teuchos::ParameterList& pl, std::ostream& yaml, int indentLevel);
164 void writeParameter(const std::string& paramName, const Teuchos::ParameterEntry& entry, std::ostream& yaml, int indentLevel); //throws if the entry's type is not supported
165 void generalWriteString(const std::string& str, std::ostream& yaml);
166 void generalWriteDouble(double d, std::ostream& yaml);
167 bool stringNeedsQuotes(const std::string& str);
169}
170
171} //namespace
172
173#endif
Definition of XMLInputSource derived class for reading XML from a file.
Object held as the "value" in the Teuchos::ParameterList std::map.
Templated Parameter List class.
Reference-counted pointer class and non-member templated function implementations.
This object is held as the "value" in the Teuchos::ParameterList std::map.
A list of parameters of arbitrary type.
Concrete serial communicator subclass.
void generalWriteDouble(double d, std::ostream &yaml)
Teuchos::RCP< Teuchos::ParameterList > parseYamlFile(const std::string &yamlFile)
void writeParameterList(const Teuchos::ParameterList &pl, std::ostream &yaml, int indentLevel)
bool stringNeedsQuotes(const std::string &s)
void writeYamlStream(std::ostream &yaml, const Teuchos::ParameterList &pl)
Teuchos::RCP< Teuchos::ParameterList > parseYamlStream(std::istream &yaml)
void writeParameter(const std::string &paramName, const Teuchos::ParameterEntry &entry, std::ostream &yaml, int indentLevel)
Teuchos::RCP< Teuchos::ParameterList > parseYamlText(const std::string &text, const std::string &name)
void generalWriteString(const std::string &str, std::ostream &yaml)
void writeYamlFile(const std::string &yamlFile, const Teuchos::ParameterList &pl)
Teuchos::ParameterList::ConstIterator PLIter
std::string convertXmlToYaml(const std::string &xmlFileName)