output_helpers.hpp

Go to the documentation of this file.

// Copyright (c) 2014-2023, Lawrence Livermore National Security, LLC.
// Produced at the Lawrence Livermore National Laboratory.
// Written by the LBANN Research Team (B. Van Essen, et al.) listed in
// the CONTRIBUTORS file. <lbann-dev@llnl.gov>
//
// LLNL-CODE-697807.
// All rights reserved.
//
// This file is part of LBANN: Livermore Big Artificial Neural Network
// Toolkit. For details, see http://software.llnl.gov/LBANN or
// https://github.com/LLNL/LBANN.
//
// Licensed under the Apache License, Version 2.0 (the "Licensee"); you
// may not use this file except in compliance with the License.  You may
// obtain a copy of the License at:
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the license.
#ifndef LBANN_UTILS_OUTPUT_HELPERS_HPP_INCLUDED
#define LBANN_UTILS_OUTPUT_HELPERS_HPP_INCLUDED

#include <iostream>

namespace lbann {

bool is_good_terminal(std::ostream& os) noexcept;

std::pair<unsigned short, unsigned short>
get_window_size(std::ostream& os) noexcept;

std::string truncate_to_width(std::string const& str, size_t max_len);


std::string strip_ansi_csis(std::string const& input);

std::ostream& black(std::ostream&);

std::ostream& red(std::ostream&);

std::ostream& green(std::ostream&);

std::ostream& yellow(std::ostream&);

std::ostream& blue(std::ostream&);

std::ostream& magenta(std::ostream&);

std::ostream& cyan(std::ostream&);

std::ostream& white(std::ostream&);

std::ostream& bgblack(std::ostream&);

std::ostream& bgred(std::ostream&);

std::ostream& bggreen(std::ostream&);

std::ostream& bgyellow(std::ostream&);

std::ostream& bgblue(std::ostream&);

std::ostream& bgmagenta(std::ostream&);

std::ostream& bgcyan(std::ostream&);

std::ostream& bgwhite(std::ostream&);

std::ostream& nocolor(std::ostream&);

std::ostream& clearline(std::ostream&);


} // namespace lbann

#endif // LBANN_UTILS_OUTPUT_HELPERS_HPP_INCLUDED