Package org.eclipse.equinox.bidi.internal

Class StructuredTextDelimsEsc

java.lang.Object

org.eclipse.equinox.bidi.custom.StructuredTextTypeHandler

org.eclipse.equinox.bidi.internal.StructuredTextDelims

org.eclipse.equinox.bidi.internal.StructuredTextDelimsEsc

public abstract class StructuredTextDelimsEsc
extends StructuredTextDelims

A base handler for structured text composed of text segments separated by separators where the text segments may include delimited parts within which separators are treated like regular characters and the delimiters may be escaped.

This is similar to StructuredTextDelims except that delimiters can be escaped using the backslash character.

• Two consecutive backslashes in a delimited part are treated like one regular character.
• An ending delimiter preceded by an odd number of backslashes is treated like a regular character within the delimited part.

Constructor Summary

Constructors

Constructor	Description
StructuredTextDelimsEsc()
StructuredTextDelimsEsc(String separator)

Method Summary

Modifier and Type	Method	Description
int	processSpecial(IStructuredTextExpert expert, String text, StructuredTextCharTypes charTypes, StructuredTextOffsets offsets, int caseNumber, int separLocation)	Handles the text between start and end delimiters as a token.

Methods inherited from class org.eclipse.equinox.bidi.internal.StructuredTextDelims

getDelimiters, indexOfSpecial

Methods inherited from class org.eclipse.equinox.bidi.custom.StructuredTextTypeHandler

getDirection, getDirection, getSeparators, getSpecialsCount, insertMark, processSeparator, skipProcessing, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

StructuredTextDelimsEsc

public StructuredTextDelimsEsc()

StructuredTextDelimsEsc

public StructuredTextDelimsEsc(String separator)

Method Details

processSpecial

public int processSpecial(IStructuredTextExpert expert,
 String text,
 StructuredTextCharTypes charTypes,
 StructuredTextOffsets offsets,
 int caseNumber,
 int separLocation)

Handles the text between start and end delimiters as a token. This method inserts a directional mark if needed at position separLocation which corresponds to a start delimiter, and skips until after the matching end delimiter, ignoring possibly escaped end delimiters.

Overrides:

processSpecial in class StructuredTextDelims

Parameters:

expert - IStructuredTextExpert instance through which this handler is invoked. The handler can use IStructuredTextExpert methods to query items stored in the expert instance, like the current environment.

text - the structured text string before addition of any directional formatting characters.

charTypes - an object whose methods can be useful to the handler.

offsets - an object whose methods can be useful to the handler.

caseNumber - number of the special case to handle.

separLocation - the position returned by StructuredTextTypeHandler.indexOfSpecial(org.eclipse.equinox.bidi.advanced.IStructuredTextExpert, java.lang.String, org.eclipse.equinox.bidi.custom.StructuredTextCharTypes, org.eclipse.equinox.bidi.custom.StructuredTextOffsets, int, int). After calls to IStructuredTextExpert.leanToFullText(java.lang.String) and other methods of IStructuredTextExpert which set a non-null final state, processSpecial is called when initializing the processing with value of separLocation equal to -1.

Returns:

the position after the matching end delimiter, or the length of text if no end delimiter is found.