org.xwiki.rendering.internal.macro.raw.RawMacro Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwiki-rendering-macro-raw Show documentation
Directly output content in a target syntax
There is a newer version: 16.10.0-rc-1
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.internal.macro.raw;

import java.util.Collections;
import java.util.List;
import java.util.Set;

import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Singleton;

import org.xwiki.component.annotation.Component;
import org.xwiki.component.manager.ComponentLookupException;
import org.xwiki.rendering.block.Block;
import org.xwiki.rendering.block.RawBlock;
import org.xwiki.rendering.internal.transformation.macro.RawBlockFilterUtils;
import org.xwiki.rendering.macro.AbstractMacro;
import org.xwiki.rendering.macro.MacroExecutionException;
import org.xwiki.rendering.macro.descriptor.DefaultContentDescriptor;
import org.xwiki.rendering.macro.raw.RawMacroParameters;
import org.xwiki.rendering.transformation.MacroTransformationContext;
import org.xwiki.rendering.transformation.macro.RawBlockFilter;
import org.xwiki.rendering.transformation.macro.RawBlockFilterParameters;

/**
 * Directly output content in a target syntax (this generates a {@link org.xwiki.rendering.block.RawBlock}). This is
 * useful when wanting to output some content directly in a target syntax (for example you're writing content in a UIX
 * wiki page and you wish to output LaTeX content since the corresponding UIXP is expecting LaTeX content).
 *
 * @version $Id: 6c62175d0ff0be32c99bd92d39a2be32792dc1ee $
 * @since 13.1RC1
 */
@Component
@Named("raw")
@Singleton
public class RawMacro extends AbstractMacro
{
    /**
     * The description of the macro.
     */
    private static final String DESCRIPTION = "Directly output content in a target syntax";

    /**
     * The description of the macro content.
     */
    private static final String CONTENT_DESCRIPTION = "The content written in the target syntax";

    @Inject
    private RawBlockFilterUtils rawBlockFilterUtils;

    /**
     * Create and initialize the descriptor of the macro.
     */
    public RawMacro()
    {
        super("Raw", DESCRIPTION, new DefaultContentDescriptor(CONTENT_DESCRIPTION, true, Block.LIST_BLOCK_TYPE),
            RawMacroParameters.class);
        setDefaultCategories(Set.of(DEFAULT_CATEGORY_CONTENT));
    }

    @Override
    public boolean supportsInlineMode()
    {
        return true;
    }

    @Override
    public List execute(RawMacroParameters parameters, String content, MacroTransformationContext context)
        throws MacroExecutionException
    {
        RawBlock rawBlock = new RawBlock(content, parameters.getSyntax());

        try {
            RawBlockFilterParameters filterParameters = new RawBlockFilterParameters(context);
            for (RawBlockFilter filter : this.rawBlockFilterUtils.getRawBlockFilters()) {
                rawBlock = filter.filter(rawBlock, filterParameters);
            }
        } catch (ComponentLookupException e) {
            throw new MacroExecutionException("Couldn't initialize the raw content filtering.", e);
        }

        return Collections.singletonList(rawBlock);
    }
}