GRASS GIS 7 Programmer's Manual
7.2.2(2017)-exported
|
GIS Library - Error messages functions. More...
#include <stdlib.h>
#include <string.h>
#include <setjmp.h>
#include <unistd.h>
#include <time.h>
#include <stdarg.h>
#include <sys/types.h>
#include <grass/glocale.h>
#include <grass/gis.h>
#include "gis_local_proto.h"
Go to the source code of this file.
Macros | |
#define | MSG 0 |
A message. More... | |
#define | WARN 1 |
A warning message. More... | |
#define | ERR 2 |
A fatal error message. More... | |
Functions | |
jmp_buf * | G_fatal_longjmp (int enable) |
void | G_message (const char *msg,...) |
Print a message to stderr. More... | |
void | G_verbose_message (const char *msg,...) |
Print a message to stderr but only if module is in verbose mode. More... | |
void | G_important_message (const char *msg,...) |
Print a message to stderr even in brief mode (verbosity=1) More... | |
void | G_fatal_error (const char *msg,...) |
Print a fatal error message to stderr. More... | |
void | G_warning (const char *msg,...) |
Print a warning message to stderr. More... | |
int | G_suppress_warnings (int flag) |
Suppress printing a warning message to stderr. More... | |
int | G_sleep_on_error (int flag) |
Turn on/off no_sleep flag. More... | |
void | G_set_error_routine (int(*error_routine)(const char *, int)) |
Establishes error_routine as the routine that will handle the printing of subsequent error messages. More... | |
void | G_unset_error_routine (void) |
After this call subsequent error messages will be handled in the default method. More... | |
void | G_init_logging (void) |
int | G_info_format (void) |
Get current message format. More... | |
GIS Library - Error messages functions.
(C) 1999-2011 by the GRASS Development Team
This program is free software under the GNU General Public License (>=v2). Read the file COPYING that comes with GRASS for details.
Definition in file gis/error.c.
#define ERR 2 |
A fatal error message.
Definition at line 44 of file gis/error.c.
#define MSG 0 |
A message.
Definition at line 32 of file gis/error.c.
#define WARN 1 |
A warning message.
Definition at line 38 of file gis/error.c.
void G_fatal_error | ( | const char * | msg, |
... | |||
) |
Print a fatal error message to stderr.
The output format depends on environment variable GRASS_MESSAGE_FORMAT
By default, the message is handled by an internal routine which prints the message to the screen. Using G_set_error_routine() the programmer can have the message handled by another routine. This is especially useful if the message should go to a particular location on the screen when using curses or to a location on a graphics device (monitor).
msg | string (cannot be NULL) |
Definition at line 159 of file gis/error.c.
References G_verbose().
Referenced by AS_option_to_algorithm(), Cairo_Graph_set(), cairo_read_bmp(), cairo_read_ppm(), cairo_read_xid(), cairo_write_bmp(), cairo_write_ppm(), cairo_write_xid(), clean_dir(), G_adjust_Cell_head(), G_adjust_Cell_head3(), G_check_input_output_name(), G_config_path(), G_fseek(), G_getenv(), G_getenv2(), G_home(), G_list(), G_location_path(), G_ls2(), G_make_mapset(), G_mapset(), G_mapset_path(), G_math_cholesky_sband_decomposition(), G_math_solver_pcg_sband(), G_open_option_file(), G_option_to_separator(), G_owner(), G_read_key_value_file(), G_srand48_auto(), G_vector_norm_euclid(), G_vector_norm_maxval(), G_write_key_value_file(), GK_print_keys(), Gp_load_sites(), IL_create_bitmask(), IL_write_temp_2d(), M_do_list(), M_do_remove(), main(), N_assemble_les_2d_param(), N_assemble_les_3d_param(), N_compute_gradient_field_2d(), N_compute_gradient_field_3d(), N_compute_gradient_field_components_2d(), N_compute_gradient_field_components_3d(), N_copy_array_2d(), N_copy_array_3d(), N_write_array_2d_to_rast(), P_Sparse_Points(), read_bmp(), read_image(), read_pgm(), read_ppm(), seg_seek_fast(), seg_seek_slow(), write_bmp(), write_image(), write_pgm(), and write_ppm().
jmp_buf* G_fatal_longjmp | ( | int | enable | ) |
Definition at line 67 of file gis/error.c.
void G_important_message | ( | const char * | msg, |
... | |||
) |
Print a message to stderr even in brief mode (verbosity=1)
Usually just G_percent()/G_clicker() would be shown at this level. This allows important non-error/warning messages to display as well.
The output format depends on environment variables GRASS_MESSAGE_FORMAT and GRASS_VERBOSE
msg | string (cannot be NULL) |
Definition at line 130 of file gis/error.c.
References G_verbose(), and G_verbose_min().
int G_info_format | ( | void | ) |
Get current message format.
Maybe set to either "standard" or "gui" (normally GRASS takes care)
Definition at line 531 of file gis/error.c.
References G_init_logging().
void G_init_logging | ( | void | ) |
Definition at line 350 of file gis/error.c.
Referenced by G_info_format(), and G_init_all().
void G_message | ( | const char * | msg, |
... | |||
) |
Print a message to stderr.
The output format depends on environment variable GRASS_MESSAGE_FORMAT
msg | string (cannot be NULL) |
Definition at line 89 of file gis/error.c.
References G_verbose(), and G_verbose_std().
Referenced by G_done_msg(), G_math_solver_cholesky(), G_math_solver_gauss(), G_math_solver_gs(), G_math_solver_jacobi(), G_math_solver_sparse_gs(), G_math_solver_sparse_jacobi(), G_matrix_print(), Gp_load_sites(), IL_create_bitmask(), M_do_copy(), M_do_remove(), M_do_rename(), N_write_array_2d_to_rast(), and show_colormode().
void G_set_error_routine | ( | int(*)(const char *, int) | error_routine | ) |
Establishes error_routine as the routine that will handle the printing of subsequent error messages.
error_routine | routine will be called like this: error_routine(msg, fatal) |
Definition at line 260 of file gis/error.c.
int G_sleep_on_error | ( | int | flag | ) |
Turn on/off no_sleep flag.
If flag is 0, then no pause will occur after printing an error or warning message. Otherwise the pause will occur.
flag | if non-zero/zero value is given G_sleep() will be activated/deactivated |
Definition at line 242 of file gis/error.c.
int G_suppress_warnings | ( | int | flag | ) |
Suppress printing a warning message to stderr.
flag | a warning message will be suppressed if non-zero value is given |
Definition at line 222 of file gis/error.c.
void G_unset_error_routine | ( | void | ) |
After this call subsequent error messages will be handled in the default method.
Error messages are printed directly to the screen: ERROR: message or WARNING: message
Definition at line 273 of file gis/error.c.
void G_verbose_message | ( | const char * | msg, |
... | |||
) |
Print a message to stderr but only if module is in verbose mode.
The output format depends on environment variables GRASS_MESSAGE_FORMAT and GRASS_VERBOSE
msg | string (cannot be NULL) |
Definition at line 108 of file gis/error.c.
References G_verbose(), and G_verbose_std().
Referenced by M_do_copy(), M_do_remove(), M_do_rename(), and PNG_Graph_set().
void G_warning | ( | const char * | msg, |
... | |||
) |
Print a warning message to stderr.
The output format depends on environment variable GRASS_MESSAGE_FORMAT
A warning message can be suppressed by G_suppress_warnings()
msg | string (cannot be NULL) |
Definition at line 203 of file gis/error.c.
Referenced by clean_dir(), close_g3d_file(), G__matrix_add(), G_adjust_Cell_head(), G_adjust_Cell_head3(), G_check_input_output_name(), G_copy_file(), G_get_3dview(), G_get_projinfo(), G_get_projunits(), G_math_cholesky_decomposition(), G_math_solver_cholesky(), G_matrix_copy(), G_matrix_init(), G_matrix_inverse(), G_matrix_LU_solve(), G_matrix_product(), G_matrix_read(), G_matrix_scalar_mul(), G_matrix_set(), G_matrix_set_element(), G_matvect_extract_vector(), G_matvect_get_column(), G_matvect_get_row(), G_matvect_product(), G_put_3dview(), G_read_vector_timestamp(), G_vector_copy(), G_vector_init(), G_vector_norm1(), G_vector_product(), G_vector_set(), G_vector_sub(), G_write_vector_timestamp(), gk_make_linear_framesfromkeys(), Gp_load_sites(), GP_str_to_marker(), GPJ__get_datum_params(), GPJ_osr_to_grass(), gs_err(), Gs_load_3dview(), gs_malloc_lookup(), GS_write_ppm(), GS_write_tif(), GS_write_zoom(), gsd_put_legend(), gsd_rot(), Gv_load_vect(), I_cluster_exec(), M_do_copy(), M_do_remove(), M_do_rename(), main(), Nviz_color_from_str(), Nviz_set_focus_state(), P_Create_Aux2_Table(), P_Create_Aux4_Table(), P_popmatrix(), P_pushmatrix(), parse_fontcap(), Rowio_setup(), seg_pagein(), seg_pageout(), seg_setup(), Segment_init(), and Segment_put().