Slag Plasmacore Reference v0.23

Class AltPatternMatcher

Internal use.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
next : PatternMatcher terms : PatternMatcher[]

Object Methods

chain_next( PatternMatcher _next ) compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( PatternMatcher p1, PatternMatcher p2, PatternMatcher p3 ) init() init( PatternMatcher p1, PatternMatcher p2 ) match( PatternMatchInfo state ).Boolean match_next( PatternMatchInfo state ).Boolean matches_any().Boolean Overridden in CharRangePatternMatcher to_String().String type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class AnyMatcher

Internal use.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
max_count : Int32 min_count : Int32 next : PatternMatcher

Object Methods

chain_next( PatternMatcher _next ) compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( [Int32 min_count], [Int32 max_count] ) match( PatternMatchInfo state ).Boolean match_next( PatternMatchInfo state ).Boolean matches_any().Boolean Overridden in CharRangePatternMatcher to_String().String type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class Application

The base class for every Plasmacore game or application. Extend your game class from this class and override methods as warranted. Start with init(), update(), and draw().

Class Methods

close_all_archives() Closes all archives cached by open_archive() and frees the memory used by them. create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise exit_program() Causes the native framework to immediately exit the application. Typically called from on_exit_request(), but may be called independently. Example: Application.exit_program input_capture( Boolean setting ) Property-set that specifies whether input is captured by (and restricted to) this application. This is "false" by default. Example: Application.input_capture = true language().String Returns the language used by the application. On many platforms this returns "english". On the Wii this returns one of: english, japanese, german, french, spanish, italian, dutch mouse_visible( Boolean setting ) Property-set that specifies the visibility of the system mouse. This is "true" by default. Example: Application.mouse_visible = false open_archive( String filename ) Attempts to locate and load the named ZIP file into memory. The archive is not uncompressed when loaded. Subsequent attempts to open any file for reading (including loading images and sounds) will first check and see if the file is in any of the archives that have been opened with open_archive(). If found, the file is uncompressed and read from the archive. If not found, Plasmacore searches for the file in the regular filesystem. If 'filename' is, for example, "images", Plasmacore will attempt to open the archive using the following paths: images images.zip data/images data/images.zip Any number of archives may be opened concurrently - all of them are searched when a file is requested. Call close_all_archives() to close the archives and free up the memory used by them. Using archives in this fashion allows for a clean and compact distribution with no significant difference in loading speed on the Windows Plasmacore platform. However, writing games to utilize the archive system should yield speed benefits on platforms (e.g. Wii) where I/O seek time and data transfer rates are an issue (such as reading data off optical drive or over the network). Note when opening input files (including loading images and sounds), the following variations of the filename are automatically checked: filename filename.ext (ext = png, jpg, etc. as appropriate) data/filename data/filename.ext This means that when creating this new image object: Image("images/sprites"), the file "sprites.png" could either be located under "data/images/sprites.png" or under "images/sprites.png" in the archive "data/images.zip". WARNING: once again, open_archive does not simply add a search path to the zip file on disc - it actually loads the entire file into memory! platform().String Returns the platform this game is running on. Currently supported platforms include: windows, wii window_title( String title ) Window title property-set for this application. Example: Application.window_title = "MadStone"

Object Methods

call_draw( Int32 window_width, Int32 window_height ) Internal use. Wraps a call to draw() in a try/catch block. call_init( Int32 display_width, Int32 display_height ) Internal use. Wraps a call to init() in a try/catch block. call_update() Internal use. Wraps a call to update() in a try/catch block. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. draw() Redraws the game. Called up to 60 times per second. You should not change the game's data model at this point. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init() Called to set up the game. Do not call any drawing operations at this point. listen_to( DispatcherType dispatcher ) Instructs this JoystickListener to listen to the given dispatcher. on_exit_request() Called when the user presses the close window button. Calls exit_program() by default. You can override this method to perform cleanup and/or postpone the call to exit_program at some later point. on_joystick_button_press( JoystickEvent event ) See JoystickEvent for more information. on_joystick_button_release( JoystickEvent event ) See JoystickEvent for more information. on_joystick_connected( JoystickEvent event ) See JoystickEvent for more information. on_joystick_hat_movement( JoystickEvent event ) See JoystickEvent for more information. on_joystick_movement( JoystickEvent event ) See JoystickEvent for more information. on_key_press( KeyEvent event ) Called when a key is pressed. An on_keystroke() event is generated at the same time. If the key is held down for a while, key repeat events are sent as additional on_keystroke() events. 'event' contains information about the key. on_key_release( KeyEvent event ) Called when a key is released. 'event' contains information about the key. on_keystroke( KeyEvent event ) Called when a key has either been pressed and released or is pressed and is repeating. 'event' contains information about the key. on_mouse_absent() Called when the the game window loses mouse focus. on_mouse_button_press( MouseEvent event ) Called when a mouse button has been pressed. 'event.button' contains the index of the mouse button being pressed (1=left, 2=right). 'event.position' contains the absolute mouse position at the time of the press. on_mouse_button_release( MouseEvent event ) Called when a mouse button has been pressed. 'event.button' contains the index of the mouse button being pressed (1=left, 2=right). 'event.position' contains the absolute mouse position at the time of the press. on_mouse_movement( MouseEvent event ) Called when the mouse position changes. 'event' contains the new mouse position in relative (delta) coordinates. on_mouse_position() is also called with the new absolute position. on_mouse_position( MouseEvent event ) Called when the mouse position changes. 'event' contains the new mouse position in absolute coordinates. on_mouse_movement() is also called with the relative position change. on_mouse_present() Called when the mouse focus returns to the game window after being elsewhere. on_mouse_wheel_down( MouseEvent event ) Called when the mouse wheel has been rotated one click down. 'event.position' contains the absolute mouse position at the time of the wheel movement. on_mouse_wheel_up( MouseEvent event ) Called when the mouse wheel has been rotated one click up. 'event.position' contains the absolute mouse position at the time of the wheel movement. on_toggle_fullscreen() Called by the input object when an ALT+ENTER key combination is detected. The default behavior is to toggle the fullscreen property setting. on_trackball_movement( JoystickEvent event ) See JoystickEvent for more information. stop_listening_to( DispatcherType dispatcher ) Stops this JoystickListener from listening to the given dispatcher. to_String().String Returns: A String representation of this object. Most classes should override this method to summarize an object's state for convenience in testing and debugging. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String update() Called 60 times per second guaranteed. Do not perform any drawing actions; just update the world's data model.

Class ArbitraryCountPatternMatcher

Internal use.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
max_count : Int32 min_count : Int32 next : PatternMatcher term : PatternMatcher

Object Methods

chain_next( PatternMatcher _next ) compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). find_matches( PatternMatchInfo state ).Boolean hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( PatternMatcher term, [Int32 min_count], [Int32 max_count] ) match( PatternMatchInfo state ).Boolean match_next( PatternMatchInfo state ).Boolean matches_any().Boolean Overridden in CharRangePatternMatcher to_String().String type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class Array<<DataType>>

Primarily for internal use - in most cases use ArrayList instead.

Array is a placeholder type. Arrays are actually implemented in the runtime implementation; calls to array methods are intercepted by the program loader and translated into array-related opcodes.

The exception to this is when a call is made to an array using a reference of aspect types Readable or IndexedData - the loader is unable to intercept. However, the Slag-side implementation of each array simply calls itself, and *that* call *is* intercepted by the compiler.

To get an array in Slag you must be explicit, e.g. "Array<<Int32>>(20)". Convenience notation (such as Array[20]) generates ArrayLists instead.

Arrays are not covariant as they are in Java. An Array<<String>> counts as an Object but not as an Array<<Object>>.

Arrays may be extended or augmented but no new object variables may be added.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Methods

clear( Int32 first_index, Int32 last_index ) Clears all the elements in this array between the two indices. Using this method to clear elements at the end of an arraylist allows the runtime to limit the number of reference array elements it searches through during a data collection. Technical note: the runtime tracks the furthest position that a non-null reference array element could possibly be at after various calls to clear() and set(). compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. contains( DataType value ).Boolean Returns "true" if this data contains the given value. copy_elements( ArrayType src_array, Int32 src_index, Int32 dest_index, Int32 number ) Copies 'number' elements from another array (starting at element 'src_index') into this one (starting at element 'dest_index'). Elements may be copied within overlapping regions of the same array. count().Int32 Returns the count of how many elements are in this array. create_duplicate().Array<<DataType>> Creates a duplicate of this array when the "duplicate(array)" command is given. If the array element type is a reference type, the new array contains a copy of the same references to the same objects - the objects themeselves are not duplicated. create_reader().Reader<<DataType>> Returns a reader that can be used to read() this data one element at a time. end( Int32 from_end ).DataType Equivalent to get( (count-1) + from_end ). For example, end(0) is equivalent to last() and end(-1) is equivalent to get(count-2). equals( DataType value ).Boolean[] Returns a list of Boolean values where each value true if the corresponding element of this indexed data equals() the given value. equals( Readable<<DataType>> other ).Boolean Returns true if each element of this data equals() each corresponding element from in 'other'. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). first().DataType Returns the first element of this data. This convenience method is equivalent to get(0). format( String prefix, String prepeat, String suffix ).String Converts this list into a string using the following format: prefix + $0 + [prepeat + $N]* + suffix where "$0" is the first element and $N is every other element. Example: local Int32[] nums = 11..15 println( nums.to_String("[", "+", "]") ) # prints: [11+12+13+14+15] format( String str_format, [String repeater_chars] ).String Easier convenience method to accomplish to_String(prefix,prepeat,suffix). Breaks down a simple format like this: {$[ or $]} Into a prefix="{", prepeat=" or ", suffix="}". Normally "[]" brackets are used to denote the repeater portion, but this may be specified otherwise. Example: local Int32[] nums = 11..15 println( nums.to_String( "[$:+$:]", ":" ) # prints: [11+12+13+14+15] println( nums.to_String( "{$[,$]}" ) # prints: {11,12,13,14,15} from( Range<<Int32>> range ).Reader<<DataType>> Returns a reader that can be used to read() this data one element at a time from the given starting index up to and including the ending index. from( Int32 starting_index ).Reader<<DataType>> Returns a reader that can be used to read() this data one element at a time with the given 'starting_index'. get( Int32 index ).DataType Retieves the element at the zero-based 'index'. Requires: 0 <= index < count get( Readable<<Boolean>> flags ).DataType[] Returns a new list containing the subset of elements of which each of the corresponding 'flags' is true. Example: local Int32[] nums = {1..10} println( nums[nums % 2 == 0] ) #prints: {2,4,6,8,10} get( Readable<<Int32>> indices ).DataType[] Gets the element at each of the given zero-based 'indices'. Example: local Int32[] nums = {1..5} nums[{0,4}] = nums[{4,0}] println( nums ) #prints: {5,2,3,4,1} hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf index_of( DataType value, [Int32 starting_index] ).Int32 Returns the first index that the given value occurs at starting at index 0 by default. (-1) is returned if 'value' is not found. indices().Range<<Int32>> Returns this data's range of indices (0..count-1). init( Int32 size ) Sets up this array to contain the given number of elements. is_empty().Boolean Returns true if count == 0. is_not_empty().Boolean Returns true if count > 0. last().DataType Returns the last element of this data. This convenience method is equivalent to get(count-1). last_index_of( DataType value, [Int32 starting_index] ).Int32 Returns the last index that the given value occurs at starting at index (count-1) by default. (-1) is returned if 'value' is not found. modification_count().Int32 Returns a counter representing the number of times items has been added to or removed. Used by readers to detect concurrent list modification errors. For example, when an inner method removes an item from a list the modification counter is incremented. An outer "forEach" loop will detect that the count is different from its original value and throw a ConcurrentListModification error. random().DataType Returns an element of this data at random. reverse() Reverses the order of the elements in this data. reverse_indices().Range<<Int32>> Returns this data's range of indices reversed (count-1 downTo 0). Example: local Int32[] nums = {5..7} forEach (i in nums.reverse_indices) println( i ) #prints: 2 | 1 | 0 reverse_order().Reader<<DataType>> Returns a reader that can be used to read() this data one element at a time from the last element (N-1) to the first (0). reversed().IndexedData<<DataType>> Returns an list containing the elements of this data in reverse order. set( Int32 index, DataType value ) Sets the element at the zero-based 'index' to the new 'value'. Requires: 0 <= index < count set( Readable<<Boolean>> flags, DataType value ) Starting at index 0, sets each element to the given 'value' if the corresponding 'element_flags' are true. Example: local Int32[] nums = {1..5} nums[nums%2==1] = 0 println( nums ) #prints: {0,2,0,4,0} set( Readable<<Int32>> indices, Readable<<DataType>> values ) Sets the element at each of the given 'indices' to each of the corresponding 'values'. Requires: The number of indices == the number of values. Example: local Int32[] nums = {1..5} nums[0..4 step 2] = {7,8,9} println( nums ) #prints: {7,2,8,4,9} set( Readable<<Boolean>> element_flags, Readable<<DataType>> values ) Starting at index 0, sets each element to the next of the given 'values' if the corresponding 'element_flags' are true. Example: local Int32[] nums = {1..5} nums[nums%2==1] = -nums println( nums ) #prints: {-1,2,-3,4,-5} set( Readable<<Int32>> indices, DataType value ) Sets the element at each of the given 'indices' to the given 'value'. Example: local Int32[] nums = {1..5} nums[{0,4}] = nums[{4,0}] println( nums ) #prints: {5,2,3,4,1} shuffle() Swaps every element of this data with another element at a randomly-chosen position. shuffled().IndexedData<<DataType>> Returns a shuffled copy of this data. subset( Int32 first_index, Int32 last_index ).ArrayList<<DataType>> Returns the subset of this data between indices [first_index,last_index] inclusive. swap( Int32 index_a, Int32 index_b ) Swaps the value at 'index_a' with the one at 'index_b'. Requires: 0 <= index_a < count 0 <= index_b < count Invariant: this[index_a] = old[index_b] this[index_b] = old[index_a] to_List().DataType[] Converts this data into a list. to_String().String Returns a string representation of this data. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class ArrayList<<DataType>>

