LLVM  14.0.0git
Public Member Functions | List of all members
llvm::FileCheck Class Reference

FileCheck class takes the request and exposes various methods that use information from the request. More...

#include "llvm/FileCheck/FileCheck.h"

Public Member Functions

 FileCheck (FileCheckRequest Req)
 
 ~FileCheck ()
 
Regex buildCheckPrefixRegex ()
 
bool readCheckFile (SourceMgr &SM, StringRef Buffer, Regex &PrefixRE, std::pair< unsigned, unsigned > *ImpPatBufferIDRange=nullptr)
 Reads the check file from Buffer and records the expected strings it contains. More...
 
bool ValidateCheckPrefixes ()
 
StringRef CanonicalizeFile (MemoryBuffer &MB, SmallVectorImpl< char > &OutputBuffer)
 Canonicalizes whitespaces in the file. More...
 
bool checkInput (SourceMgr &SM, StringRef Buffer, std::vector< FileCheckDiag > *Diags=nullptr)
 Checks the input to FileCheck provided in the Buffer against the expected strings read from the check file and record diagnostics emitted in Diags. More...
 

Detailed Description

FileCheck class takes the request and exposes various methods that use information from the request.

Definition at line 177 of file FileCheck.h.

Constructor & Destructor Documentation

◆ FileCheck()

llvm::FileCheck::FileCheck ( FileCheckRequest  Req)
explicit

◆ ~FileCheck()

llvm::FileCheck::~FileCheck ( )

Member Function Documentation

◆ buildCheckPrefixRegex()

Regex llvm::FileCheck::buildCheckPrefixRegex ( )

◆ CanonicalizeFile()

StringRef llvm::FileCheck::CanonicalizeFile ( MemoryBuffer MB,
SmallVectorImpl< char > &  OutputBuffer 
)

Canonicalizes whitespaces in the file.

Line endings are replaced with UNIX-style '
'.

◆ checkInput()

bool llvm::FileCheck::checkInput ( SourceMgr SM,
StringRef  Buffer,
std::vector< FileCheckDiag > *  Diags = nullptr 
)

Checks the input to FileCheck provided in the Buffer against the expected strings read from the check file and record diagnostics emitted in Diags.

Errors are recorded against SM.

Returns
false if the input fails to satisfy the checks.

◆ readCheckFile()

bool llvm::FileCheck::readCheckFile ( SourceMgr SM,
StringRef  Buffer,
Regex PrefixRE,
std::pair< unsigned, unsigned > *  ImpPatBufferIDRange = nullptr 
)

Reads the check file from Buffer and records the expected strings it contains.

Errors are reported against SM.

Only expected strings whose prefix is one of those listed in PrefixRE are recorded.

Returns
true in case of an error, false otherwise.

If ImpPatBufferIDRange, then the range (inclusive start, exclusive end) of IDs for source buffers added to SM for implicit patterns are recorded in it. The range is empty if there are none.

◆ ValidateCheckPrefixes()

bool llvm::FileCheck::ValidateCheckPrefixes ( )

The documentation for this class was generated from the following file: