library_err.c File Reference

Error handling library. More...

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "ccp4_errno.h"

Classes

struct  error_system

Functions

const char * ccp4_strerror (int error)
void ccp4_error (const char *msg)
void ccp4_fatal (const char *message)
int CFile_Perror (const char *msg)
int ccp4_liberr_verbosity (int iverb)
void ccp4_signal (const int code, const char *const msg, void(*callback)())

Variables

int ccp4_errno = 0


Detailed Description

Error handling library.

Author:
Charles Ballard

Function Documentation

void ccp4_error ( const char *  msg  ) 

Print out passed message and internal message based upon ccp4_errno "message : error message "

Parameters:
msg (const char *)
Returns:
void

References ccp4_errno, and ccp4_strerror().

Referenced by ccp4_fatal().

void ccp4_fatal ( const char *  message  ) 

Wrapper for ccp4_error which also calls exit(1)

Parameters:
message 

References ccp4_error().

Referenced by ccp4_file_fatal(), and ccp4_utils_isnan().

int ccp4_liberr_verbosity ( int  iverb  ) 

Set error verbosity level

Parameters:
[in] iverb Error level

Referenced by ccp4_signal(), ccp4uc_cells_differ(), MtzGet(), and sort_batches().

void ccp4_signal ( const int  code,
const char *const   msg,
void(*)()  callback 
)

Routine to set ccp4_errno and print out message for error tracing. This should be the only way in which ccp4_errno is set. See error codes above for levels and systems. A callback with prototype void function(void) may also be passed to the routine.

Note:
FATAL calls exit(1).
Parameters:
[in] code error code (int)
[in] msg error message
[in] callback point to callback routine

References ccp4_errno, and ccp4_liberr_verbosity().

Referenced by ccp4_cmap_get_label(), ccp4_cmap_get_mask(), ccp4_cmap_get_symop(), ccp4_cmap_open(), ccp4_cmap_read_data(), ccp4_cmap_read_row(), ccp4_cmap_read_section(), ccp4_cmap_read_section_header(), ccp4_cmap_seek_data(), ccp4_cmap_seek_row(), ccp4_cmap_seek_section(), ccp4_cmap_seek_symop(), ccp4_cmap_set_label(), ccp4_cmap_set_mask(), ccp4_cmap_set_symop(), ccp4_cmap_write_data(), ccp4_cmap_write_row(), ccp4_cmap_write_section(), ccp4_cmap_write_section_header(), ccp4_file_close(), ccp4_file_fatal(), ccp4_file_feof(), ccp4_file_itemsize(), ccp4_file_length(), ccp4_file_mode(), ccp4_file_open(), ccp4_file_open_fd(), ccp4_file_open_file(), ccp4_file_rarch(), ccp4_file_raw_read(), ccp4_file_raw_seek(), ccp4_file_raw_write(), ccp4_file_read(), ccp4_file_readchar(), ccp4_file_readcomp(), ccp4_file_readfloat(), ccp4_file_readint(), ccp4_file_readshort(), ccp4_file_readshortcomp(), ccp4_file_rewind(), ccp4_file_seek(), ccp4_file_setbyte(), ccp4_file_setmode(), ccp4_file_setstamp(), ccp4_file_tell(), ccp4_file_warch(), ccp4_file_write(), ccp4_file_writechar(), ccp4_file_writecomp(), ccp4_file_writefloat(), ccp4_file_writeint(), ccp4_file_writeshort(), ccp4_file_writeshortcomp(), ccp4_parse(), ccp4_parser(), ccp4fyp(), ccp4setenv(), ccp4spg_centric_phase(), ccp4spg_generate_indices(), ccp4spg_get_multiplicity(), ccp4spg_is_centric(), ccp4spg_is_in_asu(), ccp4spg_is_sysabs(), ccp4spg_load_spacegroup(), ccp4spg_print_centric_zones(), ccp4spg_print_epsilon_zones(), ccp4spg_print_recip_ops(), ccp4spg_put_in_asu(), ccp4spg_set_centric_zones(), ccp4spg_set_epsilon_zones(), ccp4spg_symbol_Hall(), doublefromstr(), mat4_to_symop(), MtzAddColumn(), MtzAddDataset(), MtzAddXtal(), MtzAssignColumn(), MtzGet(), MtzHklcoeffs(), MtzMalloc(), MtzMallocBatch(), MtzMallocCol(), MtzOpenForWrite(), MtzParseLabin(), MtzWrefl(), parse_mapheader(), set_fft_grid(), symop_to_mat4(), and write_mapheader().

const char* ccp4_strerror ( int  error  ) 

Obtain character string based upon error code. Typical use ccp4_strerror(ccp4_errno) The returned string is statically allocated in the library_err.c file and should not be freed.

Parameters:
error error code (int)
Returns:
const pointer to error message.

Referenced by ccp4_error(), and ccp4_file_error().

int CFile_Perror ( const char *  msg  ) 

Output error messaage to stderr.

Parameters:
msg Error message.

References ccp4_errno.


Variable Documentation

int ccp4_errno = 0


Generated on Wed Oct 29 21:05:09 2008 for gpp4 by  doxygen 1.5.6