Kolmafia - User contributions [en]

String Handling Routines

2007-08-19T23:26:13Z

Alacrity:

Under Construction
void print( string helloworld ) 
void echo( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window.
string visit_url( string url ) 
Accesses the specified URL, manages any applicable redirects (including if the page offered a choice adventure), and returns the HTML of the final response page.
string location_to_url( location place ) 

Returns the URL that would need to be accessed to visit the specified location.
boolean contains_text( string source, string query ) 
Reveals if the query string is a substring of the source string.
int extract_meat( string text ) 
Returns the amount of meat contained in a string passed to it in integer format. For use in k-mail parsing. *Not for use on pending trades.*
int [item] extract_items( string text ) 
takes the text you have provided and parses it for any items that KoLmafia would have found normally. This means you have access to the built-in pluralization handler as well as the ability to NOT have to lookup description IDs or whatever other loops you had to use to access that information. For use in k-mail parsing. *Not for use on pending trades.*
int length( string text ) 
Returns the length of the given string.

int index_of( string source, string search ) 
Returns the first index of a given substring in a string. 
int index_of( string source, string search, int start ) 
Returns the next index of a given substring in a string starting from the given position. 
int last_index_of( string source, string search ) 
Returns the last index of a given substring in a string.
string substring( string source, int startfrom ) 
Returns the substring of the given string starting from the given character position in the string, and ending at the last character. 
string substring( string source, int start, int end ) 

Returns the substring of the given string starting from the character position indicated by start in the string, and ending at the character position indicated by end.
string replace_string( string source, string search, string replace ) 
searches the source string for the search string and replaces all instances with the replace string
string url_encode( string text ) 
string url_decode( string text ) 
Converts a string text into a formatted string for using with raw URLs or from a formatted string back into “normal” text.

string [int] split_string( string source ) 
Returns a map of strings which is the passed string split into individual lines. Originally implemented for use when parsing session logs, but may see more uses in the future.
http://kolmafia.us/index.php/topic,794.msg3868.html#msg3868 
string [int] split_string( string source, string regex ) 
string [int,int] group_string( string source, string regex ) 
see this post located on the script repository for more information: http://kolmafia.us/index.php/topic,451.msg2235.html#msg2235 

string [int] session_logs( string player, int day_count )
Gives access to the session logs saved by kolmafia. More details will be added when this function's own page is written. For now, more extensive details can be found here: http://kolmafia.us/index.php/topic,794.msg3879.html#msg3879

Talk:String Handling Routines

2007-08-19T23:14:32Z

Alacrity:

So wtf does group_string actually do? The linked "descriptive" post has an utterly unhelpful example. Has anyone ever used it for anything?

Groups a string into a map using a regular expression. To understand the function you must know.
1. What maps are and how they are used.
2. Understand what regular expressions are and how to create them.

Using the original post:

FUNCTION DEFINTION: string [int,int] group_string( string source, string regex )
EXAMPLE: string [int,int] test = group_string( "This is a test", "([a-z]+) " );

Example Breakdown:
'''string [int,int]''' Define a map. Two dimensional. The indices are integers. The data is stored as a string.
'''test''' Define the map with name '''test'''.
'''group_string''' Call the function.
'''"This is a Test"''' Feeding the function a sample string.
'''"([a-z]+) "''' Your regular expression.

Regular expressions deal with pattern matching. You want the function to find a particular pattern. The function then returns that pattern, or the stuff before it, or the stuff after it, or splits them appart, or squeezes them together. So what does this regular expression look for?
'''The Parenthesis ():''' Tell the function this is a group of characters.
'''[a-z]:''' Tell us they will be lower case letters.
'''+:''' Tell us to look for one or more characters.
That space between the ) and " Tells us the pattern ends in a space.

Thus reading down the string.
T = Does not match [a-z] is a capital letter.
h = Matches [a-z]. Starting Group
i = Matches [a-z]
s = Matches [a-z]
= Matches space. First group found and is "his "
i = Matches [a-z]. Starting Group
s = Matches [a-z]
= Matches space. Second group found, and is "is "
a = Matches [a-z]. Starting Group
= Matches space. Third group found, and is "a "
t = Matches [a-z]. Starting Group
e = Matches [a-z]
s = Matches [a-z]
t = Matches [a-z]
End of line. No more matches. Stop.

Thus, trusting the post, the map would be:

test[0][0] => "his "
test[0][1] => "his"
test[1][0] => "is "
test[1][1] => "is"
test[2][0] => "a "
test[2][1] => "a"

I personally haven't used it. Would be used in parsing a page by hand.

Miscellaneous Functions

2007-08-19T23:12:34Z

Alacrity:

== Part 6 - Miscellaneous ==
Mostly internal stuff. Some good for everyone, some only for ASH wizards.

void print( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window

boolean cli_execute( string command ) 
Executes the given command as if it were entered into the graphical CLI window. This can be used for CLI commands or, if you’re careful and not an asshat, for raw URLs. 
See the [http://kolmafia.sourceforge.net/scripting.html CLI manual] for more details. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|Hedging]]

void wait( int delay ) 
Does nothing for the desired number of seconds.

string get_property( string key ) 
boolean set_property( string key, string value ) 
Gets or sets a stored property from your character’s .kcs file. 
The KoLmafia [[%28ASHRM%29_KoLMafia_Properties|properties]] page contains details on many of the keys that are available for access. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean file_to_map( string file_to_load, map map_to_fill ) 
boolean map_to_file( map map_to_save, string file_to_write ) 
Loads and saves maps as tab-delimited text files.

int random( int range ) 
Generates a random integer between 0 and (range-1) inclusive.

int round( float ratio ) 
int floor( float ratio ) 
int ceil( float ratio ) 
int truncate( float ratio ) 
Returns an integer near the given real number. Respectively, it returns the nearest, next lowest, next highest, and decimal-stripped integer.

int count( map ) 
Returns the number of defined keys for the aggregate.

void clear( map ) 
Remove all keys from a map. 

void disable( string function_name ) 
void enable( string function_name ) 
For debugging purposes disables or enables the indicated function

float square_root( float value ) 
returns the square root of the passed value

string today_to_string() 
Returns today’s (real-world) date in the form yyyymmdd. It is based on your computer’s system date