XMLDocument.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2012  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_XMLDocument_hxx
#define __ccxx_XMLDocument_hxx

#include <commonc++/Common.h++>
#include <commonc++/String.h++>
#include <commonc++/IOException.h++>
#include <commonc++/InvalidArgumentException.h++>
#include <commonc++/ParseException.h++>

#include <map>
#include <vector>

#include <expat.h>

namespace ccxx {

class XMLElement; // fwd ref

class COMMONCPPXML_API XMLDocument
{
  public:

  XMLDocument(const String& encoding = "us-ascii");

  ~XMLDocument() throw();

  XMLElement & getRoot();

  const XMLElement & getRoot() const;

  XMLElement & setRoot(const String &name) throw(InvalidArgumentException);

  XMLElement & find(const String &path) throw(InvalidArgumentException);

  const XMLElement & find(const String &path) const
    throw(InvalidArgumentException);

  void read(std::istream &stream) throw(ParseException, IOException);

  void read(const String &str) throw(ParseException);

  void write(std::ostream &stream, uint_t tabWidth = 2) const
    throw(IOException);

  void write(String &str, uint_t tabWidth = 2) const;

  inline bool isEmpty() const throw()
  { return(_root == NULL); }

  inline bool operator!() const throw()
  { return(isEmpty()); }

  private:

  const XMLElement & _find(const String &path) const
    throw(InvalidArgumentException);

  // RAII class to encapsulate parser object
  class XMLParser
  {
    friend class XMLDocument;

    public:

    XMLParser(XMLDocument *owner, const String& encoding = "us-ascii");
    ~XMLParser();

    void parse(const char *data, size_t length, bool done = true)
      throw(ParseException);

    inline void appendCharData(const XML_Char *data, int len)
    { _charData.append(data, len); }

    private:

    XMLDocument *_document;
    XMLElement *_current;
    String _charData;
    XML_Parser _parser;
    bool _status;
  };

  String _encoding;
  XMLElement *_root;

  static void _elementStartHandler(void *userData, const XML_Char *name,
                                   const XML_Char **attr);
  static void _elementEndHandler(void *userData, const XML_Char *name);
  static void _charDataHandler(void *userData, const XML_Char *data,
                               int len);
  static void _commentHandler(void *userData, const XML_Char *data);

  CCXX_COPY_DECLS(XMLDocument);
};

}; // namespace ccxx

#endif // __ccxx_XMLDocument_hxx

/* end of header file */