report_correctness.hpp

/*********************************************************************
 *
 * Linear Arrangement Library - A library that implements a collection
 * algorithms for linear arrangments of graphs.
 *
 * Copyright (C) 2019 - 2023
 *
 * This file is part of Linear Arrangement Library. The full code is available
 * at:
 *      https://github.com/LAL-project/linear-arrangement-library.git
 *
 * Linear Arrangement Library is free software: you can redistribute it
 * and/or modify it under the terms of the GNU Affero General Public License
 * as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * Linear Arrangement 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Linear Arrangement Library.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Contact:
 *
 *     Lluís Alemany Puig (lalemany@cs.upc.edu)
 *         LARCA (Laboratory for Relational Algorithmics, Complexity and Learning)
 *         CQL (Complexity and Quantitative Linguistics Lab)
 *         Jordi Girona St 1-3, Campus Nord UPC, 08034 Barcelona.   CATALONIA, SPAIN
 *         Webpage: https://cqllab.upc.edu/people/lalemany/
 *
 *     Ramon Ferrer i Cancho (rferrericancho@cs.upc.edu)
 *         LARCA (Laboratory for Relational Algorithmics, Complexity and Learning)
 *         CQL (Complexity and Quantitative Linguistics Lab)
 *         Office S124, Omega building
 *         Jordi Girona St 1-3, Campus Nord UPC, 08034 Barcelona.   CATALONIA, SPAIN
 *         Webpage: https://cqllab.upc.edu/people/rferrericancho/
 *
 ********************************************************************/
 
#pragma once
 
// C++ include
#include <cstdint>
#include <string>
 
namespace lal {
namespace io {
 
class report_treebank_file {
public:
    report_treebank_file() = default;
    report_treebank_file(const report_treebank_file&) = default;
 
    report_treebank_file(report_treebank_file&&) = default;
 
    ~report_treebank_file() = default;
 
    report_treebank_file(
        uint64_t line_number,
        const std::string& error_message
    )
        : m_treebank_file_line_number(line_number),
          m_error_message(error_message)
    {}
 
    report_treebank_file& operator= (const report_treebank_file&) = default;
    report_treebank_file& operator= (report_treebank_file&&) = default;
 
    /* GETTERS */
 
    uint64_t get_line_number() const noexcept { return m_treebank_file_line_number; }
 
    const std::string& get_error_message() const noexcept { return m_error_message; }
 
#ifndef SWIG
    std::string&& get_error_message() noexcept { return std::move(m_error_message); }
#endif
 
private:
    uint64_t m_treebank_file_line_number;
    std::string m_error_message;
};
 
class report_treebank_collection {
public:
    report_treebank_collection() = default;
    report_treebank_collection(const report_treebank_collection&) = default;
    report_treebank_collection(report_treebank_collection&&) = default;
    ~report_treebank_collection() = default;
 
    report_treebank_collection(
        const std::string& treebank_file_path,
        uint64_t main_file_line,
        uint64_t treebank_line_number,
        const std::string& error_message
    ) noexcept
        : m_treebank_file_path(treebank_file_path),
          m_main_file_line(main_file_line),
          m_treebank_file_line_number(treebank_line_number),
          m_error_message(error_message)
    {}
 
    report_treebank_collection& operator= (const report_treebank_collection&) = default;
    report_treebank_collection& operator= (report_treebank_collection&&) = default;
 
    const std::string& get_treebank_file_name() const noexcept
    { return m_treebank_file_path; }
 
    uint64_t get_line_within_main_file() const noexcept
    { return m_main_file_line; }
 
    uint64_t get_treebank_file_line() const noexcept
    { return m_treebank_file_line_number; }
 
    const std::string& get_error_message() const noexcept
    { return m_error_message; }
 
private:
    std::string m_treebank_file_path;
    uint64_t m_main_file_line;
    uint64_t m_treebank_file_line_number;
    std::string m_error_message;
};
 
} // -- namespace io
} // -- namespace lal