The most common "collection" type in Slag, an ArrayList is an indexable list of items implemented using arrays.

An array list has 'count' and 'capacity'. Capacity is how many elements an arraylist can store before it has to create a larger backing array. Count is how many elements of the current array are currently in use. When 'count' reaches 'capacity', the next add() operation causes the backing array to be doubled in size.

An arraylist starts out at capacity 10, count 0 by default.

When you use "array notation" in Slag it creates arraylists. The following convenience conversions are performed:

  # Create an empty list with 10 capacity
  Int32[] nums(10)  # 10 capacity
    -> List<<Int32>> nums = ArrayList<<Int32>>(10)
  # Create a list of 10 zero/null values
  Int32[] nums = Int32[10]
    -> List<<Int32>> nums = ArrayList<<Int32>>( 10, 0 )
  # Create a list with the numbers 1 to 3
  Int32[] nums = { 1, 2, 3 }
    -> List<<Int32>> nums = ...
           ArrayList<<Int32>>().add(1).add(2).add(3)

  count >= 0
  capacity >= count
  data.count == capacity

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
counter : Int32 The position to add the next item - also equivalent to the used item count. data : Array<<DataType>> The backing array for this arraylist. modification_count : Int32

Object Methods

add( Readable<<DataType>> source ).List<<DataType>> Adds each item from the Readable source to this list. Returns a reference to this list for call-chaining. add( DataType value, Int32 after_index ).List<<DataType>> Inserts 'value' after the given index. Returns: A reference to this list for call-chaining. Requires: after_index >= -1 and after_index < count Invariant: new.count == old.count + 1 new[after_index+1] == value add( DataType value ).ArrayList<<DataType>> Adds the given 'value' to the end of this list. Returns a reference to this list for call chaining. Invariant: count = old.count + 1 get[count-1] == value capacity().Int32 Returns how many values this list can store before its backing array must be doubled in size. clear() Removes all elements from this list. The capacity is unchanged. Invariant: new.count == 0 new.capacity == old.capacity compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. contains( DataType value ).Boolean Returns "true" if this data contains the given value. count().Int32 Returns how many values there are in this list. create_duplicate().ArrayList<<DataType>> Creates a duplicate of this list when the "duplicate(list)" command is given. If the list element type is a reference type, the new list contains a copy of the same references to the same objects - the objects themeselves are not duplicated. Results: A duplicate list such that "all(this is result)" equals true. create_reader().Reader<<DataType>> Returns a reader that can be used to read() this data one element at a time. discard( Int32 first_index, [Int32 last_index] ) Removes the elements in the specified range. Does not return the list of removed elements like remove() does. If only the 'first' parameter is given, elements from 'first' to the end of the list are discarded. 'first' and 'last' are clipped to be a valid range. discard( Range<<Int32>> range ) Removes elements in the specified range. Requires: range.is_contiguous_ascending end( Int32 from_end ).DataType Equivalent to get( (count-1) + from_end ). For example, end(0) is equivalent to last() and end(-1) is equivalent to get(count-2). ensure_capacity( Int32 min_capacity ) Effects that this list has a capacity of at least 'min_capacity'. If it has a lower capacity, the backing array is reallocated to have the necessary capacity. equals( Readable<<DataType>> other ).Boolean Returns true if each element of this data equals() each corresponding element from in 'other'. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). equals( DataType value ).Boolean[] Returns a list of Boolean values where each value true if the corresponding element of this indexed data equals() the given value. expand_to_capacity().ArrayList<<DataType>> Effectively adds enough null/zero values to this arraylist so that the count matches the capacity. Technically the backing array is maintained with null/zero values and so a counter is adjusted. Returns: A reference to this list for call chaining. Invariant: count == capacity first().DataType Returns the first element of this data. This convenience method is equivalent to get(0). format( String str_format, [String repeater_chars] ).String Easier convenience method to accomplish to_String(prefix,prepeat,suffix). Breaks down a simple format like this: {$[ or $]} Into a prefix="{", prepeat=" or ", suffix="}". Normally "[]" brackets are used to denote the repeater portion, but this may be specified otherwise. Example: local Int32[] nums = 11..15 println( nums.to_String( "[$:+$:]", ":" ) # prints: [11+12+13+14+15] println( nums.to_String( "{$[,$]}" ) # prints: {11,12,13,14,15} format( String prefix, String prepeat, String suffix ).String Converts this list into a string using the following format: prefix + $0 + [prepeat + $N]* + suffix where "$0" is the first element and $N is every other element. Example: local Int32[] nums = 11..15 println( nums.to_String("[", "+", "]") ) # prints: [11+12+13+14+15] from( Int32 starting_index ).Reader<<DataType>> Returns a reader that can be used to read() this data one element at a time with the given 'starting_index'. from( Range<<Int32>> range ).Reader<<DataType>> Returns a reader that can be used to read() this data one element at a time from the given starting index up to and including the ending index. get( Readable<<Int32>> indices ).DataType[] Gets the element at each of the given zero-based 'indices'. Example: local Int32[] nums = {1..5} nums[{0,4}] = nums[{4,0}] println( nums ) #prints: {5,2,3,4,1} get( Readable<<Boolean>> flags ).DataType[] Returns a new list containing the subset of elements of which each of the corresponding 'flags' is true. Example: local Int32[] nums = {1..10} println( nums[nums % 2 == 0] ) #prints: {2,4,6,8,10} get( Int32 index ).DataType Returns the element at the given zero-based index. Requires: 0 <= index and index < count hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf index_of( DataType value, [Int32 starting_index] ).Int32 Returns the first index that the given value occurs at starting at index 0 by default. (-1) is returned if 'value' is not found. indices().Range<<Int32>> Returns this data's range of indices (0..count-1). init() Creates an empty arraylist of capacity 10. init( Int32 initial_capacity ) Creates an empty arraylist with a specified initial capacity. init( Readable<<DataType>> readable ) Initializes this list to contain all the items from the 'readable' data source. init( Int32 initial_capacity, DataType content ) Creates an array list full of 'initial_capacity' duplicates of the given 'content'. insert( IndexedData<<DataType>> seq, [Int32 before_index] ).ArrayList<<DataType>> Inserts all the given values in front of 'before_index'. Elements at 'begin_index' and higher are shifted over by one. Returns: A reference to this list for call chaining. Requires: 0 <= before_index and before_index <= count Invariant: this[before_index] = value this[before_index+seq.count] = old[before_index] count = old.count + seq.count insert( DataType value, [Int32 before_index] ).ArrayList<<DataType>> Inserts the 'value' in front of 'before_index'. Elements at 'begin_index' and higher are shifted over by one. Returns: A reference to this list for call chaining. Requires: 0 <= before_index and before_index <= count Invariant: this[before_index] = value this[before_index+1] = old[before_index] count = old.count + 1 is_empty().Boolean Returns true if count == 0. is_not_empty().Boolean Returns true if count > 0. last().DataType Returns the last element of this data. This convenience method is equivalent to get(count-1). last_index_of( DataType value, [Int32 starting_index] ).Int32 Returns the last index that the given value occurs at starting at index (count-1) by default. (-1) is returned if 'value' is not found. modification_count().Int32 Returns a counter representing the number of times items has been added to or removed. Used by readers to detect concurrent list modification errors. For example, when an inner method removes an item from a list the modification counter is incremented. An outer "forEach" loop will detect that the count is different from its original value and throw a ConcurrentListModification error. random().DataType Returns an element of this data at random. remove( DataType value ).Boolean Calls remove_value(value). Only available for non-numerical lists - see note in remove_value(). remove( Int32 index ).DataType Removes and returns the element at position 'index'. All elements higher than 'index' are shifted down by one spot and the list count is decremented. Returns: old[index] Requires: 0 <= index and index < count Invariant: new[index] = old[index+1] remove( Int32 first_index, Int32 last_index ).DataType[] Removes and returns the elements in the specified range. 'first' and 'last' are clipped to be a valid range. Returns: The list of elements from old[first] through old[last]. remove( Range<<Int32>> range ).DataType[] Removes and returns the elements in the specified range. See discard() for a variant that's optimal when you don't need the return value. Requires: range.is_contiguous_ascending remove_first().DataType Equivalent to: list.remove(0) remove_last().DataType Equivalent to: list.remove(list.count-1) remove_value( DataType value ).Boolean Removes the first occurrence of 'value' from the list. Returns: "true" if an occurrence of 'value' was found and removed, or "false" if it was not found. Technical note: this method can't be named remove() because in an Int32[] list, remove(index) and remove(value) would have the same signature. reverse() Reverses the order of the elements in this data. reverse_indices().Range<<Int32>> Returns this data's range of indices reversed (count-1 downTo 0). Example: local Int32[] nums = {5..7} forEach (i in nums.reverse_indices) println( i ) #prints: 2 | 1 | 0 reverse_order().Reader<<DataType>> Returns a reader that can be used to read() this data one element at a time from the last element (N-1) to the first (0). reversed().IndexedData<<DataType>> Returns an list containing the elements of this data in reverse order. set( Readable<<Int32>> indices, DataType value ) Sets the element at each of the given 'indices' to the given 'value'. Example: local Int32[] nums = {1..5} nums[{0,4}] = nums[{4,0}] println( nums ) #prints: {5,2,3,4,1} set( Readable<<Boolean>> flags, DataType value ) Starting at index 0, sets each element to the given 'value' if the corresponding 'element_flags' are true. Example: local Int32[] nums = {1..5} nums[nums%2==1] = 0 println( nums ) #prints: {0,2,0,4,0} set( Int32 index, DataType value ) Sets the element at the given zero-based index. Requires: 0 <= index and index < count set( Readable<<Int32>> indices, Readable<<DataType>> values ) Sets the element at each of the given 'indices' to each of the corresponding 'values'. Requires: The number of indices == the number of values. Example: local Int32[] nums = {1..5} nums[0..4 step 2] = {7,8,9} println( nums ) #prints: {7,2,8,4,9} set( Readable<<Boolean>> element_flags, Readable<<DataType>> values ) Starting at index 0, sets each element to the next of the given 'values' if the corresponding 'element_flags' are true. Example: local Int32[] nums = {1..5} nums[nums%2==1] = -nums println( nums ) #prints: {-1,2,-3,4,-5} shuffle() Swaps every element of this data with another element at a randomly-chosen position. shuffled().IndexedData<<DataType>> Returns a shuffled copy of this data. sort( [SORT order] ) Sorts this list in place using a HeapSort. 'order' is SORT.ascending by default. Only implemented for numerical and String lists. To enable it for lists of other types (say, Event), add this augment: augment List<<Event>> METHODS method sort( SORT order=SORT.ascending ): HeapSort<<DataType>>.sort( this, order ) endAugment sorted( [SORT order] ).List<<String>> Returns an list containing the elements of this data sorted into order. Only implemented for numerical and String lists. subset( Int32 first_index, Int32 last_index ).ArrayList<<DataType>> Returns the subset of this data between indices [first_index,last_index] inclusive. swap( Int32 index_a, Int32 index_b ) Swaps the value at 'index_a' with the one at 'index_b'. Requires: 0 <= index_a < count 0 <= index_b < count Invariant: this[index_a] = old[index_b] this[index_b] = old[index_a] to_List().DataType[] Satisifies the ListAdaptable aspect of the IndexedData aspect by returning this list with no modifications. to_String().String Returns a string representation of this data. trim_to_count().ArrayList<<DataType>> Resizes the backing array to exactly fit the values currently stored in this list. Only recommended when memory usage is a concern and you won't be adding additional elements in the near future. Returns: A reference to this list for call chaining. Invariant: capacity == count type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class ArrayType

Placeholder class that provides a common base type for all Array<<DataType>> classes.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Methods

clear( Int32 first_index, Int32 last_index ) Clears all the elements in this array between the two indices. Using this method to clear elements at the end of an arraylist allows the runtime to limit the number of reference array elements it searches through during a data collection. Technical note: the runtime tracks the furthest position that a non-null reference array element could possibly be at after various calls to clear() and set(). compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. copy_elements( ArrayType src_array, Int32 src_index, Int32 dest_index, Int32 number ) Copies 'number' elements from another array (starting at element 'src_index') into this one (starting at element 'dest_index'). Elements may be copied within overlapping regions of the same array. count().Int32 Returns the count of how many elements are in this array. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf to_String().String Returns: A String representation of this object. Most classes should override this method to summarize an object's state for convenience in testing and debugging. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class BeginTagGroupPatternMatcher

Internal use.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
next : PatternMatcher tag_group_index : Int32

Object Methods

chain_next( PatternMatcher _next ) compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( Int32 tag_group_index ) match( PatternMatchInfo state ).Boolean match_next( PatternMatchInfo state ).Boolean matches_any().Boolean Overridden in CharRangePatternMatcher to_String().String type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class BigInt

Allows integers of any size to be represented and manipulated. BigInt operations are significantly slower than operations on primitive Int32/Int64 types so BigInt objects should only be used when you require integers with more than 64 bits.

BigInt objects are immutable; operations produce new BigInteger objects as side effects instead of altering operands.

BigInt numbers are modeled using sign-magnitude; they are not 2's complement and the sign cannot be directly changed through a bitwise operation (only incidentally, as when a negative number is AND'd with zero to produce a zero result).

