Automatic generation produced by ISE Eiffel
note description: "Abstract representation of a dictionary file" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2011-01-13 14:53:42 -0900 (Thu, 13 Jan 2011) $" revision: "$Revision: 85350 $" deferred class interface I18N_FILE feature -- Access entry_count: INTEGER_32 -- Number of entries in the file. generating_type: TYPE [detachable I18N_FILE] -- 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 locale: detachable STRING_32 -- Locale of file -- -- Note: This is a best guess and may not be accurate. original_plural_string (i: INTEGER_32): STRING_32 -- Original plural string for ith entry -- -- i: Entry index -- Result: Original plural string, otherwise Void if there is none require file_open: opened i_valid_index: valid_index (i) plurals_exist: entry_has_plurals (i) original_singular_string (i: INTEGER_32): STRING_32 -- Original singular string for ith entry -- -- i: Entry index -- Result: Original singular string require file_open: opened i_valid_index: valid_index (i) plural_form: INTEGER_32 -- Plural form used by the file -- -- This may have exactly 10 values: -- 0: unknown/unitialised/no plural support -- 1: Only one form (Chinese, Japanese, Korean, Turkish etc..) -- 2: Two forms, singular used for one only (Germanic languages: English uses this) -- 3: Two forms, singular used for zero and one (Romanic languages) -- 4: Three forms, special case for zero (Baltic languages, e.g Latvian) -- 5: Three forms, special cases for one and two (Irish, Arabic, etc.) -- 6: Three forms, special case for numbers ending in 1[2-9] (Lithuanian) -- 7: Three forms, special cases for numbers ending in 1 and 2, 3, 4, except those ending in 1[1-4] (Slavic languages) -- 8: Three forms, special case for one and some numbers ending in 2, 3, or 4 (Polish) -- 9: Four forms, special case for one and all numbers ending in 02, 03, or 04 (Slovenian) -- See I18N_PLURAL_TOOLS for more information translated_plural_strings (i: INTEGER_32): ARRAY [STRING_32] -- Translated plural strings for ith entry -- -- Note: Result array is indexed exactly from 0 to 3 -- -- i: Entry index -- Result: Array containing plural translations, otherwise Void if there are no plural translations require file_open: opened i_valid_index: valid_index (i) plurals_exist: entry_has_plurals (i) ensure result_exists: Result /= Void correct_lower_index: Result.lower = 0 correct_upper_index: Result.upper = 3 translated_singular_string (i: INTEGER_32): STRING_32 -- Translated singular string for ith entry require file_open: opened i_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: I18N_FILE): 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: I18N_FILE): 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: I18N_FILE): 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 entry_has_plurals (i: INTEGER_32): BOOLEAN -- Does this entry have any plurals? require file_open: opened i_valid_index: valid_index (i) opened: BOOLEAN -- Is the file opened? 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: BOOLEAN -- Was file parsed correctly? valid_index (i: INTEGER_32): BOOLEAN -- Is this a valid index for an entry? require file_open: opened feature -- Duplication copy (other: I18N_FILE) -- 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: I18N_FILE) -- 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: I18N_FILE -- 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: I18N_FILE) -- 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: I18N_FILE -- 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: I18N_FILE -- 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 close -- Close file. require file_open: opened ensure closed: not opened frozen default: detachable I18N_FILE -- 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 open -- Open file. require file_closed: not opened 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 -- Shared object Plural_tools: I18N_PLURAL_TOOLS -- (from SHARED_I18N_PLURAL_TOOLS) ensure -- from SHARED_I18N_PLURAL_TOOLS result_exists: Result /= Void invariant plural_form_correct: plural_form < 10 and plural_form >= 0 opened_only_if_valid: opened implies valid opened_means_file_exists: opened implies file.exists -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note library: "Internationalization library" copyright: "Copyright (c) 1984-2009, 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 I18N_FILE -- Generated by Eiffel Studio --
For more details: eiffel.org