Baloo

Classes | Typedefs | Enumerations | Functions
Baloo Namespace Reference

Classes

class  Command
 
class  DatabaseSanitizer
 
class  Document
 
class  DocumentDB
 
class  File
 
class  FileIndexerConfig
 
class  FileMetaDataProvider
 
class  IndexerConfig
 
class  MTimeDB
 
class  NewFileIndexer
 
class  PendingFile
 
class  PostingDB
 
class  PostingIterator
 
class  Query
 
class  StorageDevices
 
class  TagWidget
 
class  UnIndexedFileIterator
 

Typedefs

typedef QFlags< DocumentOperation > DocumentOperations
 
typedef QVector< quint64 > PostingList
 

Enumerations

enum  DocumentOperation {
  DocumentTerms = 0x1 , FileNameTerms = 0x2 , XAttrTerms = 0x4 , DocumentData = 0x8 ,
  DocumentTime = 0x10 , DocumentUrl = 0x20 , Everything = DocumentTerms | FileNameTerms | XAttrTerms | DocumentData | DocumentTime | DocumentUrl
}
 
enum  IndexerState {
  Idle , Suspended , FirstRun , NewFiles ,
  ModifiedFiles , XAttrFiles , ContentIndexing , UnindexedFileCheck ,
  StaleIndexEntriesClean , LowPowerIdle , Unavailable , Startup
}
 
enum  TimelineFolderType {
  NoFolder = 0 , RootFolder , CalendarFolder , MonthFolder ,
  DayFolder
}
 

Functions

QUrl canonicalizeTimelineUrl (const QUrl &url)
 
quint64 decodeFixed64 (const char *ptr)
 
QStringList defaultExcludeFilterList ()
 
int defaultExcludeFilterListVersion ()
 
QStringList defaultExcludeMimetypes ()
 
int defaultExcludeMimetypesVersion ()
 
quint64 devIdAndInodeToId (quint32 devId, quint32 inode)
 
static int encodeVarint32Internal (char *dst, quint32 v)
 
BALOO_ENGINE_EXPORT QString fileIndexDbPath ()
 
quint64 filePathToId (const QByteArray &filePath)
 
int filePathToStat (const QByteArray &filePath, QT_STATBUF &statBuf)
 
char * getDifferentialVarInt32 (char *p, char *limit, QVector< quint32 > *values)
 
char * getVarint32Ptr (char *p, char *limit, quint32 *value)
 
const char * getVarint32Ptr (const char *p, const char *limit, quint32 *v)
 
char * getVarint32PtrFallback (char *p, char *limit, quint32 *value)
 
BALOO_ENGINE_EXPORT Database * globalDatabaseInstance ()
 
quint32 idToDeviceId (quint64 id)
 
quint32 idToInode (quint64 id)
 
const KFileMetaData::PropertyMultiMap jsonToPropertyMap (const QJsonObject &properties)
 
Term operator! (const Term &rhs)
 
Term operator&& (const Term &lhs, const Term &rhs)
 
QDebug operator<< (QDebug d, const Baloo::EngineQuery &q)
 
QDebug operator<< (QDebug dbg, const Document &doc)
 
QDebug operator<< (QDebug dbg, const DocumentTimeDB::TimeInfo &time)
 
QDebug operator<< (QDebug dbg, const FileIndexerConfig::FolderCache::value_type &)
 
QDebug operator<< (QDebug dbg, const FileIndexerConfig::FolderConfig &entry)
 
QDebug operator<< (QDebug dbg, const PositionInfo &pos)
 
Term operator|| (const Term &lhs, const Term &rhs)
 
TimelineFolderType parseTimelineUrl (const QUrl &url, QDate *date, QString *filename=nullptr)
 
const QJsonObject propertyMapToJson (const KFileMetaData::PropertyMultiMap &properties)
 
void putDifferentialVarInt32 (QByteArray &temporaryStorage, QByteArray *dst, const QVector< quint32 > &values)
 
void putFixed64 (QByteArray *dst, quint64 value)
 
static void putVarint32Internal (char *dst, quint32 v, int &pos)
 
template<typename T, typename V>
void sortedIdInsert (T &vec, const V &id)
 
template<typename T, typename V>
void sortedIdRemove (T &vec, const V &id)
 
QStringList sourceCodeMimeTypes ()
 
quint64 statBufToId (const QT_STATBUF &stBuf)
 
BALOO_ENGINE_EXPORT QString stateString (IndexerState state)
 
BALOO_ENGINE_EXPORT QString stateString (int state)
 
