klocale_p.h

Go to the documentation of this file.

/*  This file is part of the KDE libraries
 *  Copyright 2009 David Faure <faure@kde.org>
 *  Copyright 2010 John Layt <john@layt.net>
 *
 *  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 KLOCALE_P_H
#define KLOCALE_P_H

#include "klocale.h"

class QMutex;

class KCatalog;
class KDayPeriod;

// Used by both KLocale and KLocalizedString, since they call each other.
QMutex* kLocaleMutex();

class KLocalePrivate
{
public:
    KLocalePrivate(KLocale *q_ptr);

    KLocalePrivate(const KLocalePrivate &rhs);

    KLocalePrivate &operator=(const KLocalePrivate &rhs);

    virtual ~KLocalePrivate();

    /**************************
     **    Initialization    **
     **************************/

    virtual void initFormat();

protected:

    KConfig *config();

    virtual void copy(const KLocalePrivate &rhs);

    virtual void init(const QString& catalogName, const QString &language, const QString &country,
                      KSharedConfig::Ptr persistantconfig, KConfig *tempConfig);

    virtual void initConfig(KConfig *config);

    /**************************
     **   Country settings   **
     **************************/

protected:

    virtual void initCountry(const QString &country, const QString &configCountry);

    virtual QString systemCountry() const;

public:

    virtual bool setCountry(const QString &country, KConfig *config);

    virtual QString country() const;

    static QString defaultCountry();

    virtual QStringList allCountriesList() const;

    virtual QString countryCodeToName(const QString &country) const;

    bool setCountryDivisionCode(const QString & countryDivision);

    QString countryDivisionCode() const;

    /**************************
     **  Language settings   **
     **************************/

protected:

    static void getLanguagesFromVariable(QStringList &list, const char *variable, bool isLanguageList = false);

    virtual QStringList systemLanguageList() const;

    virtual void initLanguageList(const QString &language, const QString &configLanguages, bool useEnv);

    virtual bool useDefaultLanguage() const;

public:

    virtual bool setLanguage(const QString &language, KConfig *config);

    virtual bool setLanguage(const QStringList &languages);

    virtual QString language() const;

    virtual QStringList languageList() const;

    virtual QStringList allLanguagesList();

    virtual QStringList installedLanguages();

    static QString defaultLanguage();

    virtual QString languageCodeToName(const QString &language);

    virtual bool nounDeclension() const;

    static QString langLookup(const QString &fname, const char *rtype = "html");

    virtual bool useTranscript() const;

    /**************************
     **   Catalog settings   **
     **************************/

protected:

    virtual void initMainCatalogs();

    virtual void updateCatalogs();

public:

    static void setMainCatalog(const char *catalog);

    virtual void setActiveCatalog(const QString &catalog);

    virtual void insertCatalog(const QString &catalog);

    virtual void removeCatalog(const QString &catalog);

    virtual void copyCatalogsTo(KLocale *locale);

    virtual void translateRawFrom(const char *catname, const char *msgctxt, const char *msgid, const char *msgid_plural = 0,
                                  unsigned long n = 0, QString *language = 0, QString *translation = 0) const;

    virtual QString translateQt(const char *context, const char *sourceText, const char *comment) const;

    virtual bool isApplicationTranslatedInto(const QString &language);

    /***************************
     **   Calendar settings   **
     ***************************/

protected:

    virtual KLocale::CalendarSystem calendarTypeToCalendarSystem(const QString &calendarType) const;

    virtual QString calendarSystemToCalendarType(KLocale::CalendarSystem) const;

