Initial commit

This commit is contained in:
Jamie Greunbaum 2024-09-17 03:09:48 -04:00
commit b40cb2f692
34 changed files with 2617 additions and 0 deletions

76
.gitignore vendored Normal file
View File

@ -0,0 +1,76 @@
# This file is used to ignore files which are generated
# ----------------------------------------------------------------------------
*~
*.autosave
*.a
*.core
*.moc
*.o
*.obj
*.orig
*.rej
*.so
*.so.*
*_pch.h.cpp
*_resource.rc
*.qm
.#*
*.*#
core
!core/
tags
.DS_Store
.directory
*.debug
Makefile*
*.prl
*.app
moc_*.cpp
ui_*.h
qrc_*.cpp
Thumbs.db
*.res
*.rc
/.qmake.cache
/.qmake.stash
# qtcreator generated files
*.pro.user*
CMakeLists.txt.user*
# xemacs temporary files
*.flc
# Vim temporary files
.*.swp
# Visual Studio generated files
*.ib_pdb_index
*.idb
*.ilk
*.pdb
*.sln
*.suo
*.vcproj
*vcproj.*.*.user
*.ncb
*.sdf
*.opensdf
*.vcxproj
*vcxproj.*
# MinGW generated files
*.Debug
*.Release
# Python byte code
*.pyc
# Binaries
# --------
*.dll
*.exe
build/

232
LICENSE Normal file
View File

@ -0,0 +1,232 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and modification follow.
TERMS AND CONDITIONS
0. Definitions.
“This License” refers to version 3 of the GNU General Public License.
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
A “covered work” means either the unmodified Program or a work based on the Program.
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
1. Source Code.
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
7. Additional Terms.
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
11. Patents.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
MacroBinds
Copyright (C) 2024 BattyBovine
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 <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
MacroBinds Copyright (C) 2024 BattyBovine
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/philosophy/why-not-lgpl.html>.

61
MacroBinds.pro Normal file
View File

@ -0,0 +1,61 @@
QT += core gui
greaterThan(QT_MAJOR_VERSION, 4): QT += widgets
CONFIG += c++17
# You can make your code fail to compile if it uses deprecated APIs.
# In order to do so, uncomment the following line.
DEFINES += QT_DISABLE_DEPRECATED_BEFORE=0x060000 # disables all the APIs deprecated before Qt 6.0.0
SOURCES += \
QKeySender/qkeysender.cpp \
QtImprovements/qsettingsplus.cpp \
Widgets/applicationinfowidget.cpp \
Widgets/qdialbutton.cpp \
Widgets/qmacrobutton.cpp \
Widgets/qprocesslistitem.cpp \
Widgets/qratiobutton.cpp \
WindowFinder/windowfinder.cpp \
main.cpp \
qmacrobindswindow.cpp \
qmacrokeysmanager.cpp \
windowfinderdialogue.cpp
HEADERS += \
QKeySender/qkeysender.h \
QtImprovements/qsettingsplus.h \
Widgets/applicationinfowidget.h \
Widgets/qdialbutton.h \
Widgets/qmacrobutton.h \
Widgets/qprocesslistitem.h \
Widgets/qratiobutton.h \
WindowFinder/windowfinder.h \
qmacrobindswindow.h \
qmacrokeysmanager.h \
windowfinderdialogue.h
FORMS += \
Widgets/applicationinfowidget.ui \
qmacrobindswindow.ui \
windowfinderdialogue.ui
TRANSLATIONS += \
MacroBinds_en_GB.ts
CONFIG += lrelease
CONFIG += embed_translations
# Default rules for deployment.
qnx: target.path = /tmp/$${TARGET}/bin
else: unix:!android: target.path = /opt/$${TARGET}/bin
!isEmpty(target.path): INSTALLS += target
win32: LIBS += -lUser32
#win32: LIBS += -lGdi32
win32: LIBS += -L$$PWD/libs/winx64-vs2019/ -lhidapi
win32: LIBS += -L"D:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.40.33807\lib\x64"
INCLUDEPATH += $$PWD/libs/include
DEPENDPATH += $$PWD/libs/include
DEFINES += _SILENCE_CXX17_CODECVT_HEADER_DEPRECATION_WARNING=1

3
MacroBinds_en_GB.ts Normal file
View File

@ -0,0 +1,3 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE TS>
<TS version="2.1" language="en_GB"></TS>

View File

@ -0,0 +1,5 @@
#include "qkeysender.h"
QKeySender::QKeySender(QObject *parent)
: QObject{parent}
{}

15
QKeySender/qkeysender.h Normal file
View File

@ -0,0 +1,15 @@
#ifndef QKEYSENDER_H
#define QKEYSENDER_H
#include <QObject>
class QKeySender : public QObject
{
Q_OBJECT
public:
explicit QKeySender(QObject *parent = nullptr);
signals:
};
#endif // QKEYSENDER_H

View File

@ -0,0 +1,18 @@
#include "qsettingsplus.h"
#include <QApplication>
QSettings QSettingsPlus::createQSettings(QObject *parent)
{
return QSettings(QSettings::Format::IniFormat,
QSettings::Scope::UserScope,
QApplication::organizationName(),
QApplication::applicationName(),
parent);
}
const QString QSettingsPlus::keyDataSeparator()
{
return QString("|");
}

View File

@ -0,0 +1,14 @@
#ifndef QSETTINGSPLUS_H
#define QSETTINGSPLUS_H
#include <QSettings>
class QSettingsPlus : public QSettings
{
public:
static QSettings createQSettings(QObject *parent = nullptr);
static const QString keyDataSeparator();
};
#endif // QSETTINGSPLUS_H

3
README.md Normal file
View File

@ -0,0 +1,3 @@
# MacroBinds
Software for setting key bindings to an Arduino-based Raw HID macro keyboard.

View File

@ -0,0 +1,33 @@
#include "Widgets/applicationinfowidget.h"
#include "ui_applicationinfowidget.h"
ApplicationInfoWidget::ApplicationInfoWidget(QWidget *parent)
: QWidget(parent)
, ui(new Ui::ApplicationInfoWidget)
{
ui->setupUi(this);
}
ApplicationInfoWidget::~ApplicationInfoWidget()
{
delete ui;
}
void ApplicationInfoWidget::setTextData(const QString &exe,
const QString &path,
const QString &title)
{
ui->editProgramExe->setText(exe);
ui->editProgramPath->setText(path);
ui->editProgramTitle->setText(title);
}
void ApplicationInfoWidget::setTextData(const QString &name,
const QString &exe,
const QString &path,
const QString &title)
{
ui->editProgramName->setText(name);
this->setTextData(exe, path, title);
}

View File

@ -0,0 +1,31 @@
#ifndef APPLICATIONINFOWIDGET_H
#define APPLICATIONINFOWIDGET_H
#include <QWidget>
namespace Ui {
class ApplicationInfoWidget;
}
class ApplicationInfoWidget : public QWidget
{
Q_OBJECT
public:
explicit ApplicationInfoWidget(QWidget *parent = nullptr);
~ApplicationInfoWidget();
void setTextData(const QString &exe,
const QString &path,
const QString &title);
void setTextData(const QString &name,
const QString &exe,
const QString &path,
const QString &title);
private:
Ui::ApplicationInfoWidget *ui;
};
#endif // APPLICATIONINFOWIDGET_H

View File

@ -0,0 +1,90 @@
<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
<class>ApplicationInfoWidget</class>
<widget class="QWidget" name="ApplicationInfoWidget">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>342</width>
<height>132</height>
</rect>
</property>
<property name="windowTitle">
<string>Form</string>
</property>
<layout class="QVBoxLayout" name="verticalLayout">
<item>
<layout class="QGridLayout" name="gridLayout">
<item row="0" column="0">
<widget class="QLabel" name="labelProgramName">
<property name="text">
<string>Name:</string>
</property>
<property name="alignment">
<set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
</property>
</widget>
</item>
<item row="0" column="1">
<widget class="QLineEdit" name="editProgramName"/>
</item>
<item row="1" column="0">
<widget class="QLabel" name="labelProgramExe">
<property name="text">
<string>Executable:</string>
</property>
<property name="alignment">
<set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
</property>
</widget>
</item>
<item row="1" column="1">
<widget class="QLineEdit" name="editProgramExe"/>
</item>
<item row="2" column="0">
<widget class="QLabel" name="labelProgramPath">
<property name="text">
<string>Path:</string>
</property>
<property name="alignment">
<set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
</property>
</widget>
</item>
<item row="2" column="1">
<widget class="QLineEdit" name="editProgramPath"/>
</item>
<item row="3" column="0">
<widget class="QLabel" name="labelProgramTitle">
<property name="text">
<string>Window Title:</string>
</property>
<property name="alignment">
<set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
</property>
</widget>
</item>
<item row="3" column="1">
<widget class="QLineEdit" name="editProgramTitle"/>
</item>
</layout>
</item>
<item>
<spacer name="verticalSpacer">
<property name="orientation">
<enum>Qt::Vertical</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
<width>20</width>
<height>0</height>
</size>
</property>
</spacer>
</item>
</layout>
</widget>
<resources/>
<connections/>
</ui>

