Difference between revisions of "String Handling Routines"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
m
imported>StDoodle
Line 1: Line 1:
 +
==Simple==
 
{{Flink|string|today_to_string|desc=Returns the current day in ISO format (based on your computer's settings).}}
 
{{Flink|string|today_to_string|desc=Returns the current day in ISO format (based on your computer's settings).}}
 
{{Flink|string|visit_url|string|desc=Visits the specified address and returns the page source (see page for details).}}
 
{{Flink|string|visit_url|string|desc=Visits the specified address and returns the page source (see page for details).}}
Line 16: Line 17:
 
{{Flink|string [int,int]|group_string|string|string|desc=Maps a string to an aggregate (see page for details). [http://kolmafia.us/showthread.php?t=318]}}
 
{{Flink|string [int,int]|group_string|string|string|desc=Maps a string to an aggregate (see page for details). [http://kolmafia.us/showthread.php?t=318]}}
 
{{Flink|string [int]|session_logs|{{opt|string}}|int|desc=Gives access to sessions logs. And stuff. [http://kolmafia.us/showthread.php?t=573]}}
 
{{Flink|string [int]|session_logs|{{opt|string}}|int|desc=Gives access to sessions logs. And stuff. [http://kolmafia.us/showthread.php?t=573]}}
 +
==Regular Expressions==
 +
{{Flink|matcher|create_matcher|string|string|desc=Creates a matcher from a pattern and input string.}}
 +
{{Flink|matcher|reset|matcher|{{opt|string}}|desc=Resets matcher to search from beginning of string, possibly with new input.}}
 +
{{Flink|int|group_count|matcher|desc=Returns the number of capturing groups in the pattern.}}
 +
{{Flink|boolean|start|matcher|desc=Indicates if the pattern is found at the start of the string.}}
 +
{{Flink|boolean|end|matcher|desc=Indicates if the pattern is found at the end of the string.}}
 +
{{Flink|boolean|find|matcher|desc=Finds the next instance of the pattern or returns false if no more matches exist.}}
 +
{{Flink|string|group|matcher|{{opt|int}}|desc=Returns the contents of an indicated capturing group (starting at 1) or the entire pattern if not indicated.}}
 
{{Flink|buffer|append|buffer|string|desc=Appends the string to the end of the buffer.}}
 
{{Flink|buffer|append|buffer|string|desc=Appends the string to the end of the buffer.}}
 
{{Flink|buffer|append_replacement|matcher|buffer|string}}
 
{{Flink|buffer|append_replacement|matcher|buffer|string}}
 
{{Flink|buffer|append_tail|matcher|buffer|desc=Appends the text returned by a matcher to the end of the buffer.}}
 
{{Flink|buffer|append_tail|matcher|buffer|desc=Appends the text returned by a matcher to the end of the buffer.}}

Revision as of 05:49, 14 March 2010

Simple

string today_to_string()

Returns the current day in ISO format (based on your computer's settings).

string visit_url( string )

Visits the specified address and returns the page source (see page for details).

string to_url( location )

Returns the url which is accessed to visit the specified location.

boolean contains_text( string, string )

Returns true if the second string is found as a substring of the first.

int extract_meat( string )

Returns the number of meat embedded in a string.

int [item] extract_items()

Parses a string for items and their amounts (handles plural & singular forms) and returns the results as a map.

int length( string )

Returns the number of characters in the specified string.

int index_of( string, string, [int] )

Returns the position of the second string in the first (or -1 if not found), optionally starting its search from a given position.

int last_index_of( string, string )

Returns the last index of the second string in the first.

string substring( string, int, [int] )

Returns the substring of the specified string, starting from a specified position, and optionally ending before a specified position (defaults to remainder of string).

buffer replace_string( buffer, string, string )

buffer replace_string( string, string, string )

Replaces all text in the first string that matches the second with the third.

string url_encode( string )

Converts a string into a URL formatted string.

string url_decode( string )

Converts a URL formatted string into regular text.

string [int] split_string( string, [string] )

Splits apart the first string at line-breaks or using an optionally supplied delimeter and returns an integer-keyed map of the result.

string [int,int] group_string( string, string )

Maps a string to an aggregate (see page for details). [1]

string [int] session_logs( [string], int )

Gives access to sessions logs. And stuff. [2]

Regular Expressions

matcher create_matcher( string, string )

Creates a matcher from a pattern and input string.

matcher reset( matcher, [string] )

Resets matcher to search from beginning of string, possibly with new input.

int group_count( matcher )

Returns the number of capturing groups in the pattern.

boolean start( matcher )

Indicates if the pattern is found at the start of the string.

boolean end( matcher )

Indicates if the pattern is found at the end of the string.

boolean find( matcher )

Finds the next instance of the pattern or returns false if no more matches exist.

string group( matcher, [int] )

Returns the contents of an indicated capturing group (starting at 1) or the entire pattern if not indicated.

buffer append( buffer, string )

Appends the string to the end of the buffer.

buffer append_replacement( matcher, buffer, string )

buffer append_tail( matcher, buffer )

Appends the text returned by a matcher to the end of the buffer.