tdesycoca.h

/*  This file is part of the KDE libraries
 *  Copyright (C) 1999 Waldo Bastian <bastian@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 __tdesycoca_h__
#define __tdesycoca_h__
 
#include <dcopobject.h>
#include <tqobject.h>
#include <tqstringlist.h>
#include "tdesycocatype.h"
#include <tdelibs_export.h>
 
class TQDataStream;
class KSycocaPrivate;
class KSycocaFactory;
class KSycocaFactoryList;
 
/*
 * Sycoca file version number.
 * If the existing file is outdated, it will not get read
 * but instead we'll ask kded to regenerate a new one...
*/
#define TDESYCOCA_VERSION 94
 
class TDECORE_EXPORT KSycoca : public TQObject, public DCOPObject
{
  TQ_OBJECT
  K_DCOP
 
protected:
   KSycoca( bool /* buildDatabase */ );
 
public:
 
   KSycoca();
 
   static KSycoca *self();
 
   virtual ~KSycoca();
 
   static int version();
 
   TQDataStream *findEntry(int offset, KSycocaType &type);
   TQDataStream *findFactory( KSycocaFactoryId id);
   TQString kfsstnd_prefixes();
   TQString language();
 
   TQ_UINT32 timeStamp();
 
   TQ_UINT32 updateSignature();
 
   TQStringList allResourceDirs();
 
   void addFactory( KSycocaFactory * );
 
   virtual bool isBuilding() { return false; }
 
   void disableAutoRebuild();
 
   static TQString determineRelativePath( const TQString & _fullpath, const char *_resource );
 
   static bool isChanged(const char *type);
 
   static void flagError();
 
   static bool readError();
 
k_dcop:
   void notifyDatabaseChanged(const TQStringList &);
 
signals:
   void databaseChanged();
 
protected:
   bool checkVersion(bool abortOnError=true);
   bool openDatabase(bool openDummyIfNotFound=true);
   void closeDatabase();
   KSycocaFactoryList *m_lstFactories;
   TQDataStream *m_str;
   TQByteArray *m_barray;
   bool bNoDatabase;
   size_t m_sycoca_size;
   const char *m_sycoca_mmap;
   TQ_UINT32 m_timeStamp;
 
public:
   static KSycoca *_self; // Internal use only.
 
protected:
  virtual void virtual_hook( int id, void* data );
private:
   KSycocaPrivate *d;
};
 
#endif