#include "llvm/FileCheck/FileCheck.h"
#include "FileCheckImpl.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/ADT/Twine.h"
#include "llvm/Support/CheckedArithmetic.h"
#include "llvm/Support/FormatVariadic.h"
#include <cstdint>
#include <list>
#include <set>
#include <tuple>
#include <utility>

Classes
struct	PrefixMatcher

Functions
static unsigned	nextAPIntBitWidth (unsigned BitWidth)

static APInt	toSigned (APInt AbsVal, bool Negative)

static char	popFront (StringRef &S)

static SMRange	ProcessMatchResult (FileCheckDiag::MatchType MatchTy, const SourceMgr &SM, SMLoc Loc, Check::FileCheckType CheckTy, StringRef Buffer, size_t Pos, size_t Len, std::vector< FileCheckDiag > *Diags, bool AdjustPrevDiags=false)

static bool	IsPartOfWord (char c)

static std::pair< Check::FileCheckType, StringRef >	FindCheckType (const FileCheckRequest &Req, StringRef Buffer, StringRef Prefix, bool &Misspelled)

static std::pair< Check::FileCheckType, StringRef >	FindCheckType (const FileCheckRequest &Req, StringRef Buffer, StringRef Prefix)

static size_t	SkipWord (StringRef Str, size_t Loc)

static void	addDefaultPrefixes (FileCheckRequest &Req)

static std::pair< StringRef, StringRef >	FindFirstMatchingPrefix (const FileCheckRequest &Req, PrefixMatcher &Matcher, StringRef &Buffer, unsigned &LineNumber, Check::FileCheckType &CheckTy)
	Searches the buffer for the first prefix in the prefix regular expression.

static Error	printMatch (bool ExpectedMatch, const SourceMgr &SM, StringRef Prefix, SMLoc Loc, const Pattern &Pat, int MatchedCount, StringRef Buffer, Pattern::MatchResult MatchResult, const FileCheckRequest &Req, std::vector< FileCheckDiag > *Diags)
	Returns either (1) `ErrorSuccess` if there was no error or (2) `ErrorReported` if an error was reported, such as an unexpected match.

static Error	printNoMatch (bool ExpectedMatch, const SourceMgr &SM, StringRef Prefix, SMLoc Loc, const Pattern &Pat, int MatchedCount, StringRef Buffer, Error MatchError, bool VerboseVerbose, std::vector< FileCheckDiag > *Diags)
	Returns either (1) `ErrorSuccess` if there was no error, or (2) `ErrorReported` if an error was reported, such as an expected match not found.

static Error	reportMatchResult (bool ExpectedMatch, const SourceMgr &SM, StringRef Prefix, SMLoc Loc, const Pattern &Pat, int MatchedCount, StringRef Buffer, Pattern::MatchResult MatchResult, const FileCheckRequest &Req, std::vector< FileCheckDiag > *Diags)
	Returns either (1) `ErrorSuccess` if there was no error, or (2) `ErrorReported` if an error was reported.

static unsigned	CountNumNewlinesBetween (StringRef Range, const char *&FirstNewLine)
	Counts the number of newlines in the specified range.

static bool	ValidatePrefixes (StringRef Kind, StringSet<> &UniquePrefixes, ArrayRef< StringRef > SuppliedPrefixes)

Variables
constexpr StringLiteral	SpaceChars = " \t"

static const char *	DefaultCheckPrefixes [] = {"CHECK"}

static const char *	DefaultCommentPrefixes [] = {"COM", "RUN"}

Function Documentation

◆ addDefaultPrefixes()

static void addDefaultPrefixes ( FileCheckRequest & Req )

static

Definition at line 1642 of file FileCheck.cpp.

References llvm::FileCheckRequest::CheckPrefixes, llvm::FileCheckRequest::CommentPrefixes, DefaultCheckPrefixes, DefaultCommentPrefixes, and llvm::FileCheckRequest::IsDefaultCheckPrefix.

