org.sweble.wikitext.engine.ExpansionFrame 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;

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

import org.sweble.wikitext.engine.config.WikiConfig;
import org.sweble.wikitext.engine.nodes.EngLogContainer;
import org.sweble.wikitext.engine.utils.UrlService;
import org.sweble.wikitext.parser.WtEntityMap;
import org.sweble.wikitext.parser.nodes.WtNode;
import org.sweble.wikitext.parser.nodes.WtNodeList;

import de.fau.cs.osr.ptk.common.Warning;

public class ExpansionFrame
{
	private final WtEngineImpl engine;
	
	private final ExpansionFrame rootFrame;
	
	private final ExpansionFrame parentFrame;
	
	private final PageTitle title;
	
	private final Map arguments;
	
	private final boolean forInclusion;
	
	private final EngLogContainer frameLog;
	
	private final ExpansionCallback callback;
	
	private final List warnings;
	
	private final WtEntityMap entityMap;
	
	private final boolean noRedirect;
	
	private ExpansionVisitor expansionVisitor;
	
	// FIXME: That should have been initialized from a request!
	//        And only once for the whole expansion process!
	private UrlService urlService = new UrlService();
	
	// =========================================================================
	
	public ExpansionFrame(
			WtEngineImpl engine,
			ExpansionCallback callback,
			ExpansionDebugHooks hooks,
			PageTitle title,
			WtEntityMap entityMap,
			boolean noRedirect,
			List warnings,
			EngLogContainer frameLog,
			boolean timingEnabled,
			boolean catchAll)
	{
		this.engine = engine;
		this.callback = callback;
		this.title = title;
		this.entityMap = entityMap;
		this.arguments = new HashMap();
		this.forInclusion = false;
		this.noRedirect = noRedirect;
		this.warnings = warnings;
		this.frameLog = frameLog;
		this.rootFrame = this;
		this.parentFrame = null;
		
		expansionVisitor = new ExpansionVisitor(
				this,
				frameLog,
				hooks,
				timingEnabled,
				catchAll);
	}
	
	public ExpansionFrame(
			WtEngineImpl engine,
			ExpansionCallback callback,
			ExpansionDebugHooks hooks,
			PageTitle title,
			WtEntityMap entityMap,
			Map arguments,
			boolean forInclusion,
			boolean noRedirect,
			ExpansionFrame rootFrame,
			ExpansionFrame parentFrame,
			List warnings,
			EngLogContainer frameLog,
			boolean timingEnabled,
			boolean catchAll)
	{
		this.engine = engine;
		this.callback = callback;
		this.title = title;
		this.entityMap = entityMap;
		this.arguments = arguments;
		this.forInclusion = forInclusion;
		this.noRedirect = noRedirect;
		this.warnings = warnings;
		this.frameLog = frameLog;
		this.rootFrame = rootFrame;
		this.parentFrame = parentFrame;
		
		expansionVisitor = new ExpansionVisitor(
				this,
				frameLog,
				hooks,
				timingEnabled,
				catchAll);
	}
	
	// =========================================================================
	
	public WtEngineImpl getEngine()
	{
		return engine;
	}
	
	public ExpansionFrame getRootFrame()
	{
		return rootFrame;
	}
	
	public ExpansionFrame getParentFrame()
	{
		return parentFrame;
	}
	
	public PageTitle getTitle()
	{
		return title;
	}
	
	public Map getArguments()
	{
		return arguments;
	}
	
	public boolean isForInclusion()
	{
		return forInclusion;
	}
	
	public EngLogContainer getFrameLog()
	{
		return frameLog;
	}
	
	public WikiConfig getWikiConfig()
	{
		return engine.getWikiConfig();
	}
	
	public void fileWarning(Warning warning)
	{
		warnings.add(warning);
	}
	
	public void addWarnings(Collection warnings)
	{
		this.warnings.addAll(warnings);
	}
	
	public List getWarnings()
	{
		return warnings;
	}
	
	public WtEntityMap getEntityMap()
	{
		return entityMap;
	}
	
	public ExpansionCallback getCallback()
	{
		return callback;
	}
	
	public boolean isNoRedirect()
	{
		return noRedirect;
	}
	
	public UrlService getUrlService()
	{
		return urlService;
	}
	
	// =========================================================================
	
	public WtNode expand(WtNode ppAst) throws ExpansionException
	{
		try
		{
			return (WtNode) expansionVisitor.go(ppAst);
		}
		catch (Exception e)
		{
			throw new ExpansionException(e);
		}
	}
	
	// =========================================================================
	
	public boolean existsPage(PageTitle pageTitle) throws Exception
	{
		return (callback.retrieveWikitext(this, pageTitle) != null) ||
				(callback.fileUrl(pageTitle, -1, -1) != null);
	}
}