1//===- RemarkUtilHelpers.cpp ----------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// Helpers for remark utilites
10//
11//===----------------------------------------------------------------------===//
12#include "RemarkUtilHelpers.h"
13
14namespace llvm {
15namespace remarks {
16/// \returns A MemoryBuffer for the input file on success, and an Error
17/// otherwise.
18Expected<std::unique_ptr<MemoryBuffer>>
19getInputMemoryBuffer(StringRef InputFileName) {
20 auto MaybeBuf = MemoryBuffer::getFileOrSTDIN(Filename: InputFileName);
21 if (auto ErrorCode = MaybeBuf.getError())
22 return createStringError(EC: ErrorCode,
23 S: Twine("Cannot open file '" + InputFileName +
24 "': " + ErrorCode.message()));
25 return std::move(*MaybeBuf);
26}
27
28/// \returns A ToolOutputFile which can be used for outputting the results of
29/// some tool mode.
30/// \p OutputFileName is the desired destination.
31/// \p Flags controls whether or not the file is opened for writing in text
32/// mode, as a binary, etc. See sys::fs::OpenFlags for more detail.
33Expected<std::unique_ptr<ToolOutputFile>>
34getOutputFileWithFlags(StringRef OutputFileName, sys::fs::OpenFlags Flags) {
35 if (OutputFileName == "")
36 OutputFileName = "-";
37 std::error_code ErrorCode;
38 auto OF = std::make_unique<ToolOutputFile>(args&: OutputFileName, args&: ErrorCode, args&: Flags);
39 if (ErrorCode)
40 return errorCodeToError(EC: ErrorCode);
41 return std::move(OF);
42}
43
44/// \returns A ToolOutputFile which can be used for writing remarks on success,
45/// and an Error otherwise.
46/// \p OutputFileName is the desired destination.
47/// \p OutputFormat
48Expected<std::unique_ptr<ToolOutputFile>>
49getOutputFileForRemarks(StringRef OutputFileName, Format OutputFormat) {
50 assert((OutputFormat == Format::YAML || OutputFormat == Format::Bitstream) &&
51 "Expected one of YAML or Bitstream!");
52 return getOutputFileWithFlags(OutputFileName, Flags: OutputFormat == Format::YAML
53 ? sys::fs::OF_TextWithCRLF
54 : sys::fs::OF_None);
55}
56
57Expected<FilterMatcher>
58FilterMatcher::createRE(const llvm::cl::opt<std::string> &Arg) {
59 return createRE(Arg: Arg.ArgStr, Value: Arg);
60}
61
62Expected<FilterMatcher>
63FilterMatcher::createRE(StringRef Filter, const cl::list<std::string> &Arg) {
64 return createRE(Arg: Arg.ArgStr, Value: Filter);
65}
66
67Expected<FilterMatcher> FilterMatcher::createRE(StringRef Arg,
68 StringRef Value) {
69 FilterMatcher FM(Value, true);
70 std::string Error;
71 if (!FM.FilterRE.isValid(Error))
72 return createStringError(EC: make_error_code(e: std::errc::invalid_argument),
73 S: "invalid argument '--" + Arg + "=" + Value +
74 "': " + Error);
75 return std::move(FM);
76}
77
78Expected<std::optional<FilterMatcher>>
79FilterMatcher::createExactOrRE(const llvm::cl::opt<std::string> &ExactArg,
80 const llvm::cl::opt<std::string> &REArg) {
81 if (!ExactArg.empty() && !REArg.empty())
82 return createStringError(EC: make_error_code(e: std::errc::invalid_argument),
83 S: "conflicting arguments: --" + ExactArg.ArgStr +
84 " and --" + REArg.ArgStr);
85
86 if (!ExactArg.empty())
87 return createExact(Filter: ExactArg);
88
89 if (!REArg.empty())
90 return createRE(Arg: REArg);
91
92 return std::nullopt;
93}
94
95} // namespace remarks
96} // namespace llvm
97