GUI: Add UI language option #2604

SunderB · 2020-12-27T15:14:20Z

An implementation of an option to change the language of the Sonic Pi GUI (without CMD args or changing the system language).

Features implemented:

Adds UI language option to the Qt GUI
Loads specified language on startup
When the language fails to load, an error message will be shown
When the user selects a new language, the user is asked to confirm the new language, then is given the option to restart Sonic Pi

Potential ideas for the future (not in the scope of this PR):

Changes the language instantly when the option is changed (this seemed like it was tricky to get working without potentially changing how the docs window works)

Closes #1506
Based on #2017

Feedback and help in completing this & testing this on different platforms is needed and greatly appreciated :)

Checklist:

SunderB · 2020-12-27T15:43:38Z

I realise this is a lot of changes in various parts of both the server and the GUI, so if it would be better to split this into multiple different PRs then I'd be happy to try to do so. Also, if it would help debugging, I can try to rebase the commits to separate the changes of the different parts of the code :)

SunderB · 2021-01-29T22:43:26Z

I think this implementation is mostly done. It needs testing to fix any bugs and to make sure it works on all platforms.

In particular the macOS GitHub action build seems to be failing for some reason (it seems like an issue to do with file paths and packaging? but I don't have a Mac to test this on). Help with testing and seeing what's wrong there would be great :)

samaaron · 2021-01-29T22:46:24Z

Lovely, I'll look at this soon :-)

Thanks so much for your hard work.

samaaron · 2021-02-12T17:05:34Z

Hi @SunderB,

I've taken a look at this and in addition to it failing the CI, there's quite a lot of changes in this PR that make it hard to see the precise goals.

Would it be at all possible to either modify this PR or create another which has a clear statement and description of the suggested changes and then just the minimum code changes necessary to achieve this. All changes that do nice refactoring and tidying etc should ideally be separate PRs to keep things easy to follow and review.

SunderB · 2021-02-13T23:58:26Z

@samaaron The main goal is to add the option to change the UI language within the GUI. I've gone through it, rebased it on top of the new API changes and trimmed it down to code that's only relevant to the GUI feature. Hopefully it makes it clearer to see its purpose and what it does? :)

samaaron · 2021-02-14T09:57:08Z

@cmaughan - would you be able to take a very brief look at this?

cmaughan · 2021-02-14T11:26:10Z

Sure, I'll look at it later today

cmaughan

Minor comments, but looks good to me.
It might be nice to add a startup argument to revert to the system default.

cmaughan · 2021-02-14T12:42:47Z

.gitignore

@@ -61,7 +61,8 @@ app/gui/qt/moc_mainwindow.cpp
 app/gui/qt/moc_sonicpiudpserver.cpp
 app/gui/qt/qrc_SonicPi.cpp
 app/gui/qt/utils/ruby_help.h
