GUI - Add language section to toolbar; move the language setting to its 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,

Author: SunderB

app/gui/qt/mainwindow.cpp

@@ -2199,39 +2199,6 @@ void MainWindow::changeSystemPreAmp(int val, int silent)
     statusBar()->showMessage(tr("Updating System Volume..."), 2000);
 }
 
-// TODO: Implement real-time language switching
-void MainWindow::changeUILanguage(QString lang) {
-    if (lang != piSettings->language) {
-        std::cout << "Current language:  " << piSettings->language.toUtf8().constData() << std::endl;
-        std::cout << "New language selected: " << lang.toUtf8().constData() << std::endl;
-        QString old_lang = sonicPii18n->getNativeLanguageName(piSettings->language);
-        QString new_lang = sonicPii18n->getNativeLanguageName(lang);
-
-        // Load new language
-        //QString language = sonicPii18n->determineUILanguage(lang);
-        //sonicPii18n->loadTranslations(language);
-        //QString title_new = tr("Updated the UI language from %s to %s").arg();
-
-        QMessageBox msgBox(this);
-        msgBox.setText(QString(tr("You've selected a new language: %1")).arg(new_lang));
-        msgBox.setInformativeText(tr("Do you want to apply this language?\nApplying the new language will restart Sonic Pi."));
-        QPushButton *restartButton = msgBox.addButton(tr("Apply and Restart"), QMessageBox::ActionRole);
-        QPushButton *dismissButton = msgBox.addButton(tr("Cancel"), QMessageBox::RejectRole);
-        msgBox.setDefaultButton(restartButton);
-        msgBox.setIcon(QMessageBox::Information);
-        msgBox.exec();
-
-        if (msgBox.clickedButton() == (QAbstractButton*)restartButton) {
-            piSettings->language = lang;
-            restartApp();
-        } else if (msgBox.clickedButton() == (QAbstractButton*)dismissButton) {
-            // Don't apply the new language settings
-            settingsWidget->updateSelectedUILanguage(piSettings->language);
-        }
-
-    }
-}
-
 void MainWindow::changeScopeKindVisibility(QString name)
 {
     foreach (QAction* action, scopeKindVisibilityMenu->actions())
@@ -3356,6 +3323,39 @@ void MainWindow::createToolBar()
     viewMenu->addAction(focusHelpListingAct);
     viewMenu->addAction(focusHelpDetailsAct);
     viewMenu->addAction(focusErrorsAct);
+
+    languageMenu = menuBar()->addMenu(tr("Language"));
+    QStringList available_languages = sonicPii18n->getAvailableLanguages();
+
+    langActionGroup = new QActionGroup(this);
+    langActionGroup->setExclusionPolicy(QActionGroup::ExclusionPolicy::Exclusive);
+
+    QSignalMapper *signalMapper = new QSignalMapper(this);
+
+    for (size_t i = 0; i < available_languages.length(); i += 1) {
+      bool is_current_lang = (available_languages[i] == piSettings->language);
+
+      QAction *langAct = new QAction(sonicPii18n->getNativeLanguageName(available_languages[i]), this);
+      langAct->setCheckable(true);
+      langAct->setChecked(is_current_lang);
+
+      connect(langAct, SIGNAL(triggered()), signalMapper, SLOT(map()));
+      signalMapper->setMapping(langAct, i);
+
+      langActionGroup->addAction(langAct);
+      languageMenu->addAction(langAct);
+
+      if (i == 0) { // add separator after System language
+        languageMenu->addSeparator();
+      }
+    }
+
+    connect(signalMapper, SIGNAL(mappedInt(int)), settingsWidget, SLOT(updateUILanguage(int)));
+    connect(settingsWidget, SIGNAL(uiLanguageChanged(QString)), this, SLOT(updateSelectedUILanguageAction(QString)));
+}
+
+void MainWindow::updateSelectedUILanguageAction(QString lang) {
+  langActionGroup->actions()[sonicPii18n->getAvailableLanguages().indexOf(lang)]->setChecked(true);
 }
 
 QString MainWindow::readFile(QString name)

app/gui/qt/mainwindow.h

@@ -34,6 +34,7 @@
 #include "config.h"
 
 class QAction;
+class QActionGroup;
 class QMenu;
 class QToolBar;
 class QLineEdit;
@@ -141,7 +142,7 @@ class MainWindow : public QMainWindow
 
        private slots:
 
-        void changeUILanguage(QString lang);
+        void updateSelectedUILanguageAction(QString lang);
         void updateContext(int line, int index);
         void updateContextWithCurrentWs();
         void docLinkClicked(const QUrl &url);
@@ -335,7 +336,7 @@ class MainWindow : public QMainWindow
         std::string number_name(int);
         std::string workspaceFilename(SonicPiScintilla* text);
         SonicPiScintilla* filenameToWorkspace(std::string filename);
