org.extex.interpreter.max.context
Class GroupImpl

java.lang.Object
  org.extex.interpreter.max.context.GroupImpl

All Implemented Interfaces:

java.io.Serializable, Group, Tokenizer

Direct Known Subclasses:

GroupExtensionImpl

public class GroupImpl
extends java.lang.Object
implements Group

This is a simple implementation for a group. The whole stack of groups is implemented as a linked list. The list itself is mixed within the pure elements of the linked list.

Version:

$Revision: 4770 $

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

GroupImpl(Group nextGroup)
Creates a new object.

Method Summary

void	afterGroup(AfterGroupObserver observer) Register an observer to be invoked after the group has been closed.
void	afterGroup(Token t) Add the token to the tokens to be inserted after the group is closed.
java.lang.Object	get(java.lang.Object extension, java.lang.Object key) Get some extension object stored in the group.
Tokens	getAfterGroup() Getter for the tokens which are inserted after the group has been closed.
Box	getBox(java.lang.String name) Getter for the boxregister.
Catcode	getCatcode(UnicodeChar c) Getter for the category code of a character.
Code	getCode(CodeToken token) Getter for the definition of an active character or macro.
protected Code	getCodeForToken(CodeToken token) Recurse down the group stack and search for the definition of a token.
Count	getCount(java.lang.String name) Getter for the named count register in the current group.
MathDelimiter	getDelcode(UnicodeChar c) Getter for the delimiter code of a character.
Dimen	getDimen(java.lang.String name) Getter for the named dimen register in the current group.
Font	getFont(java.lang.String name) Getter for the current font.
boolean	getIf(java.lang.String name) Getter for the boolean value.
InFile	getInFile(java.lang.String name) Getter for a input file register.
UnicodeChar	getLccode(UnicodeChar lc) Getter for the lccode mapping of upper case characters to their lower case equivalent.
long	getLevel() Getter for the group level.
Locator	getLocator() Getter for the locator describing where the group started.
MathCode	getMathcode(UnicodeChar c) Getter for the math code of a character.
Muskip	getMuskip(java.lang.String name) Getter for the named muskip register in the current group.
java.lang.String	getNamespace() Getter for the name space.
Group	getNext() Getter for the next group in the linked list.
OutFile	getOutFile(java.lang.String name) Getter for the output file descriptor.
FixedCount	getSfcode(UnicodeChar c) Getter for the space factor code of a character.
Glue	getSkip(java.lang.String name) Getter for the named skip register in the current group.
TokenStream	getStandardTokenStream() Getter for standardTokenStream.
Token	getStart() Getter for the token which started the group.
Tokens	getToks(java.lang.String name) Getter for the named toks register in the current group.
Tokens	getToksOrNull(java.lang.String name) Getter for the named toks register in the current group.
GroupType	getType() Getter for the group type.
TypesettingContext	getTypesettingContext() Getter for the typesetting context.
UnicodeChar	getUccode(UnicodeChar uc) Getter for the uccode mapping of lower case characters to their upper case equivalent.
void	runAfterGroup() Invoke all registered observers for the end-of-group event.
void	set(java.lang.Object extension, java.lang.Object key, java.lang.Object value, boolean global) Store some extension object in the group.
void	setBox(java.lang.String name, Box value, boolean global) Setter for the box register in all requested groups.
void	setCatcode(UnicodeChar uc, Catcode code, boolean global) Setter for the catcode of a character in the specified groups.
void	setCode(Token token, Code code, boolean global) Setter for active characters or macros in the requested group.
void	setCount(java.lang.String name, Count value, boolean global) Setter for a count register in the requested groups.
void	setDelcode(UnicodeChar uc, MathDelimiter code, boolean global) Setter for the delimiter code of a character.
void	setDimen(java.lang.String name, Dimen value, boolean global) Setter for a dimen register in the requested groups.
void	setFont(java.lang.String name, Font font, boolean global) Setter for the font with a given name.
void	setIf(java.lang.String name, boolean value, boolean global) Setter for the value of the booleans in all groups.
void	setInFile(java.lang.String name, InFile file, boolean global) Setter for an input file.
void	setLccode(UnicodeChar lc, UnicodeChar uc, boolean global) Declare the translation from an upper case character to a lower case character.
void	setLocator(Locator locator) Setter for locator.
void	setMathcode(UnicodeChar uc, MathCode code, boolean global) Setter for the math code of a character.
void	setMuskip(java.lang.String name, Muskip value, boolean global) Setter for the muskip register in the requested groups.
void	setNamespace(java.lang.String theNamespace, boolean global) Setter for the name space.
void	setOutFile(java.lang.String name, OutFile file, boolean global) Setter for the output file for a given name.
void	setSfcode(UnicodeChar uc, Count code, boolean global) Setter for the space factor code of a character.
void	setSkip(java.lang.String name, Glue value, boolean global) Setter for a skip register in all groups.
void	setStandardTokenStream(TokenStream standardTokenStream) Setter for standard Token stream.
void	setStart(Token start) Setter for start token.
void	setToks(java.lang.String name, Tokens value, boolean global) Setter for a toks register in all groups.
void	setType(GroupType type) Setter for the type.
void	setTypesettingContext(TypesettingContext context, boolean global) Setter for the typesetting context in the specified groups.
void	setUccode(UnicodeChar uc, UnicodeChar lc, boolean global) Declare the translation from a lower case character to an upper case character.
java.lang.String	toString() Get the string representation of this object for debugging purposes.

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

