llvm/llvm/include/llvm/Remarks/Remark.h

//===-- llvm/Remarks/Remark.h - The remark type -----------------*- 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 an abstraction for handling remarks.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_REMARKS_REMARK_H
#define LLVM_REMARKS_REMARK_H

#include "llvm-c/Remarks.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/CBindingWrapping.h"
#include "llvm/Support/raw_ostream.h"
#include <optional>
#include <string>

namespace llvm {
namespace remarks {

/// The current version of the remark entry.
constexpr uint64_t CurrentRemarkVersion = …;

/// The debug location used to track a remark back to the source file.
struct RemarkLocation { … };

// Create wrappers for C Binding types (see CBindingWrapping.h).
DEFINE_SIMPLE_CONVERSION_FUNCTIONS(…)

/// A key-value pair with a debug location that is used to display the remarks
/// at the right place in the source.
struct Argument { … };

// Create wrappers for C Binding types (see CBindingWrapping.h).
DEFINE_SIMPLE_CONVERSION_FUNCTIONS(…)

/// The type of the remark.
enum class Type { … };

inline StringRef typeToStr(Type Ty) { … }

/// A remark type used for both emission and parsing.
struct Remark { … };

// Create wrappers for C Binding types (see CBindingWrapping.h).
DEFINE_SIMPLE_CONVERSION_FUNCTIONS(…)

/// Comparison operators for Remark objects and dependent objects.

template <typename T>
bool operator<(const std::optional<T> &LHS, const std::optional<T> &RHS) { … }

inline bool operator==(const RemarkLocation &LHS, const RemarkLocation &RHS) { … }

inline bool operator!=(const RemarkLocation &LHS, const RemarkLocation &RHS) { … }

inline bool operator<(const RemarkLocation &LHS, const RemarkLocation &RHS) { … }

inline bool operator==(const Argument &LHS, const Argument &RHS) { … }

inline bool operator!=(const Argument &LHS, const Argument &RHS) { … }

inline bool operator<(const Argument &LHS, const Argument &RHS) { … }

inline bool operator==(const Remark &LHS, const Remark &RHS) { … }

inline bool operator!=(const Remark &LHS, const Remark &RHS) { … }

inline bool operator<(const Remark &LHS, const Remark &RHS) { … }

inline raw_ostream &operator<<(raw_ostream &OS, const RemarkLocation &RLoc) { … }

inline raw_ostream &operator<<(raw_ostream &OS, const Argument &Arg) { … }

inline raw_ostream &operator<<(raw_ostream &OS, const Remark &Remark) { … }

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

#endif /* LLVM_REMARKS_REMARK_H */