tdeconfigbackend.h

/*
   This file is part of the KDE libraries
   Copyright (c) 1999 Preston Brown <pbrown@kde.org>
   Portions copyright (c) 1997 Matthias Kalle Dalheimer <kalle@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 as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   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 _TDECONFIGBACKEND_H
#define _TDECONFIGBACKEND_H
 
#include "tdeconfigdata.h"
#include <tdeconfigbase.h>
#include <klockfile.h>
#include <tdelocale.h>
#include "tdelibs_export.h"
 
class TQFile;
class TDEConfigBackEndPrivate;
 
class TDECORE_EXPORT TDEConfigBackEnd
{
  friend class TDEConfig;
  friend class TDESharedConfig;
public:
  TDEConfigBackEnd(TDEConfigBase *_config, const TQString &_fileName,
         const char * _resType, bool _useKDEGlobals);
 
  virtual ~TDEConfigBackEnd();
 
  virtual bool parseConfigFiles() = 0;
 
  virtual void sync(bool bMerge = true) = 0;
 
  void changeFileName(const TQString &_fileName, const char * _resType,
              bool _useKDEGlobals);
 
  virtual TDEConfigBase::ConfigState getConfigState() const
    { return mConfigState; }
 
  TQString fileName() const { return mfileName; }
 
  const char * resource() const { return resType; }
 
  void setLocaleString(const TQCString &_localeString) { localeString = _localeString; }
 
  void setFileWriteMode(int mode);
 
  bool checkConfigFilesWritable(bool warnUser);
 
  TDELockFile::Ptr lockFile( bool bGlobal = false );
 
#ifdef KDE_NO_COMPAT
private:
#endif
  TDE_DEPRECATED TQString filename() const { return mfileName; }
 
protected:
  TDEConfigBase *pConfig;
 
  TQString mfileName;
  TQCString resType;
  bool useKDEGlobals : 1;
  bool bFileImmutable : 1;
  TQCString localeString;
  TQString mLocalFileName;
  TQString mGlobalFileName;
  TDEConfigBase::ConfigState mConfigState;
  int mFileMode;
 
protected:
  virtual void virtual_hook( int id, void* data );
protected:
  class TDEConfigBackEndPrivate;
  TDEConfigBackEndPrivate *d;
};
 
 
class TDECORE_EXPORT TDEConfigINIBackEnd : public TDEConfigBackEnd
{
 
public:
  TDEConfigINIBackEnd(TDEConfigBase *_config, const TQString &_fileName,
            const char * _resType, bool _useKDEGlobals = true)
    : TDEConfigBackEnd(_config, _fileName, _resType, _useKDEGlobals) {}
 
  virtual ~TDEConfigINIBackEnd() {}
 
  bool parseConfigFiles();
 
  virtual void sync(bool bMerge = true);
 
protected:
  void parseSingleConfigFile(TQFile& rFile, KEntryMap *pWriteBackMap = 0L,
                 bool bGlobal = false, bool bDefault = false);
 
  // Kubuntu patch, 2006-08-03
  // looks up a key in with TDELocale
  // see https://launchpad.net/distros/ubuntu/+spec/langpacks-desktopfiles-kde
  void translateKey(TDELocale& locale, TQCString currentGroup, TQCString key);
 
  bool writeConfigFile(TQString filename, bool bGlobal = false, bool bMerge = true);
 
  bool getEntryMap(KEntryMap &map, bool bGlobal, TQFile *mergeFile);
 
  void writeEntries(FILE *pStream, const KEntryMap &aTempMap);
 
protected:
  virtual void virtual_hook( int id, void* data );
private:
  class TDEConfigINIBackEndPrivate;
  TDEConfigINIBackEndPrivate *not_d;
};
 
#endif