kdevdocumentationplugin.h

/* This file is part of the KDE project
   Copyright (C) 2004 by Alexander Dymo <cloudtemple@mksat.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 KDEV_DOC_PLUGIN_H
#define KDEV_DOC_PLUGIN_H
 
#include <tqmap.h>
#include <tqvaluelist.h>
#include <tqpair.h>
 
#include <tdelistbox.h>
#include <tdelistview.h>
#include <kurl.h>
#include <tdefile.h>
 
#define CACHE_VERSION "3"

class DocumentationItem: public TDEListViewItem
{
public:
    enum Type {
        Collection    ,
        Catalog       ,
        Book          ,
        Document      
    };
 
    DocumentationItem(Type type, TDEListView *parent, const TQString &name);
    DocumentationItem(Type type, TDEListView *parent, TDEListViewItem *after, const TQString &name);
    DocumentationItem(Type type, TDEListViewItem *parent, const TQString &name);
    DocumentationItem(Type type, TDEListViewItem *parent, TDEListViewItem *after, const TQString &name);
 
    virtual void setURL(const KURL &url) { m_url = url; }
    virtual KURL url() const { return m_url; }
 
    Type type() const { return m_type; }
 
    void setType(Type t) { 
        if(t != m_type) {
            m_type = t;
            init();
        }
    }
private:
    void init();
 
    KURL m_url;
    Type m_type;
};
 
class DocumentationPlugin;

class DocumentationCatalogItem: public DocumentationItem
{
public:
    DocumentationCatalogItem(DocumentationPlugin* plugin, TDEListView *parent, TDEListViewItem *after, const TQString &name);
    DocumentationCatalogItem(DocumentationPlugin* plugin, DocumentationItem *parent, const TQString &name);
    virtual ~DocumentationCatalogItem();
 
    DocumentationPlugin* plugin() const { return m_plugin; }
 
    virtual void setOpen(bool o);
    void load();
 
    virtual bool isProjectDocumentationItem() const { return m_isProjectDocumentationItem; }
    virtual void setProjectDocumentationItem(bool b) { m_isProjectDocumentationItem = b; }
 
    virtual TQString cacheVersion() const { return ""; } 
    
protected:
    virtual void activate();
 
private:
    DocumentationPlugin* m_plugin;
    bool isLoaded;
    bool isActivated;
    bool m_isProjectDocumentationItem;
};
 
class IndexBox;

class IndexItemProto
{
public:
    IndexItemProto(DocumentationPlugin *plugin, DocumentationCatalogItem *catalog, IndexBox *listbox,
        const TQString &text, const TQString &description);
    ~IndexItemProto();
 
    void addURL(const KURL &url) { m_url = url; }
    KURL url() const { return m_url; }
    TQString text() const { return m_text; }
    TQString description() const { return m_description; }
 
private:
    KURL m_url;
    IndexBox *m_listbox;
    TQString m_text;
    TQString m_description;
};

class IndexItem: public TQListBoxText {
public:
    typedef TQPair<TQString, KURL> URL;
    typedef TQValueList<URL> List;
 
    IndexItem(IndexBox *listbox, const TQString &text);
 
    List urls() const;
 
private:
    IndexBox *m_listbox;
};

class IndexBox: public TDEListBox{
public:
    IndexBox(TQWidget *parent = 0, const char *name = 0);
 
    virtual void addIndexItem(IndexItemProto *item);
    virtual void removeIndexItem(IndexItemProto *item);
    virtual void fill();
    virtual void refill();
    virtual void setDirty(bool dirty);
//    virtual void refill(TQValueList<IndexItemProto*> &items);
 
private:
    TQMap<TQString, TQValueList<IndexItemProto*> > items;
    friend class IndexItem;
 
    bool m_dirty;
};
 
class TQPainter;
class TQColorGroup;
class TQFontMetrics;
class DocumentationPlugin;

class ConfigurationItem: public TQCheckListItem
{
public:
    ConfigurationItem(TQListView *parent, DocumentationPlugin * plugin, const TQString &title, const TQString &url,
        bool indexPossible, bool fullTextSearchPossible);
 
    virtual TQString title() const { return m_title; }
    virtual void setTitle(const TQString title) { setText(3, m_title = title); }
    virtual TQString url() const { return m_url; }
    virtual void setURL(const TQString url) { setText(4, m_url = url); }
 
    virtual bool isChanged() const { return m_title == m_origTitle; }
    virtual TQString origTitle() const {return m_origTitle; }
 
    virtual void paintCell(TQPainter *p, const TQColorGroup &cg, int column, int width, int align);
    virtual int width(const TQFontMetrics &fm, const TQListView *lv, int c) const;
 
    bool contents() const { return m_contents; }
    void setContents(bool contents) { m_contents = contents; }
    bool index() const { return m_index; }
    void setIndex(bool index) { m_index = index; }
    bool fullTextSearch() const { return m_fullTextSearch; }
    void setFullTextSearch(bool fullTextSearch) { m_fullTextSearch = fullTextSearch; }
 
    bool indexPossible() const { return m_indexPossible; }
    bool fullTextSearchPossible() const { return m_fullTextSearchPossible; }
 
    DocumentationPlugin * docPlugin() { return m_docPlugin; }
 
private:
    TQString m_title;
    TQString m_url;
    TQString m_origTitle;
 
    bool m_contents;
    bool m_index;
    bool m_fullTextSearch;
 
    bool m_indexPossible;
    bool m_fullTextSearchPossible;
 
    DocumentationPlugin * m_docPlugin;
};
 
 
class ProjectDocumentationPlugin;

class DocumentationPlugin: public TQObject
{
    TQ_OBJECT
  
public:
    enum Capability { Index=1 ,
                      FullTextSearch=2 ,
                      ProjectDocumentation=8 ,
                      ProjectUserManual=16  };

    enum ProjectDocType { APIDocs, UserManual };

    DocumentationPlugin(TDEConfig *pluginConfig, TQObject *parent =0, const char *name =0);
    virtual ~DocumentationPlugin();

    virtual TQString pluginName() const = 0;

    virtual DocumentationCatalogItem *createCatalog(TDEListView *contents, TDEListViewItem *after, const TQString &title, const TQString &url) = 0;

    virtual void init(TDEListView *contents);
    virtual void reinit(TDEListView *contents, IndexBox *index, TQStringList restrictions);
    virtual void autoSetup();
    virtual void autoSetupPlugin() = 0;

    virtual bool catalogEnabled(const TQString &name) const;
    virtual void setCatalogEnabled(const TQString &name, bool e);

    virtual bool needRefreshIndex(DocumentationCatalogItem *item) = 0;
    virtual bool indexEnabled(DocumentationCatalogItem *item) const;
    virtual void setIndexEnabled(DocumentationCatalogItem *item, bool e);
    virtual void createIndex(IndexBox *index, DocumentationCatalogItem *item) = 0;

    virtual void createTOC(DocumentationCatalogItem *item) = 0;
    virtual void setCatalogURL(DocumentationCatalogItem *item) = 0;
    virtual TQStringList fullTextSearchLocations() = 0;

    virtual void loadCatalogConfiguration(TDEListView *configurationView);
    virtual void saveCatalogConfiguration(TDEListView *configurationView);
    virtual void addCatalogConfiguration(TDEListView *configurationView,
        const TQString &title, const TQString &url);
    virtual void editCatalogConfiguration(ConfigurationItem *configurationItem,
        const TQString &title, const TQString &url);
    virtual void deleteCatalogConfiguration(const ConfigurationItem *const configurationItem);

    virtual TQPair<KFile::Mode, TQString> catalogLocatorProps() = 0;
    virtual TQString catalogTitle(const TQString &url) = 0;

    virtual void clear();

    bool hasCapability(Capability cap) const { return m_capabilities & cap; }

    void setDirtyIndex(bool dirty) { m_indexCreated = dirty; }

    virtual void cacheIndex(DocumentationCatalogItem *item);
    virtual bool loadCachedIndex(IndexBox *index, DocumentationCatalogItem *item);

    virtual ProjectDocumentationPlugin *projectDocumentationPlugin(ProjectDocType /* type */) { return 0; }
 
