Public API Reference

csutil/documentcommon.h

Go to the documentation of this file.

/*
    Copyright (C) 2005 by Jorrit Tyberghein
              (C) 2005 by Frank Richter

    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_CSUTIL_DOCUMENTCOMMON_H__
#define __CS_CSUTIL_DOCUMENTCOMMON_H__

#include "csextern.h"
#include "csutil/leakguard.h"
#include "csutil/scf_implementation.h"
#include "iutil/document.h"

class CS_CRYSTALSPACE_EXPORT csEmptyDocumentNodeIterator : 
  public scfImplementation1<csEmptyDocumentNodeIterator, iDocumentNodeIterator>
{
public:
  CS_LEAKGUARD_DECLARE(csEmptyDocumentNodeIterator);

  csEmptyDocumentNodeIterator ();
  virtual ~csEmptyDocumentNodeIterator ();

  virtual bool HasNext () { return false; }
  virtual csRef<iDocumentNode> Next () { return 0; }
};

class CS_CRYSTALSPACE_EXPORT csEmptyDocumentAttributeIterator : 
  public scfImplementation1<csEmptyDocumentAttributeIterator, iDocumentAttributeIterator>
{
public:
  CS_LEAKGUARD_DECLARE(csEmptyDocumentAttributeIterator);

  csEmptyDocumentAttributeIterator ();
  virtual ~csEmptyDocumentAttributeIterator ();

  virtual bool HasNext () { return false; }
  virtual csRef<iDocumentAttribute> Next () { return 0; }
};

class CS_CRYSTALSPACE_EXPORT csDocumentNodeCommon : 
  public scfImplementation1<csDocumentNodeCommon, iDocumentNode>
{
public:
  csDocumentNodeCommon () : scfImplementationType (this) {}

  virtual void SetValueAsInt (int value);
  virtual void SetValueAsFloat (float value);

  virtual csRef<iDocumentNodeIterator> GetNodes ()
  { return csPtr<iDocumentNodeIterator> (new csEmptyDocumentNodeIterator); }
  virtual csRef<iDocumentNodeIterator> GetNodes (const char* value);
  virtual csRef<iDocumentNode> GetNode (const char* /*value*/)
  { return 0; }


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

  virtual csRef<iDocumentAttributeIterator> GetAttributes ()
  { 
    return csPtr<iDocumentAttributeIterator> 
      (new csEmptyDocumentAttributeIterator); 
  }

  csRef<iDocumentAttribute> GetAttribute (const char*) { return 0; }

  virtual const char* GetAttributeValue (const char* name);
  virtual int GetAttributeValueAsInt (const char* name);
  virtual float GetAttributeValueAsFloat (const char* name);
  virtual bool GetAttributeValueAsBool (const char* name, 
    bool defaultvalue = false);


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

class CS_CRYSTALSPACE_EXPORT csDocumentAttributeCommon : 
  public scfImplementation1<csDocumentAttributeCommon, iDocumentAttribute>
{
public:
  csDocumentAttributeCommon () : scfImplementationType (this)
  {}

  virtual int GetValueAsInt ();
  virtual float GetValueAsFloat ();
  virtual bool GetValueAsBool ();


  virtual void SetValueAsInt (int v);
  virtual void SetValueAsFloat (float f);
};

class CS_CRYSTALSPACE_EXPORT csDocumentNodeReadOnly : 
  public scfImplementationExt0<csDocumentNodeReadOnly, csDocumentNodeCommon>
{
public:
  csDocumentNodeReadOnly () 
    : scfImplementationType (this)
  {}

  virtual void SetValue (const char* /*value*/) {}
  virtual void SetValueAsInt (int /*value*/) {}
  virtual void SetValueAsFloat (float /*value*/) {}

  virtual void RemoveNode (const csRef<iDocumentNode>& /*child*/) {}
  virtual void RemoveNodes (csRef<iDocumentNodeIterator> /*children*/) {}
  virtual void RemoveNodes () {}

  virtual csRef<iDocumentNode> CreateNodeBefore (csDocumentNodeType /*type*/,
        iDocumentNode* /*before*/)
  { return 0; }

  virtual void RemoveAttribute (const csRef<iDocumentAttribute>& /*attr*/) {}
  virtual void RemoveAttributes () {}

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

#endif // __CS_CSUTIL_DOCUMENTCOMMON_H__

---