Yate
MatchingItemLoad Class Reference

Matching item load parameters. More...

#include <yateclass.h>

Inheritance diagram for MatchingItemLoad:
String GenObject

Public Types

enum  LoadFlags {
  RexBasic = 0x00000001 , RexDetect = 0x00000002 , RexDetectNegated = 0x00000004 , RexValidate = 0x00000008 ,
  NameReqSimple = 0x00000010 , IgnoreFailed = 0x00000020 , ListAny = 0x00000040 , PrivateFlag = 0x100000000 ,
  DefaultFlags = RexDetect | RexDetectNegated | NameReqSimple
}
 
enum  ItemFlags {
  ItemNegated = 0x00000001 , ItemCaseInsensitive = 0x00000002 , ItemBasic = 0x00000004 , ItemAny = 0x00000008 ,
  ItemPrivateFlag = 0x00010000
}
 
- Public Types inherited from String
enum  Align { Left = 0 , Center , Right }
 

Public Member Functions

 MatchingItemLoad (uint64_t flags=DefaultFlags, const char *name=0)
 
virtual MatchingItemBaseload (const NamedList &params, String *error=0, const char *prefix=0, const char *suffix=0) const
 
virtual MatchingItemBaseloadXml (const String &str, String *error=0) const
 
virtual MatchingItemBaseloadXml (const GenObject *gen, String *error=0) const
 
- 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 ()
 
virtual void * getObject (const String &name) const
 
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
 
StringdecodeFlags (unsigned int flags, const TokenDict *tokens, bool unknownflag=true)
 