GroupImpl

public GroupImpl(Group nextGroup)

Creates a new object.

Parameters:

nextGroup - the next group in the stack. If the value is null then this is the global base

Method Detail

afterGroup

public void afterGroup(AfterGroupObserver observer)

Register an observer to be invoked after the group has been closed.

Specified by:

afterGroup in interface Group

Parameters:

observer - the observer to register

See Also:

Group.afterGroup( AfterGroupObserver)

afterGroup

public void afterGroup(Token t)

Add the token to the tokens to be inserted after the group is closed.

Specified by:

afterGroup in interface Group

Parameters:

t - the token to add

See Also:

Group.afterGroup( org.extex.scanner.type.token.Token)

get

public java.lang.Object get(java.lang.Object extension,
                            java.lang.Object key)

Get some extension object stored in the group.

Specified by:

get in interface Group

Parameters:

extension - the reference for the extension

key - the key of the object

Returns:

the object stored for the extension under the given key or null if none is there

See Also:

Group.get( java.lang.Object, java.lang.Object)

getAfterGroup

public Tokens getAfterGroup()

Getter for the tokens which are inserted after the group has been closed.

Specified by:

getAfterGroup in interface Group

Returns:

the after group tokens

See Also:

Group.getAfterGroup()

getBox

public Box getBox(java.lang.String name)

Getter for the boxregister. Count registers are named, either with a number or an arbitrary string. The numbered registers where limited to 256 in TeX. This restriction does no longer hold for ExTeX.

Specified by:

getBox in interface Group

Parameters:

name - the name or number of the count register

Returns:

the count register or null if it is not defined

See Also:

Group.getBox( java.lang.String)

getCatcode

public Catcode getCatcode(UnicodeChar c)

Getter for the category code of a character.

Specified by:

getCatcode in interface Group

Specified by:

getCatcode in interface Tokenizer

Parameters:

c - the Unicode character to analyze

Returns:

the category code of a character

See Also:

Tokenizer.getCatcode( org.extex.core.UnicodeChar)

getCode

public Code getCode(CodeToken token)

Getter for the definition of an active character or macro.

Specified by:

getCode in interface Group

Parameters:

token - the name of the active character or macro

Returns:

the code associated to the name or null if none is defined yet

See Also:

Group.getCode( CodeToken)

getCodeForToken

protected Code getCodeForToken(CodeToken token)

Recurse down the group stack and search for the definition of a token.

Parameters:

token - the token to look-up the definition for

Returns:

the code assigned to the token or null if none is found.

getCount

public Count getCount(java.lang.String name)

Getter for the named count register in the current group. The name can either be a string representing a number or an arbitrary string. In the first case the behavior of the numbered count registers is emulated. The other case can be used to store special count values.

Note: The number of count registers is not limited to 256 as in TeX.

As a default value 0 is returned.

Specified by:

getCount in interface Group

Parameters:

name - the name of the count register

Returns:

the value of the count register or its default

See Also:

Group.getCount( java.lang.String)

getDelcode

public MathDelimiter getDelcode(UnicodeChar c)

Getter for the delimiter code of a character. The delimiter code is -1 unless changed explicitly.

Specified by:

getDelcode in interface Group

Parameters:

c - the character to get the delimiter code for

Returns:

the delimiter code for the given character

See Also:

Group.getDelcode( org.extex.core.UnicodeChar)

getDimen

public Dimen getDimen(java.lang.String name)

Getter for the named dimen register in the current group. The name can either be a string representing a number or an arbitrary string. In the first case the behavior of the numbered dimen registers is emulated. The other case can be used to store special dimen values.

Note: The number of dimen registers is not limited to 256 as in TeX.

As a default value 0 is returned.

Specified by:

getDimen in interface Group

Parameters:

name - the name of the dimen register

Returns:

the value of the dimen register or its default

See Also:

Group.getDimen( java.lang.String)

getFont

public Font getFont(java.lang.String name)

Getter for the current font.

Specified by:

getFont in interface Group

Parameters:

name - the name of the font

Returns:

the current font

See Also:

Group.getFont( java.lang.String)

getIf

public boolean getIf(java.lang.String name)

Getter for the boolean value.

Specified by:

getIf in interface Group

Parameters:

name - the name of the boolean

Returns:

the value

See Also:

Group.getIf( java.lang.String)

getInFile

public InFile getInFile(java.lang.String name)

Getter for a input file register. In the case that the named descriptor does not exist yet null is returned. If the name is null then the default input stream is used.

Specified by:

getInFile in interface Group

Parameters:

name - the name or the number of the file register

Returns:

the input file descriptor

See Also:

Group.getInFile( java.lang.String)

getLccode

public UnicodeChar getLccode(UnicodeChar lc)

Getter for the lccode mapping of upper case characters to their lower case equivalent.

Specified by:

getLccode in interface Group

Parameters:

lc - the upper case character

Returns:

the lower case equivalent or null if none exists

See Also:

Group.getLccode( org.extex.core.UnicodeChar)

getLevel

public long getLevel()

Getter for the group level. The group level is the number of groups which are currently open. Thus this number of groups can be closed. Since the top-level group can not be closed this group counts as 0.

Specified by:

getLevel in interface Group

Returns:

the group level

See Also:

Group.getLevel()

getLocator

public Locator getLocator()

Getter for the locator describing where the group started.

Specified by:

getLocator in interface Group

Returns:

the locator

See Also:

Group.getLocator()

getMathcode

public MathCode getMathcode(UnicodeChar c)

Getter for the math code of a character.

Specified by:

getMathcode in interface Group

Parameters:

c - the character to get the math code for

Returns:

the math code for the given character

See Also:

Group.getMathcode( org.extex.core.UnicodeChar)

getMuskip

public Muskip getMuskip(java.lang.String name)

Getter for the named muskip register in the current group. The name can either be a string representing a number or an arbitrary string. In the first case the behavior of the numbered muskip registers is emulated. The other case can be used to store special muskip values.

As a default value 0 is returned.

Specified by:

getMuskip in interface Group

Parameters:

name - the name of the count register

Returns:

the value of the count register or its default

See Also:

Group.getMuskip( java.lang.String)

getNamespace

public java.lang.String getNamespace()

Getter for the name space.

Specified by:

getNamespace in interface Group

Specified by:

getNamespace in interface Tokenizer

Returns:

the name space

See Also:

Group.getNamespace()

getNext

public Group getNext()

Getter for the next group in the linked list. Maybe this method should be hidden.

Specified by:

getNext in interface Group

Returns:

the next group

See Also:

Group.getNext()

getOutFile

public OutFile getOutFile(java.lang.String name)

Getter for the output file descriptor.

Specified by:

getOutFile in interface Group

Parameters:

name - the name of the descriptor to get

Returns:

the output file descriptor

See Also:

Group.getOutFile( java.lang.String)

getSfcode

public FixedCount getSfcode(UnicodeChar c)

Getter for the space factor code of a character. The sfcode is 999 for letters and 1000 for other characters unless changed explicitly.

Specified by:

getSfcode in interface Group

Parameters:

c - the character for which the sfcode is requested

Returns:

the sfcode of the given character

See Also:

Group.getSfcode( org.extex.core.UnicodeChar)

getSkip

public Glue getSkip(java.lang.String name)

Getter for the named skip register in the current group. The name can either be a string representing a number or an arbitrary string. In the first case the behavior of the numbered skip registers is emulated. The other case can be used to store special skip values.

As a default value 0 is returned.

Specified by:

getSkip in interface Group

Parameters:

name - the name of the count register

Returns:

the value of the count register or its default

See Also:

Group.getSkip( java.lang.String)

getStandardTokenStream

public TokenStream getStandardTokenStream()

Getter for standardTokenStream.

Specified by:

getStandardTokenStream in interface Group

Returns:

the standardTokenStream

See Also:

Group.getStandardTokenStream()

getStart

public Token getStart()

Getter for the token which started the group.

Specified by:

getStart in interface Group

Returns:

the start token

See Also:

Group.getStart()

getToks

public Tokens getToks(java.lang.String name)

Getter for the named toks register in the current group. The name can either be a string representing a number or an arbitrary string. In the first case the behavior of the numbered toks registers is emulated. The other case can be used to store special toks values.

As a default value the empty toks register is returned.

