[nongnu] elpa/devil a955bcbf1b: Translate ", m" to "M-" and ", m m" to "C-M-"

[ELPA Syncer]

branch: elpa/devil
commit a955bcbf1b193cb2e3449ed54c493a31126a3b74
Author: Susam Pal <susam@susam.net>
Commit: Susam Pal <susam@susam.net>

    Translate ", m" to "M-" and ", m m" to "C-M-"
---
 CHANGES.org    |  23 +++++++++
 MANUAL.org     | 161 ++++++++++++++++++++++++++++-----------------------------
 Makefile       |   5 +-
 README.org     |  16 +++---
 devil-tests.el |  33 ++++++------
 devil.el       |  22 ++++----
 6 files changed, 141 insertions(+), 119 deletions(-)

diff --git a/CHANGES.org b/CHANGES.org
index 902a28fb7e..eda71d4fd7 100644
--- a/CHANGES.org
+++ b/CHANGES.org
@@ -2,6 +2,29 @@
 
 * Changelog
 
+** Version 0.6.0 (UNRELEASED)
+:PROPERTIES:
+:CUSTOM_ID: 0.6.0
+:END:
+
+*** Changed
+
+- Devil key sequence =, m= now translates to =M-= instead of =C-M-=.
+- Devil key sequence =, m z= now translates to =M-= instead of =C-M-=.
+- Devil key sequence =, m ,= now translates to =M-,= instead of =C-M-,=.
+- Devil key sequence =, m m= now translates to =C-M-= instead of =M-=.
+- Repeatable key sequence =, m m f= changed to =, m f=.
+- Repeatable key sequence =, m m b= changed to =, m b=.
+- Repeatable key sequence =, m m y= changed to =, m y=.
+- Repeatable key sequence =, m m ^= changed to =, m ^=.
+
+*** Removed
+
+- Devil key translation from =m z= to =M-=.
+- Devil key translation from =m m= to =m=.
+- Devil key translation from =m= to =M-=.
+
+
 ** Version 0.5.0 (2023-06-15)
 :PROPERTIES:
 :CUSTOM_ID: 0.5.0
diff --git a/MANUAL.org b/MANUAL.org
index 8700d5ffed..0eaffd5331 100644
--- a/MANUAL.org
+++ b/MANUAL.org
@@ -19,7 +19,7 @@ here.  Welcome, instead, to the realm of the Devil!  You will 
be
 granted the occasional use of the comma key for punctuation, but only
 if you can charm the Devil.  But beware, for in this sinister domain,
 you must relinquish your comma key and embrace an editing experience
-that whispers wicked secrets into your fingertips.
+that whispers wicked secrets into your fingertips!
 
 * Introduction
 :PROPERTIES:
@@ -115,7 +115,9 @@ following steps:
    the corresponding command.
 
 ** Install Automatically from MELPA
-
+:PROPERTIES:
+:CUSTOM_ID: install-automatically-from-melpa
+:END:
 Here is yet another basic way to install and enable Devil using Elisp:
 
 #+begin_src elisp
@@ -193,12 +195,12 @@ Devil may be used:
 5. Type =, s= and watch Devil translate it to =C-s= and invoke
    incremental search.
 
-6. Type =, m s= and watch Devil translate it to =C-M-s= and invoke
-   regular-expression-based incremental search.  Yes, =m= is
-   translated to =M-=.
+6. Type =, m x= and watch Devil translate it to =M-x= and invoke the
+   corresponding command.  Yes, =, m= is translated to =M-=.
 
-7. Type =, m m x= and watch Devil translate it to =M-x= and invoke the
-   corresponding command.
+7. Type =, m m s= and watch Devil translate it to =C-M-s= and invoke
+   regular-expression-based incremental search.  The key sequence =, m
+   m= is translated to =C-M-=.
 
 8. Type =, u , f= and watch Devil translate it to =C-u C-f= and move
    the cursor forward by 4 characters.
@@ -230,7 +232,7 @@ Devil may be used:
     key sequence =, x , f= and Devil will display the documentation of
     the function invoked by this Devil key sequence.  Note: The key
     sequence =, h k= translates to =C-h k= and invokes the vanilla
