Merge pull request #110 from balshetzer/master

Minor update

Author: balshetzer

README.rst

@@ -14,6 +14,7 @@ Supported stenotype protocols:
  * TX Bolt (a.k.a. Gemini TX)
  * Stentura
  * Treal
+ * Passport
 
 Contact the authors if you would like Plover to support your stenotype
 machine.

plover/dictionary/rtfcre_dict.py

@@ -17,6 +17,8 @@
 import re
 from plover.steno import normalize_steno
 from plover.steno_dictionary import StenoDictionary
+# TODO: Move dictionary format somewhere more caninical than formatting.
+from plover.formatting import META_RE
 
 # A regular expression to capture an individual entry in the dictionary.
 DICT_ENTRY_PATTERN = re.compile(r'(?s)(?<!\\){\\\*\\cxs (?P<steno>[^}]+)}' + 
@@ -81,19 +83,19 @@ def _re_handle_escaped_newline(self, m):
         return '{#Return}{#Return}'
 
     def _re_handle_infix(self, m):
-        r'\\cxds ([^{}\\\r\n]+)\\cxds'
+        r'\\cxds ([^{}\\\r\n]+)\\cxds ?'
         return '{^%s^}' % m.group(1)
 
     def _re_handle_suffix(self, m):
         r'\\cxds ([^{}\\\r\n ]+)'
         return '{^%s}' % m.group(1)
 
     def _re_handle_prefix(self, m):
-        r'([^{}\\\r\n ]+)\\cxds'
+        r'([^{}\\\r\n ]+)\\cxds ?'
         return '{%s^}' % m.group(1)
 
     def _re_handle_commands(self, m):
-        r'(\\\*)?\\([a-z]+)(-?[0-9]+)?[ ]?'
+        r'(\\\*)?\\([a-z]+)(-?[0-9]+)? ?'
 
         ignore = bool(m.group(1))
         command = m.group(2)
@@ -294,31 +296,37 @@ def load_dictionary(s):
 HEADER = ("{\\rtf1\\ansi{\\*\\cxrev100}\\cxdict{\\*\\cxsystem Plover}" +
           "{\\stylesheet{\\s0 Normal;}}\n")
 
+def format_translation(t):
+    t = ' '.join([x.strip() for x in META_RE.findall(t) if x.strip()])
+    
+    t = re.sub(r'{\.}', '{\\cxp. }', t)
+    t = re.sub(r'{!}', '{\\cxp! }', t)
+    t = re.sub(r'{\?}', '{\\cxp? }', t)
+    t = re.sub(r'{\,}', '{\\cxp, }', t)
+    t = re.sub(r'{:}', '{\\cxp: }', t)
+    t = re.sub(r'{;}', '{\\cxp; }', t)
+    t = re.sub(r'{\^}', '\\cxds ', t)
+    t = re.sub(r'{\^([^^}]*)}', '\\cxds \\1', t)
+    t = re.sub(r'{([^^}]*)\^}', '\\1\\cxds ', t)
+    t = re.sub(r'{\^([^^}]*)\^}', '\\cxds \\1\\cxds ', t)
+    t = re.sub(r'{-\|}', '\\cxfc ', t)
+    t = re.sub(r'{>}', '\\cxfls ', t)
+    t = re.sub(r'{ }', ' ', t)
+    t = re.sub(r'{&([^}]+)}', '{\\cxfing \\1}', t)
+    t = re.sub(r'{#([^}]+)}', '\\{#\\1\\}', t)
+    t = re.sub(r'{PLOVER:([a-zA-Z]+)}', '\\{PLOVER:\\1\\}', t)
+    t = re.sub(r'\\"', '"', t)
+    
+    return t
+    
+
 # TODO: test this
 def save_dictionary(d, fp):
     fp.write(HEADER)
 
     for s, t in d.items():
         s = '/'.join(s)
-        
-        t = re.sub(r'{\.}', '{\\cxp. }', t)
-        t = re.sub(r'{!}', '{\\cxp! }', t)
-        t = re.sub(r'{\?}', '{\\cxp? }', t)
-        t = re.sub(r'{\,}', '{\\cxp, }', t)
-        t = re.sub(r'{:}', '{\\cxp: }', t)
-        t = re.sub(r'{;}', '{\\cxp; }', t)
-        t = re.sub(r'{\^}', '\\cxds ', t)
-        t = re.sub(r'{\^([^^}]*)}', '\\cxds \\1', t)
-        t = re.sub(r'{([^^}]*)\^}', '\\1\\cxds ', t)
-        t = re.sub(r'{\^([^^}]*)\^}', '\\cxds \\1\\cxds ', t)
-        t = re.sub(r'{-\|}', '\\cxfc ', t)
-        t = re.sub(r'{>}', '\\cxfls ', t)
-        t = re.sub(r'{ }', ' ', t)
-        t = re.sub(r'{&([^}]+)}', '{\\cxfing \\1}', t)
-        t = re.sub(r'{#([^}]+)}', '\\{#\\1\\}', t)
-        t = re.sub(r'{PLOVER:([a-zA-Z]+)}', '\\{PLOVER:\\1\\}', t)
-        t = re.sub(r'\\"', '"', t)
-
+        t = format_translation(t)
         entry = "{\\*\\cxs %s}%s\r\n" % (s, t)
         fp.write(entry)
 

plover/dictionary/test_rtfcre_dict.py

@@ -1,11 +1,11 @@
 # Copyright (c) 2013 Hesky Fisher
 # See LICENSE.txt for details.
 
-from plover.steno_dictionary import StenoDictionary
-from rtfcre_dict import load_dictionary, TranslationConverter
+from plover.dictionary.rtfcre_dict import load_dictionary, TranslationConverter, format_translation, save_dictionary
 import mock
 import re
 import unittest
+from cStringIO import StringIO
 
 class TestCase(unittest.TestCase):
 
@@ -25,9 +25,12 @@ def test_converter(self):
         (r'\_', '-'),
         ('\\\r\n', '{#Return}{#Return}'),
         (r'\cxds', '{^}'),
+        (r'pre\cxds ', '{pre^}'),
+        (r'pre\cxds  ', '{pre^} '),
         (r'pre\cxds', '{pre^}'),
         (r'\cxds post', '{^post}'),
         (r'\cxds in\cxds', '{^in^}'),
+        (r'\cxds in\cxds ', '{^in^}'),
         (r'\cxfc', '{-|}'),
         (r'\cxfl', '{>}'),
         (r'pre\cxfl', 'pre{>}'),
@@ -74,6 +77,7 @@ def test_converter(self):
         (r'{\cxconf [{\cxc abc}|{\cxc def}]}', 'def'),
         (r'{\cxconf [{\cxc abc}|{\cxc def}|{\cxc ghi}]}', 'ghi'),
         (r'{\cxconf [{\cxc abc}|{\cxc {\cxp... }}]}', '{^... ^}'),
+        (r'be\cxds{\*\cxsvatdictentrydate\yr2006\mo5\dy10}', '{be^}'),
 
         (r'{\nonexistant {\cxp .}}', '{.}'),
         (r'{\*\nonexistant {\cxp .}}', ''),
@@ -172,8 +176,35 @@ def __call__(self, s):
                 expected = dict((normalize(k), convert(v)) 
                                 for k, v in expected.iteritems())
                 assertEqual(load_dictionary(make_dict(s)), expected)
-                
+
+    def test_format_translation(self):
+        cases = (
+        ('', ''),
+        ('{^in^}', '\cxds in\cxds '),
+        ('{pre^}', 'pre\cxds '),
+        ('{pre^} ', 'pre\cxds '),
+        ('{pre^}  ', 'pre\cxds ')
+        )
+        
+        failed = False
+        format_str = "format({}) != {}: {}"
+        for before, expected in cases:
+            result = format_translation(before)
+            if result != expected:
+                failed = True
+                print format_str.format(before, expected, result)
 
+        self.assertFalse(failed)
+        
+    def test_save_dictionary(self):
+        f = StringIO()
+        d = {
+        'S/T': '{pre^}',
+        }
+        save_dictionary(d, f)
+        expected = '{\\rtf1\\ansi{\\*\\cxrev100}\\cxdict{\\*\\cxsystem Plover}{\\stylesheet{\\s0 Normal;}}\n{\\*\\cxs S///T}pre\\cxds \r\n}\n' 
+        self.assertEqual(f.getvalue(), expected)
+
 
 if __name__ == '__main__':
     unittest.main()

plover/gui/paper_tape.py

@@ -152,6 +152,8 @@ def display(parent, config):
         StrokeDisplayDialog(parent, config)
 
 
+# This class exists solely so that the text doesn't get grayed out when the
+# window is not in focus.
 # This class exists solely so that the text doesn't get grayed out when the
 # window is not in focus.
 class MyStaticText(wx.PyControl):
@@ -233,7 +235,6 @@ def GetDefaultAttributes(self):
     def ShouldInheritColours(self):
         return True
 
-
 class fake_config(object):
     def __init__(self):
         self.on_top = True

plover/gui/serial_config.py

@@ -5,7 +5,7 @@
 """A graphical user interface for configuring a serial port."""
 
 from serial import Serial
-from serial.tools.list_ports import comports
+from plover.oslayer.comscan import comports
 import string
 import wx
 import wx.animate

plover/machine/base.py

@@ -157,7 +157,8 @@ def start_capture(self):
 
         try:
             self.serial_port = serial.Serial(**self.serial_params)
-        except serial.SerialException:
+        except serial.SerialException as e:
+            print e
             self._error()
             return
         if self.serial_port is None or not self.serial_port.isOpen():

plover/oslayer/comscan.py

@@ -0,0 +1,13 @@
+from serial.tools.list_ports import comports as serial_comports
+
+try:
+    from plover.oslayer.list_ports_posix import comports as alternative_comports
+except ImportError:
+    alternative_comports = lambda: []
+    
+def comports():
+    try:
+        return serial_comports()
+    except NameError:
+        # For some reason, the official release of pyserial 2.6 has a simple NameError in it :(
+        return alternative_comports()