public:

    virtual void setCalendar(const QString &calendarType);

    virtual void setCalendarSystem(KLocale::CalendarSystem);

    virtual QString calendarType() const;

    KLocale::CalendarSystem calendarSystem() const;

    virtual const KCalendarSystem *calendar();

    void setWeekNumberSystem(KLocale::WeekNumberSystem weekNumberSystem);

    KLocale::WeekNumberSystem weekNumberSystem();

    virtual void setWeekStartDay(int day);

    virtual int weekStartDay() const;

    virtual void setWorkingWeekStartDay(int day);

    virtual int workingWeekStartDay() const;

    virtual void setWorkingWeekEndDay(int day);

    virtual int workingWeekEndDay() const;

    virtual void setWeekDayOfPray(int day);

    virtual int weekDayOfPray() const;

    /***************************
     **  Date/Time settings   **
     ***************************/

protected:

    virtual void initDayPeriods(const KConfigGroup &cg);

public:

    virtual void setDateFormat(const QString &format);

    virtual QString dateFormat() const;

    virtual void setDateFormatShort(const QString &format);

    virtual QString dateFormatShort() const;

    virtual void setTimeFormat(const QString &format);

    virtual QString timeFormat() const;

    virtual void setDateTimeDigitSet(KLocale::DigitSet digitSet);

    virtual KLocale::DigitSet dateTimeDigitSet() const;

    virtual void setDateMonthNamePossessive(bool possessive);

    virtual bool dateMonthNamePossessive() const;

    virtual bool use12Clock() const;

    virtual void setDayPeriods(const QList<KDayPeriod> &dayPeriods);

    virtual QList<KDayPeriod> dayPeriods() const;

    virtual KDayPeriod dayPeriodForTime(const QTime &time) const;

    virtual QString formatDate(const QDate &date, KLocale::DateFormat format = KLocale::LongDate);

    virtual QDate readDate(const QString &str, bool *ok = 0);

    virtual QDate readDate(const QString &intstr, const QString &fmt, bool *ok = 0);

    virtual QDate readDate(const QString &str, KLocale::ReadDateFlags flags, bool *ok = 0);

    virtual QString formatTime(const QTime &pTime, bool includeSecs = false, bool isDuration = false) const;

    virtual QString formatLocaleTime(const QTime &pTime, KLocale::TimeFormatOptions options = KLocale::TimeDefault) const;

    virtual QTime readTime(const QString &str, bool *ok = 0) const;

    virtual QTime readTime(const QString &str, KLocale::ReadTimeFlags flags, bool *ok = 0) const;

    virtual QTime readLocaleTime(const QString &str, bool *ok = 0,
                                 KLocale::TimeFormatOptions options = KLocale::TimeDefault,
                                 KLocale::TimeProcessingOptions processing = KLocale::ProcessNonStrict) const;

    static QString formatDateTime(const KLocale *locale, const QDateTime &dateTime, KLocale::DateFormat,
                                  bool includeSeconds, int daysToNow, int secsToNow);

    virtual QString formatDateTime(const QDateTime &dateTime, KLocale::DateFormat format = KLocale::ShortDate,
                                   bool includeSecs = false) const;

    virtual QString formatDateTime(const KDateTime &dateTime, KLocale::DateFormat format = KLocale::ShortDate,
                                   KLocale::DateTimeFormatOptions options = 0);

    virtual QString formatDuration(unsigned long mSec) const;

    virtual QString prettyFormatDuration(unsigned long mSec) const;

    /***************************
     **  Digit Set settings   **
     ***************************/

protected:

    static QString toArabicDigits(const QString &str);

    static QString digitSetString(KLocale::DigitSet digitSet);

public:

    virtual QList<KLocale::DigitSet> allDigitSetsList() const;

    virtual QString digitSetToName(KLocale::DigitSet digitSet, bool withDigits = false) const;

    virtual QString convertDigits(const QString &str, KLocale::DigitSet digitSet, bool ignoreContext = false) const;

    /***************************
     **    Number settings    **
     ***************************/

