Public API Reference

iutil/document.h

Go to the documentation of this file.

/*
    Crystal Space Document Interface
    Copyright (C) 2002 by Jorrit Tyberghein

    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 __CS_IUTIL_DOCUMENT_H__
#define __CS_IUTIL_DOCUMENT_H__

#include "csutil/scf.h"

struct iDocumentNode;
struct iDocumentAttribute;
struct iFile;
struct iDataBuffer;
struct iString;
struct iVFS;

enum csDocumentNodeType
{
  CS_NODE_DOCUMENT = 1,
  CS_NODE_ELEMENT,
  CS_NODE_COMMENT,
  CS_NODE_UNKNOWN,
  CS_NODE_TEXT,
  CS_NODE_DECLARATION
};


#define CS_CHANGEABLE_NEVER             0
#define CS_CHANGEABLE_NEWROOT           1
#define CS_CHANGEABLE_YES               2

//===========================================================================

struct iDocumentAttributeIterator : public virtual iBase
{
  SCF_INTERFACE(iDocumentAttributeIterator, 2,0,0);
  virtual bool HasNext () = 0;
  virtual csRef<iDocumentAttribute> Next () = 0;
};

//===========================================================================


struct iDocumentAttribute : public virtual iBase
{
  SCF_INTERFACE(iDocumentAttribute, 2,0,0);
  virtual const char* GetName () = 0;
  virtual const char* GetValue () = 0;
  virtual int GetValueAsInt () = 0;
  virtual float GetValueAsFloat () = 0;
  virtual bool GetValueAsBool () = 0;
  virtual void SetName (const char* name) = 0;
  virtual void SetValue (const char* value) = 0;
  virtual void SetValueAsInt (int v) = 0;
  virtual void SetValueAsFloat (float f) = 0;
};

//===========================================================================

struct iDocumentNodeIterator : public virtual iBase
{
  SCF_INTERFACE(iDocumentNodeIterator, 2,0,0);
  virtual bool HasNext () = 0;
  virtual csRef<iDocumentNode> Next () = 0;
};

//===========================================================================


struct iDocumentNode : public virtual iBase
{
  SCF_INTERFACE(iDocumentNode, 2,0,0);
  virtual csDocumentNodeType GetType () = 0;

  virtual bool Equals (iDocumentNode* other) = 0;

  virtual const char* GetValue () = 0;
  virtual void SetValue (const char* value) = 0;
  virtual void SetValueAsInt (int value) = 0;
  virtual void SetValueAsFloat (float value) = 0;

  virtual csRef<iDocumentNode> GetParent () = 0;

  //---------------------------------------------------------------------
  
  virtual csRef<iDocumentNodeIterator> GetNodes () = 0;
  virtual csRef<iDocumentNodeIterator> GetNodes (const char* value) = 0;
  virtual csRef<iDocumentNode> GetNode (const char* value) = 0;

  virtual void RemoveNode (const csRef<iDocumentNode>& child) = 0;
  virtual void RemoveNodes (csRef<iDocumentNodeIterator> children) = 0;
  virtual void RemoveNodes () = 0;

  virtual csRef<iDocumentNode> CreateNodeBefore (csDocumentNodeType type,
        iDocumentNode* before = 0) = 0;

  virtual const char* GetContentsValue () = 0;
  virtual int GetContentsValueAsInt () = 0;
  virtual float GetContentsValueAsFloat () = 0;

  //---------------------------------------------------------------------

  virtual csRef<iDocumentAttributeIterator> GetAttributes () = 0;
  virtual csRef<iDocumentAttribute> GetAttribute (const char* name) = 0;
  virtual const char* GetAttributeValue (const char* name) = 0;
  virtual int GetAttributeValueAsInt (const char* name) = 0;
  virtual float GetAttributeValueAsFloat (const char* name) = 0;
  virtual bool GetAttributeValueAsBool (const char* name,
        bool defaultvalue=false) = 0;

  virtual void RemoveAttribute (const csRef<iDocumentAttribute>& attr) = 0;
  virtual void RemoveAttributes () = 0;

  virtual void SetAttribute (const char* name, const char* value) = 0;
  virtual void SetAttributeAsInt (const char* name, int value) = 0;
  virtual void SetAttributeAsFloat (const char* name, float value) = 0;
};

//===========================================================================


struct iDocument : public virtual iBase
{
  SCF_INTERFACE(iDocument, 2,0,0);
  virtual void Clear () = 0;

  virtual csRef<iDocumentNode> CreateRoot () = 0;

  virtual csRef<iDocumentNode> GetRoot () = 0;

  virtual const char* Parse (iFile* file, bool collapse = false) = 0;

  virtual const char* Parse (iDataBuffer* buf, bool collapse = false) = 0;

  virtual const char* Parse (iString* str, bool collapse = false) = 0;

  virtual const char* Parse (const char* buf, bool collapse = false) = 0;

  virtual const char* Write (iFile* file) = 0;

  virtual const char* Write (iString* str) = 0;

  virtual const char* Write (iVFS* vfs, const char* filename) = 0;
  
  virtual int Changeable () = 0;
};

//===========================================================================


struct iDocumentSystem : public virtual iBase
{
  SCF_INTERFACE(iDocumentSystem, 2,0,0);
  virtual csRef<iDocument> CreateDocument () = 0;
};

#endif // __CS_IUTIL_DOCUMENT_H__

---