exception.h

Go to the documentation of this file.

#ifndef FACE_SDK_EXCEPTION_H
#define FACE_SDK_EXCEPTION_H

#include <face_sdk_base/export.h>

#include <exception>
#include <string>

#if defined(WIN32) || defined(_WIN32) || defined(__WIN32)
#pragma warning(push)

// For correct working on android platform need to export face_sdk::exception.
// In other case we will have RTTI problems in out tests.
// Since we have exported face_sdk_exception, it is also good to export
// the symbol of the classes that are used inside the class, in out case class std::string.
// We couldn't do that. Prefer to disable this warning.
#pragma warning(disable:4275)
#pragma warning(disable:4251)
#endif

namespace face_sdk
{
    class FACE_SDK_EXPORT exception : public std::exception
    {
    public:

        exception();

        exception(const std::string &message, int code);

        std::string type_name() const;

        int32_t code() const;

        virtual const char* what() const noexcept override;

    protected:

        std::string _message;
        std::string _type_name;
        int32_t _code;
    };

#define DEFINE_FACE_SDK_EXCEPTION(x, code)                                                          \
                                                                                                    \
    class FACE_SDK_EXPORT x : public face_sdk::exception                                            \
    {                                                                                               \
    public:                                                                                         \
        x() : exception()                                                                           \
        { _type_name = std::string(#x); _code = (code); }                                           \
                                                                                                    \
        explicit x(const std::string &message)                                                      \
                : exception(message, (code))                                                        \
        { _type_name = std::string(#x); _code = (code); }                                           \
    }

    DEFINE_FACE_SDK_EXCEPTION(runtime_exception, 1000);

    DEFINE_FACE_SDK_EXCEPTION(internal_error_exception, 1001);

    DEFINE_FACE_SDK_EXCEPTION(out_of_range_exception, 1002);

    DEFINE_FACE_SDK_EXCEPTION(invalid_parameter_exception, 1003);

    DEFINE_FACE_SDK_EXCEPTION(file_exception, 1004);

    DEFINE_FACE_SDK_EXCEPTION(file_not_found_exception, 1005);

    DEFINE_FACE_SDK_EXCEPTION(bad_image_data_exception, 1006);

    DEFINE_FACE_SDK_EXCEPTION(bad_image_format_exception, 1007);

    DEFINE_FACE_SDK_EXCEPTION(signature_mismatch_exception, 1008);

    DEFINE_FACE_SDK_EXCEPTION(incompatible_version_exception, 1009);

    DEFINE_FACE_SDK_EXCEPTION(version_not_available_exception, 1010);

    DEFINE_FACE_SDK_EXCEPTION(key_not_found_exception, 1011);

    DEFINE_FACE_SDK_EXCEPTION(key_exists_exception, 1012);

    DEFINE_FACE_SDK_EXCEPTION(data_container_corrupted_exception, 1013);

    DEFINE_FACE_SDK_EXCEPTION(data_container_entries_limit_exceed_exception, 1014);

    DEFINE_FACE_SDK_EXCEPTION(not_implemented_exception, 1015);

    DEFINE_FACE_SDK_EXCEPTION(license_exception, 1016);

    DEFINE_FACE_SDK_EXCEPTION(nvml_exception, 1017);

    DEFINE_FACE_SDK_EXCEPTION(platofrm_not_supported_exception, 1018);

    DEFINE_FACE_SDK_EXCEPTION(not_supported_exception, 1019);

    DEFINE_FACE_SDK_EXCEPTION(make_builder_exception, 1020);

    DEFINE_FACE_SDK_EXCEPTION(make_image_compressor_exception, 1021);

    DEFINE_FACE_SDK_EXCEPTION(image_compressor_runtime_exception, 1022);

    DEFINE_FACE_SDK_EXCEPTION(alignment_info_additional_data_exception, 1023);

    DEFINE_FACE_SDK_EXCEPTION(face_out_of_bounds_not_set_exception, 1024);

    DEFINE_FACE_SDK_EXCEPTION(net_runtime_exception, 1025);

    DEFINE_FACE_SDK_EXCEPTION(make_net_exception, 1026);

    DEFINE_FACE_SDK_EXCEPTION(make_fir_matcher_exception, 1027);

    DEFINE_FACE_SDK_EXCEPTION(make_age_gender_exception, 1028);

    DEFINE_FACE_SDK_EXCEPTION(age_gender_runtime_exception, 1029);

    DEFINE_FACE_SDK_EXCEPTION(make_alignment_exception, 1030);

    DEFINE_FACE_SDK_EXCEPTION(make_quality_checker_exception, 1031);

    DEFINE_FACE_SDK_EXCEPTION(quality_checker_runtime_exception, 1032);

    DEFINE_FACE_SDK_EXCEPTION(make_detector_exception, 1033);

    DEFINE_FACE_SDK_EXCEPTION(detect_faces_exception, 1034);

    DEFINE_FACE_SDK_EXCEPTION(make_face_recognition_exception, 1035);

    DEFINE_FACE_SDK_EXCEPTION(make_nn_checker_exception, 1036);

    DEFINE_FACE_SDK_EXCEPTION(nn_checker_runtime_exception, 1037);

    DEFINE_FACE_SDK_EXCEPTION(frame_process_exception, 1038);

    DEFINE_FACE_SDK_EXCEPTION(make_red_eyes_checker_exception, 1039);

    DEFINE_FACE_SDK_EXCEPTION(red_eyes_checker_runtime_exception, 1040);

    DEFINE_FACE_SDK_EXCEPTION(make_face_color_checker_exception, 1041);

    DEFINE_FACE_SDK_EXCEPTION(face_color_checker_runtime_exception, 1042);

    DEFINE_FACE_SDK_EXCEPTION(make_background_checker_exception, 1043);

    DEFINE_FACE_SDK_EXCEPTION(background_checker_runtime_exception, 1044);

    DEFINE_FACE_SDK_EXCEPTION(make_mask_checker_exception, 1045);

    DEFINE_FACE_SDK_EXCEPTION(mask_checker_runtime_exception, 1046);

    DEFINE_FACE_SDK_EXCEPTION(http_client_exception, 1047);

    DEFINE_FACE_SDK_EXCEPTION(make_liveness_exception, 1048);

    DEFINE_FACE_SDK_EXCEPTION(make_pure_fir_extractor_exception, 1049);

    DEFINE_FACE_SDK_EXCEPTION(make_fir_matching_score_table_exception, 1050);

    DEFINE_FACE_SDK_EXCEPTION(keychain_exception, 1051);

    #define UPSCALE_TOO_MUCH_EXCEPTION_CODE 2000
    
    class FACE_SDK_EXPORT upscale_too_much_exception : public exception
    {
    private:
        uint32_t _idx;
    public:
        upscale_too_much_exception(const std::string &message, uint32_t idx) : exception(message, UPSCALE_TOO_MUCH_EXCEPTION_CODE)
        {
            _type_name = "upscale_too_much_exception";
            _idx = idx;
        }

        uint32_t imageIdx()
        {
            return _idx;
        }
    };


    std::string FACE_SDK_EXPORT format_exception(const face_sdk::exception& e, int level = 0);

    bool FACE_SDK_EXPORT is_root_exception_of_type(const std::type_info &tp, const face_sdk::exception &e);

    void FACE_SDK_EXPORT rethrow_root_exception(const face_sdk::exception& e);

#define FACE_SDK_RETHROW_ROOT(x) try{ x; } catch (const face_sdk::exception &exp ) { rethrow_root_exception(exp); }
}

#if defined(WIN32) || defined(_WIN32) || defined(__WIN32)
#pragma warning(pop)
#endif

#endif //FACE_SDK_EXCEPTION_H