blob: 7d97e366a5433dcac217e72f6cafdd0dcd7f4b1e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#ifndef cmProcessTools_h
#define cmProcessTools_h
#include "cmConfigure.h" // IWYU pragma: keep
#include "cmProcessOutput.h"
#include <cstring>
#include <iosfwd>
#include <string>
/** \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);
};
#endif
|
