bug#2984: deftype bad fontification

bug#2984: deftype bad fontification

[Robert Brown]

If you have the following Common Lisp code in a file called foo.lisp:

    (deftype foobar () "documentation" '(unsigned-byte 64))

font lock mode will display the documentation string using, I believe,
font-lock-string-face.  Instead, font-lock-doc-face should be used.
To fix the problem, look for

    (put 'defun    'doc-string-elt 3)

in lisp/emacs-lisp/lisp-mode.el and add the following line after it:

    (put 'deftype 'doc-string-elt 3)

That is, deftype should be treated just as defun or defmacro for the purpose
of fontifying the documentation string.

This bug is present in recent CVS versions of Emacs.



In GNU Emacs 22.0.55.1 (i686-pc-linux-gnu)
 of 2006-10-02 on eugene.nyc.corp.google.com
configured using `configure '--prefix=/local/software/package/emacs-22.0.55.4''

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
  locale-coding-system: utf-8
  default-enable-multibyte-characters: t

Major mode: Lisp

Minor modes in effect:
  eldoc-mode: t
  shell-dirtrack-mode: t
  slime-highlight-edits-mode: t
  slime-mode: t
  encoded-kbd-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  unify-8859-on-encoding-mode: t
  utf-translate-cjk-mode: t
  auto-compression-mode: t
  line-number-mode: t

Recent input:
DEL DEL DEL DEL i g n e d - b y t e SPC 6 4 ) ) RET 
C-x C-f $ E L I S P TAB e m a c s TAB e DEL i TAB l 
i s p TAB - m o TAB RET C-s d e f u n SPC C-a C-n C-n 
C-n C-n C-n C-n C-n C-n C-n C-n C-x b RET ESC x e m 
a c s = - DEL DEL DEL s - b u TAB ESC DEL ESC DEL r 
e p o r t - TAB RET

Recent messages:
Loading easy-mmode...done
Loading derived...done
Loading edmacro...done
Loading byte-opt...done
Loading /local/software/source-trees/slime/slime.el (source)...done
Loading eldoc...done
Auto-saving...done
Making completion list...
Mark saved where search started
Loading emacsbug...done

bug#2984: marked as done (deftype bad fontification)

[Emacs bug Tracking System]

[-- Attachment #1: Type: text/plain, Size: 836 bytes --]


Your message dated Thu, 16 Apr 2009 00:33:49 -0400
with message-id <87d4bdxln6.fsf@cyd.mit.edu>
and subject line Re: deftype bad fontification
has caused the Emacs bug report #2984,
regarding deftype bad fontification
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@emacsbugs.donarmstrong.com
immediately.)


-- 
2984: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=2984
Emacs Bug Tracking System
Contact owner@emacsbugs.donarmstrong.com with problems

[-- Attachment #2: Type: message/rfc822, Size: 4630 bytes --]

From: Robert Brown <brown@google.com>
To: emacs-pretest-bug@gnu.org
Cc: 
Subject: deftype bad fontification
Date: Mon, 13 Apr 2009 12:32:17 -0400
Message-ID: <u9ar5zwwm3y.fsf@paradicsom.nyc.corp.google.com>

If you have the following Common Lisp code in a file called foo.lisp:

    (deftype foobar () "documentation" '(unsigned-byte 64))

font lock mode will display the documentation string using, I believe,
font-lock-string-face.  Instead, font-lock-doc-face should be used.
To fix the problem, look for

    (put 'defun    'doc-string-elt 3)

in lisp/emacs-lisp/lisp-mode.el and add the following line after it:

    (put 'deftype 'doc-string-elt 3)

That is, deftype should be treated just as defun or defmacro for the purpose
of fontifying the documentation string.

This bug is present in recent CVS versions of Emacs.



In GNU Emacs 22.0.55.1 (i686-pc-linux-gnu)
 of 2006-10-02 on eugene.nyc.corp.google.com
configured using `configure '--prefix=/local/software/package/emacs-22.0.55.4''

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
  locale-coding-system: utf-8
  default-enable-multibyte-characters: t

Major mode: Lisp

Minor modes in effect:
  eldoc-mode: t
  shell-dirtrack-mode: t
  slime-highlight-edits-mode: t
  slime-mode: t
  encoded-kbd-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  unify-8859-on-encoding-mode: t
  utf-translate-cjk-mode: t
  auto-compression-mode: t
  line-number-mode: t

Recent input:
DEL DEL DEL DEL i g n e d - b y t e SPC 6 4 ) ) RET 
C-x C-f $ E L I S P TAB e m a c s TAB e DEL i TAB l 
i s p TAB - m o TAB RET C-s d e f u n SPC C-a C-n C-n 
C-n C-n C-n C-n C-n C-n C-n C-n C-x b RET ESC x e m 
a c s = - DEL DEL DEL s - b u TAB ESC DEL ESC DEL r 
e p o r t - TAB RET

Recent messages:
Loading easy-mmode...done
Loading derived...done
Loading edmacro...done
Loading byte-opt...done
Loading /local/software/source-trees/slime/slime.el (source)...done
Loading eldoc...done
Auto-saving...done
Making completion list...
Mark saved where search started
Loading emacsbug...done



[-- Attachment #3: Type: message/rfc822, Size: 1360 bytes --]

From: Chong Yidong <cyd@stupidchicken.com>
To: Robert Brown <brown@google.com>
Cc: 2984-done@emacsbugs.donarmstrong.com
Subject: Re: deftype bad fontification
Date: Thu, 16 Apr 2009 00:33:49 -0400
Message-ID: <87d4bdxln6.fsf@cyd.mit.edu>

> If you have the following Common Lisp code in a file called foo.lisp:
>
>     (deftype foobar () "documentation" '(unsigned-byte 64))
>
> font lock mode will display the documentation string using, I believe,
> font-lock-string-face.  Instead, font-lock-doc-face should be used.

I've checked in the fix you suggested.  Thanks.