-        
+
         bool sendOSC(oscpkt::Message m);
         //   void initPrefsWindow();
         void initDocsWindow();
@@ -360,7 +361,7 @@ class MainWindow : public QMainWindow
         void addUniversalCopyShortcuts(QTextEdit *te);
         void updateTranslatedUIText();
 
-  QMenu *liveMenu, *codeMenu, *audioMenu, *displayMenu, *viewMenu, *ioMenu, *ioMidiInMenu, *ioMidiOutMenu, *ioMidiOutChannelMenu, *localIpAddressesMenu, *themeMenu, *scopeKindVisibilityMenu;
+  QMenu *liveMenu, *codeMenu, *audioMenu, *displayMenu, *viewMenu, *ioMenu, *ioMidiInMenu, *ioMidiOutMenu, *ioMidiOutChannelMenu, *localIpAddressesMenu, *themeMenu, *scopeKindVisibilityMenu, *languageMenu;
 
         SonicPiSettings *piSettings;
         SonicPii18n *sonicPii18n;
@@ -422,6 +423,7 @@ class MainWindow : public QMainWindow
 
   QAction *exitAct, *runAct, *stopAct, *saveAsAct, *loadFileAct, *recAct, *textAlignAct, *textIncAct, *textDecAct, *scopeAct, *infoAct, *helpAct, *prefsAct, *focusEditorAct, *focusLogsAct, *focusContextAct, *focusCuesAct, *focusPreferencesAct, *focusHelpListingAct, *focusHelpDetailsAct, *focusErrorsAct, *showLineNumbersAct, *showAutoCompletionAct, *showContextAct, *audioSafeAct, *audioTimingGuaranteesAct, *enableExternalSynthsAct, *mixerInvertStereoAct, *mixerForceMonoAct, *midiEnabledAct, *enableOSCServerAct, *allowRemoteOSCAct, *showLogAct, *showCuesAct, *logAutoScrollAct, *logCuesAct, *logSynthsAct, *clearOutputOnRunAct, *autoIndentOnRunAct, *showButtonsAct, *showTabsAct, *fullScreenAct, *lightThemeAct, *darkThemeAct, *proLightThemeAct, *proDarkThemeAct, *highContrastThemeAct, *showScopeLabelsAct;
   QShortcut *runSc, *stopSc, *saveAsSc, *loadFileSc, *recSc, *textAlignSc, *textIncSc, *textDecSc, *scopeSc, *infoSc, *helpSc, *prefsSc, *focusEditorSc, *focusLogsSc, *focusContextSc, *focusCuesSc, *focusPreferencesSc, *focusHelpListingSc, *focusHelpDetailsSc, *focusErrorsSc;
+        QActionGroup *langActionGroup;
 
         SettingsWidget *settingsWidget;
 

app/gui/qt/utils/sonicpi_i18n.cpp

@@ -13,15 +13,28 @@
 
 SonicPii18n::SonicPii18n(QString rootpath) {
   this->root_path = rootpath;
+  this->system_languages = findSystemLanguages();
   this->system_language_available = true; // Set to true unless we can't load the system language
-
   this->available_languages = findAvailableLanguages();
+  this->currently_loaded_language = "en";
+
+
   //checkAllTranslations(); // For testing and debugging purposes
 }
 
 SonicPii18n::~SonicPii18n() {
 }
 
