mirror of
https://github.com/Kitware/CMake.git
synced 2025-06-15 16:39:26 +08:00
bdca8b01d2
#pragma once is a widely supported compiler pragma, even though it is not part of the C++ standard. Many of the issues keeping #pragma once from being standardized (distributed filesystems, build farms, hard links, etc.) do not apply to CMake - it is easy to build CMake on a single machine. CMake also does not install any header files which can be consumed by other projects (though cmCPluginAPI.h has been deliberately omitted from this conversion in case anyone is still using it.) Finally, #pragma once has been required to build CMake since at least August 2017 (7f29bbe6 enabled server mode unconditionally, which had been using #pragma once since September 2016 (b13d3e0d)). The fact that we now require C++11 filters out old compilers, and it is unlikely that there is a compiler which supports C++11 but does not support #pragma once.
88 lines
2.5 KiB
C++
88 lines
2.5 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <cstring>
|
|
#include <iosfwd>
|
|
#include <string>
|
|
|
|
#include "cmProcessOutput.h"
|
|
|
|
/** \class cmProcessTools
|
|
* \brief Helper classes for process output parsing
|
|
*
|
|
*/
|
|
class cmProcessTools
|
|
{
|
|
public:
|
|
using Encoding = cmProcessOutput::Encoding;
|
|
/** Abstract interface for process output parsers. */
|
|
class OutputParser
|
|
{
|
|
public:
|
|
/** Process the given output data from a tool. Processing may be
|
|
done incrementally. Returns true if the parser is interested
|
|
in any more data and false if it is done. */
|
|
bool Process(const char* data, int length)
|
|
{
|
|
return this->ProcessChunk(data, length);
|
|
}
|
|
bool Process(const char* data)
|
|
{
|
|
return this->Process(data, static_cast<int>(strlen(data)));
|
|
}
|
|
|
|
virtual ~OutputParser() = default;
|
|
|
|
protected:
|
|
/** Implement in a subclass to process a chunk of data. It should
|
|
return true only if it is interested in more data. */
|
|
virtual bool ProcessChunk(const char* data, int length) = 0;
|
|
};
|
|
|
|
/** Process output parser that extracts one line at a time. */
|
|
class LineParser : public OutputParser
|
|
{
|
|
public:
|
|
/** Construct with line separation character and choose whether to
|
|
ignore carriage returns. */
|
|
LineParser(char sep = '\n', bool ignoreCR = true);
|
|
|
|
/** Configure logging of lines as they are extracted. */
|
|
void SetLog(std::ostream* log, const char* prefix);
|
|
|
|
protected:
|
|
std::ostream* Log = nullptr;
|
|
const char* Prefix = nullptr;
|
|
std::string Line;
|
|
char Separator;
|
|
char LineEnd = '\0';
|
|
bool IgnoreCR;
|
|
bool ProcessChunk(const char* data, int length) override;
|
|
|
|
/** Implement in a subclass to process one line of input. It
|
|
should return true only if it is interested in more data. */
|
|
virtual bool ProcessLine() = 0;
|
|
};
|
|
|
|
/** Trivial line handler for simple logging. */
|
|
class OutputLogger : public LineParser
|
|
{
|
|
public:
|
|
OutputLogger(std::ostream& log, const char* prefix = nullptr)
|
|
{
|
|
this->SetLog(&log, prefix);
|
|
}
|
|
|
|
private:
|
|
bool ProcessLine() override { return true; }
|
|
};
|
|
|
|
/** Run a process and send output to given parsers. */
|
|
static void RunProcess(struct cmsysProcess_s* cp, OutputParser* out,
|
|
OutputParser* err = nullptr,
|
|
Encoding encoding = cmProcessOutput::Auto);
|
|
};
|