6
Widgets/qdialbutton.cpp Normal file
View File

@ -0,0 +1,6 @@
#include "qdialbutton.h"
QDialButton::QDialButton(const quint8 &row, const quint8 &column, QWidget *parent) : QRatioButton(row, column, parent)
{
}

15
Widgets/qdialbutton.h Normal file
View File

@ -0,0 +1,15 @@
#ifndef QDIALBUTTON_H
#define QDIALBUTTON_H
#include "qratiobutton.h"
class QDialButton : public QRatioButton
{
Q_OBJECT
public:
QDialButton(const quint8 &row, const quint8 &column, QWidget *parent = nullptr);
};
#endif // QDIALBUTTON_H

6
Widgets/qmacrobutton.cpp Normal file
View File

@ -0,0 +1,6 @@
#include "qmacrobutton.h"
QMacroButton::QMacroButton(const quint8 &row, const quint8 &column, QWidget *parent) : QRatioButton(row, column, parent)
{
}

15
Widgets/qmacrobutton.h Normal file
View File

@ -0,0 +1,15 @@
#ifndef QMACROBUTTON_H
#define QMACROBUTTON_H
#include "qratiobutton.h"
class QMacroButton : public QRatioButton
{
Q_OBJECT
public:
QMacroButton(const quint8 &row, const quint8 &column, QWidget *parent = nullptr);
};
#endif // QMACROBUTTON_H

View File

@ -0,0 +1,25 @@
#include "qprocesslistitem.h"
#include "QtImprovements/qsettingsplus.h"
QProcessListItem::QProcessListItem(const WindowData &windowData, QListWidget *listview, int type)
: QListWidgetItem(listview, type)
{
this->setFlags(this->flags() | Qt::ItemFlag::ItemIsEditable);
this->windowData = windowData;
this->setText(this->windowData.processName);
}
void QProcessListItem::updateText(const QString &text)
{
const QString &oldText = this->windowData.processName;
QSettings settings = QSettingsPlus::createQSettings();
settings.beginGroup("ApplicationNames");
const QString &value = settings.value(oldText).toString();
settings.setValue(text, value);
this->windowData.importDataFromSetting(value);
}

View File

@ -0,0 +1,22 @@
#ifndef QPROCESSLISTITEM_H
#define QPROCESSLISTITEM_H
#include <QListWidgetItem>
#include "WindowFinder/windowfinder.h"
class QProcessListItem : public QListWidgetItem
{
public:
explicit QProcessListItem(const WindowData &windowData, QListWidget *listview = nullptr, int type = Type);
void updateText(const QString &text);
WindowData getWindowData() const { return windowData; }
private:
WindowData windowData;
};
#endif // QPROCESSLISTITEM_H

24
Widgets/qratiobutton.cpp Normal file
View File

@ -0,0 +1,24 @@
#include "qratiobutton.h"
QRatioButton::QRatioButton(const quint8 &row, const quint8 &column, QWidget *parent) : QPushButton(parent)
{
this->setCheckable(true);
QSizePolicy sizePolicy(QSizePolicy::Policy::MinimumExpanding, QSizePolicy::Policy::MinimumExpanding);
sizePolicy.setHeightForWidth(true);
this->setSizePolicy(sizePolicy);
this->row = row;
this->column = column;
QObject::connect(this, &QPushButton::pressed, this, &QRatioButton::onButtonPressSignal);
}
int QRatioButton::heightForWidth(int w) const
{
return w;
}
void QRatioButton::onButtonPressSignal()
{
emit this->pressedRowColumn(row, column);
}

25
Widgets/qratiobutton.h Normal file
View File

@ -0,0 +1,25 @@
#ifndef QRATIOBUTTON_H
#define QRATIOBUTTON_H
#include <QPushButton>
class QRatioButton : public QPushButton
{
Q_OBJECT
public:
QRatioButton(const quint8 &row, const quint8 &column, QWidget *parent = nullptr);
virtual int heightForWidth(int w) const;
private:
void onButtonPressSignal();
quint8 row = 0;
quint8 column = 0;
signals:
void pressedRowColumn(const quint8 &row, const quint8 &column);
};
#endif // QRATIOBUTTON_H

View File

@ -0,0 +1,200 @@
#include "windowfinder.h"
#include "QtImprovements/qsettingsplus.h"
#include <QFileInfo>
#include <QImage>
#include <QKeySequence>
#ifdef Q_OS_WIN
#include <Windows.h>
#include <processthreadsapi.h>
#include <Psapi.h>
#endif
WindowFinder::WindowFinder() {}
WindowData WindowFinder::getFrontmostWindowProcess()
{
#ifdef Q_OS_WIN
return WindowFinder::getWin32FrontmostWindowProcess();
#else
return WindowData();
#endif
}
void WindowFinder::sendInputToFrontmostWindow(const QKeySequence &keys, const KeyEventType &type)
{
#ifdef Q_OS_WIN
WindowFinder::sendWin32InputToFrontmostWindow(keys, type);
#else
return;
#endif
}
void WindowData::importDataFromSetting(const QString &value)
{
QStringList values = value.split(QSettingsPlus::keyDataSeparator());
this->processName = values[0];
this->processPath = values[1];
values.removeAt(1);
values.removeAt(0);
this->processWindowTitle = values.join(QSettingsPlus::keyDataSeparator());
}
#ifdef Q_OS_WIN
WindowData WindowFinder::getWin32FrontmostWindowProcess()
{
WindowData data;
HWND focusWindow = GetForegroundWindow();
DWORD processId;
GetWindowThreadProcessId(focusWindow, &processId);
HANDLE processHandle = OpenProcess(PROCESS_QUERY_INFORMATION | PROCESS_VM_READ,
false,
processId);
TCHAR processPath[MAX_PATH];
DWORD pathLength = GetModuleFileNameExW(processHandle, NULL, processPath, MAX_PATH);
assert(pathLength != ERROR_INSUFFICIENT_BUFFER);
data.processPath = QString::fromWCharArray(processPath, pathLength);
data.processName = QFileInfo(data.processPath).fileName();
/* Extract icon */
// HICON processIcon;
// ExtractIconExW(processPath, 0, &processIcon, nullptr, 1);
// QByteArray pixelBuffer;
// WindowFinder::getWin32IconData(processIcon, 32, pixelBuffer);
/* End extract icon */
WCHAR processTitle[512];
DWORD titleLength = GetWindowTextW(focusWindow, &processTitle[0], 512);
assert(titleLength != ERROR_INSUFFICIENT_BUFFER);
data.processWindowTitle = QString::fromWCharArray(processTitle, titleLength);
CloseHandle(processHandle);
return data;
}
// bool WindowFinder::getWin32IconData(HICON hIcon, int nColorBits, QByteArray &buffer)
// {
// HDC dc = CreateCompatibleDC(NULL);
// const char iconHeader[6] = {0, 0, 1, 0, 1, 0};
// buffer.append(iconHeader);
// ICONINFO iconInfo;
// GetIconInfo(hIcon, &iconInfo);
// BITMAPINFO bmInfo = {{0}};
// bmInfo.bmiHeader.biSize = sizeof(BITMAPINFOHEADER);
// bmInfo.bmiHeader.biBitCount = 0;
// if (!GetDIBits(dc, iconInfo.hbmColor, 0, 0, NULL, &bmInfo, DIB_RGB_COLORS))
// return false;
// int nBmInfoSize = sizeof(BITMAPINFOHEADER);
// if (nColorBits < 24)
// nBmInfoSize += sizeof(RGBQUAD) * (int) (static_cast<unsigned long long>(1) << nColorBits);
// QVector<quint8> bitmapInfo;
// bitmapInfo.resize(nBmInfoSize);
// BITMAPINFO *pBmInfo = (BITMAPINFO *) bitmapInfo.data();
// memcpy(pBmInfo, &bmInfo, sizeof(BITMAPINFOHEADER));
// if (!bmInfo.bmiHeader.biSizeImage)
// return false;
// QVector<quint8> bits;
// bits.resize(bmInfo.bmiHeader.biSizeImage);
// pBmInfo->bmiHeader.biBitCount = nColorBits;
// pBmInfo->bmiHeader.biCompression = BI_RGB;
// if (!GetDIBits(dc,
// iconInfo.hbmColor,
// 0,
// bmInfo.bmiHeader.biHeight,
// bits.data(),
// pBmInfo,
// DIB_RGB_COLORS))
// return false;
// BITMAPINFO maskInfo = {{0}};
// maskInfo.bmiHeader.biSize = sizeof(BITMAPINFOHEADER);
// maskInfo.bmiHeader.biBitCount = 0;
// if (!GetDIBits(dc, iconInfo.hbmMask, 0, 0, NULL, &maskInfo, DIB_RGB_COLORS)
// || maskInfo.bmiHeader.biBitCount != 1)
// return false;
// QVector<quint8> maskBits;
// maskBits.resize(maskInfo.bmiHeader.biSizeImage);
// QVector<quint8> maskInfoBytes;
// maskInfoBytes.resize(sizeof(BITMAPINFO) + 2 * sizeof(RGBQUAD));
// BITMAPINFO *pMaskInfo = (BITMAPINFO *) maskInfoBytes.data();
// memcpy(pMaskInfo, &maskInfo, sizeof(maskInfo));
// if (!GetDIBits(dc,
// iconInfo.hbmMask,
// 0,
// maskInfo.bmiHeader.biHeight,
// maskBits.data(),
// pMaskInfo,
// DIB_RGB_COLORS)) {
// return false;
// }
// IconDirEntry dir;
// dir.nWidth = (quint8) pBmInfo->bmiHeader.biWidth;
// dir.nHeight = (quint8) pBmInfo->bmiHeader.biHeight;
// dir.nNumColorsInPalette = (nColorBits == 4 ? 16 : 0);
// dir.nReserved = 0;
// dir.nNumColorPlanes = 0;
// dir.nBitsPerPixel = pBmInfo->bmiHeader.biBitCount;
// dir.nDataLength = pBmInfo->bmiHeader.biSizeImage + pMaskInfo->bmiHeader.biSizeImage
// + nBmInfoSize;
// dir.nOffset = sizeof(dir) + sizeof(iconHeader);
// const char *dirBuffer = reinterpret_cast<const char *>(&dir);
// buffer.append(dirBuffer);
// pBmInfo->bmiHeader.biHeight *= 2;
// pBmInfo->bmiHeader.biCompression = 0;
// pBmInfo->bmiHeader.biSizeImage += pMaskInfo->bmiHeader.biSizeImage;
// const char *bmiHeaderData = reinterpret_cast<const char *>(&pBmInfo->bmiHeader);
// buffer.append(bmiHeaderData);
// const char *bitData = reinterpret_cast<const char *>(bits.data());
// buffer.append(bitData);
// const char *maskBitData = reinterpret_cast<const char *>(maskBits.data());
// buffer.append(maskBitData);
// DeleteObject(iconInfo.hbmMask);
// DeleteObject(iconInfo.hbmColor);
// DeleteDC(dc);
// return true;
// }
void WindowFinder::sendWin32InputToFrontmostWindow(const QKeySequence &keys, const KeyEventType &type)
{
const QString &keyStrings = keys.toString();
const QStringList &keyStringsList = keyStrings.split(",");
for (const QString &keyString : keyStringsList) {
const QStringList &keys = keyString.split("+");
for (const QString &key : keys) {
INPUT input[1] = {};
ZeroMemory(input, sizeof(input));
input[0].type = INPUT_KEYBOARD;
if (key.compare("Shift", Qt::CaseInsensitive) == 0) {
input[0].ki.wVk = VK_LSHIFT;
} else if (key.compare("X", Qt::CaseInsensitive) == 0) {
input[0].ki.wVk = 'X';
} else if (key.compare("Y", Qt::CaseInsensitive) == 0) {
input[0].ki.wVk = 'Y';
} else if (key.compare("Z", Qt::CaseInsensitive) == 0) {
input[0].ki.wVk = 'Z';
}
input[0].ki.dwFlags = type == KeyEventType::RELEASE ? KEYEVENTF_KEYUP : 0;
SendInput(ARRAYSIZE(input), input, sizeof(INPUT));
}
}
}
#endif // Q_OS_WIN

