Migration to Unicode - Revision history

Manus at 23:30, 15 February 2013

2013-02-15T23:30:20Z

Manus: Removed usage of non-existent class EXECUTION_ENVIRONMENT_32

2013-02-15T23:29:15Z

Removed usage of non-existent class EXECUTION_ENVIRONMENT_32

Alexander Kogtenkov: Fixed a typo.

2012-11-09T05:42:30Z

Fixed a typo.

Manus: Updated rules for Unicode migration to the latest EiffelBase design

2012-11-09T00:07:00Z

Updated rules for Unicode migration to the latest EiffelBase design

Alexander Kogtenkov: /* Temporary solution */ Splitted item #4.

2012-09-26T18:48:08Z

‎Temporary solution: Splitted item #4.

Alexander Kogtenkov: Added a first version

2012-09-25T18:00:49Z

Added a first version

New page

[[Category:Unicode]]

This is a summary of the recommendations for adapting applications to handle Unicode.

====General rule====
# '''Never use <e>STRING_8</e> or any variant of it unless you write a program that is going to be deleted in 5 minutes after running it. Do not even consider using <e>STRING_8</e> or its variant. Always use <e>IMMUTABLE_STRING_32</e>, <e>READABLE_STRING_32</e> or <e>STRING_32</e>.'''
# '''Do not use classes from third-party libraries that take <e>STRING_8</e> rather than <e>STRING_32</e>.'''

====Temporary solution====
<ol start="0.">
<li>Replace types using the following table:</li>
</ol>
{| class="wikitable"
|-
! Old class
! New class
|-
| <e>STRING_8</e>
| <e>STRING_32</e>
|-
| <e>FILE_NAME</e>
| <e>FILE_NAME_32</e>
|-
| <e>DIRECTORY_NAME</e>
| <e>DIRECTORY_NAME_32</e>
|-
| <e>FILE</e>
| <e>FILE_32</e>
|-
| <e>RAW_FILE</e>
| <e>RAW_FILE_32</e>
|-
| <e>PLAIN_TEXT_FILE</e>
| <e>PLAIN_TEXT_FILE_32</e>
|-
| <e>DIRECTORY</e>
| <e>DIRECTORY_32</e>
|-
| <e>KL_BINARY_INPUT_FILE</e>
| <e>KL_BINARY_INPUT_FILE_32</e>
|-
| <e>KL_TEXT_OUTPUT_FILE</e>
| <e>KL_TEXT_OUTPUT_FILE_32</e>
|-
| <e>EXECUTION_ENVIRONMENT</e>
| <e>EXECUTION_ENVIRONMENT_32</e>
|}
# Consider using <e>READABLE_STRING_32</e> for argument types.
# If you need to convert one UTF encoding into another one, use <e>UTF_CONVERTER</e>. This is an expanded class, so it's possible to declare a local variable of this type and call features on it without explicit object creation.
# Consider using <e>SHARED_EXECUTION_ENVIRONMENT</e> to access <e>EXECUTION_ENVIRONMENT_32</e>.
# If you cannot immediately change argument types to take <e>READABLE_STRING_32</e>, use <e>READABLE_STRING_GENERAL</e>. If you want to operate on files with an unknown string type for their names (i.e. <e>READABLE_STRING_GENERAL</e>), use <e>FILE_UTILITIES</e>. This is an expanded class and can be used as described for <e>UTF_CONVERTER</e>.

← Older revision		Revision as of 23:29, 15 February 2013
Line 38:		Line 38:
	# Consider using <e>READABLE_STRING_32</e> for argument types. If you cannot immediately change argument types to take <e>READABLE_STRING_32</e>, e.g. because this is a library class, use <e>READABLE_STRING_GENERAL</e> and perform all the necessary conversions inside the routine.		# Consider using <e>READABLE_STRING_32</e> for argument types. If you cannot immediately change argument types to take <e>READABLE_STRING_32</e>, e.g. because this is a library class, use <e>READABLE_STRING_GENERAL</e> and perform all the necessary conversions inside the routine.
	# If you need to convert one UTF encoding into another one, use <e>UTF_CONVERTER</e>. This is an expanded class, so it's possible to declare a local variable of this type and call features on it without explicit object creation.		# If you need to convert one UTF encoding into another one, use <e>UTF_CONVERTER</e>. This is an expanded class, so it's possible to declare a local variable of this type and call features on it without explicit object creation.
−	~~# Consider using <e>SHARED_EXECUTION_ENVIRONMENT</e> to access <e>EXECUTION_ENVIRONMENT_32</e>.~~

