Version 0.8.1

Using backslash to insert "?" and "/" in line editor and updating docs

Author: s-n-g

Changelog

@@ -1,12 +1,16 @@
-2019-10-18 s-n-g
+2019-10-19 s-n-g
+    * Version 0.8.1
     * CJK Unified Ideographs supported by the line edittor
     * On python 2, trying to edit a station whose name contains
       non-ASCII characters is prohibited and will end up in
       displaying a relevant message
+    * Line editor: using backslash to insert "?" and "\"
     * Search term will not be lost when resizing the window
     * Fixing issues with presenting search history
+    * Themes now have a "Edit Cursor" field
 
 2019-09-08 s-n-g
+    * Version 0.8.0
     * Adding station editor ("a" and "A" to add a station, "e" to edit)
     * Line editor supports unlimited string length
     * Main help window separated to two pages (navigation with "n" / "p")

README.html

@@ -184,14 +184,21 @@ <h2 id="search-function">Search function <span style="padding-left: 10px;"><sup
 <p>The <em>Search Window</em> supports normal and extend editing and in session history.</p>
 <p>One can always get help by pressing the “<strong>?</strong>” key.</p>
 <p>After a search term has been successfully found (search is case insensitive), next occurrence can be obtained using the “<strong>n</strong>” key and previous occurrence can be obtained using the “<strong>N</strong>” key.</p>
-<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> <strong>Python 2</strong> users are confined in typing ASCII characters only.</p>
 <h2 id="line-editor">Line editor <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
 <p><strong>PyRadio</strong> “<em>Search function</em>” and “<em>Station edior</em>” use a <em>line editor</em> to permit typing and editing stations’ data.</p>
 <p>The <em>line editor</em> works both on <strong>Python 2</strong> and <strong>Python 3</strong>, but does not provide the same functionality for both versions:</p>
 <ul>
 <li>In <strong>Python 2</strong>, only ASCII characters can be inserted.</li>
 <li>In <strong>Python 3</strong>, no such restriction exists. Furthermore, using CJK characters is also supported.</li>
 </ul>
+<p>One can always display help by pressing “<strong>?</strong>”, but that pauses a drawback; one cannot actually have a “<strong>?</strong>” withing the string.</p>
+<p>To do that, one would have to use the backslash key “<strong>\</strong>” and then press “<strong>?</strong>”.</p>
+<p>To sum it all up:</p>
+<ol type="1">
+<li>Press “<strong>?</strong>” to get help.</li>
+<li>Press “<strong>\?</strong>” to get a “<strong>?</strong>”.</li>
+<li>Press “<strong>\\</strong>” to get a “<strong>\</strong>”.</li>
+</ol>
 <h3 id="cjk-characters-support">CJK characters support</h3>
 <p>The <em>line editor</em> supports the insertion of <a target="_blank" href="https://en.wikipedia.org/wiki/CJK_Unified_Ideographs">CJK Unified Ideographs</a>, as described on <a target="_blank" href="https://en.wikipedia.org/wiki/CJK_Unified_Ideographs_(Unicode_block)">CJK Unified Ideographs (Unicode block)</a> also known as URO, abbreviation of Unified Repertoire and Ordering. These characters, although encoded as a single code-point (character), actually take up a 2-character space, when rendered on the terminal.</p>
 <p>A depiction of the editor’s behavior can be seen at this image: <a target="_blank" href="https://members.hellug.gr/sng/pyradio/pyradio-editor.jpg">pyradio-editor.jpg</a>.</p>

README.md

@@ -222,8 +222,6 @@ One can always get help by pressing the "**?**" key.
 
 After a search term has been successfully found (search is case insensitive), next occurrence can be obtained using the "**n**" key and previous occurrence can be obtained using the "**N**" key.
 
-**Note:** **Python 2** users are confined in typing ASCII characters only.
-
 ## Line editor
 
 **PyRadio** "*Search function*" and "*Station edior*" use a *line editor* to permit typing and editing stations' data. 
@@ -234,6 +232,16 @@ The *line editor* works both on **Python 2** and **Python 3**, but does not prov
 * In **Python 2**, only ASCII characters can be inserted.
 * In **Python 3**, no such restriction exists. Furthermore, using CJK characters is also supported.
 