View File

@ -0,0 +1,62 @@
#ifndef WINDOWFINDER_H
#define WINDOWFINDER_H
#include <QMetaType>
#include <QString>
#ifdef Q_OS_WIN
struct IconDirEntry
{
quint8 nWidth;
quint8 nHeight;
quint8 nNumColorsInPalette;
quint8 nReserved;
qint16 nNumColorPlanes;
qint16 nBitsPerPixel;
quint32 nDataLength;
quint32 nOffset;
};
#endif // Q_OS_WIN
enum class KeyEventType : qint8 {
PRESS,
RELEASE,
PRESS_AND_RELEASE
};
Q_DECLARE_METATYPE(KeyEventType)
class WindowData
{
public:
WindowData() = default;
~WindowData() = default;
WindowData(const WindowData &) = default;
WindowData &operator=(const WindowData &) = default;
void importDataFromSetting(const QString &value);
QString processName = "";
QString processPath = "";
QString processWindowTitle = "";
};
Q_DECLARE_METATYPE(WindowData);
class WindowFinder
{
public:
WindowFinder();
static WindowData getFrontmostWindowProcess();
static void sendInputToFrontmostWindow(const QKeySequence &keys, const KeyEventType &type);
private:
#ifdef Q_OS_WIN
static WindowData getWin32FrontmostWindowProcess();
// static bool getWin32IconData(HICON hIcon, int nColorBits, QByteArray &buffer);
static void sendWin32InputToFrontmostWindow(const QKeySequence &keys, const KeyEventType &type);
#endif // Q_OS_WIN
};
#endif // WINDOWFINDER_H

624
libs/include/hidapi.h Normal file
View File

