abstractnavigationcontext.h

Go to the documentation of this file.

/*
   Copyright 2007 David Nolden <[email protected]>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.
 
   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 KDEVPLATFORM_ABSTRACTNAVIGATIONCONTEXT_H
#define KDEVPLATFORM_ABSTRACTNAVIGATIONCONTEXT_H
 
#include <QExplicitlySharedDataPointer>
 
#include <language/languageexport.h>
#include "../indexeddeclaration.h"
#include "navigationaction.h"
 
namespace KDevelop {
class AbstractNavigationContextPrivate;
 
struct KDEVPLATFORMLANGUAGE_EXPORT Colorizer
{
    enum FormattingFlag {
        Nothing = 0x0,
        Bold = 0x1,
        Italic = 0x2,
        Fixed = 0x4
    };
    Q_DECLARE_FLAGS(Formatting, FormattingFlag)
    explicit Colorizer(const QString& color, Formatting formatting = Nothing)
        : m_color(color)
        , m_formatting(formatting)
    {
    }
 
    QString operator()(const QString& str) const;
 
    QString m_color;
    Formatting m_formatting;
};
 
#if QT_VERSION >= QT_VERSION_CHECK(5, 12, 0)
Q_DECLARE_OPERATORS_FOR_FLAGS(Colorizer::Formatting)
#endif
 
class AbstractNavigationContext;
using NavigationContextPointer = QExplicitlySharedDataPointer<AbstractNavigationContext>;
 
class KDEVPLATFORMLANGUAGE_EXPORT AbstractNavigationContext
    : public QObject
    , public QSharedData
{
    Q_OBJECT
 
public:
    explicit AbstractNavigationContext(const TopDUContextPointer& topContext = TopDUContextPointer(),
                                       AbstractNavigationContext* previousContext = nullptr);
    ~AbstractNavigationContext() override;
 
    int linkCount() const;
    bool nextLink();
    bool previousLink();
    bool up();
    bool down();
    void resetNavigation();
 
    NavigationContextPointer accept();
    NavigationContextPointer back();
    NavigationContextPointer accept(IndexedDeclaration decl);
    NavigationContextPointer acceptLink(const QString& link);
    NavigationAction currentAction() const;
 
    virtual QString name() const = 0;
    virtual QString html(bool shorten = false);
    virtual QWidget* widget() const;
 
    virtual bool isWidgetMaximized() const;
 
    bool alreadyComputed() const;
 
    TopDUContextPointer topContext() const;
    void setTopContext(const TopDUContextPointer& context);
 
    void executeLink(const QString& link);
    NavigationContextPointer execute(const NavigationAction& action);
 
Q_SIGNALS:
    void contentsChanged();
 
protected:
    AbstractNavigationContext* previousContext() const;
    virtual void setPreviousContext(AbstractNavigationContext* previousContext);
 
    struct TextHandler
    {
        explicit TextHandler(AbstractNavigationContext* c) : context(c)
        {
        }
        void operator+=(const QString& str) const
        {
            context->addHtml(str);
        }
        AbstractNavigationContext* context;
    };
 
    virtual NavigationContextPointer executeKeyAction(const QString& key);
 
    void addHtml(const QString& html);
    QString currentHtml() const;
    TextHandler modifyHtml()
    {
        return TextHandler(this);
    }
 
    //Clears the computed html and links
    void clear();
 
    virtual void makeLink(const QString& name, const DeclarationPointer& declaration,
                          NavigationAction::Type actionType);
 
    void makeLink(const QString& name, const QString& targetId, const NavigationAction& action);
 
    QString createLink(const QString& name, const QString& targetId, const NavigationAction& action);
 
    NavigationContextPointer registerChild(const DeclarationPointer& /*declaration*/);
    NavigationContextPointer registerChild(AbstractNavigationContext* context);
 
    virtual QString declarationKind(const DeclarationPointer& decl);
 
    static const Colorizer typeHighlight;
    static const Colorizer errorHighlight;
    static const Colorizer labelHighlight;
    static const Colorizer codeHighlight;
    static const Colorizer propertyHighlight;
    static const Colorizer navigationHighlight;
    static const Colorizer importantHighlight;
    static const Colorizer commentHighlight;
    static const Colorizer nameHighlight;
 
private:
    const QScopedPointer<class AbstractNavigationContextPrivate> d_ptr;
    Q_DECLARE_PRIVATE(AbstractNavigationContext)
};
 
}
 
#if QT_VERSION < QT_VERSION_CHECK(5, 12, 0)
Q_DECLARE_OPERATORS_FOR_FLAGS(KDevelop::Colorizer::Formatting)
#endif
 
#endif