You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kscope/src/queryview.h

218 lines
6.6 KiB

/***************************************************************************
*
* Copyright (C) 2005 Elad Lahav (elad_lahav@users.sourceforge.net)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
***************************************************************************/
#ifndef QUERYVIEW_H
#define QUERYVIEW_H
#include <tqlistview.h>
#include <tqregexp.h>
class QueryResultsMenu;
/**
* Items in a query view.
* The sole purpose for creating a new class is to be able to sort query
* results numerically by line number.
* @author Elad Lahav
*/
class QueryViewItem : public TQListViewItem
{
public:
/**
* Class constructor.
* Used for list views.
* @param pView The view widget
* @param pAfter The item to preceed the new one
* @param nLineCol The index of the line column
*/
QueryViewItem(TQListView* pView, TQListViewItem* pAfter,
int nLineCol) : TQListViewItem(pView, pAfter), m_nLineCol(nLineCol)
{}
/**
* Class constructor.
* Used for tree views.
* @param pParent The parent item
* @param pAfter The item to preceed the new one
* @param nLineCol The index of the line column
*/
QueryViewItem(TQListViewItem* pParent, TQListViewItem* pAfter,
int nLineCol) : TQListViewItem(pParent, pAfter), m_nLineCol(nLineCol)
{}
/**
* Compares two items.
* If the given column holds line numbers, than the items are compared
* by their numeric values. Otherwise, a standard text comparison is
* performed.
* @param pItem The item to compare to
* @param nCol The column by which to compare
* @param bAscend Whether sorting in ascending or descending order
* @return 0 if the items are equal, 1 if the current item is greater,
* -1 if the current item is smaller
*/
virtual int compare(TQListViewItem* pItem, int nCol, bool bAscend) const {
if (nCol == m_nLineCol) {
uint nLineCur, nLineOther;
int nResult;
// Get the line numbers of each item
nLineCur = text(nCol).toUInt();
nLineOther = pItem->text(nCol).toUInt();
// Compare the line numbers
nResult = nLineCur - nLineOther;
if (nResult == 0)
return 0; // Items are equal
else if (nResult > 0)
return 1; // The first item is greater
else
return -1; // The second item is greater
}
return TQListViewItem::compare(pItem, nCol, bAscend);
}
private:
/** The index of the column holding the line numbers. */
int m_nLineCol;
};
/**
* A list view widget for displaying locations in the source code. Each record
* (list item) represents a single line of code.
* The main purpose of this class is for showing query results (@see
* QueryViewDriver), but is can also serve as a base class for any widget
* which needs to refer to locations in the source code (@see
* HistoryView).
* The view has 4 columns, for showing the file path, function name, line
* number and line text of a code location.
* The widget owns a popup menu which allows users to copy information
* from records, filter records, and more.
* @author Elad Lahav
*/
class QueryView : public TQListView
{
Q_OBJECT
public:
QueryView(TQWidget* pParent = 0, const char* szName = 0);
~QueryView();
virtual void addRecord(const TQString&, const TQString&, const TQString&,
const TQString&, TQListViewItem* pParent = NULL);
virtual void select(TQListViewItem*);
virtual void selectNext();
virtual void selectPrev();
virtual void queryProgress();
virtual void queryFinished(uint, TQListViewItem* pParent = NULL);
/**
* Provides an iterator over the list of query results.
* @author Elad Lahav
*/
class Iterator
{
public:
/**
* Default constructor.
*/
Iterator() : m_pItem(NULL) {}
/**
* Copy constructor.
* @param itr The copied object
*/
Iterator(const Iterator& itr) : m_pItem(itr.m_pItem) {}
/**
* @return true if the iterator points _beyond_ the end of the list,
* false otherwise
*/
bool isEOF() { return m_pItem == NULL; }
void next();
TQString getFunc();
TQString getFile();
TQString getLine();
TQString getText();
private:
/** Points to the current list item. */
TQListViewItem* m_pItem;
/**
* Private constructor used to return initialised iterators.
* This constructor can only be called from within QueryView.
* @param pItem The initial list item
*/
Iterator(TQListViewItem* pItem) : m_pItem(pItem) {}
friend class QueryView;
};
Iterator getIterator();
signals:
/**
* Notifies the owner widget that it needs to be visible since some
* information is available to display.
* This information may be an advancement of the progress bar,
* availability of query results, etc.
*/
void needToShow();
/**
* Emitted when a list record is selected.
* Selection is done by either double-clicking a query or by highlighting
* it and then pressing the ENTER key.
* @param sFile The "File" field of the selected record
* @param nLine The "Line" field of the selected record
*/
void lineRequested(const TQString& sFile, uint nLine);
protected:
/** A popup-menu for manipulating query result items. */
QueryResultsMenu* m_pQueryMenu;
/** A pointer to the last item (used for appending results). */
TQListViewItem* m_pLastItem;
void contentsMouseDoubleClickEvent(TQMouseEvent*);
protected slots:
virtual void slotRecordSelected(TQListViewItem*);
virtual void slotFindDef(const TQString&);
virtual void slotCopy(TQListViewItem*, int);
virtual void slotFilter(int);
virtual void slotShowAll();
virtual void slotRemoveItem(TQListViewItem*);
};
#endif