examples/org.eclipse.ocl.examples.debug/src/org/eclipse/ocl/examples/debug/evaluator/OCLVMVirtualMachine.java

/*******************************************************************************
 * Copyright (c) 2014, 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:
 *     R.Dvorak and others - QVTo debugger framework
 *     E.D.Willink - revised API for OCL debugger framework
 *******************************************************************************/
package org.eclipse.ocl.examples.debug.evaluator;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.ocl.examples.debug.OCLBreakpoint;
import org.eclipse.ocl.examples.debug.core.OCLDebugCore;
import org.eclipse.ocl.examples.debug.core.OCLEvaluationContext;
import org.eclipse.ocl.examples.debug.vm.UnitLocation;
import org.eclipse.ocl.examples.debug.vm.VMBreakpoint;
import org.eclipse.ocl.examples.debug.vm.VMVirtualMachine;
import org.eclipse.ocl.examples.debug.vm.VariableFinder;
import org.eclipse.ocl.examples.debug.vm.data.VMNewBreakpointData;
import org.eclipse.ocl.examples.debug.vm.data.VMStackFrameData;
import org.eclipse.ocl.examples.debug.vm.data.VMVariableData;
import org.eclipse.ocl.examples.debug.vm.evaluator.VMEvaluationEnvironment;
import org.eclipse.ocl.examples.debug.vm.launching.DebuggableRunner;
import org.eclipse.ocl.pivot.Constraint;
import org.eclipse.ocl.pivot.Element;
import org.eclipse.ocl.pivot.Feature;
import org.eclipse.ocl.pivot.Model;
import org.eclipse.ocl.pivot.NamedElement;
import org.eclipse.ocl.pivot.Operation;
import org.eclipse.ocl.pivot.Parameter;
import org.eclipse.ocl.pivot.Type;
import org.eclipse.ocl.pivot.utilities.ClassUtil;

public class OCLVMVirtualMachine extends VMVirtualMachine
{
	public static @NonNull VMStackFrameData @NonNull [] createStackFrame(@NonNull List<UnitLocation> stack) {
		List<VMStackFrameData> result = new ArrayList<VMStackFrameData>();

		int i = 0;
		for (UnitLocation location : stack) {
			// include variables only for the current (top level) stack
			if (location != null) {
				result.add(createStackFrame(location, i++ == 0));
			}
		}
		@NonNull VMStackFrameData @NonNull [] array = result.toArray(new @NonNull VMStackFrameData[result.size()]);
		return array;
	}

	private static boolean appendElementSignature(@NonNull StringBuilder s, @Nullable EObject eObject) {
		if (eObject instanceof Model) {
			return false;
		}
		else if (eObject instanceof org.eclipse.ocl.pivot.Package) {
			if (appendElementSignature(s, eObject.eContainer())) {
				s.append("::");
			}
			s.append(((org.eclipse.ocl.pivot.Package)eObject).getName());
			return true;
		}
		else if (eObject instanceof Type) {
			if (appendElementSignature(s, eObject.eContainer())) {
				s.append("::");
			}
			s.append(((Type)eObject).getName());
			return true;
		}
		else if (eObject instanceof Operation) {
			if (appendElementSignature(s, eObject.eContainer())) {
				s.append("::");
			}
			Operation operation = (Operation)eObject;
			s.append(operation.getName());
			s.append("(");
			boolean isFirst = true;;
			for (Parameter param : operation.getOwnedParameters()) {
				if (!isFirst) {
					s.append(", ");
				}
				Type type = param.getType();
				s.append(type.getName());
				isFirst = false;
			}
			s.append(")");
			return true;
		}
		else if (eObject instanceof Feature) {
			if (appendElementSignature(s, eObject.eContainer())) {
				s.append("::");
			}
			s.append(((Feature)eObject).getName());
			return true;
		}
		else if (eObject instanceof Constraint) {
			if (appendElementSignature(s, eObject.eContainer())) {
				s.append("::");
			}
			s.append(((Constraint)eObject).getName());
			return true;
		}
		else if (eObject != null) {
			return appendElementSignature(s, eObject.eContainer());
		}
		else {
			return false;
		}
	}

	private static @NonNull VMStackFrameData createStackFrame(@NonNull UnitLocation location, boolean includeVars) {
		VMEvaluationEnvironment evalEnv = location.getEvalEnv();
		NamedElement module = location.getModule();
		String moduleName = (module != null) ? ClassUtil.nonNullState(module.getName()) : "<null>"; //$NON-NLS-1$

		NamedElement operation = location.getOperation();
		StringBuilder s = new StringBuilder();
		appendElementSignature(s, operation);
		String operSignature = s.toString(); //MessageFormat.format("<{0}>", moduleName);

		List<VMVariableData> vars = VariableFinder.getVariables(evalEnv);
		String uriString = ClassUtil.nonNullState(location.getURI().toString());
		@SuppressWarnings("null")@NonNull VMVariableData @NonNull [] varsArray = vars.toArray(new VMVariableData[vars.size()]);
		VMStackFrameData vmStackFrame = new VMStackFrameData(evalEnv.getID(), uriString, moduleName,
				operSignature, location.getLineNum(), location.getStartPosition(), location.getEndPosition(), varsArray);
		return vmStackFrame;
	}

	public OCLVMVirtualMachine(@NonNull DebuggableRunner runner, @NonNull OCLEvaluationContext evaluationContext) {
		super(runner, runner.createDebuggableAdapter(evaluationContext));
	}

	@Override
	public @NonNull VMBreakpoint createBreakpoint(@NonNull Element element, @NonNull VMNewBreakpointData data, boolean isTemporary) {
		return new OCLBreakpoint(element, data, isTemporary);
	}

	@Override
	public @NonNull VMBreakpoint createBreakpoint(@NonNull Element element, long id, int line, @NonNull String targetURI, boolean isTemporary) {
		return new OCLBreakpoint(element, id, line, targetURI, isTemporary);
	}

	@Override
	public VMStackFrameData createStackFrame(@NonNull UnitLocation location) {
		return createStackFrame(location, true);
	}

	@Override
	public @NonNull OCLDebugCore getDebugCore() {
		return OCLDebugCore.INSTANCE;
	}
}