\ VI tags support for GNU Forth.
\ Copyright (C) 1995,1998,2002,2003,2007,2008 Free Software Foundation, Inc.
\ This file is part of Gforth.
\ Gforth is free software; you can redistribute it and/or
\ modify it under the terms of the GNU General Public License
\ as published by the Free Software Foundation, either version 3
\ of the License, or (at your option) any later version.
\ This program is distributed in the hope that it will be useful,
\ but WITHOUT ANY WARRANTY; without even the implied warranty of
\ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\ GNU General Public License for more details.
\ You should have received a copy of the GNU General Public License
\ along with this program. If not, see http://www.gnu.org/licenses/.
\ usage: gforth tags.fs your_files.fs ...
\ then: vi -t word_name
\ This does not work like etags; instead, the TAGS file is updated
\ during the normal Forth interpretation/compilation process.
\ The present version has several shortcomings: It always overwrites
\ the TAGS file instead of just the parts corresponding to the loaded
\ files, but you can have several tag tables in emacs. Every load
\ creates a new etags file and the user has to confirm that she wants
\ to use it.
\ Communication of interactive programs like emacs and Forth over
\ files is clumsy. There should be better cooperation between them
\ (e.g. via shared memory)
\ This is ANS Forth with the following serious environmental
\ dependences: the word LATEST must return a pointer to the last
\ header, NAME>STRING must convert that pointer to a string, and
\ HEADER must be a deferred word that is called to create the name.
\ Changes by David: Removed the blanks before and after the explicit
\ tag name, since that conflicts with Emacs' auto-completition. In
\ fact those blanks are not necessary, since search is performed on
\ the tag-text, rather than the tag name.
\ Changes by Erik Rossen: Reversed the order of the tagname and tagfile
\ and got rid of the trailing "$" in the address regexp. I also needed
\ to comment out search.fs since it sets the search order destructively
\ on my system. Added a bit more explanation on how to use tags.fs.
: tags-file-name ( -- c-addr u )
\ for now I use just tags; this may become more flexible in the
s" tags" ;
variable tags-file 0 tags-file !
create tags-line 128 chars allot
: skip-tags ( file-id -- )
\ reads in file until it finds the end or the loadfilename
: tags-file-id ( -- file-id )
tags-file @ 0= if
tags-file-name w/o create-file throw
\ 2dup file-status
\ if \ the file does not exist
\ drop w/o create-file throw
\ drop r/w open-file throw
\ dup skip-tags
tags-file @ ;
2variable last-loadfilename 0 0 last-loadfilename 2!
: put-load-file-name ( file-id -- )
sourcefilename r@ write-file throw
#tab r> emit-file throw ;
: put-tags-entry ( -- )
\ write the entry for the last name to the TAGS file
\ if the input is from a file and it is not a local name
source-id dup 0<> swap -1 <> and \ input from a file
current @ locals-list <> and \ not a local name
latest 0<> and \ not an anonymous (i.e. noname) header
latest name>string r@ write-file throw
#tab r@ emit-file throw
s" /^" r@ write-file throw
source drop >in @ r@ write-file throw
s" /" r@ write-line throw
: (tags-header) ( -- )
' (tags-header) IS header