Automatic generation produced by ISE Eiffel

Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:
note description: "Main interface to the i18n library. Provides access to translations and formatting objects for a given locale." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2014-01-08 14:29:50 -0800 (Wed, 08 Jan 2014) $" revision: "$Revision: 93935 $" class interface I18N_LOCALE create make (a_dictionary: I18N_DICTIONARY; a_locale_info: I18N_LOCALE_INFO) -- Initialize locale with dictionary and locale information. -- -- a_dictionary: Dictionary to use to translate strings -- a_locale_info: Information about the locale require a_dictionary_not_void: a_dictionary /= Void a_locale_info_not_void: a_locale_info /= Void ensure dictionary_set: dictionary = a_dictionary info_set: info = a_locale_info feature -- Access formatted_string (original: READABLE_STRING_GENERAL; token_values: TUPLE): STRING_32 -- String which has it's tokens replaced by given values -- -- The string given can have token placeholders in the form of '$1' -- (dollar sign followed by token number). Each placeholder will be -- replaced with the tuple value indexed by the placeholder number. -- -- Note: the escape token can be set in the string formatter, the -- dollar sign is the default value. -- -- original: Original string with possible token placeholders -- token_values: Values which will be replaced in the placeholders -- Result: String which has token placeholders replaced with values require original_not_void: original /= Void token_values_not_void: token_values /= Void token_values_valid: string_formatter.valid_arguments (token_values) ensure result_attached: Result /= Void generating_type: TYPE [detachable I18N_LOCALE] -- 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 info: I18N_LOCALE_INFO -- Specific information about locale plural_translation (original_singular, original_plural: READABLE_STRING_GENERAL; plural_number: INTEGER_32): STRING_32 -- Translation of original_singular or original_plural in locale depending on plural_number -- -- original_singular: String to translate if singular is used -- original_plural: String to translate if plural is used -- plural_number: Plural number to use -- Result: Translation of singular or plural string, or the original string if no translation is available require original_singular_not_void: original_singular /= Void original_plural_not_void: original_plural /= Void ensure result_attached: Result /= Void plural_translation_in_context (original_singular, original_plural: READABLE_STRING_GENERAL; a_context: detachable READABLE_STRING_GENERAL; plural_number: INTEGER_32): STRING_32 -- Translation of original_singular or original_plural in locale depending on plural_number -- -- original_singular: String to translate if singular is used -- original_plural: String to translate if plural is used -- a_context: Context stringg of current message -- plural_number: Plural number to use -- Result: Translation of singular or plural string, or the original string if no translation is available require original_singular_not_void: original_singular /= Void original_plural_not_void: original_plural /= Void ensure result_attached: Result /= Void translation (original: READABLE_STRING_GENERAL): STRING_32 -- Translation of original in locale -- -- original: String to translate -- Result: Translated string, or the original string if no translation is available require original_not_void: original /= Void ensure result_attached: Result /= Void translation_in_context (original: READABLE_STRING_GENERAL; a_context: detachable READABLE_STRING_GENERAL): STRING_32 -- Translation of original in locale -- -- original: String to translate -- a_context: Context stringg of current message -- Result: Translated string, or the original string if no translation is available require original_not_void: original /= Void ensure result_attached: Result /= Void 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 (other: I18N_LOCALE): 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_LOCALE): 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 (other: I18N_LOCALE): 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 -- Duplication copy (other: I18N_LOCALE) -- 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_LOCALE) -- 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_LOCALE -- 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_LOCALE) -- 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_LOCALE -- 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_LOCALE -- 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 I18N_LOCALE -- 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 -- Formatters currency_formatter: I18N_CURRENCY_FORMATTER -- Formatter used to format locale-specific currencies date_formatter: I18N_DATE_FORMATTER -- Formatter used to format locale-specific dates string_formatter: I18N_STRING_FORMATTER -- Formatter used to format locale-specific strings value_formatter: I18N_VALUE_FORMATTER -- Formatter used to format locale-specific values 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 info_not_void: info /= Void date_formatter_not_void: date_formatter /= Void value_formatter_not_void: value_formatter /= Void currency_formatter_not_void: currency_formatter /= Void string_formatter_not_void: string_formatter /= Void dictionary_not_void: dictionary /= Void -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note library: "Internationalization library" 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 I18N_LOCALE
Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:

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