usesnavigationcontext.cpp Source File

Skip to content
Skip to link menu

kdevplatform/language/duchain

Go to the documentation of this file.

 /*
    Copyright 2008 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.
  */
  
 #include "usesnavigationcontext.h"
  
 #include "useswidget.h"
 #include <KLocalizedString>
 #include <language/duchain/declaration.h>
 #include <language/duchain/duchain.h>
 #include <language/duchain/duchainlock.h>
  
 using namespace KDevelop;
  
 UsesNavigationContext::UsesNavigationContext(IndexedDeclaration declaration, AbstractNavigationContext* previousContext)
     : AbstractNavigationContext(TopDUContextPointer(), previousContext)
     , m_declaration(declaration)
 {
     m_widget = new UsesWidget(m_declaration);
 }
  
 UsesNavigationContext::~UsesNavigationContext()
 {
     delete m_widget;
 }
  
 QString UsesNavigationContext::name() const
 {
     return QStringLiteral("Uses");
 }
  
 QString UsesNavigationContext::html(bool shorten)
 {
     Q_UNUSED(shorten);
     clear();
     modifyHtml()  += QStringLiteral("<html><body><p>");
  
     if (auto context = previousContext()) {
         modifyHtml() += navigationHighlight(i18n("Uses of "));
         makeLink(context->name(), context->name(), NavigationAction(context));
     } else {
         KDevelop::DUChainReadLocker lock(DUChain::lock());
         if (Declaration* decl = m_declaration.data()) {
             makeLink(i18n("Uses of %1", decl->toString()), DeclarationPointer(
                          decl), NavigationAction::NavigateDeclaration);
         }
     }
  
     modifyHtml() += QStringLiteral("</p></body></html>");
  
     return currentHtml();
 }
  
 QWidget* UsesNavigationContext::widget() const
 {
     return m_widget;
 }

KDevelop::DUChainReadLocker

Customized read locker for the definition-use chain.

Definition: duchainlock.h:114

KDevelop::UsesNavigationContext::html

QString html(bool shorten) override

Here the context can return html to be displayed.

Definition: usesnavigationcontext.cpp:46

KDevelop::AbstractNavigationContext::currentHtml

QString currentHtml() const

Returns the html text being built in its current state.

Definition: abstractnavigationcontext.cpp:587

KDevelop::DUChain::lock

static DUChainLock * lock()

Retrieve the read write lock for the entire definition-use chain.

Definition: duchain.cpp:1283

KDevelop::UsesNavigationContext::~UsesNavigationContext

~UsesNavigationContext() override

Definition: usesnavigationcontext.cpp:36

KDevelop::UsesWidget

A widget that allows browsing through all the uses of a declaration, and also through all declaration...

Definition: useswidget.h:154

KDevelop::DUChainPointer< TopDUContext >

KDevelop::UsesNavigationContext::widget

QWidget * widget() const override

Here the context can return a widget to be displayed.

Definition: usesnavigationcontext.cpp:68

KDevelop::Declaration

Represents a single declaration in a definition-use chain.

Definition: declaration.h:51

KDevelop::AbstractNavigationContext::makeLink

virtual void makeLink(const QString &name, const DeclarationPointer &declaration, NavigationAction::Type actionType)

Creates and registers a link to the given declaration, labeled by the given name.

Definition: abstractnavigationcontext.cpp:93

KDevelop::IndexedDeclaration

Represents a declaration only by its global indices.

Definition: indexeddeclaration.h:33

KDevelop::NavigationAction

Definition: navigationaction.h:31

KDevelop::AbstractNavigationContext::clear

void clear()

Definition: abstractnavigationcontext.cpp:146

KDevelop::AbstractNavigationContext::modifyHtml

TextHandler modifyHtml()

Returns a convenience object that allows writing "modifyHtml() += "Hallo";".

Definition: abstractnavigationcontext.h:139

KDevelop::AbstractNavigationContext::navigationHighlight

static const Colorizer navigationHighlight

Definition: abstractnavigationcontext.h:167

KDevelop::NavigationAction::NavigateDeclaration

Definition: navigationaction.h:35

KDevelop::IndexedDeclaration::data

Declaration * data() const

Definition: indexeddeclaration.h:47

KDevelop::AbstractNavigationContext

Definition: abstractnavigationcontext.h:64

usesnavigationcontext.h

Definition: abstractfunctiondeclaration.cpp:27

KDevelop::UsesNavigationContext::name

QString name() const override

Definition: usesnavigationcontext.cpp:41

KDevelop::UsesNavigationContext::UsesNavigationContext

UsesNavigationContext(KDevelop::IndexedDeclaration declaration, AbstractNavigationContext *previousContext=nullptr)

Definition: usesnavigationcontext.cpp:29

KDevelop::AbstractNavigationContext::previousContext

AbstractNavigationContext * previousContext() const

Definition: abstractnavigationcontext.cpp:253

KDevelop::DeclarationPointer

DUChainPointer< Declaration > DeclarationPointer

Definition: duchainpointer.h:200

This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Oct 25 2021 23:31:48 by doxygen 1.8.16 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Skip menu "kdevplatform/language/duchain"

Skip menu "kdevelop API Reference"

Search