/*******************************************************************************
* Copyright (c) 2009-2011 Luaj.org. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
* 
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
******************************************************************************/
package org.luaj.vm2;

/**
 * Data class to hold debug information relating to local variables for a {@link Prototype}
 */
public class LocVars {
	/** The local variable name */
	public LuaString varname;
	
	/** The instruction offset when the variable comes into scope */ 
	public int startpc;
	
	/** The instruction offset when the variable goes out of scope */ 
	public int endpc;

	/** The stack slot used by this local variable. */
	public int slot;

	/** Whether this local variable should be closed when leaving scope. */
	public boolean toclose;

	/** Whether this local variable is constant after initialization. */
	public boolean isconst;
	
	/**
	 * Construct a LocVars instance. 
	 * @param varname The local variable name
	 * @param startpc The instruction offset when the variable comes into scope
	 * @param endpc The instruction offset when the variable goes out of scope
	 */
	public LocVars(LuaString varname, int startpc, int endpc) {
		this(varname, startpc, endpc, -1, false);
	}

	public LocVars(LuaString varname, int startpc, int endpc, int slot, boolean toclose) {
		this(varname, startpc, endpc, slot, toclose, false);
	}

	public LocVars(LuaString varname, int startpc, int endpc, int slot, boolean toclose, boolean isconst) {
		this.varname = varname;
		this.startpc = startpc;
		this.endpc = endpc;
		this.slot = slot;
		this.toclose = toclose;
		this.isconst = isconst;
	}
	
	public String tojstring() {
		return varname+" "+startpc+"-"+endpc+(toclose? " <close>": "")+(isconst? " <const>": "");
	}
}
