XTernalizer Class Reference

Collaboration diagram for XTernalizer:

Class Description

---

This virtual class is used by classes derived from ConfigurationPlugin to convert external string to internal values and vice versa, and for parsing lists of values from an external string.

Class ConfigurationPlugin owns a default object with field defaultStringConverter which by default points to field StringConverter.

Note

Replacing the converters is deemed to be an advanced usage of ALib. Consult the source code for detailed information about how to implement an application specific converter.

This default implementation proceeds as follows:

• "Externalizing" a value:
  • Value is surrounded by quotes if it starts or ends with spaces or if it includes the delimiter token.
  • A few characters are escaped using '\'. Those are \n, \r, \t , \a, \b, \v, \f, \e and also the double quotation marks \" and the backslash itself (\\).
• "Internalizing" a value:
  • If (non-escaped) quote " characters are found, those are removed and whitespaces within such quotes are kept.
  • Escaped characters are converted to their original value.
• Loading variables from external strings:
  • If provided variable has a valid delimiter set, this character is used to tokenize the external string.
  • Values are trimmed, unless quoted. Quotes characters themselves are removed.
  • Delimiters found within a pair of quotes are ignored.
  • Each value found is internalized separately

Public Methods
virtual void	ExternalizeValue (Object src, AString dest, char delim)
virtual void	InternalizeValue (Substring src, AString dest)
virtual void	LoadFromString (Variable variable, Object src)

Protected Fields
AString	tmpAS = new AString()
Substring	tmpSubs = new Substring()
Substring	tmpSubs2 = new Substring()

Member Function Documentation

ExternalizeValue()

virtual void ExternalizeValue ( Object  src, AString  dest, char  delim  )

inlinevirtual

---

Converts the given src string to an external representation.

Parameters

src	The source string
dest	The destination string
delim	If this character is found in the string, the value is quoted

InternalizeValue()

virtual void InternalizeValue ( Substring  src, AString  dest  )

inlinevirtual

---

Trims src, removes surrounding quotes and , un-escapes characters.

Parameters

src	The source string
dest	The destination string

LoadFromString()

virtual void LoadFromString ( Variable  variable, Object  src  )

inlinevirtual

---

If field Variable::Delim is '\0', just invokes InternalizeValue. Otherwise, parses values using the delimiter. Quotes are removed and parts within quotes are kept as is. Also, delimiters in quotes are ignored.

Parameters

variable	The destination variable.
src	The source string

Member Data Documentation

tmpAS

AString tmpAS = new AString()

protected

a reusable AString

tmpSubs

Substring tmpSubs = new Substring()

protected

a reusable Substring

tmpSubs2

Substring tmpSubs2 = new Substring()

protected

a reusable Substring

---

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

• ConfigurationPlugin.cs