BigInt values are stored as a series of unsigned 16-bit Char values. Their total bit size (in multiples of 16) is only what's necessary to represent a number's magnitude; you cannot, for instance, specify that a number has "1000 zero bits".

Similar to Java's BigInteger class.

Examples:

  println( BigInt(123456) ^ BigInt("1000101",2) )
  println( "2^100 = $" (BigInt(2) ^ 100) )

Class Variables
last_modulo : BigInt one : BigInt ten : BigInt ten_e144 : BigInt ten_e18 : BigInt ten_e36 : BigInt ten_e72 : BigInt values : BigInt[] zero : BigInt

Class Methods

create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise init_class() promote( Int64 n ).BigInt Creates a BigInt object out of an Int64 value. If 'n' is 0..15 then a pre-defined BigInt object will be returned instead.

Object Variables
data : ArrayList<<Char>> sign_flag : Int32

Object Methods

compare_to( Object other ).Ternary compare_to( Int64 n ).Ternary compare_to( BigInt other ).Ternary create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Int64 n ).Boolean equals( Object other ).Boolean equals( BigInt other ).Boolean hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init() init( BigInt other ) init( Int32 value ) init( Int64 value ) init( String value, [Int32 base] ) Initializes this BigInt to a value specified as a string of digits in a given base. 'base' can be 2, 10, or 16. internal_to_Int64().Int64 is_negative().Boolean is_valid_Int32().Boolean is_valid_Int64().Boolean is_zero().Boolean left_shifted( Int32 bits ).BigInt normalized().BigInt Removes excess zero values on the most signficant end and changes a negative zero to a positive zero. op%( BigInt n ).BigInt op%( Int64 n ).BigInt op&( BigInt n ).BigInt op&( Int64 n ).BigInt op*( Int64 n ).BigInt op*( BigInt n ).BigInt op+( Int64 n ).BigInt op+( BigInt n ).BigInt op-( Int64 n ).BigInt op-().BigInt op-( BigInt n ).BigInt op/( Int64 n ).BigInt op/( BigInt n ).BigInt op^( BigInt n ).BigInt op^( Int64 n ).BigInt op|( BigInt n ).BigInt op|( Int64 n ).BigInt op~( BigInt n ).BigInt op~( Int64 n ).BigInt right_shifted( Int32 bits ).BigInt sign().Int32 Returns -1, 0, or 1. to_Int32().Int32 to_Int64().Int64 to_String( Int32 base ).String to_String().String type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Aspect BitFlags<<EnumType>>

Incorporate this aspect into enumerated types associated with Int32 values that define bit flags.

For example:

  enum DIRECTION : BitFlags<<DIRECTION>>
    CATEGORIES
      north(1), east(2), south(4), west(8)
  endEnum
  ...
  local DIRECTION d = DIRECTION.north | DIRECTION.east
  println( d == DIRECTION.north )         #prints: false
  println( d.includes(DIRECTION.north) )  #prints: true
  println( d )        #prints: north,east
  println( d.flags )  #prints: 3
  d &= !DIRECTION.north
  println( d )  #prints: east
  println( d == DIRECTION.east )  #prints: true
  println( d.flags )  #prints: 2

Class Variables
default_next_flag : Int32

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
flags : Int32

Object Methods

compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean equals( Int32 other_flags ).Boolean equals( EnumType other ).Boolean hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf includes( EnumType other ).Boolean Returns "true" if this category contains any of the bitflags from the 'other' category. includes( Int32 other_flags ).Boolean Returns "true" if this category contains any of the bitflags from 'other_flags'. init() init( Int32 flags ) init( EnumType existing ) op!().EnumType Returns a new category that contains the inverse of this category's bitflags. op&( Int32 other_flags ).EnumType Returns a new category that contains the intersection of bitflags from this category and 'other_flags'. op&( EnumType other ).EnumType Returns a new category that contains the intersection of bitflags from this category and the 'other' category. op|( Int32 other_flags ).EnumType Returns a new category that includes all the bitflags from this category and 'other_flags'. op|( EnumType other ).EnumType Returns a new category that includes all the bitflags from this category and the 'other' category. to_String().String Returns a string containing the names of all comma-separated categories included in this category's bitflags. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class BitReader

A BitReader wraps an existing Reader<<Char>> and is able to read in 1-bit to 32-bit values at a time under normal operations. There are special method variants capable of reading in 64-bit values.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
bit_buffer : Int64 Internal use. bit_count : Int32 Internal use. src : Reader<<Char>> The backing source of characters.

Object Methods

available().Int32 Returns the minimum number of additional values that can be immediately read from this reader. If the reader is exhausted or if it must block to peek or read next then the result will be 0. It is important to note that '0' does not necessarily mean the reader is exhausted. Many readers will report that they have 1 available even if there are thousands of values waiting to be read. The 'available' property should be used as an aide for buffer sizes and the like but should not be taken as an absolute size. close() Closes this reader as a source of input. Useful for file readers, but for most others this command does nothing. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. consume( DataType look_for ).Boolean Attempts to match and discard the next value from this reader, returning true, or else leaves the next value still pending and returns false. Returns: "true" if old.peek == look_for "false" if old.peek != look_for Invariant: if (old.peek == look_for) old.skip create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). fill_buffer( Int32 to_n_bits ) Internal use. has_another().Boolean Returns true if there are at least 8 bits left to read. See also: has_another(Int32) has_another( Int32 n_bits ).Boolean Returns true if there are at least 'n_bits' left to read. 'n_bits' must be 1..32. hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( Reader<<Char>> src ) Initializes this BitReader to read from the given character reader. init( Readable<<Char>> readable ) Initializes this BitReader to read from the given readable character data. is_exhausted().Boolean Returns "true" if this reader does not have another value or "false" if it does. peek( Int32 n_bits ).Int32 Returns the next 'n_bits' value that will be returned by read(n_bits). peek().Char Returns the next 8-bit value that will be returned by read(). peek_bit().Int32 Returns the bit of input that will be returned by read_bit. position( Int32 new_position ) This optional property-write sets the zero-based read position of this reader. When a reader is first created position() returns 0. After a single read() it returns 1, and so on. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. position().Int32 This optional property-read returns the zero-based read position of this reader. When a reader is first created position() returns 0. After a single read() it returns 1, and so on. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. read( Int32 n_bits ).Int32 Returns the next value of size 'n_bits', giving a value between 0 and n_bits-1. Example: ... if (bits.peek == 0b01011000) println( bits.read(3) ) # prints "2" (010) println( bits.read(2) ) # prints "3" (11) println( bits.read(3) ) # prints "0" (000) endIf read().Char Returns the next 8 bits as a Char. read_Int64().Int64 Returns the next 64 bits as an Int64 assumed to be in high-low byte order. read_Int64_low_high().Int64 Returns the next 64 bits as an Int64 assumed to be in low-high byte order. read_bit().Int32 Returns the next bit of input. read_line().String Reads and returns the next line of characters up to the next LF or CRLF. The CRLF characters are not part of the return value and are discarded. Only defined for Reader<<Char>>. read_list( Int32 size ).DataType[] Reads the next 'size' number of values and returns them in a list. Requires that there are at least 'size' number of values remaining to be read. read_low_high( Int32 n_bits ).Int32 Returns the next n_bits as a value. n_bits must be 16 or 32 bits. This method assumes that the first 8 bits to be read are the least significant byte of the answer (bits 7:1) and the last 8 bits are the most significant byte of the number (e.g. bits 31:24). Requires: n_bits == 16 or n_bits == 32 remaining().Int32 This optional property returns how many values remain to be read before the reader is exhausted. Not all readers can implement this property; those that don't will throw an UnsupportedMethodError when it's accessed. rewind() This optional method resets this reader so that the next read() will return the first value of the series. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. skip( [Int32 skip_count] ) Discards exactly the next 'skip_count' number of values rather than reading them. If there are not enough values remaining then a NoNextValueError will be thrown from read(). This program fragment: local var a = reader.read reader.read reader.read local var b = reader.read is equivalent to this: local var a = reader.read reader.skip(2) local var b = reader.read to_List().DataType[] Creates and returns a list of all the remaining values of this reader. to_String().String Returns a string representation of this reader's values. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class BitWriter

