SafeBool.hpp

Go to the documentation of this file.

//
// Aurora C++ Library
// Copyright (c) 2012-2016 Jan Haller
//
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented; you must not
//    claim that you wrote the original software. If you use this software
//    in a product, an acknowledgment in the product documentation would be
//    appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such, and must not be
//    misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//


#ifndef AURORA_SAFEBOOL_HPP
#define AURORA_SAFEBOOL_HPP


namespace aurora
{
namespace detail
{

    // Helpers for Safe-Bool idiom (use member-function pointers since they support quite few operators)
    struct SafeBoolHolder
    {
        // Dummy function
        void function() {}
    };

} // namespace detail

// ---------------------------------------------------------------------------------------------------------------------------



typedef void (detail::SafeBoolHolder::*SafeBool)();

const SafeBool SafeBoolTrue = &detail::SafeBoolHolder::function;

const SafeBool SafeBoolFalse = nullptr;

inline SafeBool toSafeBool(bool condition)
{
    return condition ? SafeBoolTrue : SafeBoolFalse;
}


} // namespace aurora

#endif // AURORA_SAFEBOOL_HPP