FOSSology  4.4.0
Open Source License Compliance by Open Source Software
Public Member Functions | List of all members
scanner Class Referenceabstract

Abstract class to provide interface to scanners. More...

#include <scanners.hpp>

Inheritance diagram for scanner:
Inheritance graph
Collaboration diagram for scanner:
Collaboration graph

Public Member Functions

virtual void ScanString (const string &s, list< match > &results) const =0
 Scan the given string and add matches to results. More...
 
virtual void ScanFile (const string &fileName, list< match > &results) const
 Helper function to scan file. More...
 

Detailed Description

Abstract class to provide interface to scanners.

Definition at line 51 of file scanners.hpp.

Member Function Documentation

◆ ScanFile()

virtual void scanner::ScanFile ( const string &  fileName,
list< match > &  results 
) const
inlinevirtual

Helper function to scan file.

Reads file contents to string and pass to ScanString()

Parameters
[in]fileNameFile name to scan
[out]resultsCopyright matches are appended to this list

Definition at line 70 of file scanners.hpp.

◆ ScanString()

virtual void scanner::ScanString ( const string &  s,
list< match > &  results 
) const
pure virtual

Scan the given string and add matches to results.

Parameters
[in]sString to scan
[out]resultsCopyright matches are appended to this list

Implemented in regexScanner, and hCopyrightScanner.

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