Add user editable key maps #5

franklin654 · 2023-08-26T18:23:26Z

changed the Cmakelist to remove unnecessary space.
added the functions to load and save key maps.
created and installed event filters to pick up user input for custom key maps

changed all static hard coded values to variables and included them in a separate folder

removed extra spaces

icons for preference buttons

added image files for button icons

added the functions and maps required to dynamically change key maps as defined by the user

fixing the bug that occurs when mapping to numbers, adding the icon files qt resource

adding the mouse press filter to map the keys to mouse buttons

src/preferences.cpp

src/mainwindow.cpp

src/mainwindow.ui

src/main.cpp

CMakeLists.txt

src/settings_key_variables.h

src/settings.h

src/settings_key_variables.cpp

src/settings.cpp

kitswas · 2023-08-30T13:10:56Z

There's not a single line of documentation accompanying the code changes.
This pull request won't be merged unless the new code is documented.

Co-authored-by: kitswas <90329875+kitswas@users.noreply.github.com>

fixing the broken include guard, removed the redundant functions, removed the qt::endl, fixed the typo in config file name

franklin654 · 2023-08-30T14:32:34Z

does this type of documentation suffices

described all the functions, their parameters and what the functions return.

…tualGamePad-PC into User_Preferences

kitswas · 2023-09-01T12:09:06Z

@franklin654
Not a fan of commit 9a29227.

Before:

After:

Everything seems to be squished. And the UI no longer scales properly with the window.
You can decrease the default window size if the old UI looks too sparse to you. But revert that commit first.

Also, kindly read what the QSizePolicies mean.

kitswas · 2023-09-01T12:26:33Z

And a bit of clarification about the documentation comments.

Something like

/**
 * @brief load_setting
 * get the value of a setting.
 * @param key
 * the fullname including the groups of the setting in string format
 * @return
 * returns the value as QVariant can be converted into almost all data types.
 */
QVariant load_setting(QString key)

ends up as:

So:

The function name should not be repeated after @brief.
Every sentence should begin with a Capital Letter.
Returns should not be written after @return.

Here's what I would write for this function:

/**
 * Get the value of a setting.
 * @param key
 * The full name including the groups of the setting as a string.
 * @return
 * The value as QVariant. It can be converted into almost all data types.
 */
QVariant load_setting(QString key)

See. Looks nicer already.

This reverts commit 9a29227.

franklin654 · 2023-09-01T17:13:28Z

preview of the new interface

kitswas · 2023-09-02T11:33:52Z

Currently, there is no option to map a button to mouse input.
We need to make it happen.

kitswas · 2023-09-02T12:02:45Z

We should support:

Left click
Right click

Here's what we could have in place of the QLineEdits we are currently using:

The current QLineEdit could be moved to the keyboard tab.

The mouse input type could be presented in a QComboBox.

Edit: A button cannot be mapped to mouse move.

kitswas · 2023-09-03T11:55:05Z

The Analogue Thumbsticks are missing.

For each thumbstick, we should be able to

Map a key/mouse click to each of the 4 directions, or
Use the whole thumbstick for mouse movement.

kitswas · 2023-09-03T17:40:48Z

src/preferences.cpp

