RemarkFormat.h

Go to the documentation of this file.

//===-- 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_REMARKFORMAT_H
#define LLVM_REMARKS_REMARKFORMAT_H
 
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Compiler.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, Auto, YAML, Bitstream };
 
/// Parse and validate a string for the remark format.
LLVM_ABI Expected<Format> parseFormat(StringRef FormatStr);
 
/// Parse and validate a magic number to a remark format.
LLVM_ABI Expected<Format> magicToFormat(StringRef Magic);
 
/// Detect format based on selected format and magic number
LLVM_ABI Expected<Format> detectFormat(Format Selected, StringRef Magic);
 
} // end namespace remarks
} // end namespace llvm
 
#endif // LLVM_REMARKS_REMARKFORMAT_H