de.dante.extex.interpreter.primitives.hyphen
Class HyphenationPrimitive

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.hyphen.AbstractHyphenationCode
          extended byde.dante.extex.interpreter.primitives.hyphen.HyphenationPrimitive
All Implemented Interfaces:
Code, Localizable, java.io.Serializable
Direct Known Subclasses:
Hyphenation

public class HyphenationPrimitive
extends AbstractHyphenationCode

This class provides an implementation for the primitive \hyphenation.

The Primitive \hyphenation

The primitive \hyphenation can be used to add hyphenation exceptions to the current language. The argument is a list of whitespace separated words enclosed in braces. The hyphenation points are indicated by including a hyphen character (-) at the appropriate places.

When paragraph breaking needs to insert additional break points these hyphenation points are translated into discretionaries. The exceptions specified with the primitive \hyphenation have precedence before the hyphenation points found with the help of hyphenation patterns.

One example which make use of this precedence is the hyphenation exception without any hyphen characters. This can be used to suppress any hyphenation in a single word.

Syntax

    ⟨hyphenation⟩
     → \hyphenation {...} 

Example:

   \hyphenation{as-so-ciate as-so-ciates}  

Version:
$Revision: 1.1 $
Author:
Gerd Neugebauer, Michael Niedermair
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
HyphenationPrimitive(java.lang.String name)
          Creates a new object.
 
Method Summary
protected  UnicodeCharList collectWord(Context context, TokenSource source, Token token)
          Collect all characters that make up a word.
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          Scan for hyphenation values and store these values in the HyphernationTable.
protected  boolean isWordConstituent(Token t, Context context)
          This method checks that the given token is a word constituent.
 
Methods inherited from class de.dante.extex.interpreter.primitives.hyphen.AbstractHyphenationCode
getHyphenationTable
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractCode
enableLocalization, getLocalizer, getName, isIf, isOuter, printable, printableControlSequence, readResolve, setName, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

protected static final long serialVersionUID
The constant serialVersionUID contains the id for serialization.

See Also:
Constant Field Values
Constructor Detail

HyphenationPrimitive

public HyphenationPrimitive(java.lang.String name)
Creates a new object.

Parameters:
name - the name for debugging
Method Detail

collectWord

protected UnicodeCharList collectWord(Context context,
                                      TokenSource source,
                                      Token token)
                               throws InterpreterException,
                                      CatcodeException
Collect all characters that make up a word.

Parameters:
context - the interpreter context
source - the source for new tokens
token - the first token already read
Returns:
the first character not included into the word
Throws:
InterpreterException - in case of an error
CatcodeException - in case of an exception in token creation

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
Scan for hyphenation values and store these values in the HyphernationTable. The index for the HyphernationTable is based on the value from the count register \language.

Specified by:
execute in interface Code
Overrides:
execute in class AbstractCode
Throws:
InterpreterException
See Also:
Code.execute( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

isWordConstituent

protected boolean isWordConstituent(Token t,
                                    Context context)
                             throws InterpreterException
This method checks that the given token is a word constituent. This means that the token is either

Parameters:
t - the token to analyze
context - the interpreter context
Returns:
true iff the token is
Throws:
InterpreterException - in case of an error