/*******************************************************************************
 * Copyright (c) 2015 CWI
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:

 *   * Jurgen J. Vinju - Jurgen.Vinju@cwi.nl - CWI
 */
package org.rascalmpl.debug;

import java.util.Set;

import org.rascalmpl.interpreter.result.IRascalResult;
import org.rascalmpl.value.ISourceLocation;

public interface IRascalFrame {
    /**
     * @return which other modules does this frame depend on
     */
    Set<String> getImports();
    
    /**
     * @return which names of variables are in scope
     */
    Set<String> getFrameVariables();
    
    /**
     * @return the current value and (static) type of the given variable in this frame
     */
    IRascalResult getFrameVariable(String name);
    
    /**
     * @return a human readable name for this stack frame (name of the module or function)
     */
    String getName();
    
    /**
     * @return the current point of execution when this frame was created or `null` if this is a root frame
     */
    ISourceLocation getCallerLocation();
}