forked from gitextensions/gitextensions
-
Notifications
You must be signed in to change notification settings - Fork 0
/
GitExtensionsForm.cs
448 lines (389 loc) · 16.7 KB
/
GitExtensionsForm.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
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
using System;
using System.ComponentModel;
using System.Configuration;
using System.Diagnostics;
using System.Drawing;
using System.Linq;
using System.Windows.Forms;
using GitUI.Properties;
#if !__MonoCS__
using Microsoft.WindowsAPICodePack.Taskbar;
#endif
using ResourceManager;
using Settings = GitCommands.AppSettings;
using System.Collections.Generic;
namespace GitUI
{
/// <summary>Base class for a Git Extensions <see cref="Form"/>.
/// <remarks>
/// Includes support for font, hotkey, icon, translation, and position restore.
/// </remarks></summary>
public class GitExtensionsForm : Form, ITranslate
{
internal static Icon ApplicationIcon = GetApplicationIcon(Settings.IconStyle, Settings.IconColor);
/// <summary>indicates whether the <see cref="Form"/> has been translated</summary>
bool _translated;
/// <summary>indicates whether the <see cref="Form"/>'s position will be restored</summary>
bool _enablePositionRestore;
/// <summary>Creates a new <see cref="GitExtensionsForm"/> without position restore.</summary>
public GitExtensionsForm()
: this(false) { }
/// <summary>Creates a new <see cref="GitExtensionsForm"/> indicating position restore.</summary>
/// <param name="enablePositionRestore">Indicates whether the <see cref="Form"/>'s position
/// will be restored upon being re-opened.</param>
public GitExtensionsForm(bool enablePositionRestore)
{
_enablePositionRestore = enablePositionRestore;
Icon = ApplicationIcon;
SetFont();
ShowInTaskbar = Application.OpenForms.Count <= 0 || (Application.OpenForms.Count == 1 && Application.OpenForms[0] is FormSplash);
var cancelButton = new Button();
cancelButton.Click += CancelButtonClick;
CancelButton = cancelButton;
Load += GitExtensionsFormLoad;
FormClosing += GitExtensionsForm_FormClosing;
}
void GitExtensionsForm_FormClosing(object sender, FormClosingEventArgs e)
{
if (_enablePositionRestore)
SavePosition(GetType().Name);
#if !__MonoCS__
if (GitCommands.Utils.EnvUtils.RunningOnWindows() && TaskbarManager.IsPlatformSupported)
{
try
{
TaskbarManager.Instance.SetProgressState(TaskbarProgressBarState.NoProgress);
}
catch (InvalidOperationException) { }
}
#endif
}
#region Hotkeys
/// <summary>Gets or sets a value that specifies if the hotkeys are used</summary>
protected bool HotkeysEnabled { get; set; }
/// <summary>Gets or sets the hotkeys</summary>
protected IEnumerable<Hotkey.HotkeyCommand> Hotkeys { get; set; }
/// <summary>Overridden: Checks if a hotkey wants to handle the key before letting the message propagate</summary>
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
{
if (HotkeysEnabled && Hotkeys != null)
foreach (var hotkey in Hotkeys)
{
if (hotkey != null && hotkey.KeyData == keyData)
{
return ExecuteCommand(hotkey.CommandCode);
}
}
return base.ProcessCmdKey(ref msg, keyData);
}
protected Keys GetShortcutKeys(int commandCode)
{
var hotkey = GetHotkeyCommand(commandCode);
return hotkey == null ? Keys.None : hotkey.KeyData;
}
protected Hotkey.HotkeyCommand GetHotkeyCommand(int commandCode)
{
if (Hotkeys == null)
return null;
return Hotkeys.FirstOrDefault(h => h.CommandCode == commandCode);
}
/// <summary>Override this method to handle form-specific Hotkey commands.</summary>
protected virtual bool ExecuteCommand(int command)
{
return false;
}
#endregion
private void SetFont()
{
Font = Settings.Font;
}
#region icon
protected void RotateApplicationIcon()
{
ApplicationIcon = GetApplicationIcon(Settings.IconStyle, Settings.IconColor);
Icon = ApplicationIcon;
}
/// <summary>Specifies a Git Extensions' color index.</summary>
protected enum ColorIndex
{
Default,
Blue,
Green,
LightBlue,
Purple,
Red,
Yellow,
Unknown = -1
}
protected static ColorIndex GetColorIndexByName(string color)
{
switch (color)
{
case "default":
return ColorIndex.Default;
case "blue":
return ColorIndex.Blue;
case "green":
return ColorIndex.Green;
case "lightblue":
return ColorIndex.LightBlue;
case "purple":
return ColorIndex.Purple;
case "red":
return ColorIndex.Red;
case "yellow":
return ColorIndex.Yellow;
case "random":
return (ColorIndex)new Random(DateTime.Now.Millisecond).Next(7);
}
return ColorIndex.Unknown;
}
public static Icon GetApplicationIcon(string iconStyle, string iconColor)
{
var colorIndex = (int)GetColorIndexByName(iconColor);
if (colorIndex == (int) ColorIndex.Unknown)
colorIndex = 0;
Icon appIcon;
if (iconStyle.Equals("small", StringComparison.OrdinalIgnoreCase))
{
Icon[] icons = {
Resources.x_with_arrow,
Resources.x_with_arrow_blue,
Resources.x_with_arrow_green,
Resources.x_with_arrow_lightblue,
Resources.x_with_arrow_purple,
Resources.x_with_arrow_red,
Resources.x_with_arrow_yellow
};
Debug.Assert(icons.Length == 7);
appIcon = icons[colorIndex];
}
else if (iconStyle.Equals("large", StringComparison.OrdinalIgnoreCase))
{
Icon[] icons = {
Resources.git_extensions_logo_final,
Resources.git_extensions_logo_final_blue,
Resources.git_extensions_logo_final_green,
Resources.git_extensions_logo_final_lightblue,
Resources.git_extensions_logo_final_purple,
Resources.git_extensions_logo_final_red,
Resources.git_extensions_logo_final_yellow
};
Debug.Assert(icons.Length == 7);
appIcon = icons[colorIndex];
}
else if (iconStyle.Equals("cow", StringComparison.OrdinalIgnoreCase))
{
Icon[] icons = {
Resources.cow_head,
Resources.cow_head_blue,
Resources.cow_head_green,
Resources.cow_head_blue,
Resources.cow_head_purple,
Resources.cow_head_red,
Resources.cow_head_yellow
};
Debug.Assert(icons.Length == 7);
appIcon = icons[colorIndex];
}
else
{
Icon[] icons = {
Resources.git_extensions_logo_final_mixed,
Resources.git_extensions_logo_final_mixed_blue,
Resources.git_extensions_logo_final_mixed_green,
Resources.git_extensions_logo_final_mixed_lightblue,
Resources.git_extensions_logo_final_mixed_purple,
Resources.git_extensions_logo_final_mixed_red,
Resources.git_extensions_logo_final_mixed_yellow
};
Debug.Assert(icons.Length == 7);
appIcon = icons[colorIndex];
}
Debug.Assert(appIcon != null);
return appIcon;
}
#endregion icon
/// <summary>Indicates whether this is a valid <see cref="IComponent"/> running in design mode.</summary>
static bool CheckComponent(object value)
{
var component = value as IComponent;
if (component == null)
return false;
var site = component.Site;
return (site != null) && site.DesignMode;
}
/// <summary>Invoked at runtime during the <see cref="OnLoad"/> method.</summary>
protected virtual void OnRuntimeLoad(EventArgs e)
{
}
/// <summary>Sets <see cref="AutoScaleMode"/>,
/// restores position, raises the <see cref="Form.Load"/> event,
/// and .
/// </summary>
protected override void OnLoad(EventArgs e)
{
AutoScaleMode = Settings.EnableAutoScale
? AutoScaleMode.Dpi
: AutoScaleMode.None;
if (_enablePositionRestore)
RestorePosition(GetType().Name);
base.OnLoad(e);
if (!CheckComponent(this))
OnRuntimeLoad(e);
}
private void GitExtensionsFormLoad(object sender, EventArgs e)
{
// find out if the value is a component and is currently in design mode
var isComponentInDesignMode = CheckComponent(this);
if (!_translated && !isComponentInDesignMode)
throw new Exception("The control " + GetType().Name +
" is not translated in the constructor. You need to call Translate() right after InitializeComponent().");
}
/// <summary>Translates the <see cref="Form"/>'s fields and properties, including child controls.</summary>
protected void Translate()
{
Translator.Translate(this, Settings.CurrentTranslation);
_translated = true;
}
public virtual void CancelButtonClick(object sender, EventArgs e)
{
Close();
}
private bool _windowCentred;
/// <summary>
/// Restores the position of a form from the user settings. Does
/// nothing if there is no entry for the form in the settings, or the
/// setting would be invisible on the current display configuration.
/// </summary>
/// <param name = "name">The name to use when looking up the position in
/// the settings</param>
private void RestorePosition(String name)
{
if (!Visible ||
WindowState == FormWindowState.Minimized)
return;
_windowCentred = (StartPosition == FormStartPosition.CenterParent);
var position = LookupWindowPosition(name);
if (position == null)
return;
StartPosition = FormStartPosition.Manual;
if (FormBorderStyle == FormBorderStyle.Sizable ||
FormBorderStyle == FormBorderStyle.SizableToolWindow)
Size = position.Rect.Size;
if (Owner == null || !_windowCentred)
{
Point location = position.Rect.Location;
Rectangle? rect = FindWindowScreen(location);
if (rect != null)
location.Y = rect.Value.Y;
DesktopLocation = location;
}
else
{
// Calculate location for modal form with parent
Location = new Point(Owner.Left + Owner.Width / 2 - Width / 2,
Math.Max(0, Owner.Top + Owner.Height / 2 - Height / 2));
}
WindowState = position.State;
}
static Rectangle? FindWindowScreen(Point location)
{
SortedDictionary<float, Rectangle> distance = new SortedDictionary<float, Rectangle>();
foreach (var rect in (from screen in Screen.AllScreens
select screen.WorkingArea))
{
if (rect.Contains(location) && !distance.ContainsKey(0.0f))
return null; // title in screen
int midPointX = (rect.X + rect.Width / 2);
int midPointY = (rect.Y + rect.Height / 2);
float d = (float)Math.Sqrt((location.X - midPointX) * (location.X - midPointX) +
(location.Y - midPointY) * (location.Y - midPointY));
distance.Add(d, rect);
}
if (distance.Count > 0)
{
return distance.First().Value;
}
else
{
return null;
}
}
/// <summary>
/// Save the position of a form to the user settings. Hides the window
/// as a side-effect.
/// </summary>
/// <param name = "name">The name to use when writing the position to the
/// settings</param>
private void SavePosition(String name)
{
try
{
var rectangle =
WindowState == FormWindowState.Normal
? DesktopBounds
: RestoreBounds;
var formWindowState =
WindowState == FormWindowState.Maximized
? FormWindowState.Maximized
: FormWindowState.Normal;
// Write to the user settings:
if (Properties.Settings.Default.WindowPositions == null)
Properties.Settings.Default.WindowPositions = new WindowPositionList();
WindowPosition windowPosition = (WindowPosition)Properties.Settings.Default.WindowPositions[name];
// Don't save location when we center modal form
if (windowPosition != null && Owner != null && _windowCentred)
{
if (rectangle.Width <= windowPosition.Rect.Width && rectangle.Height <= windowPosition.Rect.Height)
rectangle.Location = windowPosition.Rect.Location;
}
var position = new WindowPosition(rectangle, formWindowState);
Properties.Settings.Default.WindowPositions[name] = position;
Properties.Settings.Default.Save();
}
catch (ConfigurationException)
{
//TODO: howto restore a corrupted config? Properties.Settings.Default.Reset() doesn't work.
}
}
/// <summary>
/// Looks up a window in the user settings and returns its saved position.
/// </summary>
/// <param name = "name">The name.</param>
/// <returns>
/// The saved window position if it exists. Null if the entry
/// doesn't exist, or would not be visible on any screen in the user's
/// current display setup.
/// </returns>
private static WindowPosition LookupWindowPosition(String name)
{
try
{
var list = Properties.Settings.Default.WindowPositions;
if (list == null)
return null;
var position = (WindowPosition)list[name];
if (position == null || position.Rect.IsEmpty)
return null;
if (Screen.AllScreens.Any(screen => screen.WorkingArea.IntersectsWith(position.Rect)))
{
return position;
}
}
catch (ConfigurationException)
{
//TODO: howto restore a corrupted config? Properties.Settings.Default.Reset() doesn't work.
}
return null;
}
public virtual void AddTranslationItems(ITranslation translation)
{
TranslationUtils.AddTranslationItemsFromFields(Name, this, translation);
}
public virtual void TranslateItems(ITranslation translation)
{
TranslationUtils.TranslateItemsFromFields(Name, this, translation);
}
}
}