sml/symbol.h

Go to the documentation of this file.

/******************************************************************************
 *
 * \file sml/symbol.h
 * \brief SML SYMBOL
 *
 * \if NODOC
 * $Log: symbol.h_v $
 * Revision 1.8  2011/10/12 14:32:51  mju
 * Remove redundant hdrs.
 *
 * Revision 1.7  2008/10/31 16:13:50  scowan
 * Removed sml_sameSymbol define.
 *
 * Revision 1.6  2008/10/23 20:38:18  scowan
 * Moved function prototypes from sml include file.
 *
 * Revision 1.5  2007/05/08 15:46:29  dwilliss
 * SML namespace
 *
 * Revision 1.4  2007/05/07 15:43:40  dwilliss
 * *** empty log message ***
 *
 * Revision 1.3  2007/05/04 22:46:57  dwilliss
 * *** empty log message ***
 *
 * Revision 1.2  2007/05/04 21:32:59  dwilliss
 * *** empty log message ***
 *
 * Revision 1.1  2007/05/04 21:28:08  dwilliss
 * Initial revision
 *
 * \endif
*/
/*****************************************************************************/

#ifndef INC_SML_SYMBOL_H
#define INC_SML_SYMBOL_H

#ifndef  INC_SML_USERDATA_H
#include <sml/userdata.h>
#endif

#ifndef  INC_SML_STYPE_H
#include <sml/stype.h>
#endif

#ifndef  INC_MI32_SMLBASE_H
#include <mi32/smlbase.h>
#endif

#ifdef RVCSYSDLL
   #define RVCSYSLIBEXPORT MI_DLLEXPORT
   #define RVCSYSLIBCLASSEXPORT MI_DLLCLASSEXPORT
#else
   #define RVCSYSLIBEXPORT MI_DLLIMPORT
   #define RVCSYSLIBCLASSEXPORT MI_DLLCLASSIMPORT
#endif

class MISTRING;


#ifdef GetObject
#undef GetObject
#endif

namespace SML {

#ifndef GENERATING_DOXYGEN_OUTPUT
typedef PTRINT MACHINEINST;   
class STRING;
class CLASSARRAY;
class USERDATA;
class RASTEROBJECT;
class VECTOROBJECT;
class CADOBJECT;
class TINOBJECT;
class SHAPEOBJECT;
class OBJECT;
class FUNC;
class PARM;
class TABLEDATA;
class CONTEXT;
class CLASS;
#endif

/* Flags in SML::SYMBOL.flags (only a short) */

#define SYMBOL_DontFree    0x0100   
#define SYMBOL_Permanent   0x0200   
#define SYMBOL_Static      0x0400   


/***************************************************************************/
// Members labeled PRIVATE are not accessed outside the DLL as of 6.4
// Members labeled PUBLIC are accessed outside the DLL

class RVCSYSLIBCLASSEXPORT SYMBOL {
public:

   enum SCOPE {
      SCOPE_NONE        = 0,
      SCOPE_TABLE,
      SCOPE_BFUNCTION,
      SCOPE_KEYWORD,
      SCOPE_GLOBAL,
      SCOPE_LOCAL,
      SCOPE_PERMANENT,
      SCOPE_PROTOTYPE,
      SCOPE_STATIC
      };

public:

   // public member functions
   void AttachUserData (
      USERDATA* data
      ) {
      m_userdata.Attach(data);
      return;
      }

   void DetachUserData (
      USERDATA* data
      ) {
      m_userdata.Detach(data);
      return;
      }

   void DisposeOfContents (
      );

   double* GetArray (
      ) const;

   int GetArrayNumLins (
      ) const;

   int GetArrayNumCols (
      ) const;

   const CLASS* GetClass (
      ) const;

   USERDATA* GetUserData (
      USERDATA::TAG tag
      ) {
      return (m_userdata.Get(tag));
      }

   // Return true if the symbol is a "permanent" symbol defined by the
   // creator of the script context (e.g. defined by a style query)
   bool IsPermanent (
      ) const;

   ERRVALUE SetValue (
      const MIUNICODE *string          
      );

   void SetValuePtr (
      void* val
      );

   int GetFieldType (
      ) const;

   SYMBOL* GetFormalParameterSymbol (
      int parmnum
      ) const;

   CLASS* GetFormalParameterClass (
      int parmnum
      ) const;

   int GetFormalParameterType (
      int parmnum
      ) const;

   const MIUNICODE* GetName (
      ) const;

   const MIUNICODE* GetAltName (
      ) const;

   SYMBOL* GetNext (
      );

   const SYMBOL* GetNext (
      ) const;

   int GetObject (
      OBJECT** pObj,
      bool UndefinedOK = false
      );

   int GetObject (
      RASTEROBJECT** pObj,
      bool UndefinedOK = false
      );

   int GetObject (
      VECTOROBJECT** pObj,
      bool UndefinedOK = false
      );

   int GetObject (
      CADOBJECT** pObj,
      bool UndefinedOK = false
      );

