Public API Reference

imap/services.h

Go to the documentation of this file.

/*
    Copyright (C) 2001 by Norman Kraemer

    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_IMAP_SYNTAXSERVICE_H__
#define __CS_IMAP_SYNTAXSERVICE_H__

#include "csutil/scf.h"

#include "ivideo/graph3d.h"

class csBox3;
class csColor;
class csColor4;
class csMatrix3;
class csOBB;
class csPlane3;
class csShaderVariable;
class csVector2;
class csVector3;

struct csAlphaMode;

struct iDocumentNode;
struct iGradient;
struct iKeyValuePair;
struct iLoaderContext;
struct iMaterialWrapper;
struct iRenderBuffer;
struct iSector;
struct iShader;
struct iShaderVariableAccessor;
struct iString;
struct iStringSet;
struct iThingFactoryState;


#define CSTEX_UV 1  
#define CSTEX_V1 2  
#define CSTEX_V2 4  
#define CSTEX_UV_SHIFT 8 

struct iSyntaxService : public virtual iBase
{
  SCF_INTERFACE (iSyntaxService, 2, 1, 0);
  
  virtual void ReportError (const char* msgid, iDocumentNode* errornode,
        const char* msg, ...) CS_GNUC_PRINTF(4,5) = 0;

  virtual void ReportBadToken (iDocumentNode* badtokennode) = 0;

  virtual void Report (const char* msgid, int severity, 
    iDocumentNode* errornode, const char* msg, ...) CS_GNUC_PRINTF(5,6) = 0;
  virtual bool ParseBool (iDocumentNode* node, bool& result,
        bool def_result) = 0;
 
  virtual bool ParseBoolAttribute (iDocumentNode* node, const char* attrname,
        bool& result, bool def_result, bool required) = 0;

  virtual bool WriteBool (iDocumentNode* node, const char* name, 
    bool value) = 0;
  
  bool WriteBool (iDocumentNode* node, const char* name, bool value, 
    bool default_value) 
  { 
    if (value != default_value) 
      return WriteBool (node, name, value); 
    else
      return true;
  }

  virtual bool ParsePlane (iDocumentNode* node, csPlane3 &p) = 0;

  virtual bool WritePlane (iDocumentNode* node, const csPlane3& p) = 0;
  
  virtual bool ParseMatrix (iDocumentNode* node, csMatrix3 &m) = 0;

  virtual bool WriteMatrix (iDocumentNode* node, const csMatrix3& m) = 0;

  virtual bool ParseVector (iDocumentNode* node, csVector3 &v) = 0;

  virtual bool WriteVector (iDocumentNode* node, const csVector3& v) = 0;

  virtual bool ParseVector (iDocumentNode* node, csVector2 &v) = 0;

  virtual bool WriteVector (iDocumentNode* node, const csVector2& v) = 0;

  virtual bool ParseBox (iDocumentNode* node, csBox3 &v) = 0;

  virtual bool WriteBox (iDocumentNode* node, const csBox3& v) = 0;

  virtual bool ParseBox (iDocumentNode* node, csOBB &b) = 0;

  virtual bool WriteBox (iDocumentNode* node, const csOBB& b) = 0;

  virtual bool ParseColor (iDocumentNode* node, csColor &c) = 0;

  virtual bool WriteColor (iDocumentNode* node, const csColor& c) = 0;

  virtual bool ParseColor (iDocumentNode* node, csColor4 &c) = 0;

  virtual bool WriteColor (iDocumentNode* node, const csColor4& c) = 0;

  virtual bool ParseMixmode (iDocumentNode* node, uint &mixmode,
    bool allowFxMesh = false) = 0;

  virtual bool WriteMixmode (iDocumentNode* node, uint mixmode,
    bool allowFxMesh) = 0;

  virtual bool HandlePortalParameter (
        iDocumentNode* child, iLoaderContext* ldr_context,
        uint32 &flags, bool &mirror, bool &warp, int& msv,
        csMatrix3 &m, csVector3 &before, csVector3 &after,
        iString* destSector, bool& handled, bool& autoresolve) = 0;

  virtual bool ParseGradient (iDocumentNode* node,
                              iGradient* gradient) = 0;

  virtual bool WriteGradient (iDocumentNode* node,
                              iGradient* gradient) = 0;

  virtual bool ParseShaderVar (iLoaderContext* ldr_context,
      iDocumentNode* node, csShaderVariable& var) = 0;
  virtual csRef<iShaderVariableAccessor> ParseShaderVarExpr (
    iDocumentNode* node) = 0;
                            
  virtual bool WriteShaderVar (iDocumentNode* node, 
    csShaderVariable& var) = 0;
                            
  virtual bool ParseAlphaMode (iDocumentNode* node, iStringSet* strings,
    csAlphaMode& alphaMode, bool allowAutoMode = true) = 0;
    
  virtual bool WriteAlphaMode (iDocumentNode* node, iStringSet* strings,
    const csAlphaMode& alphaMode) = 0;
    
  virtual bool ParseZMode (iDocumentNode* node, csZBufMode& zmode,
    bool allowZmesh = false) = 0;

  virtual bool WriteZMode (iDocumentNode* node, csZBufMode zmode,
    bool allowZmesh) = 0;

  virtual bool ParseKey (iDocumentNode* node, iKeyValuePair*& keyvalue) = 0;

  virtual bool WriteKey (iDocumentNode* node, iKeyValuePair* keyvalue) = 0;

  virtual csRef<iRenderBuffer> ParseRenderBuffer (iDocumentNode* node) = 0;

  virtual bool WriteRenderBuffer (iDocumentNode* node, iRenderBuffer* buffer) = 0;
  
  virtual csRef<iShader> ParseShaderRef (iLoaderContext* ldr_context,
      iDocumentNode* node) = 0;
};

#endif // __CS_IMAP_SYNTAXSERVICE_H__

---