pretty highlighting and indenting own elisp macros

pretty highlighting and indenting own elisp macros

[Klaus Berndl]

If i add a call to `with-temp-file' in my elisp-program it will be highlighted
with font-lock-keyword-face and indented like follows:

(with-temp-file "my-filename"
  (foo ...)
  (bar ...))

Fine. But suppose i have written my own macro `with-XYZ':

(defmacro with-XYZ (arg &rest body)
 ....)

If i add this macro to my elisp-program then it is not highlighted as keyword
and it is poorly indented:

(with-XYZ "my-first-arg"
          (first-form-of-body ..)
          ...)

What must i do so my own macros are highlighted and indented as build-in macros
like `with-temp-file'? The former one seems to be not so hard but for the
second one i have no glue.

Many thanks in advance,
Klaus

-- 
Klaus Berndl			mailto: klaus.berndl@sdm.de
sd&m AG				http://www.sdm.de
software design & management	
Thomas-Dehler-Str. 27, 81737 München, Germany
Tel +49 89 63812-392, Fax -220

Re: pretty highlighting and indenting own elisp macros

[Stefan Monnier <foo@acm.com>]

>>>>> "Klaus" == Klaus Berndl <Klaus.Berndl@sdm.de> writes:
> What must i do so my own macros are highlighted and indented as build-in
> macros like `with-temp-file'? The former one seems to be not so hard but
> for the second one i have no glue.

You specify it via a symbol property.
Check out (symbol-plist 'with-temp-file) and you should see
something about indentation in the output.  Same thing for
edebugging.


        Stefan

Re: pretty highlighting and indenting own elisp macros

[Kevin Rodgers]

Klaus Berndl wrote:

> If i add a call to `with-temp-file' in my elisp-program it will be highlighted
> with font-lock-keyword-face and indented like follows:
> 
> (with-temp-file "my-filename"
>   (foo ...)
>   (bar ...))
> 
> Fine. But suppose i have written my own macro `with-XYZ':
> 
> (defmacro with-XYZ (arg &rest body)
>  ....)
> 
> If i add this macro to my elisp-program then it is not highlighted as keyword
> and it is poorly indented:
> 
> (with-XYZ "my-first-arg"
>           (first-form-of-body ..)
>           ...)
> 
> What must i do so my own macros are highlighted and indented as build-in macros
> like `with-temp-file'? The former one seems to be not so hard but for the
> second one i have no glue.

;;; Local Variables:
;;; eval: (put 'with-XYZ 'lisp-indent-hook 1)
;;; End:

-- 
<a href="mailto:&lt;kevinr&#64;ihs.com&gt;">Kevin Rodgers</a>

Re: pretty highlighting and indenting own elisp macros

[Klaus Berndl]

On Wed, 16 Oct 2002, Kevin Rodgers wrote:



>  Klaus Berndl wrote:
>  
> > If i add a call to `with-temp-file' in my elisp-program it will be
> > highlighted with font-lock-keyword-face and indented like follows:
> > (with-temp-file "my-filename"
> >   (foo ...)
> >   (bar ...))
> > Fine. But suppose i have written my own macro `with-XYZ':
> > (defmacro with-XYZ (arg &rest body)
> >  ....)
> > If i add this macro to my elisp-program then it is not highlighted
> > as keyword
> > and it is poorly indented:
> > (with-XYZ "my-first-arg"
> >           (first-form-of-body ..)
> >           ...)
> > What must i do so my own macros are highlighted and indented as
> > build-in macros
> > like `with-temp-file'? The former one seems to be not so hard but for the
> > second one i have no glue.
>  
>  ;;; Local Variables:
>  ;;; eval: (put 'with-XYZ 'lisp-indent-hook 1)
>  ;;; End:

Ahh, nice...but where can i find such tricks in the documentation?
I have search all the elisp-info files and haven't found *lisp-indent-hook*.

Thanks a lot!
Klaus

-- 
Klaus Berndl			mailto: klaus.berndl@sdm.de
sd&m AG				http://www.sdm.de
software design & management	
Thomas-Dehler-Str. 27, 81737 München, Germany
Tel +49 89 63812-392, Fax -220

Re: pretty highlighting and indenting own elisp macros

[Hannu Koivisto]

Klaus Berndl <Klaus.Berndl@sdm.de> writes:

> On Wed, 16 Oct 2002, Kevin Rodgers wrote:
...
>>  ;;; Local Variables:
>>  ;;; eval: (put 'with-XYZ 'lisp-indent-hook 1)

It should be lisp-indent-function, not -hook.

>>  ;;; End:
>
> Ahh, nice...but where can i find such tricks in the documentation?

See the node Lisp Indent in the Emacs manual.

-- 
Hannu

Re: pretty highlighting and indenting own elisp macros

[Stefan Monnier <foo@acm.com>]

>> ;;; Local Variables:
>> ;;; eval: (put 'with-XYZ 'lisp-indent-hook 1)
>> ;;; End:
> Ahh, nice...but where can i find such tricks in the documentation?
> I have search all the elisp-info files and haven't found *lisp-indent-hook*.

Maybe a typo?

work/emacs-0% grep lisp-indent-function man/*.texi
man/programs.texi:@cindex @code{lisp-indent-function} property
man/programs.texi:functions, according to the @code{lisp-indent-function} property of the
work/emacs-0% 

I think it also appears in the elisp manual:

work/emacs-0% grep lisp-indent-function lispref/*.texi
lispref/hooks.texi:@item lisp-indent-function
lispref/symbols.texi:(lisp-indent-function 0 byte-compile byte-compile-progn)
lispref/symbols.texi:Here @code{lisp-indent-function} and @code{byte-compile} are property
work/emacs-0% 


        Stefan

Re: pretty highlighting and indenting own elisp macros

[Klaus Berndl]

On 16 Oct 2002, Stefan Monnier wrote:



> >> ;;; Local Variables:
> >> ;;; eval: (put 'with-XYZ 'lisp-indent-hook 1)
> >> ;;; End:
> > Ahh, nice...but where can i find such tricks in the documentation? I have
> > search all the elisp-info files and haven't found *lisp-indent-hook*.
>  
>  Maybe a typo?
>  
>  work/emacs-0% grep lisp-indent-function man/*.texi
>  man/programs.texi:@cindex @code{lisp-indent-function} property
>  man/programs.texi:functions, according to the @code{lisp-indent-function}
>  property of the work/emacs-0%
>  
>  I think it also appears in the elisp manual:

Yes, if i search for the right expression ;-) Thanks to all,
lisp-indent-function does the trick.

Klaus

-- 
Klaus Berndl			mailto: klaus.berndl@sdm.de
sd&m AG				http://www.sdm.de
software design & management	
Thomas-Dehler-Str. 27, 81737 München, Germany
Tel +49 89 63812-392, Fax -220