@ -0,0 +1,624 @@
/*******************************************************
HIDAPI - Multi-Platform library for
communication with HID devices.
Alan Ott
Signal 11 Software
libusb/hidapi Team
Copyright 2023, All Rights Reserved.
At the discretion of the user of this library,
this software may be licensed under the terms of the
GNU General Public License v3, a BSD-Style license, or the
original HIDAPI license as outlined in the LICENSE.txt,
LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt
files located at the root of the source distribution.
These files may also be found in the public source
code repository located at:
https://github.com/libusb/hidapi .
********************************************************/
/** @file
* @defgroup API hidapi API
*/
#ifndef HIDAPI_H__
#define HIDAPI_H__
#include <wchar.h>
/* #480: this is to be refactored properly for v1.0 */
#ifdef _WIN32
#ifndef HID_API_NO_EXPORT_DEFINE
#define HID_API_EXPORT __declspec(dllexport)
#endif
#endif
#ifndef HID_API_EXPORT
#define HID_API_EXPORT /**< API export macro */
#endif
/* To be removed in v1.0 */
#define HID_API_CALL /**< API call macro */
#define HID_API_EXPORT_CALL HID_API_EXPORT HID_API_CALL /**< API export and call macro*/
/** @brief Static/compile-time major version of the library.
@ingroup API
*/
#define HID_API_VERSION_MAJOR 0
/** @brief Static/compile-time minor version of the library.
@ingroup API
*/
#define HID_API_VERSION_MINOR 14
/** @brief Static/compile-time patch version of the library.
@ingroup API
*/
#define HID_API_VERSION_PATCH 0
/* Helper macros */
#define HID_API_AS_STR_IMPL(x) #x
#define HID_API_AS_STR(x) HID_API_AS_STR_IMPL(x)
#define HID_API_TO_VERSION_STR(v1, v2, v3) HID_API_AS_STR(v1.v2.v3)
/** @brief Coverts a version as Major/Minor/Patch into a number:
<8 bit major><16 bit minor><8 bit patch>.
This macro was added in version 0.12.0.
Convenient function to be used for compile-time checks, like:
@code{.c}
#if HID_API_VERSION >= HID_API_MAKE_VERSION(0, 12, 0)
@endcode
@ingroup API
*/
#define HID_API_MAKE_VERSION(mj, mn, p) (((mj) << 24) | ((mn) << 8) | (p))
/** @brief Static/compile-time version of the library.
This macro was added in version 0.12.0.
@see @ref HID_API_MAKE_VERSION.
@ingroup API
*/
#define HID_API_VERSION HID_API_MAKE_VERSION(HID_API_VERSION_MAJOR, HID_API_VERSION_MINOR, HID_API_VERSION_PATCH)
/** @brief Static/compile-time string version of the library.
@ingroup API
*/
#define HID_API_VERSION_STR HID_API_TO_VERSION_STR(HID_API_VERSION_MAJOR, HID_API_VERSION_MINOR, HID_API_VERSION_PATCH)
/** @brief Maximum expected HID Report descriptor size in bytes.
Since version 0.13.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 13, 0)
@ingroup API
*/
#define HID_API_MAX_REPORT_DESCRIPTOR_SIZE 4096
#ifdef __cplusplus
extern "C" {
#endif
/** A structure to hold the version numbers. */
struct hid_api_version {
int major; /**< major version number */
int minor; /**< minor version number */
int patch; /**< patch version number */
};
struct hid_device_;
typedef struct hid_device_ hid_device; /**< opaque hidapi structure */
/** @brief HID underlying bus types.
@ingroup API
*/
typedef enum {
/** Unknown bus type */
HID_API_BUS_UNKNOWN = 0x00,
/** USB bus
Specifications:
https://usb.org/hid */
HID_API_BUS_USB = 0x01,
/** Bluetooth or Bluetooth LE bus
Specifications:
https://www.bluetooth.com/specifications/specs/human-interface-device-profile-1-1-1/
https://www.bluetooth.com/specifications/specs/hid-service-1-0/
https://www.bluetooth.com/specifications/specs/hid-over-gatt-profile-1-0/ */
HID_API_BUS_BLUETOOTH = 0x02,
/** I2C bus
Specifications:
https://docs.microsoft.com/previous-versions/windows/hardware/design/dn642101(v=vs.85) */
HID_API_BUS_I2C = 0x03,
/** SPI bus
Specifications:
https://www.microsoft.com/download/details.aspx?id=103325 */
HID_API_BUS_SPI = 0x04,
} hid_bus_type;
/** hidapi info structure */
struct hid_device_info {
/** Platform-specific device path */
char *path;
/** Device Vendor ID */
unsigned short vendor_id;
/** Device Product ID */
unsigned short product_id;
/** Serial Number */
wchar_t *serial_number;
/** Device Release Number in binary-coded decimal,
also known as Device Version Number */
unsigned short release_number;
/** Manufacturer String */
wchar_t *manufacturer_string;
/** Product string */
wchar_t *product_string;
/** Usage Page for this Device/Interface
(Windows/Mac/hidraw only) */
unsigned short usage_page;
/** Usage for this Device/Interface
(Windows/Mac/hidraw only) */
unsigned short usage;
/** The USB interface which this logical device
represents.
Valid only if the device is a USB HID device.
Set to -1 in all other cases.
*/
int interface_number;
/** Pointer to the next device */
struct hid_device_info *next;
/** Underlying bus type
Since version 0.13.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 13, 0)
*/
hid_bus_type bus_type;
};
/** @brief Initialize the HIDAPI library.
This function initializes the HIDAPI library. Calling it is not
strictly necessary, as it will be called automatically by
hid_enumerate() and any of the hid_open_*() functions if it is
needed. This function should be called at the beginning of
execution however, if there is a chance of HIDAPI handles
being opened by different threads simultaneously.
@ingroup API
@returns
This function returns 0 on success and -1 on error.
Call hid_error(NULL) to get the failure reason.
*/
int HID_API_EXPORT HID_API_CALL hid_init(void);
/** @brief Finalize the HIDAPI library.
This function frees all of the static data associated with
HIDAPI. It should be called at the end of execution to avoid
memory leaks.
@ingroup API
@returns
This function returns 0 on success and -1 on error.
*/
int HID_API_EXPORT HID_API_CALL hid_exit(void);
/** @brief Enumerate the HID Devices.
This function returns a linked list of all the HID devices
attached to the system which match vendor_id and product_id.
If @p vendor_id is set to 0 then any vendor matches.
If @p product_id is set to 0 then any product matches.
If @p vendor_id and @p product_id are both set to 0, then
all HID devices will be returned.
@ingroup API
@param vendor_id The Vendor ID (VID) of the types of device
to open.
@param product_id The Product ID (PID) of the types of
device to open.
@returns
This function returns a pointer to a linked list of type
struct #hid_device_info, containing information about the HID devices
attached to the system,
or NULL in the case of failure or if no HID devices present in the system.
Call hid_error(NULL) to get the failure reason.
@note The returned value by this function must to be freed by calling hid_free_enumeration(),
when not needed anymore.
*/
struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned short vendor_id, unsigned short product_id);
/** @brief Free an enumeration Linked List
This function frees a linked list created by hid_enumerate().
@ingroup API
@param devs Pointer to a list of struct_device returned from
hid_enumerate().
*/
void HID_API_EXPORT HID_API_CALL hid_free_enumeration(struct hid_device_info *devs);
/** @brief Open a HID device using a Vendor ID (VID), Product ID
(PID) and optionally a serial number.
If @p serial_number is NULL, the first device with the
specified VID and PID is opened.
@ingroup API
@param vendor_id The Vendor ID (VID) of the device to open.
@param product_id The Product ID (PID) of the device to open.
@param serial_number The Serial Number of the device to open
(Optionally NULL).
@returns
This function returns a pointer to a #hid_device object on
success or NULL on failure.
Call hid_error(NULL) to get the failure reason.
@note The returned object must be freed by calling hid_close(),
when not needed anymore.
*/
HID_API_EXPORT hid_device * HID_API_CALL hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number);
/** @brief Open a HID device by its path name.
The path name be determined by calling hid_enumerate(), or a
platform-specific path name can be used (eg: /dev/hidraw0 on
Linux).
@ingroup API
@param path The path name of the device to open
@returns
This function returns a pointer to a #hid_device object on
success or NULL on failure.
Call hid_error(NULL) to get the failure reason.
@note The returned object must be freed by calling hid_close(),
when not needed anymore.
*/
HID_API_EXPORT hid_device * HID_API_CALL hid_open_path(const char *path);
/** @brief Write an Output report to a HID device.
The first byte of @p data[] must contain the Report ID. For
devices which only support a single report, this must be set
to 0x0. The remaining bytes contain the report data. Since
the Report ID is mandatory, calls to hid_write() will always
contain one more byte than the report contains. For example,
if a hid report is 16 bytes long, 17 bytes must be passed to
hid_write(), the Report ID (or 0x0, for devices with a
single report), followed by the report data (16 bytes). In
this example, the length passed in would be 17.
hid_write() will send the data on the first OUT endpoint, if
one exists. If it does not, it will send the data through
the Control Endpoint (Endpoint 0).
@ingroup API
@param dev A device handle returned from hid_open().
@param data The data to send, including the report number as
the first byte.
@param length The length in bytes of the data to send.
@returns
This function returns the actual number of bytes written and
-1 on error.
Call hid_error(dev) to get the failure reason.
*/
int HID_API_EXPORT HID_API_CALL hid_write(hid_device *dev, const unsigned char *data, size_t length);
/** @brief Read an Input report from a HID device with timeout.
Input reports are returned
to the host through the INTERRUPT IN endpoint. The first byte will
contain the Report number if the device uses numbered reports.
@ingroup API
@param dev A device handle returned from hid_open().
@param data A buffer to put the read data into.
@param length The number of bytes to read. For devices with
multiple reports, make sure to read an extra byte for
the report number.
@param milliseconds timeout in milliseconds or -1 for blocking wait.
@returns
This function returns the actual number of bytes read and
-1 on error.
Call hid_error(dev) to get the failure reason.
If no packet was available to be read within
the timeout period, this function returns 0.
*/
int HID_API_EXPORT HID_API_CALL hid_read_timeout(hid_device *dev, unsigned char *data, size_t length, int milliseconds);
/** @brief Read an Input report from a HID device.
Input reports are returned
to the host through the INTERRUPT IN endpoint. The first byte will
contain the Report number if the device uses numbered reports.
@ingroup API
@param dev A device handle returned from hid_open().
@param data A buffer to put the read data into.
@param length The number of bytes to read. For devices with
multiple reports, make sure to read an extra byte for
the report number.
@returns
This function returns the actual number of bytes read and
-1 on error.
Call hid_error(dev) to get the failure reason.
If no packet was available to be read and
the handle is in non-blocking mode, this function returns 0.
*/
int HID_API_EXPORT HID_API_CALL hid_read(hid_device *dev, unsigned char *data, size_t length);
/** @brief Set the device handle to be non-blocking.
In non-blocking mode calls to hid_read() will return
immediately with a value of 0 if there is no data to be
read. In blocking mode, hid_read() will wait (block) until
there is data to read before returning.
Nonblocking can be turned on and off at any time.
@ingroup API
@param dev A device handle returned from hid_open().
@param nonblock enable or not the nonblocking reads
- 1 to enable nonblocking
- 0 to disable nonblocking.
@returns
This function returns 0 on success and -1 on error.
Call hid_error(dev) to get the failure reason.
*/
int HID_API_EXPORT HID_API_CALL hid_set_nonblocking(hid_device *dev, int nonblock);
/** @brief Send a Feature report to the device.
Feature reports are sent over the Control endpoint as a
Set_Report transfer. The first byte of @p data[] must
contain the Report ID. For devices which only support a
single report, this must be set to 0x0. The remaining bytes
contain the report data. Since the Report ID is mandatory,
calls to hid_send_feature_report() will always contain one
more byte than the report contains. For example, if a hid
report is 16 bytes long, 17 bytes must be passed to
hid_send_feature_report(): the Report ID (or 0x0, for
devices which do not use numbered reports), followed by the
report data (16 bytes). In this example, the length passed
in would be 17.
@ingroup API
@param dev A device handle returned from hid_open().
@param data The data to send, including the report number as
the first byte.
@param length The length in bytes of the data to send, including
the report number.
@returns
This function returns the actual number of bytes written and
-1 on error.
Call hid_error(dev) to get the failure reason.
*/
int HID_API_EXPORT HID_API_CALL hid_send_feature_report(hid_device *dev, const unsigned char *data, size_t length);
/** @brief Get a feature report from a HID device.
Set the first byte of @p data[] to the Report ID of the
report to be read. Make sure to allow space for this
extra byte in @p data[]. Upon return, the first byte will
still contain the Report ID, and the report data will
start in data[1].
@ingroup API
@param dev A device handle returned from hid_open().
@param data A buffer to put the read data into, including
the Report ID. Set the first byte of @p data[] to the
Report ID of the report to be read, or set it to zero
if your device does not use numbered reports.
@param length The number of bytes to read, including an
extra byte for the report ID. The buffer can be longer
than the actual report.
@returns
This function returns the number of bytes read plus
one for the report ID (which is still in the first
byte), or -1 on error.
Call hid_error(dev) to get the failure reason.
*/
int HID_API_EXPORT HID_API_CALL hid_get_feature_report(hid_device *dev, unsigned char *data, size_t length);
/** @brief Get a input report from a HID device.
Since version 0.10.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 10, 0)
Set the first byte of @p data[] to the Report ID of the
report to be read. Make sure to allow space for this
extra byte in @p data[]. Upon return, the first byte will
still contain the Report ID, and the report data will
start in data[1].
@ingroup API
@param dev A device handle returned from hid_open().
@param data A buffer to put the read data into, including
the Report ID. Set the first byte of @p data[] to the
Report ID of the report to be read, or set it to zero
if your device does not use numbered reports.
@param length The number of bytes to read, including an
extra byte for the report ID. The buffer can be longer
than the actual report.
@returns
This function returns the number of bytes read plus
one for the report ID (which is still in the first
byte), or -1 on error.
Call hid_error(dev) to get the failure reason.
*/
int HID_API_EXPORT HID_API_CALL hid_get_input_report(hid_device *dev, unsigned char *data, size_t length);
/** @brief Close a HID device.
@ingroup API
@param dev A device handle returned from hid_open().
*/
void HID_API_EXPORT HID_API_CALL hid_close(hid_device *dev);
/** @brief Get The Manufacturer String from a HID device.
@ingroup API
@param dev A device handle returned from hid_open().
@param string A wide string buffer to put the data into.
@param maxlen The length of the buffer in multiples of wchar_t.
@returns
This function returns 0 on success and -1 on error.
Call hid_error(dev) to get the failure reason.
*/
int HID_API_EXPORT_CALL hid_get_manufacturer_string(hid_device *dev, wchar_t *string, size_t maxlen);
/** @brief Get The Product String from a HID device.
@ingroup API
@param dev A device handle returned from hid_open().
@param string A wide string buffer to put the data into.
@param maxlen The length of the buffer in multiples of wchar_t.
@returns
This function returns 0 on success and -1 on error.
Call hid_error(dev) to get the failure reason.
*/
int HID_API_EXPORT_CALL hid_get_product_string(hid_device *dev, wchar_t *string, size_t maxlen);
/** @brief Get The Serial Number String from a HID device.
@ingroup API
@param dev A device handle returned from hid_open().
@param string A wide string buffer to put the data into.
@param maxlen The length of the buffer in multiples of wchar_t.
@returns
This function returns 0 on success and -1 on error.
Call hid_error(dev) to get the failure reason.
*/
int HID_API_EXPORT_CALL hid_get_serial_number_string(hid_device *dev, wchar_t *string, size_t maxlen);
/** @brief Get The struct #hid_device_info from a HID device.
Since version 0.13.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 13, 0)
@ingroup API
@param dev A device handle returned from hid_open().
@returns
This function returns a pointer to the struct #hid_device_info
for this hid_device, or NULL in the case of failure.
Call hid_error(dev) to get the failure reason.
This struct is valid until the device is closed with hid_close().
@note The returned object is owned by the @p dev, and SHOULD NOT be freed by the user.
*/
struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_get_device_info(hid_device *dev);
/** @brief Get a string from a HID device, based on its string index.
@ingroup API
@param dev A device handle returned from hid_open().
@param string_index The index of the string to get.
@param string A wide string buffer to put the data into.
@param maxlen The length of the buffer in multiples of wchar_t.
@returns
This function returns 0 on success and -1 on error.
Call hid_error(dev) to get the failure reason.
*/
int HID_API_EXPORT_CALL hid_get_indexed_string(hid_device *dev, int string_index, wchar_t *string, size_t maxlen);
/** @brief Get a report descriptor from a HID device.
Since version 0.14.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 14, 0)
User has to provide a preallocated buffer where descriptor will be copied to.
The recommended size for preallocated buffer is @ref HID_API_MAX_REPORT_DESCRIPTOR_SIZE bytes.
@ingroup API
@param dev A device handle returned from hid_open().
@param buf The buffer to copy descriptor into.
@param buf_size The size of the buffer in bytes.
@returns
This function returns non-negative number of bytes actually copied, or -1 on error.
*/
int HID_API_EXPORT_CALL hid_get_report_descriptor(hid_device *dev, unsigned char *buf, size_t buf_size);
/** @brief Get a string describing the last error which occurred.
This function is intended for logging/debugging purposes.
This function guarantees to never return NULL.
If there was no error in the last function call -
the returned string clearly indicates that.
Any HIDAPI function that can explicitly indicate an execution failure
(e.g. by an error code, or by returning NULL) - may set the error string,
to be returned by this function.
Strings returned from hid_error() must not be freed by the user,
i.e. owned by HIDAPI library.
Device-specific error string may remain allocated at most until hid_close() is called.
Global error string may remain allocated at most until hid_exit() is called.
@ingroup API
@param dev A device handle returned from hid_open(),
or NULL to get the last non-device-specific error
(e.g. for errors in hid_open() or hid_enumerate()).
@returns
A string describing the last error (if any).
*/
HID_API_EXPORT const wchar_t* HID_API_CALL hid_error(hid_device *dev);
/** @brief Get a runtime version of the library.
This function is thread-safe.
@ingroup API
@returns
Pointer to statically allocated struct, that contains version.
*/
HID_API_EXPORT const struct hid_api_version* HID_API_CALL hid_version(void);
/** @brief Get a runtime version string of the library.
This function is thread-safe.
@ingroup API
@returns
Pointer to statically allocated string, that contains version string.
*/
HID_API_EXPORT const char* HID_API_CALL hid_version_str(void);
#ifdef __cplusplus
}
#endif
#endif

