Automatic generation produced by ISE Eiffel
note description: "Formatter for integral numbers" library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." names: format_integer date: "$Date: 2013-03-20 15:43:02 -0800 (Wed, 20 Mar 2013) $" revision: "$Revision: 92323 $" class interface FORMAT_INTEGER create make (w: INTEGER_32) require reasonable_field: w >= 1 ensure blank_fill: fill_character = ' ' show_sign_negative: show_sign_negative no_separator: no_separator width_set: width = w right_justified: right_justified leading_sign: leading_sign feature -- Initialization make (w: INTEGER_32) require reasonable_field: w >= 1 ensure blank_fill: fill_character = ' ' show_sign_negative: show_sign_negative no_separator: no_separator width_set: width = w right_justified: right_justified leading_sign: leading_sign feature -- Access bracketted_negative: BOOLEAN -- Enclose negative numbers in brackets? fill_character: CHARACTER_8 -- Padding character. generating_type: TYPE [detachable FORMAT_INTEGER] -- 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 justification: INTEGER_32 -- Where in the field the format goes. separator: CHARACTER_8 -- Separator between 1000's of numbers. sign_format: INTEGER_32 -- How the sign is formatted. sign_string: STRING_8 -- Formatting details for the sign. trailing_sign: BOOLEAN -- Is the sign at the end? width: INTEGER_32 -- Width of the field. 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: FORMAT_INTEGER): 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: FORMAT_INTEGER): 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: FORMAT_INTEGER): 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 centered: BOOLEAN -- Are numbers to be formatted centered? ensure Result = (justification = Center_justification) 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 ignore_sign: BOOLEAN -- Ignore the sign of a number? ensure Result = (sign_format = Ignore_sign_value) leading_sign: BOOLEAN -- Is the sign leading? ensure Result = not trailing_sign left_justified: BOOLEAN -- Are numbers to be formatted with spaces on the right? ensure Result = (justification = Left_justification) no_separator: BOOLEAN -- Is there a separator? ensure Result = (separator = '%U') not_justified: BOOLEAN -- Are numbers to be formatted in smallest string possible ensure Result = (justification = No_justification) right_justified: BOOLEAN -- Are numbers to be formatted with spaces on the left? ensure Result = (justification = Right_justification) 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)) show_sign: BOOLEAN -- Are numbers to show sign whether positive or negative? ensure Result = (sign_format = Show_sign_value) show_sign_negative: BOOLEAN -- Are numbers to show sign only when negative? ensure Result = (sign_format = Sign_negative_value) show_sign_positive: BOOLEAN -- Are numbers to show sign only when positive? ensure Result = (sign_format = Sign_positive_value) feature -- Status setting asterisk_fill -- Fill numbers with asterisks. ensure fill_character = '*' blank_fill -- Fill numbers with blanks. ensure fill_character = ' ' bracket_negative -- Bracket negative numbers. ensure bracketted_negative center_justify -- Put padding on right and left ensure centered comma_separate -- Set separator to comma. ensure separator = ',' dollar_fill -- Fill numbers with dollars. ensure fill_character = '$' dot_separate -- Set separator to period. ensure separator = '.' left_justify --Put padding on right ensure left_justified no_justify -- Always return the smallest string possible ensure not_justified remove_separator -- Remove the separator. ensure separator = '%U' right_justify -- Put padding on left ensure right_justified set_fill (c: CHARACTER_8) -- Fill numbers with c ensure fill_character = c set_separator (c: CHARACTER_8) -- Set the separator to c ensure separator = c set_sign (s: STRING_8) -- Set sign values for positive, zero, negative -- All values must be the same length. -- Stored as negative, zero, positive. require s /= Void s.count >= 3 s.count \\ 3 = 0 ensure sign_set: sign_string ~ s set_width (w: INTEGER_32) -- Set width to w require wide_enough: w >= 1 ensure width = w sign_cr_dr -- Set sign for CR/DR ensure sign_string ~ "CR DR" sign_dr_cr -- Set sign for DR/CR ensure sign_string ~ "DR CR" sign_floating_dollar -- Set sign for floating dollar. ensure sign_string ~ "$$$" sign_floating_dollar_signed -- Set sign for floating dollar include sign. ensure sign_string ~ "-$ $+$" sign_ignore -- Do not show sign. ensure ignore_sign sign_leading -- Set the sign to lead ensure leading_sign sign_negative_only -- Show sign for negative numbers only. ensure show_sign_negative sign_normal -- Set sign for - and +. ensure sign_string ~ "- +" sign_positive_only -- Show sign for positive numbers only. ensure show_sign_positive sign_show -- Show sign for all numbers. ensure show_sign sign_trailing -- Set the sign to trail ensure trailing_sign unbracket_negative -- Do not bracket negative numbers. ensure not bracketted_negative underscore_separate -- Set separator to underscore. ensure separator = '_' zero_fill -- Fill numbers with zeros. ensure fill_character = '0' feature -- Conversion formatted (i: INTEGER_32): STRING_8 -- Format the integer. ensure exists: Result /= Void correct_length: not_justified or Result.count >= width feature -- Duplication copy (other: FORMAT_INTEGER) -- 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: FORMAT_INTEGER) -- 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: FORMAT_INTEGER -- 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: FORMAT_INTEGER) -- 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: FORMAT_INTEGER -- 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: FORMAT_INTEGER -- 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 FORMAT_INTEGER -- 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 invariant sign_string_attached: sign_string /= Void sign_string_count: sign_string.count >= 3 sign_string_equal_parts: sign_string.count \\ 3 = 0 wide_enough: width >= 1 No_justification <= justification and justification <= Right_justification -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) 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 FORMAT_INTEGER -- Generated by Eiffel Studio --
For more details: eiffel.org