roccom_exception.h File Reference

#include "roccom_basic.h"
#include <string>

Include dependency graph for roccom_exception.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	COM_exception
	Encapsulates the states of an exception. More...

Macros
#define	append_frame(s, frame)   append_frame_info( s, #frame, __FILE__, __LINE__)
	Macro for appending the information about the given frame to the string s. More...
#define	CATCHEXP_APPEND(frame)
	Macro for catching an exception and append the information to the current frame. More...
#define	CATCHBADALLOC_APPEND(frame)
	Macro for catching an deallocation exception and append the information to the current frame. More...
#define	CATCHREST_APPEND(frame)
	Macro for catching an unknown exception and append the information to the current frame. More...

Enumerations
enum	Error_code {   COM_WARN_DUP_WINDOW = 100, COM_WARN_DUP_ATTRIBUTE, COM_WARN_DUP_FUNCTION, COM_WARN_DUP_FUNC,   COM_WARN_EMPTY_MESH, COM_WARN_MODULE_LOADED, COM_ERR_MODULE_NOTLOADED =1000, COM_ERR_COULD_OPENLIB,   COM_ERR_COULD_FINDSYM, COM_ERR_WAS_INITIALIZED, COM_ERR_WASNOT_INITIALIZED, COM_ERR_WINDOW_NOTEXIST,   COM_ERR_PANE_NOTEXIST, COM_ERR_ATTRIBUTE_NOTEXIST, COM_ERR_FUNCTION_NOTEXIST, COM_ERR_UNKNOWN_KEYWORD,   COM_ERR_UNKNOWN_DATATYPE, COM_ERR_INVALID_ATTRIBUTE_NAME, COM_ERR_ATTRIBUTE_INITIALIZED, COM_ERR_ATTRIBUTE_ALLOCATED,   COM_ERR_ATTRIBUTE_NOT_ALLOCATED, COM_ERR_ATTRIBUTE_CONST, COM_ERR_ALLOC_STRUCTURED, COM_ERR_INVALID_DIMENSION,   COM_ERR_INVALID_SIZE, COM_ERR_INVALID_CAPACITY, COM_ERR_INVALID_STRIDE, COM_ERR_INVALID_ADDR,   COM_ERR_F90FUNC, COM_ERR_UNKNOWN_INTENT, COM_ERR_TOO_MANY_ARGS, COM_ERR_TOO_FEW_ARGS,   COM_ERR_INVALID_FUNCTION_HANDLE, COM_ERR_INVALID_ATTRIBUTE_HANDLE, COM_ERR_INVALID_WINDOW_HANDLE, COM_ERR_INIT_DONE_PANEMAP,   COM_ERR_INCOMPATIBLE_ATTRS, COM_ERR_INCOMPATIBLE_TYPES, COM_ERR_NOT_A_WINDOW_ATTRIBUTE, COM_ERR_NOT_A_POINTER,   COM_ERR_IMMUTABLE, COM_ERR_NULL_POINTER, COM_ERR_OUT_OF_MEMORY, COM_ERR_INDEX_OUT_OF_BOUNDS,   COM_ERR_PARENT_SMALLER, COM_ERR_CHANGE_INHERITED, COM_ERR_RESIZE, COM_ERR_INHERIT_MESH_LATE,   COM_ERR_INHERIT_ST_NG, COM_ERR_MIXED_GHOST, COM_ERR_GHOST_NODES, COM_ERR_GHOST_ELEMS,   COM_ERR_GHOST_LAYERS, COM_ERR_APPEND_ARRAY, COM_UNKNOWN_ERROR }
	Error codes. More...

Functions
std::ostream &	operator<< (std::ostream &os, const COM_exception &ex)
	Print out a given exception. More...
std::string	append_frame_info (const std::string &s, const char *frame, const char *file, int line)
	Append the information about the given frame to the string s. More...

Macro Definition Documentation

