Automatic generation produced by ISE Eiffel
note description: "Stream of data stored in non Eiffel memory" library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2021-12-23 10:03:49 -0900 (Thu, 23 Dec 2021) $" revision: "$Revision: 106072 $" class interface MEMORY_STREAM create make (a_size: INTEGER_32) -- Initialize current with a_size bytes. require valid_size: a_size >= 0 ensure non_void_area: area /= default_pointer capacity_set: capacity = a_size is_resizable_set: is_resizable make_from_pointer (an_area: POINTER; a_size: INTEGER_32) -- Initialize Current with an_area and a_size. -- Current will not be resizable as we do not know -- who created an_area. require an_area_not_null: an_area /= default_pointer valid_size: a_size >= 0 ensure non_void_area: area /= default_pointer capacity_set: capacity = a_size is_resizable_set: not is_resizable feature -- Access area: POINTER -- Memory area that holds data. ensure non_void_area: Result /= default_pointer at alias "@" (i: INTEGER_32): INTEGER_8 assign put -- Entry at index i. -- Was declared in {MEMORY_STREAM} as synonym of `item`. require valid_index: valid_index (i) capacity: INTEGER_32 -- Number of bytes in Current. count: INTEGER_32 -- Number of bytes in Current. generating_type: TYPE [detachable MEMORY_STREAM] -- 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 alias "[]" (i: INTEGER_32): INTEGER_8 assign put -- Entry at index i. -- Was declared in {MEMORY_STREAM} as synonym of `at`. require valid_index: valid_index (i) 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 alias "≡≡≡" (other: MEMORY_STREAM): 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: like Current): BOOLEAN -- Is other attached to an object considered -- equal to current object? 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 alias "≜" (other: MEMORY_STREAM): 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 is_resizable: BOOLEAN -- Can Current be resized? 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)) valid_index (i: INTEGER_32): BOOLEAN -- Is i within the bounds of Current? feature -- Element change append (other: like Current) -- Append other at the end of Current. require other_not_void: other /= Void resizable: is_resizable force (v: INTEGER_8; i: INTEGER_32) -- Replace i-th entry by v. -- If i is out of bound, reallocate Current. require positive_index: i > 0 ensure inserted: item (i) = v put (v: INTEGER_8; i: INTEGER_32) -- Replace i-th entry by v. require valid_index: valid_index (i) ensure inserted: item (i) = v feature -- Duplication copy (other: like Current) -- Copy other in Current require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: MEMORY_STREAM) -- 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: MEMORY_STREAM -- 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: MEMORY_STREAM) -- 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: MEMORY_STREAM -- 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: MEMORY_STREAM -- 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 MEMORY_STREAM -- 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 -- Setting set_capacity (n: INTEGER_32) -- Was declared in {MEMORY_STREAM} as synonym of `set_count`. require valid_index: valid_index (n - 1) ensure capacity_set: capacity = n set_count (n: INTEGER_32) -- Was declared in {MEMORY_STREAM} as synonym of `set_capacity`. require valid_index: valid_index (n - 1) ensure capacity_set: capacity = n invariant non_void_internal_area: internal_area /= Void area_not_null: area /= default_pointer -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2021, 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 MEMORY_STREAM -- Generated by Eiffel Studio --
For more details: eiffel.org