forked from WhiteMagic/JoystickGremlin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
joystick_gremlin.py
1355 lines (1155 loc) · 47.7 KB
/
joystick_gremlin.py
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
# -*- coding: utf-8; -*-
# Copyright (C) 2015 - 2019 Lionel Ott
#
# 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 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
Main UI of JoystickGremlin.
"""
import argparse
import ctypes
import hashlib
import logging
import os
import sys
import time
import traceback
# Import QtMultimedia so pyinstaller doesn't miss it
import PyQt5
from PyQt5 import QtCore, QtGui, QtMultimedia, QtWidgets
import dill
# Figure out the location of the code / executable and change the working
# directory accordingly
install_path = os.path.normcase(os.path.dirname(os.path.abspath(sys.argv[0])))
os.chdir(install_path)
import gremlin.ui.axis_calibration
import gremlin.ui.common
import gremlin.ui.device_tab
import gremlin.ui.dialogs
import gremlin.ui.input_viewer
import gremlin.ui.merge_axis
import gremlin.ui.profile_creator
import gremlin.ui.profile_settings
from gremlin.ui.ui_gremlin import Ui_Gremlin
class GremlinUi(QtWidgets.QMainWindow):
"""Main window of the Joystick Gremlin user interface."""
def __init__(self, parent=None):
"""Creates a new main ui window.
:param parent the parent of this window
"""
QtWidgets.QMainWindow.__init__(self, parent)
self.ui = Ui_Gremlin()
self.ui.setupUi(self)
self._resize_count = 0
# Process monitor
self.process_monitor = gremlin.process_monitor.ProcessMonitor()
self.process_monitor.process_changed.connect(
self._process_changed_cb
)
# Default path variable before any runtime changes
self._base_path = list(sys.path)
self.tabs = {}
self.config = gremlin.config.Configuration()
self.runner = gremlin.code_runner.CodeRunner()
self.repeater = gremlin.repeater.Repeater(
[],
self._update_statusbar_repeater
)
self.runner.event_handler.mode_changed.connect(
self._update_statusbar_mode
)
self.runner.event_handler.is_active.connect(
self._update_statusbar_active
)
self.mode_selector = gremlin.ui.common.ModeWidget()
self.mode_selector.mode_changed.connect(self._mode_changed_cb)
self.ui.toolBar.addWidget(self.mode_selector)
# Setup profile storage
self._current_mode = None
self._profile = gremlin.profile.Profile()
self._profile_fname = None
self._profile_auto_activated = False
# Input selection storage
self._last_input_timestamp = time.time()
self._last_input_event = None
self._event_process_registry = {}
# Create all required UI elements
self._create_system_tray()
self._setup_icons()
self._connect_actions()
self._create_statusbar()
self._update_statusbar_active(False)
# Load existing configuration or create a new one otherwise
if self.config.last_profile and os.path.isfile(self.config.last_profile):
self._do_load_profile(self.config.last_profile)
else:
self.new_profile()
# Setup the recent files menu
self._create_recent_profiles()
# Modal windows
self.modal_windows = {}
# Enable reloading for when a user connects / disconnects a
# device. Sleep for a bit to avert race with devices being added
# when they already exist.
el = gremlin.event_handler.EventListener()
time.sleep(0.1)
el._init_joysticks()
el.device_change_event.connect(self._device_change_cb)
self.apply_user_settings()
self.apply_window_settings()
def closeEvent(self, evt):
"""Terminate the entire application if the main window is closed.
:param evt the closure event
"""
if self.config.close_to_tray and self.ui.tray_icon.isVisible():
self.hide()
evt.ignore()
else:
self.process_monitor.running = False
del self.ui.tray_icon
QtCore.QCoreApplication.quit()
# Terminate file watcher thread
if "log" in self.modal_windows:
self.modal_windows["log"].watcher.stop()
def resizeEvent(self, evt):
"""Handling changing the size of the window.
:param evt event information
"""
if self._resize_count > 1:
self.config.window_size = [evt.size().width(), evt.size().height()]
self._resize_count += 1
def moveEvent(self, evt):
"""Handle changing the position of the window.
:param evt event information
"""
if self._resize_count > 1:
self.config.window_location = [evt.pos().x(), evt.pos().y()]
# +---------------------------------------------------------------
# | Modal window creation
# +---------------------------------------------------------------
def about(self):
"""Opens the about window."""
self.modal_windows["about"] = gremlin.ui.dialogs.AboutUi()
self.modal_windows["about"].show()
self.modal_windows["about"].closed.connect(
lambda: self._remove_modal_window("about")
)
def calibration(self):
"""Opens the calibration window."""
self.modal_windows["calibration"] = \
gremlin.ui.axis_calibration.CalibrationUi()
self.modal_windows["calibration"].show()
gremlin.shared_state.set_suspend_input_highlighting(True)
self.modal_windows["calibration"].closed.connect(
lambda: gremlin.shared_state.set_suspend_input_highlighting(False)
)
self.modal_windows["calibration"].closed.connect(
lambda: self._remove_modal_window("calibration")
)
def device_information(self):
"""Opens the device information window."""
self.modal_windows["device_information"] = \
gremlin.ui.dialogs.DeviceInformationUi()
geom = self.geometry()
self.modal_windows["device_information"].setGeometry(
geom.x() + geom.width() / 2 - 150,
geom.y() + geom.height() / 2 - 75,
300,
150
)
self.modal_windows["device_information"].show()
self.modal_windows["device_information"].closed.connect(
lambda: self._remove_modal_window("device_information")
)
def log_window(self):
"""Opens the log display window."""
self.modal_windows["log"] = gremlin.ui.dialogs.LogWindowUi()
self.modal_windows["log"].show()
self.modal_windows["log"].closed.connect(
lambda: self._remove_modal_window("log")
)
def manage_custom_modules(self):
"""Opens the custom module management window."""
self.modal_windows["module_manager"] = \
gremlin.ui.dialogs.ModuleManagerUi(self._profile)
self.modal_windows["module_manager"].show()
self.modal_windows["module_manager"].closed.connect(
lambda: self._remove_modal_window("module_manager")
)
def manage_modes(self):
"""Opens the mode management window."""
self.modal_windows["mode_manager"] = \
gremlin.ui.dialogs.ModeManagerUi(self._profile)
self.modal_windows["mode_manager"].modes_changed.connect(
self._mode_configuration_changed
)
self.modal_windows["mode_manager"].show()
self.modal_windows["mode_manager"].closed.connect(
lambda: self._remove_modal_window("mode_manager")
)
def merge_axis(self):
"""Opens the modal window to define axis merging."""
self.modal_windows["merge_axis"] = \
gremlin.ui.merge_axis.MergeAxisUi(self._profile)
self.modal_windows["merge_axis"].show()
self.modal_windows["merge_axis"].closed.connect(
lambda: self._remove_modal_window("merge_axis")
)
def options_dialog(self):
"""Opens the options dialog."""
self.modal_windows["options"] = gremlin.ui.dialogs.OptionsUi()
self.modal_windows["options"].show()
self.modal_windows["options"].closed.connect(
lambda: self.apply_user_settings(ignore_minimize=True)
)
self.modal_windows["options"].closed.connect(
lambda: self._remove_modal_window("options")
)
def profile_creator(self):
"""Opens the UI used to create a profile from an existing one."""
fname, _ = QtWidgets.QFileDialog.getOpenFileName(
None,
"Profile to load as template",
gremlin.util.userprofile_path(),
"XML files (*.xml)"
)
if fname == "":
return
profile_data = gremlin.profile.Profile()
profile_data.from_xml(fname)
self.modal_windows["profile_creator"] = \
gremlin.ui.profile_creator.ProfileCreator(profile_data)
self.modal_windows["profile_creator"].show()
gremlin.shared_state.set_suspend_input_highlighting(True)
self.modal_windows["profile_creator"].closed.connect(
lambda: gremlin.shared_state.set_suspend_input_highlighting(False)
)
self.modal_windows["profile_creator"].closed.connect(
lambda: self._remove_modal_window("profile_creator")
)
def swap_devices(self):
"""Opens the UI used to swap devices."""
self.modal_windows["swap_devices"] = \
gremlin.ui.dialogs.SwapDevicesUi(self._profile)
geom = self.geometry()
self.modal_windows["swap_devices"].setGeometry(
geom.x() + geom.width() / 2 - 150,
geom.y() + geom.height() / 2 - 75,
300,
150
)
self.modal_windows["swap_devices"].show()
self.modal_windows["swap_devices"].closed.connect(
lambda: self._remove_modal_window("swap_devices")
)
self.modal_windows["swap_devices"].closed.connect(
self._create_tabs
)
def _remove_modal_window(self, name):
"""Removes the modal window widget from the system.
:param name the name of the modal window to remove
"""
del self.modal_windows[name]
# +---------------------------------------------------------------
# | Action implementations
# +---------------------------------------------------------------
def activate(self, checked):
"""Activates and deactivates the code runner.
:param checked True when the runner is to be activated, False
otherwise
"""
if checked:
# Generate the code for the profile and run it
self._profile_auto_activated = False
self.generate()
self.runner.start(
self._profile.build_inheritance_tree(),
self._profile.settings,
self._last_active_mode(),
self._profile
)
self.ui.tray_icon.setIcon(QtGui.QIcon("gfx/icon_active.ico"))
else:
# Stop running the code
self.runner.stop()
self._update_statusbar_active(False)
self._profile_auto_activated = False
current_tab = self.ui.devices.currentWidget()
if type(current_tab) in [
gremlin.ui.device_tab.JoystickDeviceTabWidget,
gremlin.ui.device_tab.KeyboardDeviceTabWidget
]:
self.ui.devices.currentWidget().refresh()
self.ui.tray_icon.setIcon(QtGui.QIcon("gfx/icon.ico"))
def create_1to1_mapping(self):
"""Creates a 1 to 1 mapping of the given device to the first
vJoy device.
"""
# Don't attempt to create the mapping for the "Getting Started"
# widget
if isinstance(self.ui.devices.currentWidget(), QtWidgets.QTextEdit):
return
device_profile = self.ui.devices.currentWidget().device_profile
# Don't create mappings for non joystick devices
if device_profile.type != gremlin.profile.DeviceType.Joystick:
return
container_plugins = gremlin.plugin_manager.ContainerPlugins()
action_plugins = gremlin.plugin_manager.ActionPlugins()
mode = device_profile.modes[self._current_mode]
input_types = [
gremlin.common.InputType.JoystickAxis,
gremlin.common.InputType.JoystickButton,
gremlin.common.InputType.JoystickHat
]
type_name = {
gremlin.common.InputType.JoystickAxis: "axis",
gremlin.common.InputType.JoystickButton: "button",
gremlin.common.InputType.JoystickHat: "hat",
}
main_profile = device_profile.parent
for input_type in input_types:
for entry in mode.config[input_type].values():
item_list = main_profile.list_unused_vjoy_inputs()
container = container_plugins.repository["basic"](entry)
action = action_plugins.repository["remap"](container)
action.input_type = input_type
action.vjoy_device_id = 1
if len(item_list[1][type_name[input_type]]) > 0:
action.vjoy_input_id = item_list[1][type_name[input_type]][0]
else:
action.vjoy_input_id = 1
container.add_action(action)
entry.containers.append(container)
self._create_tabs()
def generate(self):
"""Generates python code for the code runner from the current
profile.
"""
# generator = CodeGenerator(self._profile)
generator = gremlin.code_generator.CodeGenerator(self._profile)
generator.write_code(
os.path.join(
gremlin.util.userprofile_path(),
"gremlin_code.py"
)
)
def input_repeater(self):
"""Enables or disables the forwarding of events to the repeater."""
el = gremlin.event_handler.EventListener()
if self.ui.actionInputRepeater.isChecked():
el.keyboard_event.connect(self.repeater.process_event)
el.joystick_event.connect(self.repeater.process_event)
self._update_statusbar_repeater("Waiting for input")
else:
el.keyboard_event.disconnect(self.repeater.process_event)
el.joystick_event.disconnect(self.repeater.process_event)
self.repeater.stop()
self.status_bar_repeater.setText("")
def input_viewer(self):
"""Displays the input viewer dialog."""
self.modal_windows["input_viewer"] = \
gremlin.ui.input_viewer.InputViewerUi()
geom = self.geometry()
self.modal_windows["input_viewer"].setGeometry(
geom.x() + geom.width() / 2 - 350,
geom.y() + geom.height() / 2 - 150,
700,
300
)
self.modal_windows["input_viewer"].show()
self.modal_windows["input_viewer"].closed.connect(
lambda: self._remove_modal_window("input_viewer")
)
def load_profile(self):
"""Prompts the user to select a profile file to load."""
if not self._save_changes_request():
return
fname, _ = QtWidgets.QFileDialog.getOpenFileName(
None,
"Load Profile",
gremlin.util.userprofile_path(),
"XML files (*.xml)"
)
if fname != "":
self._load_recent_profile(fname)
def new_profile(self):
"""Creates a new empty profile."""
# Disable Gremlin if active before opening a new profile
self.ui.actionActivate.setChecked(False)
self.activate(False)
if not self._save_changes_request():
return
self._profile = gremlin.profile.Profile()
# For each connected device create a new empty device entry
# in the new profile
for device in gremlin.joystick_handling.physical_devices():
self._profile.initialize_joystick_device(device, ["Default"])
# Create keyboard device entry
keyboard_device = gremlin.profile.Device(self._profile)
keyboard_device.name = "keyboard"
keyboard_device.device_guid = dill.GUID_Keyboard
keyboard_device.type = gremlin.profile.DeviceType.Keyboard
self._profile.devices[dill.GUID_Keyboard] = keyboard_device
# Update profile information
self._profile_fname = None
self._current_mode = None
self._update_window_title()
gremlin.shared_state.current_profile = self._profile
# Create a default mode
for device in self._profile.devices.values():
device.ensure_mode_exists("Default")
self._current_mode = "Default"
# Create device tabs
self._create_tabs()
# Update everything to the new mode
self._mode_configuration_changed()
def save_profile(self):
"""Saves the current profile to the hard drive.
If the file was loaded from an existing profile that file is
updated, otherwise the user is prompted for a new file.
"""
if self._profile_fname:
self._profile.to_xml(self._profile_fname)
else:
self.save_profile_as()
self._update_window_title()
def save_profile_as(self):
"""Prompts the user for a file to save to profile to."""
fname, _ = QtWidgets.QFileDialog.getSaveFileName(
None,
"Save Profile",
gremlin.util.userprofile_path(),
"XML files (*.xml)"
)
if fname != "":
self._profile.to_xml(fname)
self._profile_fname = fname
self.config.last_profile = fname
self._create_recent_profiles()
self._update_window_title()
# +---------------------------------------------------------------
# | Create UI elements
# +---------------------------------------------------------------
def _connect_actions(self):
"""Connects all QAction items to their corresponding callbacks."""
# Menu actions
# File
self.ui.actionLoadProfile.triggered.connect(self.load_profile)
self.ui.actionNewProfile.triggered.connect(self.new_profile)
self.ui.actionSaveProfile.triggered.connect(self.save_profile)
self.ui.actionSaveProfileAs.triggered.connect(self.save_profile_as)
self.ui.actionModifyProfile.triggered.connect(self.profile_creator)
self.ui.actionExit.triggered.connect(self._force_close)
# Actions
self.ui.actionCreate1to1Mapping.triggered.connect(
self.create_1to1_mapping
)
self.ui.actionMergeAxis.triggered.connect(self.merge_axis)
self.ui.actionSwapDevices.triggered.connect(self.swap_devices)
# Tools
self.ui.actionDeviceInformation.triggered.connect(
self.device_information
)
self.ui.actionManageModes.triggered.connect(self.manage_modes)
self.ui.actionManageCustomModules.triggered.connect(
self.manage_custom_modules
)
self.ui.actionInputRepeater.triggered.connect(self.input_repeater)
self.ui.actionCalibration.triggered.connect(self.calibration)
self.ui.actionInputViewer.triggered.connect(self.input_viewer)
self.ui.actionPDFCheatsheet.triggered.connect(
lambda: self._create_cheatsheet()
)
self.ui.actionOptions.triggered.connect(self.options_dialog)
self.ui.actionLogDisplay.triggered.connect(
self.log_window
)
# About
self.ui.actionAbout.triggered.connect(self.about)
# Toolbar actions
self.ui.actionActivate.triggered.connect(self.activate)
self.ui.actionOpen.triggered.connect(self.load_profile)
# Tray icon
self.ui.tray_icon.activated.connect(self._tray_icon_activated_cb)
def _create_recent_profiles(self):
"""Populates the Recent submenu entry with the most recent profiles."""
self.ui.menuRecent.clear()
for entry in self.config.recent_profiles:
action = self.ui.menuRecent.addAction(
gremlin.util.truncate(entry, 5, 40)
)
action.triggered.connect(self._create_load_profile_function(entry))
def _create_statusbar(self):
"""Creates the ui widgets used in the status bar."""
self.status_bar_mode = QtWidgets.QLabel("")
self.status_bar_mode.setContentsMargins(5, 0, 5, 0)
self.status_bar_is_active = QtWidgets.QLabel("")
self.status_bar_is_active.setContentsMargins(5, 0, 5, 0)
self.status_bar_repeater = QtWidgets.QLabel("")
self.status_bar_repeater.setContentsMargins(5, 0, 5, 0)
self.ui.statusbar.addWidget(self.status_bar_is_active, 0)
self.ui.statusbar.addWidget(self.status_bar_mode, 3)
self.ui.statusbar.addWidget(self.status_bar_repeater, 1)
def _create_system_tray(self):
"""Creates the system tray icon and menu."""
self.ui.tray_menu = QtWidgets.QMenu("Menu")
self.ui.action_tray_show = \
QtWidgets.QAction("Show / Hide", self)
self.ui.action_tray_enable = \
QtWidgets.QAction("Enable / Disable", self)
self.ui.action_tray_quit = QtWidgets.QAction("Quit", self)
self.ui.tray_menu.addAction(self.ui.action_tray_show)
self.ui.tray_menu.addAction(self.ui.action_tray_enable)
self.ui.tray_menu.addAction(self.ui.action_tray_quit)
self.ui.action_tray_show.triggered.connect(
lambda: self.setHidden(not self.isHidden())
)
self.ui.action_tray_enable.triggered.connect(
self.ui.actionActivate.trigger
)
self.ui.action_tray_quit.triggered.connect(
self._force_close
)
self.ui.tray_icon = QtWidgets.QSystemTrayIcon()
self.ui.tray_icon.setIcon(QtGui.QIcon("gfx/icon.ico"))
self.ui.tray_icon.setContextMenu(self.ui.tray_menu)
self.ui.tray_icon.show()
def _create_tabs(self, activate_tab=None):
"""Creates the tabs of the configuration dialog representing
the different connected devices.
"""
self.ui.devices.clear()
self.tabs = {}
# Device lists
phys_devices = gremlin.joystick_handling.physical_devices()
vjoy_devices = gremlin.joystick_handling.vjoy_devices()
# Create physical joystick device tabs
for device in sorted(phys_devices, key=lambda x: x.name):
device_profile = self._profile.get_device_modes(
device.device_guid,
gremlin.profile.DeviceType.Joystick,
device.name
)
widget = gremlin.ui.device_tab.JoystickDeviceTabWidget(
device,
device_profile,
self._current_mode
)
self.tabs[device.device_guid] = widget
tab_label = device.name.strip()
self.ui.devices.addTab(widget, tab_label)
# Create vJoy as input device tabs
for device in sorted(vjoy_devices, key=lambda x: x.vjoy_id):
# Ignore vJoy as output devices
if not self._profile.settings.vjoy_as_input.get(device.vjoy_id, False):
continue
device_profile = self._profile.get_device_modes(
device.device_guid,
gremlin.profile.DeviceType.Joystick,
device.name
)
widget = gremlin.ui.device_tab.JoystickDeviceTabWidget(
device,
device_profile,
self._current_mode
)
self.tabs[device.device_guid] = widget
tab_label = device.name.strip()
tab_label += " #{:d}".format(device.vjoy_id)
self.ui.devices.addTab(widget, tab_label)
# Create keyboard tab
device_profile = self._profile.get_device_modes(
dill.GUID_Keyboard,
gremlin.profile.DeviceType.Keyboard,
"keyboard"
)
widget = gremlin.ui.device_tab.KeyboardDeviceTabWidget(
device_profile,
self._current_mode
)
self.tabs[dill.GUID_Keyboard] = widget
self.ui.devices.addTab(widget, "Keyboard")
# Create the vjoy as output device tab
for device in sorted(vjoy_devices, key=lambda x: x.vjoy_id):
# Ignore vJoy as input devices
if self._profile.settings.vjoy_as_input.get(device.vjoy_id, False):
continue
device_profile = self._profile.get_device_modes(
device.device_guid,
gremlin.profile.DeviceType.VJoy,
device.name
)
widget = gremlin.ui.device_tab.JoystickDeviceTabWidget(
device,
device_profile,
self._current_mode
)
self.tabs[device.device_guid] = widget
self.ui.devices.addTab(
widget,
"{} #{:d}".format(device.name, device.vjoy_id)
)
# Add profile configuration tab
widget = gremlin.ui.profile_settings.ProfileSettingsWidget(
self._profile.settings
)
widget.changed.connect(lambda: self._create_tabs("Settings"))
self.ui.devices.addTab(widget, "Settings")
# Select specified tab if one is selected
if activate_tab is not None:
for i in range(self.ui.devices.count()):
if self.ui.devices.tabText(i) == activate_tab:
self.ui.devices.setCurrentIndex(i)
def _setup_icons(self):
"""Sets the icons of all QAction items."""
# Menu actions
self.ui.actionLoadProfile.setIcon(
QtGui.QIcon("gfx/profile_open.svg")
)
self.ui.actionNewProfile.setIcon(
QtGui.QIcon("gfx/profile_new.svg")
)
self.ui.actionSaveProfile.setIcon(
QtGui.QIcon("gfx/profile_save.svg")
)
self.ui.actionSaveProfileAs.setIcon(
QtGui.QIcon("gfx/profile_save_as.svg")
)
self.ui.actionDeviceInformation.setIcon(
QtGui.QIcon("gfx/device_information.svg")
)
self.ui.actionManageCustomModules.setIcon(
QtGui.QIcon("gfx/manage_modules.svg")
)
self.ui.actionManageModes.setIcon(
QtGui.QIcon("gfx/manage_modes.svg")
)
self.ui.actionInputRepeater.setIcon(
QtGui.QIcon("gfx/input_repeater.svg")
)
self.ui.actionCalibration.setIcon(
QtGui.QIcon("gfx/calibration.svg")
)
self.ui.actionInputViewer.setIcon(
QtGui.QIcon("gfx/input_viewer.svg")
)
self.ui.actionLogDisplay.setIcon(
QtGui.QIcon("gfx/logview.png")
)
self.ui.actionOptions.setIcon(
QtGui.QIcon("gfx/options.svg")
)
self.ui.actionAbout.setIcon(
QtGui.QIcon("gfx/about.svg")
)
# Toolbar actions
activate_icon = QtGui.QIcon()
activate_icon.addPixmap(
QtGui.QPixmap("gfx/activate.svg"),
QtGui.QIcon.Normal
)
activate_icon.addPixmap(
QtGui.QPixmap("gfx/activate_on.svg"),
QtGui.QIcon.Active,
QtGui.QIcon.On
)
self.ui.actionActivate.setIcon(activate_icon)
self.ui.actionOpen.setIcon(
QtGui.QIcon("gfx/profile_open.svg")
)
# +---------------------------------------------------------------
# | Signal handlers
# +---------------------------------------------------------------
def _device_change_cb(self):
"""Handles addition and removal of joystick devices."""
# Update device tabs
self.devices = gremlin.joystick_handling.joystick_devices()
self._create_tabs()
# Stop Gremlin execution
self.ui.actionActivate.setChecked(False)
self.activate(False)
def _joystick_input_selection(self, event):
"""Handles joystick events to select the appropriate input item.
:param event the event to process
"""
if event.event_type == gremlin.common.InputType.Keyboard:
return
if self.runner.is_running() or self._current_mode is None:
return
if gremlin.shared_state.suspend_input_highlighting():
return
# Do not attempt to highlight inputs on non device tabs
widget = self.ui.devices.currentWidget()
if not isinstance(widget, gremlin.ui.device_tab.JoystickDeviceTabWidget):
return
# Get device id of the event and check if this matches the currently
# active tab
if event.device_guid not in self.tabs:
return
tab_switch_needed = self.ui.devices.currentWidget() \
!= self.tabs[event.device_guid]
# Switch to the tab corresponding to the event's device if the option
# is set in the options
if self.config.highlight_device and tab_switch_needed:
self.ui.devices.setCurrentWidget(self.tabs[event.device_guid])
tab_switch_needed = False
time.sleep(0.1)
# If we want to act on the given event figure out which button
# needs to be pressed and press is
if not tab_switch_needed and self._should_process_input(event):
widget.input_item_list_view.select_item(event)
def _mode_changed_cb(self, new_mode):
"""Updates the current mode to the provided one.
:param new_mode the name of the new current mode
"""
self._current_mode = new_mode
for tab in self.tabs.values():
tab.mode_changed_cb(new_mode)
def _process_changed_cb(self, path):
"""Handles changes in the active process.
If the active process has a known associated profile it is
loaded and activated if none exists the application is
disabled.
:param path the path to the currently active process executable
"""
profile_path = self.config.get_profile_with_regex(path)
if profile_path:
if self._profile_fname != profile_path:
self.ui.actionActivate.setChecked(False)
self.activate(False)
self._do_load_profile(profile_path)
self.ui.actionActivate.setChecked(True)
self.activate(True)
self._profile_auto_activated = True
elif self._profile_auto_activated:
self.ui.actionActivate.setChecked(False)
self.activate(False)
self._profile_auto_activated = False
def _tray_icon_activated_cb(self, reason):
"""Callback triggered by clicking on the system tray icon.
:param reason the type of click performed on the icon
"""
if reason == QtWidgets.QSystemTrayIcon.Trigger:
self.setHidden(not self.isHidden())
def _update_statusbar_active(self, is_active):
"""Updates the status bar with the current state of the system.
:param is_active True if the system is active, False otherwise
"""
if is_active:
text_active = "<font color=\"green\">Active</font>"
else:
text_active = "<font color=\"red\">Paused</font>"
if self.ui.actionActivate.isChecked():
text_running = "Running and {}".format(text_active)
else:
text_running = "Not Running"
self.status_bar_is_active.setText(
"<b>Status: </b> {}".format(text_running)
)
def _update_statusbar_mode(self, mode):
"""Updates the status bar display of the current mode.
:param mode the now current mode
"""
self.status_bar_mode.setText("<b>Mode:</b> {}".format(mode))
if self.config.mode_change_message:
self.ui.tray_icon.showMessage(
"Mode: {}".format(mode),
"",
0,
250
)
# +---------------------------------------------------------------
# | Utilities
# +---------------------------------------------------------------
def apply_user_settings(self, ignore_minimize=False):
"""Configures the program based on user settings."""
self._set_joystick_input_highlighting(
self.config.highlight_input
)
if not ignore_minimize:
self.setHidden(self.config.start_minimized)
if self.config.autoload_profiles:
self.process_monitor.start()
else:
self.process_monitor.stop()
if self.config.activate_on_launch:
self.ui.actionActivate.setChecked(True)
self.activate(True)
def apply_window_settings(self):
"""Restores the stored window geometry settings."""
window_size = self.config.window_size
window_location = self.config.window_location
if window_size:
self.resize(window_size[0], window_size[1])
if window_location:
self.move(window_location[0], window_location[1])
def _create_cheatsheet(self):
"""Creates the cheatsheet and stores it in the desired place.
:param file_format the format of the cheatsheet, html or pdf
"""
fname, _ = QtWidgets.QFileDialog.getSaveFileName(
None,
"Save cheatsheet",
gremlin.util.userprofile_path(),
"PDF files (*.pdf)"
)
if len(fname) > 0:
gremlin.cheatsheet.generate_cheatsheet(fname, self._profile)
def _create_load_profile_function(self, fname):
"""Creates a callback to load a specific profile.
:param fname path to the profile to load
:return function which will load the specified profile
"""
return lambda: self._load_recent_profile(fname)
def _do_load_profile(self, fname):
"""Load the profile with the given filename.
:param fname the name of the profile file to load
"""
# Disable the program if it is running when we're loading a
# new profile
self.ui.actionActivate.setChecked(False)
self.activate(False)
# Attempt to load the new profile
try:
new_profile = gremlin.profile.Profile()
new_profile.from_xml(fname)
profile_folder = os.path.dirname(fname)
if profile_folder not in sys.path:
sys.path = list(self._base_path)
sys.path.insert(0, profile_folder)
self._sanitize_profile(new_profile)
self._profile = new_profile
self._profile_fname = fname
self._update_window_title()
gremlin.shared_state.current_profile = self._profile
self._current_mode = sorted(self._profile.get_root_modes())[0]
self._create_tabs()
# Make the first root node the default active mode
self.mode_selector.populate_selector(
self._profile, self._current_mode
)
except (KeyError, TypeError) as error:
# An error occurred while parsing an existing profile,
# creating an empty profile instead
logging.getLogger("system").exception(
"Invalid profile content:\n{}".format(error)
)
self.new_profile()
except gremlin.error.ProfileError as error:
# Parsing the profile went wrong, stop loading and start with an
# empty profile
cfg = gremlin.config.Configuration()
cfg.last_profile = None
self.new_profile()
gremlin.util.display_error(
"Failed to load the profile {} due to:\n\n{}".format(
fname, error
)
)
def _force_close(self):
"""Forces the closure of the program."""
self.ui.tray_icon.hide()
self.close()