Logger.cc

Go to the documentation of this file.

/* Copyright (C) 2015, 2017, 2021, 2022, 2023 PISM Authors
 *
 * This file is part of PISM.
 *
 * PISM 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.
 *
 * PISM 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 PISM; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#include <unistd.h>
#include <sstream>
#include <stdarg.h>
#include <petscsys.h>
 
#include "pism/util/Logger.hh"
#include "pism/util/pism_options.hh"
#include "pism/util/error_handling.hh"
 
namespace pism {
 
struct Logger::Impl {
  MPI_Comm com;
  bool enabled;
  int threshold;
};
 
Logger::Logger(MPI_Comm com, int threshold)
  : m_impl(new Impl) {
 
  m_impl->com = com;
  m_impl->enabled = true;
  m_impl->threshold = threshold;
}
 
Logger::~Logger() {
  delete m_impl;
}
 
void Logger::message(int threshold, const char format[], ...) const {
  if ((not m_impl->enabled) or threshold > m_impl->threshold) {
    return;
  }
 
  char buffer[8192];
  va_list argp;
 
  va_start(argp, format);
  vsnprintf(buffer, sizeof(buffer), format, argp);
  va_end(argp);
 
  message_impl(buffer);
}
 
void Logger::message(int threshold, const std::string &text) const {
  if ((not m_impl->enabled) or threshold > m_impl->threshold) {
    return;
  }
 
  message_impl(text.c_str());
}
 
void Logger::message_impl(const char buffer[]) const {
  PetscErrorCode ierr = PetscFPrintf(m_impl->com, PETSC_STDOUT, "%s", buffer);
  PISM_CHK(ierr, "PetscFPrintf");
}
 
void Logger::error(const char format[], ...) const {
  char buffer[8192];
  va_list argp;
 
  va_start(argp, format);
  vsnprintf(buffer, sizeof(buffer), format, argp);
  va_end(argp);
 
  error_impl(buffer);
}
 
void Logger::error_impl(const char buffer[]) const {
  PetscErrorCode ierr = PetscFPrintf(m_impl->com, stderr, "%s", buffer);
  PISM_CHK(ierr, "PetscFPrintf");
}
 
void Logger::set_threshold(int level) {
  m_impl->threshold = level;
}
int Logger::get_threshold() const {
  return m_impl->threshold;
}
void Logger::disable() const {
  m_impl->enabled = false;
}
 
void Logger::enable() const {
  m_impl->enabled = true;
}
 
Logger::Ptr logger_from_options(MPI_Comm com) {
  Logger::Ptr result(new Logger(com, 2));
 
  options::Integer verbosity("-verbose", "set logger verbosity threshold",
                             result->get_threshold());
 
  result->set_threshold(verbosity);
 
  return result;
}
 
struct StringLogger::Impl {
  std::ostringstream data;
};
 
StringLogger::StringLogger(MPI_Comm com, int threshold)
  : Logger(com, threshold), m_impl(new Impl) {
  // empty
}
 
StringLogger::~StringLogger() {
  delete m_impl;
}
 
void StringLogger::message_impl(const char buffer[]) const {
  m_impl->data << buffer;
}
 
void StringLogger::error_impl(const char buffer[]) const {
  m_impl->data << buffer;
}
 
std::string StringLogger::get() const {
  return m_impl->data.str();
}
 
void StringLogger::reset() {
  m_impl->data.str("");
}
 
 
} // end of namespace pism