LLVM 20.0.0git
RemarkParser.h
Go to the documentation of this file.
1//===-- llvm/Remarks/Remark.h - The remark type -----------------*- C++/-*-===//
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// This file provides an interface for parsing remarks in LLVM.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_REMARKS_REMARKPARSER_H
14#define LLVM_REMARKS_REMARKPARSER_H
15
16#include "llvm/ADT/StringRef.h"
18#include "llvm/Support/Error.h"
19#include <memory>
20#include <optional>
21
22namespace llvm {
23namespace remarks {
24
25struct Remark;
26
27class EndOfFileError : public ErrorInfo<EndOfFileError> {
28public:
29 static char ID;
30
31 EndOfFileError() = default;
32
33 void log(raw_ostream &OS) const override { OS << "End of file reached."; }
34 std::error_code convertToErrorCode() const override {
36 }
37};
38
39/// Parser used to parse a raw buffer to remarks::Remark objects.
41 /// The format of the parser.
43 /// Path to prepend when opening an external remark file.
45
47
48 /// If no error occurs, this returns a valid Remark object.
49 /// If an error of type EndOfFileError occurs, it is safe to recover from it
50 /// by stopping the parsing.
51 /// If any other error occurs, it should be propagated to the user.
52 /// The pointer should never be null.
54
55 virtual ~RemarkParser() = default;
56};
57
58/// In-memory representation of the string table parsed from a buffer (e.g. the
59/// remarks section).
61 /// The buffer mapped from the section contents.
63 /// This object has high changes to be std::move'd around, so don't use a
64 /// SmallVector for once.
65 std::vector<size_t> Offsets;
66
68 /// Disable copy.
71 /// Should be movable.
74
75 size_t size() const { return Offsets.size(); }
77};
78
80 StringRef Buf);
81
83createRemarkParser(Format ParserFormat, StringRef Buf,
84 ParsedStringTable StrTab);
85
87 Format ParserFormat, StringRef Buf,
88 std::optional<ParsedStringTable> StrTab = std::nullopt,
89 std::optional<StringRef> ExternalFilePrependPath = std::nullopt);
90
91} // end namespace remarks
92} // end namespace llvm
93
94#endif // LLVM_REMARKS_REMARKPARSER_H
raw_pwrite_stream & OS
Base class for user error types.
Definition: Error.h:355
Tagged union holding either a T or a Error.
Definition: Error.h:481
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
std::error_code convertToErrorCode() const override
Convert this error to a std::error_code.
Definition: RemarkParser.h:34
void log(raw_ostream &OS) const override
Print an error message to an output stream.
Definition: RemarkParser.h:33
Format
The format used for serializing/deserializing remarks.
Definition: RemarkFormat.h:25
Expected< std::unique_ptr< RemarkParser > > createRemarkParserFromMeta(Format ParserFormat, StringRef Buf, std::optional< ParsedStringTable > StrTab=std::nullopt, std::optional< StringRef > ExternalFilePrependPath=std::nullopt)
Expected< std::unique_ptr< RemarkParser > > createRemarkParser(Format ParserFormat, StringRef Buf)
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
std::error_code inconvertibleErrorCode()
The value returned by this function can be returned from convertToErrorCode for Error values where no...
Definition: Error.cpp:98
In-memory representation of the string table parsed from a buffer (e.g.
Definition: RemarkParser.h:60
Expected< StringRef > operator[](size_t Index) const
std::vector< size_t > Offsets
This object has high changes to be std::move'd around, so don't use a SmallVector for once.
Definition: RemarkParser.h:65
ParsedStringTable & operator=(ParsedStringTable &&)=default
ParsedStringTable(const ParsedStringTable &)=delete
Disable copy.
StringRef Buffer
The buffer mapped from the section contents.
Definition: RemarkParser.h:62
ParsedStringTable & operator=(const ParsedStringTable &)=delete
ParsedStringTable(ParsedStringTable &&)=default
Should be movable.
Parser used to parse a raw buffer to remarks::Remark objects.
Definition: RemarkParser.h:40
virtual ~RemarkParser()=default
std::string ExternalFilePrependPath
Path to prepend when opening an external remark file.
Definition: RemarkParser.h:44
RemarkParser(Format ParserFormat)
Definition: RemarkParser.h:46
Format ParserFormat
The format of the parser.
Definition: RemarkParser.h:42
virtual Expected< std::unique_ptr< Remark > > next()=0
If no error occurs, this returns a valid Remark object.