FSF like smart header

FSF like smart header

[Andrea Crotti]

I want to have some nice system to have finally some sort of smart
header in front of some files.

For example it would be nice something like:
when you create a file of c-mode in such directory, add a header on top
with those datas (author time, name of the project etc...)

So I guess I have to add a hook to find-file with some conditions, or is
there something more elaborate?

I would also like to use yasnippet, can I maybe pass some parameters to
a yasnippet snippet to expand automatically some variables (haven't seen
anything like that).

For the timestamp I can use the already nice defined time-stamp
functions...

What do you guys have as personal setup for these kind of things?

Thanks!

PS. another useful useage would be automatic addition of guard in files .h...

Re: FSF like smart header

[Erik Iverson]

Andrea Crotti wrote:
> I want to have some nice system to have finally some sort of smart
> header in front of some files.
> 
> For example it would be nice something like:
> when you create a file of c-mode in such directory, add a header on top
> with those datas (author time, name of the project etc...)
> 
> So I guess I have to add a hook to find-file with some conditions, or is
> there something more elaborate?

http://www.gnu.org/software/emacs/manual/html_node/autotype/Autoinserting.html

RE: FSF like smart header

[Drew Adams]

> > I want to have some nice system to have finally some sort of smart
> > header in front of some files.
> > 
> > For example it would be nice something like:
> > when you create a file of c-mode in such directory, add a 
> > header on top with those datas (author time, name of the
> > project etc...)
> > 
> > So I guess I have to add a hook to find-file with some 
> > conditions, or is there something more elaborate?
> 
> http://www.gnu.org/software/emacs/manual/html_node/autotype/Au
> toinserting.html

More generally (includes info about the previous feature):
http://www.emacswiki.org/emacs/AutomaticFileHeaders

Re: FSF like smart header

[Andrea Crotti]

"Drew Adams" <drew.adams@oracle.com> writes:

> More generally (includes info about the previous feature):
> http://www.emacswiki.org/emacs/AutomaticFileHeaders

Given that I didn't like that too much and I prefer using yasnippet I
did this simple thing for header files (but can be adapted to anything)

--8<---------------cut here---------------start------------->8---
(defun is-header (file)
  "Check if file is an header"
  (equal "h" (file-name-extension file)))
      

(defun my-h-header ()
  "try to insert the header smartly"
  (if
      (is-header buffer-file-name)
      (progn 
        (insert "once")
        (yas/expand))))

(add-hook 'c-mode-hook 'my-h-header)
--8<---------------cut here---------------end--------------->8---

Which is pretty nice :)

Re: FSF like smart header

[Andrea Crotti]

I head another idea to make it more general:
--8<---------------cut here---------------start------------->8---
;; (mode . (regexp snippet)
(setq auto-snips
             '((c-mode . '('h' "once"))
               (python-mode . (t "!"))))

(defun smart-snips()
  (let
      ((found (assoc major-mode auto-snips)))
    (if (and
         found
         (string-match (nth 0 found) major-mode)
         (yes-or-no-p "insert the header?"))
        (progn
          (insert (nth 1 found))
          (yas/expand)))))
--8<---------------cut here---------------end--------------->8---

In this way we define for every language (and possibly extension) what
snippet we want to expand when we create a file.

Then adding smart-snips to "find-file-hook" would do the rest of the magic.

It doesn't work yet because I guess c-mode is a symbol and string-match
doesn't like it.
Don't know if I should just use the string representation or if there's
a smarter way...

Re: FSF like smart header

[Richard Riley]

Andrea Crotti <andrea.crotti.0@gmail.com> writes:

