forked from rubberduck-vba/Rubberduck
-
Notifications
You must be signed in to change notification settings - Fork 12
/
AppCommandBarBase.cs
278 lines (254 loc) · 9.29 KB
/
AppCommandBarBase.cs
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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.InteropServices;
using System.Threading;
using System.Threading.Tasks;
using NLog;
using Rubberduck.Parsing.UIContext;
using Rubberduck.Parsing.VBA;
using Rubberduck.VBEditor.SafeComWrappers;
using Rubberduck.VBEditor.SafeComWrappers.Abstract;
namespace Rubberduck.UI.Command.MenuItems.CommandBars
{
public abstract class AppCommandBarBase : IAppCommandBar
{
private readonly string _name;
private readonly CommandBarPosition _position;
private readonly IDictionary<ICommandMenuItem, ICommandBarControl> _items;
protected readonly IUiDispatcher _uiDispatcher;
protected static readonly Logger Logger = LogManager.GetCurrentClassLogger();
protected AppCommandBarBase(string name, CommandBarPosition position, IEnumerable<ICommandMenuItem> items, IUiDispatcher uiDispatcher)
{
_name = name;
_position = position;
_items = items.ToDictionary(item => item, item => null as ICommandBarControl);
_uiDispatcher = uiDispatcher;
}
protected ICommandMenuItem FindChildByTag(string tag)
{
try
{
var child = _items.FirstOrDefault(kvp => kvp.Value != null && kvp.Value?.Tag == tag);
return Equals(child, default(KeyValuePair<ICommandMenuItem, ICommandBarControl>))
? null
: child.Key;
}
catch (COMException exception)
{
Logger.Error(exception, $"COMException while finding child with tag '{tag}' in the command bar.");
}
catch (InvalidCastException exception)
{
//This exception will be encountered whenever the registration of the command bar control not correct in the system.
//See issue #5349 at https://github.com/rubberduck-vba/Rubberduck/issues/5349
Logger.Error(exception, $"Invalid cast exception while finding child with tag '{tag}' in the command bar.");
}
return null;
}
public void Localize()
{
if (Item == null)
{
return;
}
foreach (var kvp in _items.Where(kv => kv.Key != null && kv.Value != null && !kv.Value.IsWrappingNullReference))
{
try
{
var item = kvp;
_uiDispatcher.Invoke(() => LocalizeInternal(item, kvp));
}
catch (Exception e)
{
Logger.Error(e, $"Failed to dispatch assignment of {kvp.Value.GetType().Name}.Caption and .TooltipText for {kvp.Key.GetType().Name} to the UI thread.");
}
}
}
private static void LocalizeInternal(KeyValuePair<ICommandMenuItem, ICommandBarControl> item, KeyValuePair<ICommandMenuItem, ICommandBarControl> kvp)
{
try
{
item.Value.Caption = item.Key.Caption.Invoke();
item.Value.TooltipText = item.Key.ToolTipText.Invoke();
}
catch (Exception e)
{
Logger.Error(e,
$"Assignment of {kvp.Value.GetType().Name}.Caption or .TooltipText for {kvp.Key.GetType().Name} threw an exception.");
}
}
public virtual void Initialize()
{
if (Parent == null || Parent.IsWrappingNullReference)
{
return;
}
try
{
Item = Parent.Add(_name, _position);
Item.IsVisible = true;
}
catch (COMException exception)
{
Logger.Error(exception, $"Failed to add the command bar {_name}.");
return;
}
foreach (var item in _items.Keys.OrderBy(item => item.DisplayOrder))
{
try
{
_items[item] = InitializeChildControl(item);
}
catch (Exception e)
{
Logger.Error(e, $"Initialization of the menu item for {item.Command.GetType().Name} threw an exception.");
}
}
}
private ICommandBarControl InitializeChildControl(ICommandMenuItem item)
{
if (item == null)
{
return null;
}
ICommandBarButton child;
using (var controls = Item.Controls)
{
child = controls.AddButton();
}
child.Style = item.ButtonStyle;
child.Picture = item.Image;
child.Mask = item.Mask;
child.ApplyIcon();
child.IsVisible = item.IsVisible;
child.BeginsGroup = item.BeginGroup;
child.Tag = item.GetType().FullName;
child.Caption = item.Caption.Invoke();
child.TooltipText = item.ToolTipText.Invoke();
if (item.Command != null)
{
child.Click += Child_Click;
}
return child;
}
public async Task EvaluateCanExecuteAsync(RubberduckParserState state, CancellationToken token)
{
var usableMenuItems = _items.Where(kv => kv.Key != null && kv.Value != null && !kv.Value.IsWrappingNullReference);
foreach (var kvp in usableMenuItems)
{
token.ThrowIfCancellationRequested();
var commandItem = kvp.Key;
var canExecute = false;
try
{
canExecute = await Task.Run(() => commandItem.EvaluateCanExecute(state), token);
}
catch (Exception e)
{
Logger.Error(e,
$"{commandItem?.GetType().Name ?? nameof(ICommandMenuItem)}.EvaluateCanExecute(RubberduckParserState) threw an exception.");
}
token.ThrowIfCancellationRequested();
try
{
_uiDispatcher.InvokeAsync(() =>
{
kvp.Value.IsEnabled = canExecute;
if (commandItem?.HiddenWhenDisabled ?? false)
{
kvp.Value.IsVisible = canExecute;
}
});
}
catch (Exception exception)
{
Logger.Error(exception,
$"Setting IsEnabled and IsVisible on {commandItem?.GetType().Name ?? nameof(ICommandMenuItem)} threw an exception.");
}
}
}
private ICommandBars _parent;
public ICommandBars Parent
{
get => _parent;
set
{
_parent?.Dispose();
_parent = value;
}
}
private ICommandBar _item;
public ICommandBar Item
{
get => _item;
private set
{
_item?.Dispose();
_item = value;
}
}
public void RemoveCommandBar()
{
try
{
if (Item != null)
{
Logger.Debug("Removing commandbar.");
RemoveChildren();
Item.Delete();
// Setting them to null will automatically dispose those
Item = null;
Parent = null;
}
}
catch (COMException exception)
{
Logger.Error(exception, "COM exception while trying to delete the commandbar");
}
}
private void RemoveChildren()
{
if (Parent == null || Parent.IsWrappingNullReference)
{
return;
}
try
{
foreach (var button in _items.Values.Select(item => item as ICommandBarButton).Where(child => child != null))
{
if (!button.IsWrappingNullReference)
{
button.Click -= Child_Click;
}
button.Delete();
button.Dispose();
}
}
catch (COMException exception)
{
Logger.Error(exception, "Error removing child controls from commandbar.");
}
_items.Clear();
}
private void Child_Click(object sender, CommandBarButtonClickEventArgs e)
{
ICommandMenuItem item;
try
{
item = _items.Select(kvp => kvp.Key).SingleOrDefault(menu => menu.GetType().FullName == e.Tag);
}
catch (COMException exception)
{
Logger.Error(exception, "COM exception finding command for a control.");
item = null;
}
if (item == null)
{
return;
}
Logger.Debug("({0}) Executing click handler for commandbar item '{1}', hash code {2}", GetHashCode(), e.Caption, e.TargetHashCode);
item.Command.Execute(null);
}
}
}