testmark.h

Go to the documentation of this file.

/*
 * Copyright (C) 2019 Ondrej Starek
 *
 * This file is part of OTest2.
 *
 * OTest2 is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OTest2 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 OTest2.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef OTest2__LIB_TESTMARK_H_
#define OTest2__LIB_TESTMARK_H_
 
#include <cstdint>
#include <string>
#include <vector>
 
#include <otest2/const.h>
#include <otest2/testmarkhashcode.h>
 
namespace OTest2 {
 
class DiffLogBuilder;
class TestMarkFactory;
class TestMarkFormatter;
class TestMarkIn;
class TestMarkOut;
 
 
class TestMark {
  public:
    struct LinearizedRecord {
        const int level;
        const TestMark* me;
        std::string label;
    };
 
  private:
    virtual TestMarkHashCode doGetHashCode() const noexcept = 0;
 
    virtual bool doIsEqual(
        const TestMark& other_,
        long double precision_) const = 0;
 
    virtual bool doIsEqualValue(
        const TestMark& other_,
        long double precision_) const = 0;
 
    virtual void doDiffArray(
        int level_,
        std::vector<LinearizedRecord>& array_) const = 0;
 
  public:
    virtual void doLinearizedMark(
        int level_,
        const std::string& label_,
        std::vector<LinearizedRecord>& array_) const = 0;
 
  private:
    virtual void doPrintOpen(
        std::ostream& os_,
        const std::string& prefix_) const = 0;
 
    virtual void doPrintClose(
        std::ostream& os_,
        const std::string& prefix_) const = 0;
 
    virtual void doSerializeMark(
        TestMarkOut& serializer_) const = 0;
 
    virtual void doDeserializeMark(
        TestMarkFactory& factory_,
        TestMarkIn& deserializer_) = 0;
 
    static void computeDiff(
        int level_,
        const std::vector<LinearizedRecord>& left_,
        const std::vector<LinearizedRecord>& right_,
        std::vector<LinearizedRecord>& left_result_,
        std::vector<LinearizedRecord>& right_result_,
        DiffLogBuilder& diff_);
 
  public:
    TestMark();
 
    virtual ~TestMark();
 
    /* -- avoid copying */
    TestMark(
        const TestMark&) = delete;
    TestMark& operator =(
        const TestMark&) = delete;
 
    TestMarkHashCode getHashCode() const noexcept;
 
    bool isEqual(
        const TestMark& other_,
        long double precision_ = DEFAULT_FLOAT_PRECISION) const;
 
    bool isEqualValue(
        const TestMark& other_,
        long double precision_ = DEFAULT_FLOAT_PRECISION) const;
 
    bool isEqualValueHash(
        const TestMark& other_,
        long double precision_ = DEFAULT_FLOAT_PRECISION) const;
 
    void linearizedMark(
        std::vector<LinearizedRecord>& array_) const;
 
    void printOpen(
        std::ostream& os_,
        const std::string& prefix_) const;
 
    void printClose(
        std::ostream& os_,
        const std::string& prefix_) const;
 
    void serializeMark(
        TestMarkOut& serializer_) const;
 
    void deserializeMark(
        TestMarkFactory& factory_,
        TestMarkIn& deserializer_);
 
    void computeDiff(
        const TestMark& other_,
        std::vector<LinearizedRecord>& left_,
        std::vector<LinearizedRecord>& right_,
        DiffLogBuilder& diff_) const;
 
    void printMark(
        TestMarkFormatter& formatter_) const;
 
    void printAddMark(
        TestMarkFormatter& formatter_) const;
};
 
} /* namespace OTest2 */
 
#endif /* OTest2__LIB_TESTMARK_H_ */