public:

    virtual void setDecimalPlaces(int digits);

    virtual int decimalPlaces() const;

    virtual void setDecimalSymbol(const QString &symbol);

    virtual QString decimalSymbol() const;

    virtual void setThousandsSeparator(const QString &separator);

    virtual QString thousandsSeparator() const;

    virtual void setNumericDigitGrouping(QList<int> groupList);

    virtual QList<int> numericDigitGrouping() const;

    virtual void setPositiveSign(const QString &sign);

    virtual QString positiveSign() const;

    virtual void setNegativeSign(const QString &sign);

    virtual QString negativeSign() const;

    virtual void setDigitSet(KLocale::DigitSet digitSet);

    virtual KLocale::DigitSet digitSet() const;

    virtual QString formatNumber(double num, int precision = -1) const;

    virtual QString formatNumber(const QString &numStr, bool round = true, int precision = -1) const;

    virtual QString formatLong(long num) const;

    virtual double readNumber(const QString &numStr, bool *ok = 0) const;

    /**************************
     **  Currency settings   **
     **************************/

protected:

    virtual void initCurrency();

public:

    virtual void setCurrencyCode(const QString &newCurrencyCode);

    virtual QString currencyCode() const;

    virtual KCurrencyCode *currency();

    static QString defaultCurrencyCode();

    virtual QStringList currencyCodeList() const;

    /***************************
     **    Money settings     **
     ***************************/

public:

    virtual void setCurrencySymbol(const QString &symbol);

    virtual QString currencySymbol() const;

    virtual void setMonetaryDecimalSymbol(const QString &symbol);

    virtual QString monetaryDecimalSymbol() const;

    virtual void setMonetaryThousandsSeparator(const QString &separator);

    virtual QString monetaryThousandsSeparator() const;

    virtual void setMonetaryDigitGrouping(QList<int> groupList);

    virtual QList<int> monetaryDigitGrouping() const;

    virtual void setMonetaryDecimalPlaces(int digits);

    virtual int monetaryDecimalPlaces() const;

    virtual void setPositivePrefixCurrencySymbol(bool prefix);

    virtual bool positivePrefixCurrencySymbol() const;

    virtual void setNegativePrefixCurrencySymbol(bool prefix);

    virtual bool negativePrefixCurrencySymbol() const;

    virtual void setPositiveMonetarySignPosition(KLocale::SignPosition signpos);

    virtual KLocale::SignPosition positiveMonetarySignPosition() const;

    virtual void setNegativeMonetarySignPosition(KLocale::SignPosition signpos);

    virtual KLocale::SignPosition negativeMonetarySignPosition() const;

    virtual void setMonetaryDigitSet(KLocale::DigitSet digitSet);

    virtual KLocale::DigitSet monetaryDigitSet() const;

    virtual QString formatMoney(double num, const QString &currency = QString(), int precision = -1) const;

    virtual double readMoney(const QString &numStr, bool *ok = 0) const;

    /***************************
     **    Units settings     **
     ***************************/

protected:

    QList<QString> dialectUnitsList(KLocale::BinaryUnitDialect dialect);

    enum DurationType {
        DaysDurationType = 0,
        HoursDurationType,
        MinutesDurationType,
        SecondsDurationType
    };

    static QString formatSingleDuration(KLocalePrivate::DurationType durationType, int n);

public:

   virtual KLocale::BinaryUnitDialect binaryUnitDialect() const;

    virtual void setBinaryUnitDialect(KLocale::BinaryUnitDialect newDialect);

    virtual QString formatByteSize(double size);

    virtual QString formatByteSize(double size, int precision,
                                   KLocale::BinaryUnitDialect dialect = KLocale::DefaultBinaryDialect,
                                   KLocale:: BinarySizeUnits specificUnit = KLocale::DefaultBinaryUnits);

    virtual void setPageSize(int paperFormat);

    virtual int pageSize() const;

    virtual void setMeasureSystem(KLocale::MeasureSystem value);

    virtual KLocale::MeasureSystem measureSystem() const;

    /***************************
     **   Encoding settings   **
     ***************************/

protected:

    virtual void initEncoding();

    virtual void initFileNameEncoding();

    virtual QByteArray systemCodeset() const;

    static QByteArray encodeFileNameUTF8(const QString &fileName);

    static QString decodeFileNameUTF8(const QByteArray &localFileName);

