Automatic generation produced by ISE Eiffel

Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:
note description: "[ Pretty printer, output as XML document Note: the original code is from Gobo's XM library (http://www.gobosoft.com/) ]" date: "$Date: 2013-05-20 15:15:17 -0800 (Mon, 20 May 2013) $" revision: "$Revision: 92557 $" class interface XML_PRETTY_PRINT_FILTER create make_null -- Don't forward anything make_with_next (a_callbacks: like next) feature -- Initialization set_output_file (a_file: FILE) -- Initialize output to given file, -- (from XML_OUTPUT) require -- from XML_OUTPUT a_file_not_void: a_file /= Void set_output_standard -- Set output to standard output (Default). -- (from XML_OUTPUT) set_output_standard_error -- Set output to standard error. -- (from XML_OUTPUT) set_output_stream (a_stream: like output_stream) -- Set output to stream. -- (from XML_OUTPUT) require -- from XML_OUTPUT a_stream_not_void: a_stream /= Void set_output_string (a_string: STRING_GENERAL) -- Initialize output to given string, -- the result must still be collected from -- last_output, which may be another string. -- (from XML_OUTPUT) require -- from XML_OUTPUT a_string_not_void: a_string /= Void is_string_8_or_32: attached {STRING_8} a_string or attached {STRING_32} a_string ensure -- from XML_OUTPUT last_output_set: internal_last_output = a_string set_output_to_string -- Set output to new string. -- (from XML_OUTPUT) ensure -- from XML_OUTPUT last_output_empty: attached internal_last_output as o and then o.is_empty set_output_to_string_32 -- Set output to new string. -- (from XML_OUTPUT) ensure -- from XML_OUTPUT last_output_empty: attached internal_last_output as o and then o.is_empty feature -- Access associated_parser: detachable XML_PARSER -- Associated parser -- mainly used to report error back to the parser -- to handle position -- (from XML_CALLBACKS) next: XML_CALLBACKS -- Callbacks event interface to which events are forwarded; -- (from XML_FORWARD_CALLBACKS) generating_type: TYPE [detachable XML_PRETTY_PRINT_FILTER] -- 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 last_output: detachable STRING_8 -- (from XML_OUTPUT) require -- from XML_OUTPUT last_output_is_valid_as_string_8: last_output_is_valid_as_string_8 last_output_32: detachable STRING_32 -- (from XML_OUTPUT) 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_PRETTY_PRINT_FILTER): 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_PRETTY_PRINT_FILTER): 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_PRETTY_PRINT_FILTER): 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 has_last_output: BOOLEAN -- Has last output? -- (from XML_OUTPUT) last_output_is_valid_as_string_8: BOOLEAN -- Is associated last output a valid string_8 value? -- (from XML_OUTPUT) 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 set_associated_parser (p: like associated_parser) -- Set p to `associated_parser` -- (from XML_CALLBACKS) feature -- Duplication copy (other: XML_PRETTY_PRINT_FILTER) -- 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_PRETTY_PRINT_FILTER) -- 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_PRETTY_PRINT_FILTER -- 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_PRETTY_PRINT_FILTER) -- 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_PRETTY_PRINT_FILTER -- 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_PRETTY_PRINT_FILTER -- 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_PRETTY_PRINT_FILTER -- 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 -- Assertion has_resolved_namespaces: BOOLEAN -- Does this callback event consumer expect resolved -- namespaces? -- If True, it must be located downstream of a filter -- or source producing resolved namespaces such -- as XML_NAMESPACE_RESOLVER. -- (from XML_CALLBACKS) feature -- Basic operation flush -- Flush `output_stream`. -- (from XML_OUTPUT) feature -- Constants Amp_char: CHARACTER_8 = '&' -- (from XML_MARKUP_CONSTANTS) Amp_entity: STRING_32 = "&amp;" -- (from XML_MARKUP_CONSTANTS) Apos_entity: STRING_32 = "&apos;" -- (from XML_MARKUP_CONSTANTS) Char_entity_prefix: STRING_32 = "&#" -- (from XML_MARKUP_CONSTANTS) Comment_end: STRING_32 = "-->" -- (from XML_MARKUP_CONSTANTS) Comment_start: STRING_32 = "<!--" -- (from XML_MARKUP_CONSTANTS) Cr_char: CHARACTER_8 = '%R' -- (from XML_MARKUP_CONSTANTS) Emptytag_end: STRING_32 = "/>" -- (from XML_MARKUP_CONSTANTS) Emptytag_start: STRING_32 -- (from XML_MARKUP_CONSTANTS) Entity_suffix: STRING_32 = ";" -- (from XML_MARKUP_CONSTANTS) Eq_s: STRING_32 = "=" -- (from XML_MARKUP_CONSTANTS) Etag_end: STRING_32 -- (from XML_MARKUP_CONSTANTS) Etag_start: STRING_32 = "</" -- (from XML_MARKUP_CONSTANTS) Gt_char: CHARACTER_8 = '>' -- (from XML_MARKUP_CONSTANTS) Gt_entity: STRING_32 = "&gt;" -- (from XML_MARKUP_CONSTANTS) Lf_char: CHARACTER_8 = '%N' -- (from XML_MARKUP_CONSTANTS) Lf_s: STRING_32 = "%N" -- (from XML_MARKUP_CONSTANTS) Lt_char: CHARACTER_8 = '<' -- (from XML_MARKUP_CONSTANTS) Lt_entity: STRING_32 = "&lt;" -- (from XML_MARKUP_CONSTANTS) Pi_end: STRING_32 = "?>" -- (from XML_MARKUP_CONSTANTS) Pi_start: STRING_32 = "<?" -- (from XML_MARKUP_CONSTANTS) Prefix_separator: STRING_32 = ":" -- (from XML_MARKUP_CONSTANTS) Quot_char: CHARACTER_8 = '"' -- (from XML_MARKUP_CONSTANTS) Quot_entity: STRING_32 = "&quot;" -- (from XML_MARKUP_CONSTANTS) Quot_s: STRING_32 = "%"" -- (from XML_MARKUP_CONSTANTS) Space_char: CHARACTER_8 = ' ' -- (from XML_MARKUP_CONSTANTS) Space_s: STRING_32 = " " -- (from XML_MARKUP_CONSTANTS) Stag_end: STRING_32 = ">" -- (from XML_MARKUP_CONSTANTS) Stag_start: STRING_32 = "<" -- (from XML_MARKUP_CONSTANTS) Tab_char: CHARACTER_8 = '%T' -- (from XML_MARKUP_CONSTANTS) Xml_base: STRING_32 = "base" -- (from XML_MARKUP_CONSTANTS) Xml_base_with_prefix: STRING_32 = "xml:base" -- (from XML_MARKUP_CONSTANTS) Xml_id: STRING_32 = "id" -- (from XML_MARKUP_CONSTANTS) Xml_id_with_prefix: STRING_32 = "xml:id" -- (from XML_MARKUP_CONSTANTS) Xml_lang: STRING_32 = "lang" -- (from XML_MARKUP_CONSTANTS) Xml_lang_with_prefix: STRING_32 = "xml:lang" -- (from XML_MARKUP_CONSTANTS) Xml_prefix: STRING_32 = "xml" -- (from XML_MARKUP_CONSTANTS) Xml_space: STRING_32 = "space" -- (from XML_MARKUP_CONSTANTS) Xml_space_preserve: STRING_32 = "preserve" -- (from XML_MARKUP_CONSTANTS) Xml_version_1_0: STRING_32 = "1.0" -- (from XML_MARKUP_CONSTANTS) Xml_version_1_1: STRING_32 = "1.1" -- (from XML_MARKUP_CONSTANTS) feature -- Content on_content (a_content: READABLE_STRING_32) -- Text content. -- NOT atomic: successive content may be different. -- Default: forward event to 'next'. require -- from XML_CALLBACKS not_void: a_content /= Void not_empty: a_content.count >= 0 feature -- Document on_finish -- Forward finish. require -- from XML_CALLBACKS True on_start -- Forward start. -- (from XML_FORWARD_CALLBACKS) require -- from XML_CALLBACKS True feature -- Errors on_error (a_message: READABLE_STRING_32) -- Event producer detected an error. -- (from XML_FORWARD_CALLBACKS) require -- from XML_CALLBACKS not_void: a_message /= Void feature -- Meta on_comment (a_content: READABLE_STRING_32) -- Print comment. require -- from XML_CALLBACKS a_content_not_void: a_content /= Void on_processing_instruction (a_name: READABLE_STRING_32; a_content: READABLE_STRING_32) -- Print processing instruction. require -- from XML_CALLBACKS name_not_void: a_name /= Void content_not_void: a_content /= Void on_xml_declaration (a_version: READABLE_STRING_32; an_encoding: detachable READABLE_STRING_32; a_standalone: BOOLEAN) -- XML declaration. require -- from XML_CALLBACKS a_version_not_void: a_version /= Void a_version_not_empty: a_version.count > 0 a_version_is_valid: a_version.is_valid_as_string_8 an_encoding_is_valid: an_encoding /= Void implies an_encoding.is_valid_as_string_8 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 -- Output, interface to descendants output (a_string: READABLE_STRING_GENERAL) -- Output string 8 value. -- All output from descendants should go through this for -- convenient redefinition. -- (from XML_OUTPUT) require -- from XML_OUTPUT a_string_not_void: a_string /= 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_next (a_callbacks: like next) -- Set callbacks to a_callbacks. -- (from XML_FORWARD_CALLBACKS) require -- from XML_CALLBACKS_SOURCE a_callback_not_void: a_callbacks /= Void ensure then -- from XML_FORWARD_CALLBACKS callbacks_set: next = a_callbacks feature -- Support has_namespace (a: detachable READABLE_STRING_32): BOOLEAN -- Is namespace resolved? -- (from XML_CALLBACKS) has_prefix (a: detachable READABLE_STRING_32): BOOLEAN -- Is prefix in use? -- (from XML_CALLBACKS) is_local_part (a: detachable READABLE_STRING_32): BOOLEAN -- Is this a valid local part string? -- (from XML_CALLBACKS) ensure -- from XML_CALLBACKS definition: Result = (a /= Void and then a.count > 0) feature -- Tag on_attribute (a_namespace: detachable READABLE_STRING_32; a_prefix: detachable READABLE_STRING_32; a_local_part: READABLE_STRING_32; a_value: READABLE_STRING_32) -- Print attribute. require -- from XML_CALLBACKS unresolved_namespace_is_void: has_resolved_namespaces implies a_namespace /= Void local_part: is_local_part (a_local_part) a_value_not_void: a_value /= Void on_end_tag (a_namespace: detachable READABLE_STRING_32; a_prefix: detachable READABLE_STRING_32; a_local_part: READABLE_STRING_32) -- Print end tag. require -- from XML_CALLBACKS unresolved_namespace_is_void: has_resolved_namespaces implies a_namespace /= Void local_part: is_local_part (a_local_part) on_start_tag (a_namespace: detachable READABLE_STRING_32; a_prefix: detachable READABLE_STRING_32; a_local_part: READABLE_STRING_32) -- Print start of start tag. require -- from XML_CALLBACKS unresolved_namespace_is_void: has_resolved_namespaces implies a_namespace /= Void local_part: is_local_part (a_local_part) on_start_tag_finish -- Print end of start tag. require -- from XML_CALLBACKS True feature -- XML namespace Default_namespace: STRING_32 = "" -- (from XML_XMLNS_CONSTANTS) Xmlns: STRING_32 = "xmlns" -- (from XML_XMLNS_CONSTANTS) Xmlns_namespace: STRING_32 = "http://www.w3.org/2000/xmlns/" -- (from XML_XMLNS_CONSTANTS) invariant -- from XML_CALLBACKS_FILTER next_not_void: next /= Void -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from XML_OUTPUT output_stream_attached: output_stream /= Void note copyright: "Copyright (c) 1984-2012, 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_PRETTY_PRINT_FILTER
Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:

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