Error.h

Go to the documentation of this file.

//===- llvm/TableGen/Error.h - tblgen error handling helpers ----*- 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 contains error handling helper routines to pretty-print diagnostic
// messages from tblgen.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_TABLEGEN_ERROR_H
#define LLVM_TABLEGEN_ERROR_H
 
#include "llvm/ADT/STLFunctionalExtras.h"
#include "llvm/Support/SourceMgr.h"
 
namespace llvm {
class Record;
class RecordVal;
class Init;
 
LLVM_ABI void PrintNote(const Twine &Msg);
LLVM_ABI void PrintNote(function_ref<void(raw_ostream &OS)> PrintMsg);
LLVM_ABI void PrintNote(ArrayRef<SMLoc> NoteLoc, const Twine &Msg);
 
[[noreturn]] LLVM_ABI void PrintFatalNote(const Twine &Msg);
[[noreturn]] LLVM_ABI void PrintFatalNote(ArrayRef<SMLoc> ErrorLoc,
                                          const Twine &Msg);
[[noreturn]] LLVM_ABI void PrintFatalNote(const Record *Rec, const Twine &Msg);
[[noreturn]] LLVM_ABI void PrintFatalNote(const RecordVal *RecVal,
                                          const Twine &Msg);
 
LLVM_ABI void PrintWarning(const Twine &Msg);
LLVM_ABI void PrintWarning(ArrayRef<SMLoc> WarningLoc, const Twine &Msg);
LLVM_ABI void PrintWarning(const char *Loc, const Twine &Msg);
 
LLVM_ABI void PrintError(const Twine &Msg);
LLVM_ABI void PrintError(function_ref<void(raw_ostream &OS)> PrintMsg);
LLVM_ABI void PrintError(ArrayRef<SMLoc> ErrorLoc, const Twine &Msg);
LLVM_ABI void PrintError(const char *Loc, const Twine &Msg);
LLVM_ABI void PrintError(const Record *Rec, const Twine &Msg);
LLVM_ABI void PrintError(const RecordVal *RecVal, const Twine &Msg);
 
[[noreturn]] LLVM_ABI void PrintFatalError(const Twine &Msg);
[[noreturn]] LLVM_ABI void PrintFatalError(ArrayRef<SMLoc> ErrorLoc,
                                           const Twine &Msg);
[[noreturn]] LLVM_ABI void PrintFatalError(const Record *Rec, const Twine &Msg);
[[noreturn]] LLVM_ABI void PrintFatalError(const RecordVal *RecVal,
                                           const Twine &Msg);
[[noreturn]] LLVM_ABI void
PrintFatalError(function_ref<void(raw_ostream &OS)> PrintMsg);
 
// Returns true if the assert failed.
LLVM_ABI bool CheckAssert(SMLoc Loc, const Init *Condition,
                          const Init *Message);
LLVM_ABI void dumpMessage(SMLoc Loc, const Init *Message);
 
extern LLVM_ABI SourceMgr SrcMgr;
extern LLVM_ABI unsigned ErrorsPrinted;
 
} // end namespace llvm
 
#endif