kstandarddirs.h

Go to the documentation of this file.

/*
  This file is part of the KDE libraries
  Copyright (C) 1999 Sirtaj Singh Kang <taj@kde.org>
  Copyright (C) 1999 Stephan Kulow <coolo@kde.org>
  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 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 KSTANDARDDIRS_H
#define KSTANDARDDIRS_H

#include <QtCore/QStringList>
#include <kglobal.h>
#include <QtCore/QMap>

class KConfig;

class KDECORE_EXPORT KStandardDirs
{
public:
    KStandardDirs();

    enum SearchOption { NoSearchOptions = 0,
                        Recursive = 1,
                        NoDuplicates = 2,
                        IgnoreExecBit = 4 };
    Q_DECLARE_FLAGS( SearchOptions, SearchOption )

    
    virtual ~KStandardDirs();

    void addPrefix( const QString& dir );

    void addXdgConfigPrefix( const QString& dir );

    void addXdgDataPrefix( const QString& dir );

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED bool addResourceType( const char *type,
                                         const QString& relativename, bool priority = true );
#endif

    bool addResourceType( const char *type, const char *basetype,
                          const QString& relativename, bool priority = true );

    bool addResourceType( const char *type, const char *basetype,
                          const char* relativename, bool priority = true )
    {
        return addResourceType(type, basetype, QLatin1String(relativename), priority);
    }

    bool addResourceDir( const char *type,
                         const QString& absdir, bool priority = true );

    QString findResource( const char *type,
                          const QString& filename ) const;

    bool isRestrictedResource( const char *type,
                               const QString& relPath=QString() ) const;

    quint32 calcResourceHash( const char *type,
                              const QString& filename,
                              SearchOptions options = NoSearchOptions) const;

    QStringList findDirs( const char *type,
                          const QString& reldir ) const;

    QString findResourceDir( const char *type,
                             const QString& filename) const;


    QStringList findAllResources( const char *type,
                                  const QString& filter = QString(),
                                  SearchOptions options = NoSearchOptions ) const;

    QStringList findAllResources( const char *type,
                                  const QString& filter,
                                  SearchOptions options,
                                  QStringList &relPaths) const;

    static QStringList systemPaths( const QString& pstr=QString() );

    static QString findExe( const QString& appname,
                            const QString& pathstr = QString(),
                            SearchOptions options = NoSearchOptions );

    static int findAllExe( QStringList& list, const QString& appname,
                           const QString& pathstr=QString(),
                           SearchOptions options = NoSearchOptions );

    bool addCustomized(KConfig *config);

    QStringList resourceDirs(const char *type) const;

    QStringList allTypes() const;

    QString saveLocation(const char *type,
                         const QString& suffix = QString(),
                         bool create = true) const;

    QString relativeLocation(const char *type, const QString &absPath);

    static bool makeDir(const QString& dir, int mode = 0755);

#ifndef KDE_NO_DEPRECATED
    static KDE_DEPRECATED QString kde_default(const char *type);
#endif

    QString kfsstnd_prefixes();

    QString kfsstnd_xdg_conf_prefixes();

    QString kfsstnd_xdg_data_prefixes();

    QString localkdedir() const;

    QString localxdgdatadir() const;

    QString localxdgconfdir() const;

    static QString installPath(const char *type);

    static bool exists(const QString &fullPath);

    static QString realPath(const QString &dirname);

    static QString realFilePath(const QString &filename);

    static QString locate( const char *type, const QString& filename, const KComponentData &cData = KGlobal::mainComponent() );

    static QString locateLocal( const char *type, const QString& filename, const KComponentData &cData = KGlobal::mainComponent() );

    static QString locateLocal( const char *type, const QString& filename, bool createDir, const KComponentData &cData = KGlobal::mainComponent() );

    static bool checkAccess(const QString& pathname, int mode);

private:
    // Disallow assignment and copy-construction
    KStandardDirs( const KStandardDirs& );
    KStandardDirs& operator= ( const KStandardDirs& );

    class KStandardDirsPrivate;
    KStandardDirsPrivate* const d;

    // Like their public counter parts but with an extra priority argument
    // If priority is true, the directory is added directly after
    // $KDEHOME/$XDG_DATA_HOME/$XDG_CONFIG_HOME
    void addPrefix( const QString& dir, bool priority );
    void addXdgConfigPrefix( const QString& dir, bool priority );
    void addXdgDataPrefix( const QString& dir, bool priority );
    void addKDEDefaults();

    void addResourcesFrom_krcdirs();
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KStandardDirs::SearchOptions)

#endif // KSTANDARDDIRS_H