From c8d96289641f106a1ae8d8395c845a86324ed0c9 Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Sat, 23 Sep 2023 22:55:58 +0100 Subject: [PATCH] first commit --- .gitattributes | 8 + .github/workflows/build_addon.yml | 64 ++++ .gitignore | 14 + .pre-commit-config.yaml | 7 + .vscode/settings.json | 8 + LICENSE | 339 ++++++++++++++++++ README.md | 3 + addon/globalPlugins/voicemeeter/__init__.py | 70 ++++ addon/globalPlugins/voicemeeter/binds.py | 51 +++ addon/globalPlugins/voicemeeter/commands.py | 65 ++++ addon/globalPlugins/voicemeeter/context.py | 66 ++++ addon/globalPlugins/voicemeeter/controller.py | 47 +++ addon/globalPlugins/voicemeeter/error.py | 2 + addon/globalPlugins/voicemeeter/kinds.py | 99 +++++ build.ps1 | 25 ++ buildVars.py | 83 +++++ manifest-translated.ini.tpl | 2 + manifest.ini.tpl | 10 + sconstruct | 332 +++++++++++++++++ site_scons/site_tools/gettexttool/__init__.py | 55 +++ 20 files changed, 1350 insertions(+) create mode 100644 .gitattributes create mode 100644 .github/workflows/build_addon.yml create mode 100644 .gitignore create mode 100644 .pre-commit-config.yaml create mode 100644 .vscode/settings.json create mode 100644 LICENSE create mode 100644 README.md create mode 100644 addon/globalPlugins/voicemeeter/__init__.py create mode 100644 addon/globalPlugins/voicemeeter/binds.py create mode 100644 addon/globalPlugins/voicemeeter/commands.py create mode 100644 addon/globalPlugins/voicemeeter/context.py create mode 100644 addon/globalPlugins/voicemeeter/controller.py create mode 100644 addon/globalPlugins/voicemeeter/error.py create mode 100644 addon/globalPlugins/voicemeeter/kinds.py create mode 100644 build.ps1 create mode 100644 buildVars.py create mode 100644 manifest-translated.ini.tpl create mode 100644 manifest.ini.tpl create mode 100644 sconstruct create mode 100644 site_scons/site_tools/gettexttool/__init__.py diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..a1a1316 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,8 @@ +# Set default behaviour, in case users don't have core.autocrlf set. +* text=auto + +# Try to ensure that po files in the repo does not include +# source code line numbers. +# Every person expected to commit po files should change their personal config file as described here: +# https://mail.gnome.org/archives/kupfer-list/2010-June/msg00002.html +*.po filter=cleanpo diff --git a/.github/workflows/build_addon.yml b/.github/workflows/build_addon.yml new file mode 100644 index 0000000..9b97cd9 --- /dev/null +++ b/.github/workflows/build_addon.yml @@ -0,0 +1,64 @@ +name: build addon + +on: + push: + tags: ["*"] + # To build on main/master branch, uncomment the following line: + # branches: [ main , master ] + + pull_request: + branches: [ main, master ] + + workflow_dispatch: + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - run: echo -e "pre-commit\nscons\nmarkdown">requirements.txt + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: 3.9 + cache: 'pip' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip wheel + pip install -r requirements.txt + sudo apt-get update -y + sudo apt-get install -y gettext + + - name: Code checks + run: export SKIP=no-commit-to-branch; pre-commit run --all + + - name: building addon + run: scons + + - uses: actions/upload-artifact@v3 + with: + name: packaged_addon + path: ./*.nvda-addon + + upload_release: + runs-on: ubuntu-latest + if: ${{ startsWith(github.ref, 'refs/tags/') }} + needs: ["build"] + steps: + - uses: actions/checkout@v3 + - name: download releases files + uses: actions/download-artifact@v3 + - name: Display structure of downloaded files + run: ls -R + + - name: Release + uses: softprops/action-gh-release@v1 + with: + files: packaged_addon/*.nvda-addon + fail_on_unmatched_files: true + prerelease: ${{ contains(github.ref, '-') }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..dfe8127 --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +addon/doc/*.css +addon/doc/en/ +*_docHandler.py +*.html +manifest.ini +*.mo +*.pot +*.py[co] +*.nvda-addon +.sconsign.dblite +/[0-9]*.[0-9]*.[0-9]*.json + +.venv/ +keybinds.json \ No newline at end of file diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..dd7a9d6 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,7 @@ +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.3.0 + hooks: + - id: check-ast + - id: check-case-conflict + - id: check-yaml diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..4aa92b0 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "python.analysis.diagnosticSeverityOverrides": { + "reportMissingImports": "none" + }, + "black-formatter.args": [ + "--line-length=120" + ] +} \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) 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 +this service 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 make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. 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. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE 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. + + 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 +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 2 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, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision 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, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..78278ad --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# NVDA Addon Voicemeeter + +Control Voicemeeter GUI with customisable hotkeys. diff --git a/addon/globalPlugins/voicemeeter/__init__.py b/addon/globalPlugins/voicemeeter/__init__.py new file mode 100644 index 0000000..9a338c1 --- /dev/null +++ b/addon/globalPlugins/voicemeeter/__init__.py @@ -0,0 +1,70 @@ +import json +import time +from pathlib import Path + +import globalPluginHandler +from logHandler import log + +from .commands import CommandsMixin +from .controller import Controller +from .kinds import KindId, request_kind_map + + +def _make_gestures(): + defaults = { + "kb:NVDA+alt+s": "strip_mode", + "kb:NVDA+alt+b": "bus_mode", + "kb:NVDA+shift+q": "announce_controller", + "kb:NVDA+shift+a": "announce_voicemeeter_version", + "kb:NVDA+shift+o": "toggle_mono", + "kb:NVDA+shift+s": "toggle_solo", + "kb:NVDA+shift+m": "toggle_mute", + "kb:NVDA+shift+upArrow": "increase_gain", + "kb:NVDA+shift+downArrow": "decrease_gain", + "kb:NVDA+shift+alt+upArrow": "increase_gain", + "kb:NVDA+shift+alt+downArrow": "decrease_gain", + "kb:NVDA+shift+control+upArrow": "increase_gain", + "kb:NVDA+shift+control+downArrow": "decrease_gain", + } + + overrides = None + pn = Path.home() / "Documents" / "Voicemeeter" / "keybinds.json" + if pn.exists(): + with open(pn, "r") as f: + data = json.load(f) + overrides = {f"kb:{v}": k for k, v in data.items()} + log.info("INFO - loading settings from keybinds.json") + if overrides: + return {**defaults, **overrides} + return defaults + + +def _get_kind_id(): + pn = Path.home() / "Documents" / "Voicemeeter" / "settings.json" + if pn.exists(): + with open(pn, "r") as f: + data = json.load(f) + return data["voicemeeter"] + return "potato" + + +class GlobalPlugin(globalPluginHandler.GlobalPlugin, CommandsMixin): + __gestures = _make_gestures() + __kind_id = _get_kind_id() + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.controller = Controller() + if self.controller.login() == 1: + self.controller.run_voicemeeter(KindId[self.__kind_id.upper()]) + time.sleep(1) + self.kind = request_kind_map(self.controller.kind_id) + + for i in range(1, self.kind.num_strip + 1): + self.bindGesture(f"kb:NVDA+alt+{i}", "index") + for i in range(1, self.kind.phys_out + self.kind.virt_out + 1): + self.bindGesture(f"kb:NVDA+shift+{i}", "bus_assignment") + + def terminate(self, *args, **kwargs): + super().terminate(*args, **kwargs) + self.controller.logout() diff --git a/addon/globalPlugins/voicemeeter/binds.py b/addon/globalPlugins/voicemeeter/binds.py new file mode 100644 index 0000000..27e01f1 --- /dev/null +++ b/addon/globalPlugins/voicemeeter/binds.py @@ -0,0 +1,51 @@ +import ctypes as ct +import winreg +from pathlib import Path + +from .error import VMError + + +class Binds: + VM_KEY = "VB:Voicemeeter {17359A74-1236-5467}" + BITS = 64 if ct.sizeof(ct.c_voidp) == 8 else 32 + + def __init__(self): + dll_path = Path(self.__vmpath()).parent.joinpath( + f'VoicemeeterRemote{"64" if self.BITS == 64 else ""}.dll' + ) + if self.BITS == 64: + self.libc = ct.CDLL(str(dll_path)) + else: + self.libc = ct.WinDLL(str(dll_path)) + + def __vmpath(self): + with winreg.OpenKey( + winreg.HKEY_LOCAL_MACHINE, + r"{}".format( + "\\".join( + ( + "\\".join( + filter( + None, + ( + "SOFTWARE", + "WOW6432Node" if self.BITS == 64 else "", + "Microsoft", + "Windows", + "CurrentVersion", + "Uninstall", + ), + ) + ), + self.VM_KEY, + ) + ) + ), + ) as vm_key: + return winreg.QueryValueEx(vm_key, r"UninstallString")[0] + + def call(self, fn, *args, ok=(0,)): + retval = getattr(self.libc, fn)(*args) + if retval not in ok: + raise VMError(f"{fn} returned {retval}") + return retval diff --git a/addon/globalPlugins/voicemeeter/commands.py b/addon/globalPlugins/voicemeeter/commands.py new file mode 100644 index 0000000..55b9f1f --- /dev/null +++ b/addon/globalPlugins/voicemeeter/commands.py @@ -0,0 +1,65 @@ +import ui +from logHandler import log + +from . import context + + +class CommandsMixin: + ### ANNOUNCEMENTS ### + + def script_announce_voicemeeter_version(self, _): + ui.message(f"Running Voicemeeter {self.kind}") + + def script_announce_controller(self, _): + ui.message(f"Controller for {self.controller.ctx.strategy} {self.controller.ctx.index + 1}") + + ### ALTER THE CONTEXT ### + + def script_strip_mode(self, _): + if self.controller.ctx.index >= self.kind.num_strip: + ui.message(f"Controller strip {self.controller.ctx.index + 1} does not exist for Voicemeeter {self.kind}") + return + self.controller.ctx.strategy = context.StripStrategy(self.controller, self.controller.ctx.index) + ui.message(f"Controller for strip {self.controller.ctx.index + 1}") + log.info(f"INFO - strip {self.controller.ctx.index} mode") + + def script_bus_mode(self, _): + if self.controller.ctx.index >= self.kind.num_bus: + ui.message(f"Controller bus {self.controller.ctx.index + 1} does not exist for Voicemeeter {self.kind}") + return + self.controller.ctx.strategy = context.BusStrategy(self.controller, self.controller.ctx.index) + ui.message(f"Controller for {self.controller.ctx.strategy} {self.controller.ctx.index + 1}") + log.info(f"INFO - {self.controller.ctx.strategy} {self.controller.ctx.index} mode") + + def script_index(self, gesture): + proposed = int(gesture.displayName[-1]) + self.controller.ctx.index = proposed - 1 + ui.message(f"Controller for {self.controller.ctx.strategy} {self.controller.ctx.index + 1}") + log.info(f"INFO - {self.controller.ctx.strategy} {self.controller.ctx.index} mode") + + ### BOOLEAN PARMETERS ### + + def script_toggle_mono(self, _): + val = not self.controller.ctx.get_bool("mono") + self.controller.ctx.set_bool("mono", val) + ui.message("on" if val else "off") + + def script_toggle_solo(self, _): + val = not self.controller.ctx.get_bool("solo") + self.controller.ctx.set_bool("solo", val) + ui.message("on" if val else "off") + + def script_toggle_mute(self, _): + val = not self.controller.ctx.get_bool("mute") + self.controller.ctx.set_bool("mute", val) + ui.message("on" if val else "off") + + def script_bus_assignment(self, gesture): + proposed = int(gesture.displayName[-1]) + if proposed - 1 < self.kind.phys_out: + output = f"A{proposed}" + else: + output = f"B{proposed - self.kind.phys_out}" + val = not self.controller.ctx.get_bool(output) + self.controller.ctx.set_bool(output, val) + ui.message("on" if val else "off") diff --git a/addon/globalPlugins/voicemeeter/context.py b/addon/globalPlugins/voicemeeter/context.py new file mode 100644 index 0000000..ac4fed1 --- /dev/null +++ b/addon/globalPlugins/voicemeeter/context.py @@ -0,0 +1,66 @@ +from abc import ABC, abstractmethod + + +class Strategy(ABC): + def __init__(self, controller, index): + self._controller = controller + self._index = index + + @property + def index(self): + return self._index + + @index.setter + def index(self, val): + self._index = val + + def get_bool(self, param: str) -> bool: + return self._controller._get(f"{self.identifier}.{param}") == 1 + + def set_bool(self, param: str, val: bool): + self._controller._set(f"{self.identifier}.{param}", 1 if val else 0) + + +class StripStrategy(Strategy): + def __str__(self): + return "Strip" + + @property + def identifier(self): + return f"strip[{self._index}]" + + +class BusStrategy(Strategy): + def __str__(self): + return "Bus" + + @property + def identifier(self): + return f"bus[{self._index}]" + + +class Context: + def __init__(self, strategy: Strategy) -> None: + self._strategy = strategy + + @property + def strategy(self) -> Strategy: + return self._strategy + + @strategy.setter + def strategy(self, strategy: Strategy) -> None: + self._strategy = strategy + + @property + def index(self): + return self._strategy._index + + @index.setter + def index(self, val): + self._strategy._index = val + + def get_bool(self, *args): + return self._strategy.get_bool(*args) + + def set_bool(self, *args): + self._strategy.set_bool(*args) diff --git a/addon/globalPlugins/voicemeeter/controller.py b/addon/globalPlugins/voicemeeter/controller.py new file mode 100644 index 0000000..41c3f6e --- /dev/null +++ b/addon/globalPlugins/voicemeeter/controller.py @@ -0,0 +1,47 @@ +import ctypes as ct + +from logHandler import log + +from .binds import Binds +from .context import Context, StripStrategy +from .kinds import KindId + + +class Controller: + def __init__(self): + self.binds = Binds() + self.ctx = Context(StripStrategy(self, 0)) + + def login(self): + retval = self.binds.call("VBVMR_Login", ok=(0, 1)) + log.info("INFO - logged into Voicemeeter Remote API") + return retval + + def logout(self): + self.binds.call("VBVMR_Logout") + log.info("NFO - logged out of Voicemeeter Remote API") + + @property + def kind_id(self): + c_type = ct.c_long() + self.binds.call("VBVMR_GetVoicemeeterType", ct.byref(c_type)) + return KindId(c_type.value).name.lower() + + def run_voicemeeter(self, kind_id): + val = kind_id.value + if val == 3 and Binds.BITS == 64: + val = 6 + self.binds.call("VBVMR_RunVoicemeeter", val) + + def __clear(self): + while self.binds.call("VBVMR_IsParametersDirty", ok=(0, 1)) == 1: + pass + + def _get(self, param): + self.__clear() + buf = ct.c_float() + self.binds.call("VBVMR_GetParameterFloat", param.encode(), ct.byref(buf)) + return buf.value + + def _set(self, param, val): + self.binds.call("VBVMR_SetParameterFloat", param.encode(), ct.c_float(float(val))) diff --git a/addon/globalPlugins/voicemeeter/error.py b/addon/globalPlugins/voicemeeter/error.py new file mode 100644 index 0000000..a979c40 --- /dev/null +++ b/addon/globalPlugins/voicemeeter/error.py @@ -0,0 +1,2 @@ +class VMError(Exception): + """Base VMError class""" diff --git a/addon/globalPlugins/voicemeeter/kinds.py b/addon/globalPlugins/voicemeeter/kinds.py new file mode 100644 index 0000000..5159b8c --- /dev/null +++ b/addon/globalPlugins/voicemeeter/kinds.py @@ -0,0 +1,99 @@ +from dataclasses import dataclass +from enum import Enum, unique + +from .error import VMError + + +@unique +class KindId(Enum): + BASIC = 1 + BANANA = 2 + POTATO = 3 + + +@dataclass +class KindMapClass: + name: str + ins: tuple + outs: tuple + vban: tuple + asio: tuple + insert: int + + @property + def phys_in(self) -> int: + return self.ins[0] + + @property + def virt_in(self) -> int: + return self.ins[-1] + + @property + def phys_out(self) -> int: + return self.outs[0] + + @property + def virt_out(self) -> int: + return self.outs[-1] + + @property + def num_strip(self) -> int: + return sum(self.ins) + + @property + def num_bus(self) -> int: + return sum(self.outs) + + def __str__(self) -> str: + return self.name.capitalize() + + +@dataclass +class BasicMap(KindMapClass): + name: str + ins: tuple = (2, 1) + outs: tuple = (1, 1) + vban: tuple = (4, 4, 1, 1) + asio: tuple = (0, 0) + insert: int = 0 + + +@dataclass +class BananaMap(KindMapClass): + name: str + ins: tuple = (3, 2) + outs: tuple = (3, 2) + vban: tuple = (8, 8, 1, 1) + asio: tuple = (6, 8) + insert: int = 22 + + +@dataclass +class PotatoMap(KindMapClass): + name: str + ins: tuple = (5, 3) + outs: tuple = (5, 3) + vban: tuple = (8, 8, 1, 1) + asio: tuple = (10, 8) + insert: int = 34 + + +def kind_factory(kind_id): + if kind_id == "basic": + _kind_map = BasicMap + elif kind_id == "banana": + _kind_map = BananaMap + elif kind_id == "potato": + _kind_map = PotatoMap + else: + raise ValueError(f"Unknown Voicemeeter kind {kind_id}") + return _kind_map(name=kind_id) + + +def request_kind_map(kind_id): + KIND_obj = None + try: + KIND_obj = kind_factory(kind_id) + except ValueError as e: + raise VMError(str(e)) from e + return KIND_obj diff --git a/build.ps1 b/build.ps1 new file mode 100644 index 0000000..eaf20aa --- /dev/null +++ b/build.ps1 @@ -0,0 +1,25 @@ +param( + [switch]$build +) + +function Copy-FilestoScratchpad { + $source = Join-Path $PSScriptRoot "addon" "globalPlugins" "voicemeeter" + $target = Join-Path $env:appdata "nvda" "scratchpad" "globalPlugins" + Copy-Item -Path $source -Destination $target -Recurse -Force +} + +function main { + "Copying files to Scratchpad" | Write-Host + Copy-FilestoScratchpad + + if ($build) { + Invoke-Expression ".venv/Scripts/Activate.ps1" + + "Building add-on" | Write-Host + scons + + deactivate + } +} + +if ($MyInvocation.InvocationName -ne '.') { main } \ No newline at end of file diff --git a/buildVars.py b/buildVars.py new file mode 100644 index 0000000..1a1ea45 --- /dev/null +++ b/buildVars.py @@ -0,0 +1,83 @@ +# -*- coding: UTF-8 -*- + +# Build customizations +# Change this file instead of sconstruct or manifest files, whenever possible. + + +# Since some strings in `addon_info` are translatable, +# we need to include them in the .po files. +# Gettext recognizes only strings given as parameters to the `_` function. +# To avoid initializing translations in this module we simply roll our own "fake" `_` function +# which returns whatever is given to it as an argument. +def _(arg): + return arg + + +# Add-on information variables +addon_info = { + # add-on Name/identifier, internal for NVDA + "addon_name": "voicemeeter", + # Add-on summary, usually the user visible name of the addon. + # Translators: Summary for this add-on + # to be shown on installation and add-on information found in Add-ons Manager. + "addon_summary": _("Voicemeeter Controller"), + # Add-on description + # Translators: Long description to be shown for this add-on on add-on information from add-ons manager + "addon_description": _( + """This add-on uses Voicemeeter's Remote API to control it's GUI. +The add-on requires Voicemeeter to be installed.""" + ), + # version + "addon_version": "0.1", + # Author(s) + "addon_author": "onyx-and-iris ", + # URL for the add-on documentation support + "addon_url": None, + # URL for the add-on repository where the source code can be found + "addon_sourceURL": "https://github.com/onyx-and-iris/nvda-addon-voicemeeter", + # Documentation file name + "addon_docFileName": "readme.html", + # Minimum NVDA version supported (e.g. "2018.3.0", minor version is optional) + "addon_minimumNVDAVersion": "2023.2", + # Last NVDA version supported/tested (e.g. "2018.4.0", ideally more recent than minimum version) + "addon_lastTestedNVDAVersion": "2023.2", + # Add-on update channel (default is None, denoting stable releases, + # and for development releases, use "dev".) + # Do not change unless you know what you are doing! + "addon_updateChannel": "dev", + # Add-on license such as GPL 2 + "addon_license": None, + # URL for the license document the ad-on is licensed under + "addon_licenseURL": None, +} + +# Define the python files that are the sources of your add-on. +# You can either list every file (using ""/") as a path separator, +# or use glob expressions. +# For example to include all files with a ".py" extension from the "globalPlugins" dir of your add-on +# the list can be written as follows: +# pythonSources = ["addon/globalPlugins/*.py"] +# For more information on SCons Glob expressions please take a look at: +# https://scons.org/doc/production/HTML/scons-user/apd.html +pythonSources = [ + "addon/globalPlugins/voicemeeter/*.py", +] + +# Files that contain strings for translation. Usually your python sources +i18nSources = pythonSources + ["buildVars.py"] + +# Files that will be ignored when building the nvda-addon file +# Paths are relative to the addon directory, not to the root directory of your addon sources. +excludedFiles = [] + +# Base language for the NVDA add-on +# If your add-on is written in a language other than english, modify this variable. +# For example, set baseLanguage to "es" if your add-on is primarily written in spanish. +baseLanguage = "en" + +# Markdown extensions for add-on documentation +# Most add-ons do not require additional Markdown extensions. +# If you need to add support for markup such as tables, fill out the below list. +# Extensions string must be of the form "markdown.extensions.extensionName" +# e.g. "markdown.extensions.tables" to add tables. +markdownExtensions = [] diff --git a/manifest-translated.ini.tpl b/manifest-translated.ini.tpl new file mode 100644 index 0000000..c06aa84 --- /dev/null +++ b/manifest-translated.ini.tpl @@ -0,0 +1,2 @@ +summary = "{addon_summary}" +description = """{addon_description}""" diff --git a/manifest.ini.tpl b/manifest.ini.tpl new file mode 100644 index 0000000..d44355d --- /dev/null +++ b/manifest.ini.tpl @@ -0,0 +1,10 @@ +name = {addon_name} +summary = "{addon_summary}" +description = """{addon_description}""" +author = "{addon_author}" +url = {addon_url} +version = {addon_version} +docFileName = {addon_docFileName} +minimumNVDAVersion = {addon_minimumNVDAVersion} +lastTestedNVDAVersion = {addon_lastTestedNVDAVersion} +updateChannel = {addon_updateChannel} diff --git a/sconstruct b/sconstruct new file mode 100644 index 0000000..f1bad99 --- /dev/null +++ b/sconstruct @@ -0,0 +1,332 @@ +# NVDA add-on template SCONSTRUCT file +# Copyright (C) 2012-2023 Rui Batista, Noelia Martinez, Joseph Lee +# This file is covered by the GNU General Public License. +# See the file COPYING.txt for more details. + +import codecs +import gettext +import os +import os.path +import zipfile +import sys + +# While names imported below are available by default in every SConscript +# Linters aren't aware about them. +# To avoid Flake8 F821 warnings about them they are imported explicitly. +# When using other Scons functions please add them to the line below. +from SCons.Script import BoolVariable, Builder, Copy, Environment, Variables + +sys.dont_write_bytecode = True + +# Bytecode should not be written for build vars module to keep the repository root folder clean. +import buildVars # NOQA: E402 + + +def md2html(source, dest): + import markdown + # Use extensions if defined. + mdExtensions = buildVars.markdownExtensions + lang = os.path.basename(os.path.dirname(source)).replace('_', '-') + localeLang = os.path.basename(os.path.dirname(source)) + try: + _ = gettext.translation("nvda", localedir=os.path.join("addon", "locale"), languages=[localeLang]).gettext + summary = _(buildVars.addon_info["addon_summary"]) + except Exception: + summary = buildVars.addon_info["addon_summary"] + title = "{addonSummary} {addonVersion}".format( + addonSummary=summary, addonVersion=buildVars.addon_info["addon_version"] + ) + headerDic = { + "[[!meta title=\"": "# ", + "\"]]": " #", + } + with codecs.open(source, "r", "utf-8") as f: + mdText = f.read() + for k, v in headerDic.items(): + mdText = mdText.replace(k, v, 1) + htmlText = markdown.markdown(mdText, extensions=mdExtensions) + # Optimization: build resulting HTML text in one go instead of writing parts separately. + docText = "\n".join([ + "", + "" % lang, + "", + "" + "", + "", + "%s" % title, + "\n", + htmlText, + "\n" + ]) + with codecs.open(dest, "w", "utf-8") as f: + f.write(docText) + + +def mdTool(env): + mdAction = env.Action( + lambda target, source, env: md2html(source[0].path, target[0].path), + lambda target, source, env: 'Generating % s' % target[0], + ) + mdBuilder = env.Builder( + action=mdAction, + suffix='.html', + src_suffix='.md', + ) + env['BUILDERS']['markdown'] = mdBuilder + + +def validateVersionNumber(key, val, env): + # Used to make sure version major.minor.patch are integers to comply with NV Access add-on store. + # Ignore all this if version number is not specified, in which case json generator will validate this info. + if val == "0.0.0": + return + versionNumber = val.split(".") + if len(versionNumber) < 3: + raise ValueError("versionNumber must have three parts (major.minor.patch)") + if not all([part.isnumeric() for part in versionNumber]): + raise ValueError("versionNumber (major.minor.patch) must be integers") + + +vars = Variables() +vars.Add("version", "The version of this build", buildVars.addon_info["addon_version"]) +vars.Add("versionNumber", "Version number of the form major.minor.patch", "0.0.0", validateVersionNumber) +vars.Add(BoolVariable("dev", "Whether this is a daily development version", False)) +vars.Add("channel", "Update channel for this build", buildVars.addon_info["addon_updateChannel"]) + +env = Environment(variables=vars, ENV=os.environ, tools=['gettexttool', mdTool]) +env.Append(**buildVars.addon_info) + +if env["dev"]: + import datetime + buildDate = datetime.datetime.now() + year, month, day = str(buildDate.year), str(buildDate.month), str(buildDate.day) + versionTimestamp = "".join([year, month.zfill(2), day.zfill(2)]) + env["addon_version"] = f"{versionTimestamp}.0.0" + env["versionNumber"] = f"{versionTimestamp}.0.0" + env["channel"] = "dev" +elif env["version"] is not None: + env["addon_version"] = env["version"] +if "channel" in env and env["channel"] is not None: + env["addon_updateChannel"] = env["channel"] + +buildVars.addon_info["addon_version"] = env["addon_version"] +buildVars.addon_info["addon_updateChannel"] = env["addon_updateChannel"] + +addonFile = env.File("${addon_name}-${addon_version}.nvda-addon") + + +def addonGenerator(target, source, env, for_signature): + action = env.Action( + lambda target, source, env: createAddonBundleFromPath(source[0].abspath, target[0].abspath) and None, + lambda target, source, env: "Generating Addon %s" % target[0] + ) + return action + + +def manifestGenerator(target, source, env, for_signature): + action = env.Action( + lambda target, source, env: generateManifest(source[0].abspath, target[0].abspath) and None, + lambda target, source, env: "Generating manifest %s" % target[0] + ) + return action + + +def translatedManifestGenerator(target, source, env, for_signature): + dir = os.path.abspath(os.path.join(os.path.dirname(str(source[0])), "..")) + lang = os.path.basename(dir) + action = env.Action( + lambda target, source, env: generateTranslatedManifest(source[1].abspath, lang, target[0].abspath) and None, + lambda target, source, env: "Generating translated manifest %s" % target[0] + ) + return action + + +env['BUILDERS']['NVDAAddon'] = Builder(generator=addonGenerator) +env['BUILDERS']['NVDAManifest'] = Builder(generator=manifestGenerator) +env['BUILDERS']['NVDATranslatedManifest'] = Builder(generator=translatedManifestGenerator) + + +def createAddonHelp(dir): + docsDir = os.path.join(dir, "doc") + if os.path.isfile("style.css"): + cssPath = os.path.join(docsDir, "style.css") + cssTarget = env.Command(cssPath, "style.css", Copy("$TARGET", "$SOURCE")) + env.Depends(addon, cssTarget) + if os.path.isfile("readme.md"): + readmePath = os.path.join(docsDir, buildVars.baseLanguage, "readme.md") + readmeTarget = env.Command(readmePath, "readme.md", Copy("$TARGET", "$SOURCE")) + env.Depends(addon, readmeTarget) + + +def createAddonBundleFromPath(path, dest): + """ Creates a bundle from a directory that contains an addon manifest file.""" + basedir = os.path.abspath(path) + with zipfile.ZipFile(dest, 'w', zipfile.ZIP_DEFLATED) as z: + # FIXME: the include/exclude feature may or may not be useful. Also python files can be pre-compiled. + for dir, dirnames, filenames in os.walk(basedir): + relativePath = os.path.relpath(dir, basedir) + for filename in filenames: + pathInBundle = os.path.join(relativePath, filename) + absPath = os.path.join(dir, filename) + if pathInBundle not in buildVars.excludedFiles: + z.write(absPath, pathInBundle) + createAddonStoreJson(dest) + return dest + + +def createAddonStoreJson(bundle): + """Creates add-on store JSON file from an add-on package and manifest data.""" + import json + import hashlib + # Set different json file names and version number properties based on version number parsing results. + if env["versionNumber"] == "0.0.0": + env["versionNumber"] = buildVars.addon_info["addon_version"] + versionNumberParsed = env["versionNumber"].split(".") + if all([part.isnumeric() for part in versionNumberParsed]): + if len(versionNumberParsed) == 1: + versionNumberParsed += ["0", "0"] + elif len(versionNumberParsed) == 2: + versionNumberParsed.append("0") + else: + versionNumberParsed = [] + if len(versionNumberParsed): + major, minor, patch = [int(part) for part in versionNumberParsed] + jsonFilename = f'{major}.{minor}.{patch}.json' + else: + jsonFilename = f'{buildVars.addon_info["addon_version"]}.json' + major, minor, patch = 0, 0, 0 + print('Generating % s' % jsonFilename) + sha256 = hashlib.sha256() + with open(bundle, "rb") as f: + for byte_block in iter(lambda: f.read(65536), b""): + sha256.update(byte_block) + hashValue = sha256.hexdigest() + try: + minimumNVDAVersion = buildVars.addon_info["addon_minimumNVDAVersion"].split(".") + except AttributeError: + minimumNVDAVersion = [0, 0, 0] + minMajor, minMinor = minimumNVDAVersion[:2] + minPatch = minimumNVDAVersion[-1] if len(minimumNVDAVersion) == 3 else "0" + try: + lastTestedNVDAVersion = buildVars.addon_info["addon_lastTestedNVDAVersion"].split(".") + except AttributeError: + lastTestedNVDAVersion = [0, 0, 0] + lastTestedMajor, lastTestedMinor = lastTestedNVDAVersion[:2] + lastTestedPatch = lastTestedNVDAVersion[-1] if len(lastTestedNVDAVersion) == 3 else "0" + channel = buildVars.addon_info["addon_updateChannel"] + if channel is None: + channel = "stable" + addonStoreEntry = { + "addonId": buildVars.addon_info["addon_name"], + "displayName": buildVars.addon_info["addon_summary"], + "URL": "", + "description": buildVars.addon_info["addon_description"], + "sha256": hashValue, + "homepage": buildVars.addon_info["addon_url"], + "addonVersionName": buildVars.addon_info["addon_version"], + "addonVersionNumber": { + "major": major, + "minor": minor, + "patch": patch + }, + "minNVDAVersion": { + "major": int(minMajor), + "minor": int(minMinor), + "patch": int(minPatch) + }, + "lastTestedVersion": { + "major": int(lastTestedMajor), + "minor": int(lastTestedMinor), + "patch": int(lastTestedPatch) + }, + "channel": channel, + "publisher": "", + "sourceURL": buildVars.addon_info["addon_sourceURL"], + "license": buildVars.addon_info["addon_license"], + "licenseURL": buildVars.addon_info["addon_licenseURL"], + } + with open(jsonFilename, "w") as addonStoreJson: + json.dump(addonStoreEntry, addonStoreJson, indent="\t") + + +def generateManifest(source, dest): + addon_info = buildVars.addon_info + with codecs.open(source, "r", "utf-8") as f: + manifest_template = f.read() + manifest = manifest_template.format(**addon_info) + with codecs.open(dest, "w", "utf-8") as f: + f.write(manifest) + + +def generateTranslatedManifest(source, language, out): + _ = gettext.translation("nvda", localedir=os.path.join("addon", "locale"), languages=[language]).gettext + vars = {} + for var in ("addon_summary", "addon_description"): + vars[var] = _(buildVars.addon_info[var]) + with codecs.open(source, "r", "utf-8") as f: + manifest_template = f.read() + result = manifest_template.format(**vars) + with codecs.open(out, "w", "utf-8") as f: + f.write(result) + + +def expandGlobs(files): + return [f for pattern in files for f in env.Glob(pattern)] + + +addon = env.NVDAAddon(addonFile, env.Dir('addon')) + +langDirs = [f for f in env.Glob(os.path.join("addon", "locale", "*"))] + +# Allow all NVDA's gettext po files to be compiled in source/locale, and manifest files to be generated +for dir in langDirs: + poFile = dir.File(os.path.join("LC_MESSAGES", "nvda.po")) + moFile = env.gettextMoFile(poFile) + env.Depends(moFile, poFile) + translatedManifest = env.NVDATranslatedManifest( + dir.File("manifest.ini"), + [moFile, os.path.join("manifest-translated.ini.tpl")] + ) + env.Depends(translatedManifest, ["buildVars.py"]) + env.Depends(addon, [translatedManifest, moFile]) + +pythonFiles = expandGlobs(buildVars.pythonSources) +for file in pythonFiles: + env.Depends(addon, file) + +# Convert markdown files to html +# We need at least doc in English and should enable the Help button for the add-on in Add-ons Manager +createAddonHelp("addon") +for mdFile in env.Glob(os.path.join('addon', 'doc', '*', '*.md')): + htmlFile = env.markdown(mdFile) + try: # It is possible that no moFile was set, because an add-on has no translations. + moFile + except NameError: # Runs if there is no moFile + env.Depends(htmlFile, mdFile) + else: # Runs if there is a moFile + env.Depends(htmlFile, [mdFile, moFile]) + env.Depends(addon, htmlFile) + +# Pot target +i18nFiles = expandGlobs(buildVars.i18nSources) +gettextvars = { + 'gettext_package_bugs_address': 'nvda-translations@groups.io', + 'gettext_package_name': buildVars.addon_info['addon_name'], + 'gettext_package_version': buildVars.addon_info['addon_version'] +} + +pot = env.gettextPotFile("${addon_name}.pot", i18nFiles, **gettextvars) +env.Alias('pot', pot) +env.Depends(pot, i18nFiles) +mergePot = env.gettextMergePotFile("${addon_name}-merge.pot", i18nFiles, **gettextvars) +env.Alias('mergePot', mergePot) +env.Depends(mergePot, i18nFiles) + +# Generate Manifest path +manifest = env.NVDAManifest(os.path.join("addon", "manifest.ini"), os.path.join("manifest.ini.tpl")) +# Ensure manifest is rebuilt if buildVars is updated. +env.Depends(manifest, "buildVars.py") + +env.Depends(addon, manifest) +env.Default(addon) +env.Clean(addon, ['.sconsign.dblite', 'addon/doc/' + buildVars.baseLanguage + '/']) diff --git a/site_scons/site_tools/gettexttool/__init__.py b/site_scons/site_tools/gettexttool/__init__.py new file mode 100644 index 0000000..db9a009 --- /dev/null +++ b/site_scons/site_tools/gettexttool/__init__.py @@ -0,0 +1,55 @@ +""" This tool allows generation of gettext .mo compiled files, pot files from source code files +and pot files for merging. + +Three new builders are added into the constructed environment: + +- gettextMoFile: generates .mo file from .pot file using msgfmt. +- gettextPotFile: Generates .pot file from source code files. +- gettextMergePotFile: Creates a .pot file appropriate for merging into existing .po files. + +To properly configure get text, define the following variables: + +- gettext_package_bugs_address +- gettext_package_name +- gettext_package_version + + +""" +from SCons.Action import Action + + +def exists(env): + return True + + +XGETTEXT_COMMON_ARGS = ( + "--msgid-bugs-address='$gettext_package_bugs_address' " + "--package-name='$gettext_package_name' " + "--package-version='$gettext_package_version' " + "--keyword=pgettext:1c,2 " + "-c -o $TARGET $SOURCES" +) + + +def generate(env): + env.SetDefault(gettext_package_bugs_address="example@example.com") + env.SetDefault(gettext_package_name="") + env.SetDefault(gettext_package_version="") + + env['BUILDERS']['gettextMoFile'] = env.Builder( + action=Action("msgfmt -o $TARGET $SOURCE", "Compiling translation $SOURCE"), + suffix=".mo", + src_suffix=".po" + ) + + env['BUILDERS']['gettextPotFile'] = env.Builder( + action=Action("xgettext " + XGETTEXT_COMMON_ARGS, "Generating pot file $TARGET"), + suffix=".pot") + + env['BUILDERS']['gettextMergePotFile'] = env.Builder( + action=Action( + "xgettext " + "--omit-header --no-location " + XGETTEXT_COMMON_ARGS, + "Generating pot file $TARGET" + ), + suffix=".pot" + )