+One can always display help by pressing "**?**", but that pauses a drawback; one cannot actually have a "**?**" withing the string.
+
+To do that, one would have to use the backslash key "**\\**" and then press "**?**".
+
+To sum it all up:
+
+1. Press "**?**" to get help.
+2. Press "**\\?**" to get a "**?**".
+3. Press "**\\\\**" to get a "**\\**".
+
 ### CJK characters support
 
 The *line editor* supports the insertion of [CJK Unified Ideographs](https://en.wikipedia.org/wiki/CJK_Unified_Ideographs), as described on [CJK Unified Ideographs (Unicode block)](https://en.wikipedia.org/wiki/CJK_Unified_Ideographs_(Unicode_block)) also known as URO, abbreviation of Unified Repertoire and Ordering. These characters, although encoded as a single code-point (character), actually take up a 2-character space, when rendered on the terminal.

pyradio.1

@@ -239,13 +239,38 @@ One can always get help by pressing the "\fI?\fR" key.
 
 After a search term has been successfully found (search is case insensitive), next occurrence can be obtained using the "\fIn\fR" key and previous occurrence can be obtained using the "\fIN\fR" key.
 
-.IP \fBNote\fR
-\fBPython 2\fR users are confined in typing ASCII characters only.
+.SH LINE EDITOR
+
+\fBpyradio\fR "\fISearch function\fR" and "\fIStation edior\fR" use a \fIline editor\fR to permit typing and editing stations' data. 
+
+The \fIline editor\fR works both on \fBPython 2\fR and \fBPython 3\fR, but does not provide the same functionality for both versions:
+
+.RS 5
+.IP \fI*\fR 2
+In \fBPython 2\fR, only ASCII characters can be inserted.
+.IP \fI*\fR 2
+In \fBPython 3\fR, no such restriction exists.  Furthermore, using CJK characters is also supported.
+
+.RE
 
+.PP
+One can always display help by pressing "\fI?\fR", but that pauses a drawback; one cannot actually have a "\fI?\fR" withing the string.
 
-.SH CJK CHARACTERS SUPPORT
+To do that, one would have to use the backslash key "\fI\\\fR" and then press "\fI?\fR".
 
-The \fIline editor\fR supports the insertion of \fICJK Unified Ideographs [1]\fR, as described on \fICJK Unified Ideographs (Unicode block) [2]\fR, also known as URO, abbreviation of Unified Repertoire and Ordering. These characters, although encoded as a single code-point (character), actually take up a 2-character space, when rendered on the terminal.
+To sum it all up:
+
+.IP
+1. Press "\fI?\fR" to get help.
+.IP
+2. Press "\fI\\?\fR" to get a "\fI?\fR".
+.IP
+3. Press "\fI\\\\\fR" to get a "\fI\\\fR".
+
+.PP
+\fBCJK CHARACTERS SUPPORT\fR
+
+The \fIline editor\fR supports the insertion of \fICJK Unified Ideographs [1]\fR, as described on \fICJK Unified Ideographs (Unicode block) [2]\fR, also known as URO, abbreviation of Unified Repertoire and Ordering. These characters, although encoded as a single code-poin (character), actually take up a 2-character space, when rendered on the terminal.
 
 A depiction of the editor's behavior can be seen at this image:
 
@@ -266,17 +291,14 @@ There are three way to do that:
 
 .RS 5
 
-.IP 1.
+.IP 1. 3
 Press \fICtrl-U\fR or \fICtrl-D\fR to move the current station up or down.
-.IP 2.
+.IP 2. 3
 Type a station number and press \fICtrl-U\fR or \fICtrl-D\fR to move the current station there.
-.IP 3.
+.IP 3. 3
 Go to the position you want to move a station to, and press "\fIJ\fR". This will tag this position (making it the target of the move). Then go to the station you want to move and press \fICtrl-U\fR or \fICtrl-D\fR to move it there.
 
 
-
-
-
 .SH SPECIFYING STATIONS' ENCODING
 
 Normally, stations provide information about their status (including the title of the song playing, which \fBpyradio\fR displays) in Unicode (\fIutf-8\fR encoded). Therefore, \fBpyradio\fR will use \fIutf-8\fR to decode such data, by default.
@@ -553,7 +575,7 @@ Finally, include the file produced in your report.
 
 .RS 5
 
-.IP 1.
+.IP 1. 3
 \fBCJKwrap\fR (\fIhttps://gitlab.com/fgallaire/cjkwrap\fR) by Florent Gallaire - A library for wrapping and filling UTF-8 CJK text.
 
 .SH FILES

pyradio/__init__.py

@@ -1,6 +1,6 @@
 " pyradio -- Console radio player. "
 
-version_info = (0, 8, 0)
+version_info = (0, 8, 1)
 
 __version__ = version = '.'.join(map(str, version_info))
 __project__ = __name__

pyradio/radio.py

@@ -1164,6 +1164,7 @@ def _show_search_help(self):
             DEL|,|^D              |Delete character.
             Backspace|,|^H        |Backspace (delete previous character).
             Up|,|^P| / |Down|,|^N     |Get previous / next history item.
+            \\?| / |\\\\             |Insert a "|?|" or a "|\\|", respectively.
             Enter| / |Esc         |Perform / cancel search.
 
             |Managing player volume does not work in search mode.
@@ -1177,6 +1178,7 @@ def _show_search_help(self):
             DEL|,|^D              |Delete character.
             Backspace|,|^H        |Backspace (delete previous character).
             Up|,|^P| / |Down|,|^N     |Get previous / next history item.
+            \\?| / |\\\\             |Insert a "|?|" or a "|\\|", respectively.
             Enter| / |Esc         |Perform / cancel search.
 
             |Managing player volume does not work in search mode.

pyradio/simple_curses_widgets.py

@@ -107,6 +107,14 @@ class SimpleCursesLineEdit(object):
                    '[', ']', '{', '}', '|', '\\', '/',
                    )
 
+    """ True if backlash has been pressed """
+    _backslash = False
+
+    """ Behaviour of ? key regarding \
+        If True, display ? (\? to display help)
+        If False, display help """
+    _show_help_with_backslash = False
+
     def __init__(self, parent, width, begin_y, begin_x, **kwargs):
 
         self._parent_win = parent
@@ -211,6 +219,14 @@ def string(self, val):
         self._is_cjk()
         self._go_to_end()
 
+    @property
+    def show_help_with_backslash(self):
+        return self._show_help_with_backslash
+
+    @show_help_with_backslash.setter
+    def show_help_with_backslash(self, val):
+        self._show_help_with_backslash = val
+
     def _is_cjk(self):
         """ Check if string contains CJK characters.
             If string is empty reset history index """
@@ -652,6 +668,12 @@ def _clear_to_end_of_line(self):
             self._go_to_end()
             self._is_cjk()
 
+    def _can_show_help(self):
+        """ return not xor of two values
+            self._backslash , self._show_help_with_backslash """
+        return not ( (self._backslash and not self._show_help_with_backslash) or \
+                (not self._backslash and self._show_help_with_backslash) )
+
     def keypress(self, win, char):
         """
          returns:
@@ -692,22 +714,29 @@ def keypress(self, win, char):
                     self._previous_word()
                 return 1
 
-        if char in (ord('?'), ):
+        if char == 92 and not self._backslash:
+            self._backslash = True
+            return 1
+
+        elif char in (ord('?'), ) and self._can_show_help():
             # display help
             if logger.isEnabledFor(logging.DEBUG):
                 logger.debug('action: help')
             self.keep_restore_data()
+            self._backslash = False
             return 2
 
         elif char in (curses.KEY_ENTER, ord('\n'), ord('\r')):
             """ ENTER """
+            self._backslash = False
             if logger.isEnabledFor(logging.DEBUG):
                 logger.debug('action: enter')
             if self._has_history:
                 self._input_history.add_to_history(self._string)
             return 0
 
         elif char in (curses.KEY_EXIT, 27):
+            self._backslash = False
             if logger.isEnabledFor(logging.DEBUG):
                 logger.debug('action: ESCAPE')
             self._edit_win.nodelay(True)
@@ -750,48 +779,55 @@ def keypress(self, win, char):
 
         elif char in (curses.KEY_RIGHT, ):
             """ KEY_RIGHT """
+            self._backslash = False
             if self.string:
                 if logger.isEnabledFor(logging.DEBUG):
                     logger.debug('action: RIGHT')
             self._go_right()
 
         elif char in (curses.KEY_LEFT, ):
             """ KEY_LEFT """
+            self._backslash = False
             if self.string:
                 if logger.isEnabledFor(logging.DEBUG):
                     logger.debug('action: LEFT')
                 self._go_left()
 
         elif char in (curses.KEY_HOME, curses.ascii.SOH):
             """ KEY_HOME, ^A """
+            self._backslash = False
             if self.string:
                 if logger.isEnabledFor(logging.DEBUG):
                     logger.debug('action: HOME')
                 self._go_to_start()
 
         elif char in (curses.KEY_END, curses.ascii.ENQ):
             """ KEY_END, ^E """
+            self._backslash = False
             if self.string:
                 if logger.isEnabledFor(logging.DEBUG):
                     logger.debug('action: END')
                 self._go_to_end()
 
         elif char in (curses.ascii.ETB, ):
             """ ^W, clear to start of line """
+            self._backslash = False
             if self.string:
                 if logger.isEnabledFor(logging.DEBUG):
                     logger.debug('action: clear-to-end')
                 self._clear_to_start_of_line()
 
         elif char in (curses.ascii.VT, ):
             """ Ctrl-K - clear to end of line """
+            self._backslash = False
             if self.string:
                 if logger.isEnabledFor(logging.DEBUG):
                     logger.debug('action: clear-to-end')
                 self._clear_to_end_of_line()
 
         elif char in (curses.ascii.NAK, ):
             """ ^U, clear line """
+            self._backslash = False
             if logger.isEnabledFor(logging.DEBUG):
                 logger.debug('action: clear')
             self.string = self._displayed_string = ''
@@ -800,20 +836,23 @@ def keypress(self, win, char):
 
         elif char in (curses.KEY_DC, curses.ascii.EOT):
             """ DEL key, ^D """
+            self._backslash = False
             if self.string:
                 if logger.isEnabledFor(logging.DEBUG):
                     logger.debug('action: delete')
                 self._delete_char()
 
         elif char in (curses.KEY_BACKSPACE, curses.ascii.BS,127):
             """ KEY_BACKSPACE """
+            self._backslash = False
             if self.string:
                 if logger.isEnabledFor(logging.DEBUG):
                     logger.debug('action: backspace')
                 self._backspace_char()
 
         elif char in (curses.KEY_UP, curses.ascii.DLE):
             """ KEY_UP, ^N """
+            self._backslash = False
             if self._key_up_function_handler is not None:
                 try:
                     self._key_up_function_handler()
@@ -825,6 +864,7 @@ def keypress(self, win, char):
 
         elif char in (curses.KEY_DOWN, curses.ascii.SO):
             """ KEY_DOWN, ^P """
+            self._backslash = False
             if self._key_down_function_handler is not None:
                 try:
                     self._key_down_function_handler()
@@ -836,6 +876,7 @@ def keypress(self, win, char):
 
         elif char in (curses.KEY_NPAGE, ):
             """ PgDn """
+            self._backslash = False
             if self._key_pgdown_function_handler is not None:
                 try:
                     self._key_pgdown_function_handler()
@@ -847,6 +888,7 @@ def keypress(self, win, char):
 
         elif char in (curses.KEY_PPAGE, ):
             """ PgUp """
+            self._backslash = False
             if self._key_pgup_function_handler is not None:
                 try:
                     self._key_pgup_function_handler()
@@ -855,6 +897,7 @@ def keypress(self, win, char):
 
         elif char in (9, ):
             """ TAB """
+            self._backslash = False
             if self._key_tab_function_handler is not None:
                 try:
                     self._key_tab_function_handler()
@@ -866,6 +909,7 @@ def keypress(self, win, char):
 
         elif char in (curses.KEY_BTAB, ):
             """ Shift-TAB """
+            self._backslash = False
             if self._key_stab_function_handler is not None:
                 try:
                     self._key_stab_function_handler()
@@ -877,9 +921,11 @@ def keypress(self, win, char):
 
         elif 0<= char <=31:
             """ do not accept any other control characters """
+            self._backslash = False
             pass
 
         else:
+            self._backslash = False
             if logger.isEnabledFor(logging.DEBUG):
                 logger.debug('action: add-character')
             if self.log is not None: