File: symbol_tree.cpp

package info (click to toggle)
codelite 17.0.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 136,204 kB
  • sloc: cpp: 491,547; ansic: 280,393; php: 10,259; sh: 8,930; lisp: 7,664; vhdl: 6,518; python: 6,020; lex: 4,920; yacc: 3,123; perl: 2,385; javascript: 1,715; cs: 1,193; xml: 1,110; makefile: 804; cobol: 741; sql: 709; ruby: 620; f90: 566; ada: 534; asm: 464; fortran: 350; objc: 289; tcl: 258; java: 157; erlang: 61; pascal: 51; ml: 49; awk: 44; haskell: 36
file content (476 lines) | stat: -rw-r--r-- 18,346 bytes parent folder | download | duplicates (2)
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// copyright            : (C) 2008 by Eran Ifrah
// file name            : symbol_tree.cpp
//
// -------------------------------------------------------------------------
// 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.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
#include "symbol_tree.h"

#include "bitmap_loader.h"
#include "ctags_manager.h"
#include "fileutils.h"
#include "globals.h"
#include "precompiled_header.h"
#include "tokenizer.h"

#include <functional>
#include <imanager.h>
#include <wx/wupdlock.h>

SymbolTree::SymbolTree()
    : m_sortByLineNumber(true)
{
    InitialiseSymbolMap();
    clSortFunc_t func = [&](clRowEntry* a, clRowEntry* b) {
        // Line number compare
        MyTreeItemData* cd1 = dynamic_cast<MyTreeItemData*>(a->GetClientObject());
        MyTreeItemData* cd2 = dynamic_cast<MyTreeItemData*>(b->GetClientObject());
        if(m_sortByLineNumber && cd1 && cd2) {
            return cd1->GetLine() < cd2->GetLine();
        } else {
            // ABC compare
            int img1, img2;
            img1 = a->GetBitmapIndex();
            img2 = b->GetBitmapIndex();
            if(img1 < img2)
                return true;
            else if(img1 < img2)
                return false;
            else {
                // Items  has the same icons, compare text
                return (a->GetLabel().CmpNoCase(b->GetLabel()) < 0);
            }
        }
    };
    SetSortFunction(func);
}

SymbolTree::SymbolTree(wxWindow* parent, const wxWindowID id, const wxPoint& pos, const wxSize& size, long style)
    : m_sortByLineNumber(true)
{
    InitialiseSymbolMap();
    Create(parent, id, pos, size, style | wxTR_HIDE_ROOT);
    clSortFunc_t func = [&](clRowEntry* a, clRowEntry* b) {
        // Line number compare
        MyTreeItemData* cd1 = dynamic_cast<MyTreeItemData*>(a->GetClientObject());
        MyTreeItemData* cd2 = dynamic_cast<MyTreeItemData*>(b->GetClientObject());
        if(m_sortByLineNumber && cd1 && cd2) {
            return cd1->GetLine() < cd2->GetLine();
        } else {
            // ABC compare
            int img1, img2;
            img1 = a->GetBitmapIndex();
            img2 = b->GetBitmapIndex();
            if(img1 < img2)
                return true;
            else if(img1 < img2)
                return false;
            else {
                // Items  has the same icons, compare text
                return (a->GetLabel().CmpNoCase(b->GetLabel()) < 0);
            }
        }
    };
    SetSortFunction(func);
}

SymbolTree::~SymbolTree() {}