-app/gui/qt/help/*.html
+app/gui/qt/utils/lang_list.h
+app/gui/qt/help


Do we never update the help as a checkin?

app/gui/qt/mainwindow.cpp

samaaron · 2021-02-14T13:00:34Z

@cmaughan, thanks!

samaaron · 2021-02-14T14:00:11Z

@SunderB - let me know when you think it's ready to be merged.

SunderB · 2021-02-14T15:13:47Z

The only main issue is that some languages' translations fail to load (I believe because no strings are translated?):

bn - Bengali
ca@valencia - Valencian
en_AU - English (Australian)
eo - Esperanto

Apart from that if you can't find anything else that needs tweaking, it should be good to go I think :)

SunderB · 2021-02-14T15:18:23Z

Also some of the native language names may need double checking and correcting - I've done my best but some may not be 100% correct.
zh and zh_Hans currently have the same name (简体中文 - Chinese (Simplified)) as I didn't know what specific language zh is here, and weblate redirects zh to zh_Hans.

…ttingsWidget

Co-authored-by: ethancrawford <ethan_jc@hotmail.com>

Load the language after program output has been redirected to gui.log

… and add a warning about stopping runs & recordings (due to restart) when changing language.

…ts own tab in the SettingsWidget; fix bugs from renaming source files Also, when the user selects 'System language', we now show them the list of detected system languages, and show them which one is in use,

…n changing the language Also clean up/refactor SonicPii18n class

SunderB · 2021-04-15T21:13:17Z

I've updated it to allow the user to decide whether to restart Sonic Pi or not after selecting a new language. If the user doesn't restart, then the language will be applied when next running Sonic Pi.

SunderB · 2021-04-15T21:18:02Z

@samaaron @ethancrawford Are there any things that need tweaking or fixing? Are you happy with the structure and how the implementation works?

samaaron · 2021-04-26T22:28:50Z

@SunderB This is looking really nice, thank-you so much for all your really hard work.

I guess my only major question is how people can easily reset to the system default. If a user accidentally changes to a different locale that they can't understand, what's the plan for us supporting them to easily reset things?

samaaron · 2021-04-27T13:58:50Z

Hi @SunderB - looks like my recent patch removing the old api code has cause some conflicts here - apologies!

Any chance you could fix this in the PR? Also, am I right in thinking that you store the current locale choice in the QSettings file? If so, I've recently moved it to the standard config dir, so just nuking that should be a simple way of reverting locale to system default?

Synths winwood_lead, bass_foundation, and bass_highend

* Fixes an issue where the settings wouldn't be saved when restarting after selecting a new language. * Also, remove the unnecessary delay in restartApp(). Cleanup should be complete when onExitCleanup() returns.

SunderB · 2021-04-27T21:02:15Z

Hi @SunderB - looks like my recent patch removing the old api code has cause some conflicts here - apologies!

Any chance you could fix this in the PR? Also, am I right in thinking that you store the current locale choice in the QSettings file? If so, I've recently moved it to the standard config dir, so just nuking that should be a simple way of reverting locale to system default?

@samaaron I've managed to fix the conflicts, and after fixing a problem with settings not saving when restarting, it still seems to work. :) And yes, deleting the gui-settings.ini file seems to reset the UI language to the system language on my system.

* Add Basque and generic English to the list of language names * Add a message in the language options panel when the translations fail to load * Set fallback language code to en_GB instead of en (so it's clear which English translation is being used) * Tweak some log messages from SonicPii18n

samaaron · 2021-05-24T10:35:47Z

Thanks so much for this work - much appreciated.

rbnpi · 2021-05-24T16:26:13Z

Tested on my Mac and Raspberry Pi. Works nicely. Nice addition.

ethancrawford mentioned this pull request Jan 5, 2021

i18n progress status: Weblate transition #1232

Closed

11 tasks

Ben Marx added 2 commits January 12, 2021 23:36

Synths winwood_lead, bass_foundation, bass_highend

46733ec

Adjusted paths in synthdefs

985f289

SunderB force-pushed the patch-localeOption branch 2 times, most recently from 18d6ce6 to d5a425a Compare January 29, 2021 20:47

SunderB force-pushed the patch-localeOption branch 2 times, most recently from ea74447 to 15feed0 Compare February 4, 2021 17:25

samaaron changed the base branch from main to dev February 12, 2021 17:03

SunderB force-pushed the patch-localeOption branch from 15feed0 to 23a406e Compare February 13, 2021 18:11

SunderB changed the title ~~[GUI Feature]: Add GUI language option, improve system lang detection, & improve app/gui/qt/help folder structure~~ GUI: Add UI language option Feb 13, 2021

SunderB force-pushed the patch-localeOption branch 5 times, most recently from 5d7b4fa to 47b34e1 Compare February 13, 2021 23:48

SunderB force-pushed the patch-localeOption branch from 9f48164 to de8e03d Compare February 14, 2021 12:17

cmaughan approved these changes Feb 14, 2021

View reviewed changes

SunderB force-pushed the patch-localeOption branch from de8e03d to 52259a3 Compare February 14, 2021 12:55

SunderB marked this pull request as ready for review February 14, 2021 13:32

SunderB and others added 12 commits April 15, 2021 22:03

GUI - move language change message box handling from MainWindow to Se…

759fa02

…ttingsWidget

Update .gitignore

3c98ff1

GUI - Add function to test all found UI translations

0422ed1

GUI - Update native language names

687316d

GUI - Apply the current theme's background colour to message boxes

1cbb2ef

GUI - Tweak 'predefined language name not found' warning

320d91f

Co-authored-by: ethancrawford <ethan_jc@hotmail.com>

GUI - Output language loading logs to gui.log

f01c901

Load the language after program output has been redirected to gui.log

GUI - Show an error message when the selected language fails to load,…

30ceabf

… and add a warning about stopping runs & recordings (due to restart) when changing language.

GUI - Update native language names

1e287dd

GUI - rename sonic_pi_i18n.cpp to sonicpi_i18n.cpp

74d19df

GUI - Add language section to toolbar; move the language setting to i…

fc7881e

…ts own tab in the SettingsWidget; fix bugs from renaming source files Also, when the user selects 'System language', we now show them the list of detected system languages, and show them which one is in use,

GUI - Give the user the option whether or not to restart Sonic Pi whe…

cee7fc0

…n changing the language Also clean up/refactor SonicPii18n class

SunderB force-pushed the patch-localeOption branch from 6780ea2 to cee7fc0 Compare April 15, 2021 21:05

samaaron and others added 3 commits April 27, 2021 20:26

Merge pull request sonic-pi-net#2628 from level-xx/main

0c1ea59

Synths winwood_lead, bass_foundation, and bass_highend

Merge branch 'dev' into patch-localeOption

fa3961e

GUI: Fix some compilation errors from previous commit

a2b1b17

SunderB force-pushed the patch-localeOption branch from 90ccfee to a68c2bf Compare April 27, 2021 20:58

GUI: Ensure that the UI settings are saved before restarting Sonic Pi

9372da9

* Fixes an issue where the settings wouldn't be saved when restarting after selecting a new language. * Also, remove the unnecessary delay in restartApp(). Cleanup should be complete when onExitCleanup() returns.

SunderB force-pushed the patch-localeOption branch from a68c2bf to 9372da9 Compare April 27, 2021 21:01

samaaron force-pushed the dev branch from 696a10c to 5b77b1b Compare April 28, 2021 07:31

SunderB added 2 commits April 28, 2021 10:54

Merge branch 'dev' into patch-localeOption

767e3aa

samaaron merged commit ef24bc7 into sonic-pi-net:dev May 24, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GUI: Add UI language option #2604

GUI: Add UI language option #2604

SunderB commented Dec 27, 2020 •

edited

Loading

SunderB commented Dec 27, 2020

SunderB commented Jan 29, 2021 •

edited

Loading

samaaron commented Jan 29, 2021

samaaron commented Feb 12, 2021

SunderB commented Feb 13, 2021

samaaron commented Feb 14, 2021

cmaughan commented Feb 14, 2021

cmaughan left a comment

cmaughan Feb 14, 2021

samaaron commented Feb 14, 2021

samaaron commented Feb 14, 2021

SunderB commented Feb 14, 2021

SunderB commented Feb 14, 2021 •

edited

Loading

SunderB commented Apr 15, 2021

SunderB commented Apr 15, 2021 •

edited

Loading

samaaron commented Apr 26, 2021

samaaron commented Apr 27, 2021

SunderB commented Apr 27, 2021 •

edited

Loading

samaaron commented May 24, 2021

rbnpi commented May 24, 2021

GUI: Add UI language option #2604

GUI: Add UI language option #2604

Conversation

SunderB commented Dec 27, 2020 • edited Loading

SunderB commented Dec 27, 2020

SunderB commented Jan 29, 2021 • edited Loading

samaaron commented Jan 29, 2021

samaaron commented Feb 12, 2021

SunderB commented Feb 13, 2021

samaaron commented Feb 14, 2021

cmaughan commented Feb 14, 2021

cmaughan left a comment

Choose a reason for hiding this comment

cmaughan Feb 14, 2021

Choose a reason for hiding this comment

samaaron commented Feb 14, 2021

samaaron commented Feb 14, 2021

SunderB commented Feb 14, 2021

SunderB commented Feb 14, 2021 • edited Loading

SunderB commented Apr 15, 2021

SunderB commented Apr 15, 2021 • edited Loading

samaaron commented Apr 26, 2021

samaaron commented Apr 27, 2021

SunderB commented Apr 27, 2021 • edited Loading

samaaron commented May 24, 2021

rbnpi commented May 24, 2021

SunderB commented Dec 27, 2020 •

edited

Loading

SunderB commented Jan 29, 2021 •

edited

Loading

SunderB commented Feb 14, 2021 •

edited

Loading

SunderB commented Apr 15, 2021 •

edited

Loading

SunderB commented Apr 27, 2021 •

edited

Loading