xmipp_error.h

Go to the documentation of this file.

/***************************************************************************
*
* Authors:     Carlos Oscar S. Sorzano (coss@cnb.csic.es)
*
* Unidad de  Bioinformatica of Centro Nacional de Biotecnologia , CSIC
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
* 02111-1307  USA
*
*  All comments concerning this program package may be sent to the
*  e-mail address 'xmipp@cnb.csic.es'
***************************************************************************/

#pragma once

#include <stdexcept>
#include "xmipp_strings.h"

/* Enum with errors types.
 * This enum represent the code of all possible
 * Xmipp erros that will be used to reporting errors
 * with REPORT_ERROR and EXIT_ERROR.
 * The convention for the codes is the following:
 * - All starts with prefix ERR_
 * - Follows some kind of section. Like IO for input/output errors.
 *      ERR_IO_
 *      ERR_MEM_
 *      ERR_IMG_
 * - Finally an abbreviation for the error msg.
 * All error codes have a default string message
 * that can be obtained with XmippError::getDefaultMessage(ErrorType)
 */
enum ErrorType
{
    ERR_FIRST_LABEL,
    ERR_ARG_BADCMDLINE,     
    ERR_ARG_INCORRECT,      
    ERR_ARG_MISSING,        
    ERR_ARG_DEPENDENCE,     

    ERR_PROG_NOTDEF,        

    ERR_DEBUG_TEST,         
    ERR_DEBUG_IMPOSIBLE,    

    ERR_DOCFILE,            

    ERR_GPU_MEMORY,         
    ERR_GRID,               
    ERR_GRID_SIZE,          

    ERR_IMG_NOREAD,         
    ERR_IMG_NOWRITE,        
    ERR_IMG_UNKNOWN,        

    ERR_INDEX_OUTOFBOUNDS,  

    ERR_IO,                 
    ERR_IO_NOCLOSED,        
    ERR_IO_NOTEXIST,        
    ERR_IO_NOTOPEN,         
    ERR_IO_NOPERM,          
    ERR_IO_NOREAD,          
    ERR_IO_NOWRITE,         
    ERR_IO_NOTFILE,         
    ERR_IO_NOTDIR,          
    ERR_IO_NOPATH,          
    ERR_IO_LOCKED,          
    ERR_IO_SIZE,            

    ERR_LOGIC_ERROR,        

    ERR_MATRIX,             
    ERR_MATRIX_DIM,         
    ERR_MATRIX_EMPTY,       
    ERR_MATRIX_SIZE,        

    ERR_MD,                 
    ERR_MD_NOACTIVE,        
    ERR_MD_NOOBJ,           
    ERR_MD_BADLABEL,        
    ERR_MD_MISSINGLABEL,    
    ERR_MD_SQL,             
    ERR_MD_OBJECTNUMBER,    
    ERR_MD_BADTYPE,         
    ERR_MD_UNDEFINED,       
    ERR_MD_BADBLOCK ,       

    ERR_MEM_BADREQUEST,     
    ERR_MEM_NOTENOUGH,      
    ERR_MEM_NOTDEALLOC,     
    ERR_MEM_NULLPOINTER,    

    ERR_MMAP,               
    ERR_MMAP_NOTADDR,       

    ERR_MULTIDIM_DIM,       
    ERR_MULTIDIM_SIZE,      
    ERR_MULTIDIM_EMPTY,     

    ERR_NOT_IMPLEMENTED,    

    ERR_NUMERICAL,          

    ERR_PARAM_INCORRECT,    
    ERR_PARAM_MISSING,      

    ERR_PLANS_NOCREATE,     

    ERR_SELFILE,            

    ERR_THREADS_NOTINIT,    

    ERR_TYPE_INCORRECT,     

    ERR_UNCLASSIFIED,       

    ERR_VALUE_EMPTY,        
    ERR_VALUE_INCORRECT,    
    ERR_VALUE_NOTSET,        

    ERR_LAST_LABEL
};


#define REPORT_ERROR(nerr, ErrormMsg) throw XmippError(nerr, ErrormMsg, __FILE__, __LINE__)

//#define REPORT_ERROR(nerr) throw XmippError((ErrorType)nerr, "", __FILE__, __LINE__)

class XmippError : public std::runtime_error
{
public:
    XmippError(const ErrorType nerr, const String& what,
               const String &fileArg, const long lineArg);

    XmippError(const std::string &what):XmippError(ERR_UNCLASSIFIED,what,"Unknown file",0) {};

    ErrorType __errno;
private:
    static String getMessage(const ErrorType nerr, const String& what,
               const String &fileArg, const long lineArg);

    static String getDefaultMessage(ErrorType e);
};

void reportWarning(const String& what);

/* @} */