void SymbolTree::InitialiseSymbolMap()
{
    //--------------------------------------------------------
    // Initialise the images map (kind:icon_index)
    //--------------------------------------------------------
    BitmapLoader* loader = clGetManager()->GetStdIcons();
    m_imagesMap["class_view"] = loader->GetImageIndex(BitmapLoader::kClass);
    m_imagesMap["project"] = loader->GetImageIndex(FileExtManager::TypeProject);
    m_imagesMap["namespace"] = loader->GetImageIndex(BitmapLoader::kNamespace);
    m_imagesMap["globals"] = loader->GetImageIndex(BitmapLoader::kAngleBrackets);
    m_imagesMap["class"] = loader->GetImageIndex(BitmapLoader::kClass);
    m_imagesMap["interface"] = loader->GetImageIndex(BitmapLoader::kClass);
    m_imagesMap["interface_private"] = loader->GetImageIndex(BitmapLoader::kClass);
    m_imagesMap["interface_protected"] = loader->GetImageIndex(BitmapLoader::kClass);
    m_imagesMap["class_private"] = loader->GetImageIndex(BitmapLoader::kClass);
    m_imagesMap["class_public"] = loader->GetImageIndex(BitmapLoader::kClass);
    m_imagesMap["class_protected"] = loader->GetImageIndex(BitmapLoader::kClass);
    m_imagesMap["struct"] = loader->GetImageIndex(BitmapLoader::kStruct);
    m_imagesMap["struct_private"] = loader->GetImageIndex(BitmapLoader::kStruct);
    m_imagesMap["struct_public"] = loader->GetImageIndex(BitmapLoader::kStruct);
    m_imagesMap["struct_protected"] = loader->GetImageIndex(BitmapLoader::kStruct);
    m_imagesMap["function"] = loader->GetImageIndex(BitmapLoader::kFunctionPublic);
    m_imagesMap["prototype"] = loader->GetImageIndex(BitmapLoader::kFunctionPublic);
    m_imagesMap["function_public"] = loader->GetImageIndex(BitmapLoader::kFunctionPublic);
    m_imagesMap["prototype_public"] = loader->GetImageIndex(BitmapLoader::kFunctionPublic);
    m_imagesMap["function_protected"] = loader->GetImageIndex(BitmapLoader::kFunctionProtected);
    m_imagesMap["prototype_protected"] = loader->GetImageIndex(BitmapLoader::kFunctionProtected);
    m_imagesMap["function_private"] = loader->GetImageIndex(BitmapLoader::kFunctionPrivate);
    m_imagesMap["prototype_private"] = loader->GetImageIndex(BitmapLoader::kFunctionPrivate);
    m_imagesMap["variable"] = loader->GetImageIndex(BitmapLoader::kMemberPublic);
    m_imagesMap["member"] = loader->GetImageIndex(BitmapLoader::kMemberPublic);
    m_imagesMap["member_public"] = loader->GetImageIndex(BitmapLoader::kMemberPublic);
    m_imagesMap["member_protected"] = loader->GetImageIndex(BitmapLoader::kMemberProtected);
    m_imagesMap["member_private"] = loader->GetImageIndex(BitmapLoader::kMemberPrivate);
    m_imagesMap["typedef"] = loader->GetImageIndex(BitmapLoader::kTypedef);
    m_imagesMap["typedef_public"] = loader->GetImageIndex(BitmapLoader::kTypedef);
    m_imagesMap["typedef_private"] = loader->GetImageIndex(BitmapLoader::kTypedef);
    m_imagesMap["typedef_protected"] = loader->GetImageIndex(BitmapLoader::kTypedef);
    m_imagesMap["macro"] = loader->GetImageIndex(BitmapLoader::kMacro);
    m_imagesMap["macro_private"] = loader->GetImageIndex(BitmapLoader::kMacro);
    m_imagesMap["macro_protected"] = loader->GetImageIndex(BitmapLoader::kMacro);
    m_imagesMap["macro_public"] = loader->GetImageIndex(BitmapLoader::kMacro);
    m_imagesMap["enum"] = loader->GetImageIndex(BitmapLoader::kEnum);
    m_imagesMap["cenum"] = loader->GetImageIndex(BitmapLoader::kEnum);
    m_imagesMap["enum_private"] = loader->GetImageIndex(BitmapLoader::kEnum);
    m_imagesMap["enum_public"] = loader->GetImageIndex(BitmapLoader::kEnum);
    m_imagesMap["enum_protected"] = loader->GetImageIndex(BitmapLoader::kEnum);
    m_imagesMap["enumerator"] = loader->GetImageIndex(BitmapLoader::kEnumerator);
    m_imagesMap["method"] = loader->GetImageIndex(BitmapLoader::kFunctionPublic);
    m_imagesMap["method_public"] = loader->GetImageIndex(BitmapLoader::kFunctionPublic);
    m_imagesMap["method_protected"] = loader->GetImageIndex(BitmapLoader::kFunctionProtected);
    m_imagesMap["method_private"] = loader->GetImageIndex(BitmapLoader::kFunctionProtected);

    //-----------------------------------------------------------
    // Populate globals kind
    //-----------------------------------------------------------
    m_globalsKind[wxT("<global>")] = true;
    m_globalsKind[wxT("function")] = true;
    m_globalsKind[wxT("prototype")] = true;
    m_globalsKind[wxT("variable")] = true;
    m_globalsKind[wxT("enumerator")] = true;
}

