org.sweble.wikitext.engine

Interface WtEngine

All Known Implementing Classes:

WtEngineImpl

public interface WtEngine

Method Summary

Modifier and Type	Method and Description
EngProcessedPage	expand(PageId pageId, String wikitext, boolean forInclusion, ExpansionCallback callback) Takes wikitext and expands the wikitext.
EngProcessedPage	expand(PageId pageId, String wikitext, ExpansionCallback callback) Takes wikitext and expands the wikitext.
ExpansionDebugHooks	getDebugHooks()
WikiConfig	getWikiConfig()
boolean	isCatchAll()
boolean	isNoRedirect()
boolean	isTimingEnabled()
EngineNodeFactory	nf()
EngProcessedPage	parse(PageId pageId, String wikitext, ExpansionCallback callback) Takes wikitext and parses the wikitext for viewing.
EngProcessedPage	postprocess(PageId pageId, String wikitext, ExpansionCallback callback) Takes wikitext and parses the wikitext for viewing.
EngProcessedPage	postprocessPpOrExpAst(PageId pageId, WtPreproWikitextPage pprAst) Takes an AST after preprocessing or after expansion and performs the following steps: Parsing Entity substitution Postprocessing
EngProcessedPage	preprocess(PageId pageId, String wikitext, boolean forInclusion, ExpansionCallback callback) Takes wikitext and preprocesses the wikitext (without performing expansion).
void	setCatchAll(boolean catchAll)
void	setDebugHooks(ExpansionDebugHooks hooks)
void	setNoRedirect(boolean noRedirect)
void	setTimingEnabled(boolean timingEnabled)

Method Detail

setDebugHooks

void setDebugHooks(ExpansionDebugHooks hooks)

setNoRedirect

void setNoRedirect(boolean noRedirect)

setTimingEnabled

void setTimingEnabled(boolean timingEnabled)

setCatchAll

void setCatchAll(boolean catchAll)

getWikiConfig

WikiConfig getWikiConfig()

getDebugHooks

ExpansionDebugHooks getDebugHooks()

isNoRedirect

boolean isNoRedirect()

isTimingEnabled

boolean isTimingEnabled()

isCatchAll

boolean isCatchAll()

nf

EngineNodeFactory nf()

preprocess

EngProcessedPage preprocess(PageId pageId,
                            String wikitext,
                            boolean forInclusion,
                            ExpansionCallback callback)
                     throws EngineException

Takes wikitext and preprocesses the wikitext (without performing expansion). The following steps are performed:

• Validation
• Preprocessing (for inclusion/viewing)
• Entity substitution
• Optional: Expansion

Throws:

EngineException

expand

EngProcessedPage expand(PageId pageId,
                        String wikitext,
                        ExpansionCallback callback)
                 throws EngineException

Takes wikitext and expands the wikitext. The following steps are performed:

• Validation
• Preprocessing (for viewing)
• Entity substitution
• Expansion

Throws:

EngineException

expand

EngProcessedPage expand(PageId pageId,
                        String wikitext,
                        boolean forInclusion,
                        ExpansionCallback callback)
                 throws EngineException

Takes wikitext and expands the wikitext. The following steps are performed:

• Validation
• Preprocessing (for viewing)
• Entity substitution
• Expansion

Throws:

EngineException

parse

EngProcessedPage parse(PageId pageId,
                       String wikitext,
                       ExpansionCallback callback)
                throws EngineException

Takes wikitext and parses the wikitext for viewing. The following steps are performed:

• Validation
• Preprocessing (for viewing)
• Entity substitution
• Optional: Expansion
• Parsing
• Entity substitution

Throws:

EngineException

postprocess

EngProcessedPage postprocess(PageId pageId,
                             String wikitext,
                             ExpansionCallback callback)
                      throws EngineException

Takes wikitext and parses the wikitext for viewing. The following steps are performed:

• Validation
• Preprocessing (for viewing)
• Entity substitution
• Optional: Expansion
• Parsing
• Entity substitution
• Postprocessing

Throws:

EngineException

postprocessPpOrExpAst

EngProcessedPage postprocessPpOrExpAst(PageId pageId,
                                       WtPreproWikitextPage pprAst)
                                throws EngineException

Takes an AST after preprocessing or after expansion and performs the following steps:

• Parsing
• Entity substitution
• Postprocessing

Throws:

EngineException