public:

    virtual bool setEncoding(int mibEnum);

    virtual const QByteArray encoding();

    virtual int encodingMib() const;

    virtual int fileEncodingMib() const;

    virtual QTextCodec *codecForEncoding() const;

    /***************************
     **       Utilities       **
     ***************************/

public:

    static void splitLocale(const QString &locale, QString &language, QString &country,
                            QString &modifier, QString &charset);

    virtual QString localizedFilePath(const QString &filePath) const;

    virtual QString removeAcceleratorMarker(const QString &label) const;

private:

    QList<int> digitGroupFormatToList(const QString &digitGroupFormat) const;

    QString formatDigitGroup(const QString &number, const QString &groupSeparator, const QString &decimalSeperator, QList<int> groupList) const;

    QString parseDigitGroup(const QString &number, const QString &groupSeparator, const QString &decimalSeperator, QList<int> groupList, bool *ok) const;

public:
    // Parent KLocale, public needed for copy ctor
    KLocale *q;

private:
    // Config file containing locale config
    KSharedConfig::Ptr m_config;

    // Country settings
    QString m_country;
    QString m_countryDivisionCode;

    // Language settings
    QString      m_language;
    KConfig     *m_languages;
    QStringList  m_languageList;
    bool         m_languageSensitiveDigits;  // FIXME: Temporary until full language-sensitivity implemented.
    bool         m_nounDeclension;

    // Catalog settings
    QString             m_catalogName;          // catalogName ("app name") used by this KLocale object
    QList<KCatalogName> m_catalogNames;         // list of all catalogs (regardless of language)
    QList<KCatalog>     m_catalogs;             // list of all found catalogs, one instance per catalog name and language
    int                 m_numberOfSysCatalogs;  // number of catalogs that each app draws from
    bool                m_useTranscript;        // indicates if scripted messages are to be executed

    // Calendar settings
    KLocale::CalendarSystem m_calendarSystem;
    KCalendarSystem *m_calendar;
    KLocale::WeekNumberSystem m_weekNumberSystem;
    int              m_weekStartDay;
    int              m_workingWeekStartDay;
    int              m_workingWeekEndDay;
    int              m_weekDayOfPray;

    // Date/Time settings
    QString           m_dateFormat;
    QString           m_dateFormatShort;
    QString           m_timeFormat;
    KLocale::DigitSet m_dateTimeDigitSet;
    bool              m_dateMonthNamePossessive;
    mutable QList<KDayPeriod> m_dayPeriods;

    // Number settings
    int               m_decimalPlaces;
    QString           m_decimalSymbol;
    QString           m_thousandsSeparator;
    QList<int>        m_numericDigitGrouping;
    QString           m_positiveSign;
    QString           m_negativeSign;
    KLocale::DigitSet m_digitSet;

    // Currency settings
    QString        m_currencyCode;
    KCurrencyCode *m_currency;
    QStringList    m_currencyCodeList;

    // Money settings
    QString               m_currencySymbol;
    QString               m_monetaryDecimalSymbol;
    QString               m_monetaryThousandsSeparator;
    QList<int>            m_monetaryDigitGrouping;
    int                   m_monetaryDecimalPlaces;
    KLocale::SignPosition m_positiveMonetarySignPosition;
    KLocale::SignPosition m_negativeMonetarySignPosition;
    bool                  m_positivePrefixCurrencySymbol;
    bool                  m_negativePrefixCurrencySymbol;
    KLocale::DigitSet     m_monetaryDigitSet;

    // Units settings
    KLocale::BinaryUnitDialect m_binaryUnitDialect;
    QList<QString>             m_byteSizeFmt;
    int                        m_pageSize;
    KLocale::MeasureSystem     m_measureSystem;

    // Encoding settings
    QString     m_encoding;
    QTextCodec *m_codecForEncoding;
    bool        m_utf8FileEncoding;
};

#endif /* KLOCALE_P_H */