int statWithFsid (const char *path, QT_STATBUF *statBuf)
 
char * toString (const EngineQuery &query)
 
char * toString (const Term &term)
 

Detailed Description

Implements storage for docIds without any associated data Instantiated for:

  • content indexing (files to be reindexed)
  • failed ids (files no indexable, e.g. due to crashing indexers)

Typedef Documentation

◆ DocumentOperations

typedef QFlags< DocumentOperation > Baloo::DocumentOperations

Definition at line 22 of file documentoperations.h.

◆ PostingList

typedef QVector<quint64> Baloo::PostingList

Definition at line 21 of file postingdb.h.

Enumeration Type Documentation

◆ DocumentOperation

enum Baloo::DocumentOperation

Definition at line 13 of file documentoperations.h.

◆ IndexerState

enum Baloo::IndexerState

Definition at line 19 of file indexerstate.h.

◆ TimelineFolderType

enum Baloo::TimelineFolderType

The hierarchy in timeline:/ looks as follows:

/ |- /today | |- /calendar | |- /calendar/2010 | |- /calendar/2010/january | |- /calendar/2010/january/2010-01-01 | |- /calendar/2009 | |- /months | |- /month/2010 | |- /months/2010/january | |- /weeks

Enumerator
RootFolder 

nothing

CalendarFolder 

the root folder

MonthFolder 

the calendar folder listing all months

DayFolder 

a folder listing a month's days (m_date contains the month)

Definition at line 36 of file timelinetools.h.

Function Documentation

◆ canonicalizeTimelineUrl()

QUrl Baloo::canonicalizeTimelineUrl ( const QUrl & url)

Remove any double slashes, remove any trailing slashes, and add an initial slash after the scheme.

Definition at line 53 of file timelinetools.cpp.

◆ decodeFixed64()

quint64 Baloo::decodeFixed64 ( const char * ptr)
inline

Definition at line 38 of file coding.h.

◆ defaultExcludeFilterList()

QStringList Baloo::defaultExcludeFilterList ( )
Returns
A list of default exclude filters to be used in the filewatch service to ignore temporary files and folders that change a lot and as a basis for the user configurable exclude filters in the strigi service.

Definition at line 202 of file fileexcludefilters.cpp.

◆ defaultExcludeFilterListVersion()

int Baloo::defaultExcludeFilterListVersion ( )
Returns
The version of the default exclude filter list. This is increased whenever the list changes.

Definition at line 214 of file fileexcludefilters.cpp.

◆ defaultExcludeMimetypes()

QStringList Baloo::defaultExcludeMimetypes ( )

Definition at line 229 of file fileexcludefilters.cpp.

◆ defaultExcludeMimetypesVersion()

int Baloo::defaultExcludeMimetypesVersion ( )

Definition at line 234 of file fileexcludefilters.cpp.

◆ devIdAndInodeToId()

quint64 Baloo::devIdAndInodeToId ( quint32 devId,
quint32 inode )
inline

Definition at line 22 of file idutils.h.

◆ encodeVarint32Internal()

static int Baloo::encodeVarint32Internal ( char * dst,
quint32 v )
inlinestatic

Definition at line 13 of file coding.cpp.

◆ filePathToId()

quint64 Baloo::filePathToId ( const QByteArray & filePath)
inline

Definition at line 78 of file idutils.h.

◆ filePathToStat()

int Baloo::filePathToStat ( const QByteArray & filePath,
QT_STATBUF & statBuf )
inline

Definition at line 63 of file idutils.h.

◆ getDifferentialVarInt32()

char * Baloo::getDifferentialVarInt32 ( char * p,
char * limit,
QVector< quint32 > * values )

Definition at line 69 of file coding.cpp.

◆ getVarint32Ptr()

char * Baloo::getVarint32Ptr ( char * p,
char * limit,
quint32 * value )
inline

Definition at line 48 of file coding.h.

◆ getVarint32PtrFallback()

char * Baloo::getVarint32PtrFallback ( char * p,
char * limit,
quint32 * value )

Definition at line 92 of file coding.cpp.

◆ globalDatabaseInstance()

Database * Baloo::Baloo::globalDatabaseInstance ( )

Definition at line 27 of file global.cpp.

◆ idToDeviceId()

quint32 Baloo::idToDeviceId ( quint64 id)
inline

Definition at line 91 of file idutils.h.

◆ idToInode()

quint32 Baloo::idToInode ( quint64 id)
inline

Definition at line 85 of file idutils.h.