Referenced by llvm::FileCheck::readCheckFile().

◆ CountNumNewlinesBetween()

static unsigned CountNumNewlinesBetween	(	StringRef	Range,
		const char *&	FirstNewLine
	)

static

Counts the number of newlines in the specified range.

Definition at line 2144 of file FileCheck.cpp.

References Range.

Referenced by llvm::FileCheckString::CheckNext(), and llvm::FileCheckString::CheckSame().

◆ FindCheckType() [1/2]

static std::pair< Check::FileCheckType, StringRef > FindCheckType	(	const FileCheckRequest &	Req,
		StringRef	Buffer,
		StringRef	Prefix
	)

static

Definition at line 1624 of file FileCheck.cpp.

References llvm::Check::CheckMisspelled, llvm::Check::CheckNone, and FindCheckType().

◆ FindCheckType() [2/2]

static std::pair< Check::FileCheckType, StringRef > FindCheckType	(	const FileCheckRequest &	Req,
		StringRef	Buffer,
		StringRef	Prefix,
		bool &	Misspelled
	)

static

◆ FindFirstMatchingPrefix()

static std::pair< StringRef, StringRef > FindFirstMatchingPrefix	(	const FileCheckRequest &	Req,
		PrefixMatcher &	Matcher,
		StringRef &	Buffer,
		unsigned &	LineNumber,
		Check::FileCheckType &	CheckTy
	)

static

Searches the buffer for the first prefix in the prefix regular expression.

This searches the buffer using the provided regular expression, however it enforces constraints beyond that: 1) The found prefix must not be a suffix of something that looks like a valid prefix. 2) The found prefix must be followed by a valid check type suffix using FindCheckType above.

Returns

a pair of StringRefs into the Buffer, which combines:

the first match of the regular expression to satisfy these two is returned, otherwise an empty StringRef is returned to indicate failure.
buffer rewound to the location right after parsed suffix, for parsing to continue from

If this routine returns a valid prefix, it will also shrink Buffer to start at the beginning of the returned prefix, increment LineNumber for each new line consumed from Buffer, and set CheckTy to the type of check found by examining the suffix.

If no valid prefix is found, the state of Buffer, LineNumber, and CheckTy is unspecified.

Definition at line 1717 of file FileCheck.cpp.

References assert(), llvm::StringRef::back(), llvm::Check::CheckNone, llvm::StringRef::count(), llvm::StringRef::data(), llvm::StringRef::drop_front(), llvm::StringRef::empty(), FindCheckType(), IsPartOfWord(), PrefixMatcher::match(), llvm::StringRef::size(), SkipWord(), and llvm::StringRef::substr().

Referenced by llvm::FileCheck::readCheckFile().

◆ IsPartOfWord()

static bool IsPartOfWord ( char c )

static

Definition at line 1470 of file FileCheck.cpp.

Referenced by FindFirstMatchingPrefix(), and SkipWord().

◆ nextAPIntBitWidth()

static unsigned nextAPIntBitWidth ( unsigned BitWidth )

static

Definition at line 123 of file FileCheck.cpp.

References llvm::APInt::APINT_BITS_PER_WORD, and llvm::BitWidth.

Referenced by llvm::BinaryOperation::eval(), and toSigned().

◆ popFront()

static char popFront ( StringRef & S )

static

Definition at line 324 of file FileCheck.cpp.

References llvm::CallingConv::C, llvm::StringRef::drop_front(), and llvm::StringRef::front().

Referenced by llvm::Pattern::parseNumericSubstitutionBlock().

◆ printMatch()

static Error printMatch	(	bool	ExpectedMatch,
		const SourceMgr &	SM,
		StringRef	Prefix,
		SMLoc	Loc,
		const Pattern &	Pat,
		int	MatchedCount,
		StringRef	Buffer,
		Pattern::MatchResult	MatchResult,
		const FileCheckRequest &	Req,
		std::vector< FileCheckDiag > *	Diags
	)