public slots:
    virtual void createIndex(IndexBox *index);
 
protected:
    TQValueList<DocumentationCatalogItem*> catalogs;
    TQMap<TQString, DocumentationCatalogItem*> namedCatalogs;
    TQMap<DocumentationCatalogItem*, TQValueList<IndexItemProto*> > indexes;

    void setCapabilities(int caps) { m_capabilities = caps; }
    virtual void clearCatalogIndex(DocumentationCatalogItem *item);
    void loadIndex(IndexBox *index, DocumentationCatalogItem *item);

    TDEListViewItem* findCatalogPosition(const TQString &key, const TDEListView *contents) const;

    TQStringList deletedConfigurationItems;

    TDEConfig *config;
 
private:
    virtual void addCatalog(DocumentationCatalogItem *item);
    virtual void clearCatalog(DocumentationCatalogItem *item);
 
    int m_capabilities;
    bool m_indexCreated;
 
 
friend class IndexItemProto;
friend class DocumentationCatalogItem;
};
 

class ProjectDocumentationPlugin: public TQObject {
    TQ_OBJECT
  
public:
    ProjectDocumentationPlugin(DocumentationPlugin *docPlugin, DocumentationPlugin::ProjectDocType type);
    virtual ~ProjectDocumentationPlugin();

    virtual void init(TDEListView *contents, IndexBox *index, const TQString &url);
    virtual void deinit();
 
    TQString pluginName() const;
    TQString catalogURL() const;
 
public slots:
    virtual void reinit();
 
protected:
    TDEListViewItem* findCatalogPosition(const TQString &key, const TDEListView *contents) const;
    
    DocumentationPlugin *m_docPlugin;
    DocumentationCatalogItem *m_catalog;
 
private:
    DocumentationPlugin::ProjectDocType m_type;
 
    class KDirWatch *m_watch;
    class TDEListView *m_contents;
    class IndexBox *m_index;
    TQString m_url;
};
 
#endif