◆ jsonToPropertyMap()

const KFileMetaData::PropertyMultiMap Baloo::jsonToPropertyMap ( const QJsonObject & properties)

Definition at line 63 of file propertydata.cpp.

◆ operator!()

Term Baloo::operator! ( const Term & rhs)
inline

Definition at line 139 of file term.h.

◆ operator&&()

Term Baloo::operator&& ( const Term & lhs,
const Term & rhs )
inline

Definition at line 119 of file term.h.

◆ operator<<() [1/5]

QDebug Baloo::operator<< ( QDebug d,
const Baloo::EngineQuery & q )
inline

Definition at line 66 of file enginequery.h.

◆ operator<<() [2/5]

QDebug Baloo::operator<< ( QDebug dbg,
const Document & doc )
inline

Definition at line 87 of file document.h.

◆ operator<<() [3/5]

QDebug Baloo::operator<< ( QDebug dbg,
const DocumentTimeDB::TimeInfo & time )
inline

Definition at line 58 of file documenttimedb.h.

◆ operator<<() [4/5]

QDebug Baloo::operator<< ( QDebug dbg,
const FileIndexerConfig::FolderConfig & entry )

Definition at line 52 of file fileindexerconfig.cpp.

◆ operator<<() [5/5]

QDebug Baloo::operator<< ( QDebug dbg,
const PositionInfo & pos )
inline

Definition at line 35 of file positioninfo.h.

◆ operator||()

Term Baloo::operator|| ( const Term & lhs,
const Term & rhs )
inline

Definition at line 129 of file term.h.

◆ parseTimelineUrl()

Baloo::TimelineFolderType Baloo::parseTimelineUrl ( const QUrl & url,
QDate * date,
QString * filename = nullptr )

Parse a timeline URL like timeline:/today and return the type of folder it represents.

If DayFolder is returned date is set to the date that should be listed. Otherwise it is an invalid date. filename is optionally set to the name of the file in the folder.

Definition at line 72 of file timelinetools.cpp.

◆ propertyMapToJson()

const QJsonObject Baloo::propertyMapToJson ( const KFileMetaData::PropertyMultiMap & properties)

Definition at line 15 of file propertydata.cpp.

◆ putDifferentialVarInt32()

void Baloo::putDifferentialVarInt32 ( QByteArray & temporaryStorage,
QByteArray * dst,
const QVector< quint32 > & values )

Definition at line 53 of file coding.cpp.

◆ putFixed64()

void Baloo::putFixed64 ( QByteArray * dst,
quint64 value )
inline

Definition at line 23 of file coding.h.

◆ putVarint32Internal()

static void Baloo::putVarint32Internal ( char * dst,
quint32 v,
int & pos )
inlinestatic

Definition at line 48 of file coding.cpp.

◆ sortedIdInsert()

template<typename T, typename V>
void Baloo::sortedIdInsert ( T & vec,
const V & id )
inline

search with normal <

end reached or element found smaller? => insert new element!

Definition at line 98 of file idutils.h.

◆ sortedIdRemove()

template<typename T, typename V>
void Baloo::sortedIdRemove ( T & vec,
const V & id )
inline

Definition at line 114 of file idutils.h.

◆ sourceCodeMimeTypes()

QStringList Baloo::sourceCodeMimeTypes ( )

Definition at line 219 of file fileexcludefilters.cpp.

◆ statBufToId()

quint64 Baloo::statBufToId ( const QT_STATBUF & stBuf)
inline

Convert the QT_STATBUF into a 64 bit unique identifier for the file.

This identifier is combination of the device id and inode number.

Definition at line 37 of file idutils.h.

◆ stateString() [1/2]

QString Baloo::stateString ( IndexerState state)

Definition at line 12 of file indexerstate.cpp.

◆ stateString() [2/2]

QString Baloo::stateString ( int state)

Definition at line 56 of file indexerstate.cpp.

◆ statWithFsid()

int Baloo::statWithFsid ( const char * path,
QT_STATBUF * statBuf )
inline

Definition at line 46 of file idutils.h.

◆ toString() [1/2]

char * Baloo::toString ( const EngineQuery & query)
inline

Helper for QTest.

See also
QTest::toString
Since
: 5.70

Definition at line 91 of file enginequery.h.

◆ toString() [2/2]

char * Baloo::toString ( const Term & term)

Helper for QTest.

See also
QTest::toString
Since
: 5.70

Definition at line 410 of file term.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Apr 25 2025 12:02:21 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.