-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathAutoCorrect2.ahk
2730 lines (2232 loc) · 117 KB
/
AutoCorrect2.ahk
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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
; This is AutoCorrect2, with HotstringHelper2
#SingleInstance Force
#Requires AutoHotkey v2.0
SetWorkingDir(A_ScriptDir)
; ========================================
; A comprehensive tool for creating, managing, and analyzing hotstrings
; Version: 4-24-2025
; Author: kunkel321
; In March 2025 it got a major refactor/rewrite using Claude AT.
; The bottom components became a separate, included, file (AutoCorrectSystem.ahk)
; Thread on AutoHotkey forums:
; https://www.autohotkey.com/boards/viewtopic.php?f=83&t=120220
; Project location on GitHub (new versions will be on GitHub)
; https://github.com/kunkel321/AutoCorrect2
; ========================================
; =============== INCLUDES ===============
; These files need to be in the same directory or properly referenced
; =============== INCLUDES ===============
#Include "AutoCorrectSystem.ahk" ; Autocorrection module -- REQUIRED
#Include "HotstringLib.ahk" ; Library of hotstrings -- REQUIRED
#Include "DateTool.ahk" ; Calendar tool with holidays -- Optional
#Include "PrinterTool.ahk" ; Shows list of installed printers -- Optional
#Include "DragTools.ahk" ; Mouse click/drags trigger things -- Optional
; =============== CONFIGURATION ===============
; The configuration is centralized here for easier modification
; In the Config class
class Config {
; ===== General Configuration =====
static ScriptName := "AutoCorrect2.ahk"
static HHWindowTitle := "HotstringHelper2" ; Appears in title bar of HotstringHelper window.
static HotstringLibrary := "HotstringLib.ahk"
static RemovedHsFile := "RemovedHotstrings.txt"
static AutoCorrectsLogFile := "AutoCorrectsLog.txt"
static ErrContextLog := "ErrContextLog.txt"
static ACLogAnalyzer := "AcLogAnalyzer.exe"
static CODE_ERROR_LOG := 0 ; Set to 1 for error logging.
static CODE_DEBUG_LOG := 0 ; Set to 1 for copious debug logging (recommended: 0)
; ===== Activation Hotkey =====
static ActivationHotkey := "#h" ; Win+h
static DefaultFontSize := "s11"
static LargeFontSize := "s15"
static Brightness := 128 ; Add default brightness value
; ===== GUI Sizing =====
static HeightSizeIncrease := 300
static WidthSizeIncrease := 400
static DefaultWidth := 366 ; 366 recommended.
; ===== Symbols for Visual Display =====
static PilcrowSymbol := "¶" ; Symbol for Enter
static DotSymbol := "• " ; Symbol for Space. "Dot-space" allows better wrapping.
static TabSymbol := "⟹ " ; Symbol for Tab. "Arrow-space" allows better wrapping.
; ===== Multi-word Entry Options =====
static DefaultBoilerPlateOpts := "" ; Options for boilerplate/template triggers
static BoilerplatePrefix := ";" ; Prefix for boilerplate triggers
static BoilerplateSuffix := "" ; Suffix for boilerplate triggers
static FirstLettersToInclude := 5 ; Number of first letters to extract
static MinWordLength := 2 ; Only extract first letters from words longer than this
; ===== AutoCorrect Options =====
static DefaultAutoCorrectOpts := "B0X" ; Default options for autocorrect entries
static MakeFuncByDefault := 1 ; Check "Make Function" box by default?
static AutoCommentWithFreqAndStats := 1 ; Add "Web Freq X | Fixes Y words, but misspells Z" comments?
static AutoEnterNewEntry := 1 ; Auto-enter the new replacement in active field?
; ===== Word Lists =====
static WordListFolder := A_ScriptDir "\WordListsForHH"
static WordListFile := "GitHubComboList249k.txt"
; ===== Validity Dialog =====
static ValidOkMessage := "-no problems found"
; static ValidityDialogGreen := "" ; Will be set during initialization
; static ValidityDialogRed := "" ; Will be set during initialization
static ValidityDialogFont := "s15"
; ===== Editor =====
static DefaultEditor := "Notepad.exe" ; This is backup, incase VSCode is not found.
; ===== Appearance =====
static FormColor := "0xE5E4E2" ; Default - will be overridden if theme file exists
static FontColor := "c0x1F1F1F" ; Default - will be overridden if theme file exists
static ListColor := "0xFFFFFF" ; Default - will be overridden if theme file exists
; Calculate brightness from form color
static CalculateBrightness() {
formColor := this.FormColor
; Convert hex string to number if needed
if Type(formColor) = "String" && InStr(formColor, "0x") {
formColor := Integer("0x" SubStr(formColor, 3))
}
if formColor is Number {
r := (formColor >> 16) & 0xFF
g := (formColor >> 8) & 0xFF
b := formColor & 0xFF
this.Brightness := (r * 299 + g * 587 + b * 114) / 1000
}
return this.Brightness
}
; Initialize with calculated values
static Init() {
; Load color settings from theme file if it exists
if FileExist("colorThemeSettings.ini") {
settingsFile := "colorThemeSettings.ini"
; --- Get current colors from ini file.
this.FontColor := "c" IniRead(settingsFile, "ColorSettings", "fontColor")
this.ListColor := IniRead(settingsFile, "ColorSettings", "listColor")
this.FormColor := IniRead(settingsFile, "ColorSettings", "formColor")
}
; Calculate brightness and set dependent colors
this.CalculateBrightness()
this.ValidityDialogGreen := this.Brightness < 128 ? "cb8f3ab" : "c0d3803"
this.ValidityDialogRed := this.Brightness < 128 ? "cfd7c73" : "cB90012"
; Calculate full path to word list
this.WordListPath := this.WordListFolder "\" this.WordListFile
; Extract just the filename from the path
SplitPath this.WordListPath, &WordListName
this.WordListName := WordListName
; Try to find VSCode if available
this.EditorPath := "C:\Users\" A_UserName "\AppData\Local\Programs\Microsoft VS Code\Code.exe"
if !FileExist(this.EditorPath)
this.EditorPath := this.DefaultEditor
}
}
; Initialize configuration
Config.Init()
; =============== TRAY MENU SETUP ===============
SetupTrayMenu() {
acMenu := A_TrayMenu
acMenu.Delete
acMenu.SetColor("Silver")
acMenu.Add(Config.ScriptName, (*) => Utils.CheckClipboard()) ; Opens hh2 gui.
acMenu.SetIcon(Config.ScriptName, "Icons\AhkBluePsicon.ico")
acMenu.Default := Config.ScriptName
acMenu.Add("Edit This Script", (*) => EditThisScript())
acMenu.SetIcon("Edit This Script", "Icons\edit-Blue.ico")
acMenu.Add("Hotstring Library", (*) => OpenHotstringLibrary())
acMenu.SetIcon("Hotstring Library", "Icons\library-Blue.ico")
acMenu.Add("Run Printer Tool", (*) => RunPrinterTool())
acMenu.SetIcon("Run Printer Tool", "Icons\printer-Blue.ico")
acMenu.Add("Show Calendar", (*) => RunDateTool())
acMenu.SetIcon("Show Calendar", "Icons\calendar-Blue.ico")
acMenu.Add("System Up Time", (*) => UpTime())
acMenu.SetIcon("System Up Time", "Icons\clock-Blue.ico")
acMenu.Add("Reload Script", (*) => Reload())
acMenu.SetIcon("Reload Script", "icons/repeat-Blue.ico")
acMenu.Add("List Lines Debug", (*) => ListLines())
acMenu.SetIcon("List Lines Debug", "icons/ListLines-Blue.ico")
acMenu.Add("Exit Script", (*) => ExitApp())
acMenu.SetIcon("Exit Script", "icons/exit-Blue.ico")
acMenu.Add("Start with Windows", (*) => StartUpAC()) ; Add menu item at the bottom.
if FileExist(A_Startup "\" Config.ScriptName ".lnk")
acMenu.Check("Start with Windows")
; This function is only accessed via the systray menu item. It toggles adding/removing
; link to this script in Windows Start up folder. Applies custom icon too.
StartUpAC(*) {
if FileExist(A_Startup "\" Config.ScriptName ".lnk") {
FileDelete(A_Startup "\" Config.ScriptName ".lnk")
MsgBox("" Config.ScriptName " will NO LONGER auto start with Windows.",, 4096)
} Else {
FileCreateShortcut(A_WorkingDir "\" Config.ScriptName ".exe", A_Startup "\" Config.ScriptName ".lnk"
, A_WorkingDir, "", "", A_ScriptDir "\Icons\AhkBluePsicon.ico")
MsgBox(Config.ScriptName " will now auto start with Windows.",, 4096)
}
Reload()
}
}
^+e:: ; Open AutoCorrect2 script in VSCode
EditThisScript(*) {
Try
Run Config.EditorPath " " Config.ScriptName
Catch
msgbox 'cannot run ' Config.ScriptName
}
OpenHotstringLibrary(*) {
Run A_ScriptDir "\Code.exe " A_ScriptDir "\" Config.HotstringLibrary
}
; PrinterTool and DateTool are #Included, so we could call the functions directly, but we should
; get an error if the script ever wasn't included. Sending the hotkey prevents this.
RunPrinterTool(*) {
Send "!+p"
}
RunDateTool(*) {
Send "!+d"
}
!+u:: ; Uptime -- time since Windows restart
UpTime(*) {
MsgBox("UpTime is:`n" . Uptime(A_TickCount))
Uptime(ms) {
VarSetStrCapacity(&b, 256) ; V1toV2: if 'b' is NOT a UTF-16 string, use 'b := Buffer(256)'
; DllCall("GetDurationFormat","uint",2048,"uint",0,"ptr",0,"int64",ms*10000,"wstr"," d 'days, 'h' hours, 'm' minutes, 's' seconds'", "wstr",b,"int",256)
DllCall("GetDurationFormat", "uint", 2048, "uint", 0, "ptr", 0, "int64", ms * 10000, "wstr", " d 'days, 'h' hours, 'm' minutes'", "wstr", b, "int", 256)
b := StrReplace(b, " 0 days,")
b := StrReplace(b, " 0 hours,")
b := StrReplace(b, " 0 minutes,")
b := StrReplace(b, " 1 days,", "1 day,")
b := StrReplace(b, " 1 hours,", " 1 hour,")
b := StrReplace(b, " 1 minutes,", " 1 minute,")
; b := StrReplace(b," 1 seconds"," 1 second")
return b
}
}
; =============== INITIALIZATION ===============
; Set up the application
; Initialize tray menu
SetupTrayMenu()
; Startup announcement
SoundBeep(900, 200)
SoundBeep(1100, 150)
; Initialize BackspaceContextLogger after startup is complete
SetTimer(() => BackspaceContextLogger.Start(), 1000) ; Start after 1 second delay
; Main application loop
; The script continues running, processing hotstrings and handling events
; Note: Your hotstrings are defined in HotstringLib.ahk and call the f() function
; from AutoCorrectSystem.ahk when triggered.
; Example hotstring:
; :B0X:teh::f("the") ; Fixes 1 word
; =============== GLOBAL VARIABLES ===============
; These variables track state throughout the application
class State {
; UI State
static ExamPaneOpen := 0
static ControlPaneOpen := 0
static FormBig := 0
static SymbolsVisible := 0
static CurrentEdit := 0
; History for undo
static TriggerHistory := []
static ReplacementHistory := []
; Original values for restoration
static OrigTrigger := ""
static OrigReplacement := ""
static TrigNeedle_Orig := ""
; Statistics
static TriggerMatches := 0
static ReplacementMatches := 0
; Clipboard state
static ClipboardOld := ""
; Target window for auto-entry
static TargetWindow := 0
static OrigTriggerTypo := ""
; Type of content detected
static IsBoilerplate := 0
; Dictionary initialized state
static DictInitialized := 0
; Reset state to defaults
static Reset() {
this.ExamPaneOpen := 0
this.ControlPaneOpen := 0
this.FormBig := 0
this.SymbolsVisible := 0
this.TriggerHistory := []
this.ReplacementHistory := []
this.OrigTrigger := ""
this.OrigReplacement := ""
this.TrigNeedle_Orig := ""
this.TriggerMatches := 0
this.ReplacementMatches := 0
this.IsBoilerplate := 0
}
}
; =============== UI COMPONENT CREATION ===============
class UI {
static MainForm := 0
static Controls := Map()
static ListBackground := ""
static DeltaColor := ""
; Initialize and build the main UI
static Init() {
; Create main GUI
this.MainForm := Gui("", Config.HHWindowTitle)
this.MainForm.Opt("-MinimizeBox +AlwaysOnTop")
try this.MainForm.BackColor := Config.FormColor
; Set font settings
fontColor := Config.FontColor != "" ? "c" SubStr(Config.FontColor, -6) : ""
this.MainForm.SetFont(Config.DefaultFontSize " " fontColor)
; Set background color for edit controls - defined once for the whole class
this.ListBackground := Config.ListColor != "" ? "Background" Config.ListColor : ""
; Set delta color based on brightness - defined once for the whole class
this.DeltaColor := Config.Brightness < 128 ? "00FFFF" : "191970"
; Build UI sections
this._CreateTriggerSection()
this._CreateReplacementSection()
this._CreateCommentSection()
this._CreateButtonSection()
this._CreateExamPane()
this._CreateControlPane()
; Set up event handlers
this._SetupEventHandlers()
; Hide panes by default
UIActions.ShowHideExamPane(false)
UIActions.ShowHideControlPane(false)
}
; Create the trigger string section
static _CreateTriggerSection() {
this.MainForm.AddText("y4 w30", "Options")
this.Controls["TriggerLabel"] := this.MainForm.AddText("x+40 w250", "Trigger String")
; Set background color for edit controls
this.ListBackground := Config.ListColor != "" ? "Background" Config.ListColor : ""
; Add the option and trigger input fields
this.Controls["OptionsEdit"] := this.MainForm.AddEdit(this.ListBackground " yp+20 xm+2 w70 h24")
this.Controls["TriggerEdit"] := this.MainForm.AddEdit(this.ListBackground " x+18 w" Config.DefaultWidth - 91)
; Add the help button
this.Controls["HelpButton"] := this.MainForm.AddButton("x" (Config.DefaultWidth - 10) " y2 w25 h20", "?")
this.Controls["HelpButton"].OnEvent("Click", (*) => HelpSystem.ShowHelp(true))
}
; Create the replacement string section
static _CreateReplacementSection() {
this.MainForm.AddText("xm", "Replacement")
; Set smaller font for the toggle buttons
this.MainForm.SetFont("s9")
; Add size toggle and symbols toggle buttons
this.Controls["SizeToggle"] := this.MainForm.AddButton("x+75 yp-5 h8", "Make Bigger")
this.Controls["SymbolToggle"] := this.MainForm.AddButton("x+5 h8", "Show Symbols")
; Reset font size
this.MainForm.SetFont(Config.DefaultFontSize)
; Set background color for edit controls (copied from _CreateTriggerSection)
this.ListBackground := Config.ListColor != "" ? "Background" Config.ListColor : ""
; Add the replacement edit control
this.Controls["ReplacementEdit"] := this.MainForm.AddEdit(this.ListBackground " +Wrap y+1 xs h100 w" Config.DefaultWidth)
}
; Create the comment section
static _CreateCommentSection() {
this.Controls["CommentLabel"] := this.MainForm.AddText("xm y182", "Comment")
this.Controls["FunctionCheck"] := this.MainForm.AddCheckbox("x+70 y182", "Make Function")
; Set background color for edit controls (same as in other sections)
this.ListBackground := Config.ListColor != "" ? "Background" Config.ListColor : ""
this.Controls["CommentEdit"] := this.MainForm.AddEdit(this.ListBackground " cGreen xs y200 w" Config.DefaultWidth)
}
; Create the action buttons
static _CreateButtonSection() {
buttonWidth := (Config.DefaultWidth / 6) - 4
this.Controls["AppendButton"] := this.MainForm.AddButton("xm y234 w" buttonWidth, "Append")
this.Controls["CheckButton"] := this.MainForm.AddButton("x+5 y234 w" buttonWidth, "Check")
this.Controls["ExamButton"] := this.MainForm.AddButton("x+5 y234 w" buttonWidth, "Exam")
this.Controls["SpellButton"] := this.MainForm.AddButton("x+5 y234 w" buttonWidth, "Spell")
this.Controls["LookButton"] := this.MainForm.AddButton("x+5 y234 w" buttonWidth, "Look")
this.Controls["CancelButton"] := this.MainForm.AddButton("x+5 y234 w" buttonWidth, "Cancel")
}
; Create the examination pane (initially hidden)
static _CreateExamPane() {
; Set font for delta string display
this.MainForm.SetFont("s10")
; Add left/right trim buttons and delta string
this.Controls["LeftTrimButton"] := this.MainForm.AddButton("xm h50 w" (Config.DefaultWidth / 8), ">>")
this.MainForm.SetFont("s14")
deltaColor := Config.brightness < 128 ? "00FFFF" : "191970"
this.Controls["DeltaString"] := this.MainForm.AddText("center c" deltaColor " x+1 w" (Config.DefaultWidth * 3 / 4), "")
this.MainForm.SetFont("s10")
this.Controls["RightTrimButton"] := this.MainForm.AddButton("x+1 h50 w" (Config.DefaultWidth / 8), "<<")
; Add radio buttons for match type
this.MainForm.SetFont(Config.DefaultFontSize)
this.Controls["BeginningRadio"] := this.MainForm.AddRadio("y+-18 x" (Config.DefaultWidth / 6) + 7, "&Beginnings")
this.Controls["MiddleRadio"] := this.MainForm.AddRadio("x+5", "&Middles")
this.Controls["EndingRadio"] := this.MainForm.AddRadio("x+5", "&Endings")
; Add undo button
this.Controls["UndoButton"] := this.MainForm.AddButton("xm y+3 h26 w" Config.DefaultWidth, "Undo (+Reset)")
this.Controls["UndoButton"].Enabled := false
; Add match list labels and edit boxes
this.Controls["TriggerFreqLabel"] := this.MainForm.AddText("center y+4 h25 xm w" Config.DefaultWidth / 2, "Web Freq [0]")
this.Controls["ReplacementFreqLabel"] := this.MainForm.AddText("center h25 x+5 w" Config.DefaultWidth / 2, "Web Freq [0]")
this.Controls["TriggerMatchLabel"] := this.MainForm.AddText("center y+-2 h25 xm w" Config.DefaultWidth / 2, "Misspells [0]")
this.Controls["ReplacementMatchLabel"] := this.MainForm.AddText("center h25 x+5 w" Config.DefaultWidth / 2, "Fixes [0]")
this.Controls["TriggerMatchesEdit"] := this.MainForm.AddEdit(this.listBackground " y+0 xm h" Config.HeightSizeIncrease " w" Config.DefaultWidth / 2)
this.Controls["ReplacementMatchesEdit"] := this.MainForm.AddEdit(this.listBackground " x+5 h" Config.HeightSizeIncrease " w" Config.DefaultWidth / 2)
}
; Create the control pane (initially hidden)
static _CreateControlPane() {
; Configuration for control panel buttons
this.Controls["ControlPanelLabel"] := this.MainForm.AddText("center c" this.DeltaColor " ym+270 h25 xm w" Config.DefaultWidth, "Secret Control Panel!")
this.MainForm.SetFont("s10")
; Initialize the buttons array
this.controlButtons := []
; Add always-present buttons first
this.controlButtons.Push({
text: "Open HotString Library",
action: (*) => UIActions.OpenHotstringLibrary(),
icon: ""
})
; Add log-related buttons only if logging is enabled
if (IsSet(EnableLogging) && EnableLogging = 1) {
this.controlButtons.Push({
text: "Open AutoCorrection Log",
action: (*) => Run(Config.AutoCorrectsLogFile),
icon: ""
})
this.controlButtons.Push({
text: " Analyze AutoCorrection Log !^+Q",
action: (*) => Run(Config.AcLogAnalyzer),
icon: A_ScriptDir "\Icons\AcAnalysis.ico"
})
this.controlButtons.Push({
text: "Open Backspace Context Log",
action: (*) => Run(Config.ErrContextLog),
icon: ""
})
this.controlButtons.Push({
text: "Open Removed HotStrings List",
action: (*) => Run(Config.RemovedHsFile),
icon: ""
})
}
; Add remaining buttons regardless of logging status
this.controlButtons.Push({
text: "Open Manual Correction Log",
action: (*) => Run("MCLog.txt"),
icon: ""
})
this.controlButtons.Push({
text: " Analyze Manual Correction Log #^+Q",
action: (*) => Run("MCLogger.exe /script MCLogger.ahk analyze"),
icon: A_ScriptDir "\Icons\JustLog.ico"
})
this.controlButtons.Push({
text: "Report HotStrings and Potential Fixes",
action: (*) => StringAndFixReport(),
icon: ""
})
; Check if Suggester tool is present, add button.
if FileExist("Suggester.exe") {
this.controlButtons.Push({
text: "Hotstring Suggester Tool",
action: (*) => Run("Suggester.exe"),
icon: ""
})
}
; Check if color theme settings exist, add theme button if they do
if FileExist("colorThemeSettings.ini") {
this.controlButtons.Push({
text: " Change Color Theme",
action: (*) => Run("ColorThemeInt.exe /script ColorThemeInt.ahk analyz"),
icon: A_ScriptDir "\Icons\msn butterfly.ico"
})
}
; Create all buttons based on configuration
this.Controls["ControlButtons"] := []
for buttonConfig in this.controlButtons {
button := this.MainForm.AddButton("y+2 h28 xm w" Config.DefaultWidth, buttonConfig.text)
button.OnEvent("click", buttonConfig.action)
if buttonConfig.icon
try this._SetButtonIcon(button, buttonConfig.icon)
this.Controls["ControlButtons"].Push(button)
}
}
; Set icon for a button
static _SetButtonIcon(ButtonCtrl, IconFile) {
hIcon := DllCall("LoadImage", "Ptr", 0, "Str", IconFile, "UInt", 1, "Int", 24, "Int", 24, "UInt", 0x10)
SendMessage(0xF7, 1, hIcon, ButtonCtrl.Hwnd)
}
; Set up event handlers for all controls
static _SetupEventHandlers() {
; Trigger section events
this.Controls["TriggerEdit"].OnEvent("Change", (*) => UIActions.OnTriggerChanged())
; Replacement section events
this.Controls["SizeToggle"].OnEvent("Click", (*) => UIActions.ToggleSize())
this.Controls["SymbolToggle"].OnEvent("Click", (*) => UIActions.ToggleSymbols())
this.Controls["ReplacementEdit"].OnEvent("Change", (*) => UIActions.FilterWordLists())
this.Controls["ReplacementEdit"].OnEvent("Focus", (ctrl, *) => State.CurrentEdit := ctrl)
; Comment section events
this.Controls["FunctionCheck"].OnEvent("Click", (*) => UIActions.FormAsFunction())
; Button section events
this.Controls["AppendButton"].OnEvent("Click", (*) => UIActions.OnAppendButtonClick())
this.Controls["CheckButton"].OnEvent("Click", (*) => UIActions.OnCheckButtonClick())
this.Controls["ExamButton"].OnEvent("Click", (*) => UIActions.OnExamButtonClick())
this.Controls["ExamButton"].OnEvent("ContextMenu", (*) => UIActions.OnExamButtonRightClick())
this.Controls["SpellButton"].OnEvent("Click", (*) => UIActions.OnSpellButtonClick())
this.Controls["LookButton"].OnEvent("Click", (*) => UIActions.OnLookButtonClick())
this.Controls["LookButton"].OnEvent("ContextMenu", (*) => UIActions.OnLookButtonRightClick())
this.Controls["CancelButton"].OnEvent("Click", (*) => UIActions.OnCancelButtonClick())
; Exam pane events
this.Controls["LeftTrimButton"].OnEvent("Click", (*) => UIActions.TrimLeft())
this.Controls["RightTrimButton"].OnEvent("Click", (*) => UIActions.TrimRight())
this.Controls["BeginningRadio"].OnEvent("Click", (*) => UIActions.FilterWordLists())
this.Controls["BeginningRadio"].OnEvent("ContextMenu", (*) => UIActions.ClearRadioButtons())
this.Controls["MiddleRadio"].OnEvent("Click", (*) => UIActions.FilterWordLists())
this.Controls["MiddleRadio"].OnEvent("ContextMenu", (*) => UIActions.ClearRadioButtons())
this.Controls["EndingRadio"].OnEvent("Click", (*) => UIActions.FilterWordLists())
this.Controls["EndingRadio"].OnEvent("ContextMenu", (*) => UIActions.ClearRadioButtons())
this.Controls["UndoButton"].OnEvent("Click", (*) => UIActions.Undo())
this.Controls["TriggerMatchesEdit"].OnEvent("Focus", (ctrl, *) => State.CurrentEdit := ctrl)
this.Controls["ReplacementMatchesEdit"].OnEvent("Focus", (ctrl, *) => State.CurrentEdit := ctrl)
; Main form events
this.MainForm.OnEvent("Close", (*) => UIActions.OnCancelButtonClick())
}
; Set up hotkeys specific to the HotString Helper form
static SetupFormHotkeys() {
; These hotkeys only apply when the form is active
HotIfWinActive "ahk_id " this.MainForm.Hwnd
; Enter key behavior
Hotkey "$Enter", (*) => this.EnterKeyHandler()
; Shift+Left - Go to start of trigger
Hotkey "+Left", (*) => this.ShiftLeftHandler()
; Escape - Hide form
Hotkey "Esc", (*) => UIActions.OnCancelButtonClick()
; Undo operations
Hotkey "^z", (*) => UIActions.Undo()
Hotkey "^+z", (*) => UIActions.RestartFromOriginal()
; Font size adjustment
Hotkey "^Up", (*) => UIActions.SetLargeFont()
Hotkey "^WheelUp", (*) => UIActions.SetLargeFont()
Hotkey "^Down", (*) => UIActions.SetNormalFont()
Hotkey "^WheelDown", (*) => UIActions.SetNormalFont()
; Turn off window-specific behavior when done
HotIfWinActive ""
}
; Handler for Enter key
static EnterKeyHandler() {
if this.Controls["SymbolToggle"].Text = "Hide Symbols"
return
else if this.Controls["ReplacementEdit"].Focused
Send("{Enter}")
else
UIActions.OnAppendButtonClick()
}
; Handler for Shift+Left combo
static ShiftLeftHandler() {
this.Controls["TriggerEdit"].Focus()
Send "{Home}"
}
; Get all controls in the exam pane for showing/hiding
static GetExamPaneControls() {
return [
this.Controls["LeftTrimButton"],
this.Controls["DeltaString"],
this.Controls["RightTrimButton"],
this.Controls["BeginningRadio"],
this.Controls["MiddleRadio"],
this.Controls["EndingRadio"],
this.Controls["UndoButton"],
this.Controls["TriggerFreqLabel"],
this.Controls["ReplacementFreqLabel"],
this.Controls["TriggerMatchLabel"],
this.Controls["ReplacementMatchLabel"],
this.Controls["TriggerMatchesEdit"],
this.Controls["ReplacementMatchesEdit"]
]
}
; Get all controls in the control pane for showing/hiding
static GetControlPaneControls() {
controls := [this.Controls["ControlPanelLabel"]]
for button in this.Controls["ControlButtons"]
controls.Push(button)
return controls
}
; Resize the form based on current size state
static Resize(isLarge) {
hFactor := isLarge ? Config.HeightSizeIncrease : 0
wFactor := isLarge ? Config.DefaultWidth + Config.WidthSizeIncrease : Config.DefaultWidth
; Resize and reposition controls
this.Controls["TriggerEdit"].Move(, , wFactor - 86)
this.Controls["ReplacementEdit"].Move(, , wFactor, hFactor + 100)
this.Controls["CommentLabel"].Move(, hFactor + 182)
this.Controls["CommentEdit"].Move(, hFactor + 200, wFactor)
this.Controls["FunctionCheck"].Move(, hFactor + 182)
; Move buttons
this.Controls["AppendButton"].Move(, hFactor + 234)
this.Controls["CheckButton"].Move(, hFactor + 234)
this.Controls["ExamButton"].Move(, hFactor + 234)
this.Controls["SpellButton"].Move(, hFactor + 234)
this.Controls["LookButton"].Move(, hFactor + 234)
this.Controls["CancelButton"].Move(, hFactor + 234)
; Update form
this.MainForm.Show("AutoSize yCenter")
}
}
; =============== UI ACTIONS ===============
class UIActions {
static ValidityDialog := 0
; Shows or hides the examination pane controls
static ShowHideExamPane(visible := false) {
for ctrl in UI.GetExamPaneControls()
ctrl.Visible := visible
if visible {
Dictionary.StartBackgroundLoad()
}
State.ExamPaneOpen := visible
}
; Shows or hides the control pane controls
static ShowHideControlPane(visible := false) {
for ctrl in UI.GetControlPaneControls()
ctrl.Visible := visible
State.ControlPaneOpen := visible
}
; Toggle form size between normal and large
static ToggleSize() {
if UI.Controls["SizeToggle"].Text = "Make Bigger" {
UI.Controls["SizeToggle"].Text := "Make Smaller"
; If exam pane is open, close it first
if UI.Controls["ExamButton"].Text = "Done" {
this.ShowHideExamPane(false)
this.ShowHideControlPane(false)
State.ExamPaneOpen := 0
State.ControlPaneOpen := 0
UI.Controls["ExamButton"].Text := "Exam"
}
State.FormBig := 1
UI.Resize(true)
}
else if UI.Controls["SizeToggle"].Text = "Make Smaller" {
UI.Controls["SizeToggle"].Text := "Make Bigger"
State.FormBig := 0
UI.Resize(false)
}
UI.MainForm.Show("AutoSize yCenter")
}
; Toggle symbol display in replacement text
static ToggleSymbols() {
if UI.Controls["SymbolToggle"].Text = "Show Symbols" {
UI.Controls["SymbolToggle"].Text := "Hide Symbols"
replaceText := UI.Controls["ReplacementEdit"].Text
; Replace newlines, spaces, and tabs with symbols
replaceText := StrReplace(StrReplace(replaceText, "`r`n", "`n"), "`n", Config.PilcrowSymbol . "`n")
replaceText := StrReplace(replaceText, A_Space, Config.DotSymbol)
replaceText := StrReplace(replaceText, A_Tab, Config.TabSymbol)
UI.Controls["ReplacementEdit"].Value := replaceText
UI.Controls["ReplacementEdit"].Opt("+Readonly")
UI.Controls["AppendButton"].Enabled := false
State.SymbolsVisible := 1
}
else if UI.Controls["SymbolToggle"].Text = "Hide Symbols" {
UI.Controls["SymbolToggle"].Text := "Show Symbols"
replaceText := UI.Controls["ReplacementEdit"].Text
; Replace symbols with actual characters
replaceText := StrReplace(replaceText, Config.PilcrowSymbol . "`r", "`r")
replaceText := StrReplace(replaceText, Config.DotSymbol, A_Space)
replaceText := StrReplace(replaceText, Config.TabSymbol, A_Tab)
UI.Controls["ReplacementEdit"].Value := replaceText
UI.Controls["ReplacementEdit"].Opt("-Readonly")
UI.Controls["AppendButton"].Enabled := true
State.SymbolsVisible := 0
}
}
; Handle changes to the trigger text
static OnTriggerChanged() {
newTrigger := UI.Controls["TriggerEdit"].Text
; If trigger has changed and exam pane is open, update replacement correspondingly
if newTrigger != State.TrigNeedle_Orig && State.ExamPaneOpen {
; Check if letter was added on the left
if State.TrigNeedle_Orig = SubStr(newTrigger, 2) {
State.TriggerHistory.Push(UI.Controls["TriggerEdit"].Text)
State.ReplacementHistory.Push(UI.Controls["ReplacementEdit"].Text)
; Add same character to left of replacement
UI.Controls["ReplacementEdit"].Value := SubStr(newTrigger, 1, 1) UI.Controls["ReplacementEdit"].Text
}
; Check if letter was added on the right
if State.TrigNeedle_Orig = SubStr(newTrigger, 1, StrLen(newTrigger) - 1) {
State.TriggerHistory.Push(UI.Controls["TriggerEdit"].Text)
State.ReplacementHistory.Push(UI.Controls["ReplacementEdit"].Text)
; Add same character to right of replacement
UI.Controls["ReplacementEdit"].Text := UI.Controls["ReplacementEdit"].Text SubStr(newTrigger, -1)
}
State.TrigNeedle_Orig := newTrigger
UI.Controls["UndoButton"].Enabled := true
}
this.FilterWordLists()
}
; Update the function checkbox status based on options
static FormAsFunction() {
if UI.Controls["FunctionCheck"].Value = 1 {
options := UI.Controls["OptionsEdit"].Text
UI.Controls["OptionsEdit"].Text := "B0X" StrReplace(StrReplace(options, "B0", ""), "X", "")
SoundBeep(700, 200)
}
else {
options := UI.Controls["OptionsEdit"].Text
UI.Controls["OptionsEdit"].Text := StrReplace(StrReplace(options, "B0", ""), "X", "")
SoundBeep(900, 200)
}
}
; Set form font size to large
static SetLargeFont() {
UI.Controls["OptionsEdit"].SetFont(Config.LargeFontSize)
UI.Controls["TriggerEdit"].SetFont(Config.LargeFontSize)
UI.Controls["ReplacementEdit"].SetFont(Config.LargeFontSize)
}
; Set form font size to normal
static SetNormalFont() {
UI.Controls["OptionsEdit"].SetFont(Config.DefaultFontSize)
UI.Controls["TriggerEdit"].SetFont(Config.DefaultFontSize)
UI.Controls["ReplacementEdit"].SetFont(Config.DefaultFontSize)
}
; Trim one character from the left of trigger and replacement
static TrimLeft() {
; Save current state for undo
State.TriggerHistory.Push(UI.Controls["TriggerEdit"].Value)
State.ReplacementHistory.Push(UI.Controls["ReplacementEdit"].Value)
; Remove first character from trigger and replacement
UI.Controls["TriggerEdit"].Value := SubStr(UI.Controls["TriggerEdit"].Value, 2)
UI.Controls["ReplacementEdit"].Value := SubStr(UI.Controls["ReplacementEdit"].Value, 2)
UI.Controls["UndoButton"].Enabled := true
this.OnTriggerChanged()
}
; Trim one character from the right of trigger and replacement
static TrimRight() {
; Save current state for undo
State.TriggerHistory.Push(UI.Controls["TriggerEdit"].Value)
State.ReplacementHistory.Push(UI.Controls["ReplacementEdit"].Value)
; Remove last character from trigger and replacement
triggerText := UI.Controls["TriggerEdit"].Value
replacementText := UI.Controls["ReplacementEdit"].Value
UI.Controls["TriggerEdit"].Value := SubStr(triggerText, 1, StrLen(triggerText) - 1)
UI.Controls["ReplacementEdit"].Value := SubStr(replacementText, 1, StrLen(replacementText) - 1)
UI.Controls["UndoButton"].Enabled := true
this.OnTriggerChanged()
}
; Undo the last edit operation
static Undo() {
if GetKeyState("Shift") {
this.RestartFromOriginal()
}
else if State.TriggerHistory.Length > 0 && State.ReplacementHistory.Length > 0 {
UI.Controls["TriggerEdit"].Value := State.TriggerHistory.Pop()
UI.Controls["ReplacementEdit"].Value := State.ReplacementHistory.Pop()
this.FilterWordLists()
}
else {
UI.Controls["UndoButton"].Enabled := false
}
}
; Reset to the original trigger and replacement
static RestartFromOriginal() {
if !State.OrigTrigger && !State.OrigReplacement {
ToolTip("Can't restart. Nothing in memory.")
SetTimer () => ToolTip(), -2000
}
else {
UI.Controls["TriggerEdit"].Value := State.OrigTrigger
UI.Controls["ReplacementEdit"].Value := State.OrigReplacement
UI.Controls["UndoButton"].Enabled := false
State.TriggerHistory := []
State.ReplacementHistory := []
this.FilterWordLists()
}
}
; Clear all radio buttons and update options accordingly
static ClearRadioButtons() {
UI.Controls["BeginningRadio"].Value := 0
UI.Controls["MiddleRadio"].Value := 0
UI.Controls["EndingRadio"].Value := 0
options := UI.Controls["OptionsEdit"].Text
UI.Controls["OptionsEdit"].Text := StrReplace(StrReplace(options, "?", ""), "*", "")
this.FilterWordLists()
}
; Filter word lists based on current trigger/replacement and options
static FilterWordLists(viaExamButton := false) {
; Get trigger and replacement text
triggerText := Trim(UI.Controls["TriggerEdit"].Value)
if triggerText = ""
triggerText := " " ; Prevent error if empty
replacementText := Trim(UI.Controls["ReplacementEdit"].Value, "`n`t ")
if replacementText = ""
replacementText := " " ; Prevent error if empty
options := UI.Controls["OptionsEdit"].Text
; If called via Exam button, update radio buttons based on options
if viaExamButton {
if InStr(options, "*") && InStr(options, "?")
UI.Controls["MiddleRadio"].Value := 1
else if InStr(options, "*")
UI.Controls["BeginningRadio"].Value := 1
else if InStr(options, "?")
UI.Controls["EndingRadio"].Value := 1
else {
UI.Controls["MiddleRadio"].Value := 0
UI.Controls["BeginningRadio"].Value := 0
UI.Controls["EndingRadio"].Value := 0
}
}
; Process trigger matches
triggerMatches := 0
triggerFilteredList := ""
if FileExist(Config.WordListPath) {
Loop Read, Config.WordListPath {
if InStr(A_LoopReadLine, triggerText) {
if UI.Controls["MiddleRadio"].Value = 1 {
triggerFilteredList .= A_LoopReadLine '`n'
triggerMatches++
}
else if UI.Controls["EndingRadio"].Value = 1 {
if InStr(SubStr(A_LoopReadLine, -StrLen(triggerText)), triggerText) {
triggerFilteredList .= A_LoopReadLine '`n'
triggerMatches++
}
}
else if UI.Controls["BeginningRadio"].Value = 1 {
if InStr(SubStr(A_LoopReadLine, 1, StrLen(triggerText)), triggerText) {
triggerFilteredList .= A_LoopReadLine '`n'
triggerMatches++
}
}
else {
if A_LoopReadLine = triggerText {
triggerFilteredList := triggerText
triggerMatches++
}
}
}
}
}
else {
triggerFilteredList := "Comparison`nword list`nnot found"
}
; Update options based on radio selection
if UI.Controls["MiddleRadio"].Value = 1 {
if !InStr(options, "*")
options := options "*"
if !InStr(options, "?")
options := options "?"
}
else if UI.Controls["EndingRadio"].Value = 1 {
if !InStr(options, "?")
options := options "?"
options := StrReplace(options, "*")
}
else if UI.Controls["BeginningRadio"].Value = 1 {
if !InStr(options, "*")
options := options "*"
options := StrReplace(options, "?")
}
UI.Controls["OptionsEdit"].Text := options
; Update trigger matches display
UI.Controls["TriggerMatchesEdit"].Value := triggerFilteredList
UI.Controls["TriggerMatchLabel"].Text := "Misspells [" triggerMatches "]"