View File

@ -0,0 +1,74 @@
/*******************************************************
HIDAPI - Multi-Platform library for
communication with HID devices.
libusb/hidapi Team
Copyright 2022, All Rights Reserved.
At the discretion of the user of this library,
this software may be licensed under the terms of the
GNU General Public License v3, a BSD-Style license, or the
original HIDAPI license as outlined in the LICENSE.txt,
LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt
files located at the root of the source distribution.
These files may also be found in the public source
code repository located at:
https://github.com/libusb/hidapi .
********************************************************/
/** @file
* @defgroup API hidapi API
*
* Since version 0.12.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 12, 0)
*/
#ifndef HIDAPI_WINAPI_H__
#define HIDAPI_WINAPI_H__
#include <stdint.h>
#include <guiddef.h>
#include "hidapi.h"
#ifdef __cplusplus
extern "C" {
#endif
/** @brief Get the container ID for a HID device.
Since version 0.12.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 12, 0)
This function returns the `DEVPKEY_Device_ContainerId` property of
the given device. This can be used to correlate different
interfaces/ports on the same hardware device.
@ingroup API
@param dev A device handle returned from hid_open().
@param guid The device's container ID on return.
@returns
This function returns 0 on success and -1 on error.
*/
int HID_API_EXPORT_CALL hid_winapi_get_container_id(hid_device *dev, GUID *container_id);
/**
* @brief Reconstructs a HID Report Descriptor from a Win32 HIDP_PREPARSED_DATA structure.
* This reconstructed report descriptor is logical identical to the real report descriptor,
* but not byte wise identical.
*
* @param[in] hidp_preparsed_data Pointer to the HIDP_PREPARSED_DATA to read, i.e.: the value of PHIDP_PREPARSED_DATA,
* as returned by HidD_GetPreparsedData WinAPI function.
* @param buf Pointer to the buffer where the report descriptor should be stored.
* @param[in] buf_size Size of the buffer. The recommended size for the buffer is @ref HID_API_MAX_REPORT_DESCRIPTOR_SIZE bytes.
*
* @return Returns size of reconstructed report descriptor if successful, -1 for error.
*/
int HID_API_EXPORT_CALL hid_winapi_descriptor_reconstruct_pp_data(void *hidp_preparsed_data, unsigned char *buf, size_t buf_size);
#ifdef __cplusplus
}
#endif
#endif

Binary file not shown.

29
main.cpp Normal file
View File

@ -0,0 +1,29 @@
#include "qmacrobindswindow.h"
#include <QApplication>
#include <QLocale>
#include <QTranslator>
int main(int argc, char *argv[])
{
QApplication a(argc, argv);
QCoreApplication::setOrganizationName("Batty Bovine Productions, LLC");
QCoreApplication::setOrganizationDomain("battybovine.com");
QCoreApplication::setApplicationName("MacroBinds");
qRegisterMetaType<EncoderRotation>();
QTranslator translator;
const QStringList uiLanguages = QLocale::system().uiLanguages();
for (const QString &locale : uiLanguages) {
const QString baseName = "MacroBinds_" + QLocale(locale).name();
if (translator.load(":/i18n/" + baseName)) {
a.installTranslator(&translator);
break;
}
}
QMacroBindsWindow w;
w.show();
return a.exec();
}

142
qmacrobindswindow.cpp Normal file
View File