StringdecodeFlags (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
 
StringtrimBlanks ()
 
StringtrimSpaces ()
 
virtual const StringtoString () const
 
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
 
int toInteger (const TokenDictStr *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
 
int64_t toInt64Dict (const TokenDict64 *tokens, int64_t defvalue=0, int base=0) const
 
int64_t toInt64Dict (const TokenDictStr64 *tokens, int64_t defvalue=0, int base=0) 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
 
StringtoUpper ()
 
StringtoLower ()
 
char operator[] (signed int index) const
 
char operator[] (unsigned int index) const
 
 operator const char * () const
 
Stringassign (const char *value, int len=-1)
 
Stringassign (char value, unsigned int repeat=1)
 
Stringhexify (const void *data, unsigned int len, char sep=0, bool upCase=false)
 
Stringoperator= (const String &value)
 
Stringoperator= (const String *value)
 
Stringoperator= (const char *value)
 
Stringoperator= (char value)
 
Stringoperator= (int32_t value)
 
Stringoperator= (uint32_t value)
 
Stringoperator= (int64_t value)
 
Stringoperator= (uint64_t value)
 
Stringoperator= (bool value)
 
Stringoperator= (double value)
 
Stringoperator+= (const char *value)
 
Stringoperator+= (char value)
 
Stringoperator+= (int32_t value)
 
Stringoperator+= (uint32_t value)
 
Stringoperator+= (int64_t value)
 
Stringoperator+= (uint64_t value)
 
Stringoperator+= (bool value)
 
Stringoperator+= (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
 
Stringoperator<< (const char *value)
 
Stringoperator<< (char value)
 
Stringoperator<< (int32_t value)
 
Stringoperator<< (uint32_t value)
 
Stringoperator<< (int64_t value)
 
Stringoperator<< (uint64_t value)
 
Stringoperator<< (bool value)
 
Stringoperator<< (double value)
 
Stringoperator>> (const char *skip)
 
Stringoperator>> (char &store)
 
Stringoperator>> (UChar &store)
 
Stringoperator>> (int &store)
 
Stringoperator>> (unsigned int &store)
 
Stringoperator>> (bool &store)
 
Stringappend (const char *value, int len)
 
Stringappend (const char *value, const char *separator=0, bool force=false)
 
Stringappend (const ObjList *list, const char *separator=0, bool force=false)
 
Stringappend (const ObjList &list, const char *separator=0, bool force=false)
 
Stringappend (char value, unsigned int len=1)
 
Stringappend (double value, unsigned int decimals=3)
 
Stringinsert (unsigned int pos, const char *value, int len=-1)
 
Stringinsert (unsigned int pos, char value, unsigned int len=1)
 
Stringprintf (const char *format,...)
 
Stringprintf (unsigned int length, const char *format,...)
 
StringprintfAppend (const char *format,...)
 
StringprintfAppend (unsigned int length, const char *format,...)
 
StringappendFixed (unsigned int fixedLength, const char *str, unsigned int len=-1, char fill=' ', int align=Left)
 
StringappendFixed (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)
 
StringreplaceChars (const char *what, const char *repl, bool inPlace=false, int wLen=-1, int rLen=-1, bool *chg=0)
 
StringremoveChars (const char *what, int wLen=-1, bool *chg=0)
 
StringextractTo (const char *sep, String &store)
 
StringextractTo (const char *sep, bool &store)
 
StringextractTo (const char *sep, int &store, int base=0)
 
StringextractTo (const char *sep, int &store, const TokenDict *tokens, int base=0)
 
StringextractTo (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
 
ObjListsplit (ObjList &list, char separator, bool emptyOK=true) const
 
ObjListsplit (ObjList &list, const Regexp &reg, bool emptyOK=true) const
 
ObjListsplit (char separator, bool emptyOK=true) const
 
ObjListsplit (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
 
StringuriEscapeTo (String &buf, char extraEsc=0, const char *noEsc=0) const
 
String uriEscape (char extraEsc=0, const char *noEsc=0) const
 
StringuriUnescapeTo (String &buf, bool setPartial=false, int *errptr=0) const
 
StringuriUnescapeStr (bool setPartial=false, int *errptr=0)
 
String uriUnescape (int *errptr=0, bool setPartial=true) const
 
- Public Member Functions inherited from GenObject
 GenObject ()
 
virtual ~GenObject ()
 
virtual bool alive () const
 
virtual void destruct ()
 
virtual const StringtraceId () const
 
NamedCountergetObjCounter () const
 
NamedCountersetObjCounter (NamedCounter *counter)
 

Static Public Member Functions

static const TokenDict64loadFlags ()
 
static const TokenDictitemFlags ()
 
- Static Public Member Functions inherited from String
static const Stringempty ()
 
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 StringuriEscapeTo (String &buf, const char *str, char extraEsc=0, const char *noEsc=0)
 
static StringuriEscapeTo (String &buf, const char *str, const char *extraEsc, const char *noEsc=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 StringuriUnescapeTo (String &buf, const char *str, bool setPartial=false, int *errptr=0)
 
static String uriUnescape (const char *str, int *errptr=0, bool setPartial=true)
 
static const Stringatom (const String *&str, const char *val)
 
static unsigned int c_starts_with (const char *str, const char *what, int lenStr=-1, int lenWhat=-1, bool caseInsensitive=false)
 
static unsigned int c_ends_with (const char *str, const char *what, int lenStr=-1, int lenWhat=-1, bool caseInsensitive=false)
 
static unsigned int c_skip (const char *&str, const char *what, int lenStr=-1, int lenWhat=-1, bool caseInsensitive=false)
 
static unsigned int c_skip_chars (const char *&str, const char *what, int len=-1, bool skipFound=true)
 
static char * c_replace_chars (const char *str, const char *what, const char *repl=0, bool inPlace=false, int wLen=-1, int rLen=-1, bool *chg=0)
 
- 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 NamedCountergetObjCounter (const String &name, bool create=true)
 
static ObjListgetObjCounters ()
 

Public Attributes

uint64_t m_flags
 
ObjListm_ignore
 
ObjListm_allow
 
DebugEnablerm_dbg
 

Additional Inherited Members

- Protected Member Functions inherited from String
virtual void changed ()
 

Detailed Description

Matching item load parameters.

This class holds matching item load parameters

Member Enumeration Documentation

◆ ItemFlags

enum ItemFlags

Item flags

◆ LoadFlags

enum LoadFlags

Load behaviour flags

Constructor & Destructor Documentation

◆ MatchingItemLoad()

MatchingItemLoad ( uint64_t flags = DefaultFlags,
const char * name = 0 )
inline

Constructor

Parameters
flagsOptional load flags
nameOptional name

Member Function Documentation

◆ itemFlags()

static const TokenDict * itemFlags ( )
static

Retrieve item flags dictionary

Returns
TokenDict pointer

◆ load()

virtual MatchingItemBase * load ( const NamedList & params,
String * error = 0,
const char * prefix = 0,
const char * suffix = 0 ) const
virtual

Load matching item(s) Parameters prefix is formed from 'prefix' + ':' + our_string + ':' + 'suffix'

Parameters
paramsParameters list
errorOptional pointer to error string
prefixOptional parameters prefix
suffixOptional parameters suffix
Returns
MatchingItemBase pointer, NULL if none loaded

◆ loadFlags()

static const TokenDict64 * loadFlags ( )
static

Retrieve load flags dictionary

Returns
TokenDict64 pointer

◆ loadXml() [1/2]

virtual MatchingItemBase * loadXml ( const GenObject * gen,
String * error = 0 ) const
virtual

Load matching item(s) from XML description

Parameters
genXmlElement object
errorOptional pointer to error string
Returns
MatchingItemBase pointer, NULL if none loaded

◆ loadXml() [2/2]

virtual MatchingItemBase * loadXml ( const String & str,
String * error = 0 ) const
virtual

Load matching item(s) from XML description

Parameters
strXML string
errorOptional pointer to error string
Returns
MatchingItemBase pointer, NULL if none loaded

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