side-vim 0.1.1__tar.gz → 0.2.0__tar.gz

{side_vim-0.1.1 → side_vim-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: side-vim
-Version: 0.1.1
+Version: 0.2.0
 Summary: Vim mode for PySide6's QPlainTextEdit
 Author: sprytnyk.dev
 License-Expression: MIT
@@ -59,9 +59,11 @@ Attach one `VimMode` per editor. Import `Mode` to compare `vim.mode` with
 | API | Behavior |
 | --- | --- |
 | `vim.mode_changed.connect(callback)` | Calls `callback(mode)` when the mode changes. |
-| `vim.pending_changed.connect(callback)` | Calls `callback(text)` with pending keys such as `2d`, or `""` when done. |
+| `vim.pending_changed.connect(callback)` | Calls `callback(text)` with pending keys such as `2d`, or `""` when done. Moving the focus to another widget drops pending keys, as a click in another window does in Vim. Switching apps or opening a menu keeps them. |
 | `vim.escape_hook = callback` | Calls `callback()` before handling Esc. Return `True` if the app used it, for example to close a popup. |
 | `vim.search_hook = callback` | `/` calls `callback(True)`; `?` calls `callback(False)`. The app opens its search UI. |
+| `vim.window_hook = callback` | `Ctrl+W` and one more key call `callback(key)`, such as `"h"` for `Ctrl+W h`. The app moves the focus, for example to a panel beside the editor. |
+| `vim.spell_hook = callback` | The spelling commands call `callback(command, count)`, such as `("z=", None)` or `("]s", 2)`. The app shows suggestions, moves the cursor or adds the word. |
 | `vim.set_search("rent", forward=True)` | Saves the search text and jumps to the next match. `n` repeats in that direction; `N` reverses it. |
 | `vim.normal()` | Goes to Normal mode as Esc does, from Insert or Visual mode. |
 | `vim.clipboard = True` | Uses the system clipboard for yank, delete, change and paste. Defaults to `False`. |
@@ -92,54 +94,82 @@ repeats the typed text: `3ix<Esc>` inserts `xxx`.
 | Insert | `i a I A o O` |
 | Delete, change, yank | `d c y` followed by a motion; `dd cc yy`, `x D C` |
 | Paste, join | `p P`, `J` |
+| Replace characters | `r` and a character: `3rx` turns three characters into `xxx` |
+| Switch case | `~`: `3~` turns `abc` into `ABC` and moves past it |
 | Undo, redo | `u`, `Ctrl+R` |
 | Select | `v` for characters, `V` for lines; motions extend the selection |
-| Edit a selection | `d c y x p`; `o` switches its ends |
+| Edit a selection | `d c y x p r ~`; `o` switches its ends |
 | Search | `/ ?` through the app hook, then `n N` |
 | Scroll a line | `Ctrl+E`, `Ctrl+Y` |
 | Scroll half a screen | `Ctrl+D`, `Ctrl+U` |
 | Scroll a screen | `Ctrl+F`, `Ctrl+B` |
 | Return to Normal | `Esc`, `Ctrl+[` |
+| Window command | `Ctrl+W` and a key, through the app hook |
+| Spelling | `z=`, `]s [s`, `zg zG`, through the app hook |
 
 In Normal and Visual modes, the Ctrl keys above take priority over app shortcuts.
 `j` and `k` keep the screen column across tabs and wide characters, and a wrapped
 line counts as one line, as in Vim.
 
+After `r`, Enter puts in a line break, and `Ctrl+E` or `Ctrl+Y` copy the
+characters below or above. `Ctrl+V` puts in the next key as it is, or a character
+code such as `065` or `u20ac`. `Ctrl+K` and two characters put in a
+[digraph](https://vimhelp.org/digraph.txt.html), such as `e:` for ë. Esc cancels
+`r`. These work as in Vim.
+
 This release has only the keys above. It has no repeat (`.`), text objects,
-`f t r ~`, colon commands, macros, marks, named registers or block selection.
+`f t`, `g~ gu gU`, colon commands, macros, marks, named registers or block
+selection.
 
 ## Differences from Vim
 
 side-vim follows Vim 9.1 with its default settings, except for these:
 
 - Joined emoji and flags, such as 👨‍👩‍👧 and 🇺🇦, are one character. Vim splits
-  them into their parts. Accents, CJK and single emoji work as in Vim.
+  them into their parts. Accents, CJK and single emoji work as in Vim, except
+  that `r Ctrl+E` and `r Ctrl+Y` copy an accented letter made of two code points
+  whole. Vim copies it without the accent.
+- Qt turns a carriage return into a line break, so `r` can't put one in. Vim
+  puts one in for `r Ctrl+V Enter`, and for Enter after `r` in Visual mode.
+  side-vim does nothing there, and Visual mode keeps its selection.
+- After `r Ctrl+V` and part of a code, such as `r Ctrl+V 6`, a key with no
+  character, such as an arrow, ends the code. Vim then also runs that key as a
+  command, but side-vim drops it.
 - Search uses plain text, not regular expressions. There is no command line.
   `/` and `?` call `search_hook`, then the app shows its own search box and
   passes the text to `set_search`.
+- side-vim has no windows. `Ctrl+W` and the key after it go to `window_hook`,
+  and the app decides what they do. `Ctrl+W Ctrl+H` and `Ctrl+W Left` arrive as
+  `h`, as in Vim. It works only in Normal mode, and the hook gets no count.
+- side-vim has no spell checker. `z=`, `]s`, `[s`, `zg` and `zG` go to
+  `spell_hook` with their count, and the app finds the words and shows the
+  suggestions. They work only in Normal mode. `]s` and `[s` aren't motions, so
+  `d]s` does nothing. side-vim doesn't have `zw`, `zW` or `zug`.
 - `J` puts one space after a period, like Vim with `nojoinspaces`. Vim's default
   puts two.
 - Qt stops scrolling when the last line reaches the bottom of the editor. Vim
   scrolls on until the last line is at the top, so `Ctrl+F` and `Ctrl+E` stop
   sooner near the end. The cursor still goes to the line Vim picks.
-- In Insert mode the editor handles every key except Esc and `Ctrl+[`. Arrows,
-  Backspace and app shortcuts work as in any Qt editor. Vim's Insert mode keys,
-  such as `Ctrl+W`, `Ctrl+U` and `Ctrl+O`, are not there.
+- In Insert mode, Esc and `Ctrl+[` go back to Normal mode. Every other key goes
+  to the editor, so arrows, Backspace and app shortcuts work as in any Qt
+  editor. side-vim doesn't have Vim's Insert mode keys, such as `Ctrl+W`,
+  `Ctrl+U` and `Ctrl+O`.
 - In Normal and Visual modes, Ctrl keys that side-vim doesn't use go to the
   editor or the app, and so do PageUp, PageDown and the function keys. `Ctrl+A`
   selects all, for example. Qt's keys that change the text do nothing in these
   modes: paste, cut, `Ctrl+Backspace` and `Ctrl+Delete`. In Vim, `Ctrl+V` starts
   a block selection, which side-vim doesn't have.
 - Other keys without a command do nothing in Normal mode. They never type text.
-- Esc in Normal mode with nothing pending goes to the app, for example to close a
-  dialog. Vim beeps.
+- In Normal mode, an Esc with nothing pending goes to the app, so it can close a
+  dialog, for example. Vim does nothing with that Esc except ring its error bell.
 - A read-only editor allows movement, scrolling, selection, yank and search, and
   ignores edits. Vim only warns when you change a read-only file.
 - Dragging with the mouse in Normal mode starts Visual mode.
 - Outside Insert mode, Ukrainian letters work as the Latin keys in the same
   place, so `ц` is `w`. Vim needs `langmap` for that. Punctuation stays as typed,
   `ґ` isn't mapped because its key moves between layout variants, and `/` needs
-  the English layout.
+  the English layout. The character after `r` is text, so `кц` puts in ц, as
+  `langmap` does in Vim.
 - On macOS, Ctrl means the physical Control key. Command shortcuts stay with the
   app.
 - The tab width comes from the editor's tab stop, not from a `tabstop` setting.
@@ -155,6 +185,7 @@ make check     # Ruff and pytest
 make format    # Format Python
 make record    # Record expected results using local Vim
 make unicode   # Regenerate Vim character classes and widths
+make digraphs  # Regenerate Vim digraphs
 make mac-keys  # Key checks on a Mac
 ```
 

{side_vim-0.1.1 → side_vim-0.2.0}/README.md

@@ -47,9 +47,11 @@ Attach one `VimMode` per editor. Import `Mode` to compare `vim.mode` with
 | API | Behavior |
 | --- | --- |
 | `vim.mode_changed.connect(callback)` | Calls `callback(mode)` when the mode changes. |
-| `vim.pending_changed.connect(callback)` | Calls `callback(text)` with pending keys such as `2d`, or `""` when done. |
+| `vim.pending_changed.connect(callback)` | Calls `callback(text)` with pending keys such as `2d`, or `""` when done. Moving the focus to another widget drops pending keys, as a click in another window does in Vim. Switching apps or opening a menu keeps them. |
 | `vim.escape_hook = callback` | Calls `callback()` before handling Esc. Return `True` if the app used it, for example to close a popup. |
 | `vim.search_hook = callback` | `/` calls `callback(True)`; `?` calls `callback(False)`. The app opens its search UI. |
+| `vim.window_hook = callback` | `Ctrl+W` and one more key call `callback(key)`, such as `"h"` for `Ctrl+W h`. The app moves the focus, for example to a panel beside the editor. |
+| `vim.spell_hook = callback` | The spelling commands call `callback(command, count)`, such as `("z=", None)` or `("]s", 2)`. The app shows suggestions, moves the cursor or adds the word. |
 | `vim.set_search("rent", forward=True)` | Saves the search text and jumps to the next match. `n` repeats in that direction; `N` reverses it. |
 | `vim.normal()` | Goes to Normal mode as Esc does, from Insert or Visual mode. |
 | `vim.clipboard = True` | Uses the system clipboard for yank, delete, change and paste. Defaults to `False`. |
@@ -80,54 +82,82 @@ repeats the typed text: `3ix<Esc>` inserts `xxx`.
 | Insert | `i a I A o O` |
 | Delete, change, yank | `d c y` followed by a motion; `dd cc yy`, `x D C` |
 | Paste, join | `p P`, `J` |
+| Replace characters | `r` and a character: `3rx` turns three characters into `xxx` |
+| Switch case | `~`: `3~` turns `abc` into `ABC` and moves past it |
 | Undo, redo | `u`, `Ctrl+R` |
 | Select | `v` for characters, `V` for lines; motions extend the selection |
-| Edit a selection | `d c y x p`; `o` switches its ends |
+| Edit a selection | `d c y x p r ~`; `o` switches its ends |
 | Search | `/ ?` through the app hook, then `n N` |
 | Scroll a line | `Ctrl+E`, `Ctrl+Y` |
 | Scroll half a screen | `Ctrl+D`, `Ctrl+U` |
 | Scroll a screen | `Ctrl+F`, `Ctrl+B` |
 | Return to Normal | `Esc`, `Ctrl+[` |
+| Window command | `Ctrl+W` and a key, through the app hook |
+| Spelling | `z=`, `]s [s`, `zg zG`, through the app hook |
 
 In Normal and Visual modes, the Ctrl keys above take priority over app shortcuts.
 `j` and `k` keep the screen column across tabs and wide characters, and a wrapped
 line counts as one line, as in Vim.
 
+After `r`, Enter puts in a line break, and `Ctrl+E` or `Ctrl+Y` copy the
+characters below or above. `Ctrl+V` puts in the next key as it is, or a character
+code such as `065` or `u20ac`. `Ctrl+K` and two characters put in a
+[digraph](https://vimhelp.org/digraph.txt.html), such as `e:` for ë. Esc cancels
+`r`. These work as in Vim.
+
 This release has only the keys above. It has no repeat (`.`), text objects,
-`f t r ~`, colon commands, macros, marks, named registers or block selection.
+`f t`, `g~ gu gU`, colon commands, macros, marks, named registers or block
+selection.
 
 ## Differences from Vim
 
 side-vim follows Vim 9.1 with its default settings, except for these:
 
 - Joined emoji and flags, such as 👨‍👩‍👧 and 🇺🇦, are one character. Vim splits
-  them into their parts. Accents, CJK and single emoji work as in Vim.
+  them into their parts. Accents, CJK and single emoji work as in Vim, except
+  that `r Ctrl+E` and `r Ctrl+Y` copy an accented letter made of two code points
+  whole. Vim copies it without the accent.
+- Qt turns a carriage return into a line break, so `r` can't put one in. Vim
+  puts one in for `r Ctrl+V Enter`, and for Enter after `r` in Visual mode.
+  side-vim does nothing there, and Visual mode keeps its selection.
+- After `r Ctrl+V` and part of a code, such as `r Ctrl+V 6`, a key with no
+  character, such as an arrow, ends the code. Vim then also runs that key as a
+  command, but side-vim drops it.
 - Search uses plain text, not regular expressions. There is no command line.
   `/` and `?` call `search_hook`, then the app shows its own search box and
   passes the text to `set_search`.
+- side-vim has no windows. `Ctrl+W` and the key after it go to `window_hook`,
+  and the app decides what they do. `Ctrl+W Ctrl+H` and `Ctrl+W Left` arrive as
+  `h`, as in Vim. It works only in Normal mode, and the hook gets no count.
+- side-vim has no spell checker. `z=`, `]s`, `[s`, `zg` and `zG` go to
+  `spell_hook` with their count, and the app finds the words and shows the
+  suggestions. They work only in Normal mode. `]s` and `[s` aren't motions, so
+  `d]s` does nothing. side-vim doesn't have `zw`, `zW` or `zug`.
 - `J` puts one space after a period, like Vim with `nojoinspaces`. Vim's default
   puts two.
 - Qt stops scrolling when the last line reaches the bottom of the editor. Vim
   scrolls on until the last line is at the top, so `Ctrl+F` and `Ctrl+E` stop
   sooner near the end. The cursor still goes to the line Vim picks.
-- In Insert mode the editor handles every key except Esc and `Ctrl+[`. Arrows,
-  Backspace and app shortcuts work as in any Qt editor. Vim's Insert mode keys,
-  such as `Ctrl+W`, `Ctrl+U` and `Ctrl+O`, are not there.
+- In Insert mode, Esc and `Ctrl+[` go back to Normal mode. Every other key goes
+  to the editor, so arrows, Backspace and app shortcuts work as in any Qt
+  editor. side-vim doesn't have Vim's Insert mode keys, such as `Ctrl+W`,
+  `Ctrl+U` and `Ctrl+O`.
 - In Normal and Visual modes, Ctrl keys that side-vim doesn't use go to the
   editor or the app, and so do PageUp, PageDown and the function keys. `Ctrl+A`
   selects all, for example. Qt's keys that change the text do nothing in these
   modes: paste, cut, `Ctrl+Backspace` and `Ctrl+Delete`. In Vim, `Ctrl+V` starts
   a block selection, which side-vim doesn't have.
 - Other keys without a command do nothing in Normal mode. They never type text.
-- Esc in Normal mode with nothing pending goes to the app, for example to close a
-  dialog. Vim beeps.
+- In Normal mode, an Esc with nothing pending goes to the app, so it can close a
+  dialog, for example. Vim does nothing with that Esc except ring its error bell.
 - A read-only editor allows movement, scrolling, selection, yank and search, and
   ignores edits. Vim only warns when you change a read-only file.
 - Dragging with the mouse in Normal mode starts Visual mode.
 - Outside Insert mode, Ukrainian letters work as the Latin keys in the same
   place, so `ц` is `w`. Vim needs `langmap` for that. Punctuation stays as typed,
   `ґ` isn't mapped because its key moves between layout variants, and `/` needs
-  the English layout.
+  the English layout. The character after `r` is text, so `кц` puts in ц, as
+  `langmap` does in Vim.
 - On macOS, Ctrl means the physical Control key. Command shortcuts stay with the
   app.
 - The tab width comes from the editor's tab stop, not from a `tabstop` setting.
@@ -143,6 +173,7 @@ make check     # Ruff and pytest
 make format    # Format Python
 make record    # Record expected results using local Vim
 make unicode   # Regenerate Vim character classes and widths
+make digraphs  # Regenerate Vim digraphs
 make mac-keys  # Key checks on a Mac
 ```
 

{side_vim-0.1.1 → side_vim-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "side-vim"
-version = "0.1.1"
+version = "0.2.0"
 description = "Vim mode for PySide6's QPlainTextEdit"
 readme = "README.md"
 license = "MIT"

{side_vim-0.1.1 → side_vim-0.2.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "side-vim"
-version = "0.1.1"
+version = "0.2.0"
 description = "Vim mode for PySide6's QPlainTextEdit"
 readme = "README.md"
 license = "MIT"