1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// copyright : (C) 2008 by Eran Ifrah
// file name : symbol_tree.h
//
// -------------------------------------------------------------------------
// A
// _____ _ _ _ _
// / __ \ | | | | (_) |
// | / \/ ___ __| | ___| | _| |_ ___
// | | / _ \ / _ |/ _ \ | | | __/ _ )
// | \__/\ (_) | (_| | __/ |___| | || __/
// \____/\___/ \__,_|\___\_____/_|\__\___|
//
// F i l e
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
#ifndef CODELITE_SYMBOL_TREE_H
#define CODELITE_SYMBOL_TREE_H
#include "ctags_manager.h"
#include "parse_thread.h"
#include "wx/filename.h"
#include "entry.h"
#include "codelite_exports.h"
#include "map"
/**
* Class MyTreeItemData, a user defined class which keeps the full name of a tree item.
* This will allow us to quickly search the TagTree for entries using the full name as the key.
*
* \date 08-19-2006
* \author Eran
*
*/
class WXDLLIMPEXP_CL MyTreeItemData : public wxTreeItemData
{
private:
wxString m_fileName;
wxString m_pattern;
int m_lineno;
public:
/**
* Constructor.
* \param filename The full name the file
* \param pattern search pattern for this item in the file
*/
MyTreeItemData(const wxString& filename, const wxString& pattern, int lineno = wxNOT_FOUND)
: m_fileName(filename), m_pattern(pattern), m_lineno(lineno)
{}
const wxString &GetFileName() const {
return m_fileName;
}
const wxString &GetPattern() const {
return m_pattern;
}
const int GetLine() const {
return m_lineno;
}
};
/**
* Class SymbolTree, a tree that contains the language symbols from SQLite database.
*
* \date 08-18-2006
* \author Eran
*
*/
class WXDLLIMPEXP_CL SymbolTree : public wxTreeCtrl
{
protected:
std::map<wxString, int> m_imagesMap;
wxTreeItemId m_globalsNode;
wxTreeItemId m_prototypesNode;
wxTreeItemId m_macrosNode;
std::map<void*, bool> m_sortItems;
std::map<wxString, bool> m_globalsKind;
wxFileName m_fileName;
std::map<wxString, void*> m_items;
TagTreePtr m_tree;
TagEntryPtrVector_t m_currentTags;
public:
/**
* Default cosntructor.
*/
SymbolTree();
/**
* Parameterized constructor.
* \param parent Tree parent window
* \param id Window id
* \param pos Window position
* \param size Window size
* \param style Window style
*/
SymbolTree(wxWindow *parent, const wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0);
/**
* @brief clear the tree content
*/
virtual void Clear();
/**
* Destructor .
*/
virtual ~SymbolTree(void);
/**
* Create tree, usually called after constructing SymbolTree with default constructor.
* \param parent Tree parent window
* \param id Window id
* \param pos Window position
* \param size Window size
* \param style Window style
*/
virtual void Create(wxWindow *parent, const wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxTR_HIDE_ROOT | wxTR_HAS_BUTTONS);
/**
* Construct a outline tree for fileName
* possible return values:
*
*/
virtual void BuildTree(const wxFileName &fileName, TagEntryPtrVector_t* tags = NULL);
/**
* User provided icons for the symbols tree.
* The assignment is index based, in the following order:
*
* -# project
* -# namespace
* -# globals
* -# class
* -# function
* -# prototype_public
* -# prototype_protected
* -# prototype_private
* -# member_public
* -# member_protected
* -# member_private
* -# typedef
* -# macro
* -# enum
*
* \note Due to ctags limitation, only 'function' is mentioned here, there is no function_protected, function_private, etc
* since when coming to implementation (not prototypes!), all functions will receive 'public' icon.
* \param images Image list (allocated on the heap), this class becomes the owner of this image list
*/
virtual void SetSymbolsImages(wxImageList *images) {
AssignImageList(images);
};
void AddSymbols(const std::vector<std::pair<wxString, TagEntry> > &items);
void DeleteSymbols(const std::vector<std::pair<wxString, TagEntry> > &items);
void UpdateSymbols(const std::vector<std::pair<wxString, TagEntry> > &items);
/**
* return the file name assocaited with this symbol tree
*/
const wxFileName &GetFilename() const {
return m_fileName;
}
/**
* \brief select item by its name and select it. If multiple matches
* fits 'name' the first one is selected
* \param name disply name of the item to be selected (can be partial name)
*/
void SelectItemByName(const wxString &name);
protected:
void GetItemChildrenRecursive(wxTreeItemId& parent, std::map<void*, bool> &deletedMap);
/**
* Add an item to the gui tree.
* \param node Node to add
*/
void AddItem(TagNode* node);
/**
* Return the icon index according to item kind and access.
* \param kind Item kind (class, namespace etc)
* \param access One of $public$, $private$, $protected$, or $wxEmptyString$
* \return icon index
*/
int GetItemIconIndex(const wxString &kind, const wxString &access = wxEmptyString);
/**
* Initialise the image: icon index map.
*/
void InitialiseSymbolMap();
/**
* Sort the tree.
* \param nodes Vector of nodes to sort
*/
void SortTree(std::map<void*, bool> & nodes);
/**
* Override this function in the derived class to change the sort order of the items in the tree control.
* \param item1 Item one
* \param item2 Item two
* \return The function should return a negative, zero or positive value
* if the first item is less than, equal to or greater than the second one.
*/
int OnCompareItems(const wxTreeItemId& item1, const wxTreeItemId& item2);
/**
* Update gui item with new data
* \param data new data
* \param key node key
*/
void UpdateGuiItem(TagEntry& data, const wxString& key);
DECLARE_DYNAMIC_CLASS(SymbolTree)
void OnItemActivated(wxTreeEvent &event);
void OnTimer(wxTimerEvent &event);
};
#endif // CODELITE_SYMBOL_TREE_H
|
