Return to paths.fs CVS log

Up to [gforth] / gforth / kernel

Makefile.in

-- changes to make documentation build with moofglos.fs
   rather than with mini-oof.fs (since the former contains glossary
   entries and the latter does not)

assert.fs blocks.fs debug.fs environ.fs errors.fs extend.fs float.fs
glocals.fs moofglos.fs prim search.fs struct.fs stuff.fs vt100.fs
kernel/args.fs kernel/basics.fs kernel/comp.fs kernel/cond.fs
kernel/files.fs kernel/getdoers.fs kernel/int.fs kernel/io.fs
kernel/nio.fs kernel/paths.fs kernel/require.fs kernel/special.fs
kernel/tools.fs kernel/toolsext.fs kernel/vars.fs

-- many small changes to glossary entries.. I think most are done
   now, so I hope to change far fewer files next time!

doc/gforth.ds

-- many, many small changes and a few large ones. Moved some sections
   around, fixed typos and formatting errors, added new section on
   exception handling, rearranged 'files' section.

    1: \ paths.fs path file handling                                    03may97jaw
    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: \ -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 chars , 	\ maximum length (is checked)
   41: \ 		0 ,		\ real len
   42: \ 		100 chars allot \ space for path
   43: \ use the same functions as above with:
   44: \ mypath path+ 
   45: \ mypath path=
   46: \ mypath .path
   47: 
   48: \ do a open with the search path:
   49: \ open-path-file ( adr len path -- fd adr len ior )
   50: \ the file is opened read-only; if the file is not found an error is generated
   51: 
   52: \ questions to: wilke@jwdt.com
   53: 
   54: [IFUNDEF] +place
   55: : +place ( adr len adr )
   56:         2dup >r >r
   57:         dup c@ char+ + swap move
   58:         r> r> dup c@ rot + swap c! ;
   59: [THEN]
   60: 
   61: [IFUNDEF] place
   62: : place ( c-addr1 u c-addr2 )
   63:         2dup c! char+ swap move ;
   64: [THEN]
   65: 
   66: create sourcepath 1024 chars , 0 , 1024 chars allot \ !! make this dynamic
   67: sourcepath avalue fpath
   68: 
   69: : also-path ( adr len path^ -- )
   70:   >r
   71:   \ len check
   72:   r@ cell+ @ over + r@ @ u> ABORT" path buffer too small!"
   73:   \ copy into
   74:   tuck r@ cell+ dup @ cell+ + swap cmove
   75:   \ make delimiter
   76:   0 r@ cell+ dup @ cell+ + 2 pick + c! 1 + r> cell+ +!
   77:   ;
   78: 
   79: : only-path ( adr len path^ -- )
   80:   dup 0 swap cell+ ! also-path ;
   81: 
   82: : path+ ( path-addr  "dir" -- ) \ gforth
   83:     \G Add the directory @var{dir} to the search path @var{path-addr}.
   84:     name rot also-path ;
   85: 
   86: : fpath+ ( "dir" ) \ gforth
   87:     \G Add directory @var{dir} to the Forth search path.
   88:     fpath path+ ;
   89: 
   90: : path= ( path-addr "dir1|dir2|dir3" ) \ gforth
   91:     \G Make a complete new search path; the path separator is |.
   92:     name 2dup bounds ?DO i c@ '| = IF 0 i c! THEN LOOP
   93:     rot only-path ;
   94: 
   95: : fpath= ( "dir1|dir2|dir3" ) \ gforth
   96:     \G Make a complete new Forth search path; the path separator is |.
   97:     fpath path= ;
   98: 
   99: : path>counted  cell+ dup cell+ swap @ ;
  100: 
  101: : next-path ( adr len -- adr2 len2 )
  102:   2dup 0 scan
  103:   dup 0= IF     2drop 0 -rot 0 -rot EXIT THEN
  104:   >r 1+ -rot r@ 1- -rot
  105:   r> - ;
  106: 
  107: : previous-path ( path^ -- )
  108:   dup path>counted
  109:   BEGIN tuck dup WHILE repeat ;
  110: 
  111: : .path ( path-addr -- ) \ gforth
  112:     \G Display the contents of the search path @var{path-addr}.
  113:     path>counted
  114:     BEGIN next-path dup WHILE type space REPEAT 2drop 2drop ;
  115: 
  116: : .fpath ( -- ) \ gforth
  117:     \G Display the contents of the Forth search path.
  118:     fpath .path ;
  119: 
  120: : absolut-path? ( addr u -- flag ) \ gforth
  121:     \G A path is absolute if it starts with a / or a ~ (~ expansion),
  122:     \G or if it is in the form ./*, extended regexp: ^[/~]|./, or if
  123:     \G it has a colon as second character ("C:...").  Paths simply
  124:     \G containing a / are not absolute!
  125:     2dup 2 u> swap 1+ c@ ': = and >r \ dos absoulte: c:/....
  126:     over c@ '/ = >r
  127:     over c@ '~ = >r
  128:     \ 2dup 3 min S" ../" compare 0= r> or >r \ not catered for in expandtopic
  129:     2 min S" ./" compare 0=
  130:     r> r> r> or or or ;
  131: 
  132: Create ofile 0 c, 255 chars allot
  133: Create tfile 0 c, 255 chars allot
  134: 
  135: : pathsep? dup [char] / = swap [char] \ = or ;
  136: 
  137: : need/   ofile dup c@ + c@ pathsep? 0= IF s" /" ofile +place THEN ;
  138: 
  139: : extractpath ( adr len -- adr len2 )
  140:   BEGIN dup WHILE 1-
  141:         2dup + c@ pathsep? IF EXIT THEN
  142:   REPEAT ;
  143: 
  144: : remove~+ ( -- )
  145:     ofile count 3 min s" ~+/" compare 0=
  146:     IF
  147: 	ofile count 3 /string ofile place
  148:     THEN ;
  149: 
  150: : expandtopic ( -- ) \ stack effect correct? - anton
  151:     \ expands "./" into an absolute name
  152:     ofile count 2 min s" ./" compare 0=
  153:     IF
  154: 	ofile count 1 /string tfile place
  155: 	0 ofile c! sourcefilename extractpath ofile place need/
  156: 	tfile count over c@ pathsep? IF 1 /string THEN
  157: 	ofile +place
  158:     THEN ;
  159: 
  160: : compact.. ( adr len -- adr2 len2 )
  161: \ deletes phrases like "xy/.." out of our directory name 2dec97jaw
  162:   over >r -1 >r
  163:   BEGIN dup WHILE
  164: 	over c@ pathsep? 
  165: 	IF 	r@ -1 =
  166: 		IF	r> drop dup >r
  167: 		ELSE	2dup 1 /string 
  168: 			3 min s" ../" compare
  169: 			0=
  170: 			IF	r@ over - ( diff )
  171: 				2 pick swap - ( dest-adr )
  172: 				>r 3 /string r> swap 2dup >r >r
  173: 				move r> r>
  174: 			ELSE	r> drop dup >r
  175: 			THEN
  176: 		THEN
  177: 	THEN
  178: 	1 /string
  179:   REPEAT 
  180:   r> drop 
  181:   drop r> tuck - ;
  182: 
  183: : reworkdir ( -- )
  184:   remove~+
  185:   ofile count compact..
  186:   nip ofile c! ;
  187: 
  188: : open-ofile ( -- fid ior )
  189:     \G opens the file whose name is in ofile
  190:     expandtopic reworkdir
  191:     ofile count r/o open-file ;
  192: 
  193: : check-path ( adr1 len1 adr2 len2 -- fd 0 | 0 <>0 )
  194:   0 ofile ! >r >r ofile place need/
  195:   r> r> ofile +place
  196:   open-ofile ;
  197: 
  198: \ !! returns 2 stack items if file is not found, not just the ior
  199: : open-path-file ( addr1 u1 path-addr -- wfileid addr2 u2 0 | ior ) \ gforth
  200:     \G Look in path @var{path-addr} for the file specified by @var{addr1 u1}.
  201:     \G If found, the resulting path and an open file descriptor
  202:     \G are returned. If the file is not found, @var{ior} is non-zero.
  203:   >r
  204:   2dup absolut-path?
  205:   IF    rdrop
  206:         ofile place open-ofile
  207: 	dup 0= IF >r ofile count r> THEN EXIT
  208:   ELSE  r> path>counted
  209:         BEGIN  next-path dup
  210:         WHILE  5 pick 5 pick check-path
  211:         0= IF >r 2drop 2drop r> ofile count 0 EXIT ELSE drop THEN
  212:   REPEAT
  213:         2drop 2drop 2drop -&38
  214:   THEN ;
  215: 
  216: \ !! returns 2 stack items if file is not found, not just the ior
  217: : open-fpath-file ( addr1 u1 -- wfileid addr2 u2 0 | ior ) \ gforth
  218:     \G Look in the Forth search path for the file specified by @var{addr1 u1}.
  219:     \G If found, the resulting path and an open file descriptor
  220:     \G are returned. If the file is not found, @var{ior} is non-zero.
  221:     fpath open-path-file ;