Assertion.h

/*
MIT License
 
Copyright (c) 2018 Brian T. Park
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
 
#ifndef AUNIT_ASSERTION_H
#define AUNIT_ASSERTION_H
 
#include "Flash.h"
#include "Test.h"
 
class __FlashStringHelper;
class String;
 
namespace aunit {
 
class Assertion: public Test {
  protected:
    Assertion() = default;
 
    bool isOutputEnabled(bool ok) const;
 
    // Terse assertions. Prints only the argument values.
 
    bool assertionBool(
        const char* file,
        uint16_t line,
        bool arg,
        bool value);
 
    bool assertion(
        const char* file,
        uint16_t line,
        bool lhs,
        const char* opName,
        bool (*op)(bool lhs, bool rhs),
        bool rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        char lhs,
        const char* opName,
        bool (*op)(char lhs, char rhs),
        char rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        int lhs,
        const char* opName,
        bool (*op)(int lhs, int rhs),
        int rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        unsigned int lhs,
        const char* opName,
        bool (*op)(unsigned int lhs, unsigned int rhs),
        unsigned int rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        long lhs,
        const char* opName,
        bool (*op)(long lhs, long rhs),
        long rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        unsigned long lhs,
        const char* opName,
        bool (*op)(unsigned long lhs, unsigned long rhs),
        unsigned long rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        long long lhs,
        const char* opName,
        bool (*op)(long long lhs, long long rhs),
        long long rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        unsigned long long lhs,
        const char* opName,
        bool (*op)(unsigned long long lhs, unsigned long long rhs),
        unsigned long long rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        double lhs,
        const char* opName,
        bool (*op)(double lhs, double rhs),
        double rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        const void* lhs,
        const char* opName,
        bool (*op)(const void* lhs, const void* rhs),
        const void* rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        const char* lhs,
        const char* opName,
        bool (*op)(const char* lhs, const char* rhs),
        const char* rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        const char* lhs,
        const char* opName,
        bool (*op)(const char* lhs, const String& rhs),
        const String& rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        const char* lhs,
        const char* opName,
        bool (*op)(const char* lhs, const __FlashStringHelper* rhs),
        const __FlashStringHelper* rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        const String& lhs,
        const char* opName,
        bool (*op)(const String& lhs, const char* rhs),
        const char* rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        const String& lhs,
        const char* opName,
        bool (*op)(const String& lhs, const String& rhs),
        const String& rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        const String& lhs,
        const char* opName,
        bool (*op)(const String& lhs, const __FlashStringHelper* rhs),
        const __FlashStringHelper* rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        const __FlashStringHelper* lhs,
        const char* opName,
        bool (*op)(const __FlashStringHelper* lhs, const char* rhs),
        const char* rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        const __FlashStringHelper* lhs,
        const char* opName,
        bool (*op)(const __FlashStringHelper* lhs, const String& rhs),
        const String& rhs);
 
    bool assertion(
        const char* file,
        uint16_t line,
        const __FlashStringHelper* lhs,
        const char* opName,
        bool (*op)(
            const __FlashStringHelper* lhs,
            const __FlashStringHelper* rhs),
        const __FlashStringHelper* rhs);
 
    bool assertionNear(
        const char* file,
        uint16_t line,
        int lhs,
        int rhs,
        int error,
        const char* opName,
        bool (*compareNear)(int lhs, int rhs, int error));
 
    bool assertionNear(
        const char* file,
        uint16_t line,
        unsigned int lhs,
        unsigned int rhs,
        unsigned int error,
        const char* opName,
        bool (*compareNear)(
            unsigned int lhs, unsigned int rhs, unsigned int error));
 
    bool assertionNear(
        const char* file,
        uint16_t line,
        long lhs,
        long rhs,
        long error,
        const char* opName,
        bool (*compareNear)(long lhs, long rhs, long error));
 
    bool assertionNear(
        const char* file,
        uint16_t line,
        unsigned long lhs,
        unsigned long rhs,
        unsigned long error,
        const char* opName,
        bool (*compareNear)(
            unsigned long lhs, unsigned long rhs, unsigned long error));
 
    bool assertionNear(
        const char* file,
        uint16_t line,
        double lhs,
        double rhs,
        double error,
        const char* opName,
        bool (*compareNear)(double lhs, double rhs, double error));
 
    // Verbose versions of above.
 
    bool assertionBoolVerbose(
        const char* file,
        uint16_t line,
        bool arg,
        const __FlashStringHelper* argString,
        bool value);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        bool lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(bool lhs, bool rhs),
        bool rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        char lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(char lhs, char rhs),
        char rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        int lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(int lhs, int rhs),
        int rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        unsigned int lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(unsigned int lhs, unsigned int rhs),
        unsigned int rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        long lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(long lhs, long rhs),
        long rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        unsigned long lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(unsigned long lhs, unsigned long rhs),
        unsigned long rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        long long lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(long long lhs, long long rhs),
        long long rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        unsigned long long lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(unsigned long long lhs, unsigned long long rhs),
        unsigned long long rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        double lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(double lhs, double rhs),
        double rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        const void* lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(const void* lhs, const void* rhs),
        const void* rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        const char* lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(const char* lhs, const char* rhs),
        const char* rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        const char* lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(const char* lhs, const String& rhs),
        const String& rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        const char* lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(const char* lhs, const __FlashStringHelper* rhs),
        const __FlashStringHelper* rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        const String& lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(const String& lhs, const char* rhs),
        const char* rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        const String& lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(const String& lhs, const String& rhs),
        const String& rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        const String& lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(const String& lhs, const __FlashStringHelper* rhs),
        const __FlashStringHelper* rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        const __FlashStringHelper* lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(const __FlashStringHelper* lhs, const char* rhs),
        const char* rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        const __FlashStringHelper* lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(const __FlashStringHelper* lhs, const String& rhs),
        const String& rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionVerbose(
        const char* file,
        uint16_t line,
        const __FlashStringHelper* lhs,
        const __FlashStringHelper* lhsString,
        const char* opName,
        bool (*op)(
            const __FlashStringHelper* lhs,
            const __FlashStringHelper* rhs),
        const __FlashStringHelper* rhs,
        const __FlashStringHelper* rhsString);
 
    bool assertionNearVerbose(
        const char* file,
        uint16_t line,
        int lhs,
        const __FlashStringHelper* lhsString,
        int rhs,
        const __FlashStringHelper* rhsString,
        int error,
        const __FlashStringHelper* errorString,
        const char* opName,
        bool (*compareNear)(int lhs, int rhs, int error));
 
    bool assertionNearVerbose(
        const char* file,
        uint16_t line,
        unsigned int lhs,
        const __FlashStringHelper* lhsString,
        unsigned int rhs,
        const __FlashStringHelper* rhsString,
        unsigned int error,
        const __FlashStringHelper* errorString,
        const char* opName,
        bool (*compareNear)(
            unsigned int lhs, unsigned int rhs, unsigned int error));
 
    bool assertionNearVerbose(
        const char* file,
        uint16_t line,
        long lhs,
        const __FlashStringHelper* lhsString,
        long rhs,
        const __FlashStringHelper* rhsString,
        long error,
        const __FlashStringHelper* errorString,
        const char* opName,
        bool (*compareNear)(long lhs, long rhs, long error));
 
    bool assertionNearVerbose(
        const char* file,
        uint16_t line,
        unsigned long lhs,
        const __FlashStringHelper* lhsString,
        unsigned long rhs,
        const __FlashStringHelper* rhsString,
        unsigned long error,
        const __FlashStringHelper* errorString,
        const char* opName,
        bool (*compareNear)(
            unsigned long lhs, unsigned long rhs, unsigned long error));
 
    bool assertionNearVerbose(
        const char* file,
        uint16_t line,
        double lhs,
        const __FlashStringHelper* lhsString,
        double rhs,
        const __FlashStringHelper* rhsString,
        double error,
        const __FlashStringHelper* errorString,
        const char* opName,
        bool (*compareNear)(double lhs, double rhs, double error));
 
  private:
    // Disable copy-constructor and assignment operator
    Assertion(const Assertion&) = delete;
    Assertion& operator=(const Assertion&) = delete;
};
 
}
 
#endif