ksquirrel/ksquirrel/ksquirrelpart/sq_libraryhandler.h

/***************************************************************************
                          sq_libraryhandler.h  -  description
                             -------------------
    begin                : Mar 5 2004
    copyright            : (C) 2004 by Baryshev Dmitry
    email                : ksquirrel.iv@gmail.com
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef SQ_LIBRARY_HANDLER_H
#define SQ_LIBRARY_HANDLER_H

#include <tqvaluevector.h>
#include <tqdatetime.h>
#include <tqobject.h>

#include "sq_library.h"

class TQStringList;

class KConfig;
class KURL;

/*
 *  SQ_LibraryHandler is a library manager. It's the main class
 *  in library loading mechanizm. 
 */

class SQ_LibraryHandler : public TQObject, public TQValueVector<SQ_LIBRARY>
{
    public:
        SQ_LibraryHandler(TQObject *parent = 0);
        ~SQ_LibraryHandler();

        enum Support { Maybe = 0, Yes, No };

        /*
        *  Reload libraries from disk
        */
        void reload();

        void sync();

        Support maybeSupported(const KURL &, const TQString& = TQString()) const;

        /*
         *  Find appropriate SQ_LIBRARY by filename. If
         *  not found, return NULL.
         */
        SQ_LIBRARY* libraryForFile(const KURL &);
        SQ_LIBRARY* libraryForFile(const TQString &);

        /*
         *  Find appropriate SQ_LIBRARY by its name. If
         *  not found, return NULL.
         *
         *  Name is a string, returned by fmt_quickinfo()
         */
        SQ_LIBRARY* libraryByName(const TQString &name);

        /*
         *  Does any of found libraries handle given extension ?
         */
        bool knownExtension(const TQString &ext);

        /*
         *  Fill 'filters' with all found filters, and
         *  'quick' with appropriate information.
         */
        void allFilters(TQStringList &filters, TQStringList &quick) const;

        void allWritableFilters(TQStringList &filters, TQStringList &quick) const;

        /*
         *  Get all filters as one string.
         */
        TQString allFiltersString() const;

        /*
         *  Filters as one string suitable for KFileDialogs.
         *  If r == true, return readable codecs
         *  If allfiles == true, append *.* to result
         */
        TQString allFiltersFileDialogString(bool r, bool allfiles = true) const;

        /*
         *  Remove and unload all libraries.
         */
        void clear();

        /*
         *  Print some information on found libraries.
         */
        void dump() const;

        static SQ_LibraryHandler* instance() { return m_instance; }

    private:

        void add(TQStringList &foundLibraries);

        /*
         *  Load libraries from disk.
         */
        void load();
        /*
         *  Is library with name 'quick' already been handled ?
         */
        bool alreadyInMap(const TQString &quick) const;

        void writeSettings(SQ_LIBRARY *lib);
        void readSettings(SQ_LIBRARY *lib);

    private:
        KConfig *kconf;

        static SQ_LibraryHandler *m_instance;
};

#endif