From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Robert Brown Newsgroups: gmane.emacs.bugs Subject: bug#9130: 23.3; Lisp mode doc string enhancment Date: Wed, 20 Jul 2011 12:50:41 -0400 Message-ID: NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: dough.gmane.org 1311223869 5485 80.91.229.12 (21 Jul 2011 04:51:09 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Thu, 21 Jul 2011 04:51:09 +0000 (UTC) To: 9130@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Jul 21 06:51:05 2011 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1QjlE0-0004St-Ao for geb-bug-gnu-emacs@m.gmane.org; Thu, 21 Jul 2011 06:51:04 +0200 Original-Received: from localhost ([::1]:43823 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qjdsn-0005Rk-A9 for geb-bug-gnu-emacs@m.gmane.org; Wed, 20 Jul 2011 17:00:41 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:60834) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QjaAs-0008Jb-7E for bug-gnu-emacs@gnu.org; Wed, 20 Jul 2011 13:03:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QjaAq-0007gV-2A for bug-gnu-emacs@gnu.org; Wed, 20 Jul 2011 13:03:05 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:40057) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QjaAp-0007es-9w for bug-gnu-emacs@gnu.org; Wed, 20 Jul 2011 13:03:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1QjaAo-0001OZ-JY; Wed, 20 Jul 2011 13:03:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Robert Brown Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 20 Jul 2011 17:03:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 9130 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.13111813255291 (code B ref -1); Wed, 20 Jul 2011 17:03:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 20 Jul 2011 17:02:05 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qja9s-0001NH-9d for submit@debbugs.gnu.org; Wed, 20 Jul 2011 13:02:05 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qja9o-0001Mm-Gg for submit@debbugs.gnu.org; Wed, 20 Jul 2011 13:02:02 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Qja9g-0007GH-Qu for submit@debbugs.gnu.org; Wed, 20 Jul 2011 13:01:54 -0400 Original-Received: from lists.gnu.org ([140.186.70.17]:50378) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qja9f-0007G0-Rf for submit@debbugs.gnu.org; Wed, 20 Jul 2011 13:01:52 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:60312) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qja9c-0007pJ-B7 for bug-gnu-emacs@gnu.org; Wed, 20 Jul 2011 13:01:51 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Qja9Z-0007Dp-7f for bug-gnu-emacs@gnu.org; Wed, 20 Jul 2011 13:01:47 -0400 Original-Received: from smtp-out.google.com ([74.125.121.67]:12796) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QjZyz-0004yw-Dt for bug-gnu-emacs@gnu.org; Wed, 20 Jul 2011 12:50:51 -0400 Original-Received: from kpbe16.cbf.corp.google.com (kpbe16.cbf.corp.google.com [172.25.105.80]) by smtp-out.google.com with ESMTP id p6KGokNn005222 for ; Wed, 20 Jul 2011 09:50:47 -0700 Original-Received: from paradicsom.nyc.corp.google.com.google.com (paradicsom.nyc.corp.google.com [172.26.83.113]) by kpbe16.cbf.corp.google.com with ESMTP id p6KGoij6014375 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NOT) for ; Wed, 20 Jul 2011 09:50:45 -0700 X-System-Of-Record: true X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Wed, 20 Jul 2011 13:03:02 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:49504 Here is a change that enhances Lisp mode fontification to handle documentation of the form (:documentation "the doc string") 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)