Skip to main content :: ::

KDE API Reference

:: Skip to Link Menu

/ API Reference / kdecore

kconfigbase.cpp // -*- c-basic-offset: 2 -*- /* This file is part of the KDE libraries Copyright (c) 1999 Preston Brown <pbrown@kde.org> 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. */ #include <stdlib.h> #include <string.h> #include <qfile.h> #include <qdir.h> #include <qtextstream.h> #include <kapplication.h> #include <kglobal.h> #include <klocale.h> #include <kcharsets.h> #include "kconfigbase.h" #include "kconfigbackend.h" #include "kdebug.h" #include "kstandarddirs.h" #include "kstringhandler.h" class KConfigBase::KConfigBasePrivate { public: KConfigBasePrivate() : readDefaults(false) { }; public: bool readDefaults; }; KConfigBase::KConfigBase() : backEnd(0L), bDirty(false), bLocaleInitialized(false), bReadOnly(false), bExpand(false), d(0) { setGroup(QString::null); } KConfigBase::~KConfigBase() { delete d; } void KConfigBase::setLocale() { bLocaleInitialized = true; if (KGlobal::locale()) aLocaleString = KGlobal::locale()->language().utf8(); else aLocaleString = KLocale::defaultLanguage().utf8(); if (backEnd) backEnd->setLocaleString(aLocaleString); } QString KConfigBase::locale() const { return QString::fromUtf8(aLocaleString); } void KConfigBase::setGroup( const QString& group ) { if ( group.isEmpty() ) mGroup = "<default>"; else mGroup = group.utf8(); } void KConfigBase::setGroup( const char *pGroup ) { setGroup(QCString(pGroup)); } void KConfigBase::setGroup( const QCString &group ) { if ( group.isEmpty() ) mGroup = "<default>"; else mGroup = group; } QString KConfigBase::group() const { return QString::fromUtf8(mGroup); } void KConfigBase::setDesktopGroup() { mGroup = "Desktop Entry"; } bool KConfigBase::hasKey(const QString &key) const { return hasKey(key.utf8().data()); } bool KConfigBase::hasKey(const char *pKey) const { KEntryKey aEntryKey(mGroup, 0); aEntryKey.c_key = pKey; aEntryKey.bDefault = readDefaults(); if (!locale().isNull()) { // try the localized key first aEntryKey.bLocal = true; KEntry entry = lookupData(aEntryKey); if (!entry.mValue.isNull()) return true; aEntryKey.bLocal = false; } // try the non-localized version KEntry entry = lookupData(aEntryKey); return !entry.mValue.isNull(); } bool KConfigBase::hasGroup(const QString &group) const { return internalHasGroup( group.utf8()); } bool KConfigBase::hasGroup(const char *_pGroup) const { return internalHasGroup( QCString(_pGroup)); } bool KConfigBase::hasGroup(const QCString &_pGroup) const { return internalHasGroup( _pGroup); } bool KConfigBase::isImmutable() const { return (getConfigState() != ReadWrite); } bool KConfigBase::groupIsImmutable(const QString &group) const { if (getConfigState() != ReadWrite) return true; KEntryKey groupKey(group.utf8(), 0); KEntry entry = lookupData(groupKey); return entry.bImmutable; } bool KConfigBase::entryIsImmutable(const QString &key) const { if (getConfigState() != ReadWrite) return true; KEntryKey entryKey(mGroup, 0); KEntry aEntryData = lookupData(entryKey); // Group if (aEntryData.bImmutable) return true; QCString utf8_key = key.utf8(); entryKey.c_key = utf8_key.data(); aEntryData = lookupData(entryKey); // Normal entry if (aEntryData.bImmutable) return true; entryKey.bLocal = true; aEntryData = lookupData(entryKey); // Localized entry return aEntryData.bImmutable; } QString KConfigBase::readEntryUntranslated( const QString& pKey, const QString& aDefault ) const { return KConfigBase::readEntryUntranslated(pKey.utf8().data(), aDefault); } QString KConfigBase::readEntryUntranslated( const char *pKey, const QString& aDefault ) const { QCString result = readEntryUtf8(pKey); if (result.isNull()) return aDefault; return QString::fromUtf8(result); } QString KConfigBase::readEntry( const QString& pKey, const QString& aDefault ) const { return KConfigBase::readEntry(pKey.utf8().data(), aDefault); } QString KConfigBase::readEntry( const char *pKey, const QString& aDefault ) const { // we need to access _locale instead of the method locale() // because calling locale() will create a locale object if it // doesn't exist, which requires KConfig, which will create a infinite // loop, and nobody likes those. if (!bLocaleInitialized && KGlobal::_locale) { // get around const'ness. KConfigBase *that = const_cast<KConfigBase *>(this); that->setLocale(); } QString aValue; bool expand = false; // construct a localized version of the key // try the localized key first KEntry aEntryData; KEntryKey entryKey(mGroup, 0); entryKey.c_key = pKey; entryKey.bDefault = readDefaults(); entryKey.bLocal = true; aEntryData = lookupData(entryKey); if (!aEntryData.mValue.isNull()) { // for GNOME .desktop aValue = KStringHandler::from8Bit( aEntryData.mValue.data() ); expand = aEntryData.bExpand; } else { entryKey.bLocal = false; aEntryData = lookupData(entryKey); if (!aEntryData.mValue.isNull()) { aValue = QString::fromUtf8(aEntryData.mValue.data()); if (aValue.isNull()) { static const QString &emptyString = KGlobal::staticQString(""); aValue = emptyString; } expand = aEntryData.bExpand; } else { aValue = aDefault; } } // only do dollar expansion if so desired if( expand || bExpand ) { // check for environment variables and make necessary translations int nDollarPos = aValue.find( '$' ); while( nDollarPos != -1 && nDollarPos+1 < static_cast<int>(aValue.length())) { // there is at least one $ if( (aValue)[nDollarPos+1] == '(' ) { uint nEndPos = nDollarPos+1; // the next character is no $ while ( (nEndPos <= aValue.length()) && (aValue[nEndPos]!=')') ) nEndPos++; nEndPos++; QString cmd = aValue.mid( nDollarPos+2, nEndPos-nDollarPos-3 ); QString result; FILE *fs = popen(QFile::encodeName(cmd).data(), "r"); if (fs) { { QTextStream ts(fs, IO_ReadOnly); result = ts.read().stripWhiteSpace(); } pclose(fs); } aValue.replace( nDollarPos, nEndPos-nDollarPos, result ); } else if( (aValue)[nDollarPos+1] != '$' ) { uint nEndPos = nDollarPos+1; // the next character is no $ QString aVarName; if (aValue[nEndPos]=='{') { while ( (nEndPos <= aValue.length()) && (aValue[nEndPos]!='}') ) nEndPos++; nEndPos++; aVarName = aValue.mid( nDollarPos+2, nEndPos-nDollarPos-3 ); } else { while ( nEndPos <= aValue.length() && (aValue[nEndPos].isNumber() || aValue[nEndPos].isLetter() || aValue[nEndPos]=='_' ) ) nEndPos++; aVarName = aValue.mid( nDollarPos+1, nEndPos-nDollarPos-1 ); } const char* pEnv = 0; if (!aVarName.isEmpty()) pEnv = getenv( aVarName.ascii() ); if( pEnv ) { // !!! Sergey A. Sukiyazov <corwin@micom.don.ru> !!! // A environment variables may contain values in 8bit // locale cpecified encoding or in UTF8 encoding. aValue.replace( nDollarPos, nEndPos-nDollarPos, KStringHandler::from8Bit( pEnv ) ); } else aValue.remove( nDollarPos, nEndPos-nDollarPos ); } else { // remove one of the dollar signs aValue.remove( nDollarPos, 1 ); nDollarPos++; } nDollarPos = aValue.find( '$', nDollarPos ); } } return aValue; } QCString KConfigBase::readEntryUtf8( const char *pKey) const { // We don't try the localized key KEntryKey entryKey(mGroup, 0); entryKey.bDefault = readDefaults(); entryKey.c_key = pKey; KEntry aEntryData = lookupData(entryKey); if (aEntryData.bExpand) { // We need to do fancy, take the slow route. return readEntry(pKey, QString::null).utf8(); } return aEntryData.mValue; } QVariant KConfigBase::readPropertyEntry( const QString& pKey, QVariant::Type type ) const { return readPropertyEntry(pKey.utf8().data(), type); } QVariant KConfigBase::readPropertyEntry( const char *pKey, QVariant::Type type ) const { QVariant va; if ( !hasKey( pKey ) ) return va; (void)va.cast(type); return readPropertyEntry(pKey, va); } QVariant KConfigBase::readPropertyEntry( const QString& pKey, const QVariant &aDefault ) const { return readPropertyEntry(pKey.utf8().data(), aDefault); } QVariant KConfigBase::readPropertyEntry( const char *pKey, const QVariant &aDefault ) const { if ( !hasKey( pKey ) ) return aDefault; QVariant tmp = aDefault; switch( aDefault.type() ) { case QVariant::Invalid: return QVariant(); case QVariant::String: return QVariant( readEntry( pKey, aDefault.toString() ) ); case QVariant::StringList: return QVariant( readListEntry( pKey ) ); case QVariant::List: { QStringList strList = readListEntry( pKey ); QStringList::ConstIterator it = strList.begin(); QStringList::ConstIterator end = strList.end(); QValueList<QVariant> list; for (; it != end; ++it ) { tmp = *it; list.append( tmp ); } return QVariant( list ); } case QVariant::Font: return QVariant( readFontEntry( pKey, &tmp.asFont() ) ); case QVariant::Point: return QVariant( readPointEntry( pKey, &tmp.asPoint() ) ); case QVariant::Rect: return QVariant( readRectEntry( pKey, &tmp.asRect() ) ); case QVariant::Size: return QVariant( readSizeEntry( pKey, &tmp.asSize() ) ); case QVariant::Color: return QVariant( readColorEntry( pKey, &tmp.asColor() ) ); case QVariant::Int: return QVariant( readNumEntry( pKey, aDefault.toInt() ) ); case QVariant::UInt: return QVariant( readUnsignedNumEntry( pKey, aDefault.toUInt() ) ); case QVariant::LongLong: return QVariant( readNum64Entry( pKey, aDefault.toLongLong() ) ); case QVariant::ULongLong: return QVariant( readUnsignedNum64Entry( pKey, aDefault.toULongLong() ) ); case QVariant::Bool: return QVariant( readBoolEntry( pKey, aDefault.toBool() ), 0 ); case QVariant::Double: return QVariant( readDoubleNumEntry( pKey, aDefault.toDouble() ) ); case QVariant::DateTime: return QVariant( readDateTimeEntry( pKey, &tmp.asDateTime() ) ); case QVariant::Date: return QVariant(readDateTimeEntry( pKey, &tmp.asDateTime() ).date()); case QVariant::Pixmap: case QVariant::Image: case QVariant::Brush: case QVariant::Palette: case QVariant::ColorGroup: case QVariant::Map: case QVariant::IconSet: case QVariant::CString: case QVariant::PointArray: case QVariant::Region: case QVariant::Bitmap: case QVariant::Cursor: case QVariant::SizePolicy: case QVariant::Time: case QVariant::ByteArray: case QVariant::BitArray: case QVariant::KeySequence: case QVariant::Pen: break; } Q_ASSERT( 0 ); return QVariant(); } int KConfigBase::readListEntry( const QString& pKey, QStrList &list, char sep ) const { return readListEntry(pKey.utf8().data(), list, sep); } int KConfigBase::readListEntry( const char *pKey, QStrList &list, char sep ) const { if( !hasKey( pKey ) ) return 0; QCString str_list = readEntryUtf8( pKey ); if (str_list.isEmpty()) return 0; list.clear(); QCString value = ""; int len = str_list.length(); for (int i = 0; i < len; i++) { if (str_list[i] != sep && str_list[i] != '\\') { value += str_list[i]; continue; } if (str_list[i] == '\\') { i++; if ( i < len ) value += str_list[i]; continue; } // if we fell through to here, we are at a separator. Append // contents of value to the list // !!! Sergey A. Sukiyazov <corwin@micom.don.ru> !!! // A QStrList may contain values in 8bit locale cpecified // encoding list.append( value ); value.truncate(0); } if ( str_list[len-1] != sep || ( len > 1 && str_list[len-2] == '\\' ) ) list.append( value ); return list.count(); } QStringList KConfigBase::readListEntry( const QString& pKey, char sep ) const { return readListEntry(pKey.utf8().data(), sep); } QStringList KConfigBase::readListEntry( const char *pKey, char sep ) const { static const QString& emptyString = KGlobal::staticQString(""); QStringList list; if( !hasKey( pKey ) ) return list; QString str_list = readEntry( pKey ); if( str_list.isEmpty() ) return list; QString value(emptyString); int len = str_list.length(); // obviously too big, but faster than letting each += resize the string. value.reserve( len ); for( int i = 0; i < len; i++ ) { if( str_list[i] != sep && str_list[i] != '\\' ) { value += str_list[i]; continue; } if( str_list[i] == '\\' ) { i++; if ( i < len ) value += str_list[i]; continue; } QString finalvalue( value ); finalvalue.squeeze(); list.append( finalvalue ); value.truncate( 0 ); } if ( str_list[len-1] != sep || ( len > 1 && str_list[len-2] == '\\' ) ) { value.squeeze(); list.append( value ); } return list; } QStringList KConfigBase::readListEntry( const char* pKey, const QStringList& aDefault, char sep ) const { if ( !hasKey( pKey ) ) return aDefault; else return readListEntry( pKey, sep ); } QValueList<int> KConfigBase::readIntListEntry( const QString& pKey ) const { return readIntListEntry(pKey.utf8().data()); } QValueList<int> KConfigBase::readIntListEntry( const char *pKey ) const { QStringList strlist = readListEntry(pKey); QValueList<int> list; QStringList::ConstIterator end(strlist.end()); for (QStringList::ConstIterator it = strlist.begin(); it != end; ++it) // I do not check if the toInt failed because I consider the number of items // more important than their value list << (*it).toInt(); return list; } QString KConfigBase::readPathEntry( const QString& pKey, const QString& pDefault ) const { return readPathEntry(pKey.utf8().data(), pDefault); } QString KConfigBase::readPathEntry( const char *pKey, const QString& pDefault ) const { const bool bExpandSave = bExpand; bExpand = true; QString aValue = readEntry( pKey, pDefault ); bExpand = bExpandSave; return aValue; } QStringList KConfigBase::readPathListEntry( const QString& pKey, char sep ) const { return readPathListEntry(pKey.utf8().data(), sep); } QStringList KConfigBase::readPathListEntry( const char *pKey, char sep ) const { const bool bExpandSave = bExpand; bExpand = true; QStringList aValue = readListEntry( pKey, sep ); bExpand = bExpandSave; return aValue; } int KConfigBase::readNumEntry( const QString& pKey, int nDefault) const { return readNumEntry(pKey.utf8().data(), nDefault); } int KConfigBase::readNumEntry( const char *pKey, int nDefault) const { QCString aValue = readEntryUtf8( pKey ); if( aValue.isNull() ) return nDefault; else if( aValue == "true" || aValue == "on" || aValue == "yes" ) return 1; else { bool ok; int rc = aValue.toInt( &ok ); return( ok ? rc : nDefault ); } } unsigned int KConfigBase::readUnsignedNumEntry( const QString& pKey, unsigned int nDefault) const { return readUnsignedNumEntry(pKey.utf8().data(), nDefault); } unsigned int KConfigBase::readUnsignedNumEntry( const char *pKey, unsigned int nDefault) const { QCString aValue = readEntryUtf8( pKey ); if( aValue.isNull() ) return nDefault; else { bool ok; unsigned int rc = aValue.toUInt( &ok ); return( ok ? rc : nDefault ); } } long KConfigBase::readLongNumEntry( const QString& pKey, long nDefault) const { return readLongNumEntry(pKey.utf8().data(), nDefault); } long KConfigBase::readLongNumEntry( const char *pKey, long nDefault) const { QCString aValue = readEntryUtf8( pKey ); if( aValue.isNull() ) return nDefault; else { bool ok; long rc = aValue.toLong( &ok ); return( ok ? rc : nDefault ); } } unsigned long KConfigBase::readUnsignedLongNumEntry( const QString& pKey, unsigned long nDefault) const { return readUnsignedLongNumEntry(pKey.utf8().data(), nDefault); } unsigned long KConfigBase::readUnsignedLongNumEntry( const char *pKey, unsigned long nDefault) const { QCString aValue = readEntryUtf8( pKey ); if( aValue.isNull() ) return nDefault; else { bool ok; unsigned long rc = aValue.toULong( &ok ); return( ok ? rc : nDefault ); } } Q_INT64 KConfigBase::readNum64Entry( const QString& pKey, Q_INT64 nDefault) const { return readNum64Entry(pKey.utf8().data(), nDefault); } Q_INT64 KConfigBase::readNum64Entry( const char *pKey, Q_INT64 nDefault) const { // Note that QCString::toLongLong() is missing, we muse use a QString instead. QString aValue = readEntry( pKey ); if( aValue.isNull() ) return nDefault; else { bool ok; Q_INT64 rc = aValue.toLongLong( &ok ); return( ok ? rc : nDefault ); } } Q_UINT64 KConfigBase::readUnsignedNum64Entry( const QString& pKey, Q_UINT64 nDefault) const { return readUnsignedNum64Entry(pKey.utf8().data(), nDefault); } Q_UINT64 KConfigBase::readUnsignedNum64Entry( const char *pKey, Q_UINT64 nDefault) const { // Note that QCString::toULongLong() is missing, we muse use a QString instead. QString aValue = readEntry( pKey ); if( aValue.isNull() ) return nDefault; else { bool ok; Q_UINT64 rc = aValue.toULongLong( &ok ); return( ok ? rc : nDefault ); } } double KConfigBase::readDoubleNumEntry( const QString& pKey, double nDefault) const { return readDoubleNumEntry(pKey.utf8().data(), nDefault); } double KConfigBase::readDoubleNumEntry( const char *pKey, double nDefault) const { QCString aValue = readEntryUtf8( pKey ); if( aValue.isNull() ) return nDefault; else { bool ok; double rc = aValue.toDouble( &ok ); return( ok ? rc : nDefault ); } } bool KConfigBase::readBoolEntry( const QString& pKey, bool bDefault ) const { return readBoolEntry(pKey.utf8().data(), bDefault); } bool KConfigBase::readBoolEntry( const char *pKey, bool bDefault ) const { QCString aValue = readEntryUtf8( pKey ); if( aValue.isNull() ) return bDefault; else { if( aValue == "true" || aValue == "on" || aValue == "yes" || aValue == "1" ) return true; else { bool bOK; int val = aValue.toInt( &bOK ); if( bOK && val != 0 ) return true; else return false; } } } QFont KConfigBase::readFontEntry( const QString& pKey, const QFont* pDefault ) const { return readFontEntry(pKey.utf8().data(), pDefault); } QFont KConfigBase::readFontEntry( const char *pKey, const QFont* pDefault ) const { QFont aRetFont; QString aValue = readEntry( pKey ); if( !aValue.isNull() ) { if ( aValue.contains( ',' ) > 5 ) { // KDE3 and upwards entry if ( !aRetFont.fromString( aValue ) && pDefault ) aRetFont = *pDefault; } else { // backward compatibility with older font formats // ### remove KDE 3.1 ? // find first part (font family) int nIndex = aValue.find( ',' ); if( nIndex == -1 ){ if( pDefault ) aRetFont = *pDefault; return aRetFont; } aRetFont.setFamily( aValue.left( nIndex ) ); // find second part (point size) int nOldIndex = nIndex; nIndex = aValue.find( ',', nOldIndex+1 ); if( nIndex == -1 ){ if( pDefault ) aRetFont = *pDefault; return aRetFont; } aRetFont.setPointSize( aValue.mid( nOldIndex+1, nIndex-nOldIndex-1 ).toInt() ); // find third part (style hint) nOldIndex = nIndex; nIndex = aValue.find( ',', nOldIndex+1 ); if( nIndex == -1 ){ if( pDefault ) aRetFont = *pDefault; return aRetFont; } aRetFont.setStyleHint( (QFont::StyleHint)aValue.mid( nOldIndex+1, nIndex-nOldIndex-1 ).toUInt() ); // find fourth part (char set) nOldIndex = nIndex; nIndex = aValue.find( ',', nOldIndex+1 ); if( nIndex == -1 ){ if( pDefault ) aRetFont = *pDefault; return aRetFont; } QString chStr=aValue.mid( nOldIndex+1, nIndex-nOldIndex-1 ); // find fifth part (weight) nOldIndex = nIndex; nIndex = aValue.find( ',', nOldIndex+1 ); if( nIndex == -1 ){ if( pDefault ) aRetFont = *pDefault; return aRetFont; } aRetFont.setWeight( aValue.mid( nOldIndex+1, nIndex-nOldIndex-1 ).toUInt() ); // find sixth part (font bits) uint nFontBits = aValue.right( aValue.length()-nIndex-1 ).toUInt(); aRetFont.setItalic( nFontBits & 0x01 ); aRetFont.setUnderline( nFontBits & 0x02 ); aRetFont.setStrikeOut( nFontBits & 0x04 ); aRetFont.setFixedPitch( nFontBits & 0x08 ); aRetFont.setRawMode( nFontBits & 0x20 ); } } else { if( pDefault ) aRetFont = *pDefault; } return aRetFont; } QRect KConfigBase::readRectEntry( const QString& pKey, const QRect* pDefault ) const { return readRectEntry(pKey.utf8().data(), pDefault); } QRect KConfigBase::readRectEntry( const char *pKey, const QRect* pDefault ) const { QCString aValue = readEntryUtf8(pKey); if (!aValue.isEmpty()) { int left, top, width, height; if (sscanf(aValue.data(), "%d,%d,%d,%d", &left, &top, &width, &height) == 4) { return QRect(left, top, width, height); } } if (pDefault) return *pDefault; return QRect(); } QPoint KConfigBase::readPointEntry( const QString& pKey, const QPoint* pDefault ) const { return readPointEntry(pKey.utf8().data(), pDefault); } QPoint KConfigBase::readPointEntry( const char *pKey, const QPoint* pDefault ) const { QCString aValue = readEntryUtf8(pKey); if (!aValue.isEmpty()) { int x,y; if (sscanf(aValue.data(), "%d,%d", &x, &y) == 2) { return QPoint(x,y); } } if (pDefault) return *pDefault; return QPoint(); } QSize KConfigBase::readSizeEntry( const QString& pKey, const QSize* pDefault ) const { return readSizeEntry(pKey.utf8().data(), pDefault); } QSize KConfigBase::readSizeEntry( const char *pKey, const QSize* pDefault ) const { QCString aValue = readEntryUtf8(pKey); if (!aValue.isEmpty()) { int width,height; if (sscanf(aValue.data(), "%d,%d", &width, &height) == 2) { return QSize(width, height); } } if (pDefault) return *pDefault; return QSize(); } QColor KConfigBase::readColorEntry( const QString& pKey, const QColor* pDefault ) const { return readColorEntry(pKey.utf8().data(), pDefault); } QColor KConfigBase::readColorEntry( const char *pKey, const QColor* pDefault ) const {