@ -0,0 +1,142 @@
#include "qmacrobindswindow.h"
#include "./ui_qmacrobindswindow.h"
#include "QtImprovements/qsettingsplus.h"
#include "Widgets/qdialbutton.h"
#include "Widgets/qmacrobutton.h"
#include "qmacrokeysmanager.h"
#include "windowfinderdialogue.h"
#include <QCryptographicHash>
#include <QDir>
#include <QKeyEvent>
#include <QSettings>
#include <QStandardPaths>
#include <QUrl>
#include <QDebug>
QMacroBindsWindow::QMacroBindsWindow(QWidget *parent)
: QMainWindow(parent)
, ui(new Ui::QMacroBindsWindow)
{
ui->setupUi(this);
this->vButtonWidgets.clear();
for (qint8 row = DEFAULT_ROW_COUNT - 1; row >= 0; row--) {
QVector<QPushButton *> buttonRow;
for (qint8 column = 0; column < DEFAULT_COLUMN_COUNT; column++) {
QMacroButton *button = new QMacroButton(row, column);
QObject::connect(button,
&QRatioButton::pressedRowColumn,
this,
&QMacroBindsWindow::showKeyBindingWindow);
ui->gridButtons->addWidget(button, DEFAULT_ROW_COUNT - 1 - row, column);
buttonRow.append(button);
}
this->vButtonWidgets.insert(0, buttonRow);
}
QVector<QPushButton *> dialRow;
const quint8 dialButtonsCount = 4;
const quint8 dialColumnCount = 2;
const qint8 dialRowCount = ceil(dialButtonsCount / (float)dialColumnCount);
for (qint8 i = 0; i < dialButtonsCount; i++) {
const quint8 dialRowNumber = ((dialRowCount - 1 - (i % dialRowCount)) % dialRowCount) * 2;
const quint8 dialColumnNumber = (dialButtonsCount % 2 == 0) ? (i / dialRowCount) * 2 : i;
QDialButton *button = new QDialButton(this->vButtonWidgets.size(), dialRow.size());
QObject::connect(button,
&QRatioButton::pressedRowColumn,
this,
&QMacroBindsWindow::showKeyBindingWindow);
ui->gridDials->addWidget(button,
dialRowNumber,
dialColumnNumber,
2, 2);
dialRow.push_back(button);
}
this->vButtonWidgets.push_back(dialRow);
this->mkmMacroKeys = new QMacroKeysManager(this);
QObject::connect(this->mkmMacroKeys,
&QMacroKeysManager::newDeviceFound,
this,
&QMacroBindsWindow::addDeviceToList);
QObject::connect(this->mkmMacroKeys, &QMacroKeysManager::newButtonState, this, &QMacroBindsWindow::newButtonState);
QObject::connect(this->mkmMacroKeys, &QMacroKeysManager::newEncoderRotation, this, &QMacroBindsWindow::newEncoderRotation);
this->mkmMacroKeys->initDevices();
}
QMacroBindsWindow::~QMacroBindsWindow()
{
delete ui;
}
void QMacroBindsWindow::addDeviceToList(const QString &devicePath)
{
QSettings deviceNameDatabase = QSettingsPlus::createQSettings(this);
QString deviceName = deviceNameDatabase.value(devicePath).toString();
if (deviceName.isEmpty()) {
const size_t keyCount = deviceNameDatabase.allKeys().size() + 1;
deviceName = QString("Device %1").arg(keyCount);
deviceNameDatabase.setValue(devicePath, deviceName);
}
ui->comboMacroKeysList->addItem(deviceName);
ui->comboMacroKeysList->setEnabled(true);
}
void QMacroBindsWindow::deviceNameChanged(const QString &newName)
{
QSettings deviceNameDatabase = QSettingsPlus::createQSettings(this);
QStringList devicePaths = deviceNameDatabase.allKeys();
const QString &oldName = this->sLastSelectedDevice;
for (const QString &devicePath : devicePaths) {
if (deviceNameDatabase.value(devicePath) == oldName) {
deviceNameDatabase.setValue(devicePath, newName);
break;
}
}
this->sLastSelectedDevice = newName;
}
void QMacroBindsWindow::newButtonState(const quint8 &row, const quint8 &column, const bool &state)
{
const quint8 &availableRows = this->vButtonWidgets.size();
if (row < availableRows) {
if (column < this->vButtonWidgets[row].size()) {
this->vButtonWidgets[row][column]->setCheckable(true);
this->vButtonWidgets[row][column]->setChecked(state);
WindowFinder::sendInputToFrontmostWindow(QKeySequence(tr("Shift+Z")), state ? KeyEventType::PRESS : KeyEventType::RELEASE);
}
}
}
void QMacroBindsWindow::newEncoderRotation(const quint8 &column, const EncoderRotation &direction)
{
const QVector<QPushButton *> &encoderButtons = this->vButtonWidgets.last();
if (column < encoderButtons.size()) {
WindowFinder::sendInputToFrontmostWindow(direction == EncoderRotation::CCW ? QKeySequence(tr("Shift+Y")) : QKeySequence(tr("Shift+X")), KeyEventType::PRESS_AND_RELEASE);
}
}
void QMacroBindsWindow::showKeyBindingWindow(const quint8 &row, const quint8 &column)
{
this->vButtonWidgets[row][column]->setCheckable(false);
qDebug() << row << ":" << column;
}
void QMacroBindsWindow::showWindowFinder()
{
this->diagWindowFinder = new WindowFinderDialogue(this);
this->diagWindowFinder->show();
}

48
qmacrobindswindow.h Normal file
View File

@ -0,0 +1,48 @@
#ifndef QMACROBINDSWINDOW_H
#define QMACROBINDSWINDOW_H
#include <QMainWindow>
#include <qmacrokeysmanager.h>
#define DEFAULT_ROW_COUNT 7
#define DEFAULT_COLUMN_COUNT 4
#define ENCODER_CLICKS_PER_ROTATION 30
QT_BEGIN_NAMESPACE
namespace Ui {
class QMacroBindsWindow;
}
QT_END_NAMESPACE
class QMacroBindsWindow : public QMainWindow
{
Q_OBJECT
public:
QMacroBindsWindow(QWidget *parent = nullptr);
~QMacroBindsWindow();
public slots:
void deviceNameChanged(const QString &newName);
private slots:
void showKeyBindingWindow(const quint8 &row, const quint8 &column);
void showWindowFinder();
private:
void addDeviceToList(const QString &devicePath);
void newButtonState(const quint8 &row, const quint8 &column, const bool &state);
void newEncoderRotation(const quint8 &column, const EncoderRotation &direction);
Ui::QMacroBindsWindow *ui;
class WindowFinderDialogue *diagWindowFinder = nullptr;
class QMacroKeysManager *mkmMacroKeys = nullptr;
QVector<QVector<class QPushButton*>> vButtonWidgets;
QString sLastSelectedDevice = "";
};
#endif // QMACROBINDSWINDOW_H

159
qmacrobindswindow.ui Normal file
View File

@ -0,0 +1,159 @@
<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
<class>QMacroBindsWindow</class>
<widget class="QMainWindow" name="QMacroBindsWindow">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>219</width>
<height>473</height>
</rect>
</property>
<property name="windowTitle">
<string>MacroBinds</string>
</property>
<widget class="QWidget" name="centralwidget">
<layout class="QVBoxLayout" name="verticalLayout" stretch="1,1,0">
<property name="spacing">
<number>2</number>
</property>
<item>
<layout class="QGridLayout" name="gridDials">
<property name="sizeConstraint">
<enum>QLayout::SetMaximumSize</enum>
</property>
<property name="spacing">
<number>2</number>
</property>
</layout>
</item>
<item>
<layout class="QGridLayout" name="gridButtons">
<property name="sizeConstraint">
<enum>QLayout::SetMaximumSize</enum>
</property>
<property name="spacing">
<number>2</number>
</property>
</layout>
</item>
<item>
<layout class="QHBoxLayout" name="horizontalLayout" stretch="1,0">
<item>
<widget class="QComboBox" name="comboMacroKeysList">
<property name="enabled">
<bool>false</bool>
</property>
<property name="sizePolicy">
<sizepolicy hsizetype="Expanding" vsizetype="Fixed">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
<property name="editable">
<bool>true</bool>
</property>
<property name="sizeAdjustPolicy">
<enum>QComboBox::AdjustToMinimumContentsLengthWithIcon</enum>
</property>
</widget>
</item>
<item>
<widget class="QPushButton" name="pushButton_5">
<property name="enabled">
<bool>false</bool>
</property>
<property name="sizePolicy">
<sizepolicy hsizetype="Maximum" vsizetype="Fixed">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
<property name="maximumSize">
<size>
<width>28</width>
<height>16777215</height>
</size>
</property>
<property name="text">
<string>↻</string>
</property>
</widget>
</item>
</layout>
</item>
</layout>
</widget>
<widget class="QMenuBar" name="menubar">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>219</width>
<height>22</height>
</rect>
</property>
<widget class="QMenu" name="menuFile">
<property name="title">
<string>File</string>
</property>
<addaction name="actionAddApplication"/>
<addaction name="separator"/>
<addaction name="actionExit"/>
</widget>
<addaction name="menuFile"/>
</widget>
<action name="actionExit">
<property name="text">
<string>Exit</string>
</property>
</action>
<action name="actionAddApplication">
<property name="text">
<string>Add Application</string>
</property>
</action>
</widget>
<resources/>
<connections>
<connection>
<sender>comboMacroKeysList</sender>
<signal>currentTextChanged(QString)</signal>
<receiver>QMacroBindsWindow</receiver>
<slot>deviceNameChanged(QString)</slot>
<hints>
<hint type="sourcelabel">
<x>107</x>
<y>377</y>
</hint>
<hint type="destinationlabel">
<x>148</x>
<y>199</y>
</hint>
</hints>
</connection>
<connection>
<sender>actionAddApplication</sender>
<signal>triggered()</signal>
<receiver>QMacroBindsWindow</receiver>
<slot>showWindowFinder()</slot>
<hints>
<hint type="sourcelabel">
<x>-1</x>
<y>-1</y>
</hint>
<hint type="destinationlabel">
<x>89</x>
<y>193</y>
</hint>
</hints>
</connection>
</connections>
<slots>
<slot>dialPressed()</slot>
<slot>buttonPressed()</slot>
<slot>deviceNameChanged(QString)</slot>
<slot>showWindowFinder()</slot>
</slots>
</ui>

