added vim bindings

Author: sudormrfbin

CHANGELOG.md

@@ -1,10 +1,10 @@
 CHANGELOG
 =========
 
-v0.7.0
+v0.6.3
 ------
 
-- [ ] Vi keybindings
+- [x] Vi keybindings
 - [x] Added option for smooth scroll
 - [x] Preferences are now saved when updating the app
 - [x] Validators for smooth_scroll and preview_format

clid.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: clid
-Version: 0.6.2
+Version: 0.6.3
 Summary: Command line app based on ncurses to edit ID3 tags of mp3 files
 Home-page: https://github.com/GokulSoumya/clid
 Author: Gokul

clid/NEW.txt

@@ -1,9 +1,10 @@
-v0.7.0
+v0.6.3
 ------
 
-- Vi keybindings
+- This is ;)
 - Added option for smooth scroll
+- Vim keybindings(disabled by default)
 - Preferences are now saved when updating the app
-- Validators for smooth_scroll and preview_format
-- Display a "What's New" Popup when app is run after an update
 
+
+Note: Escape key tends to be a little slow, probably a bug in npyscreen, when in Vim mode

clid/base.py

@@ -22,19 +22,87 @@ def change_setting(self, command_line, widget_proxy, live):
         """Change a setting in the ini file"""
         pass   # different for main and pref view; defined in respective files
 
+
 class ClidTextfield(npy.wgtextbox.Textfield):
+    """Normal textbox with home and end keys working"""
     def set_up_handlers(self):
         super().set_up_handlers()
         self.handlers[curses.KEY_END] = self.h_end
         self.handlers[curses.KEY_HOME] = self.h_home
 
-    def h_home(self, char):
+    def h_home(self, input):
         self.cursor_position = 0
 
-    def h_end(self, char):
+    def h_end(self, input):
         self.cursor_position = len(self.value)
 
 
+class ClidVimTextfield(ClidTextfield):
+    """Textfield class to be used as input boxes for tag fields when editing tags
+       if vim mode is enabled.
+    """
+    def __init__(self, *args, **kwargs):
+        self.vim_handlers = {
+            # movement
+            'k': self.h_exit_up,
+            'j': self.h_exit_down,
+            'h': self.h_cursor_left,
+            'l': self.h_cursor_right,
+            curses.ascii.SP: self.h_cursor_right,   # Space
+            curses.KEY_BACKSPACE: self.h_cursor_left,
+            # deletion
+            'X': self.h_delete_left,
+            'x': self.h_delete_right,
+            # insert chars
+            'i': self.h_vim_insert_mode,
+            'a': self.h_vim_append_char,
+            'A': self.h_vim_append_char_at_end,
+        }
+        super().__init__(*args, **kwargs)   # set_up_handlers is called in __init__
+
+    def vim_add_handlers(self):
+        """Add vim keybindings to list of keybindings"""
+        self.add_handlers(self.vim_handlers)
+
+    def vim_remove_handlers(self):
+        """Remove vim keybindings from list of keybindings"""
+        for handler in self.vim_handlers:
+            del self.handlers[handler]
+        self.handlers[curses.KEY_BACKSPACE] = self.h_delete_left   # else nothing will happen
+
+    def set_up_handlers(self):
+        super().set_up_handlers()
+        self.vim_add_handlers()
+        self.handlers[curses.ascii.ESC] = self.h_vim_normal_mode   # is a bit slow
+
+    def h_addch(self, input):
+        if self.parent.in_insert_mode:   # add characters only if in insert mode
+            super().h_addch(input)
+
+    def h_vim_insert_mode(self, input):
+        """Enter insert mode"""
+        self.parent.in_insert_mode = True
+        self.vim_remove_handlers()   # else `k`, j`, etc will not be added to text(will still act as keybindings)
+
+    def h_vim_normal_mode(self, input):
+        """Exit insert mode by pressing Esc"""
+        self.parent.in_insert_mode = False
+        self.cursor_position -= 1   # just like in vim
+        self.vim_add_handlers()   # removed earlier when going to insert mode
+
+    def h_vim_append_char(self, input):
+        """Append characters, like `a` in vim"""
+        self.h_vim_insert_mode(input)
+        self.cursor_position += 1
+
+    def h_vim_append_char_at_end(self, input):
+        """Add characters to the end of the line, like `A` in vim"""
+        self.h_vim_insert_mode(input)
+        self.h_end(input)   # go to the end
+
+class ClidVimTitleText(npy.TitleText):
+    _entry_type = ClidVimTextfield
+
 class ClidTitleText(npy.TitleText):
     _entry_type = ClidTextfield
 

clid/config.ini

@@ -1,3 +1,4 @@
 music_dir = ~/Music
-smooth_scroll = true
 preview_format = %a - %l - %n. %t 
+smooth_scroll = true
+vim_mode = false

clid/database.py

