Support Languages and SpeechStyles from folder structure

Author: ways2read

.vs/MathCATForPython/project-colors.json

@@ -0,0 +1,11 @@
+{
+  "Version": 1,
+  "ProjectMap": {
+    "a2fe74e1-b743-11d0-ae1a-00a0c90fffc3": {
+      "ProjectGuid": "a2fe74e1-b743-11d0-ae1a-00a0c90fffc3",
+      "DisplayName": "Miscellaneous Files",
+      "ColorIndex": -1
+    }
+  },
+  "NextColorIndex": 0
+}

.vs/MathCATForPython/v17/.suo

@@ -0,0 +1,3 @@
+{
+  "SuppressConfigureTestFrameworkPrompt": "true"
+}

.vs/PythonSettings.json

@@ -0,0 +1,11 @@
+{
+  "ExpandedNodes": [
+    "",
+    "\\NVDA-addon",
+    "\\NVDA-addon\\addon",
+    "\\NVDA-addon\\addon\\globalPlugins",
+    "\\NVDA-addon\\addon\\globalPlugins\\MathCAT"
+  ],
+  "SelectedNode": "\\NVDA-addon\\addon\\globalPlugins\\MathCAT\\MathCATPreferences.py",
+  "PreviewInSolutionExplorer": false
+}

.vs/VSWorkspaceState.json

@@ -2,22 +2,20 @@
 import MathCATgui
 import yaml
 import os
+import glob
 import sys
 import webbrowser  
 import gettext
 _ = gettext.gettext
 
-#initialize the languages dictionary
-Speech_Language = { "en": "English : en"}
-
 # initialize the user preferences tuples
 user_preferences = dict([("", "")])
+#Sepech_Language is derived from the folder structure
 Speech_Impairment = ("LearningDisability", "Blindness", "LowVision")
+#Speech_SpeechStyle is derived from the yaml files under the selected language
 Speech_Verbosity = ("Terse", "Medium", "Verbose")
-Speech_SpeechStyle = ("ClearSpeak", "SimpleSpeak")
 Speech_SubjectArea = ("General")
 Speech_Chemistry = ("SpellOut", "AsCompound", "Off")
-
 Navigation_NavMode = ("Enhanced", "Simple", "Character")
 #Navigation_ResetNavMode is boolean
 #Navigation_OverView is boolean
@@ -29,21 +27,21 @@
 
 def path_to_default_preferences():
     #the default preferences file is: C:\Users\<user-name>AppData\Roaming\\nvda\\addons\\mathCAT\\globalPlugins\\MathCAT\\Rules\\prefs.yaml
-    return os.path.expanduser('~')+"\\AppData\\Roaming\\nvda\\addons\\mathCAT\\globalPlugins\\MathCAT\\Rules\\prefs.yaml";
+    return os.path.expanduser('~')+"\\AppData\\Roaming\\nvda\\addons\\mathCAT\\globalPlugins\\MathCAT\\Rules\\prefs.yaml"
 
 def path_to_user_preferences_folder():
     #the user preferences file is stored at: C:\Users\<user-name>AppData\Roaming\MathCAT\prefs.yaml
-    return os.path.expanduser('~')+"\\AppData\\Roaming\\MathCAT";
+    return os.path.expanduser('~')+"\\AppData\\Roaming\\MathCAT"
 
 def path_to_user_preferences():
     #the user preferences file is stored at: C:\Users\<user-name>AppData\Roaming\MathCAT\prefs.yaml
-    return path_to_user_preferences_folder() + "\\prefs.yaml";
+    return path_to_user_preferences_folder() + "\\prefs.yaml"
 
 def load_default_preferences():
     global user_preferences
     #load default preferences into the user preferences data structure (overwites existing)
     if os.path.exists(path_to_default_preferences()):
-        with open(path_to_default_preferences()) as f:
+        with open(path_to_default_preferences(), encoding='utf-8') as f:
             user_preferences = yaml.load(f, Loader=yaml.FullLoader)
     else:
         #default preferences file is NOT found
