source: branches/1.1.x/src/org/armedbear/lisp/SpecialBindingsMark.java

/*
 * SpecialBindingsMark.java
 *
 * Copyright (C) 2009 Erik Huelsmann
 * $Id: SpecialBindingsMark.java 12603 2010-04-12 21:06:03Z ehuelsmann $
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * As a special exception, the copyright holders of this library give you
 * permission to link this library with independent modules to produce an
 * executable, regardless of the license terms of these independent
 * modules, and to copy and distribute the resulting executable under
 * terms of your choice, provided that you also meet, for each linked
 * independent module, the terms and conditions of the license of that
 * module.  An independent module is a module which is not derived from
 * or based on this library.  If you modify this library, you may extend
 * this exception to your version of the library, but you are not
 * obligated to do so.  If you do not wish to do so, delete this
 * exception statement from your version.
 */

package org.armedbear.lisp;

/** Class used to mark special bindings state.
 * Returned by LispThread.markSpecialBindings() and consumed by
 * LispThread.resetSpecialBindings() to abstract from the implementation.
 */
final public class SpecialBindingsMark {

    /** The index in the specials array of the saved binding. */
    int idx;

    /** Special binding state to be restored */
    // package level access
    SpecialBinding binding;
    SpecialBindingsMark next;

    /** Constructor to be called by LispThread.markSpecialBindings() only */
    // package level access
    SpecialBindingsMark(int idx, SpecialBinding binding,
                        SpecialBindingsMark next) {
        this.idx = idx;
        this.binding = binding;
        this.next = next;
    }
}