ksycoca.h

Go to the documentation of this file.

/*  This file is part of the KDE libraries
 *  Copyright (C) 1999 Waldo Bastian <bastian@kde.org>
 *  Copyright (C) 2005-2008 David Faure <faure@kde.org>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License version 2 as published by the Free Software Foundation;
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public License
 *  along with this library; see the file COPYING.LIB.  If not, write to
 *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 **/

#ifndef KSYCOCA_H
#define KSYCOCA_H

#include <kdecore_export.h>
#include <ksycocatype.h>

#include <QtCore/QObject>
#include <QtCore/QStringList>

class QDataStream;
class KSycocaFactory;
class KSycocaFactoryList;
class KSycocaPrivate;

#define KBUILDSYCOCA_EXENAME "kbuildsycoca4"

class KDECORE_EXPORT KSycoca : public QObject
{
  Q_OBJECT
  //Q_CLASSINFO("D-Bus Interface", "org.kde.KSycoca")

protected:
   explicit KSycoca( bool /* buildDatabase */ );

public:
   typedef enum { LocalDatabase, GlobalDatabase } DatabaseType;

   KSycoca();

   static KSycoca *self();

   virtual ~KSycoca();

   static int version();

   static bool isAvailable();

   QDataStream *findEntry(int offset, KSycocaType &type);
   QDataStream *findFactory(KSycocaFactoryId id);
   QString kfsstnd_prefixes();
   static QString absoluteFilePath(DatabaseType type=LocalDatabase);
   QString language();

   quint32 timeStamp();

   quint32 updateSignature();

   QStringList allResourceDirs();

   void addFactory( KSycocaFactory * );

   virtual bool isBuilding();

   static void disableAutoRebuild();

#ifndef KDE_NO_DEPRECATED
   static KDE_DEPRECATED bool isChanged(const char *type);
#endif

   static void flagError();

#ifndef KDE_NO_DEPRECATED
   static KDE_DEPRECATED bool readError();
#endif

Q_SIGNALS:
#ifndef KDE_NO_DEPRECATED
    QT_MOC_COMPAT void databaseChanged(); // KDE5 TODO: remove
#endif

    void databaseChanged(const QStringList& changedResources);

protected:
    // @internal used by kbuildsycoca
    KSycocaFactoryList* factories();

    // @internal was for kbuildsycoca
#ifndef KDE_NO_DEPRECATED
    QDataStream *m_str_deprecated; // KDE5: REMOVE
#endif
    // @internal used by factories and kbuildsycoca
    QDataStream*& stream();
    friend class KSycocaFactory;
    friend class KSycocaDict;

private Q_SLOTS:
    void notifyDatabaseChanged(const QStringList &);

private:
    static void clearCaches();
    friend class KBuildSycoca;
    friend class Kded;

    Q_DISABLE_COPY(KSycoca)
    friend class KSycocaPrivate;
    KSycocaPrivate * const d;
};

#endif