-    =describe=key=.  It is the Devil key sequence =, h , k= that
+    =describe-key=.  It is the Devil key sequence =, h , k= that
     invokes =devil-describe-key=.
 
 * Typing Commas
@@ -340,17 +342,17 @@ the user to an Emacs key sequence:
 3. If the simple string based replacement discussed in the previous
    point leads to an invalid Emacs key sequence, it skips the
    replacement that causes the resulting Emacs key sequence to become
-   invalid.  For example =, m ,= results in =C-M-C-= after the simple
-   string replacement because the default translation rules replace
-   =,= with =C-= and =m= with =M-=.  However, =C-M-C-= is an invalid
-   key sequence, so the replacement of the second =,= to =C-= is
-   skipped.  Therefore, the input =, m ,= is translated to =C-M-,=
-   instead.
+   invalid.  For example =, m m ,= results in =C-M-C-= after the
+   simple string replacement because the default translation rules
+   replace the leading =, m m= with =C-M-= and the trailing =,= with
+   =C-=.  However, =C-M-C-= is an invalid key sequence, so the
+   replacement of the trailing =,= to =C-= is skipped.  Therefore, the
+   input =, m m ,= is translated to =C-M-,= instead.
 
 4. Finally, Devil looks for key chords in the key sequence that
    contain both the =C-= modifier and an uppercase letter.  If such a
    key chord occurs, then it replaces the uppercase letter with its
-   shifted form, e.g., =, m V= first translates to =C-M-V= according
+   shifted form, e.g., =, m m V= first translates to =C-M-V= according
    to the previous points and then the result is translated to
    =C-M-S-v= according to this point.
 
@@ -367,19 +369,18 @@ more peculiar translations come later in the table.  The 
concluding
 paragraph of this subsection offers a guide on how to gradually and
 gently adopt these key sequences into your daily routine.
 
