[ThinLTO] Add code comment. NFC
[llvm-complete.git] / lib / TableGen / Error.cpp
blob54b063cb4f8d2fc16df6575971678e204bce33b2
1 //===- Error.cpp - tblgen error handling helper routines --------*- 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 contains error handling helper routines to pretty-print diagnostic
10 // messages from tblgen.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/TableGen/Error.h"
15 #include "llvm/ADT/Twine.h"
16 #include "llvm/Support/Signals.h"
17 #include "llvm/Support/WithColor.h"
18 #include "llvm/Support/raw_ostream.h"
19 #include <cstdlib>
21 namespace llvm {
23 SourceMgr SrcMgr;
24 unsigned ErrorsPrinted = 0;
26 static void PrintMessage(ArrayRef<SMLoc> Loc, SourceMgr::DiagKind Kind,
27 const Twine &Msg) {
28 // Count the total number of errors printed.
29 // This is used to exit with an error code if there were any errors.
30 if (Kind == SourceMgr::DK_Error)
31 ++ErrorsPrinted;
33 SMLoc NullLoc;
34 if (Loc.empty())
35 Loc = NullLoc;
36 SrcMgr.PrintMessage(Loc.front(), Kind, Msg);
37 for (unsigned i = 1; i < Loc.size(); ++i)
38 SrcMgr.PrintMessage(Loc[i], SourceMgr::DK_Note,
39 "instantiated from multiclass");
42 void PrintNote(const Twine &Msg) { WithColor::note() << Msg << "\n"; }
44 void PrintNote(ArrayRef<SMLoc> NoteLoc, const Twine &Msg) {
45 PrintMessage(NoteLoc, SourceMgr::DK_Note, Msg);
48 void PrintWarning(ArrayRef<SMLoc> WarningLoc, const Twine &Msg) {
49 PrintMessage(WarningLoc, SourceMgr::DK_Warning, Msg);
52 void PrintWarning(const char *Loc, const Twine &Msg) {
53 SrcMgr.PrintMessage(SMLoc::getFromPointer(Loc), SourceMgr::DK_Warning, Msg);
56 void PrintWarning(const Twine &Msg) { WithColor::warning() << Msg << "\n"; }
58 void PrintError(ArrayRef<SMLoc> ErrorLoc, const Twine &Msg) {
59 PrintMessage(ErrorLoc, SourceMgr::DK_Error, Msg);
62 void PrintError(const char *Loc, const Twine &Msg) {
63 SrcMgr.PrintMessage(SMLoc::getFromPointer(Loc), SourceMgr::DK_Error, Msg);
66 void PrintError(const Twine &Msg) { WithColor::error() << Msg << "\n"; }
68 void PrintFatalError(const Twine &Msg) {
69 PrintError(Msg);
70 // The following call runs the file cleanup handlers.
71 sys::RunInterruptHandlers();
72 std::exit(1);
75 void PrintFatalError(ArrayRef<SMLoc> ErrorLoc, const Twine &Msg) {
76 PrintError(ErrorLoc, Msg);
77 // The following call runs the file cleanup handlers.
78 sys::RunInterruptHandlers();
79 std::exit(1);
82 } // end namespace llvm