@@ -125,7 +125,7 @@ def make_strings(self):
            in the editing window
         """
         # number of characters after which value of an option is displayed
-        max_length = len(max(self.settings.keys())) + 3   # +3 is just to beautify
+        max_length = len(max(self.settings.keys(), key=len)) + 3   # +3 is just to beautify
         self.disp_strings = []
 
         for key, value in self.settings.items():
@@ -169,11 +169,15 @@ def __init__(self, main_form, settings):
         self.settings = settings
         self.main_form = main_form
         self.when_changed = {
+            'vim_mode': self.vim_mode,
             'music_dir': self.music_dir,
             'smooth_scroll': self.smooth_scroll,
             'preview_format': self.preview_format
         }
 
+    def vim_mode(self):
+        pass   # doesn't need anything
+
     def music_dir(self):
         self.main_form.value.load_files_and_set_values()
         self.main_form.load_files()

clid/editmeta.py

@@ -8,13 +8,31 @@
 import stagger
 import npyscreen as npy
 
+from . import base
 from . import _const
-from .base import ClidTitleText
 
 
 class EditMeta(npy.ActionFormV2):
-    """Edit the metadata of a track"""
+    """Edit the metadata of a track.
+
+       Attributes:
+            in_insert_mode(bool):
+                Used to decide whether the form is in insert/normal
+                mode(if vi_keybindings are enabled). This is actually
+                set as an attribute of the parent form so that all
+                text boxes in the form are in the same mode.
+    """
+
+    def __init__(self, *args, **kwags):
+        super().__init__(*args, **kwags)
+        self.in_insert_mode = False
+
     def create(self):
+        # error if placed in __init__
+        self.TEXTBOX = base.ClidVimTitleText \
+                if self.parentApp.settings['vim_mode'] == 'true'\
+                else base.ClidTitleText   # vim keybindings if enabled
+
         self.file = self.parentApp.current_file
         try:
             self.meta = stagger.read_tag(self.file)
@@ -27,23 +45,23 @@ def create(self):
             self.meta.album = ''   # revert what was just done
             self.meta.write()
 
-        self.tit = self.add(ClidTitleText, name='Title', value=self.meta.title)
+        self.tit = self.add(self.TEXTBOX, name='Title', value=self.meta.title)
         self.nextrely += 1
-        self.alb = self.add(ClidTitleText, name='Album', value=self.meta.album)
+        self.alb = self.add(self.TEXTBOX, name='Album', value=self.meta.album)
         self.nextrely += 1
-        self.art = self.add(ClidTitleText, name='Artist', value=self.meta.artist)
+        self.art = self.add(self.TEXTBOX, name='Artist', value=self.meta.artist)
         self.nextrely += 1
-        self.ala = self.add(ClidTitleText, name='Album Artist', value=self.meta.album_artist)
+        self.ala = self.add(self.TEXTBOX, name='Album Artist', value=self.meta.album_artist)
         self.nextrely += 2
 
-        self.gen = self.add(ClidTitleText, name='Genre', value=self.resolve_genre(self.meta.genre))
+        self.gen = self.add(self.TEXTBOX, name='Genre', value=self.resolve_genre(self.meta.genre))
         self.nextrely += 1
-        self.dat = self.add(ClidTitleText, name='Date/Year', value=self.meta.date)
+        self.dat = self.add(self.TEXTBOX, name='Date/Year', value=self.meta.date)
         self.nextrely += 1
-        self.tno = self.add(ClidTitleText, name='Track Number',
+        self.tno = self.add(self.TEXTBOX, name='Track Number',
                             value=str(self.meta.track if self.meta.track != 0 else ''))
         self.nextrely += 2
-        self.com = self.add(ClidTitleText, name='Comment', value=self.meta.comment)
+        self.com = self.add(self.TEXTBOX, name='Comment', value=self.meta.comment)
 
     def set_up_handlers(self):
         super().set_up_handlers()

clid/main.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-__version__ = '0.6.2'
+__version__ = '0.6.3'
 
 import os
 import curses

clid/validators.py

@@ -13,6 +13,15 @@ class ValidationError(Exception):
     """Raised when validation fails"""
     pass
 
+
+def true_or_false(test):
+    """Checks whether test is either 'true' or 'false'
+       Used by other functions.
+    """
+    if not(test == 'true' or test == 'false'):
+        raise ValidationError('Acceptable values are "true" or "false"("' + test +  '" is not valid)')
+
+
 def music_dir(test):
     """Checks whether `test` exists and is a directory.
        Args:
@@ -41,15 +50,9 @@ def preview_format(test):
             raise ValidationError('"' + spec + '"' + ' is not a valid format specifier')
 
 
-def smooth_scroll(test):
-    """Checks whether test is either 'true' or 'false'"""
-    if not(test == 'true' or test == 'false'):
-        raise ValidationError('Sorry, but I can\'t make sense of ' + '"' +  test + '"' + '; \
-        acceptable values for smooth_scroll are "true" or "false"')
-
-
 VALIDATORS = {
     'music_dir': music_dir,
-    'preview_format': preview_format,
-    'smooth_scroll': smooth_scroll
+    'vim_mode': true_or_false,
+    'smooth_scroll': true_or_false,
+    'preview_format': preview_format
 }