+QStringList SonicPii18n::findSystemLanguages() {
+  QLocale locale;
+  QStringList preferred_languages = locale.uiLanguages();
+  std::cout << "Looping through preferred ui languages" << std::endl;
+  for (int i = 0; i < preferred_languages.length(); i += 1) {
+    preferred_languages[i] = preferred_languages[i].replace("-", "_");
+  }
+  return preferred_languages;
+}
+
 QString SonicPii18n::determineUILanguage(QString lang_pref) {
   QStringList available_languages = getAvailableLanguages();
   //std::cout << available_languages.join("\n").toUtf8().constData() << std::endl;
@@ -42,7 +55,7 @@ QString SonicPii18n::determineUILanguage(QString lang_pref) {
     }
   } else {
     QStringList preferred_languages = locale.uiLanguages();
-    // If the specified language isn't available, or if the setting is set to system_language...
+    // If the setting is set to system_language...
       // ...run through the list of preferred languages
     std::cout << "Looping through preferred ui languages" << std::endl;
 
@@ -108,11 +121,15 @@ bool SonicPii18n::loadTranslations(QString lang) {
   qtTranslator.load("qt_" + language, QLibraryInfo::location(QLibraryInfo::TranslationsPath));
   app->installTranslator(&qtTranslator);
 
+  this->currently_loaded_language = language;
+
   return i18n;
 }
 
 QStringList SonicPii18n::getAvailableLanguages() {
-  return this->available_languages;
+  QStringList list = this->available_languages;
+  list.prepend("system_language");
+  return list;
 }
 
 std::map<QString, QString> SonicPii18n::getNativeLanguageNameList() {
@@ -142,6 +159,14 @@ QString SonicPii18n::getNativeLanguageName(QString lang) {
   }
 }
 
+QStringList SonicPii18n::getNativeLanguageNames(QStringList languages) {
+  QStringList language_names;
+  for (size_t i = 0; i < languages.length(); i += 1) {
+    language_names << getNativeLanguageName(languages[i]);
+  }
+  return language_names;
+}
+
 // For testing and debugging purposes
 bool SonicPii18n::checkAllTranslations() {
   QStringList failed_to_load = QStringList();

app/gui/qt/utils/sonicpi_i18n.h

@@ -22,15 +22,18 @@ class SonicPii18n : public QObject {
   SonicPii18n(QString rootpath);
   ~SonicPii18n();
 
+  QStringList system_languages;
+  bool system_language_available;
+  QString currently_loaded_language;
+
 public slots:
   QString determineUILanguage(QString lang_pref);
   QStringList getAvailableLanguages();
   std::map<QString, QString> getNativeLanguageNameList();
   QString getNativeLanguageName(QString lang);
+  QStringList getNativeLanguageNames(QStringList languages);
   bool loadTranslations(QString lang);
 
-  bool system_language_available;
-
 private:
   QString root_path;
   QTranslator qtTranslator;
@@ -39,6 +42,7 @@ public slots:
   static std::map<QString, QString> native_language_names;
 
   QStringList findAvailableLanguages();
+  QStringList findSystemLanguages();
   bool checkAllTranslations();
 };
 #endif

app/gui/qt/widgets/settingswidget.cpp

@@ -1,5 +1,5 @@
 #include "settingswidget.h"
-#include "utils/sonic_pi_i18n.h"
+#include "utils/sonicpi_i18n.h"
 
 #include <QSettings>
 #include <QVBoxLayout>
@@ -28,7 +28,6 @@ SettingsWidget::SettingsWidget(int port, bool i18n, SonicPiSettings *piSettings,
     this->sonicPii18n = sonicPii18n;
     this->localeNames = sonicPii18n->getNativeLanguageNameList();
     this->available_languages = sonicPii18n->getAvailableLanguages();
-    available_languages.prepend("system_language");
     server_osc_cues_port = port;
 
     prefTabs = new QTabWidget();
@@ -51,6 +50,9 @@ SettingsWidget::SettingsWidget(int port, bool i18n, SonicPiSettings *piSettings,
     QGroupBox *update_prefs_box = createUpdatePrefsTab();
     prefTabs->addTab(update_prefs_box, tr("Updates"));
 
+    QGroupBox *language_prefs_box = createLanguagePrefsTab();
+    prefTabs->addTab(language_prefs_box, tr("Language"));
+
     if (!sonicPii18n->system_language_available) {
         QGroupBox *translation_box = new QGroupBox("Translation");
         QVBoxLayout *translation_box_layout = new QVBoxLayout;
@@ -374,34 +376,12 @@ QGroupBox* SettingsWidget::createEditorPrefsTab() {
     debug_box->setLayout(debug_box_layout);
 
 
-    QGroupBox *language_box = new QGroupBox(tr("Language"));
-    language_box->setToolTip(tr("Configure language settings"));
-
-    language_combo = new QComboBox();
-    add_language_combo_box_entries(language_combo);
-    language_combo->setToolTip(tr("Change the language of the UI & Tutorial (Requires a restart to take effect)"));
-    language_combo->setMinimumContentsLength(2);
-    language_combo->setSizeAdjustPolicy(QComboBox::AdjustToMinimumContentsLength);
-
-    language_option_label = new QLabel;
-    language_option_label->setText(tr("UI & Tutorial Language (Requires a restart to take effect)"));
-    language_option_label->setToolTip(tr("Change the language of the UI & Tutorial (Requires a restart to take effect)"));
-
-    language_info_label = new QLabel;
-    language_info_label->setText(tr("Translations have been generously provided by volunteers \non https://hosted.weblate.org/projects/sonic-pi/. Thank you! :)"));
-
-    QVBoxLayout *language_box_layout = new QVBoxLayout;
-    language_box_layout->addWidget(language_combo);
-    language_box_layout->addWidget(language_option_label);
-    language_box_layout->addWidget(language_info_label);
-
-    language_box->setLayout(language_box_layout);
 
     gridEditorPrefs->addWidget(editor_display_box, 0, 0);
     gridEditorPrefs->addWidget(editor_look_feel_box, 0, 1);
     gridEditorPrefs->addWidget(automation_box, 1, 1);
     gridEditorPrefs->addWidget(debug_box, 1, 0);
-    gridEditorPrefs->addWidget(language_box, 2, 0, 1, 2);
+
 
     editor_box->setLayout(gridEditorPrefs);
     return editor_box;
@@ -496,6 +476,42 @@ QGroupBox* SettingsWidget::createUpdatePrefsTab() {
     return update_prefs_box;
 }
 
+/**
+ * create Language Preferences Tab of Settings Widget
+ */
+QGroupBox* SettingsWidget::createLanguagePrefsTab() {
+    QGroupBox *language_box = new QGroupBox(tr("Language"));
+    language_box->setToolTip(tr("Configure language settings"));
+    QSizePolicy languagePrefSizePolicy(QSizePolicy::Minimum, QSizePolicy::Fixed);
+    language_box->setSizePolicy(languagePrefSizePolicy);
+
+    language_option_label = new QLabel;
+    language_option_label->setText(tr("UI & Tutorial Language (Requires a restart to take effect)"));
+    language_option_label->setToolTip(tr("Change the language of the UI & Tutorial (Requires a restart to take effect)"));
+
+    language_combo = new QComboBox();
+    add_language_combo_box_entries(language_combo);
+    language_combo->setToolTip(tr("Change the language of the UI & Tutorial (Requires a restart to take effect)"));
+    language_combo->setMinimumContentsLength(2);
+    language_combo->setSizeAdjustPolicy(QComboBox::AdjustToMinimumContentsLength);
+
+    language_info_label = new QLabel;
+    language_info_label->setText(tr("Translations have been generously provided by volunteers \non https://hosted.weblate.org/projects/sonic-pi/. Thank you! :)"));
+
+    QVBoxLayout *language_box_layout = new QVBoxLayout;
+
+    language_box_layout->addWidget(language_option_label);
+    language_box_layout->addWidget(language_combo);
+    language_box_layout->addWidget(language_info_label);
+
+    language_box->setLayout(language_box_layout);
+
+    QGroupBox *language_prefs_box = new QGroupBox();
+    QGridLayout *language_prefs_box_layout = new QGridLayout;
+    language_prefs_box_layout->addWidget(language_box, 0, 0, 0, 0);
+    language_prefs_box->setLayout(language_prefs_box_layout);
+    return language_prefs_box;
+}
 
 // TODO utils?
 QString SettingsWidget::tooltipStrShiftMeta(char key, QString str) {
@@ -556,7 +572,13 @@ void SettingsWidget::updateUILanguage(int index) {
 
         QMessageBox msgBox(this);
         msgBox.setText(QString(tr("You've selected a new language: %1")).arg(new_lang));
-        msgBox.setInformativeText(tr("Do you want to apply this language?") + "\n" + tr("Applying the new language will stop any current runs & recordings, and restart Sonic Pi."));
+        QString info_text = tr("Do you want to apply this language?") + "\n" + tr("Applying the new language will stop any current runs & recordings, and restart Sonic Pi.");
+
+        if (lang == "system_language") {
+          info_text = tr("System languages found %1").arg(sonicPii18n->getNativeLanguageNames(sonicPii18n->system_languages).join(", ")) + "\n" + info_text;
+        }
+
+        msgBox.setInformativeText(info_text);
         QPushButton *restartButton = msgBox.addButton(tr("Apply and Restart"), QMessageBox::ActionRole);
         QPushButton *dismissButton = msgBox.addButton(tr("Cancel"), QMessageBox::RejectRole);
         msgBox.setDefaultButton(restartButton);
@@ -570,6 +592,7 @@ void SettingsWidget::updateUILanguage(int index) {
         } else if (msgBox.clickedButton() == (QAbstractButton*)dismissButton) {
             // Don't apply the new language settings
             updateSelectedUILanguage(piSettings->language);
+            emit uiLanguageChanged(piSettings->language);
         }
 
     }
@@ -755,6 +778,13 @@ void SettingsWidget::updateSettings() {
 
 void SettingsWidget::settingsChanged() {
     language_combo->setCurrentIndex(available_languages.indexOf(piSettings->language));
+    if (piSettings->language == "system_language") {
+      language_info_label->setText(
+        tr("System languages: %1").arg(sonicPii18n->getNativeLanguageNames(sonicPii18n->system_languages).join(", ")) + "\n" + tr("Current UI language: %1").arg(sonicPii18n->getNativeLanguageName(sonicPii18n->currently_loaded_language))
+        + "\n\n" + tr("Translations have been generously provided by volunteers \non https://hosted.weblate.org/projects/sonic-pi/. Thank you! :)")
+      );
+    }
+
     mixer_invert_stereo->setChecked(piSettings->mixer_invert_stereo);
     mixer_force_mono->setChecked(piSettings->mixer_force_mono);
     check_args->setChecked(piSettings->check_args);