static

Returns either (1) ErrorSuccess if there was no error or (2) ErrorReported if an error was reported, such as an unexpected match.

Definition at line 1976 of file FileCheck.cpp.

References assert(), llvm::Check::CheckEOF, llvm::SourceMgr::DK_Error, llvm::SourceMgr::DK_Note, llvm::SourceMgr::DK_Remark, llvm::formatv(), llvm::Pattern::getCheckTy(), llvm::Pattern::getCount(), llvm::Check::FileCheckType::getDescription(), llvm::handleAllErrors(), llvm::FileCheckDiag::MatchFoundAndExpected, llvm::FileCheckDiag::MatchFoundButExcluded, llvm::SourceMgr::PrintMessage(), llvm::Pattern::printSubstitutions(), llvm::Pattern::printVariableDefs(), ProcessMatchResult(), llvm::ErrorReported::reportedOrSuccess(), llvm::SMRange::Start, llvm::Pattern::MatchResult::TheError, llvm::Pattern::MatchResult::TheMatch, llvm::FileCheckRequest::Verbose, and llvm::FileCheckRequest::VerboseVerbose.

Referenced by llvm::FileCheckString::CheckDag(), and reportMatchResult().

◆ printNoMatch()

static Error printNoMatch	(	bool	ExpectedMatch,
		const SourceMgr &	SM,
		StringRef	Prefix,
		SMLoc	Loc,
		const Pattern &	Pat,
		int	MatchedCount,
		StringRef	Buffer,
		Error	MatchError,
		bool	VerboseVerbose,
		std::vector< FileCheckDiag > *	Diags
	)

static

Returns either (1) ErrorSuccess if there was no error, or (2) ErrorReported if an error was reported, such as an expected match not found.

Definition at line 2046 of file FileCheck.cpp.

References assert(), llvm::SourceMgr::DK_Error, llvm::SourceMgr::DK_Note, llvm::SourceMgr::DK_Remark, llvm::errs(), llvm::formatv(), llvm::Pattern::getCheckTy(), llvm::Pattern::getCount(), llvm::Check::FileCheckType::getDescription(), llvm::ErrorDiagnostic::getMessage(), llvm::handleAllErrors(), llvm::ErrorDiagnostic::log(), llvm::FileCheckDiag::MatchNoneAndExcluded, llvm::FileCheckDiag::MatchNoneButExpected, llvm::FileCheckDiag::MatchNoneForInvalidPattern, llvm::Pattern::printFuzzyMatch(), llvm::SourceMgr::PrintMessage(), llvm::Pattern::printSubstitutions(), ProcessMatchResult(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::ErrorReported::reportedOrSuccess(), llvm::StringRef::size(), llvm::SMRange::Start, and llvm::StringRef::str().

Referenced by reportMatchResult().

◆ ProcessMatchResult()

static SMRange ProcessMatchResult	(	FileCheckDiag::MatchType	MatchTy,
		const SourceMgr &	SM,
		SMLoc	Loc,
		Check::FileCheckType	CheckTy,
		StringRef	Buffer,
		size_t	Pos,
		size_t	Len,
		std::vector< FileCheckDiag > *	Diags,
		bool	AdjustPrevDiags = `false`
	)

static

Definition at line 1292 of file FileCheck.cpp.

References llvm::StringRef::data(), End, llvm::SMLoc::getFromPointer(), I, and Range.

Referenced by llvm::FileCheckString::Check(), llvm::Pattern::printFuzzyMatch(), printMatch(), and printNoMatch().

◆ reportMatchResult()

static Error reportMatchResult	(	bool	ExpectedMatch,
		const SourceMgr &	SM,
		StringRef	Prefix,
		SMLoc	Loc,
		const Pattern &	Pat,
		int	MatchedCount,
		StringRef	Buffer,
		Pattern::MatchResult	MatchResult,
		const FileCheckRequest &	Req,
		std::vector< FileCheckDiag > *	Diags
	)