org.sweble.wikitext.engine.ext.builtin.BuiltInParserFunctions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swc-engine Show documentation

A minimal engine using the Sweble Wikitext Parser to process articles in the context of a MediaWiki-like configuration.

There is a newer version: 3.1.9

/**
 * Copyright 2011 The Open Source Research Group,
 *                University of Erlangen-Nürnberg
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.sweble.wikitext.engine.ext.builtin;

import java.util.List;

import org.sweble.wikitext.engine.ExpansionFrame;
import org.sweble.wikitext.engine.ParserFunctionBase;
import org.sweble.wikitext.engine.PfnArgumentMode;
import org.sweble.wikitext.engine.config.ParserFunctionGroup;
import org.sweble.wikitext.engine.config.WikiConfig;
import org.sweble.wikitext.parser.nodes.WtNode;
import org.sweble.wikitext.parser.nodes.WtNodeList;
import org.sweble.wikitext.parser.nodes.WtTemplate;
import org.sweble.wikitext.parser.nodes.WtTemplateArgument;

public class BuiltInParserFunctions
		extends
			ParserFunctionGroup
{
	private static final long serialVersionUID = 1L;
	
	// =========================================================================
	
	protected BuiltInParserFunctions(WikiConfig wikiConfig)
	{
		super("Built-in Parser Functions");
		addParserFunction(new ParserFunctionSafeSubst(wikiConfig));
	}
	
	public static BuiltInParserFunctions group(WikiConfig wikiConfig)
	{
		return new BuiltInParserFunctions(wikiConfig);
	}
	
	// =========================================================================
	// ==
	// == {{safesubst}}
	// ==
	// =========================================================================
	
	public static final class ParserFunctionSafeSubst
			extends
				ParserFunctionBase
	{
		private static final long serialVersionUID = 1L;
		
		/**
		 * For un-marshaling only.
		 */
		public ParserFunctionSafeSubst()
		{
			super(PfnArgumentMode.TEMPLATE_ARGUMENTS, "safesubst");
		}
		
		public ParserFunctionSafeSubst(WikiConfig wikiConfig)
		{
			super(wikiConfig, PfnArgumentMode.TEMPLATE_ARGUMENTS, "safesubst");
		}
		
		@Override
		public WtNode invoke(
				WtNode template,
				ExpansionFrame preprocessorFrame,
				List args)
		{
			if (args.size() < 0)
				return null;
			
			// Assuming we are  NOT doing a pre save transformation
			
			WtNodeList name = nf().toList(((WtTemplateArgument) args.get(0)).getValue());
			
			WtNodeList tmplArgs = nf().list(args.subList(1, args.size()));
			
			WtTemplate tmpl = nf().tmpl(
					nf().name(name),
					nf().tmplArgs(tmplArgs));
			
			tmpl.setRtd(template.getRtd());
			
			return preprocessorFrame.expand(tmpl);
		}
	}
}