info.bliki.wiki.filter

Class TemplateParser

java.lang.Object

info.bliki.wiki.filter.WikipediaScanner

info.bliki.wiki.filter.AbstractParser

info.bliki.wiki.filter.TemplateParser

public class TemplateParser
extends AbstractParser

A template parser for the first pass in the parsing of a Wikipedia text

See Also:

for the second pass

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
static String	TEMPLATE_PARSER_ERROR

Fields inherited from class info.bliki.wiki.filter.AbstractParser

fCurrentCharacter, fCurrentPosition, fWhiteStart, fWhiteStartPosition

Fields inherited from class info.bliki.wiki.filter.WikipediaScanner

EOF, fScannerPosition, fSource, fStringSource, fWikiModel

Constructor Summary

Constructors

Constructor and Description
TemplateParser(String stringSource)
TemplateParser(String stringSource, boolean parseOnlySignature, boolean renderTemplate)
TemplateParser(String stringSource, boolean parseOnlySignature, boolean renderTemplate, boolean onlyIncludeFlag)

Method Summary

Modifier and Type	Method and Description
static int	checkParserFunction(CharSequence plainContent) Check if this template contains a template function Note: repositions this#fCurrentPosition behind the parser function string if possible
static Object[]	createParameterMap(char[] src, int startOffset, int len) Create a map from the parameters defined in a template call
static Map<String,String>	createParameterMap(Object[] objs, IWikiModel model)
static void	createSingleParameter(String srcString, IWikiModel wikiModel, Map<String,String> namedParameterMap, List<String> unnamedParams) Create a single parameter, defined in a template call, and add it to the named parameters map or unnamed parameter list
static TemplateTag	createTemplateTag(char[] src, int startOffset, int len, IWikiModel model) Create a TemplateTag from the passed template call.
static void	mergeParameters(LinkedHashMap<String,String> parameterMap, List<String> unnamedParameters) If template calls have a mix between named and unnamed parameters, the collected unnamedParameters are merged into the parameterMap.
static void	parse(String rawWikitext, IWikiModel wikiModel, Appendable writer, boolean renderTemplate)
static void	parse(String rawWikitext, IWikiModel wikiModel, Appendable writer, boolean parseOnlySignature, boolean renderTemplate) Parse the wiki texts templates, comments and signatures into the given StringBuilder.
protected boolean	parseHTMLCommentTags(Appendable writer)
static boolean	parsePreprocessRecursive(int startIndex, String rawWikitext, IWikiModel wikiModel, StringBuilder writer, boolean renderTemplate, boolean onlyIncludeFlag, Map<String,String> templateParameterMap) Preprocess parsing of the <includeonly>, <onlyinclude> and <noinclude> tags.
protected static void	parseRecursive(String rawWikitext, IWikiModel wikiModel, Appendable writer, boolean parseOnlySignature, boolean renderTemplate)
static void	parseRecursive(String rawWikitext, IWikiModel wikiModel, Appendable writer, boolean parseOnlySignature, boolean renderTemplate, Map<String,String> templateParameterMap)
StringBuilder	replaceTemplateParameters(Map<String,String> templateParameters, int curlyBraceOffset) Replace the wiki template parameters in the given template string
protected void	runPreprocessParser(int whiteStartPosition, int currentPosition, StringBuilder writer, boolean ignoreTemplateTags) Preprocess parsing of the <includeonly>, <onlyinclude> and <noinclude> tags, HTML comments and <nowiki>, <source> and <math> tags.
protected void	runPreprocessParser(StringBuilder writer, boolean ignoreTemplateTags) Preprocess parsing of the <includeonly>, <onlyinclude> and <noinclude> tags, HTML comments and <nowiki>, <source> and <math> tags.

Methods inherited from class info.bliki.wiki.filter.AbstractParser

consumeWhitespace, findWikiLinkEnd, getNextChar, getNextCharAsWhitespace, isEmptyLine, readUntil, readUntilCharOrStopAtEOL, readUntilIgnoreCase, readUntilNestedIgnoreCase, readWhitespaceUntilEndOfLine, readWhitespaceUntilStartOfLine

Methods inherited from class info.bliki.wiki.filter.WikipediaScanner

findNestedEnd, findNestedEndSingle, findNestedParamEnd, findNestedTemplateEnd, getPosition, indexEndOfComment, indexEndOfNowiki, indexEndOfTable, indexOfUntilNoLetter, makeTag, nextNewline, nextNewlineCell, parseAttributes, parseTag, readSpecialWikiTags, readUntilIgnoreCase, setModel, setPosition, splitByChar, splitByChar, splitByPipe, splitByPipe, startsWith, wpList, wpTable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TEMPLATE_PARSER_ERROR

public static final String TEMPLATE_PARSER_ERROR

See Also:

Constant Field Values

logger

protected static org.slf4j.Logger logger

Constructor Detail

TemplateParser

public TemplateParser(String stringSource)

TemplateParser

public TemplateParser(String stringSource,
                      boolean parseOnlySignature,
                      boolean renderTemplate)

TemplateParser

public TemplateParser(String stringSource,
                      boolean parseOnlySignature,
                      boolean renderTemplate,
                      boolean onlyIncludeFlag)