+            QKeyEvent* key_press = static_cast<QKeyEvent*>(event);
+            this->DDOWN = key_press->nativeVirtualKey();
+            char buffer[256];
+            get_scan_code(key_press->nativeVirtualKey(), buffer, 256);
+            ui->ddownmap->setText(QString(buffer));
+        }
+        else if(event->type() == QEvent::MouseButtonRelease) {
+            QMouseEvent* mouse_press = static_cast<QMouseEvent*>(event);
+            char buffer[256];
+            bool valid = true;
+            UINT button = mouse_press->button();
+            switch(button) {
+            case Qt::MouseButton::LeftButton:
+                this->DDOWN = VK_LBUTTON;
+                get_scan_code(VK_LBUTTON, buffer, 256);
+                break;
+            case Qt::MouseButton::RightButton:
+                this->DDOWN = VK_RBUTTON;
+                get_scan_code(VK_RBUTTON, buffer, 256);
+                break;
+            case Qt::MouseButton::MiddleButton:
+                this->DDOWN = VK_MBUTTON;
+                get_scan_code(VK_MBUTTON, buffer, 256);
+                break;
+            default:
+                qDebug() << "Some Error Occured No Legal Mouse Button found";
+                valid = false;
+            }
+            if(valid)
+            ui->ddownmap->setText(QString(buffer));
+        }
+    }
+    else if(sender == ui->drightmap) {
+        if(event->type() == QEvent::KeyRelease) {
+            QKeyEvent* key_press = static_cast<QKeyEvent*>(event);
+            this->DRIGHT = key_press->nativeVirtualKey();
+            char buffer[256];
+            get_scan_code(key_press->nativeVirtualKey(), buffer, 256);
+            ui->drightmap->setText(QString(buffer));
+        }
+        else if(event->type() == QEvent::MouseButtonRelease) {
+            QMouseEvent* mouse_press = static_cast<QMouseEvent*>(event);
+            char buffer[256];
+            bool valid = true;
+            UINT button = mouse_press->button();
+            switch(button) {
+            case Qt::MouseButton::LeftButton:
+                this->DRIGHT = VK_LBUTTON;
+                get_scan_code(VK_LBUTTON, buffer, 256);
+                break;
+            case Qt::MouseButton::RightButton:
+                this->DRIGHT = VK_RBUTTON;
+                get_scan_code(VK_RBUTTON, buffer, 256);
+                break;
+            case Qt::MouseButton::MiddleButton:
+                this->DRIGHT = VK_MBUTTON;
+                get_scan_code(VK_MBUTTON, buffer, 256);
+                break;
+            default:
+                qDebug() << "Some Error Occured No Legal Mouse Button found";
+                valid = false;
+            }
+            if(valid)
+            ui->drightmap->setText(QString(buffer));
+        }
+    }
+    else if(sender == ui->dleftmap) {
+        if(event->type() == QEvent::KeyRelease) {
+            QKeyEvent* key_press = static_cast<QKeyEvent*>(event);
+            this->DLEFT = key_press->nativeVirtualKey();
+            char buffer[256];
+            get_scan_code(key_press->nativeVirtualKey(), buffer, 256);
+            ui->dleftmap->setText(QString(buffer));
+        }
+        else if(event->type() == QEvent::MouseButtonRelease) {
+            QMouseEvent* mouse_press = static_cast<QMouseEvent*>(event);
+            char buffer[256];
+            bool valid = true;
+            UINT button = mouse_press->button();
+            switch(button) {
+            case Qt::MouseButton::LeftButton:
+                this->DLEFT = VK_LBUTTON;
+                get_scan_code(VK_LBUTTON, buffer, 256);
+                break;
+            case Qt::MouseButton::RightButton:
+                this->DLEFT = VK_RBUTTON;
+                get_scan_code(VK_RBUTTON, buffer, 256);
+                break;
+            case Qt::MouseButton::MiddleButton:
+                this->DLEFT = VK_MBUTTON;
+                get_scan_code(VK_MBUTTON, buffer, 256);
+                break;
+            default:
+                qDebug() << "Some Error Occured No Legal Mouse Button found";
+                valid = false;
+            }
+            if(valid)
+            ui->dleftmap->setText(QString(buffer));
+        }
+    }


Much of this code is simply duplicated with different variables.

This must change.

I recommend creating a new component for keyinput (like the one discussed) and moving this logic there.

decreasing the length of code using for loops and iterators. and removing excess if statements and variables, changing the order of key maps.

kitswas · 2023-10-10T13:31:25Z

@franklin654 Are you still working on this?

franklin654 · 2023-10-10T13:37:32Z

@franklin654 Are you still working on this?

Yes Just started today again.

kitswas · 2023-11-16T11:12:05Z

src/preferences.cpp

+void Preferences::get_scan_code(WORD vk, char* a, int size)
+{
+    char sc = MapVirtualKeyA((UINT)vk, MAPVK_VK_TO_CHAR);
+    if(sc >= '0' && sc <= 'Z') {
+        strncpy(a, "", size);
+        strncpy(a, &sc, 1);
+    }
+    else {
+        strncpy(a, vk_maps[vk], size);
+    }
+}


@franklin654
There was a bug in the code using strncpy that was causing the application to crash.
Did you fix that?
Please debug and verify.

See Preferences::get_scan_code() in the file src/preferences.cpp.

Yes I replaced the strncpy with strncpy_s with buffer size checks just haven't commited yet there are other changes that need to be done in preferences.cpp

1. Changed the format of saving and loading button maps. 2. Fixed the lines where memory leakage. 3. Made sure server can differentiate between mouse mapping and keyboard mapping. 4. Added some extra checks to make sure users can't put invalid inputs or perform overloading while setting the button maps.

Fixing some of the code smells Sound Cloud suggested that are fixable.

Changing the Documentation according to your suggestions. kitswas#5 (comment)

kitswas · 2023-12-15T13:55:47Z

@franklin654
Please merge changes from main into your branch and run the code linter.

./code-lint.ps1

sonarcloud · 2023-12-16T04:18:18Z

Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

33 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

franklin654 added 9 commits August 7, 2023 22:27

Add Mouse_pointer

1ef76e0

Update executor.cpp

cc2f07c

changing the mouse_sensitivity_variable

7934960

updating PROJECT_SOURCES

3bb24ce

created programmable variables

7db3439

changed all static hard coded values to variables and included them in a separate folder

Update CMakeLists.txt

921ae75

removed extra spaces

adding icons

590fcbc

icons for preference buttons

button icons

d03e09b

added image files for button icons

user defined key maps

15a92c7

added the functions and maps required to dynamically change key maps as defined by the user

franklin654 changed the title ~~User preferences~~ Add user editable key maps Aug 26, 2023

franklin654 and others added 3 commits August 30, 2023 15:11

fixing bugs and adding resources

11ea776

