Bayonne2 / Common C++ 2 Framework
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Data Fields | Static Public Attributes | Static Protected Attributes | Private Attributes | Static Private Attributes | Friends
ost::ScriptProperty Class Referenceabstract

This class is used for DSO modules that impliment property extensions for scripting objects. More...

#include <script3.h>

Inheritance diagram for ost::ScriptProperty:
Inheritance graph
[legend]
Collaboration diagram for ost::ScriptProperty:
Collaboration graph
[legend]

Public Types

enum  scrAccess {
  scrPUBLIC, scrPROTECTED, scrPRIVATE, scrFUNCTION,
  scrLOCAL
}
 
typedef enum scrAccess scrAccess
 
enum  symType {
  symNORMAL = 0, symCONST, symDYNAMIC, symFIFO,
  symSEQUENCE, symSTACK, symCOUNTER, symPOINTER,
  symREF, symARRAY, symASSOC, symINITIAL,
  symNUMBER, symLOCK, symPROPERTY, symORIGINAL,
  symMODIFIED, symTIMER, symBOOL
}
 
typedef enum symType symType
 
typedef bool(ScriptInterp::* Method )(void)
 
typedef const char
*(ScriptCommand::* 
Check )(Line *line, ScriptImage *img)
 
typedef bool(* Cond )(ScriptInterp *interp, const char *v)
 
typedef long(* Function )(long *args, unsigned prec)
 
typedef const char *(* Meta )(ScriptInterp *interp, const char *token)
 
typedef const char *(* Parse )(ScriptCompiler *img, const char *token)
 
typedef void(* Init )(void)
 
typedef struct ost::Script::_symbol Symbol
 
typedef struct ost::Script::_array Array
 

Public Member Functions

virtual void set (const char *data, char *temp, unsigned size)=0
 Set property method. More...
 
virtual unsigned prec (void)
 Precision for property type expressions. More...
 
virtual void setValue (char *data, unsigned short size, long value)
 Set property from integer value. More...
 
virtual bool isProperty (const char *data)
 See if should be computed as property. More...
 
virtual void clear (char *data, unsigned size=0)
 Initialize a new property through var definition. More...
 
virtual char token (void)
 Fetch a property specific seperator token. More...
 
virtual void adjust (char *data, size_t size, long adjustment)
 adjust value method. More...
 
virtual long adjustValue (long value)
 normalize values for scope and range. More...
 
