/*******************************************************************************
* Copyright (c) 2012 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;

public class Upvaldesc {

	/* upvalue name (for debug information) */
	public LuaString name;
	
	/* whether it is in stack */
	public final boolean instack;
	
	/* index of upvalue (in stack or in outer function's list) */
	public final short idx;

	/* whether assignments to this upvalue are forbidden by a <const> local */
	public final boolean isconst;
	
	public Upvaldesc(LuaString name, boolean instack, int idx) {
		this(name, instack, idx, false);
	}

	public Upvaldesc(LuaString name, boolean instack, int idx, boolean isconst) {
		this.name = name;
		this.instack = instack;
		this.idx = (short) idx;
		this.isconst = isconst;
	}
	
	public String toString() {
		return idx + (instack? " instack ": " closed ") + String.valueOf(name); 
	}
}
