Difference between revisions of "ObjectType:string"
Jump to navigation
Jump to search
| (3 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
== Description == | == Description == | ||
A string, also known as <tt>text</tt> is a series of consecutive characters. | A string, also known as <tt>text</tt> is a series of consecutive characters. | ||
| + | |||
== Members == | == Members == | ||
| Line 23: | Line 24: | ||
* [[DataType:string|string]] '''EscapeQuotes''': Uses slashes to escape '''"''' only | * [[DataType:string|string]] '''EscapeQuotes''': Uses slashes to escape '''"''' only | ||
* [[DataType:string|string]] '''Replace['''character''','''with''',...]''': Performs single-character replacement with any number of character pairs | * [[DataType:string|string]] '''Replace['''character''','''with''',...]''': Performs single-character replacement with any number of character pairs | ||
| + | * [[DataType:string|string]] '''ReplaceSubstring['''needle''','''replacement''']''': Performs in-place replacement of a needle in a haystack. For example, <tt>${String[abcdefg].ReplaceSubstring[def,xyz]}</tt> is <tt>abcxyzg</tt> | ||
* [[ObjectType:byte|byte]] '''GetAt['''#''']''': Retrieves a character at the #th position in the string (1-based) | * [[ObjectType:byte|byte]] '''GetAt['''#''']''': Retrieves a character at the #th position in the string (1-based) | ||
| − | * [[ | + | * [[ObjectType:unistring|unistring]] '''UniString''': |
* [[DataType:string|string]] '''URLEncode''': Returns a %u encoded version of the string, suitable for urls | * [[DataType:string|string]] '''URLEncode''': Returns a %u encoded version of the string, suitable for urls | ||
* [[ObjectType:bool|bool]] '''NotNULLOrEmpty''': TRUE if the string is not empty and does not contain the literal NULL. This provides a shortcut for: <tt>if ${MyString.Length} && !${MyString.Equals[NULL]}</tt> | * [[ObjectType:bool|bool]] '''NotNULLOrEmpty''': TRUE if the string is not empty and does not contain the literal NULL. This provides a shortcut for: <tt>if ${MyString.Length} && !${MyString.Equals[NULL]}</tt> | ||
| + | * [[ObjectType:string|string]] '''Trim''': Returns a copy of the string with no leading or trailing whitespace | ||
| + | * [[ObjectType:string|string]] '''AsJSON''': Returns a JSON encoded version of the string, including surrounding quotes | ||
== Methods == | == Methods == | ||
''(none)'' | ''(none)'' | ||
| + | |||
== Declaring string Variables == | == Declaring string Variables == | ||
*Any string '''variable''' is automatically a [[DataType:mutablestring|mutablestring]] | *Any string '''variable''' is automatically a [[DataType:mutablestring|mutablestring]] | ||
*variable string Food="Pizza" | *variable string Food="Pizza" | ||
| + | |||
== Comparing Strings == | == Comparing Strings == | ||
| Line 42: | Line 48: | ||
echo We're both named fred! | echo We're both named fred! | ||
} | } | ||
| + | |||
== See Also == | == See Also == | ||
{{LavishScript:ObjectType}} | {{LavishScript:ObjectType}} | ||
Latest revision as of 00:46, 24 July 2020
| string | |
| Defined By | LavishScript |
| Inherits | none |
| Reduces To | the stored text |
| Variable Object Type | mutablestring |
| Uses Sub-Types | no |
| C/C++ Type | const char * |
Contents
Description
A string, also known as text is a series of consecutive characters.
Members
- string Mid[position,length]: Returns a string containing the given length at the given position (1-based) of the original string
- string Left[#]: Returns a string containing the leftmost # characters of the original string. A negative number can be used to give the leftmost (Length-#)
- string Right[#]: Returns a string containing the rightmost # characters of the original string. A negative number can be used to give the rightmost (Length-#)
- int Find[text]: Returns the 1-based position of a given substring in the original string, or NULL
- int Length: Returns the length of the string
- string Upper: Returns a string containing the original string in all upper case
- string Lower: Returns a string containing the original string in all lower case
- int Compare[text]: Compares this string, without regards to case, to the given text. Return value is less than 0 if the text would come before it in the dictionary, 0 if it is equal, or greater than 0 if the text would come after the string
- int CompareCS[text]: Compares this string, with regards to case, to the given text. Return value is less than 0 if the text would come before it in the dictionary, 0 if it is equal, or greater than 0 if the text would come after the string
- bool Equal[text]: TRUE if the string is equal to, without regards to case, the given text
- bool NotEqual[text]: TRUE if the string is not equal to, without regards to case, the given text
- bool EqualCS[text]: TRUE if the string is equal to, with regards to case, the given text
- bool NotEqualCS[text]: TRUE if the string is not equal to, with regards to case, the given text
- int Count[char]: The number of times a specific character appears in the string
- string Token[#,separator]: "Tokenizes" the string by the given separator and returns the #th token
- string Escape: Uses slashes to escape \, ", carriage return, line feed, tab, as well as LavishScript data sequences
- string Escape[bool escapeLavishScript]: If escapeLavishScript is false/0, Uses slashes to escape \, ", carriage return, line feed, tab, but NOT LavishScript data sequences
- string EscapeQuotes: Uses slashes to escape " only
- string Replace[character,with,...]: Performs single-character replacement with any number of character pairs
- string ReplaceSubstring[needle,replacement]: Performs in-place replacement of a needle in a haystack. For example, ${String[abcdefg].ReplaceSubstring[def,xyz]} is abcxyzg
- byte GetAt[#]: Retrieves a character at the #th position in the string (1-based)
- unistring UniString:
- string URLEncode: Returns a %u encoded version of the string, suitable for urls
- bool NotNULLOrEmpty: TRUE if the string is not empty and does not contain the literal NULL. This provides a shortcut for: if ${MyString.Length} && !${MyString.Equals[NULL]}
- string Trim: Returns a copy of the string with no leading or trailing whitespace
- string AsJSON: Returns a JSON encoded version of the string, including surrounding quotes
Methods
(none)
Declaring string Variables
- Any string variable is automatically a mutablestring
- variable string Food="Pizza"
Comparing Strings
variable string name1="fred"
variable string name2="george"
if ${name1.Equal[${name2}]}
{
echo We're both named fred!
}
See Also
LavishScript Object Types
- Text
- string - mutablestring - unistring
- Numbers
- byte - float - float64 - int - uint - int64
- Boolean (TRUE/FALSE)
- bool
- Pointers
- boolptr - byteptr - floatptr - float64ptr - intptr - uintptr - int64ptr - rgbptr - stringptr
- Containers
- objectcontainer - array - index - collection - queue - stack - set - variablescope
- JSON
- jsonobject - jsonarray - jsonvaluecontainer - jsonvalue
- Iteration
- iterator - jsoniterator
- Date/Time
- time
- File Handling
- filepath - file - filelist - filelistentry
- Tasks
- lavishmachine - Accessed via the Top-Level Object LMAC
- task - tasklibrary - taskmanager - tasktype - taskpulseargs - elmactaskstate
