de.dante.extex.scanner.type
Interface CatcodeVisitor

All Known Implementing Classes:

TokenFactoryImpl

public interface CatcodeVisitor

This interface describes the capabilities for a visitor class on the category codes. This interface is used to implement the visitor pattern.

Version:

$Revision: 1.3 $

Author:

Gerd Neugebauer

visitEscape

public java.lang.Object visitEscape(java.lang.Object arg1,
                                    java.lang.Object arg2,
                                    java.lang.Object arg3)
                             throws java.lang.Exception

This visit method is invoked on an escape token. In TeX this normally means a control sequence.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitLeftBrace

public java.lang.Object visitLeftBrace(java.lang.Object arg1,
                                       java.lang.Object arg2,
                                       java.lang.Object arg3)
                                throws java.lang.Exception

This visit method is invoked on a left brace token.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitRightBrace

public java.lang.Object visitRightBrace(java.lang.Object arg1,
                                        java.lang.Object arg2,
                                        java.lang.Object arg3)
                                 throws java.lang.Exception

This visit method is invoked on a right brace token.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitMathShift

public java.lang.Object visitMathShift(java.lang.Object arg1,
                                       java.lang.Object arg2,
                                       java.lang.Object arg3)
                                throws java.lang.Exception

This visit method is invoked on a math shift token. In TeX this normally is a $.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitTabMark

public java.lang.Object visitTabMark(java.lang.Object arg1,
                                     java.lang.Object arg2,
                                     java.lang.Object arg3)
                              throws java.lang.Exception

This visit method is invoked on a tab mark token. In TeX this normally is a &.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitCr

public java.lang.Object visitCr(java.lang.Object arg1,
                                java.lang.Object arg2,
                                java.lang.Object arg3)
                         throws java.lang.Exception

This visit method is invoked on a cr token.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitMacroParam

public java.lang.Object visitMacroParam(java.lang.Object arg1,
                                        java.lang.Object arg2,
                                        java.lang.Object arg3)
                                 throws java.lang.Exception

This visit method is invoked on a macro parameter token. In TeX this normally is a #.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitSupMark

public java.lang.Object visitSupMark(java.lang.Object arg1,
                                     java.lang.Object arg2,
                                     java.lang.Object arg3)
                              throws java.lang.Exception

This visit method is invoked on a sup mark token. In TeX this normally is a ^.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitSubMark

public java.lang.Object visitSubMark(java.lang.Object arg1,
                                     java.lang.Object arg2,
                                     java.lang.Object arg3)
                              throws java.lang.Exception

This visit method is invoked on a sub mark token. In TeX this normally is a _.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitIgnore

public java.lang.Object visitIgnore(java.lang.Object arg1,
                                    java.lang.Object arg2,
                                    java.lang.Object arg3)
                             throws java.lang.Exception

This visit method is invoked on an ignore token.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitSpace

public java.lang.Object visitSpace(java.lang.Object arg1,
                                   java.lang.Object arg2,
                                   java.lang.Object arg3)
                            throws java.lang.Exception

This visit method is invoked on a space token.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitLetter

public java.lang.Object visitLetter(java.lang.Object arg1,
                                    java.lang.Object arg2,
                                    java.lang.Object arg3)
                             throws java.lang.Exception

This visit method is invoked on a letter token.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitOther

public java.lang.Object visitOther(java.lang.Object arg1,
                                   java.lang.Object arg2,
                                   java.lang.Object arg3)
                            throws java.lang.Exception

This visit method is invoked on an other token.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitActive

public java.lang.Object visitActive(java.lang.Object arg1,
                                    java.lang.Object arg2,
                                    java.lang.Object arg3)
                             throws java.lang.Exception

This visit method is invoked on an active token. In TeX this is e.g. ~.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitComment

public java.lang.Object visitComment(java.lang.Object arg1,
                                     java.lang.Object arg2,
                                     java.lang.Object arg3)
                              throws java.lang.Exception

This visit method is invoked on a comment token. In TeX this normally is a %.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error

visitInvalid

public java.lang.Object visitInvalid(java.lang.Object arg1,
                                     java.lang.Object arg2,
                                     java.lang.Object arg3)
                              throws java.lang.Exception

This visit method is invoked on an invalid token.

Parameters:

arg1 - the first argument to pass

arg2 - the second argument to pass

arg3 - the third argument to pass

Returns:

some value

Throws:

java.lang.Exception - in case of an error