LLVM 17.0.0git
RemarkFormat.h
Go to the documentation of this file.
1//===-- llvm/Remarks/RemarkFormat.h - The format of remarks -----*- 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 defines utilities to deal with the format of remarks.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_REMARKS_REMARKFORMAT_H
14#define LLVM_REMARKS_REMARKFORMAT_H
15
16#include "llvm/ADT/StringRef.h"
17#include "llvm/Support/Error.h"
18
19namespace llvm {
20namespace remarks {
21
22constexpr StringLiteral Magic("REMARKS");
23
24/// The format used for serializing/deserializing remarks.
26
27/// Parse and validate a string for the remark format.
29
30/// Parse and validate a magic number to a remark format.
32
33} // end namespace remarks
34} // end namespace llvm
35
36#endif // LLVM_REMARKS_REMARKFORMAT_H
Tagged union holding either a T or a Error.
Definition: Error.h:470
A wrapper around a string literal that serves as a proxy for constructing global tables of StringRefs...
Definition: StringRef.h:841
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
Expected< Format > magicToFormat(StringRef Magic)
Parse and validate a magic number to a remark format.
constexpr StringLiteral Magic("REMARKS")
Expected< Format > parseFormat(StringRef FormatStr)
Parse and validate a string for the remark format.
Format
The format used for serializing/deserializing remarks.
Definition: RemarkFormat.h:25
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18