From: Robert Brown <robert.brown@gmail.com>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: 9130@debbugs.gnu.org
Subject: bug#9130: 23.3; Lisp mode doc string enhancment
Date: Tue, 25 Mar 2014 13:54:22 -0400 [thread overview]
Message-ID: <CAPNkkp=noQY2BRyFqLLCayjc+qF11RmMri0TzMBi+LJQc499UQ@mail.gmail.com> (raw)
In-Reply-To: <jwvlivbd1rn.fsf-monnier+emacs@gnu.org>
[-- Attachment #1: Type: text/plain, Size: 9378 bytes --]
I have converted the change into a patch made with diff and
have included it as an attachment. The patch is relative to
Emacs version 24.3.
EIEIO supports defclass with :documentation strings, so I
think the detection of such strings should be active in both
emacs-lisp-mode and lisp-mode.
Bob
On Tue, Aug 2, 2011 at 4:01 PM, Stefan Monnier <monnier@iro.umontreal.ca> wrote:
> severity 9130 wishlist
> tags 9130 patch
> thanks
>
>> Here is a change that enhances Lisp mode fontification to handle
>> documentation of the form
>
>> (:documentation "the doc string")
>
> Thanks. That looks like a useful addition. Could you try and make it
> an actual patch (as output by `diff' and friends), also could you also
> make sure your code uses a proper prefix ("lisp-") for all the functions
> it defines, and finally could you make sure it's only enabled when it's
> useful (I don't think we support such :documentation thingies in Elisp
> (tho maybe EIEIO does) so it should only be enabled in lisp-mode but
> not in emacs-lisp-mode).
>
> There's time for that: we're in feature freeze for Emacs-24.1, so we
> won't install such a change before early next year.
>
>
> Stefan
>
>
>> These kinds of documentation forms are used in Common Lisp code for CLOS
>> class and slot documentation.
>
>> To apply the patch, replace lisp-font-lock-syntactic-face-function in
>> share/emacs/23.3/lisp/emacs-lisp/lisp-mode.el with the three functions
>> below:
>
>> (defun string-in-doc-position-p (state)
>> (let* ((listbeg (nth 1 state))
>> (firstsym (and listbeg
>> (save-excursion
>> (goto-char listbeg)
>> (and (looking-at "([ \t\n]*\\(\\(\\sw\\|\\s_\\)+\\)")
>> (match-string 1)))))
>> (docelt (and firstsym (get (intern-soft firstsym)
>> lisp-doc-string-elt-property))))
>> (and docelt
>> ;; It's a string in a form that can have a docstring.
>> ;; Check whether it's in docstring position.
>> (save-excursion
>> (when (functionp docelt)
>> (goto-char (match-end 1))
>> (setq docelt (funcall docelt)))
>> (goto-char listbeg)
>> (forward-char 1)
>> (condition-case nil
>> (while (and (> docelt 0) (< (point) startpos)
>> (progn (forward-sexp 1) t))
>> (setq docelt (1- docelt)))
>> (error nil))
>> (and (zerop docelt) (<= (point) startpos)
>> (progn (forward-comment (point-max)) t)
>> (= (point) (nth 8 state)))))))
>
>> (defun string-after-documentation-keyword-p (state)
>> (and (nth 1 state) ; we are inside a Lisp form
>> (let ((startpos (nth 8 state)))
>> (and startpos
>> (let ((ok nil)
>> (prevsym (save-excursion
>> (goto-char startpos)
>> (condition-case nil
>> (progn (backward-sexp 1) (setf ok t))
>> (error nil))
>> (and ok
>> (looking-at "\\(\\sw+\\)")
>> (match-string 1)))))
>> (equal prevsym ":documentation"))))))
>
>> (defun lisp-font-lock-syntactic-face-function (state)
>> (if (nth 3 state)
>> ;; This might be a (doc)string or a |...| symbol.
>> (let ((startpos (nth 8 state)))
>> (if (eq (char-after startpos) ?|)
>> ;; This is not a string, but a |...| symbol.
>> nil
>> (if (or (string-in-doc-position-p state)
>> (string-after-documentation-keyword-p state))
>> font-lock-doc-face
>> font-lock-string-face)))
>> font-lock-comment-face))
>
>
>
>> In GNU Emacs 23.3.1 (x86_64-unknown-linux-gnu)
>> of 2011-07-15 on paradicsom.nyc.corp.google.com
>> configured using `configure '--prefix' '/local/software/package/emacs-23.3.1' '--without-x''
>
>> Important settings:
>> value of $LC_ALL: nil
>> value of $LC_COLLATE: C
>> value of $LC_CTYPE: nil
>> value of $LC_MESSAGES: nil
>> value of $LC_MONETARY: C
>> value of $LC_NUMERIC: C
>> value of $LC_TIME: C
>> value of $LANG: en_US.UTF-8
>> value of $XMODIFIERS: nil
>> locale-coding-system: utf-8-unix
>> default enable-multibyte-characters: t
>
>> Major mode: Emacs-Lisp
>
>> Minor modes in effect:
>> file-name-shadow-mode: t
>> global-font-lock-mode: t
>> font-lock-mode: t
>> auto-encryption-mode: t
>> auto-compression-mode: t
>> line-number-mode: t
>
>> Recent input:
>> ESC [ > 1 ; 2 3 0 5 ; 0 c C-x C-f . e m a c s RET C-v
>> C-v C-v C-v C-v C-v C-v C-v C-v C-v C-v C-v ESC v ESC
>> v ESC v ESC v ESC v ESC v C-v C-v C-v C-v C-a C-n C-n
>> C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n
>> C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n
>> C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n
>> C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n
>> C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n
>> C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n
>> C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n
>> C-l C-v C-v C-v ESC v ESC v ESC v ESC v ESC v ESC v
>> ESC v ESC v ESC v ESC v ESC v ESC v ESC v ESC v ESC
>> v ESC v ESC v C-v C-l C-u C-u C-n C-n C-n DEL C-x SPC
>> SPC C-a C-x C-s C-v C-x C-s C-v C-v C-v C-v ESC v C-v
>> C-n C-n C-n C-n C-n C-n C-n C-n C-l C-u C-p C-p C-p
>> C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n
>> C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n
>> C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-l ESC
>> x r e p o r t - e m a c s - b u g RET
>
>> Recent messages:
>> ("emacs")
>> Loading /local/software/source-trees/emacs-jabber/jabber-autoloads.el (source)...done
>> call-interactively: Beginning of buffer [3 times]
>> Saving file /home/brown/.emacs...
>> Wrote /home/brown/.emacs
>> (No changes need to be saved)
>
>> Load-path shadows:
>> /local/software/source-trees/cc-mode/cc-fonts hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/progmodes/cc-fonts
>> /local/software/source-trees/cc-mode/cc-align hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/progmodes/cc-align
>> /local/software/source-trees/cc-mode/cc-menus hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/progmodes/cc-menus
>> /local/software/source-trees/cc-mode/cc-engine hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/progmodes/cc-engine
>> /local/software/source-trees/cc-mode/cc-mode hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/progmodes/cc-mode
>> /local/software/source-trees/cc-mode/cc-awk hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/progmodes/cc-awk
>> /local/software/source-trees/cc-mode/cc-defs hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/progmodes/cc-defs
>> /local/software/source-trees/cc-mode/cc-vars hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/progmodes/cc-vars
>> /local/software/source-trees/cc-mode/cc-styles hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/progmodes/cc-styles
>> /local/software/source-trees/cc-mode/cc-bytecomp hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/progmodes/cc-bytecomp
>> /local/software/source-trees/cc-mode/cc-compat hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/progmodes/cc-compat
>> /local/software/source-trees/cc-mode/cc-cmds hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/progmodes/cc-cmds
>> /local/software/source-trees/cc-mode/cc-langs hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/progmodes/cc-langs
>> /local/software/package/org-5.13e/org-publish hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/org/org-publish
>> /local/software/package/org-5.13e/org hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/org/org
>> /local/software/package/org-5.13e/org-install hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/org/org-install
>> /local/software/package/org-5.13e/org-mouse hides /local/software/package/emacs-23.3.1/share/emacs/23.3/lisp/org/org-mouse
>
>> Features:
>> (shadow sort mail-extr message ecomplete rfc822 mml easymenu mml-sec
>> password-cache mm-decode mm-bodies mm-encode mailcap mail-parse rfc2231
>> rfc2047 rfc2045 qp ietf-drums mailabbrev nnheader gnus-util netrc
>> time-date mm-util mail-prsvr gmm-utils wid-edit mailheader canlock sha1
>> hex-util hashcash mail-utils warnings emacsbug uniquify advice help-fns
>> advice-preload slime-autoloads regexp-opt cl cl-19 ediff-hook vc-hooks
>> lisp-float-type lisp-mode register page menu-bar rfn-eshadow timer
>> jit-lock font-lock syntax facemenu font-core frame cham georgian
>> utf-8-lang misc-lang vietnamese tibetan thai tai-viet lao korean
>> japanese hebrew greek romanian slovak czech european ethiopic indian
>> cyrillic chinese case-table epa-hook jka-cmpr-hook help simple abbrev
>> loaddefs button minibuffer faces cus-face files text-properties overlay
>> md5 base64 format env code-pages mule custom widget
>> hashtable-print-readable backquote make-network-process multi-tty emacs)
>
>
[-- Attachment #2: patch --]
[-- Type: application/octet-stream, Size: 4423 bytes --]
*** lisp-mode.el.~1~ 2014-03-25 13:29:11.498131716 -0400
--- lisp-mode.el 2014-03-25 13:46:30.516011412 -0400
***************
*** 150,155 ****
--- 150,195 ----
(defvar lisp-doc-string-elt-property 'doc-string-elt
"The symbol property that holds the docstring position info.")
+ (defun lisp-string-in-doc-position-p (listbeg startpos)
+ (let* ((firstsym (and listbeg
+ (save-excursion
+ (goto-char listbeg)
+ (and (looking-at "([ \t\n]*\\(\\(\\sw\\|\\s_\\)+\\)")
+ (match-string 1)))))
+ (docelt (and firstsym
+ (function-get (intern-soft firstsym)
+ lisp-doc-string-elt-property))))
+ (and docelt
+ ;; It's a string in a form that can have a docstring.
+ ;; Check whether it's in docstring position.
+ (save-excursion
+ (when (functionp docelt)
+ (goto-char (match-end 1))
+ (setq docelt (funcall docelt)))
+ (goto-char listbeg)
+ (forward-char 1)
+ (condition-case nil
+ (while (and (> docelt 0) (< (point) startpos)
+ (progn (forward-sexp 1) t))
+ (setq docelt (1- docelt)))
+ (error nil))
+ (and (zerop docelt) (<= (point) startpos)
+ (progn (forward-comment (point-max)) t)
+ (= (point) startpos))))))
+
+ (defun lisp-string-after-doc-keyword-p (listbeg startpos)
+ (and listbeg ; we are inside a Lisp form
+ (let* ((ok nil)
+ (prevsym (save-excursion
+ (goto-char startpos)
+ (condition-case nil
+ (progn (backward-sexp 1) (setf ok t))
+ (error nil))
+ (and ok
+ (looking-at "\\(\\sw+\\)")
+ (match-string 1)))))
+ (equal prevsym ":documentation"))))
+
(defun lisp-font-lock-syntactic-face-function (state)
(if (nth 3 state)
;; This might be a (doc)string or a |...| symbol.
***************
*** 157,188 ****
(if (eq (char-after startpos) ?|)
;; This is not a string, but a |...| symbol.
nil
! (let* ((listbeg (nth 1 state))
! (firstsym (and listbeg
! (save-excursion
! (goto-char listbeg)
! (and (looking-at "([ \t\n]*\\(\\(\\sw\\|\\s_\\)+\\)")
! (match-string 1)))))
! (docelt (and firstsym
! (function-get (intern-soft firstsym)
! lisp-doc-string-elt-property))))
! (if (and docelt
! ;; It's a string in a form that can have a docstring.
! ;; Check whether it's in docstring position.
! (save-excursion
! (when (functionp docelt)
! (goto-char (match-end 1))
! (setq docelt (funcall docelt)))
! (goto-char listbeg)
! (forward-char 1)
! (condition-case nil
! (while (and (> docelt 0) (< (point) startpos)
! (progn (forward-sexp 1) t))
! (setq docelt (1- docelt)))
! (error nil))
! (and (zerop docelt) (<= (point) startpos)
! (progn (forward-comment (point-max)) t)
! (= (point) (nth 8 state)))))
font-lock-doc-face
font-lock-string-face))))
font-lock-comment-face))
--- 197,205 ----
(if (eq (char-after startpos) ?|)
;; This is not a string, but a |...| symbol.
nil
! (let ((listbeg (nth 1 state)))
! (if (or (lisp-string-in-doc-position-p listbeg startpos)
! (lisp-string-after-doc-keyword-p listbeg startpos))
font-lock-doc-face
font-lock-string-face))))
font-lock-comment-face))
next prev parent reply other threads:[~2014-03-25 17:54 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-07-20 16:50 bug#9130: 23.3; Lisp mode doc string enhancment Robert Brown
2011-08-02 20:01 ` Stefan Monnier
2014-03-25 17:54 ` Robert Brown [this message]
2014-06-19 14:04 ` bug#9130: 23.3; Lisp mode doc string enhancement Stefan Monnier
2015-12-16 17:10 ` bug#9130: Document Lisp mode fontification for strings after :documentation Shakthi Kannan
2015-12-16 17:53 ` Eli Zaretskii
2015-12-16 18:07 ` Shakthi Kannan
2015-12-16 18:47 ` Eli Zaretskii
2015-12-16 18:54 ` Shakthi Kannan
2015-12-16 18:56 ` Eli Zaretskii
2015-12-17 16:59 ` Shakthi Kannan
2015-12-18 15:35 ` Eli Zaretskii
2015-12-18 15:58 ` Shakthi Kannan
2015-12-18 16:10 ` Eli Zaretskii
2015-12-30 6:22 ` Shakthi Kannan
2015-12-30 18:02 ` Eli Zaretskii
2015-12-31 0:09 ` Xue Fuqiao
2015-12-31 5:32 ` Shakthi Kannan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAPNkkp=noQY2BRyFqLLCayjc+qF11RmMri0TzMBi+LJQc499UQ@mail.gmail.com' \
--to=robert.brown@gmail.com \
--cc=9130@debbugs.gnu.org \
--cc=monnier@iro.umontreal.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).