A BitWriter wraps an existing Writer<<Char>> and allows arbitrarily-sized values of 1-32 bits to be written. 64-bit values may also be written using a separate call.

The bits are buffered and groups of 8 at a time (single bytes) are written to the backing Char writer.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
bit_buffer : Int64 Internal use. bit_count : Int32 Internal use. dest : Writer<<Char>> The backing character writer that a BitWriter outputs to.

Object Methods

capacity().Int32 Returns the minimum number of additional values that can written with this writer, or (-1) for "unlimited". clean_up() Closes the writer. Base aspect Writer does not incorporate the RequiresCleanup interface, but types for writers that do this method will be called when there are no more references to the object. close() Flushes and closes this BitWriter. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). flush() If there are any buffered bits that haven't been written to the backing writer yet, flush() writes out enough zero bits to make eight total and writes the resulting byte of information. hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf holds_has_another().Boolean Returns true if at least one more value can be written with write(). init( Writer<<Char>> dest ) Initializes this BitWriter to output to the given writer. init( Writable<<Char>> writable ) Initializes this BitWriter to output to the given writable object. position( Int32 new_pos ) This optional property-write sets the zero-based write position. It is up to the implementation to define how repositioning works with gaps and what happens to data at a later spot after a reposition to an earlier spot. Not all writers implement this property; those that don't will throw an UnsupportedMethodError when it's accessed. position().Int32 This optional property-read returns the zero-based write position. This will be "0" before anything is written, "1" after a single write(), and so on. Not all writers implement this property; those that don't will throw an UnsupportedMethodError when it's accessed. skip( Int32 skip_count ) This optional method repositions the writer to be 'skip_count' values further along. If a writer does not implement the 'position' property then an UnsupportedMethodError will be generated when skip() is called. to_String().String Returns: A String representation of this object. Most classes should override this method to summarize an object's state for convenience in testing and debugging. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String write( DataType value ) Outputs 'value' in an implementation-specific way. Requires: holds_has_another == true write( Int32 value, Int32 n_bits ) Writes 'value' in 'n_bits' using high-low byte order. write( Char value ) Writes 'value' in 8 bits. write_Int64( Int64 value ) Writes 'value' in 64 bits using high-low byte order. write_Int64_low_high( Int64 value ) Writes 'value' in 64 bits using low-high byte order. write_bit( Int32 b ) Writes 'b' (0 or 1) as a single bit. write_low_high( Int32 value, Int32 n_bits ) Writes 'value' in 'n_bits' using low-high byte order. 'n_bits' must be 16 or 32. The least-significant byte is written first and the most significant byte is written last. Requires: n_bits == 16 or n_bits == 32

Class Bitmap

Pixel data wrapper for examining and manipulating image data. Many native layer implementations load textures as Bitmap objects first and then convert them into hardware-accelerated Images.

Class Methods

create( String filename ).Bitmap Creates a Bitmap containing the pixel data from the specified file. Currently only png and jpg files are supported. create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
data : Array<<Color>> Single-dimensional array of Color values. Values data[0 ..< width] are the first row, data[width ..< width*2] are the second row, and so on. height : Int32 The height of this bitmap, in pixels. width : Int32 The width of this bitmap, in pixels.

Object Methods

add_transparent_outline() Adjusts this bitmap's data to include a 1-pixel transparent black border on each edge. clear( [Color color] ) Clears all the pixels of this bitmap to be the given color or opaque black by default. clear_channel( Color color, Int32 channel_mask ) Clears a certain channel of this bitmap to the given color. Parameters: color The color to clear to. Only the bits of the AARRGGBB 'color' that correspond to the set bits in 'channel_mask' are copied. channel_mask A 32-bit AARRGGBB value where 1 bits indicate the color should be copied and 0 bits where it shouldn't. For example, to clear the alpha channel to a:128 without affecting the red, green, or blue color values: clear_channel( new_Color(0,0,0,128), 0xff000000 ) column_transparent( Int32 x ).Boolean Returns "true" if column 'x' (where x is 0 ..< width) contains completely transparent pixel values. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. draw( Int32 x, Int32 y ) For native layer debugging purposes. Performs a slow image draw using a draw_point() call per pixel. draw( Rect r, Color color, Boolean blend_alpha ) Draws the outline of the given rectangle in the given color, optionally performing alpha-blending (default: true). draw( Vector2 pos ) For native layer debugging purposes. See draw(Int32,Int32). draw_channel_to( Bitmap dest, Int32 x, Int32 y, Int32 channel_mask ) Draws selected bits of this bitmap to the destination. No alpha blending is performed. Parameters: dest A bitmap to draw to. Edge clipping is performed. x,y Where to place the top-left corner of this bitmap. channel_mask A 32-bit AARRGGBB value where 1 bits indicate the color should be copied and 0 bits where it shouldn't. For example, to copy this bitmap's alpha values without disturbing the color values of the image: draw_channel_to( dest, 0, 0, 0xff000000 ) draw_to( Bitmap dest, Vector2 pos, [Boolean blend_alpha] ) Draws this bitmap to the given destination bitmap. This is operation is performed in software and is not intended for heavy per-frame use. Parameters: dest A bitmap to draw to. Edge clipping is performed. pos Where to place the top-left corner of this bitmap. blend_alpha (default:true) Set to "true" if per-pixel alpha blending should be performed. Set to "false" to completely overrwrite destination pixels. draw_to( Bitmap dest, Int32 x, Int32 y, [Boolean blend_alpha] ) Draws this bitmap to the given destination bitmap. This is operation is performed in software and is not intended for heavy per-frame use. Parameters: dest A bitmap to draw to. Edge clipping is performed. x,y Where to place the top-left corner of this bitmap. blend_alpha (default:true) Set to "true" if per-pixel alpha blending should be performed. Set to "false" to completely overrwrite destination pixels. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). fill( Rect r, Color color, [Boolean blend_alpha] ) Fills the given rectangle with the given color, optionally performing alpha-blending [default: false]. hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( Vector2 pixel_size ) Creates a transparent black bitmap of the given size. init( Bitmap existing, Vector2 top_left, Vector2 new_size ) Creates a bitmap that's a given subset of an existing bitmap. init( Bitmap existing, Rect rect ) Creates a bitmap that's a given subset of an existing bitmap. init( Int32 width, Int32 height ) Creates a transparent black bitmap of the given width and height. init( Bitmap existing ) Creates a bitmap that's an exact duplicate of an existing bitmap. init( String filename ) Creates a Bitmap containing image data from the given png or jpeg file. non_transparent_region().Rect Returns a rectangle just large enough to enclose all pixels that aren't completely transparent. If the area of the resulting rectangle is zero then this bitmap is completely transparent. Invariant: result == intersection_of(old,result) region().Rect Returns the rectangular region occupied by this bitmap. The 'position' of the resulting rectangle is (0,0). row_transparent( Int32 y ).Boolean Returns "true" if row 'y' (where y is 0 ..< height) contains completely transparent pixel values. set( Bitmap existing ) Sets this bitmap to reference the same data as another existing bitmap. Note that the array of Color data is shared rather than duplicated. size().Vector2 Returns the two-dimensional size of this bitmap, in pixels. split_into_tiles( Int32 tiles_wide, Int32 tiles_high ).Bitmap[] Splits this Bitmap into an array of separate Bitmap tiles. Returns a list of Bitmap objects where index 0 is the top-left tile, index[tiles_wide-1] is the top-right tile, and so on. to_String().String Returns: A String representation of this object. Most classes should override this method to summarize an object's state for convenience in testing and debugging. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class CastReader<<FromType,ToType>>

Wraps an existing Reader<<FromType>> and casts each value to ToType.

Example:

  local Real64[] nums = { 3.0, 3.5, 3.9, 4.0 }
  forEach (n in CastReader<<Real64,Int32>>(nums)) println(n)
    # prints: 3 3 3 4

  # Read "data.txt" into a byte buffer.
  local Byte[] buffer = CastReader<<Char,Byte>>(File("data.txt").create_reader).to_List

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
has_next : Boolean If "true" then 'next' is a valid value. next : OutputDataType The next data that will be returned by peek() or read(). src : Reader<<InputDataType>> The backing source of values for this reader.

Object Methods

available().Int32 Returns the minimum number of additional values that can be immediately read from this reader. If the reader is exhausted or if it must block to peek or read next then the result will be 0. It is important to note that '0' does not necessarily mean the reader is exhausted. Many readers will report that they have 1 available even if there are thousands of values waiting to be read. The 'available' property should be used as an aide for buffer sizes and the like but should not be taken as an absolute size. close() Closes this reader as a source of input. Useful for file readers, but for most others this command does nothing. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. consume( DataType look_for ).Boolean Attempts to match and discard the next value from this reader, returning true, or else leaves the next value still pending and returns false. Returns: "true" if old.peek == look_for "false" if old.peek != look_for Invariant: if (old.peek == look_for) old.skip create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). has_another().Boolean Returns "true" if this reader has another value that can be previewed with peek() or read with read(). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( Readable<<InputDataType>> readable ) Initializes this BitReader to read from the given reader. init( Reader<<InputDataType>> src ) Initializes this BitReader to read from the given readable data. is_exhausted().Boolean Returns "true" if this reader does not have another value or "false" if it does. peek().OutputDataType Returns the next value that will be returned from read(). If there is no next value then a NoNextValueError is thrown. position( Int32 new_position ) This optional property-write sets the zero-based read position of this reader. When a reader is first created position() returns 0. After a single read() it returns 1, and so on. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. position().Int32 This optional property-read returns the zero-based read position of this reader. When a reader is first created position() returns 0. After a single read() it returns 1, and so on. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. prep_next().Boolean read().OutputDataType Returns the next value from this reader. If (not has_another) then a NoNextValueError is thrown. read_line().String Reads and returns the next line of characters up to the next LF or CRLF. The CRLF characters are not part of the return value and are discarded. Only defined for Reader<<Char>>. read_list( Int32 size ).DataType[] Reads the next 'size' number of values and returns them in a list. Requires that there are at least 'size' number of values remaining to be read. remaining().Int32 This optional property returns how many values remain to be read before the reader is exhausted. Not all readers can implement this property; those that don't will throw an UnsupportedMethodError when it's accessed. rewind() This optional method resets this reader so that the next read() will return the first value of the series. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. skip( [Int32 skip_count] ) Discards exactly the next 'skip_count' number of values rather than reading them. If there are not enough values remaining then a NoNextValueError will be thrown from read(). This program fragment: local var a = reader.read reader.read reader.read local var b = reader.read is equivalent to this: local var a = reader.read reader.skip(2) local var b = reader.read to_List().DataType[] Creates and returns a list of all the remaining values of this reader. to_String().String Returns a string representation of this reader's values. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class CharRangePatternMatcher

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
high_ch : Char low_ch : Char next : PatternMatcher

