Add GetNavigationBraille()

Add CopyAs support
Bump version number

Author: NSoiffer

Cargo.toml

@@ -6,7 +6,7 @@
 
 [package]
 name = "MathCatForPython"
-version = "0.4.2"
+version = "0.5.0"
 authors = ["Neil Soiffer <soiffer@alum.mit.edu>"]
 edition = "2018"
 
@@ -19,7 +19,7 @@ name = "libmathcat_py"
 crate-type = ["cdylib"]
 
 [dependencies.mathcat]
-version = "0.4.2"
+version = "0.5.0"
 # for testing MathCAT without having to publish a new version (change two occurences)
 # path = "../MathCAT/"
 
@@ -29,7 +29,7 @@ features = ["extension-module", "abi3"]
 
 [build-dependencies]
 zip = { version = "0.6.2", default-features = false, features = ["deflate"] }
-mathcat = "0.4.2"
+mathcat = "0.5.0"
 # for testing MathCAT without having to publish a new version (change two occurences)
 # mathcat = {path = "../MathCAT/"}
 

addon/globalPlugins/MathCAT/MathCAT.py

@@ -313,7 +313,24 @@ def script_rawdataToClip(self, gesture: KeyboardInputGesture):
                 )  # copy will fix up name spacing
             elif self.init_mathml != "":
                 mathml = self.init_mathml
-            self._copyToClipAsMathML(mathml)
+            copy_as = "mathml"
+            try:
+                copy_as = libmathcat.GetPreference("CopyAs").lower()
+                match copy_as:
+                    case "mathml" | "latex" | "asciimath":
+                        pass
+                    case _:
+                        copy_as = "mathml"
+            except Exception as e:
+                log.error(f"Not able to get 'CopyAs' preference: {e}")
+
+            mathml = self._wrapMathMLForClipBoard(mathml)
+            if copy_as != "mathml":
+                saved_braille_code: str = libmathcat.GetPreference("BrailleCode")
+                libmathcat.SetPreference("BrailleCode", "LaTeX" if copy_as == "latex" else "ASCIIMath")
+                mathml = libmathcat.GetNavigationBraille()
+                libmathcat.SetPreference("BrailleCode", saved_braille_code)
+            self._copyToClipAsMathML(mathml, copy_as == "mathml")
             # Translators: copy to clipboard
             ui.message(_("copy"))
         except Exception as e:
@@ -337,7 +354,7 @@ def _wrapMathMLForClipBoard(self, text: str) -> str:
             )
         return mathml_with_ns
 
-    def _copyToClipAsMathML(self, text: str, notify: Optional[bool] = False) -> bool:
+    def _copyToClipAsMathML(self, text: str, is_mathml: bool, notify: Optional[bool] = False) -> bool:
         """Copies the given text to the windows clipboard.
         @returns: True if it succeeds, False otherwise.
         @param text: the text which will be copied to the clipboard
@@ -350,9 +367,9 @@ def _copyToClipAsMathML(self, text: str, notify: Optional[bool] = False) -> bool
         try:
             with winUser.openClipboard(gui.mainFrame.Handle):
                 winUser.emptyClipboard()
-                text = self._wrapMathMLForClipBoard(text)
-                self._setClipboardData(self.CF_MathML, '<?xml version="1.0"?>' + text)
-                self._setClipboardData(self.CF_MathML_Presentation, '<?xml version="1.0"?>' + text)
+                if is_mathml:
+                    self._setClipboardData(self.CF_MathML, '<?xml version="1.0"?>' + text)
+                    self._setClipboardData(self.CF_MathML_Presentation, '<?xml version="1.0"?>' + text)
                 self._setClipboardData(winUser.CF_UNICODETEXT, text)
             got = getClipData()
         except OSError:
@@ -449,7 +466,7 @@ def _add_sounds(self):
         try:
             return libmathcat.GetPreference("SpeechSound") != "None"
         except Exception as e:
-            print(f"An exception occurred: {e}")
+            log.error(f"An exception occurred: {e}")
             return False
 
     def getBrailleForMathMl(self, mathml: str):

buildVars.py

@@ -32,7 +32,7 @@ def _(arg):
         and other translations are in progress."""
     ),
     # version
-    "addon_version": "0.4.2",
+    "addon_version": "0.5.0",
     # Author(s)
     "addon_author": "Neil Soiffer <soiffer@alum.mit.edu>",
     # URL for the add-on documentation support

src/lib.rs

@@ -95,7 +95,6 @@ pub fn GetPreference(_py: Python, name: String) -> PyResult<String> {
 }
 
 #[pyfunction]
-#[allow(unused_variables)]
 /// Get the braille associated with the MathML node with a given id (MathML set by `SetMathML`]).
 /// An empty string can be used to return the braille associated with the entire expression.
 /// 
@@ -104,6 +103,15 @@ pub fn GetBraille(_py: Python, nav_node_id: String) -> PyResult<String> {
     return convert_error( get_braille(nav_node_id) );
 }
 
+#[pyfunction]
+/// Get the braille associated with the MathML node with a given id (MathML set by `SetMathML`]).
+/// An empty string can be used to return the braille associated with the entire expression.
+/// 
+/// The braille returned depends upon the preference for braille output.
+pub fn GetNavigationBraille(_py: Python) -> PyResult<String> {
+    return convert_error( get_navigation_braille() );
+}
+
 #[pyfunction]
 /// Given a key code along with the modifier keys, the current node is moved accordingly (or value reported in some cases).
 ///
@@ -156,6 +164,7 @@ fn libmathcat(_py: Python, m: &PyModule) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(SetPreference, m)?)?;
     m.add_function(wrap_pyfunction!(GetPreference, m)?)?;
     m.add_function(wrap_pyfunction!(GetBraille, m)?)?;
+    m.add_function(wrap_pyfunction!(GetNavigationBraille, m)?)?;
     m.add_function(wrap_pyfunction!(DoNavigateKeyPress, m)?)?;
     m.add_function(wrap_pyfunction!(DoNavigateCommand, m)?)?;
     m.add_function(wrap_pyfunction!(GetNavigationMathMLId, m)?)?;