KVIrc 5.2.4
Developer APIs
Classes | Signals | Public Member Functions | Private Slots | Private Member Functions | Private Attributes | List of all members
HelpIndex Class Reference

#include <HelpIndex.h>

+ Inheritance diagram for HelpIndex:

Classes

struct  Entry
 
struct  PosEntry
 

Signals

void indexingEnd ()
 
void indexingProgress (int)
 
void indexingStart (int)
 

Public Member Functions

const QStringList & documentList () const
 
QString getDocumentTitle (const QString &)
 
 HelpIndex (QString dp, const QString &hp)
 
 HelpIndex (QStringList dl, const QString &hp)
 
void makeIndex ()
 
QStringList query (const QStringList &, const QStringList &, const QStringList &)
 
void readDict ()
 
void setDictionaryFile (const QString &)
 
void setDocList (const QStringList &)
 
void setDocListFile (const QString &)
 
const QStringList & titlesList () const
 
void writeDict ()
 

Private Slots

void filterNext ()
 
void setLastWinClosed ()
 

Private Member Functions

void buildMiniDict (const QString &)
 
QStringList getWildcardTerms (const QString &)
 
void insertInDict (const QString &, int)
 
void parseDocument (const QString &, int)
 
void readDocumentList ()
 
bool searchForPattern (const QStringList &, const QStringList &, const QString &)
 
void setupDocumentList ()
 
QVector< DocumentsetupDummyTerm (const QStringList &)
 
QStringList split (const QString &)
 
void writeDocumentList ()
 

Private Attributes

bool alreadyHaveDocList
 
QHash< QString, Entry * > dict
 
QString dictFile
 
QStringList docList
 
QString docListFile
 
QString docPath
 
QHash< QString, QString > documentTitleCache
 
bool lastWindowClosed = false
 
int m_iCurItem = 0
 
QTimer * m_pTimer = nullptr
 
QHash< QString, PosEntry * > miniDict
 
QStringList titleList
 
uint wordNum = 0
 

Constructor & Destructor Documentation

◆ HelpIndex() [1/2]

HelpIndex::HelpIndex ( QString  dp,
const QString &  hp 
)

◆ HelpIndex() [2/2]

HelpIndex::HelpIndex ( QStringList  dl,
const QString &  hp 
)

Member Function Documentation

◆ buildMiniDict()

void HelpIndex::buildMiniDict ( const QString &  str)
private

References miniDict, and wordNum.

Referenced by searchForPattern().

◆ documentList()

const QStringList & HelpIndex::documentList ( ) const
inline

◆ filterNext

void HelpIndex::filterNext ( )
privateslot

◆ getDocumentTitle()

QString HelpIndex::getDocumentTitle ( const QString &  fullFileName)

◆ getWildcardTerms()

QStringList HelpIndex::getWildcardTerms ( const QString &  term)
private

References dict, and split().

Referenced by query().

◆ indexingEnd

void HelpIndex::indexingEnd ( )
signal

Referenced by filterNext().

◆ indexingProgress

void HelpIndex::indexingProgress ( int  )
signal

Referenced by filterNext().

◆ indexingStart

void HelpIndex::indexingStart ( int  )
signal

Referenced by makeIndex().

◆ insertInDict()

void HelpIndex::insertInDict ( const QString &  str,
int  docNum 
)
private

References dict, HelpIndex::Entry::documents, and e.

Referenced by parseDocument().

◆ makeIndex()

void HelpIndex::makeIndex ( )

◆ parseDocument()

void HelpIndex::parseDocument ( const QString &  filename,
int  docNum 
)
private

References i, insertInDict(), j, and s.

Referenced by filterNext().

◆ query()

QStringList HelpIndex::query ( const QStringList &  terms,
const QStringList &  termSeq,
const QStringList &  seqWords 
)

◆ readDict()

void HelpIndex::readDict ( )

◆ readDocumentList()

void HelpIndex::readDocumentList ( )
private

References docList, docListFile, f, s, and titleList.

Referenced by readDict().

◆ searchForPattern()

bool HelpIndex::searchForPattern ( const QStringList &  patterns,
const QStringList &  words,
const QString &  fileName 
)
private

References a, buildMiniDict(), i, j, miniDict, s, and wordNum.

Referenced by query().

◆ setDictionaryFile()

void HelpIndex::setDictionaryFile ( const QString &  f)

References dictFile, and f.

Referenced by help_module_init().

◆ setDocList()

void HelpIndex::setDocList ( const QStringList &  lst)

References docList.

◆ setDocListFile()

void HelpIndex::setDocListFile ( const QString &  f)

References docListFile, and f.

Referenced by help_module_init().

◆ setLastWinClosed

void HelpIndex::setLastWinClosed ( )
privateslot

References lastWindowClosed.

Referenced by HelpIndex(), and HelpIndex().

◆ setupDocumentList()

void HelpIndex::setupDocumentList ( )
private

References d, docList, docPath, getDocumentTitle(), and titleList.

Referenced by makeIndex().

◆ setupDummyTerm()

QVector< Document > HelpIndex::setupDummyTerm ( const QStringList &  terms)
private

References dict, and e.

Referenced by query().

◆ split()

QStringList HelpIndex::split ( const QString &  str)
private

References i, j, and l.

Referenced by getWildcardTerms().

◆ titlesList()

const QStringList & HelpIndex::titlesList ( ) const
inline

◆ writeDict()

void HelpIndex::writeDict ( )

◆ writeDocumentList()

void HelpIndex::writeDocumentList ( )
private

References docList, docListFile, f, s, and titleList.

Referenced by writeDict().

Member Data Documentation

◆ alreadyHaveDocList

bool HelpIndex::alreadyHaveDocList
private

Referenced by HelpIndex(), HelpIndex(), and makeIndex().

◆ dict

QHash<QString, Entry *> HelpIndex::dict
private

◆ dictFile

QString HelpIndex::dictFile
private

◆ docList

QStringList HelpIndex::docList
private

◆ docListFile

QString HelpIndex::docListFile
private

◆ docPath

QString HelpIndex::docPath
private

Referenced by setupDocumentList().

◆ documentTitleCache

QHash<QString, QString> HelpIndex::documentTitleCache
private

Referenced by getDocumentTitle().

◆ lastWindowClosed

bool HelpIndex::lastWindowClosed = false
private

◆ m_iCurItem

int HelpIndex::m_iCurItem = 0
private

Referenced by filterNext(), and makeIndex().

◆ m_pTimer

QTimer* HelpIndex::m_pTimer = nullptr
private

Referenced by filterNext(), HelpIndex(), and makeIndex().

◆ miniDict

QHash<QString, PosEntry *> HelpIndex::miniDict
private

Referenced by buildMiniDict(), and searchForPattern().

◆ titleList

QStringList HelpIndex::titleList
private

◆ wordNum

uint HelpIndex::wordNum = 0
private

Referenced by buildMiniDict(), and searchForPattern().


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