com.dfamaj.textproc.xwm
Interface XwmEngine

All Superinterfaces:

ThreadUnsafe

All Known Implementing Classes:

XwmEngineImpl

public interface XwmEngine
extends ThreadUnsafe

un moteur, qui est en train de travailler sur un certain contexte, et qu'on peut passer à des primitives pour qu'elles fassent leur traitement.

Since:

2.0

Version:

2.0 -- 2007-02-04 -- $Revision$

Author:

David Andriana

Method Summary

XwmContext	getContext() renvoie le contexte courant.
boolean	getLastLogicalCondition() renvoie le résultat de la dernière condition logique qui a été traitée.
Location	getLocation() renvoie le positionnement courant.
Token	innerNextNonVoidToken(java.lang.String primitive, Location location) renvoie le prochain Token du moteur, mais sans le développer, et qui ne soit pas une espace ou un saut de ligne.
Token	innerNextToken() renvoie le prochain Token du moteur, mais sans le développer.
Token	innerNextTokenAssertIsWord(java.lang.String primitive, Location location) renvoie le prochain Token du moteur, en garantissant qu'il s'agit d'un mot, c'est-à-dire qu'il n'est pas vide (fin de source XWM), qu'il n'est pas une espace, et qu'il n'est pas une macro.
Token[]	innerReadNoexpand(java.lang.String primitive) lit des tokens « tels quels » juste après la rencontre de la primitive "\noexpand", et les renvoie sous forme de tableau.
Token[]	innerReadTokens(java.lang.String primitive) lit des tokens « tels quels » juste après la rencontre de la primitive "\tokens", et les renvoie sous forme de tableau.
void	setLastLogicalCondition(boolean result) renseigne le résultat de la condition logique qui vient d'être traitée.

Method Detail

getContext

XwmContext getContext()

renvoie le contexte courant.

getLastLogicalCondition

boolean getLastLogicalCondition()

renvoie le résultat de la dernière condition logique qui a été traitée. true signifie que la condition logique qui a été traitée dernièrement était vraie, donc les "\else" ultérieurs ne devront pas être appliqués.

getLocation

Location getLocation()

renvoie le positionnement courant.

innerNextNonVoidToken

Token innerNextNonVoidToken(java.lang.String primitive,
                            Location location)
                            throws java.io.IOException

renvoie le prochain Token du moteur, mais sans le développer, et qui ne soit pas une espace ou un saut de ligne.

Throws:

java.io.IOException

innerNextToken

Token innerNextToken()
                     throws java.io.IOException

renvoie le prochain Token du moteur, mais sans le développer.

Throws:

java.io.IOException

innerNextTokenAssertIsWord

Token innerNextTokenAssertIsWord(java.lang.String primitive,
                                 Location location)
                                 throws java.io.IOException,
                                        XwmEngineException

renvoie le prochain Token du moteur, en garantissant qu'il s'agit d'un mot, c'est-à-dire qu'il n'est pas vide (fin de source XWM), qu'il n'est pas une espace, et qu'il n'est pas une macro.

Throws:

java.io.IOException

XwmEngineException

innerReadNoexpand

Token[] innerReadNoexpand(java.lang.String primitive)
                          throws java.io.IOException

lit des tokens « tels quels » juste après la rencontre de la primitive "\noexpand", et les renvoie sous forme de tableau.

Throws:

java.io.IOException

innerReadTokens

Token[] innerReadTokens(java.lang.String primitive)
                        throws java.io.IOException

lit des tokens « tels quels » juste après la rencontre de la primitive "\tokens", et les renvoie sous forme de tableau.

Throws:

java.io.IOException

setLastLogicalCondition

void setLastLogicalCondition(boolean result)

renseigne le résultat de la condition logique qui vient d'être traitée. true signifie que la condition logique qui vient d'être traitée était vraie, donc les "\else" ultérieurs ne devront pas être appliqués.