iprt/cpp/xml.h

	xml.h revision f7b81dcd1a01325f5ca2806c2694b8f1d3b9eb4c
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync/** @file
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * VirtualBox XML helper APIs.
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync */
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync/*
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * Copyright (C) 2007-2009 Sun Microsystems, Inc.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync *
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * available from http://www.virtualbox.org. This file is free software;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * you can redistribute it and/or modify it under the terms of the GNU
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync * General Public License (GPL) as published by the Free Software
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync *
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync * The contents of this file may alternatively be used under the terms
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync * of the Common Development and Distribution License Version 1.0
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync * VirtualBox OSE distribution, in which case the provisions of the
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync * CDDL are applicable instead of those of the GPL.
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync *
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync * You may elect to license modified versions of this file under the
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync * terms and conditions of either the GPL or the CDDL or both.
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync *
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * additional information or have any questions.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync */
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync#ifndef ___VBox_vboxxml_h
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync#define ___VBox_vboxxml_h
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync#ifndef IN_RING3
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync# error "There are no XML APIs available in Ring-0 Context!"
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync#endif
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync#include <list>
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync#include <memory>
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync#include <iprt/cpp/ministring.h>
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync/* Forwards */
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsynctypedef struct _xmlParserInput xmlParserInput;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsynctypedef xmlParserInput *xmlParserInputPtr;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsynctypedef struct _xmlParserCtxt xmlParserCtxt;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsynctypedef xmlParserCtxt *xmlParserCtxtPtr;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsynctypedef struct _xmlError xmlError;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsynctypedef xmlError *xmlErrorPtr;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncnamespace xml
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync{
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync// Exceptions
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync//////////////////////////////////////////////////////////////////////////////
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync/**
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * Base exception class.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync */
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncclass RT_DECL_CLASS Error : public std::exception
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync{
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncpublic:
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    Error(const char *pcszMessage)
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync        : m_s(pcszMessage)
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    {
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    }
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    Error(const Error &s)
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync        : std::exception(s),
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync          m_s(s.what())
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    {
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    }
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    virtual ~Error() throw()
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    {
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    }
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    void operator=(const Error &s)
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    {
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync        m_s = s.what();
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    }
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    void setWhat(const char *pcszMessage)
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    {
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync        m_s = pcszMessage;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    }
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    virtual const char* what() const throw()
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync    {
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync        return m_s.c_str();
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    }
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncprivate:
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    // hide the default constructor to make sure the extended one above is always used
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    Error();
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    iprt::MiniString m_s;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync};
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncclass RT_DECL_CLASS LogicError : public Error
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync{
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncpublic:
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    LogicError(const char *aMsg = NULL)
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync        : xml::Error(aMsg)
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    {}
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    LogicError(RT_SRC_POS_DECL);
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync};
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncclass RT_DECL_CLASS RuntimeError : public Error
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync{
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncpublic:
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    RuntimeError(const char *aMsg = NULL)
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync        : xml::Error(aMsg)
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    {}
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync};
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncclass RT_DECL_CLASS XmlError : public RuntimeError
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync{
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncpublic:
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    XmlError(xmlErrorPtr aErr);
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    static char* Format(xmlErrorPtr aErr);
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync};
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync// Logical errors
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync//////////////////////////////////////////////////////////////////////////////
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncclass RT_DECL_CLASS ENotImplemented : public LogicError
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync{
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncpublic:
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    ENotImplemented(const char *aMsg = NULL) : LogicError(aMsg) {}
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    ENotImplemented(RT_SRC_POS_DECL) : LogicError(RT_SRC_POS_ARGS) {}
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync};
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncclass RT_DECL_CLASS EInvalidArg : public LogicError
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync{
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncpublic:
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    EInvalidArg(const char *aMsg = NULL) : LogicError(aMsg) {}
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    EInvalidArg(RT_SRC_POS_DECL) : LogicError(RT_SRC_POS_ARGS) {}
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync};
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncclass RT_DECL_CLASS EDocumentNotEmpty : public LogicError
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync{
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncpublic:
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    EDocumentNotEmpty(const char *aMsg = NULL) : LogicError(aMsg) {}
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    EDocumentNotEmpty(RT_SRC_POS_DECL) : LogicError(RT_SRC_POS_ARGS) {}
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync};
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncclass RT_DECL_CLASS ENodeIsNotElement : public LogicError
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync{
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncpublic:
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    ENodeIsNotElement(const char *aMsg = NULL) : LogicError(aMsg) {}
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    ENodeIsNotElement(RT_SRC_POS_DECL) : LogicError(RT_SRC_POS_ARGS) {}
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync};
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync// Runtime errors
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync//////////////////////////////////////////////////////////////////////////////
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncclass RT_DECL_CLASS EIPRTFailure : public RuntimeError
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync{
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsyncpublic:
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    EIPRTFailure (int aRC);
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    int rc() const { return mRC; }
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncprivate:
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    int mRC;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync};
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync/**
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * The Stream class is a base class for I/O streams.
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync */
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsyncclass RT_DECL_CLASS Stream
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync{
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsyncpublic:
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    virtual ~Stream() {}
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync    virtual const char *uri() const = 0;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync    /**
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * Returns the current read/write position in the stream. The returned
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * position is a zero-based byte offset from the beginning of the file.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     *
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * Throws ENotImplemented if this operation is not implemented for the
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * given stream.
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync     */
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    virtual uint64_t pos() const = 0;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync    /**
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync     * Sets the current read/write position in the stream.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     *
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * @param aPos Zero-based byte offset from the beginning of the stream.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     *
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * Throws ENotImplemented if this operation is not implemented for the
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * given stream.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     */
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    virtual void setPos (uint64_t aPos) = 0;
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync};
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync/**
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * The Input class represents an input stream.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync *
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * This input stream is used to read the settings tree from.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * This is an abstract class that must be subclassed in order to fill it with
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * useful functionality.
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync */
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncclass RT_DECL_CLASS Input : virtual public Stream
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync{
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsyncpublic:
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    /**
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * Reads from the stream to the supplied buffer.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     *
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * @param aBuf Buffer to store read data to.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * @param aLen Buffer length.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     *
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * @return Number of bytes read.
a0f8619bc2bbe3614578c21b5b50a88d2841e7aavboxsync     */
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    virtual int read (char *aBuf, int aLen) = 0;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync};
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync/**
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync *
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync */
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncclass RT_DECL_CLASS Output : virtual public Stream
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync{
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsyncpublic:
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    /**
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * Writes to the stream from the supplied buffer.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     *
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * @param aBuf Buffer to write data from.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * @param aLen Buffer length.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     *
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * @return Number of bytes written.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     */
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    virtual int write (const char *aBuf, int aLen) = 0;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    /**
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * Truncates the stream from the current position and upto the end.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * The new file size will become exactly #pos() bytes.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     *
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * Throws ENotImplemented if this operation is not implemented for the
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     * given stream.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync     */
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync    virtual void truncate() = 0;
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync};
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync//////////////////////////////////////////////////////////////////////////////
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync/**
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * The File class is a stream implementation that reads from and writes to
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * regular files.
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync *
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * The File class uses IPRT File API for file operations. Note that IPRT File
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * API is not thread-safe. This means that if you pass the same RTFILE handle to
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * different File instances that may be simultaneously used on different
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * threads, you should care about serialization; otherwise you will get garbage
632b4638bd18092c6b8edb4e1028c9be112f5076vboxsync * when reading from or writing to such File instances.
 */
class RT_DECL_CLASS File : public Input, public Output
{
public:

    /**
     * Possible file access modes.
     */
    enum Mode { Mode_Read, Mode_WriteCreate, Mode_Overwrite, Mode_ReadWrite };

    /**
     * Opens a file with the given name in the given mode. If @a aMode is Read
     * or ReadWrite, the file must exist. If @a aMode is Write, the file must
     * not exist. Otherwise, an EIPRTFailure excetion will be thrown.
     *
     * @param aMode     File mode.
     * @param aFileName File name.
     */
    File(Mode aMode, const char *aFileName);

    /**
     * Uses the given file handle to perform file operations. This file
     * handle must be already open in necessary mode (read, or write, or mixed).
     *
     * The read/write position of the given handle will be reset to the
     * beginning of the file on success.
     *
     * Note that the given file handle will not be automatically closed upon
     * this object destruction.
     *
     * @note It you pass the same RTFILE handle to more than one File instance,
     *       please make sure you have provided serialization in case if these
     *       instasnces are to be simultaneously used by different threads.
     *       Otherwise you may get garbage when reading or writing.
     *
     * @param aHandle   Open file handle.
     * @param aFileName File name (for reference).
     */
    File(RTFILE aHandle, const char *aFileName = NULL);

    /**
     * Destroys the File object. If the object was created from a file name
     * the corresponding file will be automatically closed. If the object was
     * created from a file handle, it will remain open.
     */
    virtual ~File();

    const char *uri() const;

    uint64_t pos() const;
    void setPos(uint64_t aPos);

    /**
     * See Input::read(). If this method is called in wrong file mode,
     * LogicError will be thrown.
     */
    int read(char *aBuf, int aLen);

    /**
     * See Output::write(). If this method is called in wrong file mode,
     * LogicError will be thrown.
     */
    int write(const char *aBuf, int aLen);

    /**
     * See Output::truncate(). If this method is called in wrong file mode,
     * LogicError will be thrown.
     */
    void truncate();

private:

    /* Obscure class data */
    struct Data;
    Data *m;

    /* auto_ptr data doesn't have proper copy semantics */
    DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP (File)
};

/**
 * The MemoryBuf class represents a stream implementation that reads from the
 * memory buffer.
 */
class RT_DECL_CLASS MemoryBuf : public Input
{
public:

    MemoryBuf (const char *aBuf, size_t aLen, const char *aURI = NULL);

    virtual ~MemoryBuf();

    const char *uri() const;

    int read(char *aBuf, int aLen);
    uint64_t pos() const;
    void setPos(uint64_t aPos);

private:
    /* Obscure class data */
    struct Data;
    Data *m;

    /* auto_ptr data doesn't have proper copy semantics */
    DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(MemoryBuf)
};


/*
 * GlobalLock
 *
 *
 */

typedef xmlParserInput* FNEXTERNALENTITYLOADER(const char *aURI,
                                               const char *aID,
                                               xmlParserCtxt *aCtxt);
typedef FNEXTERNALENTITYLOADER *PFNEXTERNALENTITYLOADER;

class RT_DECL_CLASS GlobalLock
{
public:
    GlobalLock();
    ~GlobalLock();

    void setExternalEntityLoader(PFNEXTERNALENTITYLOADER pFunc);

    static xmlParserInput* callDefaultLoader(const char *aURI,
                                             const char *aID,
                                             xmlParserCtxt *aCtxt);

private:
    /* Obscure class data. */
    struct Data;
    struct Data *m;
};

/**
 * Node:
 *  an XML node, which represents either an element or text content
 *  or an attribute.
 *
 *  For elements, getName() returns the element name, and getValue()
 *  returns the text contents, if any.
 *
 *  For attributes, getName() returns the attribute name, and getValue()
 *  returns the attribute value, if any.
 *
 *  Since the default constructor is private, one can create new nodes
 *  only through factory methods provided by the XML classes. These are:
 *
 *  --  xml::Document::createRootElement()
 *  --  xml::Node::createChild()
 *  --  xml::Node::addContent()
 *  --  xml::Node::setAttribute()
 */

class ElementNode;
typedef std::list<const ElementNode*> ElementNodesList;

class AttributeNode;

class ContentNode;

class RT_DECL_CLASS Node
{
public:
    ~Node();

    const char* getName() const;
    bool nameEquals(const char *pcsz) const;

    const char* getValue() const;
    bool copyValue(int32_t &i) const;
    bool copyValue(uint32_t &i) const;
    bool copyValue(int64_t &i) const;
    bool copyValue(uint64_t &i) const;

    int getLineNumber() const;

    int isElement()
    {
        return mType == IsElement;
    }

protected:
    typedef enum {IsElement, IsAttribute, IsContent} EnumType;
    EnumType mType;

    // hide the default constructor so people use only our factory methods
    Node(EnumType type);
    Node(const Node &x);      // no copying

    void buildChildren();

    /* Obscure class data */
    struct Data;
    Data *m;
};

class RT_DECL_CLASS ElementNode : public Node
{
public:
    int getChildElements(ElementNodesList &children,
                         const char *pcszMatch = NULL) const;

    const ElementNode* findChildElement(const char *pcszMatch) const;
    const ElementNode* findChildElementFromId(const char *pcszId) const;

    const AttributeNode* findAttribute(const char *pcszMatch) const;
    bool getAttributeValue(const char *pcszMatch, const char *&ppcsz) const;
    bool getAttributeValue(const char *pcszMatch, iprt::MiniString &str) const;
    bool getAttributeValue(const char *pcszMatch, int32_t &i) const;
    bool getAttributeValue(const char *pcszMatch, uint32_t &i) const;
    bool getAttributeValue(const char *pcszMatch, int64_t &i) const;
    bool getAttributeValue(const char *pcszMatch, uint64_t &i) const;
    bool getAttributeValue(const char *pcszMatch, bool &f) const;

    ElementNode* createChild(const char *pcszElementName);

    ContentNode* addContent(const char *pcszContent);
    ContentNode* addContent(const iprt::MiniString &strContent)
    {
        return addContent(strContent.c_str());
    }

    AttributeNode* setAttribute(const char *pcszName, const char *pcszValue);
    AttributeNode* setAttribute(const char *pcszName, const iprt::MiniString &strValue)
    {
        return setAttribute(pcszName, strValue.c_str());
    }
    AttributeNode* setAttribute(const char *pcszName, int32_t i);
    AttributeNode* setAttribute(const char *pcszName, uint32_t i);
    AttributeNode* setAttribute(const char *pcszName, int64_t i);
    AttributeNode* setAttribute(const char *pcszName, uint64_t i);
    AttributeNode* setAttributeHex(const char *pcszName, uint32_t i);
    AttributeNode* setAttribute(const char *pcszName, bool f);

protected:
    // hide the default constructor so people use only our factory methods
    ElementNode();
    ElementNode(const ElementNode &x);      // no copying

    friend class Node;
    friend class Document;
    friend class XmlFileParser;
};

class RT_DECL_CLASS ContentNode : public Node
{
public:

protected:
    // hide the default constructor so people use only our factory methods
    ContentNode();
    ContentNode(const ContentNode &x);      // no copying

    friend class Node;
    friend class ElementNode;
};

class RT_DECL_CLASS AttributeNode : public Node
{
public:

protected:
    // hide the default constructor so people use only our factory methods
    AttributeNode();
    AttributeNode(const AttributeNode &x);      // no copying

    friend class Node;
    friend class ElementNode;
};

/*
 * NodesLoop
 *
 */

class RT_DECL_CLASS NodesLoop
{
public:
    NodesLoop(const ElementNode &node, const char *pcszMatch = NULL);
    ~NodesLoop();
    const ElementNode* forAllNodes() const;

private:
    /* Obscure class data */
    struct Data;
    Data *m;
};

/*
 * Document
 *
 */

class RT_DECL_CLASS Document
{
public:
    Document();
    ~Document();

    Document(const Document &x);
    Document& operator=(const Document &x);

    const ElementNode* getRootElement() const;
    ElementNode* getRootElement();

    ElementNode* createRootElement(const char *pcszRootElementName);

private:
    friend class XmlFileParser;
    friend class XmlFileWriter;

    void refreshInternals();

    /* Obscure class data */
    struct Data;
    Data *m;
};

/*
 * XmlParserBase
 *
 */

class RT_DECL_CLASS XmlParserBase
{
protected:
    XmlParserBase();
    ~XmlParserBase();

    xmlParserCtxtPtr m_ctxt;
};

/*
 * XmlFileParser
 *
 */

class RT_DECL_CLASS XmlFileParser : public XmlParserBase
{
public:
    XmlFileParser();
    ~XmlFileParser();

    void read(const iprt::MiniString &strFilename, Document &doc);

private:
    /* Obscure class data */
    struct Data;
    struct Data *m;

    static int ReadCallback(void *aCtxt, char *aBuf, int aLen);
    static int CloseCallback (void *aCtxt);
};

/*
 * XmlFileWriter
 *
 */

class RT_DECL_CLASS XmlFileWriter
{
public:
    XmlFileWriter(Document &doc);
    ~XmlFileWriter();

    void write(const char *pcszFilename);

    static int WriteCallback(void *aCtxt, const char *aBuf, int aLen);
    static int CloseCallback (void *aCtxt);

private:
    /* Obscure class data */
    struct Data;
    Data *m;
};

#if defined(_MSC_VER)
#pragma warning (default:4251)
#endif

/** @} */

} // end namespace xml

#endif /* ___VBox_vboxxml_h */