void SymbolTree::Create(wxWindow* parent, const wxWindowID id, const wxPoint& pos, const wxSize& size, long style)
{
    clThemedTreeCtrl::Create(parent, id, pos, size, style);
    BuildTree(wxFileName(), TagEntryPtrVector_t());
}

void SymbolTree::BuildTree(const wxFileName& fileName, const TagEntryPtrVector_t& tags, bool forceBuild)
{
    TagEntryPtrVector_t newTags;
    if(tags.empty()) {

        // Get the current database
        ITagsStoragePtr db = TagsManagerST::Get()->GetDatabase();
        if(!db) {
            Clear();
            return;
        }
        // Load the new tags from the database
        db->SelectTagsByFile(fileName.GetFullPath(), newTags);

        // Compare the new tags with the old ones
        if(!forceBuild && TagsManagerST::Get()->AreTheSame(newTags, m_currentTags))
            return;

        m_currentTags.clear();
        m_currentTags.insert(m_currentTags.end(), newTags.begin(), newTags.end());

    } else {

        m_currentTags.clear();
        m_currentTags.insert(m_currentTags.end(), tags.begin(), tags.end());
    }

    Clear();
    m_fileName = fileName;

    // Convert them into tree
    m_tree = TagsManagerST::Get()->Load(m_fileName, &m_currentTags);
    if(!m_tree) {
        return;
    }

    // Add invisible root node
    wxTreeItemId root;
    root = AddRoot(fileName.GetFullName(), 15, 15);

    TreeWalker<wxString, TagEntry> walker(m_tree->GetRoot());

    // add three items here:
    // the globals node, the mcros and the prototype node
    int nodeImgIdx = clGetManager()->GetStdIcons()->GetImageIndex(BitmapLoader::kAngleBrackets);
    m_globalsNode = AppendItem(root, _("Global Functions and Variables"), nodeImgIdx, nodeImgIdx,
                               new MyTreeItemData(_("Global Functions and Variables"), wxEmptyString));
    m_prototypesNode = AppendItem(root, _("Functions Prototypes"), nodeImgIdx, nodeImgIdx,
                                  new MyTreeItemData(_("Functions Prototypes"), wxEmptyString));
    m_macrosNode =
        AppendItem(root, _("Macros"), nodeImgIdx, nodeImgIdx, new MyTreeItemData(_("Macros"), wxEmptyString));

    for(; !walker.End(); walker++) {
        // Add the item to the tree
        TagNode* node = walker.GetNode();

        // Skip root node
        if(node->IsRoot())
            continue;

        // Add the node
        AddItem(node);
    }

    if(ItemHasChildren(m_globalsNode) == false) {
        Delete(m_globalsNode);
    }
    if(ItemHasChildren(m_prototypesNode) == false) {
        Delete(m_prototypesNode);
    }
    if(ItemHasChildren(m_macrosNode) == false) {
        Delete(m_macrosNode);
    }
}