Method Detail

parse

public static void parse(String rawWikitext,
                         IWikiModel wikiModel,
                         Appendable writer,
                         boolean renderTemplate)
                  throws IOException

Throws:

IOException

parse

public static void parse(String rawWikitext,
                         IWikiModel wikiModel,
                         Appendable writer,
                         boolean parseOnlySignature,
                         boolean renderTemplate)
                  throws IOException

Parse the wiki texts templates, comments and signatures into the given StringBuilder.

Parameters:

rawWikitext -

wikiModel -

writer -

parseOnlySignature - change only the signature string and ignore templates and comments parsing

renderTemplate -

Throws:

IOException

parseRecursive

protected static void parseRecursive(String rawWikitext,
                                     IWikiModel wikiModel,
                                     Appendable writer,
                                     boolean parseOnlySignature,
                                     boolean renderTemplate)
                              throws IOException

Throws:

IOException

parsePreprocessRecursive

public static boolean parsePreprocessRecursive(int startIndex,
                                               String rawWikitext,
                                               IWikiModel wikiModel,
                                               StringBuilder writer,
                                               boolean renderTemplate,
                                               boolean onlyIncludeFlag,
                                               Map<String,String> templateParameterMap)
                                        throws IOException

Preprocess parsing of the <includeonly>, <onlyinclude> and <noinclude> tags. Also performs template parameter substitution.

Throws:

IOException

parseRecursive

public static void parseRecursive(String rawWikitext,
                                  IWikiModel wikiModel,
                                  Appendable writer,
                                  boolean parseOnlySignature,
                                  boolean renderTemplate,
                                  Map<String,String> templateParameterMap)
                           throws IOException

Throws:

IOException

runPreprocessParser

protected void runPreprocessParser(StringBuilder writer,
                                   boolean ignoreTemplateTags)
                            throws IOException

Preprocess parsing of the <includeonly>, <onlyinclude> and <noinclude> tags, HTML comments and <nowiki>, <source> and <math> tags.

Parameters:

writer -

ignoreTemplateTags - don't parse special template tags like <includeonly>, <noinclude>, <onlyinclude>

Throws:

IOException

runPreprocessParser

protected void runPreprocessParser(int whiteStartPosition,
                                   int currentPosition,
                                   StringBuilder writer,
                                   boolean ignoreTemplateTags)
                            throws IOException

Preprocess parsing of the <includeonly>, <onlyinclude> and <noinclude> tags, HTML comments and <nowiki>, <source> and <math> tags.

Parameters:

writer -

whiteStartPosition - the position to start the normal content before the first special template tag

currentPosition - the position to continue with parsing special template tags

ignoreTemplateTags - don't parse special template tags like <includeonly>, <noinclude>, <onlyinclude>

Throws:

IOException

mergeParameters

public static void mergeParameters(LinkedHashMap<String,String> parameterMap,
                                   List<String> unnamedParameters)

If template calls have a mix between named and unnamed parameters, the collected unnamedParameters are merged into the parameterMap. See Help:Template#Mix_of_named_and_unnamed_parameters

createParameterMap

public static Object[] createParameterMap(char[] src,
                                          int startOffset,
                                          int len)

Create a map from the parameters defined in a template call

Returns:

the templates parameters java.util.List at index [0] and the template name at index [1]

createTemplateTag

public static TemplateTag createTemplateTag(char[] src,
                                            int startOffset,
                                            int len,
                                            IWikiModel model)

Create a TemplateTag from the passed template call.

Returns:

the template tag

createParameterMap

public static Map<String,String> createParameterMap(Object[] objs,
                                                    IWikiModel model)

createSingleParameter

public static void createSingleParameter(String srcString,
                                         IWikiModel wikiModel,
                                         Map<String,String> namedParameterMap,
                                         List<String> unnamedParams)

Create a single parameter, defined in a template call, and add it to the named parameters map or unnamed parameter list

See Help:Template: Remember that whitespace characters (spaces, tabs, carriage returns and line feeds) are not automatically stripped from the start and end of unnamed parameters (as they are from named parameters). Including such characters (or any other non-visible characters in any parameters) may in some cases affect the template's behaviour in unexpected ways. (Template designers can use {{StripWhitespace}} to remove unwanted whitespace in unnamed parameters.)

Parameters:

srcString -

namedParameterMap - a key/value pairs for name and value of a template parameter

unnamedParams - a list of unnamed parameter values

checkParserFunction

public static int checkParserFunction(CharSequence plainContent)

Check if this template contains a template function Note: repositions this#fCurrentPosition behind the parser function string if possible

Parameters:

plainContent -

Returns:

the offset behind the ´:´ character at the end of the parser function name or -1 if no parser function can be found in this template.

parseHTMLCommentTags

protected boolean parseHTMLCommentTags(Appendable writer)
                                throws IOException

Throws:

IOException

replaceTemplateParameters

@Nullable
public StringBuilder replaceTemplateParameters(@Nullable
                                                         Map<String,String> templateParameters,
                                                         int curlyBraceOffset)

Replace the wiki template parameters in the given template string

Parameters:

templateParameters -

curlyBraceOffset - TODO

template -

Returns:

null if no replacement could be found