• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KDECore

  • kdecore
  • sycoca
ksycoca_p.h
Go to the documentation of this file.
1/* This file is part of the KDE libraries
2 * Copyright (C) 1999-2000 Waldo Bastian <bastian@kde.org>
3 * Copyright (C) 2005-2009 David Faure <faure@kde.org>
4 * Copyright (C) 2008 Hamish Rodda <rodda@kde.org>
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License version 2 as published by the Free Software Foundation;
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
14 *
15 * You should have received a copy of the GNU Library General Public License
16 * along with this library; see the file COPYING.LIB. If not, write to
17 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
19 **/
20
21#ifndef KSYCOCA_P_H
22#define KSYCOCA_P_H
23
24#include "ksycocafactory.h"
25#include <QStringList>
26class QFile;
27class QDataStream;
28class KSycocaAbstractDevice;
29
30class KSycocaPrivate
31{
32public:
33 KSycocaPrivate();
34 bool checkVersion();
35 bool openDatabase(bool openDummyIfNotFound=true);
36 enum BehaviorIfNotFound {
37 IfNotFoundDoNothing = 0,
38 IfNotFoundOpenDummy = 1,
39 IfNotFoundRecreate = 2
40 };
41 Q_DECLARE_FLAGS(BehaviorsIfNotFound, BehaviorIfNotFound)
42 bool checkDatabase(BehaviorsIfNotFound ifNotFound);
43 void closeDatabase();
44 void setStrategyFromString(const QString& strategy);
45 bool tryMmap();
46
47 KSycocaAbstractDevice* device();
48 QDataStream*& stream();
49
50 enum {
51 DatabaseNotOpen, // openDatabase must be called
52 NoDatabase, // not found, so we opened a dummy one instead
53 BadVersion, // it's opened, but it's not useable
54 DatabaseOK } databaseStatus;
55 bool readError;
56
57 quint32 timeStamp;
58 enum { StrategyMmap, StrategyMemFile, StrategyFile, StrategyDummyBuffer } m_sycocaStrategy;
59 QString m_databasePath;
60 QStringList changeList;
61 QString language;
62 quint32 updateSig;
63 QStringList allResourceDirs;
64
65 void addFactory(KSycocaFactory* factory) {
66 m_factories.append(factory);
67 }
68 KSycocaFactoryList* factories() { return &m_factories; }
69
70private:
71 KSycocaFactoryList m_factories;
72 size_t sycoca_size;
73 const char *sycoca_mmap;
74 QFile* m_mmapFile;
75 KSycocaAbstractDevice* m_device;
76};
77
78#endif /* KSYCOCA_P_H */
79
KSycocaAbstractDevice
Definition: ksycocadevices_p.h:26
KSycocaFactoryList
This, instead of a typedef, allows to declare "class ..." in header files.
Definition: ksycocafactory.h:149
KSycocaFactory
Definition: ksycocafactory.h:37
KSycocaPrivate
Definition: ksycoca_p.h:31
KSycocaPrivate::databaseStatus
enum KSycocaPrivate::@7 databaseStatus
KSycocaPrivate::updateSig
quint32 updateSig
Definition: ksycoca_p.h:62
KSycocaPrivate::checkVersion
bool checkVersion()
Definition: ksycoca.cpp:389
KSycocaPrivate::addFactory
void addFactory(KSycocaFactory *factory)
Definition: ksycoca_p.h:65
KSycocaPrivate::language
QString language
Definition: ksycoca_p.h:61
KSycocaPrivate::tryMmap
bool tryMmap()
Definition: ksycoca.cpp:121
KSycocaPrivate::KSycocaPrivate
KSycocaPrivate()
Definition: ksycoca.cpp:86
KSycocaPrivate::timeStamp
quint32 timeStamp
Definition: ksycoca_p.h:57
KSycocaPrivate::BadVersion
@ BadVersion
Definition: ksycoca_p.h:53
KSycocaPrivate::NoDatabase
@ NoDatabase
Definition: ksycoca_p.h:52
KSycocaPrivate::DatabaseOK
@ DatabaseOK
Definition: ksycoca_p.h:54
KSycocaPrivate::DatabaseNotOpen
@ DatabaseNotOpen
Definition: ksycoca_p.h:51
KSycocaPrivate::closeDatabase
void closeDatabase()
Definition: ksycoca.cpp:314
KSycocaPrivate::m_databasePath
QString m_databasePath
Definition: ksycoca_p.h:59
KSycocaPrivate::changeList
QStringList changeList
Definition: ksycoca_p.h:60
KSycocaPrivate::StrategyMemFile
@ StrategyMemFile
Definition: ksycoca_p.h:58
KSycocaPrivate::StrategyMmap
@ StrategyMmap
Definition: ksycoca_p.h:58
KSycocaPrivate::StrategyFile
@ StrategyFile
Definition: ksycoca_p.h:58
KSycocaPrivate::StrategyDummyBuffer
@ StrategyDummyBuffer
Definition: ksycoca_p.h:58
KSycocaPrivate::factories
KSycocaFactoryList * factories()
Definition: ksycoca_p.h:68
KSycocaPrivate::BehaviorIfNotFound
BehaviorIfNotFound
Definition: ksycoca_p.h:36
KSycocaPrivate::IfNotFoundOpenDummy
@ IfNotFoundOpenDummy
Definition: ksycoca_p.h:38
KSycocaPrivate::IfNotFoundRecreate
@ IfNotFoundRecreate
Definition: ksycoca_p.h:39
KSycocaPrivate::IfNotFoundDoNothing
@ IfNotFoundDoNothing
Definition: ksycoca_p.h:37
KSycocaPrivate::device
KSycocaAbstractDevice * device()
Definition: ksycoca.cpp:229
KSycocaPrivate::m_sycocaStrategy
enum KSycocaPrivate::@8 m_sycocaStrategy
KSycocaPrivate::allResourceDirs
QStringList allResourceDirs
Definition: ksycoca_p.h:63
KSycocaPrivate::setStrategyFromString
void setStrategyFromString(const QString &strategy)
Definition: ksycoca.cpp:110
KSycocaPrivate::readError
bool readError
Definition: ksycoca_p.h:55
KSycocaPrivate::stream
QDataStream *& stream()
Definition: ksycoca.cpp:272
KSycocaPrivate::openDatabase
bool openDatabase(bool openDummyIfNotFound=true)
Definition: ksycoca.cpp:189
KSycocaPrivate::checkDatabase
bool checkDatabase(BehaviorsIfNotFound ifNotFound)
Definition: ksycoca.cpp:408
QStringList
QString
quint32
ksycocafactory.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

Skip menu "KDECore"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal