kallisto_error.hpp

Go to the documentation of this file.

#ifndef KALLISTO_ERROR_HPP_
#define KALLISTO_ERROR_HPP_

/*******************************************************************************
 *                             Includes
 * *****************************************************************************/
#include <string>
#include <sstream>      //std::stringstream

namespace kallisto {
namespace error {

/*******************************************************************************
 *                             Library
 ******************************************************************************/
enum KallistoResult {
    SUCCESS = 0,                    
    ERROR_INTERNAL,                 
    ERROR_NO_MEM,                   
    ERROR_NOT_FOUND,                
    ERROR_NOT_SUPPORTED,            
    ERROR_INVALID_PARAM,            
    ERROR_INVALID_STATE,            
    ERROR_INVALID_LENGTH,           
    ERROR_INVALID_FLAGS,            
    ERROR_INVALID_DATA,             
    ERROR_DATA_SIZE,                
    ERROR_TIMEOUT,                  
    ERROR_NULL,                     
    ERROR_FORBIDDEN,                
    ERROR_INVALID_ADDR,             
    ERROR_BUSY,                     
    ERROR_BLUETOOTH_ADAPTER,        
    ERROR_BLUETOOTH_DEVICE          
};

class KallistoDetailedResult {
    private:
        KallistoResult m_result;           // Holds the result code
        std::string m_message;          // Optional message describing why this error ocurred

        KallistoDetailedResult(const KallistoResult result, const std::string message);

    public:
        ~KallistoDetailedResult();

        KallistoDetailedResult (const KallistoDetailedResult& other);

        KallistoDetailedResult (KallistoDetailedResult&& other);

        KallistoDetailedResult& operator= (const KallistoDetailedResult& other);

        KallistoDetailedResult& operator= (KallistoDetailedResult&& other);

        static KallistoDetailedResult build(const KallistoResult result);

        static KallistoDetailedResult build(const KallistoResult result, const std::string message);

        static std::string toString(const KallistoResult result);

        std::string toString() const;

        KallistoResult getResult() const;

        std::string getMessage() const;
};

void kallisto_error_handler(unsigned int& error_code, const char * file, unsigned int line, const char * function);

} /* namespace  error */
} /* namespace kallisto */


#define KALLISTO_ERROR_HANDLER(ERR_CODE)                       \
    do                                                      \
    {                                                       \
        kallisto::error::kallisto_error_handler((ERR_CODE), __FILE__, __LINE__, __FUNCTION__);  \
    } while (0)


#define KALLISTO_ERROR_CHECK(ERR_CODE)                         \
    do                                                      \
    {                                                       \
        unsigned int LOCAL_ERR_CODE = (ERR_CODE);           \
        if (LOCAL_ERR_CODE != 0)                            \
        {                                                   \
            KALLISTO_ERROR_HANDLER(LOCAL_ERR_CODE);            \
        }                                                   \
    } while (0)

#endif /* KALLISTO_ERROR_HPP_ */