Integrate the MathCAT settings menu.

There are some lines that will get overridden when the builder file is changed:
  comment out of import wx.xrc
  import os
  and the logo line
These need to be fixed, maybe with a change to the build script.

Rearranged some code in MathCATPreferences.py to eliminate some global vars.

Update the release number

Author: NSoiffer

Cargo.toml

@@ -13,14 +13,14 @@ name = "libmathcat_py"
 crate-type = ["cdylib"]
 
 [dependencies]
-mathcat = "0.1.7"
+mathcat = "0.1.13"
 
 [dependencies.pyo3]
 version = "0.15.1"
 features = ["extension-module", "abi3"]
 
 [build-dependencies]
-mathcat = "0.1.6"
+mathcat = "0.1.13"
 zip = "0.5.8"
 
 [profile.release]

NVDA-addon/README

@@ -1,3 +1,3 @@
 To build the addon, type "scons".
 This rebuilds addon/manifest.ini and then zips up the addon dir to create 
-  mathCAT-0.1.nvda-addon  (where the version number comes from the manifest)
+  MathCAT-0.1.nvda-addon  (where the version number comes from the manifest)

NVDA-addon/README.install

@@ -3,7 +3,7 @@ To install this addon for NVDA:
 2. Choose Tools
 3. Choose Manage add-ons...
 4. Click Install...
-5. Pick the location where you saved mathCAT (the file name starts with "mathCAT" and ends with ".nvda-addon". The version number in the middle will change)
+5. Pick the location where you saved MathCAT (the file name starts with "MathCAT" and ends with ".nvda-addon". The version number in the middle will change)
 6. Click "Open"
 7. Click "Yes" to agree you want to install it.
 8. Click "Close" to restart NVDA with MathCAT enabled.

NVDA-addon/addon/globalPlugins/MathCAT/MathCATPreferences.py

@@ -27,61 +27,48 @@
 Braille_BrailleNavHighlight = ("Off", "FirstChar", "EndPoints", "All")
 Braille_BrailleCode = ("Nemeth", "UEB")
 
-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"
-
-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"
-
-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"
-
-def load_default_preferences():
-    global user_preferences
-    #load default preferences into the user preferences data structure (overwrites existing)
-    if os.path.exists(path_to_default_preferences()):
-        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
-        wx.MessageBox(_(u"MathCat preferences file not found. The program will now exit."), "Error", wx.OK | wx.ICON_ERROR)
-        os.sys.exit(-1)
-
-def load_user_preferences():
-    global user_preferences
-    #merge user file values into the user preferences data structure
-    if os.path.exists(path_to_user_preferences()):
-        with open(path_to_user_preferences(), encoding='utf-8') as f:
-            # merge with the default preferences, overwriting with the user's values
-            user_preferences.update(yaml.load(f, Loader=yaml.FullLoader))
-
-def write_user_preferences():
-    if not os.path.exists(path_to_user_preferences_folder()):
-        #create a folder for the user preferences
-        os.mkdir(path_to_user_preferences_folder())
-    with open(path_to_user_preferences(), 'w', encoding="utf-8") as f:
-        #write values to the user preferences file, NOT the default
-        yaml.dump(user_preferences, stream=f, allow_unicode=True)
 
 class UserInterface(MathCATgui.MathCATPreferencesDialog):
+    def __init__(self,parent):
+        #initialize parent class
+        MathCATgui.MathCATPreferencesDialog.__init__(self,parent)
+
+        # load in the system values followed by the user prefs (if any)
+        UserInterface.load_default_preferences()
+        UserInterface.load_user_preferences()
+
+        if "MathCATPreferencesLastCategory" in user_preferences:
+            #set the categories selection to what we used on last run
+            self.m_listBoxPreferencesTopic.SetSelection(user_preferences["MathCATPreferencesLastCategory"])
+            #show the appropriate dialogue page
+            self.m_simplebookPanelsCategories.SetSelection(self.m_listBoxPreferencesTopic.GetSelection())
+        else:
+            #set the categories selection to the first item
+            self.m_listBoxPreferencesTopic.SetSelection(0)
+            user_preferences["MathCATPreferencesLastCategory"]="0"
+        #populate the languages
+        UserInterface.GetLanguages(self)
+        #set the ui items to match the preferences
+        UserInterface.set_ui_values(self)
+
+    def path_to_languages_folder():
+        #the user preferences file is stored at: MathCAT\Rules\Languages
+        return os.path.expanduser('~')+"\\AppData\\Roaming\\nvda\\addons\\mathCAT\\globalPlugins\\MathCAT\\Rules\\Languages"
 
     def GetLanguages(self):
         #clear the language choices
         self.m_choiceLanguage.Clear()
         #populate the language choices
