org.xwiki.rendering.wikimodel.xhtml.impl.MacroInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwiki-rendering-wikimodel Show documentation
XWiki Rendering - WikiModel
There is a newer version: 16.10.2
Show newest version
/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.rendering.wikimodel.xhtml.impl;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.xwiki.rendering.wikimodel.WikiParameter;
import org.xwiki.rendering.wikimodel.WikiParameters;
import org.xwiki.rendering.wikimodel.impl.WikiScannerContext;
import org.xwiki.rendering.wikimodel.impl.WikiScannerUtil;

/**
 * This class represents some generic information related to macro and their parsing / rendering.
 *
 * @version $Id: 8968954a36123670519eec791304ddf57cf691f6 $
 * @since 10.10RC1
 */
public class MacroInfo
{
    /**
     * Define the comment marker for starting a macro.
     */
    public static final String MACRO_START = "startmacro:";

    /**
     * Define the comment marker for finishing a macro.
     */
    public static final String MACRO_STOP = "stopmacro";

    private static final String MACRO_SEPARATOR = "|-|";

    private final String name;
    private WikiParameters parameters;

    private String content;

    private WikiScannerContext contentScannerContext;

    private Map parameterScannerContextMap;

    /**
     * Build a MacroInfo based on the content of a comment.
     *
     * @param content A comment representing a macro.
     * It must start with a startmacro comment marker {@link #MACRO_START}.
     */
    public MacroInfo(String content)
    {
        String macroString = content.substring(MACRO_START.length());
        int index = macroString.indexOf(MACRO_SEPARATOR);

        if (index != -1) {
            // Extract macro name
            name = macroString.substring(0, index);

            // Remove macro name part and continue parsing
            macroString = macroString.substring(index + MACRO_SEPARATOR.length());

            index = macroString.indexOf(MACRO_SEPARATOR);
            if (index != -1) {
                // Extract macro parameters
                List parameters = new ArrayList();
                index = WikiScannerUtil.splitToPairs(macroString, parameters, null, MACRO_SEPARATOR);
                this.parameters = new WikiParameters(parameters);

                // Extract macro content
                if (macroString.length() > index) {
                    this.content = macroString.substring(index + MACRO_SEPARATOR.length());
                } else {
                    this.content = null;
                }
            } else {
                // There is only parameters remaining in the string, the
                // macro does not have content
                // Extract macro parameters
                this.parameters = WikiParameters.newWikiParameters(macroString);
                this.content = null;
            }
        } else {
            // There is only macro name, the macro does not have
            // parameters
            // or content
            name = macroString;
            this.content = null;
            parameters = WikiParameters.EMPTY;
        }

        this.parameterScannerContextMap = new HashMap<>();
    }

    /**
     * @return the name of the macro.
     */
    public String getName()
    {
        return name;
    }

    /**
     * @return the parameters of the macro.
     */
    public WikiParameters getParameters()
    {
        return parameters;
    }

    /**
     * Allow to set new parameters for this macro.
     * @param parameters the parameters to set.
     * @since 11.1RC1
     */
    public void setParameters(WikiParameters parameters)
    {
        this.parameters = parameters;
    }

    /**
     * @return the content of the macro.
     */
    public String getContent()
    {
        return content;
    }

    /**
     * Allow to specify the content of the macro when changed in a non generated content block.
     *
     * @param content the new content of the macro.
     */
    public void setContent(String content)
    {
        this.content = content;
    }

    /**
     * @return the scanner context that is used to parse the content of the macro.
     * @since 11.4RC1
     */
    public WikiScannerContext getContentScannerContext()
    {
        return contentScannerContext;
    }

    /**
     * @param contentScannerContext the scanner context that is used to parse the content of the macro.
     * @since 11.4RC1
     */
    public void setContentScannerContext(WikiScannerContext contentScannerContext)
    {
        this.contentScannerContext = contentScannerContext;
    }

    /**
     * @param parameter a parameter name of the macro
     * @param scannerContext the scanner context that is used to parse the specified parameter of the macro.
     * @since 11.4RC1
     */
    public void setParameterScannerContext(String parameter, WikiScannerContext scannerContext)
    {
        this.parameterScannerContextMap.put(parameter, scannerContext);
    }

    /**
     * @param parameter a parameter name of the macro
     * @return the scanner context that is used to parse the specified parameter of the macro.
     * @since 11.4RC1
     */
    public WikiScannerContext getParameterScannerContext(String parameter)
    {
        return this.parameterScannerContextMap.get(parameter);
    }
}