Automatic generation produced by ISE Eiffel
note description: "[ Stoppable XML parser with custom settings - carriage_return_character_ignored - entity_mapping ]" author: "Jocelyn Fiat" date: "$Date: 2015-08-21 06:25:02 -0800 (Fri, 21 Aug 2015) $" revision: "$Revision: 97876 $" class interface XML_CUSTOM_PARSER create make -- Instanciate Current feature -- Access callbacks: XML_CALLBACKS -- Callbacks event interface to which events are forwarded -- (from XML_STANDARD_PARSER) generating_type: TYPE [detachable XML_CUSTOM_PARSER] -- 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 frozen last_error_description: detachable STRING_32 -- Last error message -- (from XML_PARSER) 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: XML_CUSTOM_PARSER): 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: XML_CUSTOM_PARSER): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) 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: XML_CUSTOM_PARSER): 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 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 reset -- Reset parser states -- (from XML_STOPPABLE_PARSER) require -- from XML_STANDARD_PARSER True ensure -- from XML_STANDARD_PARSER error_message_void: error_message = Void error_position_void: error_position = Void error_occurred_unset: not error_occurred ensure then -- from XML_STOPPABLE_PARSER stop_requested_unset: not stop_requested set_callbacks (a_callbacks: like callbacks) -- Set `callbacks` to a_callbacks. -- (from XML_STANDARD_PARSER) require -- from XML_CALLBACKS_SOURCE a_callback_not_void: a_callbacks /= Void ensure then -- from XML_STANDARD_PARSER callbacks_set: callbacks = a_callbacks set_encoding (a_encoding: READABLE_STRING_GENERAL) -- Set encoding to a_encoding. -- (from XML_STANDARD_PARSER) require -- from XML_PARSER a_encoding_not_empty: a_encoding /= Void and then (not a_encoding.is_empty and a_encoding.is_valid_as_string_8) feature -- Duplication copy (other: XML_CUSTOM_PARSER) -- 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: XML_CUSTOM_PARSER) -- 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: XML_CUSTOM_PARSER -- 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: XML_CUSTOM_PARSER) -- 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: XML_CUSTOM_PARSER -- 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: XML_CUSTOM_PARSER -- 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 XML_CUSTOM_PARSER -- 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 -- Parsing parse_from_file (a_file: FILE) -- Parse from file a_file -- (from XML_STANDARD_PARSER) require -- from XML_PARSER a_file_attached: a_file /= Void a_file_is_readable: a_file.is_open_read and then a_file.is_readable parse_from_path (a_path: PATH) -- Parse from file named a_path -- (from XML_STANDARD_PARSER) require -- from XML_PARSER a_path_valid: a_path /= Void and then not a_path.is_empty parse_from_stream (a_stream: XML_INPUT_STREAM) -- Parse stream a_stream -- (from XML_STANDARD_PARSER) require -- from XML_PARSER a_stream_attached: a_stream /= Void parse_from_string (a_string: READABLE_STRING_GENERAL) -- Parse string general a_string -- (from XML_PARSER) require -- from XML_PARSER a_string_attached: a_string /= Void parse_from_string_32 (a_string: READABLE_STRING_32) -- Parse string a_string -- (from XML_STANDARD_PARSER) require -- from XML_PARSER a_string_attached: a_string /= Void parse_from_string_8 (a_string: READABLE_STRING_8) -- Parse string a_string -- (from XML_STANDARD_PARSER) require -- from XML_PARSER a_string_attached: a_string /= Void feature -- Parsing status error_occurred: BOOLEAN -- Error occurred? -- (from XML_STANDARD_PARSER) parsing_stopped: BOOLEAN -- Parsing stopped? -- (from XML_STANDARD_PARSER) stop_requested: BOOLEAN -- Requested to stop parsing -- (from XML_STOPPABLE_PARSER) 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 -- Settings carriage_return_character_ignored: BOOLEAN -- Ignore "carriage return" character CR '%R' characters -- occurring with dos format with CR+LF as end of line. -- By default: True entity_mapping: HASH_TABLE [CHARACTER_32, STRING_32] -- Entities mapping -- You can provide your own extended mapping with set_entity_mapping error_ignored: BOOLEAN -- Ignore error? -- If True, do not stop parser on error (no guarantee) -- Default: False -- (from XML_STOPPABLE_PARSER) feature -- Settings change set_carriage_return_ignored (b: BOOLEAN) -- Set `carriage_return_character_ignored` to b set_error_ignored (b: BOOLEAN) -- Set `error_ignored` to b -- (from XML_STOPPABLE_PARSER) feature -- Status is_correct: BOOLEAN -- Has no error been detected? -- (from XML_PARSER) last_error: INTEGER_32 -- Last error's code -- See {XML_ERROR_CODES}. -- (from XML_PARSER) feature -- Status buffer_position: XML_POSITION -- XML position in buffer -- (from XML_STANDARD_PARSER) byte_index: INTEGER_32 -- Byte index -- (from XML_STANDARD_PARSER) column: INTEGER_32 -- Last column number -- (from XML_STANDARD_PARSER) error_message: detachable STRING_32 -- Error message -- (from XML_STANDARD_PARSER) error_position: detachable XML_POSITION -- Position when error occurred -- (from XML_STANDARD_PARSER) has_warning: BOOLEAN -- Did parsing reported warning? -- (from XML_STANDARD_PARSER) line: INTEGER_32 -- Last line number -- (from XML_STANDARD_PARSER) position: XML_POSITION -- Logical position -- (from XML_STANDARD_PARSER) ensure -- from XML_PARSER result_attached: Result /= Void truncation_reported: BOOLEAN -- Is parsed xml content truncated? -- (from XML_STANDARD_PARSER) warning_message: detachable STRING_32 -- Warning message -- (from XML_STANDARD_PARSER) feature -- Status change abort -- Request the parser to stop -- Was declared in {XML_STOPPABLE_PARSER} as synonym of `request_stop`. -- (from XML_STOPPABLE_PARSER) request_stop -- Request the parser to stop -- Was declared in {XML_STOPPABLE_PARSER} as synonym of `abort`. -- (from XML_STOPPABLE_PARSER) invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2014, 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 XML_CUSTOM_PARSER -- Generated by Eiffel Studio --
For more details: eiffel.org