Helper class to declare a native function. More...

#include <yatescript.h>

Inheritance diagram for ExpFunction:

Public Member Functions
	ExpFunction (const char *name, long int argc=0, bool barrier=false)

virtual bool	valBoolean (bool defVal=false) const

virtual ExpOperation *	clone (const char *name) const

Public Member Functions inherited from ExpOperation
	ExpOperation (const ExpOperation &original)

	ExpOperation (const ExpOperation &original, const char *name, bool copyType=true)

	ExpOperation (const String &value, const char *name=0, bool autoNum=false)

	ExpOperation (const char value, const char name=0)

	ExpOperation (int64_t value, const char *name=0)

	ExpOperation (bool value, const char *name=0)

	ExpOperation (ExpEvaluator::Opcode oper, const char *name=0, int64_t value=nonInteger(), bool barrier=false)

	ExpOperation (ExpEvaluator::Opcode oper, const char name, const char value, bool barrier=false)

	ExpOperation (ExpEvaluator::Opcode oper, const char name, const char value, int64_t number, bool barrier)

ExpEvaluator::Opcode	opcode () const

bool	isInteger () const

int64_t	number () const

bool	isBoolean () const

bool	isNumber () const

bool	barrier () const

unsigned int	lineNumber () const

void	lineNumber (unsigned int line)

int64_t	operator= (int64_t num)

virtual int64_t	valInteger (int64_t defVal=0) const

virtual int64_t	toNumber () const

virtual const char *	typeOf () const

ExpOperation *	clone () const

virtual ExpOperation *	copy (ScriptMutex *mtx) const

Public Member Functions inherited from NamedString
	NamedString (const char name, const char value=0)

const String &	name () const

virtual const String &	toString () const

virtual void *	getObject (const String &name) const

NamedString &	operator= (const char *value)

Public Member Functions inherited from String
	String ()

	String (const char *value, int len=-1)

	String (char value, unsigned int repeat=1)

	String (int32_t value)

	String (uint32_t value)

	String (int64_t value)

	String (uint64_t value)

	String (bool value)

	String (double value)

	String (const String &value)

	String (const String *value)

virtual	~String ()

const char *	c_str () const

const char *	safe () const

const char *	safe (const char *defStr) const

unsigned int	length () const

bool	null () const

int	lenUtf8 (uint32_t maxChar=0x10ffff, bool overlong=false) const

int	fixUtf8 (const char *replace=0, uint32_t maxChar=0x10ffff, bool overlong=false)

unsigned int	encodeFlags (const TokenDict *tokens) const

uint64_t	encodeFlags (const TokenDict64 *tokens) const

const String &	decodeFlags (unsigned int flags, const TokenDict *tokens, bool unknownflag=true)

const String &	decodeFlags (uint64_t flags, const TokenDict64 *tokens, bool unknownflag=true)

bool	checkBOM () const

bool	stripBOM ()

unsigned int	hash () const

void	clear ()

char	at (int index) const

String	substr (int offs, int len=-1) const

String &	trimBlanks ()

String &	trimSpaces ()

int	toInteger (int defvalue=0, int base=0, int minvalue=INT_MIN, int maxvalue=INT_MAX, bool clamp=true) const

int	toInteger (const TokenDict *tokens, int defvalue=0, int base=0) const

long int	toLong (long int defvalue=0, int base=0, long int minvalue=LONG_MIN, long int maxvalue=LONG_MAX, bool clamp=true) const

int64_t	toInt64 (int64_t defvalue=0, int base=0, int64_t minvalue=LLONG_MIN, int64_t maxvalue=LLONG_MAX, bool clamp=true) const

uint64_t	toUInt64 (uint64_t defvalue=0, int base=0, uint64_t minvalue=0, uint64_t maxvalue=ULLONG_MAX, bool clamp=true) const

double	toDouble (double defvalue=0.0) const

bool	toBoolean (bool defvalue=false) const

bool	isBoolean () const

String &	toUpper ()

String &	toLower ()

char	operator[] (signed int index) const

char	operator[] (unsigned int index) const

	operator const char * () const

String &	assign (const char *value, int len=-1)

String &	assign (char value, unsigned int repeat=1)

String &	hexify (void *data, unsigned int len, char sep=0, bool upCase=false)

String &	operator= (const String &value)

String &	operator= (const String *value)

String &	operator= (const char *value)

String &	operator= (char value)

String &	operator= (int32_t value)

String &	operator= (uint32_t value)

String &	operator= (int64_t value)

String &	operator= (uint64_t value)

String &	operator= (bool value)

String &	operator= (double value)

String &	operator+= (const char *value)

String &	operator+= (char value)

String &	operator+= (int32_t value)

String &	operator+= (uint32_t value)

String &	operator+= (int64_t value)

String &	operator+= (uint64_t value)

String &	operator+= (bool value)

String &	operator+= (double value)

bool	operator== (const char *value) const

bool	operator!= (const char *value) const

bool	operator== (const String &value) const

bool	operator!= (const String &value) const

bool	operator&= (const char *value) const

bool	operator\|= (const char *value) const

String &	operator<< (const char *value)

String &	operator<< (char value)

String &	operator<< (int32_t value)