@@ -66,20 +64,44 @@ def write_user_preferences():
         #write values to the user preferences file, NOT the default
         yaml.dump(user_preferences, f)
 
-def GetKey(val):
-   for key, value in Speech_Language.items():
-      if val == value:
-         return key 
-   return "en"
-
 class UserInterface(MathCATgui.MathCATPreferencesDialog):
 
+    def GetLanguages(self):
+        #clear the language choices
+        self.m_choiceLanguage.Clear()
+        #populate the language choices
+        for f in os.listdir(os.path.expanduser('~')+"\\AppData\\Roaming\\nvda\\addons\\mathCAT\\globalPlugins\\MathCAT\\Rules\\Languages"):
+            if os.path.isdir(os.path.expanduser('~')+"\\AppData\\Roaming\\nvda\\addons\\mathCAT\\globalPlugins\\MathCAT\\Rules\\Languages\\"+f):
+                self.m_choiceLanguage.Append(f)
+
+    def GetSpeechStyles(self, this_SpeechStyle):
+        #clear the SpeechStyle choices
+        self.m_choiceSpeechStyle.Clear()
+        #get the currently selected language
+        this_language = self.m_choiceLanguage.GetStringSelection()
+        this_path = os.path.expanduser('~')+"\\AppData\\Roaming\\nvda\\addons\\mathCAT\\globalPlugins\\MathCAT\\Rules\\Languages\\"+this_language+"\\*_Rules.yaml"
+        #populate the m_choiceSpeechStyle choices
+        for f in glob.glob(this_path):
+            fname = os.path.basename(f)
+            self.m_choiceSpeechStyle.Append((fname[:fname.find("_Rules.yaml")]))
+        try:
+            #set the SpeechStyle to the same as previous
+            self.m_choiceSpeechStyle.SetStringSelection(this_SpeechStyle)
+        except:
+            #that didn't work, choose the first in the list
+            self.m_choiceSpeechStyle.SetSelection(0)
+
     def set_ui_values(self):
         #set the UI elements to the ones read from the preference file(s)
         try:
             self.m_choiceImpairment.SetSelection(Speech_Impairment.index(user_preferences["Speech"]["Impairment"]))
-            self.m_choiceLanguage.SetStringSelection(Speech_Language[user_preferences["Speech"]["Language"]])
-            self.m_choiceSpeechStyle.SetSelection(Speech_SpeechStyle.index(user_preferences["Speech"]["SpeechStyle"]))
+            try:
+                self.m_choiceLanguage.SetStringSelection(user_preferences["Speech"]["Language"])
+            except:
+                #the language in the settings file is not in the folder structure, something went wrong, set to the first in the list
+                self.m_choiceLanguage.SetSelection(0)
+            #now get the available SpeechStyles from the folder structure and set to the preference setting is possible
+            UserInterface.GetSpeechStyles(self, user_preferences["Speech"]["SpeechStyle"])
             self.m_choiceSpeechAmount.SetSelection(Speech_Verbosity.index(user_preferences["Speech"]["Verbosity"]))
             self.m_choiceSpeechForChemical.SetSelection(Speech_Chemistry.index(user_preferences["Speech"]["Chemistry"]))
             self.m_choiceNavigationMode.SetSelection(Navigation_NavMode.index(user_preferences["Navigation"]["NavMode"]))
@@ -100,8 +122,8 @@ def get_ui_values(self):
         global user_preferences
         # read the values from the UI and update the user preferences dictionary
         user_preferences["Speech"]["Impairment"] = Speech_Impairment[self.m_choiceImpairment.GetSelection()]
-        user_preferences["Speech"]["Language"] = GetKey( self.m_choiceLanguage.GetStringSelection())
-        user_preferences["Speech"]["SpeechStyle"] = Speech_SpeechStyle[self.m_choiceSpeechStyle.GetSelection()]
+        user_preferences["Speech"]["Language"] = self.m_choiceLanguage.GetStringSelection()
+        user_preferences["Speech"]["SpeechStyle"] = self.m_choiceSpeechStyle.GetStringSelection()
         user_preferences["Speech"]["Verbosity"] = Speech_Verbosity[self.m_choiceSpeechAmount.GetSelection()]
         user_preferences["Speech"]["Chemistry"] = Speech_Chemistry[self.m_choiceSpeechForChemical.GetSelection()]
         user_preferences["Navigation"]["NavMode"] = Navigation_NavMode[self.m_choiceNavigationMode.GetSelection()]
