pluginbase.Helpers.Data.TokenizedString Class Reference

Fast implementation of a string tokenizer. Tokens exist like {token} More...

Inheritance diagram for pluginbase.Helpers.Data.TokenizedString:

Public Member Functions
	TokenizedString (string str)
	Create a tokenized string from a normal string More...
bool	SetToken (string token, string val)
	Sets a token in the instance of a string to a value More...
bool	SetToken (string token, object val)
	Sets a token in the instance of the string. More...
bool	SetToken (string token, string format, params object[] args)
	Helper: Sets a token to the formatted string More...
int	SetTokens (IDictionary< string, object > vals)
	Sets tokens given a dictionary of items More...
void	ClearTokens ()
	Reset all tokens to be empty string More...

Static Public Member Functions
static string	Render (string str, IDictionary< string, object > tokens)
	Helper method to render a new string, given one with tokens, and a mapping dictionary More...
static string	Render (string str, object model)
	Render helper to create a string from a tokenized one and an anonymous model More...

Public Attributes
readonly string	OriginalString
	The original string with tokens intact More...

Properties
int	Segments [get]
	The total number of token segments More...
int	TokenCount [get]
	The total number of replaceable tokens More...
IEnumerable< string >	Tokens [get]
	An enumerable representing the token names More...

Detailed Description

Fast implementation of a string tokenizer. Tokens exist like {token}

Constructor & Destructor Documentation

TokenizedString()

pluginbase.Helpers.Data.TokenizedString.TokenizedString

(

string

str

)

Create a tokenized string from a normal string

Parameters

str

String.

Attribute: i

;

Attribute: i + 1

: (char)0;

Attribute: parts[0]

= new Token

Attribute: 1

: null

        {
            if (str == null)
                throw new ArgumentNullException("str");

            this.OriginalString = str;
            this._builder.Capacity = this.OriginalString.Length;

            var tokens = new List<string>();
            var sb = new StringBuilder(this.OriginalString.Length);

            bool isToken = false;
            for (int i = 0; i<str.Length; ++i)
            {
                char c = str[i];
                char cNext = i < str.Length - 1 ? str[i + 1] : (char)0;

                if (c == T_OPEN && cNext == T_OPEN)
                {
                    sb.Append(c);
                    ++i;
                }
                else if(c == T_OPEN)
                {
                    if (isToken)
                        throw new FormatException("Token already open. Can't have a token in a token");

                    isToken = true;
                    if (sb.Length > 0)
                        tokens.Add(sb.ToString());
                    sb.Clear();
                }
                else if (c == T_CLOSE && cNext == T_CLOSE)
                {
                    sb.Append(c);
                    ++i;
                }
                else if (c == T_CLOSE)
                {
                    if (!isToken)
                        throw new FormatException("Token was closed, but never opened");
                    if (sb.Length == 0)
                        throw new FormatException("Empty token not valid");

                    isToken = false;
                    tokens.Add(string.Empty);

                    string[] parts = sb.ToString().Split(':');
                    _tokenPositions[parts[0]] = new Token
                    {
                        Pos = tokens.Count - 1,
                        Format = parts.Length >= 2 ? parts[1] : null
                    };
                    sb.Clear();
                }
                else
                {
                    sb.Append(c);
                }
            }

            if (isToken)
                throw new FormatException("Token open but was never closed");

            //End
            if (sb.Length > 0)
                tokens.Add(sb.ToString());

            _tokens = tokens.ToArray();
        }

Member Function Documentation

ClearTokens()

void pluginbase.Helpers.Data.TokenizedString.ClearTokens

(

)

Reset all tokens to be empty string

Attribute: item.Pos

= string.Empty;

        {
            foreach(var item in _tokenPositions.Values)
            {
                _tokens[item.Pos] = string.Empty;
            }
        }

Render() [1/2]

static string pluginbase.Helpers.Data.TokenizedString.Render ( string  str, IDictionary< string, object >  tokens  )

static

Helper method to render a new string, given one with tokens, and a mapping dictionary

Parameters

str	String.
tokens	Tokens.

        {
            var s = new TokenizedString(str);
            s.SetTokens(tokens);
            return s.ToString();
        }

Render() [2/2]

static string pluginbase.Helpers.Data.TokenizedString.Render ( string  str, object  model  )

static

Render helper to create a string from a tokenized one and an anonymous model

Parameters

str	String.
model	Model.

Attribute: prop.Name

= prop.GetValue(model, null);

        {
            var dict = new Dictionary<string, object>();
            foreach(var prop in model.GetType().GetProperties(BindingFlags.Public | BindingFlags.Instance))
            {
                dict[prop.Name] = prop.GetValue(model, null);
            }
            return Render(str, dict);
        }

SetToken() [1/3]

bool pluginbase.Helpers.Data.TokenizedString.SetToken	(	string	token,
		string	val
	)

Sets a token in the instance of a string to a value

Returns

true, if token was set, false otherwise.

Parameters

token	Token.
val	Value.

Attribute: tok.Pos

= val;

        {
            Token tok;
            if (_tokenPositions.TryGetValue(token, out tok))
            {
                _tokens[tok.Pos] = val;
                return true;
            }
            return false;
        }

SetToken() [2/3]

bool pluginbase.Helpers.Data.TokenizedString.SetToken	(	string	token,
		object	val
	)

Sets a token in the instance of the string.

Returns

true, if token was set, false otherwise.

Parameters

token	Token.
val	Value.

Attribute: tok.Pos

= formattable.ToString(tok.Format, null);

Attribute: tok.Pos

= val.ToString();

        {
            Token tok;
            if (_tokenPositions.TryGetValue(token, out tok))
            {
                IFormattable formattable;
                if (tok.Format != null && (formattable = val as IFormattable) != null)
                    _tokens[tok.Pos] = formattable.ToString(tok.Format, null);
                else
                    _tokens[tok.Pos] = val.ToString();
                return true;
            }
            return false;
        }

SetToken() [3/3]

bool pluginbase.Helpers.Data.TokenizedString.SetToken	(	string	token,
		string	format,
		params object []	args
	)

Helper: Sets a token to the formatted string

Returns

true, if token was set, false otherwise.

Parameters

token	Token.
format	Format.
args	Arguments.

        {
            return this.SetToken(token, string.Format(format, args));
        }

SetTokens()

int pluginbase.Helpers.Data.TokenizedString.SetTokens

(

IDictionary< string, object >

vals

)

Sets tokens given a dictionary of items

Returns

The tokens.

Parameters

vals

Vals.

        {
            int count = 0;
            foreach(var item in vals)
            {
                if (this.SetToken(item.Key, item.Value))
                    count++;
            }
            return count;
        }

Member Data Documentation

OriginalString

readonly string pluginbase.Helpers.Data.TokenizedString.OriginalString

The original string with tokens intact

Property Documentation

Segments

int pluginbase.Helpers.Data.TokenizedString.Segments

get

The total number of token segments

The segments.

TokenCount

int pluginbase.Helpers.Data.TokenizedString.TokenCount

get

The total number of replaceable tokens

The token count.

Tokens

IEnumerable<string> pluginbase.Helpers.Data.TokenizedString.Tokens

get

An enumerable representing the token names

The tokens.

---

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

• pluginbase/Helpers/Data/TokenizedString.cs