151
qmacrokeysmanager.cpp Normal file
View File

@ -0,0 +1,151 @@
#include "qmacrokeysmanager.h"
#include <codecvt>
#include <locale>
QMacroKeysManager::QMacroKeysManager(QObject *parent)
: QObject{parent}
{}
void QMacroKeysManager::initDevices()
{
hid_device_info *deviceInfo = hid_enumerate(MACROKEYS_VID, MACROKEYS_PID);
if (!deviceInfo) {
return;
}
for (hid_device_info *di = deviceInfo; di != nullptr; di = di->next) {
QDeviceHandler *deviceHandler = new QDeviceHandler();
this->mDevices[di->path] = deviceHandler;
QObject::connect(deviceHandler,
&QDeviceHandler::deviceInitialised,
this,
&QMacroKeysManager::getDeviceInitStatus);
deviceHandler->initDevice(di);
}
}
void QMacroKeysManager::getDeviceInitStatus(const HIDDevice &device)
{
QDeviceHandler *dh = this->mDevices[device.sPath];
QObject::connect(dh,
&QDeviceHandler::buttonStateChanged,
this,
&QMacroKeysManager::handleNewButtonState);
QObject::connect(dh,
&QDeviceHandler::encoderRotationChanged,
this,
&QMacroKeysManager::handleNewEncoderRotation);
emit this->newDeviceFound(device.sPath);
dh->runDevice();
}
void QMacroKeysManager::handleNewButtonState(const quint8 &row,
const quint8 &column,
const bool &state)
{
emit this->newButtonState(row, column, state);
}
void QMacroKeysManager::handleNewEncoderRotation(const quint8 &column,
const EncoderRotation &direction)
{
emit this->newEncoderRotation(column, direction);
}
void QMacroKeysManager::uninitDevices() {}
QDeviceHandler::QDeviceHandler(QObject *parent)
: QObject{parent}
{
this->moveToThread(&this->threadButtonReader);
this->threadButtonReader.start();
}
QDeviceHandler::~QDeviceHandler()
{
hid_close(this->hidDevice.hidDevice);
this->threadButtonReader.quit();
this->threadButtonReader.wait();
}
void QDeviceHandler::initDevice(const hid_device_info *di)
{
hid_device_info *deviceInfo = hid_enumerate(MACROKEYS_VID, MACROKEYS_PID);
if (!deviceInfo) {
return;
}
HIDDevice device;
device.hidInfo = di;
std::wstring_convert<std::codecvt_utf8<wchar_t>> utf8_conv;
device.sManufacturer = utf8_conv.to_bytes(di->manufacturer_string).c_str();
device.sProduct = utf8_conv.to_bytes(di->product_string).c_str();
device.sPath = di->path;
hid_device *handle = hid_open(MACROKEYS_VID, MACROKEYS_PID, deviceInfo->serial_number);
device.hidDevice = handle;
hid_set_nonblocking(device.hidDevice, 0);
ButtonStateRow buttonStatesRow;
buttonStatesRow.fill(false, NUM_BUTTON_COLUMNS);
QVector<ButtonStateRow> buttonStates;
buttonStates.fill(buttonStatesRow, NUM_BUTTON_ROWS);
this->vCurrentButtonStates = buttonStates;
this->hidDevice = device;
emit this->deviceInitialised(this->hidDevice);
}
void QDeviceHandler::runDevice()
{
QMetaObject::invokeMethod(this, "buttonReadLoop");
}
void QDeviceHandler::buttonReadLoop()
{
while (this->threadButtonReader.isRunning()) {
const ButtonStateVector &previousState = ButtonStateVector(this->vCurrentButtonStates);
unsigned char buffer[NUM_HID_BYTES];
hid_read(this->hidDevice.hidDevice, buffer, NUM_HID_BYTES);
for (int column = 0; column < NUM_BUTTON_COLUMNS; column++) {
for (int row = 0; row < NUM_BUTTON_ROWS; row++) {
// Convert bit position in each byte into a row/column value.
// Bits are read from left to right, as though they were one
// little endian value, but with bit order reversed as well.
// Each successive byte counts down the row number, and then
// rolls over to the next column for each row.
//
// Examples:
// - Bit 7 in byte 0 (1000 0000 | 0000 0000) is row 0, column 0
// - Bit 6 in byte 0 (0100 0000 | 0000 0000) is row 1, column 0
// - Bit 2 in byte 1 (0000 0000 | 0100 0000) is row 2, column 1
// - Bit 0 in byte 1 (0000 0000 | 0000 0001) is row 8, column 1
const quint8 buttonBit = (column * NUM_BUTTON_ROWS) + row;
const quint8 byte = buttonBit / 8;
const quint8 byteBit = buttonBit % 8;
const bool buttonState = (buffer[byte] >> (8 - (byteBit + 1))) & 0b00000001;
this->vCurrentButtonStates[row][column] = buttonState;
if (previousState[row][column] != buttonState) {
emit this->buttonStateChanged(row, column, buttonState);
}
}
}
const char &encoderDirectionBytes = buffer[NUM_HID_BYTES - 1];
if (encoderDirectionBytes & ENC1_CCW) emit encoderRotationChanged(0, EncoderRotation::CCW);
if (encoderDirectionBytes & ENC1_CW) emit encoderRotationChanged(0, EncoderRotation::CW);
if (encoderDirectionBytes & ENC2_CCW) emit encoderRotationChanged(1, EncoderRotation::CCW);
if (encoderDirectionBytes & ENC2_CW) emit encoderRotationChanged(1, EncoderRotation::CW);
if (encoderDirectionBytes & ENC3_CCW) emit encoderRotationChanged(2, EncoderRotation::CCW);
if (encoderDirectionBytes & ENC3_CW) emit encoderRotationChanged(2, EncoderRotation::CW);
if (encoderDirectionBytes & ENC4_CCW) emit encoderRotationChanged(3, EncoderRotation::CCW);
if (encoderDirectionBytes & ENC4_CW) emit encoderRotationChanged(3, EncoderRotation::CW);
}
}

97
qmacrokeysmanager.h Normal file
View File

@ -0,0 +1,97 @@
#ifndef QMACROKEYSMANAGER_H
#define QMACROKEYSMANAGER_H
#include <QObject>
#include <QMap>
#include <QThread>
#include <QTimer>
#include "hidapi.h"
#define MACROKEYS_VID 0x2341
#define MACROKEYS_PID 0x8036
#define NUM_HID_BYTES 5
#define NUM_BUTTON_ROWS 8
#define NUM_BUTTON_COLUMNS 4
#define ENC1_CCW 0b10000000
#define ENC1_CW 0b01000000
#define ENC2_CCW 0b00100000
#define ENC2_CW 0b00010000
#define ENC3_CCW 0b00001000
#define ENC3_CW 0b00000100
#define ENC4_CCW 0b00000010
#define ENC4_CW 0b00000001
enum class EncoderRotation : qint8 {
CCW = -1,
INVALID,
CW
};
Q_DECLARE_METATYPE(EncoderRotation)
struct HIDDevice
{
hid_device *hidDevice = nullptr;
QString sManufacturer;
QString sProduct;
QString sSerialNumber;
QString sPath;
const hid_device_info *hidInfo;
};
typedef QVector<bool> ButtonStateRow;
typedef QVector<ButtonStateRow> ButtonStateVector;
class QMacroKeysManager : public QObject
{
Q_OBJECT
public:
explicit QMacroKeysManager(QObject *parent = nullptr);
void initDevices();
void uninitDevices();
signals:
void newDeviceFound(const QString &devicePath);
void newButtonState(const quint8 &row, const quint8 &column, const bool &state);
void newEncoderRotation(const quint8 &column, const EncoderRotation &direction);
private slots:
void getDeviceInitStatus(const HIDDevice &device);
void handleNewButtonState(const quint8 &row, const quint8 &column, const bool &state);
void handleNewEncoderRotation(const quint8 &column, const EncoderRotation &direction);
private:
QMap<QString, class QDeviceHandler*> mDevices;
};
class QDeviceHandler : public QObject
{
Q_OBJECT
public:
explicit QDeviceHandler(QObject *parent = nullptr);
~QDeviceHandler();
void initDevice(const hid_device_info *di);
void runDevice();
public slots:
void buttonReadLoop();
signals:
void deviceInitialised(const HIDDevice &device);
void buttonStateChanged(const quint8 &row, const quint8 &column, const bool &state);
void encoderRotationChanged(const quint8 &column, const EncoderRotation &direction = EncoderRotation::INVALID);
private:
QThread threadButtonReader;
HIDDevice hidDevice;
ButtonStateVector vCurrentButtonStates;
};
#endif // QMACROKEYSMANAGER_H