Specified by:

getToks in interface Group

Parameters:

name - the name of the toks register

Returns:

the value of the toks register or its default

See Also:

Group.getToks( java.lang.String)

getToksOrNull

public Tokens getToksOrNull(java.lang.String name)

Getter for the named toks register in the current group. The name can either be a string representing a number or an arbitrary string. In the first case the behavior of the numbered toks registers is emulated. The other case can be used to store special toks values.

Specified by:

getToksOrNull in interface Group

Parameters:

name - the name of the toks register

Returns:

the value of the toks register or null if none is defined

See Also:

Group.getToksOrNull(java.lang.String)

getType

public GroupType getType()

Getter for the group type.

Specified by:

getType in interface Group

Returns:

the group type

See Also:

Group.getType()

getTypesettingContext

public TypesettingContext getTypesettingContext()

Getter for the typesetting context.

Specified by:

getTypesettingContext in interface Group

Returns:

the typesetting context

See Also:

Group.getTypesettingContext()

getUccode

public UnicodeChar getUccode(UnicodeChar uc)

Getter for the uccode mapping of lower case characters to their upper case equivalent.

Specified by:

getUccode in interface Group

Parameters:

uc - the upper case character

Returns:

the upper case equivalent or null if none exists

See Also:

Group.getUccode( org.extex.core.UnicodeChar)

runAfterGroup

public void runAfterGroup()
                   throws HelpingException

Invoke all registered observers for the end-of-group event.

Specified by:

runAfterGroup in interface Group

Throws:

HelpingException - in case of an error

See Also:

Group.runAfterGroup()

set

public void set(java.lang.Object extension,
                java.lang.Object key,
                java.lang.Object value,
                boolean global)

Store some extension object in the group.

Specified by:

set in interface Group

Parameters:

extension - the reference for the extension

key - the key of the object

value - the value to store

global - the indicator that the assignment should be performed globally

See Also:

Group.set( java.lang.Object, java.lang.Object, java.lang.Object, boolean)

setBox

public void setBox(java.lang.String name,
                   Box value,
                   boolean global)

Setter for the box register in all requested groups. Count registers are named, either with a number or an arbitrary string. The numbered registers where limited to 256 in TeX. This restriction does no longer hold for ExTeX.

Specified by:

setBox in interface Group

Parameters:

name - the name or the number of the register

value - the new value of the register

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setBox( java.lang.String, org.extex.interpreter.type.box.Box, boolean)

setCatcode

public void setCatcode(UnicodeChar uc,
                       Catcode code,
                       boolean global)

Setter for the catcode of a character in the specified groups.

Specified by:

setCatcode in interface Group

Parameters:

uc - the character

code - the catcode

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setCatcode( org.extex.core.UnicodeChar, org.extex.scanner.type.Catcode, boolean)

setCode

public void setCode(Token token,
                    Code code,
                    boolean global)

Setter for active characters or macros in the requested group.

Specified by:

setCode in interface Group

Parameters:

token - the name of the active character, i.e. a single letter string

code - the new code

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setCode( org.extex.scanner.type.token.Token, org.extex.interpreter.type.Code, boolean)

setCount

public void setCount(java.lang.String name,
                     Count value,
                     boolean global)

Setter for a count register in the requested groups.

Specified by:

setCount in interface Group

Parameters:

name - the name of the count register

value - the value of the count register

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setCount( java.lang.String, org.extex.core.count.Count, boolean)

setDelcode

public void setDelcode(UnicodeChar uc,
                       MathDelimiter code,
                       boolean global)

Setter for the delimiter code of a character.

Specified by:

setDelcode in interface Group

Parameters:

uc - the character to set the delimiter code for

code - the new delimiter code

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setDelcode( org.extex.core.UnicodeChar, MathDelimiter, boolean)

setDimen

public void setDimen(java.lang.String name,
                     Dimen value,
                     boolean global)

Setter for a dimen register in the requested groups.

Specified by:

setDimen in interface Group

Parameters:

name - the name of the count register

value - the value of the count register

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setDimen( java.lang.String, org.extex.core.dimen.Dimen, boolean)

setFont

public void setFont(java.lang.String name,
                    Font font,
                    boolean global)

Setter for the font with a given name.

Specified by:

setFont in interface Group

Parameters:

name - the name of the font

font - the new font

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setFont( java.lang.String, org.extex.typesetter.tc.font.Font, boolean)

setIf

public void setIf(java.lang.String name,
                  boolean value,
                  boolean global)

Setter for the value of the booleans in all groups.

Specified by:

setIf in interface Group

Parameters:

name - the name of the boolean