fixing the bug that occurs when mapping to numbers, adding the icon files qt resource

add tracking for mouse_press

a2509f1

adding the mouse press filter to map the keys to mouse buttons

Moved resource files

1e8f652

kitswas requested changes Aug 30, 2023

View reviewed changes

kitswas and others added 4 commits August 30, 2023 19:03

Use resources instead of absolute paths

c393a5f

Update src/main.cpp

3cda9c7

Co-authored-by: kitswas <90329875+kitswas@users.noreply.github.com>

Update CMakeLists.txt

6da54fc

Co-authored-by: kitswas <90329875+kitswas@users.noreply.github.com>

fixing the suggested changes

6336624

fixing the broken include guard, removed the redundant functions, removed the qt::endl, fixed the typo in config file name

kitswas and others added 4 commits August 31, 2023 00:09

Updated the preferences UI

c64b9d1

added documentation

d079152

described all the functions, their parameters and what the functions return.

Merge branch 'User_Preferences' of https://github.com/franklin654/Vir…

31603c7

…tualGamePad-PC into User_Preferences

fixing key sizes

9a29227

kitswas approved these changes Sep 1, 2023

View reviewed changes

franklin654 added 2 commits September 1, 2023 22:12

Revert "fixing key sizes"

e328c12

This reverts commit 9a29227.

changes to documentation and fixing sizes

1ada43d

kitswas reviewed Sep 3, 2023

View reviewed changes

removing unccessary code

750c2b8

decreasing the length of code using for loops and iterators. and removing excess if statements and variables, changing the order of key maps.

Repository owner deleted a comment from sonarcloud bot Sep 9, 2023

franklin654 added 3 commits November 16, 2023 14:17

changing the datatype of buttons

cfb1cbd

Merge branch 'kitswas:main' into User_Preferences

8fc51e1

Solving sub module changes

cc5c86d

kitswas reviewed Nov 16, 2023

View reviewed changes

franklin654 added 3 commits December 10, 2023 10:46

Sound Cloud Suggestions

52ce451

Fixing some of the code smells Sound Cloud suggested that are fixable.

Documentation changes

24e3836

Changing the Documentation according to your suggestions. kitswas#5 (comment)

franklin654 and others added 5 commits December 15, 2023 19:45

Merge branch 'kitswas:main' into User_Preferences

e4e009d

Applying Clang-Format to the code

fdbd020

Reset Preferences on Cancel

855b5f6

Added the Menu Button and View Button

b03f50f

Fixed submodules

b78da90

kitswas merged commit 860a475 into kitswas:main Dec 16, 2023
2 checks passed

kitswas mentioned this pull request Dec 16, 2023

Store and manage user preferences #2

Open

3 tasks

franklin654 deleted the User_Preferences branch December 17, 2023 21:33

franklin654 restored the User_Preferences branch December 17, 2023 21:34

franklin654 deleted the User_Preferences branch December 17, 2023 21:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add user editable key maps #5

Add user editable key maps #5

franklin654 commented Aug 26, 2023

kitswas commented Aug 30, 2023

franklin654 commented Aug 30, 2023

kitswas commented Sep 1, 2023 •

edited

Loading

kitswas commented Sep 1, 2023

franklin654 commented Sep 1, 2023 •

edited

Loading

kitswas commented Sep 2, 2023

kitswas commented Sep 2, 2023 •

edited

Loading

kitswas commented Sep 3, 2023 •

edited

Loading

kitswas Sep 3, 2023

kitswas Sep 3, 2023 •

edited

Loading

kitswas commented Oct 10, 2023

franklin654 commented Oct 10, 2023

kitswas Nov 16, 2023

franklin654 Nov 18, 2023

kitswas commented Dec 15, 2023

sonarcloud bot commented Dec 16, 2023

Add user editable key maps #5

Add user editable key maps #5

Conversation

franklin654 commented Aug 26, 2023

kitswas commented Aug 30, 2023

franklin654 commented Aug 30, 2023

kitswas commented Sep 1, 2023 • edited Loading

kitswas commented Sep 1, 2023

franklin654 commented Sep 1, 2023 • edited Loading

kitswas commented Sep 2, 2023

kitswas commented Sep 2, 2023 • edited Loading

kitswas commented Sep 3, 2023 • edited Loading

kitswas Sep 3, 2023

Choose a reason for hiding this comment

kitswas Sep 3, 2023 • edited Loading

Choose a reason for hiding this comment

kitswas commented Oct 10, 2023

franklin654 commented Oct 10, 2023

kitswas Nov 16, 2023

Choose a reason for hiding this comment

franklin654 Nov 18, 2023

Choose a reason for hiding this comment

kitswas commented Dec 15, 2023

sonarcloud bot commented Dec 16, 2023

Quality Gate passed

kitswas commented Sep 1, 2023 •

edited

Loading

franklin654 commented Sep 1, 2023 •

edited

Loading

kitswas commented Sep 2, 2023 •

edited

Loading

kitswas commented Sep 3, 2023 •

edited

Loading

kitswas Sep 3, 2023 •

edited

Loading