@@ Line 7: / Line 7: @@
 # Do not use classes from third-party libraries that take <e>STRING_8</e> rather than <e>STRING_32</e>.
 # Use <e>PATH</e> to manipulate file or directory names
-# Whenever an API takes a READABLE_STRING_GENERAL argument, assumes that STRING_8 will be treated as Unicode strings in the range 0 .. 255, unless explicitly noted.
+# Whenever an API takes a READABLE_STRING_GENERAL argument, assume that STRING_8 will be treated as Unicode strings in the range 0 .. 255, unless explicitly noted.
 ====Temporary solution====

@@ Line 1: / Line 1: @@
 [[Category:Unicode]]
-This is a summary of the recommendations for adapting applications to handle Unicode.
+This is a summary of the recommendations for adapting applications to handle Unicode. Although some recommendations can be applied in earlier version of EiffelStudio starting from 5.6, the following recommendations are made for 7.2 and higher.
 ====General rule====

@@ Line 4: / Line 4: @@
 ====General rule====
-# '''Never use <e>STRING_8</e> or any variant of it unless you write a program that is going to be deleted in 5 minutes after running it. Do not even consider using <e>STRING_8</e> or its variant. Always use <e>IMMUTABLE_STRING_32</e>, <e>READABLE_STRING_32</e> or <e>STRING_32</e>.'''
+# Never use <e>STRING_8</e> or any variant of it unless you write a program that is going to be deleted in 5 minutes after running it. Do not even consider using <e>STRING_8</e> or its variant. Always use <e>IMMUTABLE_STRING_32</e>, <e>READABLE_STRING_32</e> or <e>STRING_32</e>.
-# '''Do not use classes from third-party libraries that take <e>STRING_8</e> rather than <e>STRING_32</e>.'''
+# Do not use classes from third-party libraries that take <e>STRING_8</e> rather than <e>STRING_32</e>.
 ====Temporary solution====
@@ Line 20: / Line 22: @@
 |-
 | <e>FILE_NAME</e>
-| <e>FILE_NAME_32</e>
+| <e>PATH</e>
 |-
 | <e>DIRECTORY_NAME</e>
-| <e>DIRECTORY_NAME_32</e>
+| <e>PATH</e>
-|-
-| <e>FILE</e>
-| <e>FILE_32</e>
-|-
-| <e>RAW_FILE</e>
-| <e>RAW_FILE_32</e>
-|-
-| <e>PLAIN_TEXT_FILE</e>
-| <e>PLAIN_TEXT_FILE_32</e>
-|-
-| <e>DIRECTORY</e>
-| <e>DIRECTORY_32</e>
 |-
 | <e>KL_BINARY_INPUT_FILE</e>
@@ Line 49: / Line 39: @@
 # If you need to convert one UTF encoding into another one, use <e>UTF_CONVERTER</e>. This is an expanded class, so it's possible to declare a local variable of this type and call features on it without explicit object creation.
 # Consider using <e>SHARED_EXECUTION_ENVIRONMENT</e> to access <e>EXECUTION_ENVIRONMENT_32</e>.

@@ Line 46: / Line 46: @@
 | <e>EXECUTION_ENVIRONMENT_32</e>
 |}
-# Consider using <e>READABLE_STRING_32</e> for argument types.
+# Consider using <e>READABLE_STRING_32</e> for argument types. If you cannot immediately change argument types to take <e>READABLE_STRING_32</e>, e.g. because this is a library class, use <e>READABLE_STRING_GENERAL</e> and perform all the necessary conversions inside the routine.
 # If you need to convert one UTF encoding into another one, use <e>UTF_CONVERTER</e>. This is an expanded class, so it's possible to declare a local variable of this type and call features on it without explicit object creation.
 # Consider using <e>SHARED_EXECUTION_ENVIRONMENT</e> to access <e>EXECUTION_ENVIRONMENT_32</e>.
-# If you cannot immediately change argument types to take <e>READABLE_STRING_32</e>, use <e>READABLE_STRING_GENERAL</e>. If you want to operate on files with an unknown string type for their names (i.e. <e>READABLE_STRING_GENERAL</e>), use <e>FILE_UTILITIES</e>. This is an expanded class and can be used as described for <e>UTF_CONVERTER</e>.
+# If you want to operate on files with an unknown string type for their names (i.e. <e>READABLE_STRING_GENERAL</e>), use <e>FILE_UTILITIES</e>. This is an expanded class and can be used as described for <e>UTF_CONVERTER</e>.