value - the truth value

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setIf( java.lang.String, boolean, boolean)

setInFile

public void setInFile(java.lang.String name,
                      InFile file,
                      boolean global)

Setter for an input file.

Specified by:

setInFile in interface Group

Parameters:

name - the name of the input file

file - the input file specification

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setInFile( java.lang.String, org.extex.scanner.type.file.InFile, boolean)

setLccode

public void setLccode(UnicodeChar lc,
                      UnicodeChar uc,
                      boolean global)

Declare the translation from an upper case character to a lower case character.

Specified by:

setLccode in interface Group

Parameters:

uc - upper case character

lc - lower case equivalent

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setLccode( org.extex.core.UnicodeChar, org.extex.core.UnicodeChar, boolean)

setLocator

public void setLocator(Locator locator)

Setter for locator.

Specified by:

setLocator in interface Group

Parameters:

locator - the locator to set

setMathcode

public void setMathcode(UnicodeChar uc,
                        MathCode code,
                        boolean global)

Setter for the math code of a character.

Specified by:

setMathcode in interface Group

Parameters:

uc - the character to set the math code for

code - the new math code

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setMathcode( org.extex.core.UnicodeChar, MathCode, boolean)

setMuskip

public void setMuskip(java.lang.String name,
                      Muskip value,
                      boolean global)

Setter for the muskip register in the requested groups.

Specified by:

setMuskip in interface Group

Parameters:

name - the name of the register

value - the value of the register

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setMuskip( java.lang.String, org.extex.core.muskip.Muskip, boolean)

setNamespace

public void setNamespace(java.lang.String theNamespace,
                         boolean global)

Setter for the name space.

Specified by:

setNamespace in interface Group

Parameters:

theNamespace - the new name space

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setNamespace( java.lang.String, boolean)

setOutFile

public void setOutFile(java.lang.String name,
                       OutFile file,
                       boolean global)

Setter for the output file for a given name.

Specified by:

setOutFile in interface Group

Parameters:

name - the name of the output file

file - the output file specification

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setOutFile( java.lang.String, org.extex.scanner.type.file.OutFile, boolean)

setSfcode

public void setSfcode(UnicodeChar uc,
                      Count code,
                      boolean global)

Setter for the space factor code of a character.

Specified by:

setSfcode in interface Group

Parameters:

uc - the character to set the space factor code for

code - the new space factor code

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setSfcode( org.extex.core.UnicodeChar, org.extex.core.count.Count, boolean)

setSkip

public void setSkip(java.lang.String name,
                    Glue value,
                    boolean global)

Setter for a skip register in all groups.

Specified by:

setSkip in interface Group

Parameters:

name - the name of the count register

value - the value of the count register

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setSkip( java.lang.String, org.extex.core.glue.Glue, boolean)

setStandardTokenStream

public void setStandardTokenStream(TokenStream standardTokenStream)

Setter for standard Token stream.

Specified by:

setStandardTokenStream in interface Group

Parameters:

standardTokenStream - the standardTokenStream to set.

See Also:

Group.setStandardTokenStream( org.extex.scanner.api.TokenStream)

setStart

public void setStart(Token start)

Setter for start token.

Specified by:

setStart in interface Group

Parameters:

start - the start token to set

setToks

public void setToks(java.lang.String name,
                    Tokens value,
                    boolean global)

Setter for a toks register in all groups.

Specified by:

setToks in interface Group

Parameters:

name - the name of the toks register

value - the value of the toks register

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setToks( java.lang.String, org.extex.scanner.type.tokens.Tokens, boolean)

setType

public void setType(GroupType type)

Setter for the type.

Specified by:

setType in interface Group

Parameters:

type - the type of the group

See Also:

Group.setType( org.extex.interpreter.context.group.GroupType)

setTypesettingContext

public void setTypesettingContext(TypesettingContext context,
                                  boolean global)

Setter for the typesetting context in the specified groups.

Specified by:

setTypesettingContext in interface Group

Parameters:

context - the new typesetting context

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setTypesettingContext( org.extex.typesetter.tc.TypesettingContext, boolean)

setUccode

public void setUccode(UnicodeChar uc,
                      UnicodeChar lc,
                      boolean global)

Declare the translation from a lower case character to an upper case character.

Specified by:

setUccode in interface Group

Parameters:

uc - lower case character

lc - uppercase equivalent

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

See Also:

Group.setUccode( org.extex.core.UnicodeChar, org.extex.core.UnicodeChar, boolean)

toString

public java.lang.String toString()

Get the string representation of this object for debugging purposes.

Overrides:

toString in class java.lang.Object

Returns:

the string representation

See Also:

Object.toString()