result.h

/* Copyright (c) 2013, Stefan.Eilemann@epfl.ch
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef LUNCHBOX_RESULT_H
#define LUNCHBOX_RESULT_H

#include <lunchbox/api.h>
#include <lunchbox/log.h>
#include <lunchbox/types.h>

#include <iostream>

namespace lunchbox
{

class Result
{
    typedef void (Result::*bool_t)() const;
    void bool_true() const {}

public:
    static const int32_t SUCCESS = 0;

    explicit Result( const int32_t code ) : code_( code ){}

    virtual ~Result(){}

    operator bool_t() const { return code_ == SUCCESS ? &Result::bool_true : 0;}

    bool operator !() const { return code_ != SUCCESS; }

    bool operator == ( const int32_t code ) const { return code_ == code; }

    bool operator != ( const int32_t code ) const { return code != code_; }

    int32_t getCode() const { return code_; }

    virtual std::string getString() const
        { return code_ == SUCCESS ? "success" : "result"; }

protected:
    int32_t code_;
};

inline std::ostream& operator << ( std::ostream& os, const Result& result )
{
    return os << result.getString() << " (" << result.getCode() << ")";
}

}
#endif //LUNCHBOX_RESULT_H