source: git/src/aventreectrl.cc @ 3b6e9cf

warn-only-for-hanging-survey
Last change on this file since 3b6e9cf was dba01e2, checked in by Olly Betts <olly@…>, 2 months ago

Fixes for survey tree change
  • Property mode set to 100644
File size: 17.9 KB
Line 
1//
2//  aventreectrl.cc
3//
4//  Tree control used for the survey tree.
5//
6//  Copyright (C) 2001, Mark R. Shinwell.
7//  Copyright (C) 2001-2003,2005,2006,2016,2018 Olly Betts
8//  Copyright (C) 2005 Martin Green
9//
10//  This program is free software; you can redistribute it and/or modify
11//  it under the terms of the GNU General Public License as published by
12//  the Free Software Foundation; either version 2 of the License, or
13//  (at your option) any later version.
14//
15//  This program is distributed in the hope that it will be useful,
16//  but WITHOUT ANY WARRANTY; without even the implied warranty of
17//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18//  GNU General Public License for more details.
19//
20//  You should have received a copy of the GNU General Public License
21//  along with this program; if not, write to the Free Software
22//  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
23//
24
25#include <config.h>
26
27#include "aventreectrl.h"
28#include "mainfrm.h"
29#include "osalloc.h"
30
31#include <stack>
32
33using namespace std;
34
35// STATE_BLANK is used for stations which are siblings of surveys which have
36// select checkboxes.
37enum { STATE_BLANK = 0, STATE_OFF, STATE_ON };
38
39/* XPM */
40static const char *blank_xpm[] = {
41/* columns rows colors chars-per-pixel */
42"15 15 1 1",
43"  c None",
44/* pixels */
45"               ",
46"               ",
47"               ",
48"               ",
49"               ",
50"               ",
51"               ",
52"               ",
53"               ",
54"               ",
55"               ",
56"               ",
57"               ",
58"               ",
59"               "
60};
61
62/* XPM */
63static const char *off_xpm[] = {
64/* columns rows colors chars-per-pixel */
65"15 15 2 1",
66". c #000000",
67"  c None",
68/* pixels */
69"               ",
70"               ",
71" ............  ",
72" .          .  ",
73" .          .  ",
74" .          .  ",
75" .          .  ",
76" .          .  ",
77" .          .  ",
78" .          .  ",
79" .          .  ",
80" .          .  ",
81" .          .  ",
82" ............  ",
83"               "
84};
85
86/* XPM */
87static const char *on_xpm[] = {
88/* columns rows colors chars-per-pixel */
89"15 15 3 1",
90". c #000000",
91"X c #007F28",
92"  c None",
93/* pixels */
94"               ",
95"               ",
96" ............XX",
97" .          XXX",
98" .         XXXX",
99" .        XXXX ",
100" .       XXXX  ",
101" .      XXXX.  ",
102" . XX  XXXX .  ",
103" . XXXXXXX  .  ",
104" .  XXXXX   .  ",
105" .   XXX    .  ",
106" .    X     .  ",
107" ............  ",
108"               "
109};
110
111BEGIN_EVENT_TABLE(AvenTreeCtrl, wxTreeCtrl)
112    EVT_MOTION(AvenTreeCtrl::OnMouseMove)
113    EVT_LEAVE_WINDOW(AvenTreeCtrl::OnLeaveWindow)
114    EVT_TREE_SEL_CHANGED(wxID_ANY, AvenTreeCtrl::OnSelChanged)
115    EVT_TREE_ITEM_ACTIVATED(wxID_ANY, AvenTreeCtrl::OnItemActivated)
116    EVT_CHAR(AvenTreeCtrl::OnKeyPress)
117    EVT_TREE_ITEM_MENU(wxID_ANY, AvenTreeCtrl::OnMenu)
118    EVT_MENU(menu_SURVEY_SHOW_ALL, AvenTreeCtrl::OnRestrict)
119    EVT_MENU(menu_SURVEY_RESTRICT, AvenTreeCtrl::OnRestrict)
120    EVT_MENU(menu_SURVEY_HIDE, AvenTreeCtrl::OnHide)
121    EVT_MENU(menu_SURVEY_SHOW, AvenTreeCtrl::OnShow)
122    EVT_MENU(menu_SURVEY_HIDE_SIBLINGS, AvenTreeCtrl::OnHideSiblings)
123    EVT_TREE_STATE_IMAGE_CLICK(wxID_ANY, AvenTreeCtrl::OnStateClick)
124END_EVENT_TABLE()
125
126AvenTreeCtrl::AvenTreeCtrl(MainFrm* parent, wxWindow* window_parent) :
127    wxTreeCtrl(window_parent, wxID_ANY, wxDefaultPosition, wxDefaultSize,
128               wxTR_DEFAULT_STYLE | wxTR_HIDE_ROOT),
129    m_Parent(parent),
130    m_Enabled(false),
131    m_LastItem(),
132    m_BackgroundColour(),
133    m_SelValid(false),
134    menu_data(NULL)
135{
136    wxImageList* img_list = new wxImageList(15, 15, 2);
137    img_list->Add(wxBitmap(blank_xpm));
138    img_list->Add(wxBitmap(off_xpm));
139    img_list->Add(wxBitmap(on_xpm));
140    AssignStateImageList(img_list);
141}
142
143void AvenTreeCtrl::FillTree(const wxString& root_name)
144{
145    Freeze();
146    m_Enabled = false;
147    m_LastItem = wxTreeItemId();
148    m_SelValid = false;
149    DeleteAllItems();
150
151    const wxChar separator = m_Parent->GetSeparator();
152    filter.clear();
153    filter.SetSeparator(separator);
154
155    // Create the (hidden) real root of the wxTreeCtrl.
156    wxTreeItemId treeroot = AddRoot(wxString());
157
158    // Create the root of the survey tree.
159    wxTreeItemId surveyroot = AppendItem(treeroot, root_name);
160
161    // Fill the tree of stations and prefixes.
162    stack<wxTreeItemId> previous_ids;
163    wxString current_prefix;
164    wxTreeItemId current_id = surveyroot;
165
166    list<LabelInfo*>::const_iterator pos = m_Parent->GetLabels();
167    while (pos != m_Parent->GetLabelsEnd()) {
168        LabelInfo* label = *pos++;
169
170        if (label->IsAnon()) continue;
171
172        // Determine the current prefix.
173        wxString prefix = label->GetText().BeforeLast(separator);
174
175        // Determine if we're still on the same prefix.
176        if (prefix == current_prefix) {
177            // no need to fiddle with branches...
178        }
179        // If not, then see if we've descended to a new prefix.
180        else if (prefix.length() > current_prefix.length() &&
181                 prefix.StartsWith(current_prefix) &&
182                 (prefix[current_prefix.length()] == separator ||
183                  current_prefix.empty())) {
184            // We have, so start as many new branches as required.
185            int current_prefix_length = current_prefix.length();
186            current_prefix = prefix;
187            size_t next_dot = current_prefix_length;
188            if (!next_dot) --next_dot;
189            do {
190                size_t prev_dot = next_dot + 1;
191
192                // Extract the next bit of prefix.
193                next_dot = prefix.find(separator, prev_dot + 1);
194
195                wxString bit = prefix.substr(prev_dot, next_dot - prev_dot);
196                // Sigh, therion can produce files with empty components in
197                // station names!
198                // assert(!bit.empty());
199
200                // Add the current tree ID to the stack.
201                previous_ids.push(current_id);
202
203                // Append the new item to the tree and set this as the current branch.
204                current_id = AppendItem(current_id, bit);
205                SetItemData(current_id, new TreeData(prefix.substr(0, next_dot)));
206            } while (next_dot != wxString::npos);
207        }
208        // Otherwise, we must have moved up, and possibly then down again.
209        else {
210            size_t count = 0;
211            bool ascent_only = (prefix.length() < current_prefix.length() &&
212                                current_prefix.StartsWith(prefix) &&
213                                (current_prefix[prefix.length()] == separator ||
214                                 prefix.empty()));
215            if (!ascent_only) {
216                // Find out how much of the current prefix and the new prefix
217                // are the same.
218                // Note that we require a match of a whole number of parts
219                // between dots!
220                size_t n = min(prefix.length(), current_prefix.length());
221                size_t i;
222                for (i = 0; i < n && prefix[i] == current_prefix[i]; ++i) {
223                    if (prefix[i] == separator) count = i + 1;
224                }
225            } else {
226                count = prefix.length() + 1;
227            }
228
229            // Extract the part of the current prefix after the bit (if any)
230            // which has matched.
231            // This gives the prefixes to ascend over.
232            wxString prefixes_ascended = current_prefix.substr(count);
233
234            // Count the number of prefixes to ascend over.
235            int num_prefixes = prefixes_ascended.Freq(separator);
236
237            // Reverse up over these prefixes.
238            for (int i = 1; i <= num_prefixes; i++) {
239                previous_ids.pop();
240            }
241            current_id = previous_ids.top();
242            previous_ids.pop();
243
244            if (!ascent_only) {
245                // Add branches for this new part.
246                size_t next_dot = count - 1;
247                do {
248                    size_t prev_dot = next_dot + 1;
249
250                    // Extract the next bit of prefix.
251                    next_dot = prefix.find(separator, prev_dot + 1);
252
253                    wxString bit = prefix.substr(prev_dot, next_dot - prev_dot);
254                    // Sigh, therion can produce files with empty components in
255                    // station names!
256                    // assert(!bit.empty());
257
258                    // Add the current tree ID to the stack.
259                    previous_ids.push(current_id);
260
261                    // Append the new item to the tree and set this as the current branch.
262                    current_id = AppendItem(current_id, bit);
263                    SetItemData(current_id, new TreeData(prefix.substr(0, next_dot)));
264                } while (next_dot != wxString::npos);
265            }
266
267            current_prefix = prefix;
268        }
269
270        // Now add the leaf.
271        wxString bit = label->GetText().AfterLast(separator);
272        // Sigh, therion can produce files with empty components in station
273        // names!
274        // assert(!bit.empty());
275        wxTreeItemId id = AppendItem(current_id, bit);
276        SetItemData(id, new TreeData(label));
277        label->tree_id = id;
278        // Set the colour for an item in the survey tree.
279        if (label->IsEntrance()) {
280            // Entrances are green (like entrance blobs).
281            SetItemTextColour(id, wxColour(0, 255, 40));
282        } else if (label->IsSurface()) {
283            // Surface stations are dark green.
284            SetItemTextColour(id, wxColour(49, 158, 79));
285        }
286    }
287
288    Expand(surveyroot);
289    m_Enabled = true;
290    Thaw();
291}
292
293constexpr auto TREE_MASK = wxTREE_HITTEST_ONITEMLABEL |
294                           wxTREE_HITTEST_ONITEMRIGHT |
295                           wxTREE_HITTEST_ONITEMSTATEICON;
296
297void AvenTreeCtrl::OnMouseMove(wxMouseEvent& event)
298{
299    if (!m_Enabled || m_Parent->Animating())
300        return;
301
302    int flags;
303    wxTreeItemId pos = HitTest(event.GetPosition(), flags);
304    if (!(flags & TREE_MASK)) {
305        pos = wxTreeItemId();
306    }
307    if (pos == m_LastItem) return;
308    if (pos.IsOk()) {
309        const TreeData* data = static_cast<const TreeData*>(GetItemData(pos));
310        m_Parent->DisplayTreeInfo(data);
311        if (data && !data->IsStation()) {
312            // For stations, MainFrm calls back to SetHere(), but for surveys
313            // we need to do that ourselves.
314            SetHere(pos);
315        }
316    } else {
317        m_Parent->DisplayTreeInfo();
318    }
319}
320
321void AvenTreeCtrl::SetHere(wxTreeItemId pos)
322{
323    if (pos == m_LastItem) return;
324
325    if (m_LastItem.IsOk()) {
326        SetItemBackgroundColour(m_LastItem, m_BackgroundColour);
327    }
328    if (pos.IsOk()) {
329        m_BackgroundColour = GetItemBackgroundColour(pos);
330        SetItemBackgroundColour(pos, wxColour(180, 180, 180));
331    }
332    m_LastItem = pos;
333}
334
335void AvenTreeCtrl::OnLeaveWindow(wxMouseEvent&)
336{
337    if (m_LastItem.IsOk()) {
338        SetItemBackgroundColour(m_LastItem, m_BackgroundColour);
339        m_LastItem = wxTreeItemId();
340    }
341    m_Parent->DisplayTreeInfo();
342}
343
344void AvenTreeCtrl::OnSelChanged(wxTreeEvent&)
345{
346    m_SelValid = true;
347}
348
349void AvenTreeCtrl::OnItemActivated(wxTreeEvent& e)
350{
351    if (!m_Enabled) return;
352
353    m_Parent->TreeItemSelected(GetItemData(e.GetItem()));
354}
355
356void AvenTreeCtrl::OnMenu(wxTreeEvent& e)
357{
358    if (!m_Enabled) return;
359
360    const TreeData* data = static_cast<const TreeData*>(GetItemData(e.GetItem()));
361    menu_data = data;
362    menu_item = e.GetItem();
363    if (!data) {
364        // Survey tree root:
365        wxMenu menu;
366        /* TRANSLATORS: In aven's survey tree, right-clicking on the root
367         * gives a pop-up menu and this is an option (but only enabled if
368         * the view is restricted to a subsurvey). It reloads the current
369         * survey file with the who survey visible.
370         */
371        menu.Append(menu_SURVEY_SHOW_ALL, wmsg(/*Show all*/245));
372        if (m_Parent->GetSurvey().empty())
373            menu.Enable(menu_SURVEY_SHOW_ALL, false);
374        PopupMenu(&menu);
375    } else if (data->IsStation()) {
376        // Station: name is data->GetLabel()->GetText()
377    } else if (ItemHasChildren(menu_item)) {
378        // Survey:
379        wxMenu menu;
380        /* TRANSLATORS: In aven's survey tree, right-clicking on a survey
381         * name gives a pop-up menu and this is an option.  It reloads the
382         * current survey file with the view restricted to the survey
383         * clicked upon.
384         */
385        menu.Append(menu_SURVEY_RESTRICT, wmsg(/*Hide others*/246));
386        menu.AppendSeparator();
387        menu.Append(menu_SURVEY_HIDE, wmsg(/*&Hide*/407));
388        menu.Append(menu_SURVEY_SHOW, wmsg(/*&Show*/409));
389        menu.Append(menu_SURVEY_HIDE_SIBLINGS, wmsg(/*Hide si&blings*/388));
390        switch (GetItemState(menu_item)) {
391            case STATE_ON: // Currently shown.
392                menu.Enable(menu_SURVEY_SHOW, false);
393                break;
394            case STATE_OFF:
395                menu.Enable(menu_SURVEY_HIDE, false);
396                break;
397        }
398        PopupMenu(&menu);
399    } else {
400        // Overlay - FIXME: menu here?
401    }
402    menu_data = NULL;
403    e.Skip();
404}
405
406bool AvenTreeCtrl::GetSelectionData(wxTreeItemData** data) const
407{
408    assert(m_Enabled);
409    assert(data);
410
411    if (!m_SelValid) {
412        return false;
413    }
414
415    wxTreeItemId id = GetSelection();
416    if (id.IsOk()) {
417        *data = GetItemData(id);
418    }
419
420    return id.IsOk() && *data;
421}
422
423void AvenTreeCtrl::UnselectAll()
424{
425    m_SelValid = false;
426    wxTreeCtrl::UnselectAll();
427}
428
429void AvenTreeCtrl::OnKeyPress(wxKeyEvent &e)
430{
431    switch (e.GetKeyCode()) {
432        case WXK_ESCAPE:
433            m_Parent->ClearTreeSelection();
434            break;
435        case WXK_RETURN: {
436            wxTreeItemId id = GetSelection();
437            if (id.IsOk()) {
438                if (ItemHasChildren(id)) {
439                    // If on a branch, expand/contract it.
440                    if (IsExpanded(id)) {
441                        Collapse(id);
442                    } else {
443                        Expand(id);
444                    }
445                } else {
446                    // If on a station, centre on it by selecting it twice.
447                    m_Parent->TreeItemSelected(GetItemData(id));
448                    m_Parent->TreeItemSelected(GetItemData(id));
449                }
450            }
451            break;
452        }
453        case WXK_LEFT: case WXK_RIGHT: case WXK_UP: case WXK_DOWN:
454        case WXK_HOME: case WXK_END: case WXK_PAGEUP: case WXK_PAGEDOWN:
455            e.Skip();
456            break;
457        default:
458            // Pass key event to MainFrm which will pass to GfxCore which will
459            // pass to GUIControl.
460            m_Parent->OnKeyPress(e);
461            break;
462    }
463}
464
465void AvenTreeCtrl::OnRestrict(wxCommandEvent&)
466{
467    m_Parent->RestrictTo(menu_data && menu_data->IsSurvey() ? menu_data->GetSurvey() : wxString());
468    // FIXME: Overlays
469}
470
471void AvenTreeCtrl::OnHide(wxCommandEvent&)
472{
473    // Shouldn't be available for the root item.
474    wxASSERT(menu_data);
475    // Hide should be disabled if the item is off.
476    wxASSERT(GetItemState(menu_item) != STATE_OFF);
477    SetItemState(menu_item, STATE_OFF);
478    // FIXME: Overlays?
479    filter.remove(menu_data->GetSurvey());
480    Freeze();
481    // Show siblings if not already shown or hidden.
482    wxTreeItemId i = menu_item;
483    while ((i = GetPrevSibling(i)).IsOk()) {
484        if (GetItemState(i) == wxTREE_ITEMSTATE_NONE)
485            SetItemState(i, STATE_ON);
486    }
487    i = menu_item;
488    while ((i = GetNextSibling(i)).IsOk()) {
489        if (GetItemState(i) == wxTREE_ITEMSTATE_NONE)
490            SetItemState(i, STATE_ON);
491    }
492    Thaw();
493    m_Parent->ForceFullRedraw();
494}
495
496void AvenTreeCtrl::OnShow(wxCommandEvent&)
497{
498    // Shouldn't be available for the root item.
499    wxASSERT(menu_data);
500    auto old_state = GetItemState(menu_item);
501    // Show should be disabled for an explicitly shown item.
502    wxASSERT(old_state != STATE_ON);
503    Freeze();
504    SetItemState(menu_item, STATE_ON);
505    // FIXME: Overlays?
506    filter.add(menu_data->GetSurvey());
507    if (old_state == wxTREE_ITEMSTATE_NONE) {
508        // Hide siblings if not already shown or hidden.
509        wxTreeItemId i = menu_item;
510        while ((i = GetPrevSibling(i)).IsOk()) {
511            if (GetItemState(i) == wxTREE_ITEMSTATE_NONE) {
512                const TreeData* data = static_cast<const TreeData*>(GetItemData(i));
513                SetItemState(i, data->IsStation() ? STATE_BLANK : STATE_OFF);
514            }
515        }
516        i = menu_item;
517        while ((i = GetNextSibling(i)).IsOk()) {
518            if (GetItemState(i) == wxTREE_ITEMSTATE_NONE) {
519                const TreeData* data = static_cast<const TreeData*>(GetItemData(i));
520                SetItemState(i, data->IsStation() ? STATE_BLANK : STATE_OFF);
521            }
522        }
523    }
524    Thaw();
525    m_Parent->ForceFullRedraw();
526}
527
528void AvenTreeCtrl::OnHideSiblings(wxCommandEvent&)
529{
530    // Shouldn't be available for the root item.
531    wxASSERT(menu_data);
532    Freeze();
533    // FIXME: Overlays?
534    SetItemState(menu_item, STATE_ON);
535    filter.add(menu_data->GetSurvey());
536
537    wxTreeItemId i = menu_item;
538    while ((i = GetPrevSibling(i)).IsOk()) {
539        const TreeData* data = static_cast<const TreeData*>(GetItemData(i));
540        filter.remove(data->GetSurvey());
541        SetItemState(i, data->IsStation() ? STATE_BLANK : STATE_OFF);
542    }
543    i = menu_item;
544    while ((i = GetNextSibling(i)).IsOk()) {
545        const TreeData* data = static_cast<const TreeData*>(GetItemData(i));
546        filter.remove(data->GetSurvey());
547        SetItemState(i, data->IsStation() ? STATE_BLANK : STATE_OFF);
548    }
549    Thaw();
550    m_Parent->ForceFullRedraw();
551}
552
553void AvenTreeCtrl::OnStateClick(wxTreeEvent& e)
554{
555    auto item = e.GetItem();
556    const TreeData* data = static_cast<const TreeData*>(GetItemData(item));
557    switch (GetItemState(item)) {
558        case STATE_BLANK:
559            // Click on blank state icon for a station - let the tree handle
560            // this in the same way as a click on the label.
561            return;
562        case STATE_ON:
563            if (!ItemHasChildren(item)) {
564                // Overlay.
565                m_Parent->InvalidateOverlays();
566            } else {
567                // Survey.
568                if (data) filter.remove(data->GetSurvey());
569            }
570            SetItemState(item, STATE_OFF);
571            break;
572        case STATE_OFF:
573            if (!ItemHasChildren(item)) {
574                // Overlay.
575                m_Parent->InvalidateOverlays();
576            } else {
577                // Survey.
578                if (data) filter.add(data->GetSurvey());
579            }
580            SetItemState(item, STATE_ON);
581            break;
582    }
583    e.Skip();
584    m_Parent->ForceFullRedraw();
585}
586
587void AvenTreeCtrl::AddOverlay(const wxString& file)
588{
589    char* leaf = leaf_from_fnm(file.utf8_str());
590    auto id = AppendItem(GetRootItem(), leaf);
591    osfree(leaf);
592    SetItemState(id, STATE_ON);
593    SetItemData(id, new TreeData(file));
594}
595
596void AvenTreeCtrl::RemoveOverlay(const wxString& file)
597{
598    // If we add an overlay but fail to load it and remove it again, the
599    // overlay will be the last one, so search from the last one back.
600    for (auto item = GetLastChild(GetRootItem());
601         item.IsOk();
602         item = GetPrevSibling(item)) {
603        if (ItemHasChildren(item)) {
604            // Not an overlay.
605            continue;
606        }
607        const TreeData* data = static_cast<const TreeData*>(GetItemData(item));
608        if (data->GetSurvey() == file) {
609            Delete(item);
610            break;
611        }
612    }
613}
614
615wxTreeItemId AvenTreeCtrl::FirstOverlay()
616{
617    wxTreeItemIdValue cookie;
618    auto item = GetFirstChild(GetRootItem(), cookie);
619    while (item.IsOk() &&
620           (ItemHasChildren(item) || GetItemState(item) != STATE_ON)) {
621        item = GetNextSibling(item);
622    }
623    return item;
624}
625
626wxTreeItemId AvenTreeCtrl::NextOverlay(wxTreeItemId item)
627{
628    do {
629        item = GetNextSibling(item);
630    } while (item.IsOk() &&
631             (ItemHasChildren(item) || GetItemState(item) != STATE_ON));
632    return item;
633}
634
635wxTreeItemId AvenTreeCtrl::RemoveOverlay(wxTreeItemId id)
636{
637    wxTreeItemId item = NextOverlay(id);
638    Delete(id);
639    return item;
640}
641
642const wxString& AvenTreeCtrl::GetOverlayFilename(wxTreeItemId item)
643{
644    if (ItemHasChildren(item)) {
645not_an_overlay:
646        static const wxString empty_string;
647        return empty_string;
648    }
649
650    const TreeData* data = static_cast<const TreeData*>(GetItemData(item));
651    if (!data) goto not_an_overlay;
652    return data->GetSurvey();
653}
Note: See TracBrowser for help on using the repository browser.