lambdamoo/exceptions.h
Roger Crew 2aa5ab682e mark nonreturning functions
we can now remove useless "NOTREACHED" and post-panic() control flow
2025-09-30 23:03:40 -07:00

218 lines
7.5 KiB
C

/******************************************************************************
Copyright (c) 1992, 1995, 1996 Xerox Corporation. All rights reserved.
Portions of this code were written by Stephen White, aka ghond.
Use and copying of this software and preparation of derivative works based
upon this software are permitted. Any distribution of this software or
derivative works must comply with all applicable United States export
control laws. This software is made available AS IS, and Xerox Corporation
makes no warranty about the software, its performance or its conformity to
any specification. Any person obtaining a copy of this software is requested
to send their name and post office or electronic mail address to:
Pavel Curtis
Xerox PARC
3333 Coyote Hill Rd.
Palo Alto, CA 94304
Pavel@Xerox.Com
*****************************************************************************/
/* Copyright 1989 Digital Equipment Corporation. */
/* Distributed only by permission. */
/*****************************************************************************/
/* File: exceptions.h */
/* Taken originally from: */
/* Implementing Exceptions in C */
/* Eric S. Roberts */
/* Research Report #40 */
/* DEC Systems Research Center */
/* March 21, 1989 */
/* Modified slightly by Pavel Curtis for use in the LambdaMOO server code. */
/* ------------------------------------------------------------------------- */
/* The exceptions package provides a general exception handling mechanism */
/* for use with C that is portable across a variety of compilers and */
/* operating systems. The design of this facility is based on the */
/* exception handling mechanism used in the Modula-2+ language at DEC/SRC */
/* and is described in detail in the paper cited above. */
/* For more background on the underlying motivation for this design, see */
/* SRC Research Report #3. */
/*****************************************************************************/
/*
* Syntax: Exception my_exception;
*
* TRY
* stmts;
* EXCEPT (my_exception) [ANY matches all exceptions]
* stmts; [int exception_value available here]
* ...
* ENDTRY
*
* RAISE(my_exception, value);
*
* TRY
* stmts;
* FINALLY
* stmts;
* ENDTRY
*
* Usage notes:
*
* (1) Do *not* attempt any non-local exit from a TRY block or
* handler, meaning
*
* (.) return,
* (.) break or continue from any loop or switch,
* not entirely enclosed in that TRY block/handler,
* (.) goto any label outside of that TRY block/handler, and
* (.) longjmp
*
* are all pretty much guaranteed **not** to behave the way you
* expect and **will** likely corrupt the exception stack
* (...well okay, it is possible that return or goto out of an
* EXCEPT handler won't kill you, but if so, that was by accident,
* and we will try harder next time.)
*
* (2) TRY uses setjmp/longjmp, which means
* automatic variables modified in the TRY body
* whose values need to be available in a handler or afterwards
*
* should be declared 'volatile' (compiler otherwise has no idea
* what it needs to restore upon coming back from the longjmp).
*
* (3) Life will be easier if you do all of your memory allocation
* outside of TRY blocks.
*
* If you *have* to allocate within a TRY block, and it's
* something that will become inaccessible when the block exits,
* then anything afterwards within the block that might fail
* should be enclosed in a TRY of its own with a FINALLY that does
* the freeing of whatever you allocated.
*
* Otherwise you've just created a memory leak; congratulations.
*
* --wrog
*/
#ifndef Exceptions_H
#define Exceptions_H 1
#include "config.h"
#include <setjmp.h>
#define ES_MaxExceptionsPerScope 10
typedef enum ES_Value {
ES_Initialize, ES_EvalBody, ES_Exception
} ES_Value;
typedef struct {
int junk;
} Exception; /* Only addr. of exception is used. */
typedef volatile struct ES_CtxBlock ES_CtxBlock;
struct ES_CtxBlock {
jmp_buf jmp;
int nx;
Exception *array[ES_MaxExceptionsPerScope];
Exception *id;
int value;
int finally;
ES_CtxBlock *link;
};
extern Exception ANY;
extern ES_CtxBlock *ES_exceptionStack;
extern void ES_RaiseException(Exception * exception, int value);
#define RAISE(e, v) ES_RaiseException(&e, v)
#define TRY \
{ \
ES_CtxBlock ES_ctx; \
volatile ES_Value ES_es = ES_Initialize; \
\
ES_ctx.nx = 0; \
ES_ctx.finally = 0; \
ES_ctx.link = ES_exceptionStack; \
ES_exceptionStack = &ES_ctx; \
\
if (setjmp((void *) ES_ctx.jmp) != 0) \
ES_es = ES_Exception; \
\
while (1) { \
if (ES_es == ES_EvalBody) { \
/* TRY body goes here */
#define EXCEPT(e) \
/* TRY body or handler goes here */ \
if (ES_es == ES_EvalBody) \
ES_exceptionStack = ES_ctx.link; \
break; \
} \
if (ES_es == ES_Initialize) { \
if (ES_ctx.nx >= ES_MaxExceptionsPerScope) \
panic("Too many EXCEPT clauses!"); \
ES_ctx.array[ES_ctx.nx++] = &e; \
} else if (ES_ctx.id == &e || &e == &ANY) { \
int exception_value = ES_ctx.value; \
\
ES_exceptionStack = ES_ctx.link; \
exception_value = exception_value; \
/* avoid warnings */ \
/* handler goes here */
#define FINALLY \
/* TRY body goes here */ \
} \
if (ES_es == ES_Initialize) \
ES_ctx.finally = 1; \
else { \
ES_exceptionStack = ES_ctx.link; \
/* FINALLY body goes here */ \
#define ENDTRY \
/* FINALLY body or handler goes here */ \
if (ES_ctx.finally && ES_es == ES_Exception) \
ES_RaiseException((Exception *) ES_ctx.id, \
(int) ES_ctx.value); \
break; \
} \
ES_es = ES_EvalBody; \
} \
}
/* The exceptions package doesn't provide this function, but it calls it */
/* whenever a fatal error occurs: */
/* 1) Too many EXCEPT clauses in a single TRY construct. */
/* 2) An unhandled exception is RAISEd. */
extern NORETURN_ panic(const char *message);
#endif /* !Exceptions_H */
/*
* $Log$
* Revision 2.1 1996/02/08 06:25:56 pavel
* Updated copyright notice for 1996. Release 1.8.0beta1.
*
* Revision 2.0 1995/11/30 04:51:06 pavel
* New baseline version, corresponding to release 1.8.0alpha1.
*
* Revision 1.4 1992/10/23 23:03:47 pavel
* Added copyright notice.
*
* Revision 1.3 1992/10/21 03:02:35 pavel
* Converted to use new automatic configuration system.
*
* Revision 1.2 1992/09/23 17:10:48 pavel
* Added protection against this file being included more than once.
*
* Revision 1.1 1992/07/20 23:23:12 pavel
* Initial RCS-controlled version.
*/