virtual long getValue (const char *data)
 Get the "numeric" (or #var) value of this property symbol. More...
 
 ScriptProperty (const char *name)
 
virtual ~ScriptProperty ()
 

Static Public Member Functions

static ScriptPropertyfind (const char *name)
 
static bool isScript (Name *scr)
 
static bool isSymbol (const char *id)
 
static bool use (const char *name)
 
static unsigned getIndex (const char *id)
 
static Symbolderef (Symbol *sym)
 
static bool commit (Symbol *sym, const char *value)
 
static bool append (Symbol *sym, const char *value)
 
static bool symindex (Symbol *sym, short offset)
 
static const char * extract (Symbol *sym)
 
static unsigned count (Symbol *sym)
 
static unsigned storage (Symbol *sym)
 
static void clear (Symbol *sym)
 
static void addFunction (const char *name, unsigned count, Function i)
 
static void addConditional (const char *name, Cond test)
 
static bool isPrivate (Name *scr)
 
static bool isFunction (Name *scr)
 

Data Fields

class __EXPORT Line
 
class __EXPORT Name
 

Static Public Attributes

static bool fastStart
 
static bool useBigmem
 
static unsigned fastStepping
 
static unsigned autoStepping
 
static size_t pagesize
 
static unsigned symsize
 
static unsigned symlimit
 
static char decimal
 
static bool use_definitions
 
static bool use_macros
 
static bool use_prefix
 
static bool use_merge
 
static bool use_funcs
 
static const char * plugins
 
static const char * altplugins
 
static const char * access_user
 
static const char * access_pass
 
static const char * access_host
 
static bool exec_funcs
 
static const char * exec_extensions
 
static const char * exec_token
 
static const char * exec_prefix
 
static const char * exit_token
 
static const char * apps_extensions
 
static const char * apps_prefix
 
static const char * etc_prefix
 
static const char * var_prefix
 
static const char * log_prefix
 

Static Protected Attributes

static Testtest
 
static Funifun
 

Private Attributes

ScriptPropertynext
 
const char * id
 

Static Private Attributes

static ScriptPropertyfirst
 

Friends

class ScriptInterp
 

Detailed Description

This class is used for DSO modules that impliment property extensions for scripting objects.

Author
David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m ccScript property module

Definition at line 1692 of file script3.h.

Member Typedef Documentation

typedef struct ost::Script::_array ost::Script::Array
inherited
typedef const char*(ScriptCommand::* ost::Script::Check)(Line *line, ScriptImage *img)
inherited

Definition at line 106 of file script3.h.

typedef bool(* ost::Script::Cond)(ScriptInterp *interp, const char *v)
inherited

Definition at line 107 of file script3.h.

typedef long(* ost::Script::Function)(long *args, unsigned prec)
inherited

Definition at line 108 of file script3.h.

typedef void(* ost::Script::Init)(void)
inherited

Definition at line 111 of file script3.h.

typedef const char*(* ost::Script::Meta)(ScriptInterp *interp, const char *token)
inherited

Definition at line 109 of file script3.h.

typedef bool(ScriptInterp::* ost::Script::Method)(void)
inherited

Definition at line 105 of file script3.h.

typedef const char*(* ost::Script::Parse)(ScriptCompiler *img, const char *token)
inherited

Definition at line 110 of file script3.h.

typedef enum scrAccess ost::Script::scrAccess
inherited

Definition at line 121 of file script3.h.

typedef struct ost::Script::_symbol ost::Script::Symbol
inherited
typedef enum symType ost::Script::symType
inherited

Definition at line 145 of file script3.h.

Member Enumeration Documentation

enum ost::Script::scrAccess
inherited
Enumerator
scrPUBLIC 
scrPROTECTED 
scrPRIVATE 
scrFUNCTION 
scrLOCAL 

Definition at line 113 of file script3.h.

enum ost::Script::symType
inherited
Enumerator
symNORMAL 
symCONST 
symDYNAMIC 
symFIFO 
symSEQUENCE 
symSTACK 
symCOUNTER 
symPOINTER 
symREF 
symARRAY 
symASSOC 
symINITIAL 
symNUMBER 
symLOCK 
symPROPERTY 
symORIGINAL 
symMODIFIED 
symTIMER 
symBOOL 

Definition at line 123 of file script3.h.

Constructor & Destructor Documentation

ost::ScriptProperty::ScriptProperty ( const char *  name)
virtual ost::ScriptProperty::~ScriptProperty ( )
virtual

Member Function Documentation

static void ost::Script::addConditional ( const char *  name,
Cond  test 
)
staticinherited
static void ost::Script::addFunction ( const char *  name,
unsigned  count,
Function  i 
)
staticinherited
virtual void ost::ScriptProperty::adjust ( char *  data,
size_t  size,
long  adjustment 
)
virtual

adjust value method.

Performs inc.xxx conversions.

Parameters
databuffer to work from.
sizeof data buffer.
adjustmentoffset to apply.
virtual long ost::ScriptProperty::adjustValue ( long  value)
virtual

normalize values for scope and range.

Returns
noramized value.
Parameters
valueprior to normalization.
static bool ost::Script::append ( Symbol sym,
const char *  value 
)
staticinherited
static void ost::Script::clear ( Symbol sym)
staticinherited
virtual void ost::ScriptProperty::clear ( char *  data,
unsigned  size = 0 
)
virtual

Initialize a new property through var definition.

Returns
property value.
Parameters
datalocation to clear.
sizeof workspace to clear.
static bool ost::Script::commit ( Symbol sym,
const char *  value 
)
staticinherited
static unsigned ost::Script::count ( Symbol sym)
staticinherited
static Symbol* ost::Script::deref ( Symbol sym)
staticinherited
static const char* ost::Script::extract ( Symbol sym)
staticinherited
static ScriptProperty* ost::ScriptProperty::find ( const char *  name)
static
static unsigned ost::Script::getIndex ( const char *  id)
staticinherited
virtual long ost::ScriptProperty::getValue ( const char *  data)
virtual

Get the "numeric" (or #var) value of this property symbol.

Returns
numeric value of this property object.
Parameters
databeing examined from property object.
static bool ost::Script::isFunction ( Name scr)
staticinherited
static bool ost::Script::isPrivate ( Name scr)
staticinherited
virtual bool ost::ScriptProperty::isProperty ( const char *  data)
virtual

See if should be computed as property.

Returns
true if property valid.
Parameters
datastring to test.
static bool ost::Script::isScript ( Name scr)
staticinherited
static bool ost::Script::isSymbol ( const char *  id)
staticinherited
virtual unsigned ost::ScriptProperty::prec ( void  )
virtual

Precision for property type expressions.

Returns
precision.
virtual void ost::ScriptProperty::set ( const char *  data,
char *  temp,
unsigned  size 
)
pure virtual

Set property method.

Performs set.xxx and init.xxx methods.

Parameters
databuffer to work from.
tempworkspace buffer to use.
sizeof temp area.
virtual void ost::ScriptProperty::setValue ( char *  data,
unsigned short  size,
long  value 
)
virtual

Set property from integer value.

Parameters
datato save.
sizeof data.
valuebeing set.
static unsigned ost::Script::storage ( Symbol sym)
staticinherited
static bool ost::Script::symindex ( Symbol sym,
short  offset 
)
staticinherited
virtual char ost::ScriptProperty::token ( void  )
virtual

Fetch a property specific seperator token.

Returns
seperator token used in foreach loops...
static bool ost::Script::use ( const char *  name)
staticinherited

Friends And Related Function Documentation

friend class ScriptInterp
friend

Definition at line 1695 of file script3.h.

Field Documentation

const char* ost::Script::access_host
staticinherited

Definition at line 285 of file script3.h.

const char* ost::Script::access_pass
staticinherited

Definition at line 284 of file script3.h.

const char* ost::Script::access_user
staticinherited

Definition at line 283 of file script3.h.

const char* ost::Script::altplugins
staticinherited

Definition at line 282 of file script3.h.

const char* ost::Script::apps_extensions
staticinherited

Definition at line 291 of file script3.h.

const char* ost::Script::apps_prefix
staticinherited

Definition at line 292 of file script3.h.

unsigned ost::Script::autoStepping
staticinherited

Definition at line 258 of file script3.h.

char ost::Script::decimal
staticinherited

Definition at line 275 of file script3.h.

const char* ost::Script::etc_prefix
staticinherited

Definition at line 294 of file script3.h.

const char* ost::Script::exec_extensions
staticinherited

Definition at line 287 of file script3.h.

bool ost::Script::exec_funcs
staticinherited

Definition at line 286 of file script3.h.

const char* ost::Script::exec_prefix
staticinherited

Definition at line 289 of file script3.h.

const char* ost::Script::exec_token
staticinherited

Definition at line 288 of file script3.h.

const char* ost::Script::exit_token
staticinherited

Definition at line 290 of file script3.h.

bool ost::Script::fastStart
staticinherited

Definition at line 255 of file script3.h.

unsigned ost::Script::fastStepping
staticinherited

Definition at line 257 of file script3.h.

ScriptProperty* ost::ScriptProperty::first
staticprivate

Definition at line 1697 of file script3.h.

const char* ost::ScriptProperty::id
private

Definition at line 1699 of file script3.h.

Fun* ost::Script::ifun
staticprotectedinherited

Definition at line 306 of file script3.h.

class __EXPORT ost::Script::Line
inherited

Definition at line 102 of file script3.h.

const char* ost::Script::log_prefix
staticinherited

Definition at line 296 of file script3.h.

class __EXPORT ost::Script::Name
inherited

Definition at line 103 of file script3.h.

ScriptProperty* ost::ScriptProperty::next
private

Definition at line 1698 of file script3.h.

size_t ost::Script::pagesize
staticinherited

Definition at line 259 of file script3.h.

const char* ost::Script::plugins
staticinherited

Definition at line 281 of file script3.h.

unsigned ost::Script::symlimit
staticinherited

Definition at line 261 of file script3.h.

unsigned ost::Script::symsize
staticinherited

Definition at line 260 of file script3.h.

Test* ost::Script::test
staticprotectedinherited

Definition at line 305 of file script3.h.

bool ost::Script::use_definitions
staticinherited

Definition at line 276 of file script3.h.

bool ost::Script::use_funcs
staticinherited

Definition at line 280 of file script3.h.

bool ost::Script::use_macros
staticinherited

Definition at line 277 of file script3.h.

bool ost::Script::use_merge
staticinherited

Definition at line 279 of file script3.h.

bool ost::Script::use_prefix
staticinherited

Definition at line 278 of file script3.h.

bool ost::Script::useBigmem
staticinherited

Definition at line 256 of file script3.h.

const char* ost::Script::var_prefix
staticinherited

Definition at line 295 of file script3.h.


The documentation for this class was generated from the following file: