xml.h revision 7f1db520ded2b0454dd839fdf9ecae555b3a28fe
/** @file
* VirtualBox XML helper APIs.
*/
/*
* Copyright (C) 2007-2008 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef ___VBox_vboxxml_h
#define ___VBox_vboxxml_h
#include <iprt/cpputils.h>
/* these conflict with numeric_digits<>::min and max */
#ifndef IN_RING3
# error "There are no XML APIs available in Ring-0 Context!"
#else /* IN_RING3 */
/** @def IN_VBOXXML_R3
* Used to indicate whether we're inside the same link module as the
* XML Settings File Manipulation API.
*
* @todo should go to a separate common include together with VBOXXML2_CLASS
* once there becomes more than one header in the VBoxXML2 library.
*/
#ifdef DOXYGEN_RUNNING
# define IN_VBOXXML_R3
#endif
/** @def VBOXXML_CLASS
#ifdef IN_VBOXXML_R3
# define VBOXXML_CLASS DECLEXPORT_CLASS
#else
# define VBOXXML_CLASS DECLIMPORT_CLASS
#endif
/*
* Shut up MSVC complaining that auto_ptr[_ref] template instantiations (as a
* result of private data member declarations of some classes below) need to
* be exported too to in order to be accessible by clients.
*
* The alternative is to instantiate a template before the data member
* declaration with the VBOXXML_CLASS prefix, but the standard disables
* explicit instantiations in a foreign namespace. In other words, a declaration
* like:
*
* template class VBOXXML_CLASS std::auto_ptr <Data>;
*
* right before the member declaration makes MSVC happy too, but this is not a
* valid C++ construct (and G++ spits it out). So, for now we just disable the
* warning and will come back to this problem one day later.
*
* We also disable another warning (4275) saying that a DLL-exported class
* inherits form a non-DLL-exported one (e.g. settings::ENoMemory ->
* std::bad_alloc). I can't get how it can harm yet.
*/
#if defined(_MSC_VER)
#endif
/* Forwards */
typedef struct _xmlParserInput xmlParserInput;
typedef xmlParserInput *xmlParserInputPtr;
typedef struct _xmlParserCtxt xmlParserCtxt;
typedef xmlParserCtxt *xmlParserCtxtPtr;
typedef xmlError *xmlErrorPtr;
{
// Exceptions
//////////////////////////////////////////////////////////////////////////////
/**
* Base exception class.
*/
{
/** smart string with support for reference counting */
struct Str
{
char str [1];
{
return that;
}
};
};
{
};
{
};
// Logical errors
//////////////////////////////////////////////////////////////////////////////
{
};
{
};
// Runtime errors
//////////////////////////////////////////////////////////////////////////////
{
};
{
int mRC;
};
/**
* The Stream class is a base class for I/O streams.
*/
{
/**
* position is a zero-based byte offset from the beginning of the file.
*
* Throws ENotImplemented if this operation is not implemented for the
* given stream.
*/
/**
*
* @param aPos Zero-based byte offset from the beginning of the stream.
*
* Throws ENotImplemented if this operation is not implemented for the
* given stream.
*/
};
/**
* The Input class represents an input stream.
*
* This input stream is used to read the settings tree from.
* This is an abstract class that must be subclassed in order to fill it with
* useful functionality.
*/
{
/**
* Reads from the stream to the supplied buffer.
*
* @param aBuf Buffer to store read data to.
* @param aLen Buffer length.
*
* @return Number of bytes read.
*/
};
/**
*
*/
{
/**
* Writes to the stream from the supplied buffer.
*
* @param aBuf Buffer to write data from.
* @param aLen Buffer length.
*
* @return Number of bytes written.
*/
/**
* Truncates the stream from the current position and upto the end.
* The new file size will become exactly #pos() bytes.
*
* Throws ENotImplemented if this operation is not implemented for the
* given stream.
*/
};
//////////////////////////////////////////////////////////////////////////////
/**
* The File class is a stream implementation that reads from and writes to
* regular files.
*
* The File class uses IPRT File API for file operations. Note that IPRT File
* API is not thread-safe. This means that if you pass the same RTFILE handle to
* different File instances that may be simultaneously used on different
* threads, you should care about serialization; otherwise you will get garbage
* when reading from or writing to such File instances.
*/
{
/**
* Possible file access modes.
*/
/**
* 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.
*/
/**
* Uses the given file handle to perform file operations. This file
* handle must be already open in necessary mode (read, or write, or mixed).
*
* 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).
*/
/**
* Destrroys 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.
*/
const char *uri() const;
/**
* See Input::read(). If this method is called in wrong file mode,
* LogicError will be thrown.
*/
/**
* See Output::write(). If this method is called in wrong file mode,
* LogicError will be thrown.
*/
/**
* See Output::truncate(). If this method is called in wrong file mode,
* LogicError will be thrown.
*/
void truncate();
/* Obscure class data */
struct Data;
/* auto_ptr data doesn't have proper copy semantics */
};
/**
* The MemoryBuf class represents a stream implementation that reads from the
* memory buffer.
*/
{
const char *uri() const;
/* Obscure class data */
struct Data;
/* auto_ptr data doesn't have proper copy semantics */
};
/*
* GlobalLock
*
*
*/
const char *aID,
{
GlobalLock();
~GlobalLock();
const char *aID,
/* Obscure class data */
struct Data;
};
/*
* XmlParserBase
*
*/
{
~XmlParserBase();
};
/*
* XmlFileParser
*
*/
{
~XmlFileParser();
void read(const char *pcszFilename);
/* Obscure class data */
struct Data;
};
#if defined(_MSC_VER)
#pragma warning (default:4251)
#endif
#endif /* IN_RING3 */
/** @} */
} // end namespace xml
#endif /* ___VBox_vboxxml_h */