kstandarddirs.h

/*
  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 <tqstring.h>
#include <tqdict.h>
#include <tqstringlist.h>
#include <tdeglobal.h>
 
class TDEConfig;
class TDEStandardDirsPrivate;

class TDECORE_EXPORT TDEStandardDirs
{
public:
    TDEStandardDirs( );

    virtual ~TDEStandardDirs();

    void addPrefix( const TQString& dir );

    void addXdgConfigPrefix( const TQString& dir );

    void addXdgDataPrefix( const TQString& dir );

    bool addResourceType( const char *type,
                  const TQString& relativename );

    bool addResourceDir( const char *type,
                 const TQString& absdir);

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

    bool isRestrictedResource( const char *type,
                  const TQString& relPath=TQString::null ) const;

    TQ_UINT32 calcResourceHash( const char *type,
                  const TQString& filename, bool deep) const;

    TQStringList findDirs( const char *type,
                              const TQString& reldir ) const;

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

    TQStringList findAllResources( const char *type,
                       const TQString& filter = TQString::null,
                       bool recursive = false,
                       bool unique = false) const;

    TQStringList findAllResources( const char *type,
                       const TQString& filter,
                       bool recursive,
                       bool unique,
                       TQStringList &relPaths) const;

    static TQStringList systemPaths( const TQString& pstr=TQString::null );

    static TQString findExe( const TQString& appname,
                const TQString& pathstr=TQString::null,
                bool ignoreExecBit=false );

    static int findAllExe( TQStringList& list, const TQString& appname,
                   const TQString& pathstr=TQString::null,
                   bool ignoreExecBit=false );

    void addKDEDefaults();

    bool addCustomized(TDEConfig *config);

    TQStringList resourceDirs(const char *type) const;

    TQStringList allTypes() const;

     TQString saveLocation(const char *type,
                  const TQString& suffix = TQString::null,
                  bool create = true) const;

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

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

    static TQString kde_default(const char *type);

    TQString kfsstnd_prefixes();

    TQString kfsstnd_xdg_conf_prefixes();

    TQString kfsstnd_xdg_data_prefixes();

    TQString localtdedir() const;

    static TQString kfsstnd_defaultprefix();

    static TQString kfsstnd_defaultbindir();

    TQString localxdgdatadir() const;

    TQString localxdgconfdir() const;

    static bool exists(const TQString &fullPath);

    static TQString realPath(const TQString &dirname);

    static TQString realFilePath(const TQString &filename);
 
 private:
 
    TQStringList prefixes;
 
    // Directory dictionaries
    TQDict<TQStringList> absolutes;
    TQDict<TQStringList> relatives;
 
    mutable TQDict<TQStringList> dircache;
    mutable TQDict<TQString> savelocations;
 
    // Disallow assignment and copy-construction
    TDEStandardDirs( const TDEStandardDirs& );
    TDEStandardDirs& operator= ( const TDEStandardDirs& );
 
    bool addedCustoms;
 
    class TDEStandardDirsPrivate;
    TDEStandardDirsPrivate *d;
 
    void checkConfig() const;
    void applyDataRestrictions(const TQString &) const;
    void createSpecialResource(const char*);
 
        // Like their public counter parts but with an extra priority argument
        // If priority is true, the directory is added directly after
        // $TDEHOME/$XDG_DATA_HOME/$XDG_CONFIG_HOME
    void addPrefix( const TQString& dir, bool priority );
    void addXdgConfigPrefix( const TQString& dir, bool priority );
    void addXdgDataPrefix( const TQString& dir, bool priority );
 
    // If priority is true, the directory is added before any other,
    // otherwise after
    bool addResourceType( const char *type,
                  const TQString& relativename, bool priority );
    bool addResourceDir( const char *type,
                 const TQString& absdir, bool priority);
};


TDECORE_EXPORT TQString locate( const char *type, const TQString& filename, const TDEInstance* instance = TDEGlobal::instance() );

TDECORE_EXPORT TQString locateLocal( const char *type, const TQString& filename, const TDEInstance* instance = TDEGlobal::instance() );

TDECORE_EXPORT TQString locateLocal( const char *type, const TQString& filename, bool createDir, const TDEInstance* instance = TDEGlobal::instance() );

 
#endif // _KSTANDARDDIRS_H