Object Methods

chain_next( PatternMatcher _next ) compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( Char low_ch, Char high_ch ) init( Char low_ch ) match( PatternMatchInfo state ).Boolean match_next( PatternMatchInfo state ).Boolean matches_any().Boolean to_String().String type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Compound Circle ( Vector2 position, Real64 radius )

Defines an abstract circle as 'position' and 'radius'. Note: Circle drawing requires many operations!

Circle-related methods in class Global
  enclose( Circle circle ).Rect
  intersect( Line line, Circle circle ).Boolean
  print( Circle circle )
  println( Circle circle )
  surround( Rect rect ).Circle
  surround( Line line ).Circle
  to_String( Circle circle ).String
  x1_of( Circle circle ).Real64
  x2_of( Circle circle ).Real64
  y1_of( Circle circle ).Real64
  y2_of( Circle circle ).Real64

Composite Elements
position : Vector2 radius : Real64

Compound Color ( Byte blue, Byte green, Byte red, Byte alpha )

Defines a 32-bit color using integer red, green, blue, and alpha color components, each 0-255.

The order of the color components is designed so that the underlying memory lists them in ARGB order.

Color-related methods in class Global
  as_Int32( Color color ).Int32
  clear_display( [Color color] )
  draw( Quad q, Color color )
  draw( Rect r, Color color )
  draw( Line line, Color color )
  fill( Rect r, Color color )
  fill( Quad q, Color color )
  new_HSV( Color color ).HSV
  print( Color c )
  println( Color c )
  random_Color().Color
  to_String( Color c ).String

Composite Elements
blue : Byte green : Byte red : Byte alpha : Byte

Class ColorGradient

Convenience class that stores the four corner colors of a color gradient and can draw the gradient in a rectangular area.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
bottom_left_color : Color bottom_right_color : Color top_left_color : Color top_right_color : Color

Object Methods

compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. draw( Real64 x, Real64 y, Real64 w, Real64 h ) Draws this color gradient in the given rectangular area. draw( Rect r ) Draws this color gradient in the given rectangular area. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( Color top_left_color, Color top_right_color, Color bottom_right_color, Color bottom_left_color ) Creates a color gradient with the specified corner colors. init( Int32 c1, Int32 c2, Int32 c3, Int32 c4 ) Creates a color gradient with the specified corner colors (given as 0xAARRGGBB integers). to_String().String Returns: A String representation of this object. Most classes should override this method to summarize an object's state for convenience in testing and debugging. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class CompositeImage

A composite image is designed for loading and displaying large splash screens and other background graphics. Upon initialization it loads a given image and then breaks it up into 256x256-pixel chunks - which are then redrawn pieced together as a whole.

Class Variables
color_policy : Color Specifies the initial value for the 'color' property of new Image objects. Opaque white by default. handle_policy : Vector2 Specifies the initial value for the 'handle' property of new Image objects. (0,0) (HANDLE.top_left) by default. render_flags_policy : Int32 Specifies the initial value for the 'render_flags' property of new Image objects. Default: no flags are set.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables

angle : Radians The angle property variable. This may be set to a new Radians or Degrees value. Note: CompositeImage objects currently ignore this property. color : Color The multiplier for each pixel in this image as it's drawn. The default color of new_Color(255,255,255,255) ensures that the image will appear "normal". A color of new_Color(255,255,0) would not draw any of the blue channel, making a grey-scale image appear to be tinted yellow. A color of new_Color(255,255,255,128) would draw the image halfway transparent. handle : Vector2 Specifies the drawing and rotation origin of this image. This can be set to a pixel value relative to the upper-left of the image (0,0) or a HANDLE category such as "HANDLE.center" or "HANDLE.bottom_center". hflip : Boolean Specifies that an image should be flipped horizontally when drawn. This mirroring is applied before the image is rotated and does not affect the spatial positioning. Note: CompositeImage objects currently ignore this property. parts : GenericImage[] All of the image sub-parts that comprise this composite image. render_flags : Int32 Any combination of RENDER constants, or 0 for no special rendering options. Example: ghost.render_flags = (RENDER.overexpose | RENDER.fixed_color) scale : Vector2 The size multiplier for rendering, (1.0,1.0) by default. Setting "scale = Vector2(2.0,0.5)" would cause the image to render at twice the width and half the height. Change 'size' instead if you want to achieve particular pixel dimensions. size : Vector2 The nominal size of the given image, in pixels. Change 'size' if you want the image's standard size to be a given number of pixels or change 'scale' if you want the image to be proportionally larger or smaller. vflip : Boolean Specifies that an image should be flipped vertically when drawn. This mirroring is applied before the image is rotated and does not affect the spatial positioning. Note: CompositeImage objects currently ignore this property.

Object Methods

add( GenericImage img, Vector2 offset ) Adds 'img' to this composite image - 'img' may be an Image or a CompositeImage object. It will be drawn with its handle at 'offset' relative to the top-left corner of this image. alpha( Int32 new_alpha ) Alpha property-set method - sets the alpha component of this image's color multiplier. alpha().Int32 Alpha property-get method - returns the alpha component (0-255) of the current color multiplier. angle( Radians new_angle ) Angle property-set. Note: CompositeImage objects currently ignore this property. angle( Degrees deg ) Angle property-set. Note: CompositeImage objects currently ignore this property. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. draw( Vector2 pos ) draw() method. draw( Real64 x, Real64 y ) Draws this image with its handle (origin) at (x,y). equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). fixed_color().Boolean Returns "true" if "fixed_color" is set in the render flags. fixed_color( Boolean setting ) Turns fixed-color drawing on or off in the render flags. handle( Vector2 new_handle ) Handle property-set. handle( HANDLE h ) Handle property-set. hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( String filename ) Initializes this CompositeImage to draw the given image. init( Vector2 size ) Initializes this object to an empty image of the given size. Additional image subparts may be added with the add() method. init( Bitmap bmp ) Initializes this CompositeImage to draw the given bitmap. overexpose().Boolean Returns "true" if "overexpose" is set in the render flags. overexpose( Boolean setting ) Turns overexposure on or off in the render flags. point_filter( Boolean setting ) Turns point filtering on or off in the render flags. "on" selects nearest-neighbor point filtering; "off" selects linear filtering (the Image default). point_filter().Boolean Returns "true" if "point_filter" is set in the render flags. region().Rect Returns the rectangular region nominally occupied by this image at its size and scale. The 'position' of the resulting rectangle is (0,0). release() Calls release() on each of this CompositeImage object's constituent parts. scale( Real64 uniform_scale ) Scale property-set. scale( Vector2 new_scale ) Scale property-set. size( Vector2 new_size ) Size property-set. texture_wrap().Boolean Returns "true" if "texture_wrap" is set in the render flags. texture_wrap( Boolean setting ) Turns texture wrapping on or off in the render flags. to_String().String Returns: A String representation of this object. Most classes should override this method to summarize an object's state for convenience in testing and debugging. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class CompositeRange<<DataType>>

A range made up of ranges - each next value is obtained indirectly from a list of ranges. For example, {1..3,7..9} creates a CompositeRange object whose reader would return the values {1,2,3,7,8,9}.

This is relied on by the compiler internally; most programmers will not need to use it directly.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
ranges : Range<<DataType>>[]

Object Methods

compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. create_reader().Reader<<DataType>> Returns a reader that can be used to read() this data one element at a time. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( Range<<DataType>>[] ranges ) to_List().DataType[] Converts this data into a list. to_String().String Returns a string representation of this CompositeRange. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class CompositeRangeReader<<DataType>>

Reader for a CompositeRange. Utilized by the Slag compiler; most programmers will not need to use this directly.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
cur_range : Reader<<DataType>> range_reader : Reader<<Range<<DataType>>>>

Object Methods

available().Int32 Returns the minimum number of additional values that can be immediately read from this reader. If the reader is exhausted or if it must block to peek or read next then the result will be 0. It is important to note that '0' does not necessarily mean the reader is exhausted. Many readers will report that they have 1 available even if there are thousands of values waiting to be read. The 'available' property should be used as an aide for buffer sizes and the like but should not be taken as an absolute size. close() Closes this reader as a source of input. Useful for file readers, but for most others this command does nothing. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. consume( DataType look_for ).Boolean Attempts to match and discard the next value from this reader, returning true, or else leaves the next value still pending and returns false. Returns: "true" if old.peek == look_for "false" if old.peek != look_for Invariant: if (old.peek == look_for) old.skip create_duplicate().CompositeRangeReader<<DataType>> Handles duplicating this iterator when "duplicate(iterator_obj)" is called. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). has_another().Boolean Returns "true" if this reader has another value that can be previewed with peek() or read with read(). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( Reader<<DataType>> cur_range, Reader<<Range<<DataType>>>> range_reader ) init( Reader<<Range<<DataType>>>> range_reader ) is_exhausted().Boolean Returns "true" if this reader does not have another value or "false" if it does. peek().DataType Returns the next value that will be returned from read(). If there is no next value then a NoNextValueError is thrown. position( Int32 new_position ) This optional property-write sets the zero-based read position of this reader. When a reader is first created position() returns 0. After a single read() it returns 1, and so on. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. position().Int32 This optional property-read returns the zero-based read position of this reader. When a reader is first created position() returns 0. After a single read() it returns 1, and so on. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. prep_next() Prepares the next value that will be used by peek() and read(). As a composite range reader, this involves advancing to the next range reader if the current range reader is empty. read().DataType Returns the next value from this reader. If (not has_another) then a NoNextValueError is thrown. read_line().String Reads and returns the next line of characters up to the next LF or CRLF. The CRLF characters are not part of the return value and are discarded. Only defined for Reader<<Char>>. read_list( Int32 size ).DataType[] Reads the next 'size' number of values and returns them in a list. Requires that there are at least 'size' number of values remaining to be read. remaining().Int32 This optional property returns how many values remain to be read before the reader is exhausted. Not all readers can implement this property; those that don't will throw an UnsupportedMethodError when it's accessed. rewind() This optional method resets this reader so that the next read() will return the first value of the series. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. skip( [Int32 skip_count] ) Discards exactly the next 'skip_count' number of values rather than reading them. If there are not enough values remaining then a NoNextValueError will be thrown from read(). This program fragment: local var a = reader.read reader.read reader.read local var b = reader.read is equivalent to this: local var a = reader.read reader.skip(2) local var b = reader.read to_List().DataType[] Creates and returns a list of all the remaining values of this reader. to_String().String Returns a string representation of this reader's values. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class ConcurrentModificationError

Thrown when a reader detects that other code has modified a list between one read and the next.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
ip : Int64 The execution ip at the time of the exception. If generated by Slag code this is "manually" calculated (as in 'Global.excecution_ip(-2)') or by the runtime environment if generated by the VM or runtime. message : String The error message.