@@ -129,15 +151,9 @@ def __init__(self,parent):
             #set the categories selection to the first item
             self.m_listBoxPreferencesTopic.SetSelection(0)
             user_preferences["MathCATPreferencesLastCategory"]="0"
-        #populate the language choices
-        self.m_choiceLanguage.Clear()
-        for lang in Speech_Language.values():
-            self.m_choiceLanguage.Append(lang)
-        #populate the SpeechStyle choices
-        #this will need to be done on change of language
-        self.m_choiceSpeechStyle.Clear()
-        self.m_choiceSpeechStyle.Append("ClearSpeak")
-
+        #populate the languages
+        UserInterface.GetLanguages(self)
+        #set the ui items to match the preferences
         UserInterface.set_ui_values(self)
 
     def OnClickOK(self,event):
@@ -160,9 +176,13 @@ def OnClickHelp(self,event):
         webbrowser.open('https://nsoiffer.github.io/MathCAT/users.html')
 
     def OnListBoxCategories(self,event):
-        #show the appropriate dialogue page
+        #the category changed, now show the appropriate dialogue page
         self.m_simplebookPanelsCategories.SetSelection(self.m_listBoxPreferencesTopic.GetSelection())
 
+    def OnLanguage(self,event):
+        #the language changed, get the SpeechStyles for the new language
+        UserInterface.GetSpeechStyles(self, self.m_choiceSpeechStyle.GetSelection())
+
     def MathCATPreferencesDialogOnCharHook(self,event):
         #designed choice is that Enter is the same as clicking OK, and Escape is the same as clicking Cancel
         keyCode = event.GetKeyCode()

.vs/slnx.sqlite

@@ -93,7 +93,7 @@ def __init__( self, parent ):
 
 		bSizer713.Add( self.m_staticText2111, 0, wx.ALL, 5 )
 
-		m_choiceSpeechStyleChoices = [ _(u"ClearSpeakxxxxxx") ]
+		m_choiceSpeechStyleChoices = [ _(u"xxxxxxxxxxxxxxxx") ]
 		self.m_choiceSpeechStyle = wx.Choice( self.m_panelSpeech, wx.ID_ANY, wx.DefaultPosition, wx.DefaultSize, m_choiceSpeechStyleChoices, 0 )
 		self.m_choiceSpeechStyle.SetSelection( 0 )
 		bSizer713.Add( self.m_choiceSpeechStyle, 0, wx.ALL, 5 )
@@ -311,6 +311,7 @@ def __init__( self, parent ):
 		self.Bind( wx.EVT_CHAR_HOOK, self.MathCATPreferencesDialogOnCharHook )
 		self.Bind( wx.EVT_KEY_UP, self.MathCATPreferencesDialogOnKeyUp )
 		self.m_listBoxPreferencesTopic.Bind( wx.EVT_LISTBOX, self.OnListBoxCategories )
+		self.m_choiceLanguage.Bind( wx.EVT_CHOICE, self.OnLanguage )
 		self.m_buttonOK.Bind( wx.EVT_BUTTON, self.OnClickOK )
 		self.m_buttonCancel.Bind( wx.EVT_BUTTON, self.OnClickCancel )
 		self.m_buttonApply.Bind( wx.EVT_BUTTON, self.OnClickApply )
@@ -331,6 +332,9 @@ def MathCATPreferencesDialogOnKeyUp( self, event ):
 	def OnListBoxCategories( self, event ):
 		event.Skip()
 
+	def OnLanguage( self, event ):
+		event.Skip()
+
 	def OnClickOK( self, event ):
 		event.Skip()