Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_TreeBuildingXMLHandler.hpp
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
42#ifndef Teuchos_TREEBUILDINGXMLHANDLER_H
43#define Teuchos_TREEBUILDINGXMLHANDLER_H
44
50#include "Teuchos_XMLObject.hpp"
51#include <list>
52#include <stack>
53
54
55namespace Teuchos
56{
57
62 {
64 public:
67
69 const XMLObject& getObject() const
70 {
71 // valid XML requires a root object; we will allow empty XML files
73 root_.isEmpty(), EmptyXMLError
74 ,"Error, An empty XML std::string or file was specified!"
75 " The XML specification requires at minimum the presence"
76 " of a root element!" );
77 return root_.getChild(0);
78 }
79
81 void characters(const std::string& chars);
82
84 int endElement(const std::string& tag);
85
87 void startElement(const std::string& tag,
88 const Map& attributes);
89
90 private:
91 XMLObject root_;
92 XMLObject current_;
93 std::stack<XMLObject> path_;
94 };
95}
96
97
98#endif
99
Teuchos header file which uses auto-configuration information to include necessary C++ headers.
An object representation of a subset of XML data.
Thrown when attempting to parse an empty XML std::string.
Smart reference counting pointer class for automatic garbage collection.
TreeBuildingXMLHandler assembles a XMLObject from your XML input.
void characters(const std::string &chars)
Process character data.
void startElement(const std::string &tag, const Map &attributes)
Receive notification of the start of an element.
const XMLObject & getObject() const
Retrieve the entire XML tree.
int endElement(const std::string &tag)
Receive notification of the end of an element.
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object,...
const XMLObject & getChild(int i) const
Return the i-th child node.
bool isEmpty() const
Find out if a node is empty.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Macro for throwing an exception with breakpointing to ease debugging.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...