172
windowfinderdialogue.cpp Normal file
View File

@ -0,0 +1,172 @@
#include "windowfinderdialogue.h"
#include "ui_windowfinderdialogue.h"
#include "Widgets/applicationinfowidget.h"
#include "QtImprovements/qsettingsplus.h"
#include "Widgets/qprocesslistitem.h"
#include <QAbstractButton>
#include <QMenu>
#include <QMessageBox>
#include <QTimer>
#include <QDebug>
WindowFinderDialogue::WindowFinderDialogue(QWidget *parent)
: QMainWindow(parent)
, ui(new Ui::WindowFinderDialogue)
{
ui->setupUi(this);
ui->labelInstructions->setHidden(false);
this->widgetApplicationInfo = new ApplicationInfoWidget(this);
ui->layoutApplicationEditor->addWidget(this->widgetApplicationInfo);
this->widgetApplicationInfo->setHidden(true);
ui->listApplications->setSelectionMode(QAbstractItemView::SelectionMode::SingleSelection);
ui->listApplications->setContextMenuPolicy(Qt::ContextMenuPolicy::CustomContextMenu);
QObject::connect(ui->listApplications, &QListWidget::customContextMenuRequested, this, &WindowFinderDialogue::showListContextMenu);
QObject::connect(ui->listApplications,
&QListWidget::itemSelectionChanged,
this,
&WindowFinderDialogue::loadNewApplicationData);
QObject::connect(ui->listApplications,
&QListWidget::currentTextChanged,
this,
&WindowFinderDialogue::updateListItem);
QSettings settings = QSettingsPlus::createQSettings(this);
settings.beginGroup("ApplicationNames");
QStringList applicationKeys = settings.childKeys();
for (const QString &applicationName : applicationKeys) {
WindowData data;
data.importDataFromSetting(settings.value(applicationName).toString());
QProcessListItem *pli = new QProcessListItem(data, ui->listApplications);
pli->setFlags(pli->flags());
ui->listApplications->addItem(pli);
}
QListWidgetItem();
}
WindowFinderDialogue::~WindowFinderDialogue()
{
delete ui;
}
void WindowFinderDialogue::changeEvent(QEvent *event)
{
if (event->type() == QEvent::ActivationChange) {
if (!this->isActiveWindow()) {
this->timerWindowFinder = new QTimer();
QObject::connect(this->timerWindowFinder,
&QTimer::timeout,
this,
&WindowFinderDialogue::windowFound);
this->timerWindowFinder->setSingleShot(true);
this->timerWindowFinder->start(250);
}
}
QWidget::changeEvent(event);
}
void WindowFinderDialogue::windowFound()
{
this->capturedWindow = WindowFinder::getFrontmostWindowProcess();
QSettings settings = QSettingsPlus::createQSettings(this);
settings.beginGroup("ApplicationNames");
if (settings.contains(this->capturedWindow.processName)) {
return;
}
ui->labelInstructions->setHidden(true);
this->widgetApplicationInfo->setHidden(false);
this->widgetApplicationInfo->setTextData(this->capturedWindow.processName,
this->capturedWindow.processName,
this->capturedWindow.processPath,
this->capturedWindow.processWindowTitle);
settings.setValue(this->capturedWindow.processName,
QString("%1%2%3%4%5").arg(this->capturedWindow.processName,
QSettingsPlus::keyDataSeparator(),
this->capturedWindow.processPath,
QSettingsPlus::keyDataSeparator(),
this->capturedWindow.processWindowTitle));
QProcessListItem *pli = new QProcessListItem(this->capturedWindow, ui->listApplications);
pli->setFlags(pli->flags());
ui->listApplications->addItem(pli);
pli->setSelected(true);
}
void WindowFinderDialogue::showListContextMenu(const QPoint &pos)
{
if (ui->listApplications->selectedItems().size() > 0) {
QPoint globalPos = ui->listApplications->mapToGlobal(pos);
QMenu myMenu;
myMenu.addAction("Delete selected", this, &WindowFinderDialogue::eraseListItem);
myMenu.exec(globalPos);
}
}
void WindowFinderDialogue::updateListItem(const QString &text)
{
QList<QListWidgetItem *> items = ui->listApplications->selectedItems();
if (items.size() == 1) {
QProcessListItem *pli = (QProcessListItem *) items.first();
pli->updateText(text);
}
}
void WindowFinderDialogue::eraseListItem()
{
QSettings settings = QSettingsPlus::createQSettings(this);
settings.beginGroup("ApplicationNames");
QList<QListWidgetItem *> items = ui->listApplications->selectedItems();
for (QListWidgetItem *item : items) {
settings.remove(item->text());
ui->listApplications->removeItemWidget(item);
delete item;
}
}
void WindowFinderDialogue::loadNewApplicationData()
{
QList<QListWidgetItem *> items = ui->listApplications->selectedItems();
switch (items.size()) {
case 0: {
this->setWidgetState(WindowPanelState::INSTRUCTIONS);
} break;
case 1: {
QProcessListItem *pli = (QProcessListItem *) items.first();
const WindowData &windowData = pli->getWindowData();
this->widgetApplicationInfo->setTextData(pli->text(),
windowData.processName,
windowData.processPath,
windowData.processWindowTitle);
this->setWidgetState(WindowPanelState::EDITOR);
} break;
}
}
void WindowFinderDialogue::setWidgetState(const WindowPanelState &newState)
{
switch (newState) {
case WindowPanelState::INSTRUCTIONS:
ui->labelInstructions->setHidden(false);
this->widgetApplicationInfo->setHidden(true);
break;
case WindowPanelState::EDITOR:
ui->labelInstructions->setHidden(true);
this->widgetApplicationInfo->setHidden(false);
break;
}
}

52
windowfinderdialogue.h Normal file
View File

@ -0,0 +1,52 @@
#ifndef WINDOWFINDERDIALOGUE_H
#define WINDOWFINDERDIALOGUE_H
#include <QMainWindow>
#include "Widgets/applicationinfowidget.h"
#include "WindowFinder/windowfinder.h"
enum class WindowPanelState : quint8 {
INSTRUCTIONS,
EDITOR
};
namespace Ui {
class WindowFinderDialogue;
}
class WindowFinderDialogue : public QMainWindow
{
Q_OBJECT
public:
explicit WindowFinderDialogue(QWidget *parent = nullptr);
~WindowFinderDialogue();
private slots:
void windowFound();
void showListContextMenu(const QPoint &pos);
void loadNewApplicationData();
void updateListItem(const QString &text);
void eraseListItem();
protected:
virtual void changeEvent(QEvent *event) override;
private:
void setWidgetState(const WindowPanelState &newState);
Ui::WindowFinderDialogue *ui;
ApplicationInfoWidget *widgetApplicationInfo = nullptr;
bool bFindingWindow = false;
class QTimer *timerWindowFinder = nullptr;
WindowData capturedWindow;
};
#endif // WINDOWFINDERDIALOGUE_H

88
windowfinderdialogue.ui Normal file
View File

@ -0,0 +1,88 @@
<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
<class>WindowFinderDialogue</class>
<widget class="QMainWindow" name="WindowFinderDialogue">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>380</width>
<height>266</height>
</rect>
</property>
<widget class="QWidget" name="centralwidget">
<layout class="QVBoxLayout" name="verticalLayout_2" stretch="1,0">
<item>
<widget class="QSplitter" name="splitter">
<property name="orientation">
<enum>Qt::Horizontal</enum>
</property>
<widget class="QListWidget" name="listApplications">
<property name="sizePolicy">
<sizepolicy hsizetype="Maximum" vsizetype="Expanding">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
</widget>
<widget class="QWidget" name="layoutWidget">
<layout class="QVBoxLayout" name="layoutApplicationEditor" stretch="0">
<item>
<widget class="QLabel" name="labelInstructions">
<property name="text">
<string>Click on the window you want to capture.</string>
</property>
<property name="alignment">
<set>Qt::AlignCenter</set>
</property>
</widget>
</item>
</layout>
</widget>
</widget>
</item>
<item>
<layout class="QHBoxLayout" name="horizontalLayout_2">
<item>
<spacer name="horizontalSpacer_3">
<property name="orientation">
<enum>Qt::Horizontal</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
<width>40</width>
<height>20</height>
</size>
</property>
</spacer>
</item>
<item>
<widget class="QPushButton" name="buttonCancel">
<property name="text">
<string>Cancel</string>
</property>
</widget>
</item>
<item>
<widget class="QPushButton" name="buttonAccept">
<property name="enabled">
<bool>false</bool>
</property>
<property name="text">
<string>Accept</string>
</property>
</widget>
</item>
</layout>
</item>
</layout>
</widget>
</widget>
<resources/>
<connections/>
<slots>
<slot>startFindingWindow()</slot>
<slot>acceptWindowCapture()</slot>
<slot>cancelWindowCapture()</slot>
</slots>
</ui>