   int GetObject (
      TINOBJECT** pObj,
      bool UndefinedOK = false
      );

   int GetFieldNumber (
      ) const;

   const TABLEDATA* GetTableData (
      ) const;

   int GetTableNumber (
      ) const;

   STYPE GetType (
      ) const;

   void SetType (
      STYPE type
      );

   const char *GetTypeName (
      ) const;

   int IsNULL (
      ) const;

   bool IsOptionalArgument (
      ) const;


   void SetObjectElement (
      int ElemType,
      INT32 ElemNum
      );

   void SetRasterLinCol (
      int lin,
      int col
      );


   bool GetValue (
      double& value
      ) const;

   bool GetValue (
      MISTRING& value
      ) const;

   MIUNICODE *GetValueUnicode (
      char *fmt,
      MIUNICODE *buf,
      int maxlen
      ) const ;

   char *GetValueStr (
      char *fmt,
      char *buf,
      int maxlen
      ) const;

#if defined(ALLOW_RETIRED) || defined (RVCSYSDLL)
   #ifndef GENERATING_DOXYGEN_OUTPUT
   void GetValue (
      MISTRING& mistring,
      const char* format
      ) const;
   #endif // GENERATING_DOXYGEN_OUTPUT
#endif

   double GetValueDouble (
      ) const;

   void* GetValuePtr () const;
   OBJECT* GetValueObj () const;

   void SetValue(OBJECT*);

   STRING* GetValueSTRING() const;

   ERRVALUE ResizeArray (
      int numcols
      );

   ERRVALUE ResizeArray (
      int numlines,
      int numcols,
      bool bKeep = false
      );

   void SetArray (
      double *data,
      int numrows,
      int numcols
      );

   int SetValueNULL (
      );

   int SetValue (
      double value
      );

   ERRVALUE SetValue (
      const char *string               
      );


#ifndef GENERATING_DOXYGEN_OUTPUT
   SYMBOL* GetLocalVars (
      ) const;

   void SetLocalVars (
      SYMBOL* sym
      );

   void SetNext (
      SYMBOL* sym
      );

   void _SetNumCols(int);

   FUNC* GetFunc() const;

   int GetTypeRaw() const;

   // LIST OF FRIENDS
   friend class CONTEXT;
   friend class VM;
   friend class PARSER;
   friend int qqparse(void*);
#endif // GENERATING_DOXYGEN_OUTPUT

private:
   void SetValuePtr (
      OBJECT* val
      );


#ifndef GENERATING_DOXYGEN_OUTPUT
public:
#if !defined(RVCSYSDLL)
private:
#endif

   /*:> public */
   MIUNICODE *name;

   union DATA {      /* 12 bytes */
      double         val;
      void *         ptr;
      void           (*proc)(int, ARG*, UINT8 *, CONTEXT *);         /* hardcoded functions */
      double         (*func)(int, ARG*, UINT8 *, CONTEXT *);         /* hardcoded functions */
      double         (*dfunc)(double);       /* hardcoded functions */
      SYMBOL      *(*ofunc)(int, ARG*, UINT8 *, CONTEXT *);    /* hardcoded functions */
      STRING *    (*sfunc)(int, ARG*, UINT8 *, CONTEXT *);        /* hardcoded functions */
      void *         (*classfunc)(int, ARG*, UINT8 *, CONTEXT *); /* hardcoded functions of type STYPE_ClassRefFunc or STYPE_ClassCopyFunc */
      MACHINEINST defn;
      void           *list;
      STRING      *str;
      double         *array;
      UINT8          *free_me;
      int            pc;               
      void           *ClassData;
      CLASSARRAY  *carray;
      struct {
         short tnum, fnum, ftype, spare;  
         } field;
      } u;
   short type;
   short ptype;   
   PARM *parm; 
   union {
      short parmnum;             
      short segnum;              
      } u1;
   short flags;                  

   long NumLins;
   long NumCols;        
   union {
      TABLEDATA *table;       
      CLASS *objclass;        
      } u2;
   SYMBOL *tablesym;    
   SYMBOL *localvars;      
   SYMBOL *next;
   FUNC *smlfunc;
   CONTEXT *context;
   USERDATACONTAINER m_userdata;
   OBJECT* m_obj;
   MIUNICODE* m_altname;      // Alternative name ("full name" for objects)
   SYMBOL* m_NextOverload;
   INT32 m_Scope;             // for "local" symbols 

   #endif // GENERATING_DOXYGEN_OUTPUT

   };

RVCSYSLIBEXPORT int SameObject (
   SML::SYMBOL*,
   SML::SYMBOL*
   );
}        // End of SML namespace

/***************************************************************************/

typedef enum SML::SYMBOL::SCOPE SMLSCOPE;
typedef SML::SYMBOL SMLSYMBOL;

#undef RVCSYSLIBEXPORT
#undef RVCSYSLIBCLASSEXPORT

#endif      //  INC_SML_SYMBOL_H

---