LLVM: include/llvm/Remarks/RemarkFormat.h Source File (original) (raw)

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

19

20namespace llvm {

22

24

25/// The format used for serializing/deserializing remarks.

27

28/// Parse and validate a string for the remark format.

30

31/// Parse and validate a magic number to a remark format.

33

34/// Detect format based on selected format and magic number

36

37} // end namespace remarks

38} // end namespace llvm

39

40#endif // LLVM_REMARKS_REMARKFORMAT_H

Tagged union holding either a T or a Error.

A wrapper around a string literal that serves as a proxy for constructing global tables of StringRefs...

StringRef - Represent a constant reference to a string, i.e.

LLVM_ABI Expected< Format > magicToFormat(StringRef Magic)

Parse and validate a magic number to a remark format.

constexpr StringLiteral Magic("REMARKS")

LLVM_ABI 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:26

@ Auto

Definition RemarkFormat.h:26

@ Bitstream

Definition RemarkFormat.h:26

@ YAML

Definition RemarkFormat.h:26

LLVM_ABI Expected< Format > detectFormat(Format Selected, StringRef Magic)

Detect format based on selected format and magic number.

This is an optimization pass for GlobalISel generic memory operations.