Jump to: navigation, search

Difference between revisions of "New Bidi APIs"

Line 18: Line 18:
 
#File names with extensions (e.g. ABC.java)
 
#File names with extensions (e.g. ABC.java)
 
#File associations (e.g. *.java, *.ABC)
 
#File associations (e.g. *.java, *.ABC)
 +
<br>
 +
To use the API, determine what delimiter characters should be used to segment the string, then simply call
 +
TextProcessor.process(string, delimiter);
  
In Eclipse 3.3, there is a bug that suggests providing APIs for the most common usages so that users won't have to figure out for themselves the instances in which this API should be used (see [https://bugs.eclipse.org/bugs/show_bug.cgi?id=146220 bug 146220]).
+
<strong>Example 1</strong><br>
 +
The delimiter string for a file path would be "/\:." to account for volume separator (:), path separators (/ and \) and file extension separator (.).
 +
 
 +
<strong>Example 2</strong><br>
 +
The delimiter string for a URL would be ":/".
 +
 
 +
<br>
 +
The Eclipse Platform has begun to use this API in the Eclipse 3.3 development stream.  Examples of places where it is currently being used are the Info property page (for paths), the Properties view (for paths and file names with extensions), and the Navigator view (also for file names with extensions).
 +
 
 +
<br>
 +
It has been suggested that APIs be provided for the most common usages so that users won't have to figure out for themselves the most common usages of this API (see [https://bugs.eclipse.org/bugs/show_bug.cgi?id=146220 bug 146220]).

Revision as of 14:50, 16 June 2006

In Eclipse 3.2, new APIs were added to provide proper rendering of strings containing bidirectional text that have implicit left to right semantic meaning. The method org.eclipse.osgi.util.TextProcessor.process(String str, String delimiter) provides this function.

str 
the string to process
delimiter 
a string of characters used to segment the string.

The text of each segment has directional markers inserted at the beginning and end of it to ensure the entire string is rendered left-to-right and also has the Unicode Bidirectional algorithm applied to it in order to render the mixed text of the segment in the proper orientation.

As an example, a file path such as

  d:\myFolder\FOLDER\MYFILE.java

(where capital letters indicate RTL-oriented text) should render as

  d:\myFolder\REDLOF\ELIFYM.java

when using the Unicode Bidi algorithm and segmenting the string according to a specified delimiter set. However, since the OS does not understand that the string should be segmented according to each segment of the file path, it uses the Bidirectional algorithm to renders the string as follows:

  java.ELIFYM\REDLOF\d:\myFolder

Types of strings to which this API should be applied are:

  1. File paths (e.g. d:\myFolder\abc\DEF)
  2. URLs (e.g. http://abc/DEF )
  3. File names with extensions (e.g. ABC.java)
  4. File associations (e.g. *.java, *.ABC)


To use the API, determine what delimiter characters should be used to segment the string, then simply call TextProcessor.process(string, delimiter);

Example 1
The delimiter string for a file path would be "/\:." to account for volume separator (:), path separators (/ and \) and file extension separator (.).

Example 2
The delimiter string for a URL would be ":/".


The Eclipse Platform has begun to use this API in the Eclipse 3.3 development stream. Examples of places where it is currently being used are the Info property page (for paths), the Properties view (for paths and file names with extensions), and the Navigator view (also for file names with extensions).


It has been suggested that APIs be provided for the most common usages so that users won't have to figure out for themselves the most common usages of this API (see bug 146220).