/*
 * Copyright (c) 2001 by The XFree86 Project, Inc.
 *
 * 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 XFREE86 PROJECT 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.
 *
 * Except as contained in this notice, the name of the XFree86 Project shall
 * not be used in advertising or otherwise to promote the sale, use or other
 * dealings in this Software without prior written authorization from the
 * XFree86 Project.
 *
 * Author: Paulo César Pereira de Andrade
 */

/* $XFree86: xc/programs/xedit/lisp/debugger.h,v 1.4 2001/10/10 07:02:51 paulo Exp $ */

#ifndef Lisp_debugger_h
#define Lisp_debugger_h

/*
 * Definitions
 */
#define	DBGPROMPT	"DEBUG> "

/*
 * Types
 */
typedef enum _LispDebugState {
    LispDebugUnspec,	/* initial state */
    LispDebugRun,	/* just run, until breakpoint or error */
    LispDebugFinish,	/* evaluates until selected form is finished */
    LispDebugNext,	/* evaluate form */
    LispDebugStep,	/* evaluate form, and step on subforms */
    LispDebugNexti,	/* Like next, but includes variables evaluation */
    LispDebugStepi	/* Like step, but includes variables evaluation */
} LispDebugState;

typedef enum _LispDebugCall {
    LispDebugCallBegin,
    LispDebugCallEnd,
    LispDebugCallBegini,
    LispDebugCallEndi,
    LispDebugCallFatal,
    LispDebugCallWatch	/* just remove watched variables that lost context */
} LispDebugCall;

typedef enum _LispDebugBreak {
    LispDebugBreakFunction,
    LispDebugBreakVariable
} LispDebugBreak;

#include "private.h"

/*
 * Prototypes
 */
void LispDebugger(LispMac*, LispDebugCall, LispObj*, LispObj*);

#endif /* Lisp_debugger_h */
