Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
ParameterList_XMLDuplicateSublists.cpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
47 #include <fstream>
48 #include <string>
49 
50 std::string filename;
51 
52 namespace Teuchos {
53 
55  {
57  "filename", &filename, "XML file to parse" );
58  }
59 
60  TEUCHOS_UNIT_TEST( ParameterList, ExistingSublistIsOkay )
61  {
62  std::string xmlstring(
63  "<ParameterList> \n"
64  " <ParameterList name=\"SubList\">\n"
65  " </ParameterList> \n"
66  "</ParameterList> \n");
67  RCP<ParameterList> plist = getParametersFromXmlString(xmlstring);
68  updateParametersFromXmlString( xmlstring, plist() );
69  }
70 
71  TEUCHOS_UNIT_TEST( ParameterList, XMLDuplicatedSublists )
72  {
73  ParameterList pl;
74  TEST_THROW( updateParametersFromXmlFile(filename, inOutArg(pl) ), DuplicateParameterSublist );
75  TEST_THROW( getParametersFromXmlFile(filename), DuplicateParameterSublist );
76  TEST_THROW( getParametersFromXmlFile(filename,null), DuplicateParameterSublist );
77  //
78  std::ifstream fin(filename.c_str());
79  std::string xmlstring( (std::istreambuf_iterator<char>(fin)),
80  std::istreambuf_iterator<char>() );
81  TEST_THROW( updateParametersFromXmlString(xmlstring,inOutArg(pl) ), DuplicateParameterSublist );
82  TEST_THROW( getParametersFromXmlString(xmlstring), DuplicateParameterSublist );
83  TEST_THROW( getParametersFromXmlString(xmlstring,null), DuplicateParameterSublist );
84  }
85 
86  TEUCHOS_UNIT_TEST( XMLParameterListReader, XMLDuplicatedSublistsThrowsError )
87  {
88  FileInputSource xmlFile(filename);
89  XMLObject xmlParams = xmlFile.getObject();
90  XMLParameterListReader xmlPLReader;
91  TEST_EQUALITY_CONST( xmlPLReader.getAllowsDuplicateSublists(), true );
92  out << "Changing policy to disallow duplicate sublists" << std::endl;
93  xmlPLReader.setAllowsDuplicateSublists( false );
94  TEST_EQUALITY_CONST( xmlPLReader.getAllowsDuplicateSublists(), false );
95  TEST_THROW( xmlPLReader.toParameterList(xmlParams), DuplicateParameterSublist );
96  }
97 
98  TEUCHOS_UNIT_TEST( XMLParameterListReader, XMLDuplicatedSublistsBackwardsCompatible )
99  {
100  FileInputSource xmlFile(filename);
101  XMLObject xmlParams = xmlFile.getObject();
102  XMLParameterListReader xmlPLReader;
103  TEST_EQUALITY_CONST( xmlPLReader.getAllowsDuplicateSublists(), true );
104  TEST_NOTHROW( xmlPLReader.toParameterList(xmlParams) );
105  }
106 
107 } // namespace Teuchos
Definition of XMLInputSource derived class for reading XML from a file.
#define TEST_EQUALITY_CONST(v1, v2)
Assert the equality of v1 and constant v2.
#define TEST_NOTHROW(code)
Asserr that the statement 'code' does not thrown any excpetions.
#define TEST_THROW(code, ExceptType)
Assert that the statement 'code' throws the exception 'ExceptType' (otherwise the test fails).
Templated Parameter List class.
Unit testing support.
Simple helper functions that make it easy to read and write XML to and from a parameterlist.
Writes an XML object to a parameter list.
void setOption(const char option_true[], const char option_false[], bool *option_val, const char documentation[]=NULL)
Set a boolean option.
Optionally thrown when a sublist is set twice by either updateParametersFromXmlFile(),...
Instantiation of XMLInputSource class for reading XML from a file.
A list of parameters of arbitrary type.
Smart reference counting pointer class for automatic garbage collection.
static CommandLineProcessor & getCLP()
Return the CLP to add options to.
XMLObject getObject() const
Get an object by invoking the TreeBuildingXMLHandler on the input data.
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object,...
Writes an XML object to a parameter list.
bool getAllowsDuplicateSublists() const
Specifies the current policy regarding duplicated sublists. See setAllowsDuplicateSublists() for more...
void setAllowsDuplicateSublists(bool policy)
Set policy regarding duplicated sublists.
RCP< ParameterList > toParameterList(const XMLObject &xml, RCP< DependencySheet > depSheet) const
TEUCHOS_UNIT_TEST(ConstNonconstObjectContainer, create)