-| Input       | Translated | Remarks                           |
-|-------------+------------+-----------------------------------|
-| =, s=       | =C-s=      | =,= is replaced with =C-=         |
-| =, m s=     | =C-M-s=    | =m= is replaced with =M-=         |
-| =, m m x=   | =M-x=      | =, m m= is replaced with =M-= too |
-| =, [ x=     | =C-[ x=    | equivalent to =M-x=               |
-| =, c , ,=   | =C-c ,=    | =, ,= is replaced with =,=        |
-| =, c m m=   | =C-c m=    | =m m= is replaced with =m=        |
-| =, z SPC=   | =C-SPC=    | =, z= is replaced with =C-= too   |
-| =, z z=     | =C-z=      | ditto                             |
-| =, z ,=     | =C-,=      | ditto                             |
-| =, c m z m= | =C-c M-m=  | =m z= is replaced with =M-= too   |
-| =, m z m=   | =C-M-m=    | ditto                             |
+| Input     | Translated | Remarks                                   |
+|-----------+------------+-------------------------------------------|
+| =, s=     | =C-s=      | Rule 1: =,= is replaced with =C-=         |
+| =, m x=   | =M-x=      | Rule 2: =, m= is replaced with =M-=       |
+| =, [ x=   | =C-[ x=    | equivalent to =M-x=                       |
+| =, m m s= | =C-M-s=    | Rule 3: =, m m= is replaced with =C-M-=   |
+| =, m ,=   | =M-,=      | Rule 4: =, m ,= is replaced with =M-,=    |
+| =, m z m= | =M-m=      | Rule 5: =, m z= is replaced with =M-= too |
+| =, c , ,= | =C-c ,=    | Rule 6: =, ,= is replaced with =,=        |
+| =, z SPC= | =C-SPC=    | Rule 7: =, z= is replaced with =C-= too   |
+| =, z z=   | =C-z=      | ditto                                     |
+| =, z ,=   | =C-,=      | ditto                                     |
 
 Note how we cannot use =, SPC= to set a mark because that key sequence
 is already reserved as a special key sequence in =devil-special-keys=.
@@ -387,43 +388,42 @@ In order to conveniently set a mark, Devil translates =, 
z= to =C-=
 too, so that we can type =, z SPC= and have Devil translate it to
 =C-SPC=.
 
-Also, note how the translation of =, m m= to =M-= allows us to enter a
-key sequence that begins with the =M-= modifier key.  Additionally,
-consider that =, [= is yet another way to type a key sequence that
-contains =M-= because =, [= translates to =C-[= and =C-[ <key>= is
-equivalent to =ESC <key>= which in turn is equivalent to =M-<key>=.
+Also, note that while =, m= may be used to type =M-= we have =, [= as
+yet another way to type a key sequence that contains =M-= because =,
+[= translates to =C-[= and =C-[ <key>= is equivalent to =ESC <key>=
+which in turn is equivalent to =M-<key>=.
 
 The default translation examples presented in the table above look
-weirder and weirder as we go down the table.  But the default
-translation rules are not as arbitrary as they might initially appear
-to be.  The default translation rules are arranged in such a way that
-overall, we get the following effect:
-
-- In a Devil key sequence, we see that the special character =,=
-  translates to =C-= and similarly =m= translates to =M-= according to
-  the default translation rules.
-
-- If we really want the Devil key sequence to translate to an actual
-  =,= or =m=, then we need to double type the special character, i.e.,
-  in a Devil key sequence, we see that =, ,= translates to =,= and =m
-  m= translates to =m=.  Doubling the special character serves as an
-  escape mechanism to avoid the special meaning of the character and
-  get the literal form of the character instead.
+weirder and weirder as we go down the table.  But they are not as
+arbitrary as they might initially appear to be.  They are arranged in
+such a way that overall, we get the following effect:
+
+- Devil translates the input =,= to =C-=.  Similarly it translates =,
+  m= to =M-= and =, m m= to =C-M-=.
+
+- When we really want to type the Devil key =,= we need to double type
+  it in the Devil key sequence.  Doubling the special character serves
+  as an escape mechanism to avoid the special meaning of the Devil key
+  and get its literal form instead.
 
 - Now since =, ,= translates to =,= we need another escape mechanism
-  to type =C-,=.  Putting =z= in between serves as this escape
+  to type =C-,=.  Typing =z= in between serves as this escape
   mechanism, i.e., within a Devil key sequence =, z ,= translates to
-  =C-,= and similarly =m z m= translates to =M-m=.
+  =C-,=.
+
+- Similarly since =, m m= translates to =C-M-= we need an escape
+  mechanism to type =M-m=.  Again, typing =z= in between serves as
+  this escape mechanism, i.e., =, m z m= translates to =M-m=.
 
 Here is a gentle guide to adopting these key sequences: For beginners
 using Devil, it is not necessary to memorize all of them right away.
-Understanding that =,= translates to =C-= and =m= translates to =M-=
-is sufficient to begin.  Subsequently, learning that =, m m= too
-translates to =M-= unlocks several more key sequences like =, m m x=
-(=M-x=), =, m m f= (=M-f=), etc.  As you encounter more key sequences
-that are not covered by these initial rules, revisit the above table
-to pick up new translation rules and adopt them in your day-to-day
-usage of Devil.
+Understanding that =,= translates to =C-= and =, m= translates to =M-=
+is sufficient to begin.  Subsequently, learning that =, m m=
+translates to =C-M-= unlocks several more key sequences like =, m m s=
+(=C-M-s=), =, m m f= (=C-M-f=), etc.  As you encounter more key
+sequences that are not covered by these initial rules, revisit the
+above table to pick up new translation rules and adopt them in your
+day-to-day usage of Devil.
 
 * Describe Devil Key
 :PROPERTIES:
@@ -663,18 +663,18 @@ something like God mode or Evil mode?
 
 Well, for one, both God mode and Evil mode are modal editing modes.
 Devil, on the other hand, retains the non-modal editing experience of
-Emacs as much as possible.
+Emacs.
 
-Devil mode began as a fun little tiny experiment.  From the outset, it
-was clear that using something as crucial as the comma for specifying
-the modifier key is asking for trouble.  However, I still wanted to
-see how far I could go with it.  It turned out that in a matter of
-days, I was using it full-time for all of my Emacs usage.
+Devil mode began as a fun little experiment.  From the outset, it was
+clear that using something as crucial as the comma for specifying the
+modifier key is asking for trouble.  However, I still wanted to see
+how far I could go with it.  It turned out that in a matter of days, I
+was using it full-time for all of my Emacs usage.
 
 This experiment was partly motivated by Macbook keyboards which do not
 have a =ctrl= key on the right side of the keyboard.  Being a
 touch-typist myself, I found it inconvenient to type key combinations
-like =C-x=, =C-s=, =C-r=, =C-d=, =C=f=, =C-w=, =C-a=, =C-e=,
+like =C-x=, =C-s=, =C-r=, =C-d=, =C-f=, =C-w=, =C-a=, =C-e=,
 etc. where both the modifier key and the modified key need to be
 pressed with the left hand fingers.  I am not particularly fond of
 remapping =caps lock= to behave like =ctrl= because that still suffers
@@ -704,7 +704,7 @@ like God mode has.  Instead, Devil waits for an activation 
key (=,= by
 default) and as soon as it is activated, it intercepts and translates
 keys, runs the corresponding command, and then gets out of the way.
 So Devil tries to retain the non-modal editing experience of vanilla
-Emacs as much as possible.
+Emacs.
 
 Now it is worth mentioning that some of this non-modal editing
 experience can be reproduced in god-mode too using its
@@ -733,7 +733,7 @@ as sticky which leads to simpler key sequences at the cost 
of a little
 additional typing, i.e., =, x , f= translates to =C-x C-f= and =, x f=
 translates to =C-x f=.
 
-To summarize, there are primarily three things that Devil does
+To summarize, there are primarily four things that Devil does
 differently:
 
 - Provide a non-modal editing experience from the outset.
@@ -782,13 +782,13 @@ and preferences.
     of =, x , f= to invoke =C-x C-f=?
 
     Devil does not support sticky keys.  Say, Devil were to translate
-    =, x f= to =C-x C-f=, how then would you invoke =C-x f=?  We need
+    =, x f= to =C-x C-f=, how then would we invoke =C-x f=?  We need
     some way to disambiguate between =C-x C-f= and =C-x f=.  Different
     tools take different approaches to disambiguate the two key
-    sequences.  For example, god-mode translates =x f= to =C-x C-f=
-    and =x SPC f= to =C-x f=.  That is, God-mode treats the =C-=
-    modifier as sticky by default but when we want to make it
-    non-sticky, we need to type =SPC= in god-mode.
+    sequences.  God-mode translates =x f= to =C-x C-f= and =x SPC f=
+    to =C-x f=.  That is, God-mode treats the =C-= modifier as sticky
+    by default but when we want to make it non-sticky, we need to type
+    =SPC= in god-mode.
 
     Devil treats the Devil key as non-sticky, so that there is no need
     for additional peculiar rules to switch between sticky and
@@ -816,13 +816,12 @@ and preferences.
 Devil is a minor mode to translate key sequences.  Devil utilizes this
 translation capability to provide a modifier-free editing experience
 and it does so without resorting to modal-editing.  Devil retains the
-non-modal editing of vanilla Emacs as much as possible.  This mode was
-written as a quirky experiment to make it easier to use Emacs with
-only one =ctrl= key.  However, the resulting mode turned out to be
-quite convenient to use, in general.  You might find Devil
-comfortable.  Or you might find Devil to be a terrible idea.  It is
-also possible that you might find Devil useful but intrusive.  In such
-cases, there are plenty of customisable options that you can modify to
-configure Devil according to your preferences.  If you need any help
-or if you find any issues, please create an issue at
-[[https://github.com/susam/devil/issues]].
+non-modal editing of vanilla Emacs.  This mode was written as a quirky
+experiment to make it easier to use Emacs with only one =ctrl= key.
+However, the resulting mode turned out to be quite convenient to use,
+in general.  You might find Devil comfortable.  Or you might find
+Devil to be a terrible idea.  It is also possible that you might find
+Devil useful but intrusive.  In such cases, there are plenty of
+customisable options that you can modify to configure Devil according
+to your preferences.  If you need any help or if you find any issues,
+please create an issue at [[https://github.com/susam/devil/issues]].
diff --git a/Makefile b/Makefile
index e147460842..b4fbf933ef 100644
--- a/Makefile
+++ b/Makefile
@@ -1,10 +1,7 @@
 checks: tests test-sentence-ends
 
 test-sentence-ends:
-       grep -n '[^0-9]\. [^ lswxz.,"(]' MANUAL.org; [ $$? = 1 ]
-       grep -n '\. [^ a]' README.org CHANGES.org LICENSE.org; [ $$? = 1 ]
-       grep -n '\. [^ m]' *.el; [ $$? = 1 ]
-       grep -n '[?!] [^ ]' *.org *.el; [ $$? = 1 ]
+       grep -n '[^0-9][.?=)] [A-Z]' *.org *.el; [ $$? = 1 ]
 
 tests:
        emacs --batch -l devil.el -l devil-tests.el -f 
ert-run-tests-batch-and-exit
diff --git a/README.org b/README.org
index 888a944f1f..0b60949c06 100644
--- a/README.org
+++ b/README.org
@@ -15,7 +15,7 @@ here.  Welcome, instead, to the realm of the Devil!  You will 
be
 granted the occasional use of the comma key for punctuation, but only
 if you can charm the Devil.  But beware, for in this sinister domain,
 you must relinquish your comma key and embrace an editing experience
-that whispers wicked secrets into your fingertips.
+that whispers wicked secrets into your fingertips!
 
 ** Introduction
 :PROPERTIES:
@@ -38,11 +38,14 @@ deactivates itself.
 
 By default, each comma in the Devil key sequence is translated to
 "C-".  For example, if you type ", x , f", Devil translates it to "C-x
-C-f".  Similarly, "m" is translated to "M-", so if you type ", m s",
-Devil translates it to "C-M-s".  There are several other translations
-available in the default translation rules that let you enjoy working
-with Emacs while avoiding modifier keys.  Further, the Devil
-activation key, translation rules, etc. are customisable.
+C-f".  Similarly ", m" is translated to "M-".  If you type ", m x",
+Devil translates it to "M-x".  Further ", m m" is translated to
+"C-M-".  If you type ", m m f" Devil translates it to "C-M-f".  There
+are several other translations available in the default translation
+rules that let you enjoy working with Emacs while avoiding modifier
+keys.  Further, the Devil activation key, translation rules, etc. are
+customisable.  Thus if you do not like the default choices made in
+this package, you can customise it easily to suit your preferences.
 
 Read the [[https://susam.github.io/devil/][manual]] to learn how to install, 
use, and customise Devil.
 
@@ -55,7 +58,6 @@ The author of this project hangs out at the following places 
online:
 
 - Website: [[https://susam.net][susam.net]]
 - Mastodon: [[https://mastodon.social/@susam][@susam@mastodon.social]]
-- Twitter: [[https://twitter.com/susam][@susam]]
 - GitHub: [[https://github.com/susam][@susam]]
 
 You are welcome to subscribe to, follow, or join one or more of the
diff --git a/devil-tests.el b/devil-tests.el
index 90fb0004f1..62083debbb 100644
--- a/devil-tests.el
+++ b/devil-tests.el
@@ -89,32 +89,33 @@
   (should (string= (devil--translate (vconcat ",,")) ","))
   (should (string= (devil--translate (vconcat ",,,,")) ", ,"))
   ;; Translations involving M- modifier.
-  (should (string= (devil--translate (vconcat ",mx")) "C-M-x"))
-  (should (string= (devil--translate (vconcat ",mmx")) "M-x"))
-  (should (string= (devil--translate (vconcat ",mmm")) "M-m"))
+  (should (string= (devil--translate (vconcat ",mx")) "M-x"))
+  (should (string= (devil--translate (vconcat ",mmx")) "C-M-x"))
+  (should (string= (devil--translate (vconcat ",m,x")) "M-, x"))
+  (should (string= (devil--translate (vconcat ",mmm")) "C-M-m"))
   ;; Translations involing C- and uppercase letter.
   (should (string= (devil--translate (vconcat ",a")) "C-a"))
   (should (string= (devil--translate (vconcat ",A")) "C-S-a"))
-  (should (string= (devil--translate (vconcat ",mA")) "C-M-S-a"))
-  (should (string= (devil--translate (vconcat ",mmA")) "M-A"))
-  (should (string= (devil--translate (vconcat ",A,mA,a")) "C-S-a C-M-S-a C-a"))
-  (should (string= (devil--translate (vconcat ",AmA,mmA,a")) "C-S-a M-A M-A 
C-a"))
+  (should (string= (devil--translate (vconcat ",mA")) "M-A"))
+  (should (string= (devil--translate (vconcat ",mmA")) "C-M-S-a"))
+  (should (string= (devil--translate (vconcat ",A,mmA,a")) "C-S-a C-M-S-a 
C-a"))
+  (should (string= (devil--translate (vconcat ",A,mA,mA,a")) "C-S-a M-A M-A 
C-a"))
   ;; Translations involving C- and RET.
   (should (string= (devil--translate (vconcat ",\r")) "C-RET"))
-  (should (string= (devil--translate (vconcat ",m\r")) "C-M-RET"))
-  (should (string= (devil--translate (vconcat ",mm\r")) "M-RET"))
-  (should (string= (devil--translate (vconcat ",\r,R,mm\r")) "C-RET C-S-r 
M-RET"))
+  (should (string= (devil--translate (vconcat ",m\r")) "M-RET"))
+  (should (string= (devil--translate (vconcat ",mm\r")) "C-M-RET"))
+  (should (string= (devil--translate (vconcat ",\r,R,m\r")) "C-RET C-S-r 
M-RET"))
   ;; Translations provided in the manual as examples.
   (should (string= (devil--translate (vconcat ",s")) "C-s"))
-  (should (string= (devil--translate (vconcat ",ms")) "C-M-s"))
-  (should (string= (devil--translate (vconcat ",mmx")) "M-x"))
+  (should (string= (devil--translate (vconcat ",mx")) "M-x"))
+  (should (string= (devil--translate (vconcat ",mms")) "C-M-s"))
+  (should (string= (devil--translate (vconcat ",m,")) "M-,"))
+  (should (string= (devil--translate (vconcat ",mzm")) "M-m"))
+  (should (string= (devil--translate (vconcat ",[x")) "C-[ x"))
   (should (string= (devil--translate (vconcat ",c,,")) "C-c ,"))
-  (should (string= (devil--translate (vconcat ",cmm")) "C-c m"))
   (should (string= (devil--translate (vconcat ",z ")) "C-SPC"))
   (should (string= (devil--translate (vconcat ",zz")) "C-z"))
-  (should (string= (devil--translate (vconcat ",z,")) "C-,"))
-  (should (string= (devil--translate (vconcat ",cmzm")) "C-c M-m"))
-  (should (string= (devil--translate (vconcat ",mzm")) "C-M-m")))
+  (should (string= (devil--translate (vconcat ",z,")) "C-,")))
 
 (ert-deftest devil--terminal-key ()
   "Test if `devil--terminal-key' works as expected."
diff --git a/devil.el b/devil.el
index 0f91b9f2f8..e92a206613 100644
--- a/devil.el
+++ b/devil.el
@@ -4,7 +4,7 @@
 
 ;; Author: Susam Pal <susam@susam.net>
 ;; Maintainer: Susam Pal <susam@susam.net>
-;; Version: 0.5.0
+;; Version: 0.6.0-beta1
 ;; Package-Requires: ((emacs "24.4"))
 ;; Keywords: convenience, abbrev
 ;; URL: https://github.com/susam/devil
@@ -141,13 +141,13 @@ supported by `devil-format' may be used in the keys."
   :type '(alist :key-type string :value-type function))
 
 (defcustom devil-translations
-  (list (cons "%k z" "C-")
+  (list (cons "%k m m" "C-M-")
+        (cons "%k m %k" "M-,")
+        (cons "%k m z" "M-")
+        (cons "%k m" "M-")
         (cons "%k %k" "%k")
-        (cons "%k m m" "M-")
-        (cons "m z" "M-")
-        (cons "m m" "m")
-        (cons "%k"  "C-")
-        (cons "m" "M-"))
+        (cons "%k z" "C-")
+        (cons "%k"  "C-"))
   "Translation rules to convert Devil input to Emacs key sequence.
 
 The value of this variable is an alist where each item represents
@@ -171,10 +171,10 @@ by `devil-format' may be used in the keys and values."
         "%k k"
         "%k s"
         "%k /"
-        "%k m m f"
-        "%k m m b"
-        "%k m m y"
-        "%k m m ^"
+        "%k m f"
+        "%k m b"
+        "%k m y"
+        "%k m ^"
         "%k x o")
   "Devil mode repeatable key sequences.