- version 0.8.9.18 (0.9-beta15)

s-n-g · s-n-g · commit 6e8d8b10b6f5 · 2022-05-18T15:55:27.000+03:00
- implementing global functions for line editor
- updating docs
diff --git a/Changelog b/Changelog
@@ -1,11 +1,24 @@
+2022-05-18 s-n-g
+    * version 0.8.9.18 (0.9-beta15)
+    * changing shortcut w and ^W to e and ^E on the RadioBrowser
+      Search Window
+    * implementing global functions
+    * fixing a couple of bugs and crashes
+    * updating docs
+
 2022-04-29 s-n-g
-    * version 0.8.9.17 (0.9-beta13)
+    * version 0.8.9.17 (0.9-beta14)
     * adding Title's Log
     * changing versioning
-    * fixing user isntallation in build_install_pyradio
+    * fixing user installation in build_install_pyradio
     * fixing python2 main.py crash (#153)
     * updating docs
 
+2022-03-18 s-n-g (0.9-beta13)
+    * version 0.8.9.16 (0.9-beta13)
+    * fixing install.py script
+    * installing Start Menu Shortcut on Windows
+
 2022-03-15 s-n-g
     * version 0.8.9.15 (0.9-beta12)
     * fixing "0" and "$" insertion on RadioBrowser search window
diff --git a/README.html b/README.html
@@ -48,7 +48,10 @@ <h2 id="table-of-contents">Table of Contents <span style="padding-left: 10px;"><
 <li><a href="#changelog">Changelog</a></li>
 <li><a href="#installation">Installation</a></li>
 <li><a href="#command-line-options">Command line options</a></li>
-<li><a href="#controls">Controls</a></li>
+<li><a href="#controls">Controls</a>
+<ul>
+<li><a href="#global-shortcuts">Global shortcuts</a></li>
+</ul></li>
 <li><a href="#html-help">HTML help</a></li>
 <li><a href="#pyradio-modes">PyRadio Modes</a>
 <ul>
@@ -150,14 +153,27 @@ <h2 id="requirements">Requirements <span style="padding-left: 10px;"><sup style=
 <h2 id="changelog">Changelog <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
 <pre style="height: 200px;">
 
+2022-05-18 s-n-g
+    * version 0.8.9.18 (0.9-beta15)
+    * changing shortcut w and ^W to e and ^E on the RadioBrowser
+      Search Window
+    * implementing global functions
+    * fixing a couple of bugs and crashes
+    * updating docs
+
 2022-04-29 s-n-g
-    * version 0.8.9.17 (0.9-beta13)
+    * version 0.8.9.17 (0.9-beta14)
     * adding Title's Log
     * changing versioning
-    * fixing user isntallation in build_install_pyradio
+    * fixing user installation in build_install_pyradio
     * fixing python2 main.py crash (#153)
     * updating docs
 
+2022-03-18 s-n-g (0.9-beta13)
+    * version 0.8.9.16 (0.9-beta13)
+    * fixing install.py script
+    * installing Start Menu Shortcut on Windows
+
 2022-03-15 s-n-g
     * version 0.8.9.15 (0.9-beta12)
     * fixing "0" and "$" insertion on RadioBrowser search window
@@ -803,9 +819,46 @@ <h2 id="controls">Controls <span style="padding-left: 10px;"><sup style="font-si
 Esc/q             Quit                                             -                                  -
 Esc/q/Left/h      -                                                Cancel / close window              Cancel / close window</pre>
 <p>The same logic applies to all <strong>PyRadio</strong> windows.</p>
-<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> All windows - except the <em>Search window</em> - support changing the volume and muting / unmuting the player (provided that <strong>PyRadio</strong> is actually connected to a station).</p>
 <p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> When inserting numbers (either to jump to a station or to move a station), the number will be displayed at the right bottom corner of the window, suffixed by a “<em>G</em>”, i.e. pressing <em>35</em> will display <em>[35G]</em>.</p>
 <p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> When tagging a station position for a move action (by pressing “<strong>J</strong>”), the position will be displayed at the right bottom corner of the window, suffixed by a “<em>J</em>”, i.e. pressing “<em>J</em>” on position <em>35</em> will display <em>[35J]</em>.</p>
+<h3 id="global-shortcuts">Global shortcuts</h3>
+<p>Some of the functions provided by <strong>PyRadio</strong> will always be available to the user. These functions are:</p>
+<table>
+<thead>
+<tr class="header">
+<th>Shortcut</th>
+<th>Function</th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td><strong>+</strong>/<strong>-</strong> and <strong>,</strong>/<strong>.</strong></td>
+<td>adjust volume</td>
+</tr>
+<tr class="even">
+<td><strong>m</strong></td>
+<td>mute player</td>
+</tr>
+<tr class="odd">
+<td><strong>v</strong></td>
+<td>save volume</td>
+</tr>
+<tr class="even">
+<td><strong>T</strong></td>
+<td>toggle transparency</td>
+</tr>
+<tr class="odd">
+<td><strong>W</strong></td>
+<td>toggle titles logging</td>
+</tr>
+<tr class="even">
+<td><strong>w</strong></td>
+<td>like a station</td>
+</tr>
+</tbody>
+</table>
+<p>Every window in <strong>PyRadio</strong> will respect these shotrcuts, even the ones with a “<em>Press any key to…</em>” message.</p>
+<p>When focus is on a “<em>Line editor</em>”, all shortcuts will work when preceded by a “<strong>\</strong>”.</p>
 <h2 id="html-help">HTML help <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>While in <strong>PyRadio</strong> main window, one can open the HTML (offline) help using “<strong>\h</strong>”.</p>
 <p>This is just a helper function for windows users who cannot use the man pages, but is still available for all platforms.</p>
diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@ Ben Dowling - [https://github.com/coderholic](https://github.com/coderholic)
 * [Installation](#installation)
 * [Command line options](#command-line-options)
 * [Controls](#controls)
+    * [Global shortcuts](#global-shortcuts)
 * [HTML help](#html-help)
 * [PyRadio Modes](#pyradio-modes)
     * [Secondary Modes](#secondary-modes)
@@ -202,13 +203,28 @@ The following options can also be set in **PyRadio**'s [configuration file](#con
 
 The same logic applies to all **PyRadio** windows.
 
-**Note:** All windows - except the *Search window* - support changing the volume and muting / unmuting the player (provided that **PyRadio** is actually connected to a station).
-
 **Note:** When inserting numbers (either to jump to a station or to move a station), the number will be displayed at the right bottom corner of the window, suffixed by a "*G*", i.e. pressing *35* will display *[35G]*.
 
 **Note:** When tagging a station position for a move action (by pressing "**J**"), the position will be displayed at the right bottom corner of the window, suffixed by a "*J*", i.e. pressing "*J*" on position *35* will display *[35J]*.
 
 
+### Global shortcuts
+
+Some of the functions provided by **PyRadio** will always be available to the user. These functions are:
+
+| Shortcut                       |   Function            |
+|--------------------------------|-----------------------|
+| **\+**/**\-** and **,**/**\.** | adjust volume         |
+| **m**                          | mute player           |
+| **v**                          | save volume           |
+| **T**                          | toggle transparency   |
+| **W**                          | toggle titles logging |
+| **w**                          | like a station        |
+
+Every window in **PyRadio** will respect these shotrcuts, even the ones with a "*Press any key to...*" message.
+
+When focus is on a "*Line editor*", all shortcuts will work when preceded by a "**\\**".
+
 ## HTML help
 
 While in **PyRadio** main window, one can open the HTML (offline) help using "**\\h**".
diff --git a/pyradio.1 b/pyradio.1
@@ -134,15 +134,38 @@ Quit
 .P
 The same logic applies to all \fBPyRadio\fR windows.
 
-.IP \fBNote:
-All windows - except the \fISearch window\fR - support changing the volume and muting / unmuting the player (provided that \fBPyRadio\fR is actually connected to a station).
-
 .IP \fBNote:
 When inserting numbers (either to jump to a station or to move a station), the number will be displayed at the right bottom corner of the window, suffixed by a "\fIG\fR", i.e. pressing \fI35\fR will display \fI[35G]\fR.
 
 .IP \fBNote:
 When tagging a station position for a move action (by pressing "\fBJ\fR"), the position will be displayed at the right bottom corner of the window, suffixed by a "\fIJ\fR", i.e. pressing "\fIJ\fR" on position \fI35\fR will display \fI[35J]\fR.
 
+.IP \fBGlobal\ shortcuts\fR
+
+Some of the functions provided by \fBpyradio\fR will always be available to the user. These functions are:
+
+
+.RS 10
+
+.IP \fB+\fR/\fB-\fR\ and\ \fB,\fR/\fB.\fR
+adjust volume
+.IP \fBm\fR
+mute player
+.IP \fBv\fR
+save volume
+.IP \fBT\fR
+toggle transparency
+.IP \fBW\fR
+toggle titles logging
+.IP \fBw\fR
+like a station
+
+.RE
+.RS 7
+Every window in \fBpyradio\fR will respect these shotrcuts, even the ones with a “\fIPress any key to…\fR” message.
+
+When focus is on a \fBLine editor\fR, all shortcuts will work when preceded by a "\fI\\\fR".
+
 .SH Pyradio's Modes
 
 \fBPyRadio\fR has the following primary modes:
diff --git a/pyradio/__init__.py b/pyradio/__init__.py
@@ -1,6 +1,6 @@
 " pyradio -- Console radio player. "
 
-version_info = (0, 8, 9, 17)
+version_info = (0, 8, 9, 18)
 
 # Set it to True if new stations have been
 # added to the package's stations.csv
diff --git a/pyradio/browser.py b/pyradio/browser.py
@@ -401,8 +401,8 @@ def set_global_functions(self, global_functions):
             self._global_functions = dict(global_functions)
             if 't' in self._global_functions.keys():
                 del self._global_functions['t']
-            if 'T' in self._global_functions.keys():
-                del self._global_functions['T']
+            # if 'T' in self._global_functions.keys():
+            #     del self._global_functions['T']
 
     def stations(self, playlist_format=1):
         ''' Return stations' list (in PyRadio playlist format)
@@ -1401,7 +1401,8 @@ def do_search(self, parent=None, init=False):
                 parent=parent,
                 config=self.browser_config,
                 limit=self._default_max_number_of_results,
-                init=init
+                init=init,
+                global_functions=self._global_functions
             )
         self._search_win.set_search_history(
             self._default_search_history_index,
@@ -2284,11 +2285,14 @@ class RadioBrowserSearchWindow(object):
     _history_id = _selected_history_id = _default_history_id = 1
     _history = []
 
+    _global_functions = {}
+
     def __init__(self,
                  parent,
                  config,
                  limit=100,
-                 init=False
+                 init=False,
+                 global_functions=None
                  ):
         self._parent = parent
         self._cnf = config
@@ -2306,6 +2310,11 @@ def __init__(self,
         self._half_width = 0
         self._widgets = [ None ]
 
+        if global_functions is not None:
+            self._global_functions = dict(global_functions)
+            if 't' in self._global_functions.keys():
+                del self._global_functions['t']
+
     def __del__(self):
         for a_widget in self._widgets:
             # logger.error('DE deleting: {}'.format(a_widget))
@@ -2689,6 +2698,7 @@ def show(self, parent=None):
                     key_down_function_handler=self._focus_down))
                 self._widgets[-1].bracket = False
                 self._widgets[-1].use_paste_mode = True
+                self._widgets[-1].set_global_functions(self._global_functions)
                 #self._widgets[-1].string = self.captions[n]
 
             ''' limit - index = -3 '''
diff --git a/pyradio/config_window.py b/pyradio/config_window.py
@@ -27,7 +27,6 @@ def set_global_functions(global_functions):
         ret = dict(global_functions)
         if 't' in ret.keys():
             del ret['t']
-        del ret['T']
     return ret
 
 class PyRadioConfigWindow(object):
@@ -669,12 +668,15 @@ def __init__(self,
             edit_color=curses.color_pair(9),
             cursor_color=curses.color_pair(8),
             unfocused_color=curses.color_pair(5),
-            string_changed_handler=self._string_changed)
+            string_changed_handler=self._string_changed
+        )
         self._widgets[0].string = string
         self._widgets[0].bracket = False
         self._widgets[0]._use_paste_mode = True
+        self._widgets[0]._mode_changed = self._show_alternative_modes
+        self._widgets[0].set_global_functions(self._global_functions)
         ''' enables direct insersion of ? and \ '''
-        self._widgets[0]._paste_mode = True
+        self._widgets[0]._paste_mode = False
         self._line_editor = self._widgets[0]
 
         ''' add horizontal push buttons '''
@@ -691,6 +693,27 @@ def __init__(self,
         if not self._orig_string:
             self._widgets[1].enabled = False
 
+    def _show_alternative_modes(self):
+        if self._line_editor._paste_mode:
+            """ print paste mode is on on editor """
+            self._win.addstr(0, 18, '[', curses.color_pair(5))
+            self._win.addstr('Paste mode', curses.color_pair(4))
+            self._win.addstr(']    ', curses.color_pair(5))
+        else:
+            if self._line_editor.backslash_pressed:
+                """ print editor's flag """
+                # fix for python 2
+                #self._win.addstr(*lin[i], '[', curses.color_pair(5))
+                self._win.addstr(0, 18, '[', curses.color_pair(5))
+                self._win.addstr('Extra mode', curses.color_pair(4))
+                self._win.addstr(']', curses.color_pair(5))
+            else:
+                """ print cleared editor's flag """
+                # fix for python 2
+                #self._win.addstr(*lin[i], 15 * ' ', curses.color_pair(5))
+                self._win.addstr(0, 18, 15 * ' ', curses.color_pair(5))
+        self._win.refresh()
+
     def _string_changed(self):
         pass
 
@@ -741,6 +764,7 @@ def show(self):
 
         self._win.addstr(10 + step, 5, '?', curses.color_pair(4))
         self._win.addstr(10 + step, 23, 'Line editor help (in Line Editor).', curses.color_pair(5))
+        self._show_alternative_modes()
         self._win.refresh()
         self.refresh_win()
 
@@ -790,10 +814,7 @@ def keypress(self, char):
                 2: Display line editor help
         '''
         ret = 1
-        if chr(char) in self._global_functions.keys():
-            self._global_functions[chr(char)]()
-            return 1
-        elif char == ord('?') and self._focus > 0:
+        if char == ord('?') and self._focus > 0:
             return 2
         elif char in (curses.KEY_EXIT, 27, ord('q')) and \
                 self._focus > 0:
@@ -846,6 +867,9 @@ def keypress(self, char):
                 ''' cancel '''
                 self.edit_string = ''
                 ret = 0
+        elif chr(char) in self._global_functions.keys():
+            self._global_functions[chr(char)]()
+            return 1
 
         if ret == 1:
             self._update_focus()
@@ -1461,11 +1485,11 @@ def keypress(self, char):
                3 - Editor is visible
                4 - Editor exited
         '''
-        if chr(char) in self._global_functions.keys():
-            self._global_functions[chr(char)]()
-        elif self.editing == 0:
+        if self.editing == 0:
             ''' focus on players '''
-            if char in (9, ):
+            if chr(char) in self._global_functions.keys():
+                self._global_functions[chr(char)]()
+            elif char in (9, ):
                 if self._players[self.selection][1]:
                     self._switch_column()
                     self.refresh_selection()
@@ -1558,14 +1582,18 @@ def keypress(self, char):
                     self._parameter_editor = ExtraParametersEditor(
                         self._win,
                         self._cnf,
-                        string=self._extra._items[self._extra.selection])
+                        string=self._extra._items[self._extra.selection],
+                        global_functions=self._global_functions
+                    )
                     self.refresh_win()
                     return 3
                 elif ret == 5:
                     ''' add parameter '''
                     self._parameter_editor = ExtraParametersEditor(
                         self._win,
-                        self._cnf)
+                        self._cnf,
+                        global_functions=self._global_functions
+                    )
                     self.editing = 1
                     self.refresh_win()
                     return 3
diff --git a/pyradio/edit.py b/pyradio/edit.py
@@ -302,6 +302,7 @@ def _add_editors(self):
                 self._line_editor[ed].bracket = False
                 self._line_editor[ed]._mode_changed = self._show_alternative_modes
                 self._line_editor[ed].use_paste_mode = True
+                self._line_editor[ed].set_global_functions(self._global_functions)
 
     def show(self, item=None):
         self._win = None
@@ -808,6 +809,7 @@ def show(self):
                 unfocused_color=curses.color_pair(5),
                 string_changed_handler=self._string_changed)
             self._widgets[0].bracket = False
+            self._widgets[0].set_global_functions(self._global_functions)
         self._line_editor = self._widgets[0]
         # add copy checkbox
         if self._widgets[1] is None:
diff --git a/pyradio/radio.py b/pyradio/radio.py
diff --git a/pyradio/simple_curses_widgets.py b/pyradio/simple_curses_widgets.py
diff --git a/pyradio/window_stack.py b/pyradio/window_stack.py
