aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/llvm12/include/llvm/Remarks/RemarkFormat.h
blob: 2b8eaf2a3e51086cd0e58b38ceabe8290e83d25c (plain) (blame)
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
#pragma once

#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#endif

//===-- llvm/Remarks/RemarkFormat.h - The format of remarks -----*- C++/-*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file defines utilities to deal with the format of remarks.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_REMARKS_REMARK_FORMAT_H
#define LLVM_REMARKS_REMARK_FORMAT_H

#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Error.h"

namespace llvm {
namespace remarks {

constexpr StringLiteral Magic("REMARKS");

/// The format used for serializing/deserializing remarks.
enum class Format { Unknown, YAML, YAMLStrTab, Bitstream };

/// Parse and validate a string for the remark format.
Expected<Format> parseFormat(StringRef FormatStr);

/// Parse and validate a magic number to a remark format.
Expected<Format> magicToFormat(StringRef Magic);

} // end namespace remarks
} // end namespace llvm

#endif /* LLVM_REMARKS_REMARK_FORMAT_H */

#ifdef __GNUC__
#pragma GCC diagnostic pop
#endif