errorsContainer.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - 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,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or 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.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2025                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_ERRORS_CONTAINERS_H
#define GUM_ERRORS_CONTAINERS_H
 
#include <fstream>
#include <iostream>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/cocoR/common.h>
 
namespace gum {

  class ParseError {
    public:
    // ============================================================================
    // ============================================================================

    ParseError(bool is_error, const std::string& msg, Idx line);

    ParseError(bool               is_error,
               const std::string& msg,
               const std::string& filename,
               Idx                line,
               Idx                col = 0);

    ParseError(bool               is_error,
               const std::string& msg,
               const std::string& filename,
               const std::string& code,
               Idx                line,
               Idx                col = 0);

    ParseError(const ParseError& cont);

    // ============================================================================
    // ============================================================================

    ParseError operator=(const ParseError& cont);

    // ============================================================================
    // ============================================================================

    bool is_error;

    Idx line;

    Idx column;

    std::string msg;

    std::string filename;

    mutable std::string code;   // default ""

    std::string toString() const;

    std::string toElegantString() const;

  };

  class ErrorsContainer {
    mutable std::vector< ParseError > errors;
 
    public:
    Size error_count;
 
    // Number of warnings detected.
    Size warning_count;
 
    // ============================================================================
    // ============================================================================

    ErrorsContainer();

    ErrorsContainer(const ErrorsContainer& cont);

    // ============================================================================
    // ============================================================================

    void add(ParseError error);

    ParseError error(Idx i) const;

    ParseError last() const;

    void addError(const std::string& msg, const std::string& filename, Idx line, Idx col);

    void addWarning(const std::string& msg, const std::string& filename, Idx line, Idx col);

    void addException(const std::string& msg, const std::string& filename);

    Size count() const;

    void syntheticResults(std::ostream& o) const;

    void simpleErrors(std::ostream& o) const;

    void simpleErrorsAndWarnings(std::ostream& o) const;

    void elegantErrors(std::ostream& o) const;

    void elegantErrorsAndWarnings(std::ostream& o) const;

    // ============================================================================
    // ============================================================================

    void Error(const std::wstring& filename, Idx line, Idx col, const wchar_t* msg);

    void Warning(const std::wstring& filename, Idx line, Idx col, const wchar_t* msg);

    void Exception(const std::wstring& filename, const wchar_t* msg);

    // ============================================================================
    // ============================================================================

    ErrorsContainer operator+(const ErrorsContainer& cont) const;

    ErrorsContainer operator=(const ErrorsContainer& cont);

    ErrorsContainer operator+=(const ErrorsContainer& cont);

 
  };   // ErrorsContainer
 
}   // namespace gum

#ifndef GUM_NO_INLINE
#  include <agrum/base/core/errorsContainer_inl.h>
#endif   /* GUM_NO_INLINE */
 
#endif   // GUM_ERRORS_CONTAINERS_H