DocumentationParser.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2020 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.parser;
 
import java.util.List;
import java.util.stream.Collectors;
import org.turro.action.Secrets;
import org.turro.action.content.ContentProviders;
import org.turro.annotation.ExternalParser;
import org.turro.emoji.EmojiMap;
import org.turro.icon.IconSet;
import org.turro.indicator.IElephantIndicator;
import org.turro.indicator.Indicators;
import org.turro.marker.ElephantMarker;
import org.turro.reflection.Instances;
import org.turro.security.Permissions;
import org.turro.security.SecurityGroups;
 
@ExternalParser
public class DocumentationParser extends AbstractParser {
 
  @Override
  public String getParserName() {
    return "Documentation";
  }
 
  @Override
  protected boolean doExecute() {
    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;
  }
 
  @Override
  protected void explainMacros(ParserMacroSet macros) {
    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");
  }
  
}