File:  [gforth] / gforth / kernel / require.fs
Revision 1.14: download - view: text, annotated - select for diffs
Wed Sep 6 20:30:07 2000 UTC (21 years ago) by anton
Branches: MAIN
CVS tags: HEAD
improved error messages for errors happening in non-files.

    1: \ require.fs
    2: 
    3: \ Copyright (C) 1995,1996,1997,1998 Free Software Foundation, Inc.
    4: 
    5: \ This file is part of Gforth.
    6: 
    7: \ Gforth is free software; you can redistribute it and/or
    8: \ modify it under the terms of the GNU General Public License
    9: \ as published by the Free Software Foundation; either version 2
   10: \ of the License, or (at your option) any later version.
   11: 
   12: \ This program is distributed in the hope that it will be useful,
   13: \ but WITHOUT ANY WARRANTY; without even the implied warranty of
   14: \ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   15: \ GNU General Public License for more details.
   16: 
   17: \ You should have received a copy of the GNU General Public License
   18: \ along with this program; if not, write to the Free Software
   19: \ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   20: 
   21: \ Now: Kernel Module, Reloadable
   22: 
   23: create included-files 0 , 0 , ( pointer to and count of included files )
   24: here ," \a file/" dup c@ swap 1 + swap
   25: here ," \a block/" dup c@ swap 1 + swap
   26: here ," \evaluated string/" dup c@ swap 1 + swap
   27: here ," \the terminal/" dup c@ swap 1 + swap
   28: , A, , A, , A, , A, here 8 cells -
   29: create image-included-files 4 , A, ( pointer to and count of included files )
   30: \ included-files points to ALLOCATEd space, while image-included-files
   31: \ points to ALLOTed objects, so it survives a save-system
   32: 
   33: : sourcefilename ( -- c-addr u ) \ gforth
   34:     \G The name of the source file which is currently the input
   35:     \G source.  The result is valid only while the file is being
   36:     \G loaded.  If the current input source is no (stream) file, the
   37:     \G result is undefined.  In Gforth, the result is valid during the
   38:     \G whole seesion (but not across @code{savesystem} etc.).
   39:     loadfilename# @ loadfilename#>str ;
   40: 
   41: : sourceline# ( -- u ) \ gforth		sourceline-number
   42:     \G The line number of the line that is currently being interpreted
   43:     \G from a (stream) file. The first line has the number 1. If the
   44:     \G current input source is not a (stream) file, the result is
   45:     \G undefined.
   46:     loadline @ ;
   47: 
   48: : init-included-files ( -- ) \ gforth-internal
   49:     image-included-files 2@ 2* cells save-mem drop ( addr )
   50:     image-included-files 2@ nip included-files 2! ;
   51: 
   52: : included? ( c-addr u -- f ) \ gforth
   53:     \G True only if the file @var{c-addr u} is in the list of earlier
   54:     \G included files. If the file has been loaded, it may have been
   55:     \G specified as, say, @file{foo.fs} and found somewhere on the
   56:     \G Forth search path. To return @code{true} from @code{included?},
   57:     \G you must specify the exact path to the file, even if that is
   58:     \G @file{./foo.fs}
   59:     included-files 2@ 0
   60:     ?do ( c-addr u addr )
   61: 	dup >r 2@ 2over compare 0=
   62: 	if
   63: 	    2drop rdrop unloop
   64: 	    true EXIT
   65: 	then
   66: 	r> cell+ cell+
   67:     loop
   68:     2drop drop false ;
   69: 
   70: : add-included-file ( c-addr u -- ) \ gforth
   71:     \G add name c-addr u to included-files
   72:     included-files 2@ 2* cells 2 cells extend-mem
   73:     2/ cell / included-files 2!
   74:     2! ;
   75: 
   76: : included1 ( i*x file-id c-addr u -- j*x ) \ gforth
   77:     \G Include the file file-id with the name given by @var{c-addr u}.
   78:     loadfilename# @ >r
   79:     save-mem add-included-file ( file-id )
   80:     included-files 2@ nip 1- loadfilename# !
   81:     ['] include-file2 catch
   82:     r> loadfilename# !
   83:     throw ;
   84:     
   85: : included ( i*x c-addr u -- j*x ) \ file
   86:     \G @code{include-file} the file whose name is given by the string
   87:     \G @var{c-addr u}.
   88:     open-fpath-file throw included1 ;
   89: 
   90: : required ( i*x addr u -- j*x ) \ gforth
   91:     \G @code{include-file} the file with the name given by @var{addr
   92:     \G u}, if it is not @code{included} (or @code{required})
   93:     \G already. Currently this works by comparing the name of the file
   94:     \G (with path) against the names of earlier included files.
   95:     \ however, it may be better to fstat the file,
   96:     \ and compare the device and inode. The advantages would be: no
   97:     \ problems with several paths to the same file (e.g., due to
   98:     \ links) and we would catch files included with include-file and
   99:     \ write a require-file.
  100:     open-fpath-file throw 2dup included?
  101:     if
  102: 	2drop close-file throw
  103:     else
  104: 	included1
  105:     then ;
  106: 
  107: \ INCLUDE                                               9may93jaw
  108: 
  109: : include  ( ... "file" -- ... ) \ gforth
  110:     \G @code{include-file} the file @var{file}.
  111:     name included ;
  112: 
  113: : require  ( ... "file" -- ... ) \ gforth
  114:     \G @code{include-file} @var{file} only if it is not included already.
  115:     name required ;
  116: 
  117: \ : \I
  118: \   here 
  119: \   0 word count
  120: \   string,
  121: \   needsrcs^ @ ! ;
  122: 
  123: \ : .included ( -- ) \ gforth
  124: \     \G list the names of the files that have been @code{included}
  125: \   cr
  126: \   needs^ @
  127: \   BEGIN		dup 
  128: \   WHILE		dup cell+ count type cr
  129: \ 		5 spaces
  130: \ 		dup cell+ count + aligned
  131: \ 		@ dup IF count type ELSE drop THEN cr
  132: \ 		@
  133: \   REPEAT
  134: \   drop ;
  135: 
  136: \ : loadfilename#>str ( n -- adr len )
  137: \ \ this converts the filenumber into the string
  138: \   loadfilenamecount @ swap -
  139: \   needs^ @
  140: \   swap 0 ?DO dup 0= IF LEAVE THEN @ LOOP 
  141: \   dup IF cell+ count ELSE drop s" NOT FOUND" THEN ;
  142: 
  143: : loadfilename#>str ( n -- adr len )
  144:     included-files 2@ drop swap 2* cells + 2@ ;
  145: 
  146: : .strings ( addr u -- ) \ gforth
  147:     \G list the strings from an array of string descriptors at addr
  148:     \G with u entries, one per line.
  149:     2* cells bounds ?DO
  150: 	cr I 2@ type 2 cells +LOOP ;
  151: 
  152: : .included ( -- ) \ gforth
  153:     \G list the names of the files that have been @code{included}
  154:     included-files 2@ .strings ;
  155:     
  156: \ contains tools/newrequire.fs
  157: \ \I $Id: require.fs,v 1.14 2000/09/06 20:30:07 anton Exp $
  158: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>