+
Point of view
All features
class FIXED_STRING
Summary
top
Immutable character STRINGs indexed from 1 to count.
Direct parents
Inherit list: NATIVELY_STORED_STRING
Class invariant
top
Overview
top
Creation features
{ANY}
{FIXED_STRING}
Features
Creation:
{ANY}
{ANY}
{ANY}
{ABSTRACT_STRING}
{ANY}
Other features:
{ANY}
{}
Interfacing with C string:
{ANY}
  • to_external: POINTER
    The address of a memory region containing the text of Current, useful to interact with the C language.
Creation from C string:
{STRING_HANDLER}
{RECYCLING_POOL, STRING_RECYCLING_POOL, STRING_HANDLER}
  • recycle
    Do whatever needs to be done to free resources or recycle other objects when recycling this one
Copy On Write:
{STRING_HANDLER}
Holders management:
{}
Invariant checking:
{}
{STRING_HANDLER}
{}
{STRING_HANDLER}
{ANY}
Concatenation
{ANY}
Access
{ANY}
{STRING_HANDLER}
{STRING_HANDLER}
storage signature: only in all_check mode
{}
{STRING_HANDLER}
{ANY}
Testing:
{ANY}
Testing and Conversion:
{ANY}
Concatenation
{ANY}
Case conversion
{ANY}
String replacing
{ANY}
Other features:
{ANY}
Splitting a STRING:
{ANY}
Other features:
{ANY}
Other features here for ELKS compatibility:
{ANY}
{}
The states of the finite state automaton used in arg feature
{}
{}
{ANY}
  • in_range (lower: FIXED_STRING, upper: FIXED_STRING): BOOLEAN
    Return True if Current is in range [lower..upper]
    See also min, max, compare.
  • min (other: FIXED_STRING): FIXED_STRING
    Minimum of Current and other.
  • max (other: FIXED_STRING): FIXED_STRING
    Maximum of Current and other.
  • bounded_by (a_min: FIXED_STRING, a_max: FIXED_STRING): FIXED_STRING
    A value that is equal to Current if it is between the limits set by a_min and a_max.
{ANY}
Other features:
{ANY}
Agent-based features:
{ANY}
{ANY}
{}
Agent-based features:
{ANY}
{}
Indexing:
{ANY}
Maximum:
{}
Minimum:
{}
Bits:
{}
make_from_string (model: STRING)
effective procedure
{ANY}
top
Initialize from the characters of model.
hash_code: INTEGER_32
writable attribute
{ANY}
top
The hash-code value of Current.
intern: FIXED_STRING
effective function
{ANY}
top
A shared version of this string.
out_in_tagged_out_memory
effective procedure
{ANY}
top
Append terse printable representation of current object in tagged_out_memory.
fill_tagged_out_memory
effective procedure
{ANY}
top
Append a viewable information in tagged_out_memory in order to affect the behavior of out, tagged_out, etc.
copy (other: FIXED_STRING)
effective procedure
{ANY}
top
In fact this feature can only be used at creation time (see immutable).
immutable: BOOLEAN
writable attribute
{ANY}
top
Is the object immutable?
do_intern (strings: FAST_ARRAY[FIXED_STRING])
effective procedure
{ABSTRACT_STRING}
top
is_interned: BOOLEAN
writable attribute
{ANY}
top
substring (start_index: INTEGER_32, end_index: INTEGER_32): FIXED_STRING
effective function
{ANY}
top
New string consisting of items [start_index.. end_index].
make_from_fixed_string (other: FIXED_STRING, start_index: INTEGER_32, end_index: INTEGER_32)
effective procedure
{}
top
to_external: POINTER
effective function
{ANY}
top
The address of a memory region containing the text of Current, useful to interact with the C language.
from_external (p: POINTER)
effective procedure
{STRING_HANDLER}
top
Internal storage is set using a copy of p.
from_external_copy (p: POINTER)
effective procedure
{STRING_HANDLER}
top
Internal storage is set using a copy of p.
from_external_sized_copy (p: POINTER, size: INTEGER_32)
effective procedure
{STRING_HANDLER}
top
Internal storage is set using a copy of p.
recycle
effective procedure
{RECYCLING_POOL, STRING_RECYCLING_POOL, STRING_HANDLER}
top
Do whatever needs to be done to free resources or recycle other objects when recycling this one
is_shared: BOOLEAN
effective function
{STRING_HANDLER}
top
holders: FAST_ARRAY[FIXED_STRING]
writable attribute
{STRING_HANDLER}
top
share_with (other: FIXED_STRING)
effective procedure
{STRING_HANDLER}
top
unshare
effective procedure
{STRING_HANDLER}
top
new_holders: FAST_ARRAY[FIXED_STRING]
effective function
{}
top
free_holders (a_holders: FAST_ARRAY[FIXED_STRING])
effective procedure
{}
top
holders_memory: FAST_ARRAY[WEAK_REFERENCE[FAST_ARRAY[FIXED_STRING]]]
once function
{}
top
weakrefs: FAST_ARRAY[WEAK_REFERENCE[FAST_ARRAY[FIXED_STRING]]]
once function
{}
top
is_storage_unchanged: BOOLEAN
effective function
{}
top
original: FIXED_STRING
writable attribute
{}
top
check_can_have_storage_signature: BOOLEAN
effective function
{STRING_HANDLER}
top
_inline_agent48 (holder: FIXED_STRING, p: POINTER): BOOLEAN
frozen
effective function
{}
top
writable attribute
{STRING_HANDLER}
top
The place where characters are stored.
storage_lower: INTEGER_32
writable attribute
{STRING_HANDLER}
top
The index of the first character of storage effectively used.
count: INTEGER_32
writable attribute
{ANY}
top
Number of available items in the hoard.
capacity: INTEGER_32
writable attribute
{ANY}
top
Capacity of the storage area.
item (i: INTEGER_32): CHARACTER
effective function
{ANY}
top
Character at position i.
is_equal (other: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
It other does not conform to NATIVELY_STORED_STRING this query is an O(count.max(other.count)) operation, requiring iterating over both strings.
same_as (other: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
Case insensitive is_equal.
index_of (c: CHARACTER, start_index: INTEGER_32): INTEGER_32
effective function
{ANY}
top
Using is_equal for comparison, gives the index of the first occurrence of element at or after start_index.
fast_index_of (c: CHARACTER, start_index: INTEGER_32): INTEGER_32
effective function
{ANY}
top
Using basic = for comparison, gives the index of the first occurrence of element at or after start_index.
reverse_index_of (c: CHARACTER, start_index: INTEGER_32): INTEGER_32
effective function
{ANY}
top
Index of first occurrence of c at or before start_index, The index will be invalid, smaller than lower when no occurrence is found; The search is done in reverse direction, which means from the start_index down to the first character.
fast_reverse_index_of (c: CHARACTER, start_index: INTEGER_32): INTEGER_32
effective function
{ANY}
top
Index of first occurrence of c at or before start_index, The index will be invalid, smaller than lower when no occurrence is found; The search is done in reverse direction, which means from the start_index down to the first character.
has (c: CHARACTER): BOOLEAN
effective function
{ANY}
top
Look for x using is_equal for comparison.
fast_has (c: CHARACTER): BOOLEAN
effective function
{ANY}
top
Look for x using basic = for comparison.
occurrences (c: CHARACTER): INTEGER_32
effective function
{ANY}
top
Number of times character c appears in the string.
infix "&" (another: ABSTRACT_STRING): ABSTRACT_STRING
effective function
{ANY}
top
Current and another concatenating into a new object.
first: CHARACTER
effective function
{ANY}
top
Access to the very first character.
last: CHARACTER
effective function
{ANY}
top
Access to the very last character.
print_on (file: OUTPUT_STREAM)
effective procedure
{ANY}
top
Default printing of current object on a file.
set_count (new_count: INTEGER_32)
effective procedure
{STRING_HANDLER}
top
ensure_capacity (needed_capacity: INTEGER_32)
effective procedure
{STRING_HANDLER}
top
set_storage (new_storage: NATIVE_ARRAY[CHARACTER], new_capacity: INTEGER_32)
effective procedure
{STRING_HANDLER}
top
copy_slice_to_native (start_index: INTEGER_32, end_index: INTEGER_32, target: NATIVE_ARRAY[CHARACTER], target_offset: INTEGER_32)
effective procedure
{STRING_HANDLER}
top
check_set_storage_signature: BOOLEAN
effective function
{}
top
has_storage_signature: BOOLEAN
writable attribute
{STRING_HANDLER}
top
check_valid_storage_signature: BOOLEAN
effective function
{STRING_HANDLER}
top
storage_signature_count: INTEGER_32
writable attribute
{STRING_HANDLER}
top
lower: INTEGER_32
is 1
constant attribute
{ANY}
top
Minimum index; actually, this is always 1 (this feature here to mimic the one of the COLLECTION hierarchy).
upper: INTEGER_32
effective function
{ANY}
top
Maximum index; actually the same value as count (this feature is here to mimic the one of the COLLECTION hierarchy).
is_empty: BOOLEAN
effective function
{ANY}
top
Has string length 0?
infix "@" (i: INTEGER_32): CHARACTER
frozen
effective function
{ANY}
top
The infix notation which is actually just a synonym for item.
infix "^" (a_range: INTEGER_RANGE[INTEGER_32]): ABSTRACT_STRING
effective function
{ANY}
top
Substring of items in a_range .
infix "<" (other: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
Is Current less than other?
infix "<=" (other: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
Is Current less than or equal other?
infix ">" (other: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
Is Current strictly greater than other?
infix ">=" (other: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
Is Current greater than or equal than other?
compare (other: ABSTRACT_STRING): INTEGER_32
effective function
{ANY}
top
If current object equal to other, 0 if smaller, -1; if greater, 1.
three_way_comparison (other: ABSTRACT_STRING): INTEGER_32
effective function
{ANY}
top
If current object equal to other, 0 if smaller, -1; if greater, 1.
item_code (i: INTEGER_32): INTEGER_32
effective function
{ANY}
top
Code of character at position i.
first_index_of (c: CHARACTER): INTEGER_32
effective function
{ANY}
top
Index of first occurrence of c, upper` + 1 if none. See also `last_index_of, index_of, reverse_index_of.
fast_first_index_of (c: CHARACTER): INTEGER_32
effective function
{ANY}
top
Index of first occurrence of c, upper` + 1 if none. See also `last_index_of, index_of, reverse_index_of.
last_index_of (c: CHARACTER): INTEGER_32
effective function
{ANY}
top
Index of last occurrence of c, lower` - 1 if none. See also `first_index_of, reverse_index_of, index_of.
fast_last_index_of (c: CHARACTER): INTEGER_32
effective function
{ANY}
top
Index of last occurrence of c, lower` - 1 if none. See also `first_index_of, reverse_index_of, index_of.
has_substring (other: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
True if Current contains other.
has_suffix (s: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
True if suffix of Current is s.
has_prefix (p: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
True if prefix of Current is p.
is_ascii: BOOLEAN
effective function
{ANY}
top
Is Current only made of (7 bit) ASCII characters?
is_boolean: BOOLEAN
effective function
{ANY}
top
Does Current represent a BOOLEAN?
to_boolean: BOOLEAN
effective function
{ANY}
top
Boolean value "True" yields True, "False" yields False (what a surprise).
is_integer: BOOLEAN
effective function
{ANY}
top
Does 'Current' represent an INTEGER?
to_integer: INTEGER_32
effective function
{ANY}
top
Current must look like an INTEGER.
is_integer_64: BOOLEAN
effective function
{ANY}
top
Does 'Current' represent an INTEGER_64?
to_integer_64: INTEGER_64
effective function
{ANY}
top
Current must look like an INTEGER_64.
is_real: BOOLEAN
effective function
{ANY}
top
Can contents be read as a REAL ? Fails for numbers where the base or "10 ^ exponent" are not in the range Minimum_real ...
to_real: REAL_64
effective function
{ANY}
top
Conversion to the corresponding REAL value.
is_number: BOOLEAN
effective function
{ANY}
top
Can contents be read as a NUMBER?
to_number: NUMBER
effective function
{ANY}
top
Current must looks like an INTEGER.
is_bit: BOOLEAN
effective function
{ANY}
top
True when the contents is a sequence of bits (i.e., mixed characters 0 and characters 1).
binary_to_integer: INTEGER_32
effective function
{ANY}
top
Assume there is enough space in the INTEGER to store the corresponding decimal value.
infix "+" (other: ABSTRACT_STRING): STRING
effective function
{ANY}
top
Create a new STRING which is the concatenation of Current and other.
infix "|" (other: ABSTRACT_STRING): ROPE
effective function
{ANY}
top
Current and other concatenated into a new ROPE, an ABSTRACT_STRING that can be efficiently concatenated.
arg (an_index: INTEGER_32, a_value: ABSTRACT_STRING): ABSTRACT_STRING
effective function
{ANY}
top
A copy of Current with the placeholder "#(an_index)" is replaced (if present) with the content of a_value.
infix "#" (a_value: ABSTRACT_STRING): ABSTRACT_STRING
effective function
{ANY}
top
A copy of Current with a placeholder "#(n)" is replaced with the content of a_value.
as_lower: STRING
effective function
{ANY}
top
New object with all letters in lower case.
as_upper: STRING
effective function
{ANY}
top
New object with all letters in upper case.
replacing (an_old: ABSTRACT_STRING, a_new: ABSTRACT_STRING): STRING
effective function
{ANY}
top
Current with all occurrences of an_old string replaced with a_new.
replacing_in (an_old: ABSTRACT_STRING, a_new: ABSTRACT_STRING, buffer: STRING)
effective procedure
{ANY}
top
Current with all occurrences of an_old string replaced with a_new in buffer.
substring_index (other: ABSTRACT_STRING, start_index: INTEGER_32): INTEGER_32
effective function
{ANY}
top
Position of first occurrence of other at or after start_index.
first_substring_index (other: ABSTRACT_STRING): INTEGER_32
effective function
{ANY}
top
Position of first occurrence of other at or after 1, 0 if none.
split: ARRAY[STRING]
effective function
{ANY}
top
Split the string into an array of words.
split_in (words: COLLECTION[STRING])
effective procedure
{ANY}
top
Same jobs as split but result is appended in words.
new_iterator: ITERATOR[CHARACTER]
effective function
{ANY}
top
same_string (other: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
(Here for ELKS compatibility.)
string: STRING
effective function
{ANY}
top
(Here for ELKS compatibility.)
string_buffer: STRING
once function
{}
top
Private, temporary once buffer.
split_buffer: ARRAY[STRING]
once function
{}
top
computed_hash_code: INTEGER_32
effective function
{}
top
interned: HASHED_DICTIONARY[FAST_ARRAY[FIXED_STRING], INTEGER_32]
once function
{}
top
Key: hash_code Item: interned string
always_print_state: INTEGER_32
is -1
constant attribute
{}
top
normal_state: INTEGER_32
is 0
constant attribute
{}
top
after_delimiter_state: INTEGER_32
is 1
constant attribute
{}
top
after_brace_state: INTEGER_32
is 2
constant attribute
{}
top
Please note that we picked the same values used in MESSAGE_FORMATTER.
debug_string: STRING
writable attribute
{}
top
only used to display the content of the FIXED_STRING in the trace stack
in_range (lower: FIXED_STRING, upper: FIXED_STRING): BOOLEAN
effective function
{ANY}
top
Return True if Current is in range [lower..upper]
See also min, max, compare.
min (other: FIXED_STRING): FIXED_STRING
effective function
{ANY}
top
Minimum of Current and other.
max (other: FIXED_STRING): FIXED_STRING
effective function
{ANY}
top
Maximum of Current and other.
bounded_by (a_min: FIXED_STRING, a_max: FIXED_STRING): FIXED_STRING
effective function
{ANY}
top
A value that is equal to Current if it is between the limits set by a_min and a_max.
enumerate: ENUMERATE[E_]
effective function
{ANY}
top
get_new_iterator: ITERATOR[E_]
frozen
effective function
{ANY}
top
for_each (action: PROCEDURE[TUPLE[TUPLE 1[E_]]])
effective procedure
{ANY}
top
Apply action to every item of Current.
for_all (test: FUNCTION[TUPLE[TUPLE 1[E_]]]): BOOLEAN
effective function
{ANY}
top
Do all items satisfy test?
exists (test: FUNCTION[TUPLE[TUPLE 1[E_]]]): BOOLEAN
effective function
{ANY}
top
Does at least one item satisfy test?
aggregate (action: FUNCTION[TUPLE[TUPLE 2[E_, E_], E_]], initial: E_): E_
effective function
{ANY}
top
Aggregate all the elements starting from the initial value.
generation: INTEGER_32
writable attribute
{ANY}
top
next_generation
effective procedure
{}
top
do_all (action: ROUTINE[TUPLE[TUPLE 1[E_]]])
frozen
effective procedure
{ANY}
top
Apply action to every item of Current.
_inline_agent1 (a: ROUTINE[TUPLE[TUPLE 1[E_]]], e: E_)
frozen
effective procedure
{}
top
valid_index (i: INTEGER_32): BOOLEAN
effective function
{ANY}
top
True when i is valid (i.e., inside actual bounds).
Maximum_character_code: INTEGER_16
{}
top
Largest supported code for CHARACTER values.
Maximum_integer_8: INTEGER_8
is 127
constant attribute
{}
top
Largest supported value of type INTEGER_8.
Maximum_integer_16: INTEGER_16
is 32767
constant attribute
{}
top
Largest supported value of type INTEGER_16.
Maximum_integer: INTEGER_32
is 2147483647
constant attribute
{}
top
Largest supported value of type INTEGER/INTEGER_32.
Maximum_integer_32: INTEGER_32
is 2147483647
constant attribute
{}
top
Largest supported value of type INTEGER/INTEGER_32.
Maximum_integer_64: INTEGER_64
is 9223372036854775807
constant attribute
{}
top
Largest supported value of type INTEGER_64.
Maximum_real_32: REAL_32
is {REAL_32 3.4028234663852885981170418348451692544e+38}
constant attribute
{}
top
Largest non-special (no NaNs nor infinity) supported value of type REAL_32.
Maximum_real: REAL_64
{}
top
Largest non-special (no NaNs nor infinity) supported value of type REAL.
Maximum_real_64: REAL_64
{}
top
Largest non-special (no NaNs nor infinity) supported value of type REAL.
Maximum_real_80: REAL_EXTENDED
{}
top
Largest supported value of type REAL_80.
Minimum_character_code: INTEGER_16
{}
top
Smallest supported code for CHARACTER values.
Minimum_integer_8: INTEGER_8
is -128
constant attribute
{}
top
Smallest supported value of type INTEGER_8.
Minimum_integer_16: INTEGER_16
is -32768
constant attribute
{}
top
Smallest supported value of type INTEGER_16.
Minimum_integer: INTEGER_32
is -2147483648
constant attribute
{}
top
Smallest supported value of type INTEGER/INTEGER_32.
Minimum_integer_32: INTEGER_32
is -2147483648
constant attribute
{}
top
Smallest supported value of type INTEGER/INTEGER_32.
Minimum_integer_64: INTEGER_64
is -9223372036854775808
constant attribute
{}
top
Smallest supported value of type INTEGER_64.
Minimum_real_32: REAL_32
is {REAL_32 -3.40282346638528859811704183484516925440e+38}
constant attribute
{}
top
Smallest non-special (no NaNs nor infinity) supported value of type REAL_32.
Minimum_real: REAL_64
{}
top
Smallest non-special (no NaNs nor infinity) supported value of type REAL.
Minimum_real_64: REAL_64
{}
top
Smallest non-special (no NaNs nor infinity) supported value of type REAL.
Minimum_real_80: REAL_64
{}
top
Smallest supported value of type REAL_80.
Boolean_bits: INTEGER_32
{}
top
Number of bits in a value of type BOOLEAN.
Character_bits: INTEGER_32
{}
top
Number of bits in a value of type CHARACTER.
Integer_bits: INTEGER_32
{}
top
Number of bits in a value of type INTEGER.
Real_bits: INTEGER_32
is 64
constant attribute
{}
top
Number of bits in a value of type REAL.
Pointer_bits: INTEGER_32
{}
top
Number of bits in a value of type POINTER.