Object Methods

compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( String message ) Stores the given error message. init() Default initializer. to_String().String Returns a description of the execution IP at the time the error was thrown along with the error message. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Compound Corners ( Vector2 top_left, Vector2 bottom_right )

Compound consisting of two corners. Exists as a means to create a rectangle from two corners rather than a corner and a size.

Corners-related methods in class Global
  get_uv( Int32 image_index ).Corners
  new_Rect( Corners c ).Rect
  print( Corners c )
  println( Corners c )
  set_uv( Int32 image_index, Corners corners )
  size_of( Corners c ).Vector2
  to_String( Corners c ).String
  x1_of( Corners c ).Real64
  x2_of( Corners c ).Real64
  y1_of( Corners c ).Real64
  y2_of( Corners c ).Real64

Composite Elements
top_left : Vector2 bottom_right : Vector2

Class Counter<<DataType>>

A generator that returns the next value in the sequence with every read.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
next : DataType The next number that will be returned from read(). step_size : DataType The step size between consecutive numbers.

Object Methods

available().Int32 Returns the minimum number of additional values that can be immediately read from this reader. If the reader is exhausted or if it must block to peek or read next then the result will be 0. It is important to note that '0' does not necessarily mean the reader is exhausted. Many readers will report that they have 1 available even if there are thousands of values waiting to be read. The 'available' property should be used as an aide for buffer sizes and the like but should not be taken as an absolute size. close() Closes this reader as a source of input. Useful for file readers, but for most others this command does nothing. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. consume( DataType look_for ).Boolean Attempts to match and discard the next value from this reader, returning true, or else leaves the next value still pending and returns false. Returns: "true" if old.peek == look_for "false" if old.peek != look_for Invariant: if (old.peek == look_for) old.skip create_duplicate().Counter<<DataType>> Handles duplicating this iterator when "duplicate(iterator_obj)" is called. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). has_another().Boolean Returns true - standard generators always have another value. hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( [DataType next], [DataType step_size] ) is_exhausted().Boolean Returns "true" if this reader does not have another value or "false" if it does. peek().DataType Returns the next value that will be returned from read(). If there is no next value then a NoNextValueError is thrown. position( Int32 new_position ) This optional property-write sets the zero-based read position of this reader. When a reader is first created position() returns 0. After a single read() it returns 1, and so on. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. position().Int32 This optional property-read returns the zero-based read position of this reader. When a reader is first created position() returns 0. After a single read() it returns 1, and so on. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. read().DataType Returns the next number and advances the counter. read_line().String Reads and returns the next line of characters up to the next LF or CRLF. The CRLF characters are not part of the return value and are discarded. Only defined for Reader<<Char>>. read_list( Int32 size ).DataType[] Reads the next 'size' number of values and returns them in a list. Requires that there are at least 'size' number of values remaining to be read. remaining().Int32 This optional property returns how many values remain to be read before the reader is exhausted. Not all readers can implement this property; those that don't will throw an UnsupportedMethodError when it's accessed. rewind() This optional method resets this reader so that the next read() will return the first value of the series. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. skip( Int32 skip_count ) Discards 'skip_count' number of values that would otherwise be returned from this generator. to_List().DataType[] Throws an UnsupportedMethodError. to_String().String Returns a string representation of this reader's values. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Compound Degrees ( Real64 value )

Real64 wrapper compound that specifies an angle in degrees.

Degrees compounds may be used in trig operations such as sin() and cos().

Degrees-related methods in class Global
  cos( Degrees deg ).Real64
  degrees_of( Vector2 v ).Degrees
  new_Radians( Degrees deg ).Radians
  new_Vector2( Real64 magnitude, Degrees angle ).Vector2
  op*( Real64 factor, Degrees deg ).Degrees
  op+( Radians rad, Degrees deg ).Radians
  op-( Radians rad, Degrees deg ).Radians
  op-( Degrees deg1 ).Degrees
  op/( Real64 factor, Degrees deg ).Degrees
  point_at( Circle circle, Degrees angle ).Vector2
  print( Degrees deg )
  println( Degrees deg )
  random_Degrees().Degrees
  rotate( Vector2 v, Degrees deg ).Vector2
  sin( Degrees deg ).Real64
  tan( Degrees deg ).Real64
  to_Radians( Degrees deg ).Radians
  to_String( Degrees deg ).String

Composite Elements
value : Real64

Aspect DispatcherType

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Methods

compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf to_String().String Returns: A String representation of this object. Most classes should override this method to summarize an object's state for convenience in testing and debugging. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class DivideByZeroError

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
ip : Int64 The execution ip at the time of the exception. If generated by Slag code this is "manually" calculated (as in 'Global.excecution_ip(-2)') or by the runtime environment if generated by the VM or runtime. message : String The error message.

Object Methods

compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( String message ) Initializes this Error with the given message. init() to_String().String Returns a description of the execution IP at the time the error was thrown along with the error message. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class EndTagGroupPatternMatcher

Internal use.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
next : PatternMatcher tag_group_index : Int32

Object Methods

chain_next( PatternMatcher _next ) compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( Int32 tag_group_index ) match( PatternMatchInfo state ).Boolean match_next( PatternMatchInfo state ).Boolean matches_any().Boolean Overridden in CharRangePatternMatcher to_String().String type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class EnumIterator<<DataType>>

A reader that steps through the enumeration categories between a start and an end value.

Created by Range<<DataType>> objects with an enumeration DataType.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
last_value : DataType next_value : DataType

Object Methods

compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().EnumIterator<<DataType>> Handles duplicating this iterator when "duplicate(iterator_obj)" is called. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). has_another().Boolean Returns "true" if this reader has another value that can be previewed with peek() or read with read(). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( DataType first_value, DataType last_value ) peek().DataType Returns the next value that will be returned from read(). If there is no next value then a NoNextValueError is thrown. read().DataType Returns the next value from this reader. If (not has_another) then a NoNextValueError is thrown. to_String().String Returns: A String representation of this object. Most classes should override this method to summarize an object's state for convenience in testing and debugging. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Aspect EnumeratedType<<EnumType>>

Base class for any 'enum'. See also "BitFlags"

NOTES The compiler converts:

  enum FRUIT
    CATEGORIES
      apple, orange
    ...
  endEnum

  class FRUIT : EnumeratedType<<FRUIT>>
    CLASS_PROPERTIES
      apple  = set_up_def( FRUIT(), "apple" )  : FRUIT
      orange = set_up_def( FRUIT(), "orange" ) : FRUIT
    ...
  endClass

Class Variables
definitions : HashTable<<String,EnumType>> Internal use - hashtable of names->categories. values : EnumType[] Internal use - a list of the category objects in this enumeration.

Class Methods

by_name( String name ).EnumType Returns the category object corresponding to the given string name. Contract: FRUIT.by_name("banana") == FRUIT.banana by_ordinal( Int32 ordinal ).EnumType Returns the category object corresponding to the given ordinal position. Contract: if (FRUIT.banana.ordinal == 2) FRUIT.by_ordinal(2) == FRUIT.banana endIf create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise includes( String name ).Boolean Returns "true" if the given name is a category of this enumeration. Example: FRUIT.includes("carrot") -> false set_up_def( EnumType enum_def, String name ).EnumType Internal use.

Object Variables

name : String The name of this category. This is a string with the the same as the enum categery. Suit.spades.name == "spades" ordinal : Int32 The positional index value of this enumeration category, corresponding to the order that the categories were declared in (starting at zero). enum Suit CATEGORIES spades, hearts, clubs, diamonds endEnum ... Suit.spades.ordinal == 0 Suit.diamonds.ordinal == 3

Object Methods

compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. compare_to( EnumType other ).Ternary Returns the relative ordering (lt, eq, gt) of this enum's ordinal versus the ordinal of the given enum. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init() Default initializer. next().EnumType Returns the category that was defined after this one. Example: Suit.spades.next == Suit.hearts Suit.diamonds.next is null next_in_cycle().EnumType Like 'next' but wraps around from the last to the first. Example: Suit.spades.next_in_cycle == Suit.hearts Suit.diamonds.next_in_cycle == Suit.spades previous().EnumType Returns the category that was defined before this one. Example: Suit.spades.previous is null Suit.diamonds.previous == Suit.clubs previous_in_cycle().EnumType Like 'previous' but wraps around from the last to the first. Example: Suit.spades.previous_in_cycle == Suit.diamonds Suit.diamonds.previous_in_cycle == Suit.clubs to_String().String Returns 'name' type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class Error

All built-in exceptions are extended from this Error class.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
ip : Int64 The execution ip at the time of the exception. If generated by Slag code this is "manually" calculated (as in 'Global.excecution_ip(-2)') or by the runtime environment if generated by the VM or runtime. message : String The error message.

Object Methods

compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( String message ) Stores the given error message. init() Sets the error message to an empty string. to_String().String Returns a description of the execution IP at the time the error was thrown along with the error message. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class Exception

The base class of all Error messages. An 'Exception' in Slag is equivalent to a RuntimeException in Java; there are no "checked exceptions" that *require* a try/catch block or a 'throws' clause. Most subclasses of Exception are derived from child class 'Error'.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
ip : Int64 The execution ip at the time of the exception. If generated by Slag code this is "manually" calculated (as in 'Global.excecution_ip(-2)') or by the runtime environment if generated by the VM or runtime. message : String The error message.

Object Methods

compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( String message ) Stores the given error message. init() Sets the error message to an empty string. to_String().String Returns a description of the execution IP at the time the error was thrown along with the error message. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Enum FONT_STYLE

Used to specify different font styles when loading. The following styles are available:

  fixed_width
    Each character in a font strip is the same number of pixels
    wide.
  proportional
    Each character in a font strip can have a different pixel
    width.
  linear_filter
    Peforms linear filtering on each letter as it's drawn.
  point_filter
    Draws nearest-neighbor pixels.  If this flag is omitted
    then linear filtering is used.
  snug
    Adjusts the logical widths of all characters by -1 pixel
    after loading; often appropriate for fonts with black
    outlines. Without snug letters, two capital "M" characters
    in a black-outline font might have two columns of black
    pixels in-between them.  With snug letters there would only
    be one column.

  high_score_font( "somefont.png",
      FONT_STYLE.fixed_width | FONT_STYLE.snug ) : Font

Categories
fixed_width linear_filter point_filter proportional snug

Class Variables
default_next_flag : Int32 definitions : HashTable<<String,EnumType>> Internal use - hashtable of names->categories. values : EnumType[] Internal use - a list of the category objects in this enumeration.

Class Methods

by_name( String name ).EnumType Returns the category object corresponding to the given string name. Contract: FRUIT.by_name("banana") == FRUIT.banana by_ordinal( Int32 ordinal ).EnumType Returns the category object corresponding to the given ordinal position. Contract: if (FRUIT.banana.ordinal == 2) FRUIT.by_ordinal(2) == FRUIT.banana endIf create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise includes( String name ).Boolean Returns "true" if the given name is a category of this enumeration. Example: FRUIT.includes("carrot") -> false set_up_def( EnumType enum_def, String name ).EnumType Internal use.

Object Variables

flags : Int32 name : String The name of this category. This is a string with the the same as the enum categery. Suit.spades.name == "spades" ordinal : Int32 The positional index value of this enumeration category, corresponding to the order that the categories were declared in (starting at zero). enum Suit CATEGORIES spades, hearts, clubs, diamonds endEnum ... Suit.spades.ordinal == 0 Suit.diamonds.ordinal == 3

