plugins/org.eclipse.ocl.xtext.base/src/org/eclipse/ocl/xtext/base/utilities/ExtendedParserContext.java

/*******************************************************************************
 * Copyright (c) 2012, 2018 Willink Transformations and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v20.html
 *
 * Contributors:
 *   E.D.Willink - Initial API and implementation
 *******************************************************************************/
package org.eclipse.ocl.xtext.base.utilities;

import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.ocl.pivot.resource.ASResource;
import org.eclipse.ocl.pivot.utilities.ParserContext;
import org.eclipse.ocl.xtext.base.cs2as.CS2AS;

/**
 * An ExtendedParserContext captures the context in which source text is parsed with knowledge of the Concrete SYntax classes
 * that are in use.
 *
 * A derived context is constructed with the relevant context, then createBaseResource
 * creates a Concrete Syntax resource for a Concrete Syntax expression string. Then parse creates
 * a corresponding Abstract Syntax ExpressionInOCL. initialize is invoked during the parse to
 * install the derived context into the ExpressionInOCL.
 *
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface ExtendedParserContext extends ParserContext
{
	/**
	 * Create and return a CS2AS to orchestrate the conversion of csResource to asResource.
	 * If a null CS2AS is returned, the default CS2AS appropriate to the csResource should be created by the caller.
	 */
	@Nullable CS2AS createCS2AS(@NonNull BaseCSResource csResource, @NonNull ASResource asResource);
}