1ee3c74fbSChris Lattner //===- FileCheck.cpp - Check that File's Contents match what is expected --===//
2ee3c74fbSChris Lattner //
3ee3c74fbSChris Lattner //                     The LLVM Compiler Infrastructure
4ee3c74fbSChris Lattner //
5ee3c74fbSChris Lattner // This file is distributed under the University of Illinois Open Source
6ee3c74fbSChris Lattner // License. See LICENSE.TXT for details.
7ee3c74fbSChris Lattner //
8ee3c74fbSChris Lattner //===----------------------------------------------------------------------===//
9ee3c74fbSChris Lattner //
10ee3c74fbSChris Lattner // FileCheck does a line-by line check of a file that validates whether it
11ee3c74fbSChris Lattner // contains the expected content.  This is useful for regression tests etc.
12ee3c74fbSChris Lattner //
13b5ecceffSJames Henderson // This program exits with an exit status of 2 on error, exit status of 0 if
14ee3c74fbSChris Lattner // the file matched the expected contents, and exit status of 1 if it did not
15ee3c74fbSChris Lattner // contain the expected contents.
16ee3c74fbSChris Lattner //
17ee3c74fbSChris Lattner //===----------------------------------------------------------------------===//
18ee3c74fbSChris Lattner 
19ee3c74fbSChris Lattner #include "llvm/Support/CommandLine.h"
20197194b6SRui Ueyama #include "llvm/Support/InitLLVM.h"
213e66509fSJoel E. Denny #include "llvm/Support/Process.h"
223c5d267eSJoel E. Denny #include "llvm/Support/WithColor.h"
23ee3c74fbSChris Lattner #include "llvm/Support/raw_ostream.h"
24ffa9d2e4SAditya Nandakumar #include "llvm/Support/FileCheck.h"
25ee3c74fbSChris Lattner using namespace llvm;
26ee3c74fbSChris Lattner 
27ee3c74fbSChris Lattner static cl::opt<std::string>
283c5d267eSJoel E. Denny     CheckFilename(cl::Positional, cl::desc("<check-file>"), cl::Optional);
29ee3c74fbSChris Lattner 
30ee3c74fbSChris Lattner static cl::opt<std::string>
31ee3c74fbSChris Lattner     InputFilename("input-file", cl::desc("File to check (defaults to stdin)"),
32ee3c74fbSChris Lattner                   cl::init("-"), cl::value_desc("filename"));
33ee3c74fbSChris Lattner 
34e8f2fb20SChandler Carruth static cl::list<std::string> CheckPrefixes(
35e8f2fb20SChandler Carruth     "check-prefix",
36ee3c74fbSChris Lattner     cl::desc("Prefix to use from check file (defaults to 'CHECK')"));
37fd557cb0SDaniel Sanders static cl::alias CheckPrefixesAlias(
38fd557cb0SDaniel Sanders     "check-prefixes", cl::aliasopt(CheckPrefixes), cl::CommaSeparated,
39fd557cb0SDaniel Sanders     cl::NotHidden,
40fd557cb0SDaniel Sanders     cl::desc(
41fd557cb0SDaniel Sanders         "Alias for -check-prefix permitting multiple comma separated values"));
42ee3c74fbSChris Lattner 
43e8f2fb20SChandler Carruth static cl::opt<bool> NoCanonicalizeWhiteSpace(
44e8f2fb20SChandler Carruth     "strict-whitespace",
452c3e5cdfSChris Lattner     cl::desc("Do not treat all horizontal whitespace as equivalent"));
462c3e5cdfSChris Lattner 
4756ccdbbdSAlexander Kornienko static cl::list<std::string> ImplicitCheckNot(
4856ccdbbdSAlexander Kornienko     "implicit-check-not",
4956ccdbbdSAlexander Kornienko     cl::desc("Add an implicit negative check with this pattern to every\n"
5056ccdbbdSAlexander Kornienko              "positive check. This can be used to ensure that no instances of\n"
5156ccdbbdSAlexander Kornienko              "this pattern occur which are not matched by a positive pattern"),
5256ccdbbdSAlexander Kornienko     cl::value_desc("pattern"));
5356ccdbbdSAlexander Kornienko 
5446e1fd61SAlexander Richardson static cl::list<std::string> GlobalDefines("D", cl::Prefix,
5546e1fd61SAlexander Richardson     cl::desc("Define a variable to be used in capture patterns."),
5646e1fd61SAlexander Richardson     cl::value_desc("VAR=VALUE"));
5746e1fd61SAlexander Richardson 
581b9f936fSJustin Bogner static cl::opt<bool> AllowEmptyInput(
591b9f936fSJustin Bogner     "allow-empty", cl::init(false),
601b9f936fSJustin Bogner     cl::desc("Allow the input file to be empty. This is useful when making\n"
611b9f936fSJustin Bogner              "checks that some error message does not occur, for example."));
621b9f936fSJustin Bogner 
6385913ccaSJames Y Knight static cl::opt<bool> MatchFullLines(
6485913ccaSJames Y Knight     "match-full-lines", cl::init(false),
6585913ccaSJames Y Knight     cl::desc("Require all positive matches to cover an entire input line.\n"
6685913ccaSJames Y Knight              "Allows leading and trailing whitespace if --strict-whitespace\n"
6785913ccaSJames Y Knight              "is not also passed."));
6885913ccaSJames Y Knight 
69f55e72a5SArtem Belevich static cl::opt<bool> EnableVarScope(
70f55e72a5SArtem Belevich     "enable-var-scope", cl::init(false),
71f55e72a5SArtem Belevich     cl::desc("Enables scope for regex variables. Variables with names that\n"
72f55e72a5SArtem Belevich              "do not start with '$' will be reset at the beginning of\n"
73f55e72a5SArtem Belevich              "each CHECK-LABEL block."));
74f55e72a5SArtem Belevich 
75bcf5b441SJoel E. Denny static cl::opt<bool> AllowDeprecatedDagOverlap(
76bcf5b441SJoel E. Denny     "allow-deprecated-dag-overlap", cl::init(false),
77bcf5b441SJoel E. Denny     cl::desc("Enable overlapping among matches in a group of consecutive\n"
78bcf5b441SJoel E. Denny              "CHECK-DAG directives.  This option is deprecated and is only\n"
79bcf5b441SJoel E. Denny              "provided for convenience as old tests are migrated to the new\n"
80bcf5b441SJoel E. Denny              "non-overlapping CHECK-DAG implementation.\n"));
81bcf5b441SJoel E. Denny 
82dc5ba317SJoel E. Denny static cl::opt<bool> Verbose("v", cl::init(false),
83dc5ba317SJoel E. Denny                              cl::desc("Print directive pattern matches.\n"));
84dc5ba317SJoel E. Denny 
85dc5ba317SJoel E. Denny static cl::opt<bool> VerboseVerbose(
86dc5ba317SJoel E. Denny     "vv", cl::init(false),
87dc5ba317SJoel E. Denny     cl::desc("Print information helpful in diagnosing internal FileCheck\n"
88dc5ba317SJoel E. Denny              "issues.  Implies -v.\n"));
89346dfbe2SGeorge Karpenkov static const char * DumpInputEnv = "FILECHECK_DUMP_INPUT_ON_FAILURE";
90346dfbe2SGeorge Karpenkov 
91346dfbe2SGeorge Karpenkov static cl::opt<bool> DumpInputOnFailure(
92346dfbe2SGeorge Karpenkov     "dump-input-on-failure", cl::init(std::getenv(DumpInputEnv)),
93346dfbe2SGeorge Karpenkov     cl::desc("Dump original input to stderr before failing.\n"
94346dfbe2SGeorge Karpenkov              "The value can be also controlled using\n"
953c5d267eSJoel E. Denny              "FILECHECK_DUMP_INPUT_ON_FAILURE environment variable.\n"
963c5d267eSJoel E. Denny              "This option is deprecated in favor of -dump-input=fail.\n"));
973c5d267eSJoel E. Denny 
983c5d267eSJoel E. Denny enum DumpInputValue {
993c5d267eSJoel E. Denny   DumpInputDefault,
1003c5d267eSJoel E. Denny   DumpInputHelp,
1013c5d267eSJoel E. Denny   DumpInputNever,
1023c5d267eSJoel E. Denny   DumpInputFail,
1033c5d267eSJoel E. Denny   DumpInputAlways
1043c5d267eSJoel E. Denny };
1053c5d267eSJoel E. Denny 
1063c5d267eSJoel E. Denny static cl::opt<DumpInputValue> DumpInput(
1073c5d267eSJoel E. Denny     "dump-input", cl::init(DumpInputDefault),
1083c5d267eSJoel E. Denny     cl::desc("Dump input to stderr, adding annotations representing\n"
1093c5d267eSJoel E. Denny              " currently enabled diagnostics\n"),
1103c5d267eSJoel E. Denny     cl::value_desc("mode"),
1113c5d267eSJoel E. Denny     cl::values(clEnumValN(DumpInputHelp, "help",
1123c5d267eSJoel E. Denny                           "Explain dump format and quit"),
1133c5d267eSJoel E. Denny                clEnumValN(DumpInputNever, "never", "Never dump input"),
1143c5d267eSJoel E. Denny                clEnumValN(DumpInputFail, "fail", "Dump input on failure"),
1153c5d267eSJoel E. Denny                clEnumValN(DumpInputAlways, "always", "Always dump input")));
116dc5ba317SJoel E. Denny 
11713df4626SMatt Arsenault typedef cl::list<std::string>::const_iterator prefix_iterator;
11813df4626SMatt Arsenault 
11913df4626SMatt Arsenault 
12013df4626SMatt Arsenault 
121726774cbSChandler Carruth 
122726774cbSChandler Carruth 
123726774cbSChandler Carruth 
124c2735158SRui Ueyama 
1252bd4f8b6SXinliang David Li static void DumpCommandLine(int argc, char **argv) {
1262bd4f8b6SXinliang David Li   errs() << "FileCheck command line: ";
1272bd4f8b6SXinliang David Li   for (int I = 0; I < argc; I++)
1282bd4f8b6SXinliang David Li     errs() << " " << argv[I];
1292bd4f8b6SXinliang David Li   errs() << "\n";
1302bd4f8b6SXinliang David Li }
1312bd4f8b6SXinliang David Li 
1323c5d267eSJoel E. Denny struct MarkerStyle {
1333c5d267eSJoel E. Denny   /// The starting char (before tildes) for marking the line.
1343c5d267eSJoel E. Denny   char Lead;
1353c5d267eSJoel E. Denny   /// What color to use for this annotation.
1363c5d267eSJoel E. Denny   raw_ostream::Colors Color;
1373c5d267eSJoel E. Denny   /// A note to follow the marker, or empty string if none.
1383c5d267eSJoel E. Denny   std::string Note;
1393c5d267eSJoel E. Denny   MarkerStyle() {}
1407df86967SJoel E. Denny   MarkerStyle(char Lead, raw_ostream::Colors Color,
1417df86967SJoel E. Denny               const std::string &Note = "")
1423c5d267eSJoel E. Denny       : Lead(Lead), Color(Color), Note(Note) {}
1433c5d267eSJoel E. Denny };
1443c5d267eSJoel E. Denny 
1453c5d267eSJoel E. Denny static MarkerStyle GetMarker(FileCheckDiag::MatchType MatchTy) {
1463c5d267eSJoel E. Denny   switch (MatchTy) {
147*e2afb614SJoel E. Denny   case FileCheckDiag::MatchFoundAndExpected:
1487df86967SJoel E. Denny     return MarkerStyle('^', raw_ostream::GREEN);
149*e2afb614SJoel E. Denny   case FileCheckDiag::MatchFoundButExcluded:
1500e7e3fa0SJoel E. Denny     return MarkerStyle('!', raw_ostream::RED, "error: no match expected");
151*e2afb614SJoel E. Denny   case FileCheckDiag::MatchFoundButWrongLine:
152cadfcef4SJoel E. Denny     return MarkerStyle('!', raw_ostream::RED, "error: match on wrong line");
153*e2afb614SJoel E. Denny   case FileCheckDiag::MatchFoundButDiscarded:
154f7c1c4d8SJoel E. Denny     return MarkerStyle('!', raw_ostream::CYAN,
155f7c1c4d8SJoel E. Denny                        "discard: overlaps earlier match");
15696f0e84cSJoel E. Denny   case FileCheckDiag::MatchNoneAndExcluded:
15796f0e84cSJoel E. Denny     return MarkerStyle('X', raw_ostream::GREEN);
1583c5d267eSJoel E. Denny   case FileCheckDiag::MatchNoneButExpected:
1593c5d267eSJoel E. Denny     return MarkerStyle('X', raw_ostream::RED, "error: no match found");
1602c007c80SJoel E. Denny   case FileCheckDiag::MatchFuzzy:
1612c007c80SJoel E. Denny     return MarkerStyle('?', raw_ostream::MAGENTA, "possible intended match");
1623c5d267eSJoel E. Denny   }
1633c5d267eSJoel E. Denny   llvm_unreachable_internal("unexpected match type");
1643c5d267eSJoel E. Denny }
1653c5d267eSJoel E. Denny 
1663c5d267eSJoel E. Denny static void DumpInputAnnotationHelp(raw_ostream &OS) {
1673c5d267eSJoel E. Denny   OS << "The following description was requested by -dump-input=help to\n"
1683c5d267eSJoel E. Denny      << "explain the input annotations printed by -dump-input=always and\n"
1693c5d267eSJoel E. Denny      << "-dump-input=fail:\n\n";
1703c5d267eSJoel E. Denny 
1713c5d267eSJoel E. Denny   // Labels for input lines.
1723c5d267eSJoel E. Denny   OS << "  - ";
1733c5d267eSJoel E. Denny   WithColor(OS, raw_ostream::SAVEDCOLOR, true) << "L:";
1743c5d267eSJoel E. Denny   OS << "     labels line number L of the input file\n";
1753c5d267eSJoel E. Denny 
1763c5d267eSJoel E. Denny   // Labels for annotation lines.
1773c5d267eSJoel E. Denny   OS << "  - ";
1783c5d267eSJoel E. Denny   WithColor(OS, raw_ostream::SAVEDCOLOR, true) << "T:L";
1792c007c80SJoel E. Denny   OS << "    labels the only match result for a pattern of type T from "
1803c5d267eSJoel E. Denny      << "line L of\n"
1813c5d267eSJoel E. Denny      << "           the check file\n";
1822c007c80SJoel E. Denny   OS << "  - ";
1832c007c80SJoel E. Denny   WithColor(OS, raw_ostream::SAVEDCOLOR, true) << "T:L'N";
1842c007c80SJoel E. Denny   OS << "  labels the Nth match result for a pattern of type T from line "
1852c007c80SJoel E. Denny      << "L of\n"
1862c007c80SJoel E. Denny      << "           the check file\n";
1873c5d267eSJoel E. Denny 
1883c5d267eSJoel E. Denny   // Markers on annotation lines.
1893c5d267eSJoel E. Denny   OS << "  - ";
1907df86967SJoel E. Denny   WithColor(OS, raw_ostream::SAVEDCOLOR, true) << "^~~";
1917df86967SJoel E. Denny   OS << "    marks good match (reported if -v)\n"
1927df86967SJoel E. Denny      << "  - ";
193cadfcef4SJoel E. Denny   WithColor(OS, raw_ostream::SAVEDCOLOR, true) << "!~~";
194cadfcef4SJoel E. Denny   OS << "    marks bad match, such as:\n"
195cadfcef4SJoel E. Denny      << "           - CHECK-NEXT on same line as previous match (error)\n"
1960e7e3fa0SJoel E. Denny      << "           - CHECK-NOT found (error)\n"
197f7c1c4d8SJoel E. Denny      << "           - CHECK-DAG overlapping match (discarded, reported if "
198f7c1c4d8SJoel E. Denny      << "-vv)\n"
199cadfcef4SJoel E. Denny      << "  - ";
2003c5d267eSJoel E. Denny   WithColor(OS, raw_ostream::SAVEDCOLOR, true) << "X~~";
201cadfcef4SJoel E. Denny   OS << "    marks search range when no match is found, such as:\n"
202cadfcef4SJoel E. Denny      << "           - CHECK-NEXT not found (error)\n"
20396f0e84cSJoel E. Denny      << "           - CHECK-NOT not found (success, reported if -vv)\n"
204f7c1c4d8SJoel E. Denny      << "           - CHECK-DAG not found after discarded matches (error)\n"
2052c007c80SJoel E. Denny      << "  - ";
2062c007c80SJoel E. Denny   WithColor(OS, raw_ostream::SAVEDCOLOR, true) << "?";
2072c007c80SJoel E. Denny   OS << "      marks fuzzy match when no match is found\n";
2083c5d267eSJoel E. Denny 
2093c5d267eSJoel E. Denny   // Colors.
2103c5d267eSJoel E. Denny   OS << "  - colors ";
2117df86967SJoel E. Denny   WithColor(OS, raw_ostream::GREEN, true) << "success";
2127df86967SJoel E. Denny   OS << ", ";
2133c5d267eSJoel E. Denny   WithColor(OS, raw_ostream::RED, true) << "error";
2142c007c80SJoel E. Denny   OS << ", ";
2152c007c80SJoel E. Denny   WithColor(OS, raw_ostream::MAGENTA, true) << "fuzzy match";
2167df86967SJoel E. Denny   OS << ", ";
217f7c1c4d8SJoel E. Denny   WithColor(OS, raw_ostream::CYAN, true, false) << "discarded match";
218f7c1c4d8SJoel E. Denny   OS << ", ";
2197df86967SJoel E. Denny   WithColor(OS, raw_ostream::CYAN, true, true) << "unmatched input";
2203c5d267eSJoel E. Denny   OS << "\n\n"
2213c5d267eSJoel E. Denny      << "If you are not seeing color above or in input dumps, try: -color\n";
2223c5d267eSJoel E. Denny }
2233c5d267eSJoel E. Denny 
2243c5d267eSJoel E. Denny /// An annotation for a single input line.
2253c5d267eSJoel E. Denny struct InputAnnotation {
2263c5d267eSJoel E. Denny   /// The check file line (one-origin indexing) where the directive that
2273c5d267eSJoel E. Denny   /// produced this annotation is located.
2283c5d267eSJoel E. Denny   unsigned CheckLine;
2292c007c80SJoel E. Denny   /// The index of the match result for this check.
2302c007c80SJoel E. Denny   unsigned CheckDiagIndex;
2313c5d267eSJoel E. Denny   /// The label for this annotation.
2323c5d267eSJoel E. Denny   std::string Label;
2333c5d267eSJoel E. Denny   /// What input line (one-origin indexing) this annotation marks.  This might
2343c5d267eSJoel E. Denny   /// be different from the starting line of the original diagnostic if this is
2353c5d267eSJoel E. Denny   /// a non-initial fragment of a diagnostic that has been broken across
2363c5d267eSJoel E. Denny   /// multiple lines.
2373c5d267eSJoel E. Denny   unsigned InputLine;
2383c5d267eSJoel E. Denny   /// The column range (one-origin indexing, open end) in which to to mark the
2393c5d267eSJoel E. Denny   /// input line.  If InputEndCol is UINT_MAX, treat it as the last column
2403c5d267eSJoel E. Denny   /// before the newline.
2413c5d267eSJoel E. Denny   unsigned InputStartCol, InputEndCol;
2423c5d267eSJoel E. Denny   /// The marker to use.
2433c5d267eSJoel E. Denny   MarkerStyle Marker;
244*e2afb614SJoel E. Denny   /// Whether this annotation represents a good match for an expected pattern.
245*e2afb614SJoel E. Denny   bool FoundAndExpectedMatch;
2463c5d267eSJoel E. Denny };
2473c5d267eSJoel E. Denny 
2483c5d267eSJoel E. Denny /// Get an abbreviation for the check type.
2493c5d267eSJoel E. Denny std::string GetCheckTypeAbbreviation(Check::FileCheckType Ty) {
2503c5d267eSJoel E. Denny   switch (Ty) {
2513c5d267eSJoel E. Denny   case Check::CheckPlain:
2523c5d267eSJoel E. Denny     if (Ty.getCount() > 1)
2533c5d267eSJoel E. Denny       return "count";
2543c5d267eSJoel E. Denny     return "check";
2553c5d267eSJoel E. Denny   case Check::CheckNext:
2563c5d267eSJoel E. Denny     return "next";
2573c5d267eSJoel E. Denny   case Check::CheckSame:
2583c5d267eSJoel E. Denny     return "same";
2593c5d267eSJoel E. Denny   case Check::CheckNot:
2603c5d267eSJoel E. Denny     return "not";
2613c5d267eSJoel E. Denny   case Check::CheckDAG:
2623c5d267eSJoel E. Denny     return "dag";
2633c5d267eSJoel E. Denny   case Check::CheckLabel:
2643c5d267eSJoel E. Denny     return "label";
2653c5d267eSJoel E. Denny   case Check::CheckEmpty:
2663c5d267eSJoel E. Denny     return "empty";
2673c5d267eSJoel E. Denny   case Check::CheckEOF:
2683c5d267eSJoel E. Denny     return "eof";
2693c5d267eSJoel E. Denny   case Check::CheckBadNot:
2703c5d267eSJoel E. Denny     return "bad-not";
2713c5d267eSJoel E. Denny   case Check::CheckBadCount:
2723c5d267eSJoel E. Denny     return "bad-count";
2733c5d267eSJoel E. Denny   case Check::CheckNone:
2743c5d267eSJoel E. Denny     llvm_unreachable("invalid FileCheckType");
2753c5d267eSJoel E. Denny   }
2763c5d267eSJoel E. Denny   llvm_unreachable("unknown FileCheckType");
2773c5d267eSJoel E. Denny }
2783c5d267eSJoel E. Denny 
2793c5d267eSJoel E. Denny static void BuildInputAnnotations(const std::vector<FileCheckDiag> &Diags,
2803c5d267eSJoel E. Denny                                   std::vector<InputAnnotation> &Annotations,
2813c5d267eSJoel E. Denny                                   unsigned &LabelWidth) {
2822c007c80SJoel E. Denny   // How many diagnostics has the current check seen so far?
2832c007c80SJoel E. Denny   unsigned CheckDiagCount = 0;
2843c5d267eSJoel E. Denny   // What's the widest label?
2853c5d267eSJoel E. Denny   LabelWidth = 0;
2863c5d267eSJoel E. Denny   for (auto DiagItr = Diags.begin(), DiagEnd = Diags.end(); DiagItr != DiagEnd;
2873c5d267eSJoel E. Denny        ++DiagItr) {
2883c5d267eSJoel E. Denny     InputAnnotation A;
2893c5d267eSJoel E. Denny 
2903c5d267eSJoel E. Denny     // Build label, which uniquely identifies this check result.
2913c5d267eSJoel E. Denny     A.CheckLine = DiagItr->CheckLine;
2923c5d267eSJoel E. Denny     llvm::raw_string_ostream Label(A.Label);
2933c5d267eSJoel E. Denny     Label << GetCheckTypeAbbreviation(DiagItr->CheckTy) << ":"
2943c5d267eSJoel E. Denny           << DiagItr->CheckLine;
2952c007c80SJoel E. Denny     A.CheckDiagIndex = UINT_MAX;
2962c007c80SJoel E. Denny     auto DiagNext = std::next(DiagItr);
2972c007c80SJoel E. Denny     if (DiagNext != DiagEnd && DiagItr->CheckTy == DiagNext->CheckTy &&
2982c007c80SJoel E. Denny         DiagItr->CheckLine == DiagNext->CheckLine)
2992c007c80SJoel E. Denny       A.CheckDiagIndex = CheckDiagCount++;
3002c007c80SJoel E. Denny     else if (CheckDiagCount) {
3012c007c80SJoel E. Denny       A.CheckDiagIndex = CheckDiagCount;
3022c007c80SJoel E. Denny       CheckDiagCount = 0;
3032c007c80SJoel E. Denny     }
3042c007c80SJoel E. Denny     if (A.CheckDiagIndex != UINT_MAX)
3052c007c80SJoel E. Denny       Label << "'" << A.CheckDiagIndex;
3062c007c80SJoel E. Denny     else
3072c007c80SJoel E. Denny       A.CheckDiagIndex = 0;
3083c5d267eSJoel E. Denny     Label.flush();
3093c5d267eSJoel E. Denny     LabelWidth = std::max((std::string::size_type)LabelWidth, A.Label.size());
3103c5d267eSJoel E. Denny 
3113c5d267eSJoel E. Denny     MarkerStyle Marker = GetMarker(DiagItr->MatchTy);
3123c5d267eSJoel E. Denny     A.Marker = Marker;
313*e2afb614SJoel E. Denny     A.FoundAndExpectedMatch =
314*e2afb614SJoel E. Denny         DiagItr->MatchTy == FileCheckDiag::MatchFoundAndExpected;
3153c5d267eSJoel E. Denny 
3163c5d267eSJoel E. Denny     // Compute the mark location, and break annotation into multiple
3173c5d267eSJoel E. Denny     // annotations if it spans multiple lines.
3183c5d267eSJoel E. Denny     A.InputLine = DiagItr->InputStartLine;
3193c5d267eSJoel E. Denny     A.InputStartCol = DiagItr->InputStartCol;
3203c5d267eSJoel E. Denny     if (DiagItr->InputStartLine == DiagItr->InputEndLine) {
3213c5d267eSJoel E. Denny       // Sometimes ranges are empty in order to indicate a specific point, but
3223c5d267eSJoel E. Denny       // that would mean nothing would be marked, so adjust the range to
3233c5d267eSJoel E. Denny       // include the following character.
3243c5d267eSJoel E. Denny       A.InputEndCol =
3253c5d267eSJoel E. Denny           std::max(DiagItr->InputStartCol + 1, DiagItr->InputEndCol);
3263c5d267eSJoel E. Denny       Annotations.push_back(A);
3273c5d267eSJoel E. Denny     } else {
3283c5d267eSJoel E. Denny       assert(DiagItr->InputStartLine < DiagItr->InputEndLine &&
3293c5d267eSJoel E. Denny              "expected input range not to be inverted");
3303c5d267eSJoel E. Denny       A.InputEndCol = UINT_MAX;
3313c5d267eSJoel E. Denny       A.Marker.Note = "";
3323c5d267eSJoel E. Denny       Annotations.push_back(A);
3333c5d267eSJoel E. Denny       for (unsigned L = DiagItr->InputStartLine + 1, E = DiagItr->InputEndLine;
3343c5d267eSJoel E. Denny            L <= E; ++L) {
3353c5d267eSJoel E. Denny         // If a range ends before the first column on a line, then it has no
3363c5d267eSJoel E. Denny         // characters on that line, so there's nothing to render.
3373c5d267eSJoel E. Denny         if (DiagItr->InputEndCol == 1 && L == E) {
3383c5d267eSJoel E. Denny           Annotations.back().Marker.Note = Marker.Note;
3393c5d267eSJoel E. Denny           break;
3403c5d267eSJoel E. Denny         }
3413c5d267eSJoel E. Denny         InputAnnotation B;
3423c5d267eSJoel E. Denny         B.CheckLine = A.CheckLine;
3432c007c80SJoel E. Denny         B.CheckDiagIndex = A.CheckDiagIndex;
3443c5d267eSJoel E. Denny         B.Label = A.Label;
3453c5d267eSJoel E. Denny         B.InputLine = L;
3463c5d267eSJoel E. Denny         B.Marker = Marker;
3473c5d267eSJoel E. Denny         B.Marker.Lead = '~';
3483c5d267eSJoel E. Denny         B.InputStartCol = 1;
3493c5d267eSJoel E. Denny         if (L != E) {
3503c5d267eSJoel E. Denny           B.InputEndCol = UINT_MAX;
3513c5d267eSJoel E. Denny           B.Marker.Note = "";
3523c5d267eSJoel E. Denny         } else
3533c5d267eSJoel E. Denny           B.InputEndCol = DiagItr->InputEndCol;
354*e2afb614SJoel E. Denny         B.FoundAndExpectedMatch = A.FoundAndExpectedMatch;
3553c5d267eSJoel E. Denny         Annotations.push_back(B);
3563c5d267eSJoel E. Denny       }
3573c5d267eSJoel E. Denny     }
3583c5d267eSJoel E. Denny   }
3593c5d267eSJoel E. Denny }
3603c5d267eSJoel E. Denny 
3617df86967SJoel E. Denny static void DumpAnnotatedInput(raw_ostream &OS, const FileCheckRequest &Req,
3627df86967SJoel E. Denny                                StringRef InputFileText,
3637df86967SJoel E. Denny                                std::vector<InputAnnotation> &Annotations,
3647df86967SJoel E. Denny                                unsigned LabelWidth) {
3653c5d267eSJoel E. Denny   OS << "Full input was:\n<<<<<<\n";
3663c5d267eSJoel E. Denny 
3673c5d267eSJoel E. Denny   // Sort annotations.
3683c5d267eSJoel E. Denny   //
3693c5d267eSJoel E. Denny   // First, sort in the order of input lines to make it easier to find relevant
3703c5d267eSJoel E. Denny   // annotations while iterating input lines in the implementation below.
3713c5d267eSJoel E. Denny   // FileCheck diagnostics are not always reported and recorded in the order of
3723c5d267eSJoel E. Denny   // input lines due to, for example, CHECK-DAG and CHECK-NOT.
3733c5d267eSJoel E. Denny   //
3743c5d267eSJoel E. Denny   // Second, for annotations for the same input line, sort in the order of the
3753c5d267eSJoel E. Denny   // FileCheck directive's line in the check file (where there's at most one
3762c007c80SJoel E. Denny   // directive per line) and then by the index of the match result for that
3772c007c80SJoel E. Denny   // directive.  The rationale of this choice is that, for any input line, this
3782c007c80SJoel E. Denny   // sort establishes a total order of annotations that, with respect to match
3792c007c80SJoel E. Denny   // results, is consistent across multiple lines, thus making match results
3802c007c80SJoel E. Denny   // easier to track from one line to the next when they span multiple lines.
3813c5d267eSJoel E. Denny   std::sort(Annotations.begin(), Annotations.end(),
3823c5d267eSJoel E. Denny             [](const InputAnnotation &A, const InputAnnotation &B) {
3833c5d267eSJoel E. Denny               if (A.InputLine != B.InputLine)
3843c5d267eSJoel E. Denny                 return A.InputLine < B.InputLine;
3852c007c80SJoel E. Denny               if (A.CheckLine != B.CheckLine)
3863c5d267eSJoel E. Denny                 return A.CheckLine < B.CheckLine;
3877df86967SJoel E. Denny               // FIXME: Sometimes CHECK-LABEL reports its match twice with
3887df86967SJoel E. Denny               // other diagnostics in between, and then diag index incrementing
3897df86967SJoel E. Denny               // fails to work properly, and then this assert fails.  We should
3907df86967SJoel E. Denny               // suppress one of those diagnostics or do a better job of
3917df86967SJoel E. Denny               // computing this index.  For now, we just produce a redundant
3927df86967SJoel E. Denny               // CHECK-LABEL annotation.
3937df86967SJoel E. Denny               // assert(A.CheckDiagIndex != B.CheckDiagIndex &&
3947df86967SJoel E. Denny               //        "expected diagnostic indices to be unique within a "
3957df86967SJoel E. Denny               //        " check line");
3962c007c80SJoel E. Denny               return A.CheckDiagIndex < B.CheckDiagIndex;
3973c5d267eSJoel E. Denny             });
3983c5d267eSJoel E. Denny 
3993c5d267eSJoel E. Denny   // Compute the width of the label column.
4003c5d267eSJoel E. Denny   const unsigned char *InputFilePtr = InputFileText.bytes_begin(),
4013c5d267eSJoel E. Denny                       *InputFileEnd = InputFileText.bytes_end();
4023c5d267eSJoel E. Denny   unsigned LineCount = InputFileText.count('\n');
4033c5d267eSJoel E. Denny   if (InputFileEnd[-1] != '\n')
4043c5d267eSJoel E. Denny     ++LineCount;
4053c5d267eSJoel E. Denny   unsigned LineNoWidth = log10(LineCount) + 1;
4063c5d267eSJoel E. Denny   // +3 below adds spaces (1) to the left of the (right-aligned) line numbers
4073c5d267eSJoel E. Denny   // on input lines and (2) to the right of the (left-aligned) labels on
4083c5d267eSJoel E. Denny   // annotation lines so that input lines and annotation lines are more
4093c5d267eSJoel E. Denny   // visually distinct.  For example, the spaces on the annotation lines ensure
4103c5d267eSJoel E. Denny   // that input line numbers and check directive line numbers never align
4113c5d267eSJoel E. Denny   // horizontally.  Those line numbers might not even be for the same file.
4123c5d267eSJoel E. Denny   // One space would be enough to achieve that, but more makes it even easier
4133c5d267eSJoel E. Denny   // to see.
4143c5d267eSJoel E. Denny   LabelWidth = std::max(LabelWidth, LineNoWidth) + 3;
4153c5d267eSJoel E. Denny 
4163c5d267eSJoel E. Denny   // Print annotated input lines.
4173c5d267eSJoel E. Denny   auto AnnotationItr = Annotations.begin(), AnnotationEnd = Annotations.end();
4183c5d267eSJoel E. Denny   for (unsigned Line = 1;
4193c5d267eSJoel E. Denny        InputFilePtr != InputFileEnd || AnnotationItr != AnnotationEnd;
4203c5d267eSJoel E. Denny        ++Line) {
4213c5d267eSJoel E. Denny     const unsigned char *InputFileLine = InputFilePtr;
4223c5d267eSJoel E. Denny 
4233c5d267eSJoel E. Denny     // Print right-aligned line number.
4243c5d267eSJoel E. Denny     WithColor(OS, raw_ostream::BLACK, true)
4253c5d267eSJoel E. Denny         << format_decimal(Line, LabelWidth) << ": ";
4263c5d267eSJoel E. Denny 
427*e2afb614SJoel E. Denny     // For the case where -v and colors are enabled, find the annotations for
428*e2afb614SJoel E. Denny     // good matches for expected patterns in order to highlight everything
429*e2afb614SJoel E. Denny     // else in the line.  There are no such annotations if -v is disabled.
430*e2afb614SJoel E. Denny     std::vector<InputAnnotation> FoundAndExpectedMatches;
4317df86967SJoel E. Denny     if (Req.Verbose && WithColor(OS).colorsEnabled()) {
4327df86967SJoel E. Denny       for (auto I = AnnotationItr; I != AnnotationEnd && I->InputLine == Line;
4337df86967SJoel E. Denny            ++I) {
434*e2afb614SJoel E. Denny         if (I->FoundAndExpectedMatch)
435*e2afb614SJoel E. Denny           FoundAndExpectedMatches.push_back(*I);
4367df86967SJoel E. Denny       }
4377df86967SJoel E. Denny     }
4387df86967SJoel E. Denny 
4397df86967SJoel E. Denny     // Print numbered line with highlighting where there are no matches for
4407df86967SJoel E. Denny     // expected patterns.
4413c5d267eSJoel E. Denny     bool Newline = false;
4427df86967SJoel E. Denny     {
4437df86967SJoel E. Denny       WithColor COS(OS);
4447df86967SJoel E. Denny       bool InMatch = false;
4457df86967SJoel E. Denny       if (Req.Verbose)
4467df86967SJoel E. Denny         COS.changeColor(raw_ostream::CYAN, true, true);
4477df86967SJoel E. Denny       for (unsigned Col = 1; InputFilePtr != InputFileEnd && !Newline; ++Col) {
4487df86967SJoel E. Denny         bool WasInMatch = InMatch;
4497df86967SJoel E. Denny         InMatch = false;
450*e2afb614SJoel E. Denny         for (auto M : FoundAndExpectedMatches) {
4517df86967SJoel E. Denny           if (M.InputStartCol <= Col && Col < M.InputEndCol) {
4527df86967SJoel E. Denny             InMatch = true;
4537df86967SJoel E. Denny             break;
4547df86967SJoel E. Denny           }
4557df86967SJoel E. Denny         }
4567df86967SJoel E. Denny         if (!WasInMatch && InMatch)
4577df86967SJoel E. Denny           COS.resetColor();
4587df86967SJoel E. Denny         else if (WasInMatch && !InMatch)
4597df86967SJoel E. Denny           COS.changeColor(raw_ostream::CYAN, true, true);
4603c5d267eSJoel E. Denny         if (*InputFilePtr == '\n')
4613c5d267eSJoel E. Denny           Newline = true;
4623c5d267eSJoel E. Denny         else
4637df86967SJoel E. Denny           COS << *InputFilePtr;
4643c5d267eSJoel E. Denny         ++InputFilePtr;
4653c5d267eSJoel E. Denny       }
4667df86967SJoel E. Denny     }
4673c5d267eSJoel E. Denny     OS << '\n';
4683c5d267eSJoel E. Denny     unsigned InputLineWidth = InputFilePtr - InputFileLine - Newline;
4693c5d267eSJoel E. Denny 
4703c5d267eSJoel E. Denny     // Print any annotations.
4713c5d267eSJoel E. Denny     while (AnnotationItr != AnnotationEnd &&
4723c5d267eSJoel E. Denny            AnnotationItr->InputLine == Line) {
4733c5d267eSJoel E. Denny       WithColor COS(OS, AnnotationItr->Marker.Color, true);
4743c5d267eSJoel E. Denny       // The two spaces below are where the ": " appears on input lines.
4753c5d267eSJoel E. Denny       COS << left_justify(AnnotationItr->Label, LabelWidth) << "  ";
4763c5d267eSJoel E. Denny       unsigned Col;
4773c5d267eSJoel E. Denny       for (Col = 1; Col < AnnotationItr->InputStartCol; ++Col)
4783c5d267eSJoel E. Denny         COS << ' ';
4793c5d267eSJoel E. Denny       COS << AnnotationItr->Marker.Lead;
4803c5d267eSJoel E. Denny       // If InputEndCol=UINT_MAX, stop at InputLineWidth.
4813c5d267eSJoel E. Denny       for (++Col; Col < AnnotationItr->InputEndCol && Col <= InputLineWidth;
4823c5d267eSJoel E. Denny            ++Col)
4833c5d267eSJoel E. Denny         COS << '~';
4843c5d267eSJoel E. Denny       const std::string &Note = AnnotationItr->Marker.Note;
4853c5d267eSJoel E. Denny       if (!Note.empty()) {
4863c5d267eSJoel E. Denny         // Put the note at the end of the input line.  If we were to instead
4873c5d267eSJoel E. Denny         // put the note right after the marker, subsequent annotations for the
4883c5d267eSJoel E. Denny         // same input line might appear to mark this note instead of the input
4893c5d267eSJoel E. Denny         // line.
4903c5d267eSJoel E. Denny         for (; Col <= InputLineWidth; ++Col)
4913c5d267eSJoel E. Denny           COS << ' ';
4923c5d267eSJoel E. Denny         COS << ' ' << Note;
4933c5d267eSJoel E. Denny       }
4943c5d267eSJoel E. Denny       COS << '\n';
4953c5d267eSJoel E. Denny       ++AnnotationItr;
4963c5d267eSJoel E. Denny     }
4973c5d267eSJoel E. Denny   }
4983c5d267eSJoel E. Denny 
4993c5d267eSJoel E. Denny   OS << ">>>>>>\n";
5003c5d267eSJoel E. Denny }
5013c5d267eSJoel E. Denny 
502ee3c74fbSChris Lattner int main(int argc, char **argv) {
5033e66509fSJoel E. Denny   // Enable use of ANSI color codes because FileCheck is using them to
5043e66509fSJoel E. Denny   // highlight text.
5053e66509fSJoel E. Denny   llvm::sys::Process::UseANSIEscapeCodes(true);
5063e66509fSJoel E. Denny 
507197194b6SRui Ueyama   InitLLVM X(argc, argv);
50824994d77SJoel E. Denny   cl::ParseCommandLineOptions(argc, argv, /*Overview*/ "", /*Errs*/ nullptr,
50924994d77SJoel E. Denny                               "FILECHECK_OPTS");
5103c5d267eSJoel E. Denny   if (DumpInput == DumpInputHelp) {
5113c5d267eSJoel E. Denny     DumpInputAnnotationHelp(outs());
5123c5d267eSJoel E. Denny     return 0;
5133c5d267eSJoel E. Denny   }
5143c5d267eSJoel E. Denny   if (CheckFilename.empty()) {
5153c5d267eSJoel E. Denny     errs() << "<check-file> not specified\n";
5163c5d267eSJoel E. Denny     return 2;
5173c5d267eSJoel E. Denny   }
518ee3c74fbSChris Lattner 
519ffa9d2e4SAditya Nandakumar   FileCheckRequest Req;
520ffa9d2e4SAditya Nandakumar   for (auto Prefix : CheckPrefixes)
521ffa9d2e4SAditya Nandakumar     Req.CheckPrefixes.push_back(Prefix);
522ffa9d2e4SAditya Nandakumar 
523ffa9d2e4SAditya Nandakumar   for (auto CheckNot : ImplicitCheckNot)
524ffa9d2e4SAditya Nandakumar     Req.ImplicitCheckNot.push_back(CheckNot);
525ffa9d2e4SAditya Nandakumar 
526ffa9d2e4SAditya Nandakumar   for (auto G : GlobalDefines)
527ffa9d2e4SAditya Nandakumar     Req.GlobalDefines.push_back(G);
528ffa9d2e4SAditya Nandakumar 
529ffa9d2e4SAditya Nandakumar   Req.AllowEmptyInput = AllowEmptyInput;
530ffa9d2e4SAditya Nandakumar   Req.EnableVarScope = EnableVarScope;
531ffa9d2e4SAditya Nandakumar   Req.AllowDeprecatedDagOverlap = AllowDeprecatedDagOverlap;
532ffa9d2e4SAditya Nandakumar   Req.Verbose = Verbose;
533ffa9d2e4SAditya Nandakumar   Req.VerboseVerbose = VerboseVerbose;
534ffa9d2e4SAditya Nandakumar   Req.NoCanonicalizeWhiteSpace = NoCanonicalizeWhiteSpace;
535ffa9d2e4SAditya Nandakumar   Req.MatchFullLines = MatchFullLines;
536ffa9d2e4SAditya Nandakumar 
537ffa9d2e4SAditya Nandakumar   if (VerboseVerbose)
538ffa9d2e4SAditya Nandakumar     Req.Verbose = true;
539ffa9d2e4SAditya Nandakumar 
540ffa9d2e4SAditya Nandakumar   FileCheck FC(Req);
541ffa9d2e4SAditya Nandakumar   if (!FC.ValidateCheckPrefixes()) {
54213df4626SMatt Arsenault     errs() << "Supplied check-prefix is invalid! Prefixes must be unique and "
54313df4626SMatt Arsenault               "start with a letter and contain only alphanumeric characters, "
54413df4626SMatt Arsenault               "hyphens and underscores\n";
545c2735158SRui Ueyama     return 2;
546c2735158SRui Ueyama   }
547c2735158SRui Ueyama 
548ffa9d2e4SAditya Nandakumar   Regex PrefixRE = FC.buildCheckPrefixRegex();
549726774cbSChandler Carruth   std::string REError;
550726774cbSChandler Carruth   if (!PrefixRE.isValid(REError)) {
551726774cbSChandler Carruth     errs() << "Unable to combine check-prefix strings into a prefix regular "
552726774cbSChandler Carruth               "expression! This is likely a bug in FileCheck's verification of "
553726774cbSChandler Carruth               "the check-prefix strings. Regular expression parsing failed "
554726774cbSChandler Carruth               "with the following error: "
555726774cbSChandler Carruth            << REError << "\n";
556726774cbSChandler Carruth     return 2;
557726774cbSChandler Carruth   }
55813df4626SMatt Arsenault 
559ee3c74fbSChris Lattner   SourceMgr SM;
560ee3c74fbSChris Lattner 
561ee3c74fbSChris Lattner   // Read the expected strings from the check file.
56220247900SChandler Carruth   ErrorOr<std::unique_ptr<MemoryBuffer>> CheckFileOrErr =
56320247900SChandler Carruth       MemoryBuffer::getFileOrSTDIN(CheckFilename);
56420247900SChandler Carruth   if (std::error_code EC = CheckFileOrErr.getError()) {
56520247900SChandler Carruth     errs() << "Could not open check file '" << CheckFilename
56620247900SChandler Carruth            << "': " << EC.message() << '\n';
56720247900SChandler Carruth     return 2;
56820247900SChandler Carruth   }
56920247900SChandler Carruth   MemoryBuffer &CheckFile = *CheckFileOrErr.get();
57020247900SChandler Carruth 
57120247900SChandler Carruth   SmallString<4096> CheckFileBuffer;
572ffa9d2e4SAditya Nandakumar   StringRef CheckFileText = FC.CanonicalizeFile(CheckFile, CheckFileBuffer);
57320247900SChandler Carruth 
57420247900SChandler Carruth   SM.AddNewSourceBuffer(MemoryBuffer::getMemBuffer(
57520247900SChandler Carruth                             CheckFileText, CheckFile.getBufferIdentifier()),
57620247900SChandler Carruth                         SMLoc());
57720247900SChandler Carruth 
578ffa9d2e4SAditya Nandakumar   std::vector<FileCheckString> CheckStrings;
579ffa9d2e4SAditya Nandakumar   if (FC.ReadCheckFile(SM, CheckFileText, PrefixRE, CheckStrings))
580ee3c74fbSChris Lattner     return 2;
581ee3c74fbSChris Lattner 
582ee3c74fbSChris Lattner   // Open the file to check and add it to SourceMgr.
58320247900SChandler Carruth   ErrorOr<std::unique_ptr<MemoryBuffer>> InputFileOrErr =
584adf21f2aSRafael Espindola       MemoryBuffer::getFileOrSTDIN(InputFilename);
58520247900SChandler Carruth   if (std::error_code EC = InputFileOrErr.getError()) {
586adf21f2aSRafael Espindola     errs() << "Could not open input file '" << InputFilename
587adf21f2aSRafael Espindola            << "': " << EC.message() << '\n';
5888e1c6477SEli Bendersky     return 2;
589ee3c74fbSChris Lattner   }
59020247900SChandler Carruth   MemoryBuffer &InputFile = *InputFileOrErr.get();
5912c3e5cdfSChris Lattner 
59220247900SChandler Carruth   if (InputFile.getBufferSize() == 0 && !AllowEmptyInput) {
593b692bed7SChris Lattner     errs() << "FileCheck error: '" << InputFilename << "' is empty.\n";
5942bd4f8b6SXinliang David Li     DumpCommandLine(argc, argv);
5958e1c6477SEli Bendersky     return 2;
596b692bed7SChris Lattner   }
597b692bed7SChris Lattner 
59820247900SChandler Carruth   SmallString<4096> InputFileBuffer;
599ffa9d2e4SAditya Nandakumar   StringRef InputFileText = FC.CanonicalizeFile(InputFile, InputFileBuffer);
6002c3e5cdfSChris Lattner 
601e8f2fb20SChandler Carruth   SM.AddNewSourceBuffer(MemoryBuffer::getMemBuffer(
602e8f2fb20SChandler Carruth                             InputFileText, InputFile.getBufferIdentifier()),
603e8f2fb20SChandler Carruth                         SMLoc());
604ee3c74fbSChris Lattner 
6053c5d267eSJoel E. Denny   if (DumpInput == DumpInputDefault)
6063c5d267eSJoel E. Denny     DumpInput = DumpInputOnFailure ? DumpInputFail : DumpInputNever;
6073c5d267eSJoel E. Denny 
6083c5d267eSJoel E. Denny   std::vector<FileCheckDiag> Diags;
6093c5d267eSJoel E. Denny   int ExitCode = FC.CheckInput(SM, InputFileText, CheckStrings,
6103c5d267eSJoel E. Denny                                DumpInput == DumpInputNever ? nullptr : &Diags)
6113c5d267eSJoel E. Denny                      ? EXIT_SUCCESS
6123c5d267eSJoel E. Denny                      : 1;
6133c5d267eSJoel E. Denny   if (DumpInput == DumpInputAlways ||
6143c5d267eSJoel E. Denny       (ExitCode == 1 && DumpInput == DumpInputFail)) {
6153c5d267eSJoel E. Denny     errs() << "\n"
6163c5d267eSJoel E. Denny            << "Input file: "
6173c5d267eSJoel E. Denny            << (InputFilename == "-" ? "<stdin>" : InputFilename.getValue())
6183c5d267eSJoel E. Denny            << "\n"
6193c5d267eSJoel E. Denny            << "Check file: " << CheckFilename << "\n"
6203c5d267eSJoel E. Denny            << "\n"
6213c5d267eSJoel E. Denny            << "-dump-input=help describes the format of the following dump.\n"
6223c5d267eSJoel E. Denny            << "\n";
6233c5d267eSJoel E. Denny     std::vector<InputAnnotation> Annotations;
6243c5d267eSJoel E. Denny     unsigned LabelWidth;
6253c5d267eSJoel E. Denny     BuildInputAnnotations(Diags, Annotations, LabelWidth);
6267df86967SJoel E. Denny     DumpAnnotatedInput(errs(), Req, InputFileText, Annotations, LabelWidth);
6273c5d267eSJoel E. Denny   }
628346dfbe2SGeorge Karpenkov 
629346dfbe2SGeorge Karpenkov   return ExitCode;
630ee3c74fbSChris Lattner }
631