#define append_frame	(		s,
			frame
	)		append_frame_info( s, #frame, __FILE__, __LINE__)

Macro for appending the information about the given frame to the string s.

Definition at line 81 of file roccom_exception.h.

Referenced by Window::alloc_array(), Attribute::allocate(), Roccom_base::allocate_array(), Window::append_array(), Roccom_base::append_array(), Attribute::append_array(), Attribute::Attribute(), Window::attribute(), Roccom_base::call_function(), Roccom_base::clone_attribute(), Pane::connectivity(), Roccom_base::copy_array(), Window::copy_array(), Attribute::copy_array(), copy_array_common(), Roccom_base::copy_attribute(), Window::dealloc_array(), Roccom_base::deallocate_array(), Roccom_base::delete_attribute(), Window::delete_attribute(), Roccom_base::delete_pane(), Roccom_base::delete_window(), Attribute::get_addr(), Connectivity::get_addr(), Roccom_base::get_array(), Window::get_array(), get_array_common(), Roccom_base::get_attribute(), Window::get_attribute(), Roccom_base::get_attribute_handle(), Roccom_base::get_attribute_handle_const(), Roccom_base::get_attributes(), Roccom_base::get_communicator(), Roccom_base::get_connectivities(), Roccom_base::get_f90pointer(), Roccom_base::get_function(), Roccom_base::get_function_handle(), Roccom_base::get_modules(), Roccom_base::get_num_arguments(), Roccom_base::get_panes(), Window::get_parent(), Roccom_base::get_parent(), Roccom_base::get_size(), Window::get_size(), get_size_common(), Window::get_status(), Roccom_base::get_status(), Roccom_base::get_window(), Roccom_base::get_window_handle(), Roccom_base::get_window_object(), Roccom_base::get_windows(), Window::inherit(), Pane::inherit(), Pane::init_done(), Window::init_done(), Roccom_base::new_attribute(), Window::new_attribute(), Pane::new_attribute(), Roccom_base::new_window(), Window::pane(), Pane::refresh_connectivity(), Pane::reinit_attr(), Pane::reinit_conn(), Window::resize_array(), Roccom_base::resize_array(), Roccom_base::set_array(), Window::set_array(), Roccom_base::set_f90pointer(), Window::set_function(), Roccom_base::set_function(), Roccom_base::set_member_function_helper(), Attribute::set_pointer(), Roccom_base::set_profiling_barrier(), Roccom_base::set_size(), Window::set_size(), Connectivity::set_size(), Attribute::set_size(), Pane::set_size(), Roccom_base::split_name(), Roccom_base::use_attribute(), and Roccom_base::window_init_done().

#define CATCHBADALLOC_APPEND

(

frame

)

Value:

catch ( std::bad_alloc xa) \
  { throw COM_exception( COM_ERR_OUT_OF_MEMORY, append_frame( "", frame)); }

Macro for catching an deallocation exception and append the information to the current frame.

Definition at line 92 of file roccom_exception.h.

Referenced by Attribute::allocate(), Attribute::inherit(), and Pane::inherit().

#define CATCHEXP_APPEND

(

frame

)

Value:

catch ( COM_exception e) \
  { throw COM_exception( e.ierr, append_frame( e.msg, frame)); }

Macro for catching an exception and append the information to the current frame.

Definition at line 86 of file roccom_exception.h.

Referenced by Attribute::allocate(), Attribute::deallocate(), Attribute::inherit(), and Pane::inherit().

#define CATCHREST_APPEND

(

frame

)

Value:

catch (...) \
  { throw COM_exception( COM_UNKNOWN_ERROR, append_frame( "", frame)); }

Macro for catching an unknown exception and append the information to the current frame.

Definition at line 98 of file roccom_exception.h.

Enumeration Type Documentation

enum Error_code

Error codes.

Enumerator
COM_WARN_DUP_WINDOW
COM_WARN_DUP_ATTRIBUTE
COM_WARN_DUP_FUNCTION
COM_WARN_DUP_FUNC
COM_WARN_EMPTY_MESH
COM_WARN_MODULE_LOADED
COM_ERR_MODULE_NOTLOADED
COM_ERR_COULD_OPENLIB
COM_ERR_COULD_FINDSYM
COM_ERR_WAS_INITIALIZED
COM_ERR_WASNOT_INITIALIZED
COM_ERR_WINDOW_NOTEXIST
COM_ERR_PANE_NOTEXIST
COM_ERR_ATTRIBUTE_NOTEXIST
COM_ERR_FUNCTION_NOTEXIST
COM_ERR_UNKNOWN_KEYWORD
COM_ERR_UNKNOWN_DATATYPE
COM_ERR_INVALID_ATTRIBUTE_NAME
COM_ERR_ATTRIBUTE_INITIALIZED
COM_ERR_ATTRIBUTE_ALLOCATED
COM_ERR_ATTRIBUTE_NOT_ALLOCATED
COM_ERR_ATTRIBUTE_CONST
COM_ERR_ALLOC_STRUCTURED
COM_ERR_INVALID_DIMENSION
COM_ERR_INVALID_SIZE
COM_ERR_INVALID_CAPACITY
COM_ERR_INVALID_STRIDE
COM_ERR_INVALID_ADDR
COM_ERR_F90FUNC
COM_ERR_UNKNOWN_INTENT
COM_ERR_TOO_MANY_ARGS
COM_ERR_TOO_FEW_ARGS
COM_ERR_INVALID_FUNCTION_HANDLE
COM_ERR_INVALID_ATTRIBUTE_HANDLE
COM_ERR_INVALID_WINDOW_HANDLE
COM_ERR_INIT_DONE_PANEMAP
COM_ERR_INCOMPATIBLE_ATTRS
COM_ERR_INCOMPATIBLE_TYPES
COM_ERR_NOT_A_WINDOW_ATTRIBUTE
COM_ERR_NOT_A_POINTER
COM_ERR_IMMUTABLE
COM_ERR_NULL_POINTER
COM_ERR_OUT_OF_MEMORY
COM_ERR_INDEX_OUT_OF_BOUNDS
COM_ERR_PARENT_SMALLER
COM_ERR_CHANGE_INHERITED
COM_ERR_RESIZE
COM_ERR_INHERIT_MESH_LATE
COM_ERR_INHERIT_ST_NG
COM_ERR_MIXED_GHOST
COM_ERR_GHOST_NODES
COM_ERR_GHOST_ELEMS
COM_ERR_GHOST_LAYERS
COM_ERR_APPEND_ARRAY
COM_UNKNOWN_ERROR

Definition at line 34 of file roccom_exception.h.

                { 
  COM_WARN_DUP_WINDOW = 100, COM_WARN_DUP_ATTRIBUTE,
  COM_WARN_DUP_FUNCTION, COM_WARN_DUP_FUNC, COM_WARN_EMPTY_MESH,
  COM_WARN_MODULE_LOADED, COM_ERR_MODULE_NOTLOADED=1000, 
  COM_ERR_COULD_OPENLIB, COM_ERR_COULD_FINDSYM,
  COM_ERR_WAS_INITIALIZED, COM_ERR_WASNOT_INITIALIZED,
  COM_ERR_WINDOW_NOTEXIST, COM_ERR_PANE_NOTEXIST, 
  COM_ERR_ATTRIBUTE_NOTEXIST, COM_ERR_FUNCTION_NOTEXIST, 
  COM_ERR_UNKNOWN_KEYWORD, COM_ERR_UNKNOWN_DATATYPE, 
  COM_ERR_INVALID_ATTRIBUTE_NAME, COM_ERR_ATTRIBUTE_INITIALIZED, 
  COM_ERR_ATTRIBUTE_ALLOCATED, COM_ERR_ATTRIBUTE_NOT_ALLOCATED, 
  COM_ERR_ATTRIBUTE_CONST, COM_ERR_ALLOC_STRUCTURED, 
  COM_ERR_INVALID_DIMENSION, COM_ERR_INVALID_SIZE, 
  COM_ERR_INVALID_CAPACITY, COM_ERR_INVALID_STRIDE,  COM_ERR_INVALID_ADDR, 
  COM_ERR_F90FUNC, COM_ERR_UNKNOWN_INTENT,  
  COM_ERR_TOO_MANY_ARGS, COM_ERR_TOO_FEW_ARGS, 
  COM_ERR_INVALID_FUNCTION_HANDLE, COM_ERR_INVALID_ATTRIBUTE_HANDLE,
  COM_ERR_INVALID_WINDOW_HANDLE, COM_ERR_INIT_DONE_PANEMAP,
  COM_ERR_INCOMPATIBLE_ATTRS,  COM_ERR_INCOMPATIBLE_TYPES, 
  COM_ERR_NOT_A_WINDOW_ATTRIBUTE, COM_ERR_NOT_A_POINTER, COM_ERR_IMMUTABLE, 
  COM_ERR_NULL_POINTER, COM_ERR_OUT_OF_MEMORY, COM_ERR_INDEX_OUT_OF_BOUNDS, 
  COM_ERR_PARENT_SMALLER, COM_ERR_CHANGE_INHERITED, COM_ERR_RESIZE, 
  COM_ERR_INHERIT_MESH_LATE, COM_ERR_INHERIT_ST_NG, 
  COM_ERR_MIXED_GHOST, COM_ERR_GHOST_NODES, COM_ERR_GHOST_ELEMS, 
  COM_ERR_GHOST_LAYERS, COM_ERR_APPEND_ARRAY, COM_UNKNOWN_ERROR};

Function Documentation

std::string append_frame_info	(	const std::string &	s,
		const char *	frame,
		const char *	file,
		int	line
	)

Append the information about the given frame to the string s.

Definition at line 190 of file roccom_exception.C.

                                               {
  char buf[1000];
  
  std::sprintf( buf, "\nRoccom: In %s of file %s at line %d",
                frame, file, line);
  return s+buf;
}

std::ostream& operator<<	(	std::ostream &	os,
		const COM_exception &	ex
	)

Print out a given exception.

Definition at line 56 of file roccom_exception.C.

References COM_ERR_ALLOC_STRUCTURED, COM_ERR_APPEND_ARRAY, COM_ERR_ATTRIBUTE_ALLOCATED, COM_ERR_ATTRIBUTE_CONST, COM_ERR_ATTRIBUTE_INITIALIZED, COM_ERR_ATTRIBUTE_NOT_ALLOCATED, COM_ERR_ATTRIBUTE_NOTEXIST, COM_ERR_CHANGE_INHERITED, COM_ERR_COULD_FINDSYM, COM_ERR_COULD_OPENLIB, COM_ERR_F90FUNC, COM_ERR_FUNCTION_NOTEXIST, COM_ERR_GHOST_ELEMS, COM_ERR_GHOST_LAYERS, COM_ERR_GHOST_NODES, COM_ERR_IMMUTABLE, COM_ERR_INCOMPATIBLE_ATTRS, COM_ERR_INCOMPATIBLE_TYPES, COM_ERR_INDEX_OUT_OF_BOUNDS, COM_ERR_INHERIT_MESH_LATE, COM_ERR_INHERIT_ST_NG, COM_ERR_INIT_DONE_PANEMAP, COM_ERR_INVALID_ADDR, COM_ERR_INVALID_ATTRIBUTE_HANDLE, COM_ERR_INVALID_ATTRIBUTE_NAME, COM_ERR_INVALID_CAPACITY, COM_ERR_INVALID_DIMENSION, COM_ERR_INVALID_FUNCTION_HANDLE, COM_ERR_INVALID_SIZE, COM_ERR_INVALID_STRIDE, COM_ERR_INVALID_WINDOW_HANDLE, COM_ERR_MIXED_GHOST, COM_ERR_MODULE_NOTLOADED, COM_ERR_NOT_A_POINTER, COM_ERR_NOT_A_WINDOW_ATTRIBUTE, COM_ERR_NULL_POINTER, COM_ERR_OUT_OF_MEMORY, COM_ERR_PANE_NOTEXIST, COM_ERR_PARENT_SMALLER, COM_ERR_RESIZE, COM_ERR_TOO_FEW_ARGS, COM_ERR_TOO_MANY_ARGS, COM_ERR_UNKNOWN_DATATYPE, COM_ERR_UNKNOWN_INTENT, COM_ERR_UNKNOWN_KEYWORD, COM_ERR_WAS_INITIALIZED, COM_ERR_WASNOT_INITIALIZED, COM_ERR_WINDOW_NOTEXIST, COM_UNKNOWN_ERROR, COM_WARN_DUP_ATTRIBUTE, COM_WARN_DUP_FUNC, COM_WARN_DUP_FUNCTION, COM_WARN_DUP_WINDOW, COM_WARN_EMPTY_MESH, COM_WARN_MODULE_LOADED, COM_exception::ierr, and COM_exception::msg.

                                                                 {
  os << "Roccom: " << (ex.ierr<1000?"WARNING ":"ERROR ")
     << ex.ierr << ": ";
  std::string msg;
  switch (ex.ierr) {
  case COM_WARN_DUP_WINDOW:    
    msg = "Duplicated window"; break;
  case COM_WARN_DUP_ATTRIBUTE: 
    msg = "Duplicated attribute"; break;
  case COM_WARN_DUP_FUNCTION:  
    msg = "Duplicated function"; break;
  case COM_WARN_DUP_FUNC:        
    msg = "Duplicated function"; break;
  case COM_WARN_EMPTY_MESH:      
    msg = "Empty mesh"; break;
  case COM_WARN_MODULE_LOADED:
    msg = "Module has already been loaded"; break;

  case COM_ERR_MODULE_NOTLOADED:      
    msg = "Module was never loaded"; break;
  case COM_ERR_COULD_OPENLIB:      
    msg = "Could not open library"; break;
  case COM_ERR_COULD_FINDSYM:      
    msg = "Could not find symbol"; break;

  case COM_ERR_WAS_INITIALIZED:    
    msg = "Roccom was already initialized"; break;
  case COM_ERR_WASNOT_INITIALIZED: 
    msg = "Roccom was not initialized"; break;

  case COM_ERR_INIT_DONE_PANEMAP:  
    msg = "Pane map has changed but input argument claims not"; break;
  case COM_ERR_WINDOW_NOTEXIST:  
    msg = "Window does not exist"; break;
  case COM_ERR_PANE_NOTEXIST:
    msg = "Pane does not exist"; break;
  case COM_ERR_ATTRIBUTE_NOTEXIST: 
    msg = "Attribute does not exist"; break;
  case COM_ERR_FUNCTION_NOTEXIST:  
    msg = "Function does not exist"; break;
  case COM_ERR_UNKNOWN_KEYWORD:    
    msg = "Unknown keyword"; break;
  case COM_ERR_UNKNOWN_DATATYPE:
    msg = "Got an unknown data type"; break;
  case COM_ERR_INVALID_ATTRIBUTE_NAME: 
    msg = "Invalid attribute name"; break;

  case COM_ERR_ATTRIBUTE_INITIALIZED: 
    msg = "Attribute was already intialized"; break;
  case COM_ERR_ATTRIBUTE_NOT_ALLOCATED: 
    msg = "Attribute was not allocated by Roccom"; break;
  case COM_ERR_ATTRIBUTE_CONST: 
    msg = "A const array cannot be modified, and a non-const reference to it\n\
           cannot be obtained."; break;
  case COM_ERR_ATTRIBUTE_ALLOCATED: 
    msg = "Attribute has already been allocated by Roccom"; break;
  case COM_ERR_ALLOC_STRUCTURED:
    msg = "Connectivity for structured meshes cannot be Allocated"; break;
  case COM_ERR_INVALID_DIMENSION:  
    msg = "Invalid number of components or dimensions"; break;
  case COM_ERR_INVALID_SIZE:
    msg = "Invalid size. Cannot be negative or larger than capacity, \n\
   and the number of ghosts cannot be greater than the total number of items."; break;
  case COM_ERR_INVALID_CAPACITY:
    msg = "Invalid capacity. Cannot be smaller than the registered \n\
           size or be zero when setting a nonnull array"; break;
  case COM_ERR_INVALID_STRIDE:
    msg = "Invalid stride. Must be either 1 or >= the number of components"; break;
  case COM_ERR_INVALID_ADDR: 
    msg = "Invalid address. Probably is trying to register a local/stack variable."; break;

  case COM_ERR_F90FUNC:
    msg = "Only F90 functions can accept F90 pointers"; break;
  case COM_ERR_UNKNOWN_INTENT:     
    msg = "Unknown intention of argument"; break;
  case COM_ERR_TOO_MANY_ARGS:      
    msg = "Too many arguments"; break;
  case COM_ERR_TOO_FEW_ARGS:       
    msg = "Too few argument"; break;
  case COM_ERR_INVALID_FUNCTION_HANDLE:      
    msg = "Received an invalid function handle"; break;
  case COM_ERR_INVALID_ATTRIBUTE_HANDLE:       
    msg = "Received an invalid attribute handle"; break;
  case COM_ERR_INVALID_WINDOW_HANDLE:       
    msg = "Received an invalid window handle"; break;
  case COM_ERR_INCOMPATIBLE_ATTRS:
    msg = "Incompatible attributes"; break;
  case COM_ERR_INCOMPATIBLE_TYPES: 
    msg = "Incompatible data types"; break;

  case COM_ERR_NOT_A_WINDOW_ATTRIBUTE:
    msg = "Not a window attribute"; break;
  case COM_ERR_NOT_A_POINTER:
    msg = "Trying to nullify an attribute that is not a pointer"; break;
  case COM_ERR_IMMUTABLE:
    msg = "Immutable attributes cannot be passed to mutable arguments"; break;
  case COM_ERR_NULL_POINTER:
    msg = "Unexpected null pointer"; break;
  case COM_ERR_OUT_OF_MEMORY:      
    msg = "Out of memory"; break;
  case COM_ERR_INDEX_OUT_OF_BOUNDS:      
    msg = "Index out of bounds"; break;

  case COM_ERR_PARENT_SMALLER:
    msg = "Parent window does not have all the panes in child window"; break;
  case COM_ERR_CHANGE_INHERITED:
    msg = "Trying to change the meta-data of an inherited attribute"; break;
  case COM_ERR_RESIZE:
    msg = "Trying to resize an inherited or user-allocated attribute"; break;
  case COM_ERR_INHERIT_MESH_LATE:
    msg = "Mesh must be used/cloned before creating any attribute"; break;
  case COM_ERR_INHERIT_ST_NG:
    msg = "Inheritance w/o ghost is not supported for structured meshes"; break;
  case COM_ERR_MIXED_GHOST:
    msg = "Ghost elements of unstructured mesh must be at the end"; break;
  case COM_ERR_GHOST_NODES:
    msg = "The number of ghost nodes must be <= the total number of nodes"; break;
  case COM_ERR_GHOST_ELEMS:
    msg = "The number of ghost elements must be <= the total number of elements"; break;
  case COM_ERR_GHOST_LAYERS:
    msg = "The number of ghost layers must be <= half of each dimension"; break;
  case COM_ERR_APPEND_ARRAY:
    msg = "Appending array is supported only for window and pane attributes without ghosts"; break;
  case COM_UNKNOWN_ERROR:
  default: 
    msg = "Unknow error"; 
  }

  os << msg << "\nRoccom: Error encountered when processing " 
     << ex.msg << std::endl << "Roccom: ";
  return os;
}