Object Methods

compare_to( EnumType other ).Ternary Returns the relative ordering (lt, eq, gt) of this enum's ordinal versus the ordinal of the given enum. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( EnumType other ).Boolean equals( Object other ).Boolean equals( Int32 other_flags ).Boolean hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf includes( EnumType other ).Boolean Returns "true" if this category contains any of the bitflags from the 'other' category. includes( Int32 other_flags ).Boolean Returns "true" if this category contains any of the bitflags from 'other_flags'. init( EnumType existing ) init( Int32 flags ) init() next().EnumType Returns the category that was defined after this one. Example: Suit.spades.next == Suit.hearts Suit.diamonds.next is null next_in_cycle().EnumType Like 'next' but wraps around from the last to the first. Example: Suit.spades.next_in_cycle == Suit.hearts Suit.diamonds.next_in_cycle == Suit.spades op!().EnumType Returns a new category that contains the inverse of this category's bitflags. op&( Int32 other_flags ).EnumType Returns a new category that contains the intersection of bitflags from this category and 'other_flags'. op&( EnumType other ).EnumType Returns a new category that contains the intersection of bitflags from this category and the 'other' category. op|( Int32 other_flags ).EnumType Returns a new category that includes all the bitflags from this category and 'other_flags'. op|( EnumType other ).EnumType Returns a new category that includes all the bitflags from this category and the 'other' category. previous().EnumType Returns the category that was defined before this one. Example: Suit.spades.previous is null Suit.diamonds.previous == Suit.clubs previous_in_cycle().EnumType Like 'previous' but wraps around from the last to the first. Example: Suit.spades.previous_in_cycle == Suit.diamonds Suit.diamonds.previous_in_cycle == Suit.clubs to_String().String Returns a string containing the names of all comma-separated categories included in this category's bitflags. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class File

Represents a potential file in the operating system. A File object is created with a filepath; a file of that name may or may not exist yet.

A file object is both Readable and Writable as an input and output for characters.

Class File uses the following terminology:

  filename
    The name of a file without any location information.
  path
    The directory location where the file is stored.
  filepath
    A filename with path information.

  # print every character in a file "test.txt"
  forEach (ch in File("test.txt")) print( ch )

  class RecursiveDirectoryListing
    METHODS
      method init:
        # Recursively lists files starting in the current directory
        list( "." )
      method list( String filepath ):
        local File file(filepath)
        file.filepath = file.absolute_filepath
        println( file.filepath )
        if (file.is_directory)
          forEach (entry in file.directory_listing)
            list("$/$" (file.filepath,entry))
          endForEach
        endIf
  endClass

Class Methods

create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise native_absolute_filepath( String filepath ).String Internal use. native_directory_listing( String path, String[] contents ) Internal use. native_is_directory( String filepath ).Boolean Internal use.

Object Variables
filepath : String The filepath of this file.

Object Methods

absolute_filepath().String Returns the absolute filepath (path + file) of this file. Note: If a filepath doesn't exist it will still be fleshed out with the current full path to allow this method to work with non-existent output files that will be created. absolute_path().String Returns the absolute path denoted by this File object. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. create_reader().FileReader Creates and returns a character reader for this file which opens the corresponding file in the operating system for reading. If the file doesn't exist or if there's some other error then a FileError exception is thrown. create_writer().PrintWriter Creates and returns a character writer for this file which opens the corresponding file in the operating system for writing. If an error occurs then a FileError exception is thrown. directory_listing().String[] Returns a list of filenames and directory names contained within the directory represented by this File object. Throws a FileError if this file does not denote a valid directory. Note: the list of entries returned will not contain the current directory "." or the parent directory "..". equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). exists().Boolean Returns whether or not this file already exists within the operating system. filename().String Returns the filename (without path information) denoted by this File. hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( String filepath ) Initializes this file object with the given filepath. No operating system files are actually opened or created yet. is_directory().Boolean Returns "true" if the path of this file specifies a directory. path().String Returns the path denoted by this File object. This may be relative or absolute depending on the string passed into the initializer. At a minimum, the relative path "." will be returned. to_List().DataType[] Converts this Readable data into a list. Creates a reader and fowards the call to it. to_String().String Returns the original filepath of this File object. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class FileError

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
ip : Int64 The execution ip at the time of the exception. If generated by Slag code this is "manually" calculated (as in 'Global.excecution_ip(-2)') or by the runtime environment if generated by the VM or runtime. message : String The error message.

Object Methods

compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( [String message] ) Initializes this FileError with the given error message. init() Sets the error message to an empty string. to_String().String Returns a description of the execution IP at the time the error was thrown along with the error message. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class FileReader

Reads one character at a time from a file.

Class Methods

create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise native_close( Int32 handle ) Internal use. native_file_size( Int32 handle ).Int32 Internal use. native_open( String filename ).Int32 Internal use. native_read( Int32 handle ).Int32 Internal use. native_skip( Int32 handle, Int32 amount ) Internal use.

Object Variables
file_handle : Int32 The integer that the native layer uses to track this file. next : Char The next character that will be returned from read(). pos : Int32 Counts the number of characters that have been read. total_size : Int32 The total number of characters in the file.

Object Methods

available().Int32 Returns the remaining number of characters in this file since file readers don't block. clean_up() Called when there are no more references to this object; closes the file. close() Closes this file; no more data may be read from this reader. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. consume( DataType look_for ).Boolean Attempts to match and discard the next value from this reader, returning true, or else leaves the next value still pending and returns false. Returns: "true" if old.peek == look_for "false" if old.peek != look_for Invariant: if (old.peek == look_for) old.skip create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). has_another().Boolean Returns "true" if this reader has another value that can be previewed with peek() or read with read(). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( String filename ) Opens the given file and preps this reader to read it. If the file doesn't exist or if there are other problems then a FileError will be thrown. is_exhausted().Boolean Returns "true" if this reader does not have another value or "false" if it does. peek().Char Returns the next value that will be returned from read(). If there is no next value then a NoNextValueError is thrown. position( Int32 new_position ) Sets this position of this file. File readers can only be repositioned further on in the file. position().Int32 Returns the position of this file - equivalent to the number of characters read so far. read().Char Returns the next character from the associated file. read_line().String Reads and returns the next line of characters up to the next LF or CRLF. The CRLF characters are not part of the return value and are discarded. Only defined for Reader<<Char>>. read_list( Int32 size ).DataType[] Reads the next 'size' number of values and returns them in a list. Requires that there are at least 'size' number of values remaining to be read. remaining().Int32 Returns the remaining number of characters in this file. rewind() This optional method resets this reader so that the next read() will return the first value of the series. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. skip( [Int32 skip_count] ) Discards exactly the next 'skip_count' number of values rather than reading them. If there are not enough values remaining then a NoNextValueError will be thrown from read(). This program fragment: local var a = reader.read reader.read reader.read local var b = reader.read is equivalent to this: local var a = reader.read reader.skip(2) local var b = reader.read to_List().DataType[] Creates and returns a list of all the remaining values of this reader. to_String().String Returns a string representation of this reader's values. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class FileWriter

Subclass of PrintWriter that prints to a file. Created by a call to File::create_writer.

Class Methods

create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise native_close( Int32 handle ) Internal use. native_open( String filename ).Int32 Internal use. native_write( Int32 handle, Int32 datum ) Internal use.

Object Variables
file_handle : Int32 Internal use. pos : Int32 Equivalent to the number of characters that have been written.

Object Methods

capacity().Int32 Returns the minimum number of additional values that can written with this writer, or (-1) for "unlimited". clean_up() Closes the writer. Base aspect Writer does not incorporate the RequiresCleanup interface, but types for writers that do this method will be called when there are no more references to the object. close() Closes the file. This should be called after all desired data has been written to the file. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). flush() Orders the writer to write out any buffered data in preparations for closing the writer. Invariant: close() should always call flush() first. hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf holds_has_another().Boolean Returns "true". init( String filename ) Initializes this writer to write to the specified file. The file is opened for writing; close() should be called when finished. If there's an error opening the file then a FileError() is thrown. position( Int32 new_pos ) This optional property-write sets the zero-based write position. It is up to the implementation to define how repositioning works with gaps and what happens to data at a later spot after a reposition to an earlier spot. Not all writers implement this property; those that don't will throw an UnsupportedMethodError when it's accessed. position().Int32 This property-read returns the position of the file, equivalent to the number of characters that have been written thus far. print( Int64 n ) Prints the given Int64 in text form. print( Degrees deg ) Prints out the given degrees value. print( Boolean n ) Prints the given Boolean in text form as "true" or "false". print( Char ch ) Prints the given Char. The symbol corresponding to the Unicode value of 'n' will be displayed. print( Real32 n ) Prints the given Real32 in text form. print( Vector2 v ) Prints 'v' in text form. print( Byte n ) Prints the given Byte in text form. print( Color c ) Prints 'c' in text form. print( RealColor argb ) Prints 'argb' in text form. print( HSV hsv ) Prints 'hsv' in text form. print( Real64 n ) Prints the given Real64 in text form. print( Quad q ) Prints 'q' in text form. print( ParsePos p ) Prints the given ParsePos in text form. print( Object obj ) Prints the to_String representation of the given object, or else the world "null" if the 'obj' reference is null. print( Line line ) Prints 'line' in text form. print( Readable<<Char>> readable ) Prints out every character in the Readable data. print( Corners c ) Prints 'v' in text form. print( String st ) Prints the given String. print( Rect r ) Prints 'r' in text form. print( Ternary n ) Prints the given Ternary in text form as "yes", "no", or "void". print( Radians rad ) Prints out the given radians value. print( Circle circle ) Prints 'circle in text form. print( Reader<<Char>> reader ) Prints out every character that can be obtained from the reader. println( Object obj ) Prints the given object's to_String value and advances the cursor to the next line. println( RealColor argb ) Prints 'argb' in text form and advances the cursor to the next line. println( Readable<<Char>> readable ) Prints out every character in the Readable data and advances the cursor to the next line. println( Real64 n ) Prints the given Real64 value and advances the cursor to the next line. println( Ternary n ) Prints the given Ternary value and advances the cursor to the next line. println( Radians rad ) Prints out the given radians value and advances the cursor to the next line. println( Byte n ) Prints the given Byte value and advances the cursor to the next line. println( String st ) Prints the given String value and advances the cursor to the next line. println( Boolean n ) Prints the given Boolean value and advances the cursor to the next line. println( Degrees deg ) Prints out the given degrees value and advances the cursor to the next line. println( Quad q ) Prints 'q' in text form and advances the cursor to the next line. println( Corners c ) Prints 'v' in text form and advances the cursor to the next line. println( Vector2 v ) Prints 'v' in text form and advances the cursor to the next line. println( Int64 n ) Prints the given Int64 value and advances the cursor to the next line. println( Rect r ) Prints 'r' in text form and advances the cursor to the next line. println( Line line ) Prints 'line' in text form and advances the cursor to the next line of text output. println( Circle circle ) Prints 'circle' in text form and advances the cursor to the next circle of text output. println( Color c ) Prints 'c' in text form and advances the cursor to the next line. println( Char n ) Prints the given Char value and advances the cursor to the next line. println() Advances the cursor to the next line. println( ParsePos p ) Prints the given ParsePos in text form and advances the cursor to the next line. println( Reader<<Char>> reader ) Prints out every character that can be obtained from the reader and advances the cursor to the next line. println( HSV hsv ) Prints 'hsv' in text form and advances the cursor to the next line. skip( Int32 skip_count ) This optional method repositions the writer to be 'skip_count' values further along. If a writer does not implement the 'position' property then an UnsupportedMethodError will be generated when skip() is called. to_String().String Returns: A String representation of this object. Most classes should override this method to summarize an object's state for convenience in testing and debugging. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String write( Char value ) Writes 'value' in 8 bits. write( DataType value ) Outputs 'value' in an implementation-specific way. Requires: holds_has_another == true