> I head another idea to make it more general:
>
>
> ;; (mode . (regexp snippet)
> (setq auto-snips
>              '((c-mode . '('h' "once"))
>                (python-mode . (t "!"))))
>
> (defun smart-snips()
>   (let
>       ((found (assoc major-mode auto-snips)))
>     (if (and
>          found
>          (string-match (nth 0 found) major-mode)
>          (yes-or-no-p "insert the header?"))
>         (progn
>           (insert (nth 1 found))
>           (yas/expand)))))
>
>
>
> In this way we define for every language (and possibly extension) what
> snippet we want to expand when we create a file.
>
> Then adding smart-snips to "find-file-hook" would do the rest of the magic.
>
> It doesn't work yet because I guess c-mode is a symbol and string-match
> doesn't like it.
> Don't know if I should just use the string representation or if there's
> a smarter way...
>
>
>
>

FYI - Whats does this provide that other existing packages to auto
create headers for certain file types do not?

http://www.emacswiki.org/emacs/AutomaticFileHeaders

It's maintained by Drew and seems pretty comprehensive.

RE: FSF like smart header

[Drew Adams]

> FYI - Whats does this provide that other existing packages to auto
> create headers for certain file types do not?
> 
> http://www.emacswiki.org/emacs/AutomaticFileHeaders
> It's maintained by Drew and seems pretty comprehensive.

Just to clarify -

That page lists several different packages that create or update file headers.
I maintain only one of them, header2.el.

Re: FSF like smart header

[Andrea Crotti]

Richard Riley <rileyrg@gmail.com> writes:

> FYI - Whats does this provide that other existing packages to auto
> create headers for certain file types do not?
>
> http://www.emacswiki.org/emacs/AutomaticFileHeaders
>
> It's maintained by Drew and seems pretty comprehensive.

Probably nothing, but I prefer to keep everything in yasnippet if
possible.

I think in general is much more powerful than normal skeletons, and
anyway is very easy as you saw to extend it in this way...

Re: FSF like smart header

[Tim X]

Andrea Crotti <andrea.crotti.0@gmail.com> writes:

> I want to have some nice system to have finally some sort of smart
> header in front of some files.
>
> For example it would be nice something like:
> when you create a file of c-mode in such directory, add a header on top
> with those datas (author time, name of the project etc...)
>
> So I guess I have to add a hook to find-file with some conditions, or is
> there something more elaborate?
>
> I would also like to use yasnippet, can I maybe pass some parameters to
> a yasnippet snippet to expand automatically some variables (haven't seen
> anything like that).
>
> For the timestamp I can use the already nice defined time-stamp
> functions...
>
> What do you guys have as personal setup for these kind of things?
>
> Thanks!
>
I use the following, based on tempo, which puts a standard header block in my files. It
uses the omment character of the major mode to determine how to put the
header in as a comment. It uses timestamp.el to handle the timestamps.
Each time the file is saved, the timestamp is automatically updated. It
could also be easily updated to use environment variables to control the
author etc. 

;;;								   
;;;      Filename: /home/tcross/.emacs.d/55tempo.el
;;; Creation Date: Wednesday, 30 April 2003 11:41 AM EST
;;; Last Modified: Saturday, 19 July 2008 12:44 PM EST
;;;           Job: private
;;;        Author: Tim Cross <tcross@pobox.une.edu.au>
;;;   Description:
;;; This file contains some temp templates for setting file headers. 
;;; 

(require 'tempo)


(tempo-define-template "generic-header"
        '((format "%s" comment-start)
          "      Filename: " (file-name-nondirectory (buffer-file-name)) 'n
          (format "%s" comment-start) " Creation Date: "
          (format-time-string "%A, %d %B %Y %I:%M %p %Z") 'n
          (format "%s" comment-start) " Last Modified: " 'n
          (format "%s" comment-start)
          "        Author: Tim Cross <tcross@xxxx>" 'n
          (format "%s" comment-start) "   Description:" 'n
          (format "%s" comment-start) 'n
          'n))

;;; Lets setup some key bindings.

(global-set-key [(f5)] 'tempo-template-generic-header)

(provide 'tc-template)


-- 
tcross (at) rapttech dot com dot au