CepsFlags.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS 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 General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include <fstream>
#include <iostream>
#include <sstream>
#include <source_location>
 
#include "common/core/CepsParallelTools.hpp"
#include "common/abstract/CepsObject.hpp"
 
class Flags : public CepsObject
{
 
  public:
 
    Flags() = delete;
  
    Flags(int argc, CepsChar **argv);
  
    Flags(Flags& that) = delete;
  
    ~Flags();
  
    Flags&
    operator=(Flags& that) = delete;
  
    void
    setVerbose(CepsBool v);
  
    void
    enableDebug();
  
    void
    enableProfiling();
  
    void
    enableTesting();
  
    void
    disableTesting();
  
    void
    enableWarnings();
  
    void
    disableWarnings();
  
    CepsBool
    profiling() const;
 
    CepsBool
    testing() const;
 
    CepsBool
    verbose() const;
  
    CepsBool
    warnings() const;
  
    void
    printHelp(CepsChar** argv);
  
    CepsString
    getDebugLogName() const;
  
    CepsString
    getProfilingLogName() const;
  
    std::ofstream&
    getDebugLog();
  
    std::ofstream&
    getProfilingLog();
  
 
  private:
 
    CepsBool m_profiling;              
    CepsBool m_verbose;                
    CepsBool m_warnings;               
    CepsBool m_testing;                
  
    CepsString    m_debugLogName;      
    std::ofstream m_debugLog;          
    CepsString    m_profilingLogName;  
    std::ofstream m_profilingLog;      
 
};
 
extern Flags *flags;
 
namespace ceps
{
  std::ofstream&
  debugLog();
 
  std::ofstream&
  profilingLog();
 
  CepsBool
  isProfiling();
 
  CepsBool
  isVerbose();
 
  CepsBool
  isWarnings();
 
  CepsBool
  isDebug();
 
  void
  disableAbortOnError();
 
  void
  enableAbortOnError();
 
 
 
}  // namespace ceps