String &	operator<< (uint32_t value)

String &	operator<< (int64_t value)

String &	operator<< (uint64_t value)

String &	operator<< (bool value)

String &	operator<< (double value)

String &	operator>> (const char *skip)

String &	operator>> (char &store)

String &	operator>> (UChar &store)

String &	operator>> (int &store)

String &	operator>> (unsigned int &store)

String &	operator>> (bool &store)

String &	append (const char *value, int len)

String &	append (const char value, const char separator=0, bool force=false)

String &	append (const ObjList list, const char separator=0, bool force=false)

String &	append (const ObjList &list, const char *separator=0, bool force=false)

String &	append (double value, unsigned int decimals=3)

String &	printf (const char *format,...)

String &	printf (unsigned int length, const char *format,...)

String &	appendFixed (unsigned int fixedLength, const char *str, unsigned int len=-1, char fill=' ', int align=Left)

String &	appendFixed (unsigned int fixedLength, const String &str, char fill=' ', int align=Left)

int	find (char what, unsigned int offs=0) const

int	find (const char *what, unsigned int offs=0) const

int	rfind (char what) const

int	rfind (const char *what) const

bool	startsWith (const char *what, bool wordBreak=false, bool caseInsensitive=false) const

bool	endsWith (const char *what, bool wordBreak=false, bool caseInsensitive=false) const

bool	startSkip (const char *what, bool wordBreak=true, bool caseInsensitive=false)

String &	extractTo (const char *sep, String &store)

String &	extractTo (const char *sep, bool &store)

String &	extractTo (const char *sep, int &store, int base=0)

String &	extractTo (const char sep, int &store, const TokenDict tokens, int base=0)

String &	extractTo (const char *sep, double &store)

virtual bool	matches (const String &value) const

bool	matches (const Regexp &rexp)

int	matchOffset (int index=0) const

int	matchLength (int index=0) const

String	matchString (int index=0) const

String	replaceMatches (const String &templ) const

int	matchCount () const

ObjList *	split (char separator, bool emptyOK=true) const

ObjList *	split (const Regexp &reg, bool emptyOK=true) const

String	msgEscape (char extraEsc=0) const

String	msgUnescape (int *errptr=0, char extraEsc=0) const

String	sqlEscape (char extraEsc=0) const

String	uriEscape (char extraEsc=0, const char *noEsc=0) const

String	uriUnescape (int *errptr=0) const

Public Member Functions inherited from GenObject
	GenObject ()

virtual	~GenObject ()

virtual bool	alive () const

virtual void	destruct ()

virtual const String &	traceId () const

NamedCounter *	getObjCounter () const

NamedCounter *	setObjCounter (NamedCounter *counter)

Additional Inherited Members
Public Types inherited from String
enum	Align { Left = 0 , Center , Right }

Static Public Member Functions inherited from ExpOperation
static int64_t	nonInteger ()

Static Public Member Functions inherited from String
static const String &	empty ()

static const char *	boolText (bool value)

static int	lenUtf8 (const char *value, uint32_t maxChar=0x10ffff, bool overlong=false)

static bool	checkBOM (const char *str)

static bool	stripBOM (const char *&str)

static bool	stripBOM (char *&str)

static unsigned int	hash (const char *value, unsigned int h=0)

static String	msgEscape (const char *str, char extraEsc=0)

static String	msgUnescape (const char str, int errptr=0, char extraEsc=0)

static String	sqlEscape (const char *str, char extraEsc=0)

static String	uriEscape (const char str, char extraEsc=0, const char noEsc=0)

static String	uriEscape (const char str, const char extraEsc, const char *noEsc=0)

static String	uriUnescape (const char str, int errptr=0)

static const String *	atom (const String &str, const char val)

Static Public Member Functions inherited from GenObject
static void *	getObject (const String &name, const GenObject *obj)

static bool	getObjCounting ()

static void	setObjCounting (bool enable)

static NamedCounter *	getObjCounter (const String &name, bool create=true)

static ObjList &	getObjCounters ()

Protected Member Functions inherited from String
virtual void	changed ()

Detailed Description

Helper class to declare a native function.

Small helper class that simplifies declaring native functions

Constructor & Destructor Documentation

◆ ExpFunction()

ExpFunction	(	const char *	name,
		long int	argc = 0,
		bool	barrier = false )

inline

Constructor

Parameters

name	Name of the function
argc	Number of arguments expected by function
barrier	True if the function is an expression barrier on the stack

References ExpOperation::barrier(), ExpOperation::ExpOperation(), and NamedString::name().

Member Function Documentation

◆ clone()

virtual ExpOperation * clone ( const char * name ) const

virtual

Clone and rename method

Parameters

name	Name of the cloned operation

Returns: New operation instance

Reimplemented from ExpOperation.

References ExpOperation::ExpOperation(), and NamedString::name().

◆ valBoolean()

virtual bool valBoolean ( bool defVal = false ) const

inlinevirtual

Retrieve the boolean value of the function (not of its result)

Parameters

defVal Parameter ignored

Returns: Always true

Reimplemented from ExpOperation.

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

yatescript.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExpFunction()

Member Function Documentation

◆ clone()

◆ valBoolean()