RetCode.h

Go to the documentation of this file.

/*
 * /phoenix/include/RetCode.h
 *
 * This file is a part of Phoenix operating system.
 * Copyright (c) 2011-2012, Artyom Lebedev <artyom.lebedev@gmail.com>
 * All rights reserved.
 * See COPYING file for copyright details.
 */

#ifndef RETCODE_H_
#define RETCODE_H_

class RetCode {
public:
    enum Code {
        SUCCESS, 
        FAIL, 
        INV_PARAM, 
        NOT_FOUND, 
        NO_MEMORY, 
        NO_RESOURCES, 
    };

    inline RetCode(Code retCode = SUCCESS) {
        code = retCode;
    }

    inline operator Code() { return code; }

    inline bool IsOk() { return code == SUCCESS; }

    inline bool IsFailed() { return code != SUCCESS; }

    const char *GetName() {
        switch (code) {
        case SUCCESS:
            return "SUCCESS";
        case FAIL:
            return "FAIL";
        case INV_PARAM:
            return "INV_PARAM";
        case NOT_FOUND:
            return "NOT_FOUND";
        case NO_MEMORY:
            return "NO_MEMORY";
        case NO_RESOURCES:
            return "NO_RESOURCES";
        }
        return "UNKNOWN";
    }

    inline operator const char *() {
        return GetName();
    }

    Code code;
};

#ifdef DEBUG

#define RC(__code)      ({ \
    if (RetCode::__code != RetCode::SUCCESS) { \
        TRACE("Function '%s' at %s:%d failed: %s", \
              __func__, __FILE__, __LINE__, __STR(__code)); \
    } \
    RetCode::__code; \
})

#define OK(__rc)        ({ \
    RetCode __Xrc = __rc; \
    if ((__Xrc).IsFailed()) { \
        TRACE("Failed return code received in '%s' at %s:%d: %s", \
              __func__, __FILE__, __LINE__, (__Xrc).GetName()); \
    } \
    (__Xrc).IsOk(); \
})

#define NOK(__rc)       ({ \
    RetCode __Xrc = __rc; \
    if ((__Xrc).IsFailed()) { \
        TRACE("Failed return code received in '%s' at %s:%d: %s", \
              __func__, __FILE__, __LINE__, (__Xrc).GetName()); \
    } \
    (__Xrc).IsFailed(); \
})

#else /* DEBUG */

#define RC(__code)      RetCode(RetCode::__code)

#define OK(__rc)        (LIKELY((__rc).IsOk()))

#define NOK(__rc)       (UNLIKELY((__rc).IsFailed()))

#endif /* DEBUG */

#endif /* RETCODE_H_ */