void SymbolTree::AddItem(TagNode* node)
{
    // Get node icon index
    TagEntry nodeData = node->GetData();

    int iconIndex = GetItemIconIndex(nodeData.GetKind(), nodeData.GetAccess());
    wxString displayName(nodeData.GetDisplayName());

    wxTreeItemId parentHti;
    if(nodeData.GetName().IsEmpty())
        return;

    wxFont font = clScrolledPanel::GetDefaultFont();
    if(nodeData.GetKind() == wxT("prototype")) {
        font.SetStyle(wxFONTSTYLE_ITALIC);
    }
    if(nodeData.GetAccess() == wxT("public")) {
        font.SetWeight(wxFONTWEIGHT_BOLD);
    }

    //-------------------------------------------------------------------------------
    // We gather globals together under special node
    //-------------------------------------------------------------------------------
    if((nodeData.GetParent() == wxT("<global>")) && // parent is global scope
       m_globalsKind.find(nodeData.GetKind()) !=
           m_globalsKind.end()) { // the node kind is one of function, prototype or variable
        if(nodeData.GetKind() == wxT("prototype"))
            parentHti = m_prototypesNode;
        else
            parentHti = m_globalsNode;
    } else
        parentHti = node->GetParent()->GetData().GetTreeItemId();

    //---------------------------------------------------------------------------------
    // Macros are gathered under the 'Macros' node
    //---------------------------------------------------------------------------------
    if(nodeData.GetKind() == wxT("macro")) {
        parentHti = m_macrosNode;
    }

    // only if parent is valid, we add item to the tree
    wxTreeItemId hti;

    if(parentHti.IsOk() == false) {
        parentHti = GetRootItem();
    }

    if(parentHti.IsOk()) {
        hti = AppendItem(
            parentHti,   // parent
            displayName, // display name
            iconIndex,   // item image index
            iconIndex,   // selected item image
            new MyTreeItemData(node->GetData().GetFile(), node->GetData().GetPattern(), node->GetData().GetLine()));
        SetItemFont(hti, font);
        node->GetData().SetTreeItemId(hti);
        m_items[nodeData.Key()] = hti.m_pItem;
    }
}

void SymbolTree::SelectItemByName(const wxString& name)
{
    if(!Matches(GetRootItem(), name)) {
        // wxTreeItemId currentSelection = GetSelection();
        // if(currentSelection.IsOk()) {
        //     SelectItem(currentSelection, false);
        // }
    }
}

int SymbolTree::GetItemIconIndex(const wxString& kind, const wxString& access)
{
    wxString key(kind);
    int index(m_imagesMap["struct"]); // structs will be the default icon index

    if(!access.IsEmpty())
        key += wxT("_") + access;

    key.Trim();

    std::map<wxString, int>::iterator iter = m_imagesMap.find(key);
    if(iter != m_imagesMap.end()) {
        index = iter->second;
    }
    return index;
}

void SymbolTree::UpdateSymbols(const std::vector<std::pair<wxString, TagEntry>>& items)
{
    if(!m_tree)
        return;

    Freeze();
    for(size_t i = 0; i < items.size(); i++) {
        wxString key = items[i].first;
        TagEntry data = items[i].second;

        UpdateGuiItem(data, key);
    }
    Thaw();
}

