org.extex.scanner.type
Interface CatcodeVisitor<RET,ARG1,ARG2,ARG3>

Type Parameters:

RET - the type of the return value

ARG1 - the type of the first argument

ARG2 - the type of the second argument

ARG3 - the type of the third argument

All Known Implementing Classes:

TokenFactoryImpl

public interface CatcodeVisitor<RET,ARG1,ARG2,ARG3>

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

Version:

$Revision:5563 $

Author:

Gerd Neugebauer

Method Summary

RET	visitActive(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on an active token.
RET	visitComment(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on a comment token.
RET	visitCr(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on a cr token.
RET	visitEscape(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on an escape token.
RET	visitIgnore(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on an ignore token.
RET	visitInvalid(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on an invalid token.
RET	visitLeftBrace(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on a left brace token.
RET	visitLetter(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on a letter token.
RET	visitMacroParam(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on a macro parameter token.
RET	visitMathShift(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on a math shift token.
RET	visitOther(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on an other token.
RET	visitRightBrace(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on a right brace token.
RET	visitSpace(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on a space token.
RET	visitSubMark(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on a sub mark token.
RET	visitSupMark(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on a sup mark token.
RET	visitTabMark(ARG1 arg1, ARG2 arg2, ARG3 arg3) This visit method is invoked on a tab mark token.

Method Detail

visitActive

RET visitActive(ARG1 arg1,
                ARG2 arg2,
                ARG3 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

RET visitComment(ARG1 arg1,
                 ARG2 arg2,
                 ARG3 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

visitCr

RET visitCr(ARG1 arg1,
            ARG2 arg2,
            ARG3 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

visitEscape

RET visitEscape(ARG1 arg1,
                ARG2 arg2,
                ARG3 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

visitIgnore

RET visitIgnore(ARG1 arg1,
                ARG2 arg2,
                ARG3 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

visitInvalid

RET visitInvalid(ARG1 arg1,
                 ARG2 arg2,
                 ARG3 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

visitLeftBrace

RET visitLeftBrace(ARG1 arg1,
                   ARG2 arg2,
                   ARG3 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

visitLetter

RET visitLetter(ARG1 arg1,
                ARG2 arg2,
                ARG3 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

visitMacroParam

RET visitMacroParam(ARG1 arg1,
                    ARG2 arg2,
                    ARG3 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

visitMathShift

RET visitMathShift(ARG1 arg1,
                   ARG2 arg2,
                   ARG3 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

visitOther

RET visitOther(ARG1 arg1,
               ARG2 arg2,
               ARG3 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

visitRightBrace

RET visitRightBrace(ARG1 arg1,
                    ARG2 arg2,
                    ARG3 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

visitSpace

RET visitSpace(ARG1 arg1,
               ARG2 arg2,
               ARG3 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

visitSubMark

RET visitSubMark(ARG1 arg1,
                 ARG2 arg2,
                 ARG3 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

visitSupMark

RET visitSupMark(ARG1 arg1,
                 ARG2 arg2,
                 ARG3 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

visitTabMark

RET visitTabMark(ARG1 arg1,
                 ARG2 arg2,
                 ARG3 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