BIFReader_tpl.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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                           *
 *                                                                          *
 ****************************************************************************/
 
 
#pragma once
 

 
 
#include <agrum/BN/io/BIF/BIFReader.h>
#include <agrum/BN/io/BNReader.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
namespace gum {
 
  template < GUM_Numeric GUM_SCALAR >
  BIFReader< GUM_SCALAR >::BIFReader(BayesNet< GUM_SCALAR >* bn, std::string_view filename) :
      BNReader< GUM_SCALAR >(bn, filename) {
    GUM_CONSTRUCTOR(BIFReader);
    _bn_         = bn;
    _streamName_ = filename;
    _parseDone_  = false;
 
    _factory_ = new BayesNetFactory< GUM_SCALAR >(_bn_);
 
    _ioerror_ = false;
 
    try {
      _scanner_ = new BIF::Scanner(_streamName_.c_str());
      _parser_  = new BIF::Parser(_scanner_);
      _parser_->setFactory(static_cast< IBayesNetFactory* >(_factory_));
    } catch (IOError const&) { _ioerror_ = true; }
  }
 
  template < GUM_Numeric GUM_SCALAR >
  BIFReader< GUM_SCALAR >::~BIFReader() {
    GUM_DESTRUCTOR(BIFReader);
 
    if (!_ioerror_) {
      // this could lead to memory leak !!
      if (_parser_) delete (_parser_);
 
      if (_scanner_) delete (_scanner_);
    }
 
    if (_factory_) delete (_factory_);
  }
 
  template < GUM_Numeric GUM_SCALAR >
  BIF::Scanner& BIFReader< GUM_SCALAR >::scanner() {
    if (_ioerror_) { GUM_ERROR(gum::IOError, "No such file " + streamName()) }
 
    return *_scanner_;
  }
 
  template < GUM_Numeric GUM_SCALAR >
  const std::string& BIFReader< GUM_SCALAR >::streamName() const {
    return _streamName_;
  }
 
  template < GUM_Numeric GUM_SCALAR >
  bool BIFReader< GUM_SCALAR >::trace() const {
    return _traceScanning_;
  }
 
  template < GUM_Numeric GUM_SCALAR >
  void BIFReader< GUM_SCALAR >::trace(bool b) {
    _traceScanning_ = b;
    scanner().setTrace(b);
  }
 
  template < GUM_Numeric GUM_SCALAR >
  Size BIFReader< GUM_SCALAR >::proceed() {
    if (_ioerror_) { GUM_ERROR(gum::IOError, "No such file " + streamName()) }
 
    if (!_parseDone_) {
      try {
        _parser_->Parse();
        _parseDone_ = true;
      } catch (gum::Exception& e) {
        GUM_SHOWERROR(e);
        return 1 + _parser_->errors().error_count;
      }
    }
 
    return (_parser_->errors().error_count);
  }

  template < GUM_Numeric GUM_SCALAR >
  Idx BIFReader< GUM_SCALAR >::errLine(Idx i) const {
    if (_parseDone_) return _parser_->errors().error(i).line;
    else { GUM_ERROR(OperationNotAllowed, "BIF file not parsed yet") }
  }
 
  template < GUM_Numeric GUM_SCALAR >
  Idx BIFReader< GUM_SCALAR >::errCol(Idx i) const {
    if (_parseDone_) return _parser_->errors().error(i).column;
    else { GUM_ERROR(OperationNotAllowed, "BIF file not parsed yet") }
  }
 
  template < GUM_Numeric GUM_SCALAR >
  bool BIFReader< GUM_SCALAR >::errIsError(Idx i) const {
    if (_parseDone_) return _parser_->errors().error(i).is_error;
    else { GUM_ERROR(OperationNotAllowed, "BIF file not parsed yet") }
  }
 
  template < GUM_Numeric GUM_SCALAR >
  std::string BIFReader< GUM_SCALAR >::errMsg(Idx i) const {
    if (_parseDone_) return _parser_->errors().error(i).msg;
    else { GUM_ERROR(OperationNotAllowed, "BIF file not parsed yet") }
  }
 
  template < GUM_Numeric GUM_SCALAR >
  void BIFReader< GUM_SCALAR >::showElegantErrors(std::ostream& o) const {
    if (_parseDone_) _parser_->errors().elegantErrors(o);
    else { GUM_ERROR(OperationNotAllowed, "BIF file not parsed yet") }
  }
 
  template < GUM_Numeric GUM_SCALAR >
  void BIFReader< GUM_SCALAR >::showElegantErrorsAndWarnings(std::ostream& o) const {
    if (_parseDone_) _parser_->errors().elegantErrorsAndWarnings(o);
    else { GUM_ERROR(OperationNotAllowed, "BIF file not parsed yet") }
  }
 
  template < GUM_Numeric GUM_SCALAR >
  void BIFReader< GUM_SCALAR >::showErrorCounts(std::ostream& o) const {
    if (_parseDone_) _parser_->errors().syntheticResults(o);
    else { GUM_ERROR(OperationNotAllowed, "BIF file not parsed yet") }
  }
 
  template < GUM_Numeric GUM_SCALAR >
  Size BIFReader< GUM_SCALAR >::errors() const {
    return (!_parseDone_) ? (Size)0 : _parser_->errors().error_count;
  }
 
  template < GUM_Numeric GUM_SCALAR >
  Size BIFReader< GUM_SCALAR >::warnings() const {
    return (!_parseDone_) ? (Size)0 : _parser_->errors().warning_count;
  }

}   // namespace gum
 
#endif   // DOXYGEN_SHOULD_SKIP_THIS