-        for f in os.listdir(path_to_languages_folder()):
-            if os.path.isdir(path_to_languages_folder()+"\\"+f):
+        for f in os.listdir(UserInterface.path_to_languages_folder()):
+            if os.path.isdir(UserInterface.path_to_languages_folder()+"\\"+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"
+        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)
@@ -103,7 +90,7 @@ def set_ui_values(self):
                 #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.GetSpeechStyles(user_preferences["Speech"]["SpeechStyle"])
             self.m_choiceSpeechAmount.SetSelection(Speech_Verbosity.index(user_preferences["Speech"]["Verbosity"]))
             self.m_sliderRelativeSpeed.SetValue(user_preferences["Speech"]["MathRate"])
             self.m_choiceSpeechForChemical.SetSelection(Speech_Chemistry.index(user_preferences["Speech"]["Chemistry"]))
@@ -143,42 +130,59 @@ def get_ui_values(self):
         user_preferences["Braille"]["BrailleCode"] = Braille_BrailleCode[self.m_choiceBrailleMathCode.GetSelection()]
         user_preferences["MathCATPreferencesLastCategory"] = self.m_listBoxPreferencesTopic.GetSelection()
 
-    def __init__(self,parent):
-        #initialize parent class
-        MathCATgui.MathCATPreferencesDialog.__init__(self,parent)
+    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"
 
-        # load in the system values followed by the user prefs (if any)
-        load_default_preferences()
-        load_user_preferences()
+    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"
 
-        if "MathCATPreferencesLastCategory" in user_preferences:
-            #set the categories selection to what we used on last run
-            self.m_listBoxPreferencesTopic.SetSelection(user_preferences["MathCATPreferencesLastCategory"])
-            #show the appropriate dialogue page
-            self.m_simplebookPanelsCategories.SetSelection(self.m_listBoxPreferencesTopic.GetSelection())
+    def path_to_user_preferences():
+        #the user preferences file is stored at: C:\Users\<user-name>AppData\Roaming\MathCAT\prefs.yaml
+        return UserInterface.path_to_user_preferences_folder() + "\\prefs.yaml"
+
+    def load_default_preferences():
+        global user_preferences
+        #load default preferences into the user preferences data structure (overwrites existing)
+        if os.path.exists(UserInterface.path_to_default_preferences()):
+            with open(UserInterface.path_to_default_preferences(), encoding='utf-8') as f:
+                user_preferences = yaml.load(f, Loader=yaml.FullLoader)
         else:
-            #set the categories selection to the first item
-            self.m_listBoxPreferencesTopic.SetSelection(0)
-            user_preferences["MathCATPreferencesLastCategory"]="0"
-        #populate the languages
-        UserInterface.GetLanguages(self)
-        #set the ui items to match the preferences
-        UserInterface.set_ui_values(self)
+            #default preferences file is NOT found
+            wx.MessageBox(_(u"MathCat preferences file not found. The program will now exit."), "Error", wx.OK | wx.ICON_ERROR)
+            os.sys.exit(-1)
+
+    def load_user_preferences():
+        global user_preferences
+        #merge user file values into the user preferences data structure
+        if os.path.exists(UserInterface.path_to_user_preferences()):
+            with open(UserInterface.path_to_user_preferences(), encoding='utf-8') as f:
+                # merge with the default preferences, overwriting with the user's values
+                user_preferences.update(yaml.load(f, Loader=yaml.FullLoader))
+
+    def write_user_preferences():
+        if not os.path.exists(UserInterface.path_to_user_preferences_folder()):
+            #create a folder for the user preferences
+            os.mkdir(UserInterface.path_to_user_preferences_folder())
+        with open(UserInterface.path_to_user_preferences(), 'w', encoding="utf-8") as f:
+            #write values to the user preferences file, NOT the default
+            yaml.dump(user_preferences, stream=f, allow_unicode=True)
 
     def OnClickOK(self,event):
         UserInterface.get_ui_values(self)
