Automatic generation produced by ISE Eiffel

Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:
note description: "A low-level string class to convert Eiffel strings to UTF-16 Unicode strings used by the Windows API." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2019-08-02 00:08:17 -0800 (Fri, 02 Aug 2019) $" revision: "$Revision: 103380 $" class interface WEL_STRING create make (a_string: READABLE_STRING_GENERAL) -- Initialize an instance of Current using a_string treated as a sequence -- of Unicode characters. -- (from NATIVE_STRING) require -- from NATIVE_STRING a_string_not_void: a_string /= Void make_empty (a_length: INTEGER_32) -- Initialize an empty instance of Current that will accommodate a_length code units. -- The memory area is not initialized. -- (from NATIVE_STRING) require -- from NATIVE_STRING a_length_positive: a_length >= 0 make_from_path (a_path: PATH) -- Make a C string from a_path. make_by_pointer (a_pointer: POINTER) -- Initialize current from a_pointer, a platform system specific null-terminated string. -- (from NATIVE_STRING) require -- from NATIVE_STRING a_path_pointer_not_null: a_pointer /= default_pointer make_by_pointer_and_count (a_ptr: POINTER; a_length: INTEGER_32) -- Make a copy of first a_length byte of string pointed by a_ptr. require a_ptr_not_null: a_ptr /= default_pointer a_length_non_negative: a_length >= 0 a_length_valid: (a_length \\ {WEL_STRING}.character_size) = 0 make_with_newline_conversion (a_string: READABLE_STRING_GENERAL) -- Make a C string from a_string guaranteeing that all newline (linefeed) characters '%N' -- are prepended with a carriage return character '%R'. share_from_pointer (a_ptr: POINTER) -- New instance sharing a_ptr. require a_ptr_not_null: a_ptr /= default_pointer share_from_pointer_and_count (a_ptr: POINTER; a_length: INTEGER_32) -- New instance sharing a_ptr of a_length byte. require a_ptr_not_null: a_ptr /= default_pointer a_length_non_negative: a_length >= 0 a_length_valid: (a_length \\ {WEL_STRING}.character_size) = 0 feature -- Access generating_type: TYPE [detachable WEL_STRING] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty item: POINTER -- Get pointer to allocated area. -- (from NATIVE_STRING) ensure -- from NATIVE_STRING item_not_null: Result /= default_pointer managed_data: MANAGED_POINTER -- Hold data of Current. -- (from NATIVE_STRING) null_separated_paths: ARRAYED_LIST [PATH] -- Retrieve all paths contained in item. Strings are -- NULL separared inside item. ensure result_not_void: Result /= Void null_separated_strings: LIST [STRING_32] -- Retrieve all string contained in item. Strings are -- NULL separared inside item. ensure result_not_void: Result /= Void raw_string: STRING_8 -- Sequence of bytes representing Current. -- (from NATIVE_STRING) read_string_into (a_string: STRING_GENERAL) -- Append of all characters of Current to a_string. require a_string_not_void: a_string /= Void a_string_large_enough: a_string.count >= count read_substring_into (a_string: STRING_32; start_pos, end_pos: INTEGER_32) -- Copy of substring containing all characters at indices -- between start_pos and end_pos appended into a_string. require a_string_not_void: a_string /= Void start_position_big_enough: start_pos >= 1 end_position_big_enough: start_pos <= end_pos + 1 end_position_not_too_big: end_pos <= (capacity // Character_size) a_string_large_enough: a_string.count >= end_pos - start_pos + 1 space_separated_strings: LIST [STRING_32] -- Retrieve all string contained in item. Strings are -- space-separared inside item. ensure result_not_void: Result /= Void string: STRING_32 -- Representation of Current up to the first null character. -- (from NATIVE_STRING) string_discarding_carriage_return: STRING_32 -- Eiffel string, ignoring count and discarding carriage return '%R' characters. Reads until a null character is read. substring (start_pos, end_pos: INTEGER_32): STRING_32 -- Copy of substring containing all code units at indices -- between start_pos and end_pos. -- (from NATIVE_STRING) require -- from NATIVE_STRING start_position_big_enough: start_pos >= 1 end_position_big_enough: start_pos <= end_pos + 1 end_position_not_too_big: end_pos <= (capacity // Character_size) ensure -- from NATIVE_STRING susbstring_not_void: Result /= Void feature -- Measurement bytes_count: INTEGER_32 -- Number of bytes used by Current not including the null terminating character. -- (from NATIVE_STRING) ensure -- from NATIVE_STRING bytes_count_non_negative: Result >= 0 capacity: INTEGER_32 -- Number of bytes in Current. -- (from NATIVE_STRING) character_capacity: INTEGER_32 -- Number of characters in Current. Character_size: INTEGER_32 = 2 -- Size of a code unit. occurrences (c: CHARACTER_32): INTEGER_32 -- Number of times c appears in string. unicode_character_count: INTEGER_32 -- Size in Unicode character of Current count: INTEGER_32 -- Number of units used by Current not including the null terminating unit. -- (from NATIVE_STRING) feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal (other: WEL_STRING): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: WEL_STRING): BOOLEAN -- Is content of string identical to content of string other? -- (from NATIVE_STRING) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal (other: WEL_STRING): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void Exists: BOOLEAN = True -- item is always valid. same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) feature -- Element change fill_blank -- Fill Current with zeros. fill_value (a_value: INTEGER_8) -- Fill Current with a_value. set_count (a_count: INTEGER_32) -- Set count with a_count. -- Note: Current content from index 1 to -- count.min (a_count) is unchanged. require a_count_non_negative: a_count >= 0 ensure count_set: count = a_count set_null_character (offset: INTEGER_32) -- Set %U at offset position of Current. -- First position being  at 0 index. require valid_offset: offset >= 0 and offset <= (capacity // Character_size) ensure string_set: managed_data.read_integer_16 (offset) = 0 set_shared_from_pointer (a_ptr: POINTER) -- New instance sharing a_ptr. -- (from NATIVE_STRING) require -- from NATIVE_STRING a_ptr_not_null: a_ptr /= default_pointer set_shared_from_pointer_and_count (a_ptr: POINTER; a_length: INTEGER_32) -- New instance sharing a_ptr of a_length byte. Space for an additional -- null terminating code unit is added to managed_data. -- (from NATIVE_STRING) require -- from NATIVE_STRING a_ptr_not_null: a_ptr /= default_pointer a_length_non_negative: a_length >= 0 a_length_valid: (a_length \\ Character_size) = 0 set_size_in_string (n: INTEGER_32) -- Set two first bytes of string pointed by item to -- value represented by n in a two bytes representation. require valid_size: n > 0 small_enough: n <= {INTEGER_16}.max_value.to_integer_32 set_string (a_string: READABLE_STRING_GENERAL) -- Set string with a_string treated as a sequence of Unicode characters. -- (from NATIVE_STRING) require -- from NATIVE_STRING a_string_not_void: a_string /= Void set_string_with_newline_conversion (a_string: READABLE_STRING_GENERAL) -- Make a C string from a_string guaranteeing that all newline (linefeed) characters '%N' -- are prepended with a carriage return character '%R'. require a_string_not_void: a_string /= Void set_substring (a_string: READABLE_STRING_GENERAL; start_pos, end_pos: INTEGER_32) -- Set string with a subset of a_string from a_start_pos index to end_pos index. -- (from NATIVE_STRING) require -- from NATIVE_STRING a_string_not_void: a_string /= Void start_position_big_enough: start_pos >= 1 end_position_big_enough: start_pos <= end_pos + 1 end_pos_small_enough: end_pos <= a_string.count feature -- Duplication copy (other: WEL_STRING) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: WEL_STRING) -- Effect equivalent to that of: -- copy (other . deep_twin) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: WEL_STRING -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: WEL_STRING) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: WEL_STRING -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: WEL_STRING -- New object equal to Current -- twin calls copy; to change copying/twinning semantics, redefine copy. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable WEL_STRING -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.default for -- some p of type POINTER.) -- (from ANY) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void feature -- Status Report is_empty: BOOLEAN -- Is current empty? -- (from NATIVE_STRING) feature --{NONE} -- Initialization make_by_pointer_and_count (a_ptr: POINTER; a_length: INTEGER_32) -- Make a copy of first a_length byte of string pointed by a_ptr. require a_ptr_not_null: a_ptr /= default_pointer a_length_non_negative: a_length >= 0 a_length_valid: (a_length \\ {WEL_STRING}.character_size) = 0 make_from_path (a_path: PATH) -- Make a C string from a_path. make_with_newline_conversion (a_string: READABLE_STRING_GENERAL) -- Make a C string from a_string guaranteeing that all newline (linefeed) characters '%N' -- are prepended with a carriage return character '%R'. invariant managed_data_not_void: managed_data /= Void count_not_negative: count >= 0 bytes_count_valid: (bytes_count \\ Character_size) = 0 -- from NATIVE_STRING little_endian_windows: {PLATFORM}.is_windows implies Platform.Is_little_endian even_count_on_windows: {PLATFORM}.is_windows implies managed_data.count \\ Character_size = 0 -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2019, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class WEL_STRING
Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:

-- Generated by Eiffel Studio --
For more details: eiffel.org