Class Font

Manages a bitmapped font. A font loads png or jpeg images containing font strips, breaks up the letters, arranges them onto square textures, and draws the images piece by piece as needed.

Fonts can be loaded as proportional or non-proportional. All letters in a font must have the same height (though parts of that area can be blank/transparent). The drawing origin of every character is the top-left corner.

The image width of a non-proportional font is divided by the number of characters in it to determine the character width.

A proportional font has a single-pixel-high band of alternating colors in the topmost row. The length of any contiguous patch of the same color determines the width of the character underneath. The actual color used does not matter.

Since font strips tend to be images that are too long for texture hardware to support, every font is automatically broken up and laid out on square textures up to 256x256 in size. Any empty pixels around each letter are removed before laying out the letter on a texture.

Either point filtering or linear filtering can be selected for a font. If linear filtering is chosen, an extra outline of padding is added around each letter before it is laid out to avoid color bleeding.

Copy and paste the following letter strip in Photoshop or another paint program to get started on a font strip. Notice the first character is a space; if you accidentally leave it out then all your letters will be one position off.

 !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables

characters : HashTable<<Char,FontCharacter>> color : Color The multiplier for each pixel in this font as it's drawn. The default color of new_Color(255,255,255,255) ensures that the font will appear "normal". A color of new_Color(255,255,0) would not draw any of the blue channel, making a grey-scale letter appear to be tinted yellow. A color of new_Color(255,255,255,128) would draw the letters halfway transparent. height : Int32 The original pixel height of each character in the font. scale : Vector2 The size multiplier for rendering, (1.0,1.0) by default. Setting "scale = Vector2(2.0,0.5)" would cause the font to render at twice the width and half the height.

Object Methods

adjust_character_widths( Int32 amount ) Adjusts the logical widths of all the characters in this font. A positive value will space characters further apart while a negative value will scoot them closer together. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. draw( Char ch, Vector2 pos ).Real64 Draws the given character with its top-left corner at the specified position. Returns the pixel width of the drawn character. draw( String st, Vector2 pos ) Draws the given string of characters to the screen with the top-left corner of the first character at the given position. draw_center( String st, Vector2 pos, Real64 field_width ) Draws the given string centered in the given field width. 'pos' is the top-left corner of the field. draw_center( String st, Vector2 pos ) Draws the given string to the screen with the top-center of all the characters at the given position. draw_line( String st, Vector2 pos ) Internal use. Draws a single line of text with its top-left corner at position 'pos'. draw_right( String st, Vector2 pos ) Draws the given string right-justified with its right edge at 'pos'. draw_right( String st, Vector2 pos, Real64 field_width ) Draws the given string right-justified in a field with the given top-left 'pos' and width. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf height().Real64 Height property-get. Returns the original pixel height times the y-scale value. init( HashTable<<Char,FontCharacter>> characters, Int32 height ) Initializes this font with an existing lookup table of Char->FontCharacter mappings and a font height. init( String filename, [FONT_STYLE style], [String mapping] ) Intializes this font from characters in the given font strip. Parameters: filename A png or jpeg file containing a strip of characters. style Any combination of FONT_STYLE categories. mapping A string of characters specifying the Unicode value of each character in the font strip. The default is a string of 95 characters ranging from ' ' (space) to '~'. If you want to create a single font out of several different font strips, use a FontBuilder instead. scale( Vector2 new_scale ) Scale property-set. scale( Real64 uniform_scale ) Scale property-set. text_width_of( Char ch ).Real64 Returns the render width of 'ch' in pixels, taking the current scale into account. text_width_of( String text ).Real64 Returns the render width of 'text' in pixels, taking the current scale into account. to_String().String Returns: A String representation of this object. Most classes should override this method to summarize an object's state for convenience in testing and debugging. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class FontBuilder

Utility class used to load fonts; used by class Font for loading fonts with single font-strip images. To load a font with a series of font-strip images you can use this class directly.

Example:

  Say that "letters.png" contains 26 fixed-width letter images
  and "numbers.png" contains 10 fixed-with number images.
  PROPERTIES
    my_font : Font
  ...
    local FontBuilder builder()
    builder.load( "letters.png", String('A'..'Z') )
    builder.load( "numbers.png", String('0'..'9') )
    my_font = builder.to_Font

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
font_height : Int32 handles : HashTable<<Char,Vector2>> letter_widths : HashTable<<Char,Int32>> letters : HashTable<<Char,Bitmap>> style : FONT_STYLE

Object Methods

adjust_edges( Char ch, Bitmap letter_bmp ).Vector2 Internal use. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. create_letter_map().HashTable<<Char,FontCharacter>> Internal use. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). find_letter_width( Bitmap bmp, Int32 letter_start_x ).Int32 Internal use. hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( [FONT_STYLE style] ) Initializes an empty FontBuilder with the specified font style applying to future load() calls. init( String filename, [FONT_STYLE style], [String mapping] ) Initializes the FontBuilder to load the given font strip as its initial contents. load( String filename, [String mapping] ) Adds the characters from the given font strip to this font. load( Bitmap src, String mapping ) Adds the characters from the given font strip to this font. to_Font().Font Returns a Font containing all the characters that have been loaded by this FontBuilder. to_String().String Returns: A String representation of this object. Most classes should override this method to summarize an object's state for convenience in testing and debugging. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class FontCharacter

Internal use. Specifies information about a single font character.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Variables
image : Image width : Int32

Object Methods

compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf init( Image image, Int32 width ) to_String().String Returns: A String representation of this object. Most classes should override this method to summarize an object's state for convenience in testing and debugging. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String

Class Generator<<DataType>>

Base type for a Reader that's specialized as a generator. Generators always have another number, can skip() a number of values ahead (through repeated reads), and don't support the to_List operation.

Class Methods
create_duplicate( Object existing ).Object This factory method initiates object duplication. The compiler transforms the duplicate(obj) command into Object.create_duplicate(obj). Returns: 'null' if 'existing' is null. existing.create_duplicate otherwise

Object Methods

available().Int32 Returns the minimum number of additional values that can be immediately read from this reader. If the reader is exhausted or if it must block to peek or read next then the result will be 0. It is important to note that '0' does not necessarily mean the reader is exhausted. Many readers will report that they have 1 available even if there are thousands of values waiting to be read. The 'available' property should be used as an aide for buffer sizes and the like but should not be taken as an absolute size. close() Closes this reader as a source of input. Useful for file readers, but for most others this command does nothing. compare_to( Object other ).Ternary This method is used for ordering (quantitative) comparisons between this object and another. Returns 'eq' if they're equivalent, 'lt' if this object is "less than" the other, or 'gt' if this object is "greater than" another. The compiler converts: 'obj1 < obj2' -> 'obj1.compare_to(obj2) == lt' 'obj1 > obj2' -> 'obj1.compare_to(obj2) == gt' 'obj1 <= obj2' -> 'obj1.compare_to(obj2) != gt' 'obj1 >= obj2' -> 'obj1.compare_to(obj2) != lt' Implementations of compare_to() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.compare_to(obj2) == eq) obj1.equals(obj2) == true obj1.hash_code == obj2.hash_code else obj1.equals(obj2) == false endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation throws an UnsupportedMethodError. consume( DataType look_for ).Boolean Attempts to match and discard the next value from this reader, returning true, or else leaves the next value still pending and returns false. Returns: "true" if old.peek == look_for "false" if old.peek != look_for Invariant: if (old.peek == look_for) old.skip create_duplicate().Object Should create a duplicate of this object such that obj1.equals(obj1.create_duplicate) return true. The command duplicate(obj) is transformed by the compiler into Object.create_duplicate(obj), which then calls this method. For optimal performance (by removing an internal typecast in most situations), have your overridden create_duplicate have the same return type as the class it's defined in. For instance, Strings implementation is 'create_duplicate.String'. This default implementation throws an UnsupportedMethodError. equals( Object other ).Boolean Returns true if this object is equivalant to another. The compiler converts 'obj1 == obj2' into 'obj1.equals(obj2)' and 'obj1 != obj2' into 'not obj1.equals(obj2)'. Implementations of equals() must maintain the following general contract between equals(), compare_to(), and hash_code(). Contract: if (obj1.equals(obj2)) obj1.compare_to(obj2) == eq obj1.hash_code == obj2.hash_code else obj1.compare_to(obj2) != eq endIf Note that two "equal" objects *must* have the same hash code, but "unequal" objects may or may not have the same hash code. This default implementation returns true if the this object and the 'other' reference are the same object ('this is other'). has_another().Boolean Returns true - standard generators always have another value. hash_code().Int32 Returns the hash code of this object, which some classes (like HashTable) rely on. This default implementation throws an UnsupportedMethodError. Hash codes are used to quickly test and see if two complex objects are NOT equal. The value returned has no intrinsic meaning, but should conform to the following rules: 1. Two objects that are equivalent should produce the same hash code. 2. If an object's state doesn't change, its hash code shouldn't change either. Internally, this precludes the hash code being based on an object's memory address since Slag doesn't guarantee that an object's address won't change over time. This has the following implications: If you override hash_code you should also override equals() and possibly compare_to() and ensure the following contract. Invariant: if (obj1.hash_code != obj2.hash_code) obj1.equals(obj2) == false obj1.compare_to(obj2) != eq endIf if (obj1.equals(obj2)) obj1.hash_code == obj2.hash_code endIf is_exhausted().Boolean Returns "true" if this reader does not have another value or "false" if it does. peek().DataType Returns the next value that will be returned from read(). If there is no next value then a NoNextValueError is thrown. position( Int32 new_position ) This optional property-write sets the zero-based read position of this reader. When a reader is first created position() returns 0. After a single read() it returns 1, and so on. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. position().Int32 This optional property-read returns the zero-based read position of this reader. When a reader is first created position() returns 0. After a single read() it returns 1, and so on. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. read().DataType Returns the next value from this reader. If (not has_another) then a NoNextValueError is thrown. read_line().String Reads and returns the next line of characters up to the next LF or CRLF. The CRLF characters are not part of the return value and are discarded. Only defined for Reader<<Char>>. read_list( Int32 size ).DataType[] Reads the next 'size' number of values and returns them in a list. Requires that there are at least 'size' number of values remaining to be read. remaining().Int32 This optional property returns how many values remain to be read before the reader is exhausted. Not all readers can implement this property; those that don't will throw an UnsupportedMethodError when it's accessed. rewind() This optional method resets this reader so that the next read() will return the first value of the series. Readers that don't implement this property will throw an UnsupportedMethodError when it's accessed. skip( Int32 skip_count ) Discards 'skip_count' number of values that would otherwise be returned from this generator. to_List().DataType[] Throws an UnsupportedMethodError. to_String().String Returns a string representation of this reader's values. type_name().String Returns the true class name of this object. Implemented by the runtime; you should not override this method. Example: local Object obj = "Hello World" println( obj.type_name ) #prints: String