void SymbolTree::UpdateGuiItem(TagEntry& data, const wxString& key)
{
    if(!m_tree)
        return;

    TagNode* node = m_tree->Find(key);
    if(node) {
        // Update the new data with the gui tree item id
        data.SetTreeItemId(node->GetData().GetTreeItemId());
        node->SetData(data);

        // Update Icon if needed
        int iconIndex = GetItemIconIndex(data.GetKind(), data.GetAccess());
        int curIconIndex = -1;
        wxTreeItemId itemId = node->GetData().GetTreeItemId();
        if(itemId.IsOk()) {
            curIconIndex = GetItemImage(itemId);
            if(curIconIndex != iconIndex) {
                // Need to update the image as well
                SetItemImage(node->GetData().GetTreeItemId(), iconIndex);
                SetItemImage(node->GetData().GetTreeItemId(), iconIndex, wxTreeItemIcon_Selected);

            } // if(curIconIndex != iconIndex )
            // update the linenumber and file
            MyTreeItemData* item_data = new MyTreeItemData(data.GetFile(), data.GetPattern());
            wxTreeItemData* old_data = GetItemData(itemId);
            if(old_data)
                delete old_data;
            SetItemData(itemId, item_data);
        }
    }
}

void SymbolTree::DeleteSymbols(const std::vector<std::pair<wxString, TagEntry>>& items)
{
    if(!m_tree)
        return;

    std::map<void*, bool> deletedMap;

    Freeze();
    for(size_t i = 0; i < items.size(); i++) {
        wxString key = items.at(i).first;

        std::map<wxString, void*>::iterator iter = m_items.find(key);
        if(iter != m_items.end() && iter->second) {
            wxTreeItemId hti = iter->second;
            // if this note was already deleted, dont delete it again
            if(deletedMap.find(hti.m_pItem) == deletedMap.end()) {
                GetItemChildrenRecursive(hti, deletedMap);
                // remove just the parent
                Delete(hti);
            }
            m_items.erase(iter);
        }
    }
    Thaw();
}

void SymbolTree::GetItemChildrenRecursive(wxTreeItemId& parent, std::map<void*, bool>& deletedMap)
{
    // delete the item's children
    wxTreeItemIdValue cookie;
    wxTreeItemId child = GetFirstChild(parent, cookie);
    while(child.IsOk()) {
        if(ItemHasChildren(child)) {
            GetItemChildrenRecursive(child, deletedMap);
        } else {
            deletedMap[child.m_pItem] = child;
        }
        child = GetNextChild(parent, cookie);
    }
    deletedMap[parent.m_pItem] = true;
}

void SymbolTree::AddSymbols(const std::vector<std::pair<wxString, TagEntry>>& items)
{
    if(!m_tree)
        return;
    for(size_t i = 0; i < items.size(); i++) {
        TagEntry data = items.at(i).second;
        if(m_tree) {
            TagNode* node = m_tree->AddEntry(data);
            if(node) {
                AddItem(node);
            }
        }
    } // for(size_t i=0; i<items.size(); i++)
}

void SymbolTree::Clear()
{
    // Clear the tree
    Freeze();
    DeleteAllItems();
    m_items.clear();
    m_globalsNode = wxTreeItemId();
    m_prototypesNode = wxTreeItemId();
    m_macrosNode = wxTreeItemId();
    m_fileName.Clear();
    Thaw();
}

bool SymbolTree::Matches(const wxTreeItemId& item, const wxString& patter)
{
    if(!item.IsOk())
        return false;
    wxString displayName = GetItemText(item);
    wxString path = displayName.BeforeFirst(wxT('('));
    // Get the name from the path
    path = path.AfterLast(wxT(':'));
    if(FileUtils::FuzzyMatch(patter, path)) {
        SelectItem(item);
        EnsureVisible(item);
        return true;
    }

    // Check the item's children
    if(ItemHasChildren(item)) {
        wxTreeItemIdValue cookie;
        wxTreeItemId child = GetFirstChild(item, cookie);
        while(child.IsOk()) {
            if(Matches(child, patter)) {
                return true;
            }
            child = GetNextChild(item, cookie);
        }
    }
    return false;
}

void SymbolTree::SetSymbolsImages(BitmapLoader::Vec_t* bitmaps) { SetBitmaps(bitmaps); }

void SymbolTree::SelectFirstItem() { SelectItem(GetFirstVisibleItem()); }