[PATCH] change wordstar-mode into a minor mode

[PATCH] change wordstar-mode into a minor mode

[Mark Oteiza]

I was poking through obsolete/ the other day and happened upon
ws-mode.el and subsequently the thread

https://lists.gnu.org/archive/html/emacs-devel/2015-05/msg00127.html

The following changes `wordstar-mode' into a minor mode, and also
adds a global minor mode `global-wordstar-mode', which will turn on
wordstar-mode in all buffers except the minibuffer.

diff --git a/lisp/obsolete/ws-mode.el b/lisp/obsolete/ws-mode.el
index 62cccf725a..f977bc089e 100644
--- a/lisp/obsolete/ws-mode.el
+++ b/lisp/obsolete/ws-mode.el
@@ -1,4 +1,4 @@
-;;; ws-mode.el --- WordStar emulation mode for GNU Emacs
+;;; ws-mode.el --- WordStar emulation mode for GNU Emacs -*- lexical-binding: t -*-
 
 ;; Copyright (C) 1991, 2001-2017 Free Software Foundation, Inc.
 
@@ -24,9 +24,20 @@
 
 ;;; Commentary:
 
-;; This emulates WordStar, with a major mode.
+;; This provides emulation of WordStar with a minor mode.
 
 ;;; Code:
+
+(defgroup wordstar nil
+  "WordStar emulation within Emacs."
+  :prefix "wordstar-"
+  :prefix "ws-"
+  :group 'emulations)
+
+(defcustom wordstar-mode-lighter " WordStar"
+  "Lighter shown in the modeline for `wordstar' mode."
+  :type 'string)
+
 (defvar wordstar-C-k-map
   (let ((map (make-keymap)))
     (define-key map " " ())
@@ -98,8 +109,7 @@ wordstar-C-o-map
     (define-key map "wh" 'split-window-right)
     (define-key map "wo" 'other-window)
     (define-key map "wv" 'split-window-below)
-    map)
-  "")
+    map))
 
 (defvar wordstar-C-q-map
   (let ((map (make-keymap)))
@@ -174,12 +184,9 @@ wordstar-mode-map
 ;; wordstar-C-j-map not yet implemented
 (defvar wordstar-C-j-map nil)
 
-
-(put 'wordstar-mode 'mode-class 'special)
-
 ;;;###autoload
-(define-derived-mode wordstar-mode fundamental-mode "WordStar"
-  "Major mode with WordStar-like key bindings.
+(define-minor-mode wordstar-mode
+  "Minor mode with WordStar-like key bindings.
 
 BUGS:
  - Help menus with WordStar commands (C-j just calls help-for-help)
@@ -189,8 +196,18 @@ wordstar-mode
  - Search and replace (C-q a) is only available in forward direction
 
 No key bindings beginning with ESC are installed, they will work
-Emacs-like.")
-
+Emacs-like."
+  :group 'wordstar
+  :lighter wordstar-mode-lighter
+  :keymap wordstar-mode-map)
+
+(defun turn-on-wordstar-mode ()
+  (when (and (not (minibufferp))
+             (not wordstar-mode))
+    (wordstar-mode 1)))
+
+(define-globalized-minor-mode global-wordstar-mode wordstar-mode
+  turn-on-wordstar-mode)
 
 (defun wordstar-center-paragraph ()
   "Center each line in the paragraph at or after point.

Re: [PATCH] change wordstar-mode into a minor mode

[Eli Zaretskii]

> Date: Sun, 12 Feb 2017 12:32:00 -0500
> From: Mark Oteiza <mvoteiza@udel.edu>
> Cc: Douglas Quagliana <dquagliana@gmail.com>
> 
> I was poking through obsolete/ the other day and happened upon
> ws-mode.el and subsequently the thread
> 
> https://lists.gnu.org/archive/html/emacs-devel/2015-05/msg00127.html
> 
> The following changes `wordstar-mode' into a minor mode, and also
> adds a global minor mode `global-wordstar-mode', which will turn on
> wordstar-mode in all buffers except the minibuffer.

If we want to continue developing ws-mode.el, we should pull it from
lisp/obsolete/, IMO.

Re: [PATCH] change wordstar-mode into a minor mode

[Eli Zaretskii]

> Date: Sun, 12 Feb 2017 12:32:00 -0500
> From: Mark Oteiza <mvoteiza@udel.edu>
> Cc: Douglas Quagliana <dquagliana@gmail.com>
> 
> +(defgroup wordstar nil
> +  "WordStar emulation within Emacs."
> +  :prefix "wordstar-"
> +  :prefix "ws-"
> +  :group 'emulations)
> +
> +(defcustom wordstar-mode-lighter " WordStar"
> +  "Lighter shown in the modeline for `wordstar' mode."
> +  :type 'string)
> +

When you introduce new groups and defcustoms, please always specify a
':version' tag.

Thanks.

Re: [PATCH] change wordstar-mode into a minor mode

[Mark Oteiza]

On 12/02/17 at 08:29pm, Eli Zaretskii wrote:
> > Date: Sun, 12 Feb 2017 12:32:00 -0500
> > From: Mark Oteiza <mvoteiza@udel.edu>
> > Cc: Douglas Quagliana <dquagliana@gmail.com>
> > 
> > +(defgroup wordstar nil
> > +  "WordStar emulation within Emacs."
> > +  :prefix "wordstar-"
> > +  :prefix "ws-"
> > +  :group 'emulations)
> > +
> > +(defcustom wordstar-mode-lighter " WordStar"
> > +  "Lighter shown in the modeline for `wordstar' mode."
> > +  :type 'string)
> > +
> 
> When you introduce new groups and defcustoms, please always specify a
> ':version' tag.

Right, thanks.

Re: [PATCH] change wordstar-mode into a minor mode

[Stefan Monnier]

> If we want to continue developing ws-mode.el, we should pull it from
> lisp/obsolete/, IMO.

And move it to elpa.git, like we've done for crisp.el.


        Stefan

Re: [PATCH] change wordstar-mode into a minor mode

[Eli Zaretskii]

> From: Stefan Monnier <monnier@iro.umontreal.ca>
> Date: Sun, 12 Feb 2017 15:38:06 -0500
> 
> > If we want to continue developing ws-mode.el, we should pull it from
> > lisp/obsolete/, IMO.
> 
> And move it to elpa.git, like we've done for crisp.el.

That's up to the individual(s) who'd volunteer to develop/maintain it.

bug#35148: [PATCH] change wordstar-mode into a minor mode

[Mark Oteiza]

Hi,

I recently got some testing/confirmation that this does work as
expected, so pinging the list again to ask what I should do here.
I don't have strong feelings over whether this gets nudged out of
obsolete/ or gets moved over to ELPA.

The original thread is here:
https://lists.gnu.org/archive/html/emacs-devel/2017-02/msg00467.html

On 12/02/17 at 12:32pm, Mark Oteiza wrote:
> I was poking through obsolete/ the other day and happened upon
> ws-mode.el and subsequently the thread
> 
> https://lists.gnu.org/archive/html/emacs-devel/2015-05/msg00127.html
> 
> The following changes `wordstar-mode' into a minor mode, and also
> adds a global minor mode `global-wordstar-mode', which will turn on
> wordstar-mode in all buffers except the minibuffer.
> 
> diff --git a/lisp/obsolete/ws-mode.el b/lisp/obsolete/ws-mode.el
> index 62cccf725a..f977bc089e 100644
> --- a/lisp/obsolete/ws-mode.el
> +++ b/lisp/obsolete/ws-mode.el
> @@ -1,4 +1,4 @@
> -;;; ws-mode.el --- WordStar emulation mode for GNU Emacs
> +;;; ws-mode.el --- WordStar emulation mode for GNU Emacs -*- lexical-binding: t -*-
>  
>  ;; Copyright (C) 1991, 2001-2017 Free Software Foundation, Inc.
>  
> @@ -24,9 +24,20 @@
>  
>  ;;; Commentary:
>  
> -;; This emulates WordStar, with a major mode.
> +;; This provides emulation of WordStar with a minor mode.
>  
>  ;;; Code:
> +
> +(defgroup wordstar nil
> +  "WordStar emulation within Emacs."
> +  :prefix "wordstar-"
> +  :prefix "ws-"
> +  :group 'emulations)
> +
> +(defcustom wordstar-mode-lighter " WordStar"
> +  "Lighter shown in the modeline for `wordstar' mode."
> +  :type 'string)
> +
>  (defvar wordstar-C-k-map
>    (let ((map (make-keymap)))
>      (define-key map " " ())
> @@ -98,8 +109,7 @@ wordstar-C-o-map
>      (define-key map "wh" 'split-window-right)
>      (define-key map "wo" 'other-window)
>      (define-key map "wv" 'split-window-below)
> -    map)
> -  "")
> +    map))
>  
>  (defvar wordstar-C-q-map
>    (let ((map (make-keymap)))
> @@ -174,12 +184,9 @@ wordstar-mode-map
>  ;; wordstar-C-j-map not yet implemented
>  (defvar wordstar-C-j-map nil)
>  
> -
> -(put 'wordstar-mode 'mode-class 'special)
> -
>  ;;;###autoload
> -(define-derived-mode wordstar-mode fundamental-mode "WordStar"
> -  "Major mode with WordStar-like key bindings.
> +(define-minor-mode wordstar-mode
> +  "Minor mode with WordStar-like key bindings.
>  
>  BUGS:
>   - Help menus with WordStar commands (C-j just calls help-for-help)
> @@ -189,8 +196,18 @@ wordstar-mode
>   - Search and replace (C-q a) is only available in forward direction
>  
>  No key bindings beginning with ESC are installed, they will work
> -Emacs-like.")
> -
> +Emacs-like."
> +  :group 'wordstar
> +  :lighter wordstar-mode-lighter
> +  :keymap wordstar-mode-map)
> +
> +(defun turn-on-wordstar-mode ()
> +  (when (and (not (minibufferp))
> +             (not wordstar-mode))
> +    (wordstar-mode 1)))
> +
> +(define-globalized-minor-mode global-wordstar-mode wordstar-mode
> +  turn-on-wordstar-mode)
>  
>  (defun wordstar-center-paragraph ()
>    "Center each line in the paragraph at or after point.

bug#35148: [PATCH] change wordstar-mode into a minor mode

[Mark Oteiza]

Bumping for attention.  I'll push this in a few days or so otherwise.

On 04/04/19 at 01:53pm, Mark Oteiza wrote:
> Hi,
> 
> I recently got some testing/confirmation that this does work as
> expected, so pinging the list again to ask what I should do here.
> I don't have strong feelings over whether this gets nudged out of
> obsolete/ or gets moved over to ELPA.
> 
> The original thread is here:
> https://lists.gnu.org/archive/html/emacs-devel/2017-02/msg00467.html
> 
> On 12/02/17 at 12:32pm, Mark Oteiza wrote:
> > I was poking through obsolete/ the other day and happened upon
> > ws-mode.el and subsequently the thread
> > 
> > https://lists.gnu.org/archive/html/emacs-devel/2015-05/msg00127.html
> > 
> > The following changes `wordstar-mode' into a minor mode, and also
> > adds a global minor mode `global-wordstar-mode', which will turn on
> > wordstar-mode in all buffers except the minibuffer.
> > 
> > diff --git a/lisp/obsolete/ws-mode.el b/lisp/obsolete/ws-mode.el
> > index 62cccf725a..f977bc089e 100644
> > --- a/lisp/obsolete/ws-mode.el
> > +++ b/lisp/obsolete/ws-mode.el
> > @@ -1,4 +1,4 @@
> > -;;; ws-mode.el --- WordStar emulation mode for GNU Emacs
> > +;;; ws-mode.el --- WordStar emulation mode for GNU Emacs -*- lexical-binding: t -*-
> >  
> >  ;; Copyright (C) 1991, 2001-2017 Free Software Foundation, Inc.
> >  
> > @@ -24,9 +24,20 @@
> >  
> >  ;;; Commentary:
> >  
> > -;; This emulates WordStar, with a major mode.
> > +;; This provides emulation of WordStar with a minor mode.
> >  
> >  ;;; Code:
> > +
> > +(defgroup wordstar nil
> > +  "WordStar emulation within Emacs."
> > +  :prefix "wordstar-"
> > +  :prefix "ws-"
> > +  :group 'emulations)
> > +
> > +(defcustom wordstar-mode-lighter " WordStar"
> > +  "Lighter shown in the modeline for `wordstar' mode."
> > +  :type 'string)
> > +
> >  (defvar wordstar-C-k-map
> >    (let ((map (make-keymap)))
> >      (define-key map " " ())
> > @@ -98,8 +109,7 @@ wordstar-C-o-map
> >      (define-key map "wh" 'split-window-right)
> >      (define-key map "wo" 'other-window)
> >      (define-key map "wv" 'split-window-below)
> > -    map)
> > -  "")
> > +    map))
> >  
> >  (defvar wordstar-C-q-map
> >    (let ((map (make-keymap)))
> > @@ -174,12 +184,9 @@ wordstar-mode-map
> >  ;; wordstar-C-j-map not yet implemented
> >  (defvar wordstar-C-j-map nil)
> >  
> > -
> > -(put 'wordstar-mode 'mode-class 'special)
> > -
> >  ;;;###autoload
> > -(define-derived-mode wordstar-mode fundamental-mode "WordStar"
> > -  "Major mode with WordStar-like key bindings.
> > +(define-minor-mode wordstar-mode
> > +  "Minor mode with WordStar-like key bindings.
> >  
> >  BUGS:
> >   - Help menus with WordStar commands (C-j just calls help-for-help)
> > @@ -189,8 +196,18 @@ wordstar-mode
> >   - Search and replace (C-q a) is only available in forward direction
> >  
> >  No key bindings beginning with ESC are installed, they will work
> > -Emacs-like.")
> > -
> > +Emacs-like."
> > +  :group 'wordstar
> > +  :lighter wordstar-mode-lighter
> > +  :keymap wordstar-mode-map)
> > +
> > +(defun turn-on-wordstar-mode ()
> > +  (when (and (not (minibufferp))
> > +             (not wordstar-mode))
> > +    (wordstar-mode 1)))
> > +
> > +(define-globalized-minor-mode global-wordstar-mode wordstar-mode
> > +  turn-on-wordstar-mode)
> >  
> >  (defun wordstar-center-paragraph ()
> >    "Center each line in the paragraph at or after point.

bug#35148: [PATCH] change wordstar-mode into a minor mode

[Lars Ingebrigtsen]

Mark Oteiza <mvoteiza@udel.edu> writes:

> Bumping for attention.  I'll push this in a few days or so otherwise.

This was apparently done, so I'm now closing this bug report.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no