-        write_user_preferences()
+        UserInterface.write_user_preferences()
         self.Destroy()
 
     def OnClickCancel(self,event):
         self.Destroy()
 
     def OnClickApply(self,event):
         UserInterface.get_ui_values(self)
-        write_user_preferences()
+        UserInterface.write_user_preferences()
 
     def OnClickReset(self,event):
-        load_default_preferences()
+        UserInterface.load_default_preferences()
         UserInterface.set_ui_values(self)
 
     def OnClickHelp(self,event):

NVDA-addon/addon/globalPlugins/MathCAT/MathCATgui.py

@@ -8,7 +8,8 @@
 ###########################################################################
 
 import wx
-import wx.xrc
+# import wx.xrc
+import os
 
 import gettext
 _ = gettext.gettext
@@ -43,7 +44,7 @@ def __init__( self, parent ):
 
 		bSizerCategories.Add( ( 0, 0), 1, wx.EXPAND, 5 )
 
-		self.m_bitmapLogo = wx.StaticBitmap( self.m_panelCategories, wx.ID_ANY, wx.Bitmap( u"logo.png", wx.BITMAP_TYPE_ANY ), wx.DefaultPosition, wx.DefaultSize, 0 )
+		self.m_bitmapLogo = wx.StaticBitmap( self.m_panelCategories, wx.ID_ANY, wx.Bitmap( os.path.expanduser('~')+"\\AppData\\Roaming\\nvda\\addons\\MathCAT\\globalPlugins\\MathCAT\\logo.png", wx.BITMAP_TYPE_ANY ), wx.DefaultPosition, wx.DefaultSize, 0 )
 		bSizerCategories.Add( self.m_bitmapLogo, 0, wx.ALL, 5 )
 
 
@@ -242,7 +243,7 @@ def __init__( self, parent ):
 
 		bSizer171 = wx.BoxSizer( wx.HORIZONTAL )
 
-		self.m_staticTextBrailleHighlights = wx.StaticText( self.m_panelBraille, wx.ID_ANY, _(u"Highlight with dots 7 & 8 the current nav node:"), wx.DefaultPosition, wx.DefaultSize, 0 )
+		self.m_staticTextBrailleHighlights = wx.StaticText( self.m_panelBraille, wx.ID_ANY, _(u"Highlight with dots 7 && 8 the current nav node:"), wx.DefaultPosition, wx.DefaultSize, 0 )
 		self.m_staticTextBrailleHighlights.Wrap( -1 )
 
 		bSizer171.Add( self.m_staticTextBrailleHighlights, 0, wx.ALL, 5 )

NVDA-addon/addon/globalPlugins/MathCAT/__init__.py

@@ -314,12 +314,10 @@ def _setSpeechLanguage(self, mathMl):
 class GlobalPlugin(globalPluginHandler.GlobalPlugin):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        MathCAT.__init__(self)
-        log.info("about to call add_MathCAT_menu\n")
+        # MathCAT.__init__(self)
         self.add_MathCAT_menu()
 
     def add_MathCAT_menu(self):
-        log.info("in add_MathCAT_menu\n")
         self.toolsMenu = mainFrame.sysTrayIcon.toolsMenu
         self.settings = self.toolsMenu.Append(wx.ID_ANY, _("&MathCAT Settings..."))
         mainFrame.sysTrayIcon.Bind(wx.EVT_MENU, self.on_settings, self.settings)
@@ -328,7 +326,6 @@ def on_settings(self, evt):
         mainFrame._popupSettingsDialog(UserInterface)
 
     def terminate(self):
-        log.info("======== in terminate (remove settings menu\n")
         try:
             self.toolsMenu.Remove(self.settings)
         except (AttributeError, RuntimeError):

NVDA-addon/buildVars.py

@@ -16,7 +16,7 @@ def _(arg):
 # Add-on information variables
 addon_info = {
 	# add-on Name/identifier, internal for NVDA
-	"addon_name": "mathCAT",
+	"addon_name": "MathCAT",
 	# 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.

build-addon.sh

@@ -5,6 +5,6 @@ cargo build --target i686-pc-windows-msvc --release
 
 cp target/i686-pc-windows-msvc/release/libmathcat_py.dll NVDA-addon/addon/globalPlugins/MathCAT/libmathcat.pyd
 cd NVDA-addon
-rm mathCAT-*.nvda-addon
+rm MathCAT-*.nvda-addon
 scons