Return to paths.fs CVS log

Up to [gforth] / gforth / kernel

updated the copyright year on many files
added FSF copyright header to complex.fs fft.fs regexp-test.fs regexp.fs
added fsl-util.fs to update-copyright-blacklist

    1: \ paths.fs path file handling                                    03may97jaw
    2: 
    3: \ Copyright (C) 1995,1996,1997,1998,2000,2003,2004,2005 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., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
   20: 
   21: \ -Changing the search-path:
   22: \ fpath+ <path> 	adds a directory to the searchpath
   23: \ fpath= <path>|<path>	makes complete now searchpath
   24: \ 			seperator is |
   25: \ .fpath		displays the search path
   26: \ remark I: 
   27: \ a ./ in the beginning of filename is expanded to the directory the
   28: \ current file comes from. ./ can also be included in the search-path!
   29: \ ~+/ loads from the current working directory
   30: 
   31: \ remark II:
   32: \ if there is no sufficient space for the search path increase it!
   33: 
   34: 
   35: \ -Creating custom paths:
   36: 
   37: \ It is possible to use the search mechanism on yourself.
   38: 
   39: \ Make a buffer for the path:
   40: \ create mypath	100 path,
   41: \ mypath path+ 
   42: \ mypath path=
   43: \ mypath .path
   44: 
   45: \ do a open with the search path:
   46: \ open-path-file ( adr len path -- fd adr len ior )
   47: \ the file is opened read-only; if the file is not found an error is generated
   48: 
   49: \ questions to: wilke@jwdt.com
   50: 
   51: : path-allot ( umax -- ) \ gforth
   52:     \G @code{Allot} a path with @i{umax} characters capacity, initially empty.
   53:     chars dup , 0 , allot ;
   54: 
   55: [IFUNDEF] +place
   56: : +place ( adr len adr )
   57:         2dup >r >r
   58:         dup c@ char+ + swap move
   59:         r> r> dup c@ rot + swap c! ;
   60: [THEN]
   61: 
   62: [IFUNDEF] place
   63: : place ( c-addr1 u c-addr2 )
   64:         2dup c! char+ swap move ;
   65: [THEN]
   66: 
   67: \ create sourcepath 1024 chars , 0 , 1024 chars allot \ !! make this dynamic
   68: 0 avalue fpath ( -- path-addr ) \ gforth
   69: 
   70: : os-cold ( -- )
   71:     $400 chars dup 2 cells + allocate throw to fpath
   72:     0 swap fpath 2!
   73:     pathstring 2@ fpath only-path 
   74:     init-included-files ;
   75: 
   76: \ The path Gforth uses for @code{included} and friends.
   77: 
   78: : also-path ( c-addr len path-addr -- ) \ gforth
   79:     \G add the directory @i{c-addr len} to @i{path-addr}.
   80:   >r
   81:   \ len check
   82:   r@ cell+ @ over + r@ @ u> ABORT" path buffer too small!"
   83:   \ copy into
   84:   tuck r@ cell+ dup @ cell+ + swap cmove
   85:   \ make delimiter
   86:   0 r@ cell+ dup @ cell+ + 2 pick + c! 1 + r> cell+ +!
   87: ;
   88: 
   89: : clear-path ( path-addr -- ) \ gforth
   90:     \G Set the path @i{path-addr} to empty.
   91:     0 swap cell+ ! ;
   92: 
   93: : only-path ( adr len path^ -- )
   94:     dup clear-path also-path ;
   95: 
   96: : path+ ( path-addr  "dir" -- ) \ gforth
   97:     \G Add the directory @var{dir} to the search path @var{path-addr}.
   98:     name rot also-path ;
   99: 
  100: : fpath+ ( "dir" ) \ gforth
  101:     \G Add directory @var{dir} to the Forth search path.
  102:     fpath path+ ;
  103: 
  104: : path= ( path-addr "dir1|dir2|dir3" ) \ gforth
  105:     \G Make a complete new search path; the path separator is |.
  106:     name 2dup bounds ?DO i c@ '| = IF 0 i c! THEN LOOP
  107:     rot only-path ;
  108: 
  109: : fpath= ( "dir1|dir2|dir3" ) \ gforth
  110:     \G Make a complete new Forth search path; the path separator is |.
  111:     fpath path= ;
  112: 
  113: : path>string ( path -- c-addr u )
  114:     \ string contains NULs to separate/terminate components
  115:     cell+ dup cell+ swap @ ;
  116: 
  117: : next-path ( addr u -- addr1 u1 addr2 u2 )
  118:     \ addr2 u2 is the first component of the path, addr1 u1 is the rest
  119:     2dup 0 scan
  120:     dup 0= IF     2drop 0 -rot 0 -rot EXIT THEN
  121:     >r 1+ -rot r@ 1- -rot
  122:     r> - ;
  123: 
  124: : previous-path ( path^ -- )
  125:     \ !! "fpath previous-path" doesn't work
  126:   dup path>string
  127:   BEGIN tuck dup WHILE repeat ;
  128: 
  129: : .path ( path-addr -- ) \ gforth
  130:     \G Display the contents of the search path @var{path-addr}.
  131:     path>string
  132:     BEGIN next-path dup WHILE type space REPEAT 2drop 2drop ;
  133: 
  134: : .fpath ( -- ) \ gforth
  135:     \G Display the contents of the Forth search path.
  136:     fpath .path ;
  137: 
  138: : absolut-path? ( addr u -- flag ) \ gforth
  139:     \G A path is absolute if it starts with a / or a ~ (~ expansion),
  140:     \G or if it is in the form ./*, extended regexp: ^[/~]|./, or if
  141:     \G it has a colon as second character ("C:...").  Paths simply
  142:     \G containing a / are not absolute!
  143:     2dup 2 u> swap 1+ c@ ': = and >r \ dos absoulte: c:/....
  144:     over c@ '/ = >r
  145:     over c@ '~ = >r
  146:     \ 2dup S" ../" string-prefix? r> or >r \ not catered for in expandtopic
  147:     S" ./" string-prefix?
  148:     r> r> r> or or or ;
  149: 
  150: Create ofile 0 c, 255 chars allot
  151: Create tfile 0 c, 255 chars allot
  152: 
  153: : pathsep? dup [char] / = swap [char] \ = or ;
  154: 
  155: : need/   ofile dup c@ + c@ pathsep? 0= IF s" /" ofile +place THEN ;
  156: 
  157: : extractpath ( adr len -- adr len2 )
  158:   BEGIN dup WHILE 1-
  159:         2dup + c@ pathsep? IF EXIT THEN
  160:   REPEAT ;
  161: 
  162: : remove~+ ( -- )
  163:     ofile count s" ~+/" string-prefix?
  164:     IF
  165: 	ofile count 3 /string ofile place
  166:     THEN ;
  167: 
  168: : expandtopic ( -- ) \ stack effect correct? - anton
  169:     \ expands "./" into an absolute name
  170:     ofile count s" ./" string-prefix?
  171:     IF
  172: 	ofile count 1 /string tfile place
  173: 	0 ofile c! sourcefilename extractpath ofile place
  174: 	\ care of / only if there is a directory
  175: 	ofile c@ IF need/ THEN
  176: 	tfile count over c@ pathsep? IF 1 /string THEN
  177: 	ofile +place
  178:     THEN ;
  179: 
  180: : del-string ( addr u u1 -- addr u2 )
  181:     \ delete u1 characters from string by moving stuff from further up
  182:     2 pick >r /string r@ over >r swap cmove 2r> ;
  183: 
  184: : del-./s ( addr u -- addr u2 )
  185:     \ deletes (/*./)* at the start of the string
  186:     BEGIN ( current-addr u )
  187: 	BEGIN ( current-addr u )
  188: 	    over c@ '/ = WHILE
  189: 		1 del-string
  190: 	REPEAT
  191: 	2dup s" ./" string-prefix? WHILE
  192: 	    2 del-string
  193:     REPEAT ;
  194: 
  195: : preserve-root ( addr1 u1 -- addr2 u2 )
  196:     over c@ '/ = if \ preserve / at start
  197: 	1 /string
  198:     endif ;
  199: 
  200: 
  201: : skip-..-prefixes ( addr1 u1 -- addr2 u2 )
  202:     \ deal with ../ at start
  203:     begin ( current-addr u )
  204: 	del-./s 2dup s" ../" string-prefix? while
  205: 	    3 /string
  206:     repeat ;
  207:     
  208: : compact-filename ( addr u1 -- addr u2 )
  209:     \ rewrite filename in place, eliminating multiple slashes, "./", and "x/.."
  210:     over swap preserve-root skip-..-prefixes
  211:     ( start current-addr u )
  212:     over swap '/ scan dup if ( start addr3 addr4 u4 )
  213: 	1 /string del-./s recurse
  214: 	2dup s" ../" string-prefix? if ( start addr3 addr4 u4 )
  215: 	    3 /string ( start to from count )
  216: 	    >r swap 2dup r@ cmove r>
  217: 	endif
  218:     endif
  219:     + nip over - ;
  220: 
  221: \ test cases:
  222: \ s" z/../../../a" compact-filename type cr
  223: \ s" ../z/../../../a/c" compact-filename type cr
  224: \ s" /././//./../..///x/y/../z/.././..//..//a//b/../c" compact-filename type cr
  225: 
  226: : reworkdir ( -- )
  227:   remove~+
  228:   ofile count compact-filename
  229:   nip ofile c! ;
  230: 
  231: : open-ofile ( -- fid ior )
  232:     \G opens the file whose name is in ofile
  233:     expandtopic reworkdir
  234:     ofile count r/o open-file ;
  235: 
  236: : check-path ( adr1 len1 adr2 len2 -- fd 0 | 0 <>0 )
  237:   0 ofile ! >r >r ofile place need/
  238:   r> r> ofile +place
  239:   open-ofile ;
  240: 
  241: \ !! allow arbitrary FAMs, not just R/O
  242: : open-path-file ( addr1 u1 path-addr -- wfileid addr2 u2 0 | ior ) \ gforth
  243:     \G Look in path @var{path-addr} for the file specified by @var{addr1 u1}.
  244:     \G If found, the resulting path and and (read-only) open file descriptor
  245:     \G are returned. If the file is not found, @var{ior} is non-zero.
  246:   >r
  247:   2dup absolut-path?
  248:   IF    rdrop
  249:         ofile place open-ofile
  250: 	dup 0= IF >r ofile count r> THEN EXIT
  251:   ELSE  r> path>string
  252:         BEGIN  next-path dup
  253:         WHILE  5 pick 5 pick check-path
  254:         0= IF >r 2drop 2drop r> ofile count 0 EXIT ELSE drop THEN
  255:   REPEAT
  256:         2drop 2drop 2drop -&37
  257:   THEN ;
  258: 
  259: : open-fpath-file ( addr1 u1 -- wfileid addr2 u2 0 | ior ) \ gforth
  260:     \G Look in the Forth search path for the file specified by @var{addr1 u1}.
  261:     \G If found, the resulting path and an open file descriptor
  262:     \G are returned. If the file is not found, @var{ior} is non-zero.
  263:     fpath open-path-file ;