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:

Inheritance graph
[legend]
Collaboration diagram for CTagsPart:

Collaboration graph
[legend]
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 70 of file ctagspart.cpp.


Member Function Documentation

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

Definition at line 89 of file ctagspart.cpp.

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

bool CTagsPart::createTagsFile  ) 
 

Definition at line 298 of file ctagspart.cpp.

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

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

bool CTagsPart::ensureTagsLoaded  ) 
 

Definition at line 195 of file ctagspart.cpp.

References createTagsFile(), kdDebug(), loadTagsFile(), main(), KDevPlugin::mainWindow(), KDevPlugin::project(), KMessageBox::questionYesNo(), and KMessageBox::sorry().

Referenced by gotoTag(), and slotSearchTags().

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

Definition at line 153 of file ctagspart.cpp.

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

Referenced by gotoTag(), and slotGotoTag().

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

Definition at line 112 of file ctagspart.cpp.

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

Referenced by slotGotoDeclaration(), and slotGotoDefinition().

QStringList CTagsPart::kindStrings  )  [inline]
 

Definition at line 54 of file ctagspart.h.

Referenced by CTagsDialog::updateInfo().

bool CTagsPart::loadTagsFile  ) 
 

Definition at line 220 of file ctagspart.cpp.

References CTagsMap, CTagsMapIterator, CTagsTagInfoList, file, CTagsTagInfo::fileName, CTagsKinds::findKind(), 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 78 of file ctagspart.cpp.

References m_dialog, m_tags, and mOccuresTagsDlg.

void CTagsPart::slotGotoDeclaration  )  [private, slot]
 

Definition at line 171 of file ctagspart.cpp.

References gotoTag(), and m_contextString.

Referenced by contextMenu().

void CTagsPart::slotGotoDefinition  )  [private, slot]
 

Definition at line 177 of file ctagspart.cpp.

References gotoTag(), and m_contextString.

Referenced by contextMenu().

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

Definition at line 147 of file ctagspart.cpp.

References gotoFinalTag().

void CTagsPart::slotSearchTags  )  [private, slot]
 

Definition at line 183 of file ctagspart.cpp.

References ensureTagsLoaded(), and m_dialog.

CTagsMap CTagsPart::tags  )  [inline]
 

Definition at line 52 of file ctagspart.h.

References CTagsMap.

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(), and slotSearchTags().

QStringList CTagsPart::m_kindStrings [private]
 

Definition at line 71 of file ctagspart.h.

Referenced by loadTagsFile().

CTagsMap* CTagsPart::m_tags [private]
 

Definition at line 70 of file ctagspart.h.

Referenced by gotoTag(), loadTagsFile(), and projectClosed().

OccuresTagsDlg* CTagsPart::mOccuresTagsDlg [private]
 

Definition at line 74 of file ctagspart.h.

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


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 23 00:21:40 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003