• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdevelop API Reference
  • KDE Home
  • Contact Us
 

kdevplatform/language/duchain

  • KDevelop
  • IndexedTopDUContext
Public Types | Public Member Functions | List of all members
KDevelop::IndexedTopDUContext Class Reference

#include <indexedtopducontext.h>

Public Types

enum  { DummyMask = 1u << 31u }
 

Public Member Functions

 IndexedTopDUContext (TopDUContext *context=nullptr)
 
 IndexedTopDUContext (uint index)
 
TopDUContext * data () const
 
QPair< ushort, ushort > dummyData () const
 
uint index () const
 
bool isDummy () const
 
bool isLoaded () const
 
bool isValid () const
 
bool operator!= (const IndexedTopDUContext &rhs) const
 
bool operator< (const IndexedTopDUContext &rhs) const
 
bool operator== (const IndexedTopDUContext &rhs) const
 
void setDummyData (ushort first, ushort second)
 
void setIsDummy (bool isDummy)
 
IndexedString url () const
 

Detailed Description

Allows simple indirect access to top-contexts with on-demand loading.

Definition at line 35 of file indexedtopducontext.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
DummyMask 

Definition at line 45 of file indexedtopducontext.h.

Constructor & Destructor Documentation

◆ IndexedTopDUContext() [1/2]

KDevelop::IndexedTopDUContext::IndexedTopDUContext ( uint  index)
inline

Definition at line 38 of file indexedtopducontext.h.

◆ IndexedTopDUContext() [2/2]

IndexedTopDUContext::IndexedTopDUContext ( TopDUContext *  context = nullptr)

Definition at line 25 of file indexedtopducontext.cpp.

Member Function Documentation

◆ data()

TopDUContext * IndexedTopDUContext::data ( ) const

Returns the top-context represented by this indexed top-context.

If it wasn't loaded yet, it is loaded.

The duchain must be read-locked when this is called! To prevent it from being unloaded, store it into a ReferencedTopDUContext before releasing the duchain lock.

Definition at line 49 of file indexedtopducontext.cpp.

◆ dummyData()

QPair<ushort, ushort> KDevelop::IndexedTopDUContext::dummyData ( ) const
inline

The data previously set through setDummyData().

Initially 0.

Definition at line 122 of file indexedtopducontext.h.

◆ index()

uint KDevelop::IndexedTopDUContext::index ( ) const
inline

Definition at line 85 of file indexedtopducontext.h.

◆ isDummy()

bool KDevelop::IndexedTopDUContext::isDummy ( ) const
inline

Definition at line 93 of file indexedtopducontext.h.

◆ isLoaded()

bool IndexedTopDUContext::isLoaded ( ) const

Returns whether the top-context is currently loaded.

If not, it will be loaded when you call data().

Definition at line 33 of file indexedtopducontext.cpp.

◆ isValid()

bool KDevelop::IndexedTopDUContext::isValid ( ) const
inline

Definition at line 80 of file indexedtopducontext.h.

◆ operator!=()

bool KDevelop::IndexedTopDUContext::operator!= ( const IndexedTopDUContext &  rhs) const
inline

Definition at line 70 of file indexedtopducontext.h.

◆ operator<()

bool KDevelop::IndexedTopDUContext::operator< ( const IndexedTopDUContext &  rhs) const
inline

Definition at line 75 of file indexedtopducontext.h.

◆ operator==()

bool KDevelop::IndexedTopDUContext::operator== ( const IndexedTopDUContext &  rhs) const
inline

Definition at line 65 of file indexedtopducontext.h.

◆ setDummyData()

void KDevelop::IndexedTopDUContext::setDummyData ( ushort  first,
ushort  second 
)
inline

Allows giving this IndexedTopDUContext some data while logically keeping it invalid.

It will still return zero on index(), data(), etc.

Parameters
firstThe highest of this value bit will be removed.

Definition at line 113 of file indexedtopducontext.h.

◆ setIsDummy()

void KDevelop::IndexedTopDUContext::setIsDummy ( bool  isDummy)
inline

Definition at line 98 of file indexedtopducontext.h.

◆ url()

IndexedString IndexedTopDUContext::url ( ) const

Definition at line 41 of file indexedtopducontext.cpp.


The documentation for this class was generated from the following files:
  • indexedtopducontext.h
  • indexedtopducontext.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Thu Mar 4 2021 23:31:18 by doxygen 1.8.16 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kdevplatform/language/duchain

Skip menu "kdevplatform/language/duchain"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdevelop API Reference

Skip menu "kdevelop API Reference"
  • kdevplatform
  •   debugger
  •   documentation
  •   interfaces
  •   language
  •     assistant
  •     backgroundparser
  •     checks
  •     classmodel
  •     codecompletion
  •     codegen
  •     duchain
  •     editor
  •     highlighting
  •     interfaces
  •     util
  •   outputview
  •   project
  •   serialization
  •   shell
  •   sublime
  •   tests
  •   util
  •   vcs

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal