Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
139 #include "Teuchos_ParameterList.hpp"
141 #include "Teuchos_RCP.hpp"
142 #include "Teuchos_PtrDecl.hpp"
144 #ifdef HAVE_TEUCHOSPARAMETERLIST_YAMLCPP
145 #include "yaml-cpp/yaml.h"
146 #endif // HAVE_TEUCHOSPARAMETERLIST_YAMLCPP
147 
148 #include <iostream>
149 #include <string>
150 
151 namespace Teuchos
152 {
153 
154 #ifdef HAVE_TEUCHOSPARAMETERLIST_YAMLCPP
155 #define MAKE_EXCEPTION_TYPE(Name) \
156 class Name : public Teuchos::ExceptionBase \
157 { \
158  public: \
159  Name(const std::string& arg) : ExceptionBase(arg) {} \
160 };
161 
162 MAKE_EXCEPTION_TYPE(YamlKeyError)
163 MAKE_EXCEPTION_TYPE(YamlSequenceError)
164 MAKE_EXCEPTION_TYPE(YamlStructureError)
165 MAKE_EXCEPTION_TYPE(YamlUndefinedNodeError)
166 
167 #undef MAKE_EXCEPTION_TYPE
168 #endif // HAVE_TEUCHOSPARAMETERLIST_YAMLCPP
169 
170 std::string convertXmlToYaml(const std::string& xmlFileName); //returns filename of produced YAML file
171 void convertXmlToYaml(const std::string& xmlFileName, const std::string& yamlFileName); //writes to given filename
172 void convertXmlToYaml(std::istream& xmlStream, std::ostream& yamlStream);
173 
174 //Functions modeled after Teuchos::XMLParameterListReader
175 namespace YAMLParameterList
176 {
177  Teuchos::RCP<Teuchos::ParameterList> parseYamlText(const std::string& text,
178  const std::string& name);
179  Teuchos::RCP<Teuchos::ParameterList> parseYamlFile(const std::string& yamlFile);
180  Teuchos::RCP<Teuchos::ParameterList> parseYamlStream(std::istream& yaml);
181  void writeYamlStream(std::ostream& yamlFile, const Teuchos::ParameterList& pl);
182  void writeYamlFile(const std::string& yamlFile, const Teuchos::ParameterList& pl);
183 
184  #ifdef HAVE_TEUCHOSPARAMETERLIST_YAMLCPP
185  Teuchos::RCP<Teuchos::ParameterList> readParams(std::vector<::YAML::Node>& lists);
186  void processMapNode(const ::YAML::Node& node, Teuchos::ParameterList& parent, bool topLevel = false);
187  void processKeyValueNode(const std::string& key, const ::YAML::Node& node, Teuchos::ParameterList& parent, bool topLevel = false);
188  #endif // HAVE_TEUCHOSPARAMETERLIST_YAMLCPP
189 
190  void writeParameterList(const Teuchos::ParameterList& pl, std::ostream& yaml, int indentLevel);
191  void writeParameter(const std::string& paramName, const Teuchos::ParameterEntry& entry, std::ostream& yaml, int indentLevel); //throws if the entry's type is not supported
192  void generalWriteString(const std::string& str, std::ostream& yaml);
193  void generalWriteDouble(double d, std::ostream& yaml);
194  bool stringNeedsQuotes(const std::string& str);
196 }
197 
198 } //namespace
199 
200 #endif
Object held as the &quot;value&quot; in the Teuchos::ParameterList std::map.
C++ Standard Library compatable filtered iterator.
This object is held as the &quot;value&quot; in the Teuchos::ParameterList std::map.
Templated Parameter List class.
A list of parameters of arbitrary type.
Definition of XMLInputSource derived class for reading XML from a file.
Reference-counted pointer class and non-member templated function implementations.