org.turro.parser.DocumentationParser Class Reference

Inheritance diagram for org.turro.parser.DocumentationParser:

Collaboration diagram for org.turro.parser.DocumentationParser:

Public Member Functions
String	getParserName ()
Public Member Functions inherited from org.turro.parser.AbstractParser
	AbstractParser ()
ParserMacroSet	getParserMacros ()
boolean	execute (IConstructor constructor, PrintWriter out, String[] tokens)

Protected Member Functions
boolean	doExecute ()
void	explainMacros (ParserMacroSet macros)
Protected Member Functions inherited from org.turro.parser.AbstractParser
String	getMacroName ()
String	getToken (String name)
String	getToken (String name, boolean defParameter)
String	getToken (String name, String def)
String	getToken (int index)
String	getToken (int index, boolean defParameter)
String	getToken (int index, String def)
int	getTokenSize ()
String	getDefaultFor (int index)
void	prepareProperties (ElephantMarker marker, String properties)

Additional Inherited Members
Protected Attributes inherited from org.turro.parser.AbstractParser
IConstructor	constructor
String[]	tokens
PrintWriter	out
String	parserName
ParserMacroSet	parserMacros = new ParserMacroSet()

Detailed Description

Author

Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 40 of file DocumentationParser.java.

Member Function Documentation

doExecute()

boolean org.turro.parser.DocumentationParser.doExecute ( )

protected

Reimplemented from org.turro.parser.AbstractParser.

Definition at line 48 of file DocumentationParser.java.

                                {
    boolean done = false;
    if("provider-macros".equals(getMacroName())) {
      ElephantMarker marker = new ElephantMarker(constructor);
      marker.put("providers", ContentProviders.getProviders());
      prepareProperties(marker, getToken(1));
      marker.process(getToken(2), getToken(3));
    } else if("social-groups".equals(getMacroName())) {
      ElephantMarker marker = new ElephantMarker(constructor);
      marker.put("socialGroups", SecurityGroups.getAll().stream().sorted().toList());
      marker.put("roles", Permissions.permissionStringMap());
      prepareProperties(marker, getToken(1));
      marker.process(getToken(2), getToken(3));
    } else if("elephant-macros".equals(getMacroName())) {
      ElephantMarker marker = new ElephantMarker(constructor);
      marker.put("elephantParsers", 
              Instances.cached().byAnnotation(ExternalParser.class, IParser.class)
              .stream().filter((p) -> {
                return "all".equals(getToken(1)) || 
                        ((p instanceof AbstractParser) && 
                        ((AbstractParser) p).getParserName().equals(getToken(1)));
              }).collect(Collectors.toList()));
      marker.put("headers", "true".equals(getToken(2)));
      prepareProperties(marker, getToken(3));
      marker.process(getToken(4), getToken(5));
    } else if("elephant-emojis".equals(getMacroName())) {
      ElephantMarker marker = new ElephantMarker(constructor);
      marker.put("emojimap", EmojiMap.getInstance());
      marker.process(getToken(1), getToken(2));
    } else if("elephant-icons".equals(getMacroName())) {
      ElephantMarker marker = new ElephantMarker(constructor);
      marker.put("iconset", IconSet.getInstance());
      marker.process(getToken(1), getToken(2));
    } else if("elephant-indicators".equals(getMacroName())) {
      ElephantMarker marker = new ElephantMarker(constructor);
      marker.put("elephantIndicators", Indicators.getIndicators().stream().filter((i) -> {
                return "all".equals(getToken(1)) || 
                        ((i instanceof IElephantIndicator) && 
                        ((IElephantIndicator) i).getRoot().equals(getToken(1)));
              }).collect(Collectors.toList()));
      marker.put("headers", "true".equals(getToken(2)));
      prepareProperties(marker, getToken(3));
      marker.process(getToken(4), getToken(5));
    } else if("notice".equals(getMacroName())) {
      ElephantMarker marker = new ElephantMarker(constructor);
      marker.put("notice", Secrets.<List<String>>getObject("key=notice;show=false"));
      marker.process("widgets/licenses", "notice");
    } else if("licenses".equals(getMacroName())) {
      ElephantMarker marker = new ElephantMarker(constructor);
      marker.put("licenses", Secrets.<List<String>>getObject("key=licenses;show=false"));
      marker.process("widgets/licenses", "licenses");
    } else if("libraries".equals(getMacroName())) {
      ElephantMarker marker = new ElephantMarker(constructor);
      marker.put("libraries", Secrets.<List<String>>getObject("key=libraries;show=false"));
      marker.process("widgets/licenses", "libraries");
    }
    return done;
  }

Here is the call graph for this function:

explainMacros()

void org.turro.parser.DocumentationParser.explainMacros ( ParserMacroSet  macros )

protected

Reimplemented from org.turro.parser.AbstractParser.

Definition at line 108 of file DocumentationParser.java.

                                                      {
    macros.addMacro("provider-macros")
            .addParameter("doc-properties", true, "*/documentation")
            .addParameter("tmpl-root", true, "documentation")
            .addParameter("template", true, "providerMacros");
    macros.addMacro("social-groups")
            .addParameter("doc-properties", true, "*/documentation")
            .addParameter("tmpl-root", true, "documentation")
            .addParameter("template", true, "socialGroups");
    macros.addMacro("elephant-macros")
            .addParameter("parser", false, "all")
            .addParameter("headers", true, "true")
            .addParameter("doc-properties", true, "*/documentation")
            .addParameter("tmpl-root", true, "documentation")
            .addParameter("template", true, "elephantMacros");
    macros.addMacro("elephant-emojis")
            .addParameter("tmpl-root", true, "documentation")
            .addParameter("template", true, "providerEmojis");
    macros.addMacro("elephant-icons")
            .addParameter("tmpl-root", true, "documentation")
            .addParameter("template", true, "providerIcons");
    macros.addMacro("elephant-indicators")
            .addParameter("indicator", false, "all")
            .addParameter("headers", true, "true")
            .addParameter("doc-properties", true, "*/documentation")
            .addParameter("tmpl-root", true, "documentation")
            .addParameter("template", true, "elephantIndicators");
  }

Here is the call graph for this function:

getParserName()

String org.turro.parser.DocumentationParser.getParserName

(

)

Reimplemented from org.turro.parser.AbstractParser.

Definition at line 43 of file DocumentationParser.java.

                                {
    return "Documentation";
  }

---

The documentation for this class was generated from the following file:

• DocumentationParser.java