Bioplib
Protein Structure C Library
 All Data Structures Files Functions Variables Typedefs Macros Pages
ErrStack.h
Go to the documentation of this file.
1 /************************************************************************/
2 /**
3 
4  \file ErrStack.h
5 
6  \version V1.3
7  \date 14.08.14
8  \brief Build and print an error stack for program failure.
9 
10  \copyright (c) UCL / Dr. Andrew C. R. Martin 1994-2014
11  \author Dr. Andrew C. R. Martin
12  \par
13  Institute of Structural & Molecular Biology,
14  University College London,
15  Gower Street,
16  London.
17  WC1E 6BT.
18  \par
19  andrew@bioinf.org.uk
20  andrew.martin@ucl.ac.uk
21 
22 **************************************************************************
23 
24  This code is NOT IN THE PUBLIC DOMAIN, but it may be copied
25  according to the conditions laid out in the accompanying file
26  COPYING.DOC.
27 
28  The code may be modified as required, but any modifications must be
29  documented so that the person responsible can be identified.
30 
31  The code may not be sold commercially or included as part of a
32  commercial product except as described in the file COPYING.DOC.
33 
34 **************************************************************************
35 
36  Description:
37  ============
38 
39 
40  This set of routines allows a stack of errors to be created.
41  When a program has a fatal error, the StoreError() routine is called
42  to place the error on the stack. As the program un-winds, each
43  routine which fails stores it's error. Finally, before the program
44  actually exits, it calls ShowErrors() to display the error stack.
45 
46 **************************************************************************
47 
48  Usage:
49  ======
50 
51 **************************************************************************
52 
53  Revision History:
54  =================
55 - V1.0 31.08.94 Original By: ACRM
56 - V1.1 07.07.14 Use bl prefix for functions By: CTP
57 - V1.2 31.07.14 Updated deprecation: Removed deprecated.h and added
58  prototypes for renamed functions. By: CTP
59 - V1.3 14.08.14 Moved deprecated function prototypes to deprecated.h
60  By: CTP
61 
62 *************************************************************************/
63 #ifndef _ERRSTACK_H
64 #define _ERRSTACK_H
65 /************************************************************************/
66 /* Includes
67 */
68 #include "SysDefs.h"
69 
70 /************************************************************************/
71 /* Prototypes
72 */
73 void blStoreError(char *routine, char *error);
74 void blShowErrors(void *PrintRoutine(char *), BOOL Trace);
75 
76 /************************************************************************/
77 /* Include deprecated functions */
78 #define _ERRSTACK_H_DEPRECATED
79 #include "deprecated.h"
80 /************************************************************************/
81 
82 #endif
BOOL
short BOOL
Definition: SysDefs.h:64
_errorstack::routine
char * routine
Definition: ErrStack.c:110
deprecated.h
Redirect calls to deprecated functions.
_errorstack::error
char * error
Definition: ErrStack.c:110
blStoreError
void blStoreError(char *routine, char *error)
Definition: ErrStack.c:137
blShowErrors
void blShowErrors(void *PrintRoutine(char *), BOOL Trace)
Definition: ErrStack.c:182
SysDefs.h
System-type variable type definitions.
Generated on Tue Oct 24 2017 10:57:06 for Bioplib by   doxygen 1.8.8