chiark / gitweb /
Initial revision
[ssr] / StraySrc / Libraries / Sapphire / csapph / h / report
1 /*
2  * report.h
3  *
4  * [Generated from report, 25 September 1996]
5  */
6
7 #if !defined(__CC_NORCROFT) || !defined(__arm)
8   #error You must use the Norcroft ARM Compiler for Sapphire programs
9 #endif
10
11 #pragma include_only_once
12 #pragma force_top_level
13
14 #ifndef __report_h
15 #define __report_h
16
17 #ifndef __sapphire_h
18   #include "sapphire.h"
19 #endif
20
21 /*----- Overview ----------------------------------------------------------*
22  *
23  * Functions provided:
24  *
25  *  report_register
26  *  report_catchAll
27  *  report_error
28  */
29
30 /* --- report_register --- *
31  *
32  * On entry:    R0 == pointer to routine to use
33  *              R1 == R12 to pass to the routine
34  *              R2 == stack pointer to set when it gets control
35  *
36  * On exit:     --
37  *
38  * Use:         Registers a resume point so that the application can recover
39  *              from errors.  Error messages are reported using errorBox.
40  */
41
42 extern routine report_register;
43
44 /* --- report_catchAll --- *
45  *
46  * On entry:    --
47  *
48  * On exit:     R13 modified
49  *
50  * Use:         Sets up an exception handler to catch errors and other SEH
51  *              exceptions.  Errors are reported in the usual way, and the
52  *              user is given the option to close the application.  Other
53  *              exceptions are reported as errors.
54  */
55
56 extern routine report_catchAll;
57
58 /* --- report_error --- *
59  *
60  * On entry:    R0 == pointer to error
61  *
62  * On exit:     --
63  *
64  * Use:         Prompts the user about quitting the application in response
65  *              to a really bad error.  If the user decides to quit, we
66  *              quit.  Otherwise we return.
67  */
68
69 extern routine report_error;
70
71 /*----- That's all, folks -------------------------------------------------*/
72
73 #endif