KDevelop API Documentation

CTagsPart Class Reference

CTags (http://ctags.sourceforge.net) is a source navigation tool with support for many languages. More...

#include <ctagspart.h>

Inheritance diagram for CTagsPart:

KDevPlugin QObject KXMLGUIClient List of all members.

Public Member Functions

 CTagsPart (QObject *parent, const char *name, const QStringList &)
 ~CTagsPart ()
bool ensureTagsLoaded ()
bool loadTagsFile ()
bool createTagsFile ()
CTagsMap tags ()
QStringList kindStrings ()

Private Slots

void projectClosed ()
void contextMenu (QPopupMenu *popup, const Context *context)
void slotSearchTags ()
void slotGotoDeclaration ()
void slotGotoDefinition ()
void slotGotoTag (QListBoxItem *item)

Private Member Functions

void gotoTag (const QString &tag, const QString &kindChars)
void gotoFinalTag (const QString &contextStr)

Private Attributes

CTagsDialogm_dialog
CTagsMapm_tags
QStringList m_kindStrings
QString m_contextString
OccuresTagsDlgmOccuresTagsDlg

Detailed Description

CTags (http://ctags.sourceforge.net) is a source navigation tool with support for many languages.

Author(s):
Bernd Gehrmann

Feature(s):
Provides a context menu for finding type declarations/definitions.

Provides query dialog in the Tools menu.

When more than one declaration/definition is found, presets a dialog so that the user can select which one to goto.

Bug:
bugs in ctags part component at Bugzilla database

Can not detect CTags version that well.

Requirement(s):
CTags >= 5.0

Definition at line 40 of file ctagspart.h.


Constructor & Destructor Documentation

CTagsPart::CTagsPart QObject parent,
const char *  name,
const QStringList
 

CTagsPart::~CTagsPart  ) 
 

Definition at line 69 of file ctagspart.cpp.

References m_dialog, m_tags, and mOccuresTagsDlg.


Member Function Documentation

void CTagsPart::contextMenu QPopupMenu popup,
const Context context
[private, slot]
 

Definition at line 88 of file ctagspart.cpp.

References contextMenu(), EditorContext::currentWord(), Context::hasType(), m_contextString, slotGotoDeclaration(), and slotGotoDefinition().

Referenced by contextMenu().

bool CTagsPart::createTagsFile  ) 
 

Definition at line 296 of file ctagspart.cpp.

References KDevProject::allFiles(), KTempFile::close(), endl(), kdDebug(), KTempFile::name(), KDevPlugin::project(), KProcess::setWorkingDirectory(), KProcess::start(), and KTempFile::textStream().

Referenced by ensureTagsLoaded(), and CTagsDialog::slotRegenerate().

bool CTagsPart::ensureTagsLoaded  ) 
 

Definition at line 193 of file ctagspart.cpp.

References createTagsFile(), endl(), kdDebug(), loadTagsFile(), m_tags, main(), KDevPlugin::mainWindow(), and KDevPlugin::project().

Referenced by gotoTag(), and slotSearchTags().

void CTagsPart::gotoFinalTag const QString contextStr  )  [private]
 

Definition at line 151 of file ctagspart.cpp.

References KDevPartController::editDocument(), gotoFinalTag(), mOccuresTagsDlg, and KDevPlugin::partController().

Referenced by gotoFinalTag(), gotoTag(), and slotGotoTag().

void CTagsPart::gotoTag const QString tag,
const QString kindChars
[private]
 

Definition at line 110 of file ctagspart.cpp.

References CTagsMapIterator, CTagsTagInfoListConstIterator, ensureTagsLoaded(), gotoFinalTag(), gotoTag(), m_tags, mOccuresTagsDlg, and OccuresTagsDlg::mOcurresList.

Referenced by gotoTag(), slotGotoDeclaration(), and slotGotoDefinition().

QStringList CTagsPart::kindStrings  )  [inline]
 

Definition at line 54 of file ctagspart.h.

References m_kindStrings.

Referenced by CTagsDialog::updateInfo().

bool CTagsPart::loadTagsFile  ) 
 

Definition at line 218 of file ctagspart.cpp.

References CTagsTagInfoList, endl(), file, CTagsTagInfo::fileName, kdDebug(), CTagsTagInfo::kind, m_kindStrings, m_tags, CTagsTagInfo::pattern, KDevPlugin::project(), and tags().

Referenced by ensureTagsLoaded(), and CTagsDialog::slotRegenerate().

void CTagsPart::projectClosed  )  [private, slot]
 

Definition at line 77 of file ctagspart.cpp.

References m_dialog, m_tags, and mOccuresTagsDlg.

void CTagsPart::slotGotoDeclaration  )  [private, slot]
 

Definition at line 169 of file ctagspart.cpp.

References gotoTag(), and m_contextString.

Referenced by contextMenu().

void CTagsPart::slotGotoDefinition  )  [private, slot]
 

Definition at line 175 of file ctagspart.cpp.

References gotoTag(), and m_contextString.

Referenced by contextMenu().

void CTagsPart::slotGotoTag QListBoxItem item  )  [private, slot]
 

Definition at line 145 of file ctagspart.cpp.

References gotoFinalTag(), and slotGotoTag().

Referenced by slotGotoTag().

void CTagsPart::slotSearchTags  )  [private, slot]
 

Definition at line 181 of file ctagspart.cpp.

References ensureTagsLoaded(), and m_dialog.

CTagsMap CTagsPart::tags  )  [inline]
 

Definition at line 52 of file ctagspart.h.

References CTagsMap, and m_tags.

Referenced by loadTagsFile(), and CTagsDialog::updateInfo().


Member Data Documentation

QString CTagsPart::m_contextString [private]
 

Definition at line 72 of file ctagspart.h.

Referenced by contextMenu(), slotGotoDeclaration(), and slotGotoDefinition().

CTagsDialog* CTagsPart::m_dialog [private]
 

Definition at line 69 of file ctagspart.h.

Referenced by projectClosed(), slotSearchTags(), and ~CTagsPart().

QStringList CTagsPart::m_kindStrings [private]
 

Definition at line 71 of file ctagspart.h.

Referenced by kindStrings(), and loadTagsFile().

CTagsMap* CTagsPart::m_tags [private]
 

Definition at line 70 of file ctagspart.h.

Referenced by ensureTagsLoaded(), gotoTag(), loadTagsFile(), projectClosed(), tags(), and ~CTagsPart().

OccuresTagsDlg* CTagsPart::mOccuresTagsDlg [private]
 

Definition at line 74 of file ctagspart.h.

Referenced by gotoFinalTag(), gotoTag(), projectClosed(), and ~CTagsPart().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.0.4.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Oct 6 17:39:22 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003