cppcheck/test/redirect.h

122 lines
3.7 KiB
C
Raw Normal View History

// Cppcheck - A tool for static C/C++ code analysis
2023-01-28 10:16:34 +01:00
// Copyright (C) 2007-2023 Cppcheck team.
//
// This program 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.
//
// This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
#ifndef REDIRECT_H
#define REDIRECT_H
#include <iostream>
2017-05-27 04:33:47 +02:00
#include <sstream>
#include <string>
// NOLINTNEXTLINE(readability-redundant-declaration) - TODO: fix this
extern std::ostringstream errout;
// NOLINTNEXTLINE(readability-redundant-declaration) - TODO: fix this
extern std::ostringstream output;
/**
2021-08-07 20:51:18 +02:00
* @brief Utility class for capturing cout and cerr to ostringstream buffers
* for later use. Uses RAII to stop redirection when the object goes out of
* scope.
* NOTE: This is *not* thread-safe.
2021-08-07 20:51:18 +02:00
*/
2011-10-13 20:53:06 +02:00
class RedirectOutputError {
public:
/** Set up redirection, flushing anything in the pipes. */
2014-11-20 14:20:09 +01:00
RedirectOutputError() {
// flush all old output
std::cout.flush();
std::cerr.flush();
_oldCout = std::cout.rdbuf(); // back up cout's streambuf
_oldCerr = std::cerr.rdbuf(); // back up cerr's streambuf
std::cout.rdbuf(_out.rdbuf()); // assign streambuf to cout
std::cerr.rdbuf(_err.rdbuf()); // assign streambuf to cerr
}
/** Revert cout and cerr behaviour */
2014-11-20 14:20:09 +01:00
~RedirectOutputError() {
std::cout.rdbuf(_oldCout); // restore cout's original streambuf
std::cerr.rdbuf(_oldCerr); // restore cerrs's original streambuf
errout << _err.str();
output << _out.str();
}
/** Return what would be printed to cout. See also clearOutput() */
2014-11-20 14:20:09 +01:00
std::string getOutput() const {
return _out.str();
}
/** Normally called after getOutput() to prevent same text to be returned
2021-08-07 20:51:18 +02:00
twice. */
2014-11-20 14:20:09 +01:00
void clearOutput() {
_out.str("");
}
/** Return what would be printed to cerr. See also clearErrout() */
2014-11-20 14:20:09 +01:00
std::string getErrout() const {
return _err.str();
}
/** Normally called after getErrout() to prevent same text to be returned
2021-08-07 20:51:18 +02:00
twice. */
2014-11-20 14:20:09 +01:00
void clearErrout() {
_err.str("");
}
private:
std::ostringstream _out;
std::ostringstream _err;
std::streambuf *_oldCout;
std::streambuf *_oldCerr;
};
class SuppressOutput {
public:
/** Set up suppression, flushing anything in the pipes. */
SuppressOutput() {
// flush all old output
std::cout.flush();
std::cerr.flush();
_oldCout = std::cout.rdbuf(); // back up cout's streambuf
_oldCerr = std::cerr.rdbuf(); // back up cerr's streambuf
std::cout.rdbuf(nullptr); // disable cout
std::cerr.rdbuf(nullptr); // disable cerr
}
/** Revert cout and cerr behaviour */
~SuppressOutput() {
std::cout.rdbuf(_oldCout); // restore cout's original streambuf
std::cerr.rdbuf(_oldCerr); // restore cerrs's original streambuf
}
private:
std::streambuf *_oldCout;
std::streambuf *_oldCerr;
};
#define REDIRECT RedirectOutputError redir
#define GET_REDIRECT_OUTPUT redir.getOutput()
#define CLEAR_REDIRECT_OUTPUT redir.clearOutput()
#define GET_REDIRECT_ERROUT redir.getErrout()
#define CLEAR_REDIRECT_ERROUT redir.clearErrout()
#define SUPPRESS SuppressOutput supprout
#endif