class FileCheck

Declaration

class FileCheck { /* full declaration omitted */ };

Description

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

Declared at: llvm/include/llvm/FileCheck/FileCheck.h:180

Member Variables

private llvm::FileCheckRequest Req

private std::unique_ptr<FileCheckPatternContext> PatternContext

private std::unique_ptr<std::vector<FileCheckString>> CheckStrings

Method Overview

• public llvm::StringRef CanonicalizeFile(llvm::MemoryBuffer & MB, SmallVectorImpl<char> & OutputBuffer)
• public FileCheck(llvm::FileCheckRequest Req)
• public bool ValidateCheckPrefixes()
• public llvm::Regex buildCheckPrefixRegex()
• public bool checkInput(llvm::SourceMgr & SM, llvm::StringRef Buffer, std::vector<FileCheckDiag> * Diags = nullptr)
• public bool readCheckFile(llvm::SourceMgr & SM, llvm::StringRef Buffer, llvm::Regex & PrefixRE, std::pair<unsigned int, unsigned int> * ImpPatBufferIDRange = nullptr)
• public ~FileCheck()

Methods

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

Description

Canonicalizes whitespaces in the file. Line endings are replaced with UNIX-style '\n'.

Declared at: llvm/include/llvm/FileCheck/FileCheck.h:214

Parameters

llvm::MemoryBuffer& MB

SmallVectorImpl<char>& OutputBuffer

¶FileCheck(llvm::FileCheckRequest Req)

Declared at: llvm/include/llvm/FileCheck/FileCheck.h:187

Parameters

llvm::FileCheckRequest Req

¶bool ValidateCheckPrefixes()

Declared at: llvm/include/llvm/FileCheck/FileCheck.h:210

¶llvm::Regex buildCheckPrefixRegex()

Declared at: llvm/include/llvm/FileCheck/FileCheck.h:195

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

Description

Checks the input to FileCheck provided in the \p Buffer against the expected strings read from the check file and record diagnostics emitted in \p Diags. Errors are recorded against \p SM.

Declared at: llvm/include/llvm/FileCheck/FileCheck.h:222

Parameters

llvm::SourceMgr& SM

llvm::StringRef Buffer

std::vector<FileCheckDiag>* Diags = nullptr

Returns

false if the input fails to satisfy the checks.

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

Description

Reads the check file from \p Buffer and records the expected strings it contains. Errors are reported against \p SM. Only expected strings whose prefix is one of those listed in \p PrefixRE are recorded. If \p ImpPatBufferIDRange, then the range (inclusive start, exclusive end) of IDs for source buffers added to \p SM for implicit patterns are recorded in it. The range is empty if there are none.

Declared at: llvm/include/llvm/FileCheck/FileCheck.h:207

Parameters

llvm::SourceMgr& SM

llvm::StringRef Buffer

llvm::Regex& PrefixRE

std::pair<unsigned int, unsigned int>* ImpPatBufferIDRange = nullptr

Returns

true in case of an error, false otherwise.

¶~FileCheck()

Declared at: llvm/include/llvm/FileCheck/FileCheck.h:188