Thread: [Win32forth-cvs] win32forth/doc Paths.htm,1.4,1.5

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/win32forth/win32forth/doc
In directory sc8-pr-cvs9.sourceforge.net:/tmp/cvs-serv17812/doc

Modified Files:
	Paths.htm 
Log Message:
Jos: Adapted to the new search-path.

Index: Paths.htm
===================================================================
RCS file: /cvsroot/win32forth/win32forth/doc/Paths.htm,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** Paths.htm	5 Aug 2006 12:27:39 -0000	1.4
--- Paths.htm	26 Aug 2006 15:27:21 -0000	1.5
***************
*** 1,19 ****
! <html>
  <head>
! <meta http-equiv="Content-Language" content="en-gb">
! <meta name="GENERATOR" content="dexh00">
! <meta name="ProgId" content="FrontPage.Editor.Document">
! <meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
! <title>
! </title><style><!--
! h1           { font-family: Tahoma; font-size: 24pt; font-weight: bold }
! h2           { font-family: Tahoma; font-size: 18pt; font-weight: bold } -->
  </style>
  </head>
! <body><h1 align="center">
! <a href="mailto:win...@ya...?subject=DOC:Doc error in $Id$">
! <img border="0" src="TELLUS.gif" align="left" width="32" height="32"></a>
! <img border="0" src="FORTHPRO.gif"
! width="32" height="32">&nbsp;&nbsp;Win32Forth</h1>
  <hr /><h1>Paths -- Multiple search path support
  </h1><hr /><h2>Glossary
--- 1,15 ----
! <?xml version="1.0"?>
! <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
!     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
! <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
! <meta http-equiv="Content-Type" content="text/xml; charset=iso-8859-1" />
! <meta name="GENERATOR" content="DexH v03" />
! <style type="text/css">
  </style>
+ <title>
+ </title>
  </head>
! <body>
  <hr /><h1>Paths -- Multiple search path support
  </h1><hr /><h2>Glossary
***************
*** 38,102 ****
  followed by 0. <br />
  In runtime it returns adres of the counted string of a path
! </p><pre><b><a name="8">: path-source &nbsp;&nbsp;( path-ptr &nbsp;- 2variable_path-source )
  </a></b></pre><p>Path-source points to a substring in a path. <br />
  Path-source returns this adress.
! </p><pre><b><a name="9">path: path-ptr
! </a></b></pre><p>Path-ptr defines the path buffer for Forth. Applications that let Forth
  compile should not change it in a way that Forth is not able too compile.
! </p><pre><b><a name="10">: next-path&quot; &nbsp;&nbsp;&nbsp;( path-ptr -- a1 n1 &nbsp;)
  </a></b></pre><p>Get the next path from dir list.
! </p><pre><b><a name="11">: reset-path-source &nbsp;&nbsp;&nbsp;&nbsp;( path-ptr -- &nbsp;)
  </a></b></pre><p>Points the path-source to the whole path.
! </p><pre><b><a name="12">: first-path&quot; &nbsp;&nbsp;( path-ptr -- a1 n1 &nbsp;)
  </a></b></pre><p>Get the first forth directory path.
! </p><pre><b><a name="13">: &quot;path+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( a1 n1 path-ptr -- )
  </a></b></pre><p>Append a directory to a path.
! </p><pre><b><a name="14">: &quot;fpath+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( a1 n1 -- )
  </a></b></pre><p>Append a directory to the Forth path.
! </p><pre><b><a name="15">: fpath+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( -&lt;directory&gt;- )
  </a></b></pre><p>Append a directory to the Forth path.
! </p><pre><b><a name="16">: .path &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( path-ptr -- )
  </a></b></pre><p>Display a directory search path list.
! </p><pre><b><a name="17">: .fpath &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( -- )
  </a></b></pre><p>Display the Forth directory search path list.
! </p><pre><b><a name="18">: volume-indication? ( adr - flag )
  </a></b></pre><p>True when the counted string at adr starts with x: or \name
! </p><pre><b><a name="19">: full-path &nbsp;{ a1 n1 path-ptr \ searchpath$ filename$ current$ -- a2 n2 f1 }
  </a></b></pre><p>Find file a1,n1 in a path and return the full path. <br />
  a2,n2 and f1=false, succeeded.
! </p><pre><b><a name="20">: program-path-init ( -- )
  </a></b></pre><p>Initialize the Forth directory search path list. Automatically done at program
  initialization and when Paths.f is loaded.
! </p><pre><b><a name="21">: &quot;path-file &nbsp;{ a1 n1 \ current$ -- a2 n2 f1 }
  </a></b></pre><p>Find file a1,n1 in the Forth path and return the full path. <br />
  a2,n2 and f1=false, succeeded.
! </p><pre><b><a name="22">: n&quot;open &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( a1 n1 -- handle f1 )
  </a></b></pre><p>Open file a1,n1 with a Forth path search.
! </p><pre><b><a name="23">: MakeAbsolutePath &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( a1 n1 a2 n2 -- a3 )
  </a></b></pre><p>Make path a1 n1 absolute to path a2 n2.
! </p><pre><b><a name="24">: IsPathRelativeTo? &nbsp;&nbsp;&nbsp;&nbsp;{ a1 n1 a2 n2 -- f }
  </a></b></pre><p>Return true if path a1 n1 is relative to path a2 n2
! </p><pre><b><a name="25">: MakePathRelativeTo &nbsp;&nbsp;&nbsp;( a1 n1 a2 n2 -- a3 )
  </a></b></pre><p>Make path a1 n1 relative to path a2 n2.
! </p><pre><b><a name="26">: FindRelativePath &nbsp;( a1 n1 path-ptr - a2 n2 )
! </a></b></pre><p>Returns a relative path for file a1 n1 in path-ptr ( first part ). <br />
  n2=0 means not in search path.
! </p><pre><b><a name="27">: FindRelativeName &nbsp;( a1 n1 path-ptr - a2 n2 f )
! </a></b></pre><p>Returns a releative name for file a1 n1 in path-ptr ( last-part ). <br />
  n2=0 means not in search path.
! </p><pre><b><a name="28">: &quot;LOADED? &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( addr len -- flag )
! </a></b></pre><p>True if a file addr len is loaded. The filename must cointain a full path.
! </p><pre><b><a name="29">: LOADED? &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( -&lt;name&gt;- -- flag ) &nbsp;{ \ current$ }
  </a></b></pre><p>True if the following file is loaded. The filename may be relative.
! </p><pre><b><a name="30">: \LOADED- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( -&lt;name&gt;- )
  </a></b></pre><p>If the following file IS NOT LOADED interpret line.
! </p><pre><b><a name="31">: \LOADED &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( -&lt;name&gt;- )
  </a></b></pre><p>&nbsp;If the following file IS LOADED interpret line.
! </p><pre><b><a name="32">: NEEDS &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( -&lt;name&gt;- )
  </a></b></pre><p>Conditionally load file &quot;name&quot; if not loaded.
! </p><pre><b><a name="33">synonym Require needs
  </a></b></pre><p>Forth 200X name for needs.
! </p><pre><b><a name="34">: &quot;file-clip&quot; &nbsp;&nbsp;{ adr len limit \ temp$ pre -- 'adr 'len }
  </a></b></pre><p>Clip filename to limit.
! </p><hr><p>Document $Id$</p>
  </body></html>
--- 34,104 ----
  followed by 0. <br />
  In runtime it returns adres of the counted string of a path
! </p><pre><b><a name="8">: path-source &nbsp;&nbsp;( path &nbsp;- 2variable_path-source )
  </a></b></pre><p>Path-source points to a substring in a path. <br />
  Path-source returns this adress.
! </p><pre><b><a name="9">path: path-ptr deprecated
! </a></b></pre><p>The old functionality had the bad habbit to pass a pointer through a
! value instead of passing the parameter over the stack. <br />
! Use win32forth\src\Compat\OldPaths.f for the old functionality. <br />
! Words like first-path&quot; and next-path&quot; are now able to handle
! each path separate without saving and restoring a path-ptr.
! </p><pre><b><a name="10">path: search-path
! </a></b></pre><p>search-path defines the path buffer for Forth.<br /> Applications that let Forth
  compile should not change it in a way that Forth is not able too compile.
! </p><pre><b><a name="11">: next-path&quot; &nbsp;&nbsp;&nbsp;( path -- a1 n1 &nbsp;)
  </a></b></pre><p>Get the next path from dir list.
! </p><pre><b><a name="12">: reset-path-source &nbsp;&nbsp;&nbsp;&nbsp;( path -- &nbsp;)
  </a></b></pre><p>Points the path-source to the whole path.
! </p><pre><b><a name="13">: first-path&quot; &nbsp;&nbsp;( path -- a1 n1 &nbsp;)
  </a></b></pre><p>Get the first forth directory path.
! </p><pre><b><a name="14">: &quot;path+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( a1 n1 path -- )
  </a></b></pre><p>Append a directory to a path.
! </p><pre><b><a name="15">: &quot;fpath+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( a1 n1 -- )
  </a></b></pre><p>Append a directory to the Forth path.
! </p><pre><b><a name="16">: fpath+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( -&lt;directory&gt;- )
  </a></b></pre><p>Append a directory to the Forth path.
! </p><pre><b><a name="17">: .path &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( path -- )
  </a></b></pre><p>Display a directory search path list.
! </p><pre><b><a name="18">: .fpath &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( -- )
  </a></b></pre><p>Display the Forth directory search path list.
! </p><pre><b><a name="19">: volume-indication? ( adr - flag )
  </a></b></pre><p>True when the counted string at adr starts with x: or \name
! </p><pre><b><a name="20">: full-path &nbsp;{ a1 n1 path \ searchpath$ filename$ current$ -- a2 n2 f1 }
  </a></b></pre><p>Find file a1,n1 in a path and return the full path. <br />
  a2,n2 and f1=false, succeeded.
! </p><pre><b><a name="21">: program-path-init ( -- )
  </a></b></pre><p>Initialize the Forth directory search path list. Automatically done at program
  initialization and when Paths.f is loaded.
! </p><pre><b><a name="22">: &quot;path-file &nbsp;{ a1 n1 \ current$ -- a2 n2 f1 }
  </a></b></pre><p>Find file a1,n1 in the Forth path and return the full path. <br />
  a2,n2 and f1=false, succeeded.
! </p><pre><b><a name="23">: n&quot;open &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( a1 n1 -- handle f1 )
  </a></b></pre><p>Open file a1,n1 with a Forth path search.
! </p><pre><b><a name="24">: MakeAbsolutePath &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( a1 n1 a2 n2 -- a3 )
  </a></b></pre><p>Make path a1 n1 absolute to path a2 n2.
! </p><pre><b><a name="25">: IsPathRelativeTo? &nbsp;&nbsp;&nbsp;&nbsp;{ a1 n1 a2 n2 -- f }
  </a></b></pre><p>Return true if path a1 n1 is relative to path a2 n2
! </p><pre><b><a name="26">: MakePathRelativeTo &nbsp;&nbsp;&nbsp;( a1 n1 a2 n2 -- a3 )
  </a></b></pre><p>Make path a1 n1 relative to path a2 n2.
! </p><pre><b><a name="27">: FindRelativePath &nbsp;( a1 n1 path - a2 n2 )
! </a></b></pre><p>Returns a relative path for file a1 n1 in path ( first part ). <br />
  n2=0 means not in search path.
! </p><pre><b><a name="28">: FindRelativeName &nbsp;( a1 n1 path - a2 n2 f )
! </a></b></pre><p>Returns a relative name for file a1 n1 in path ( last-part ). <br />
  n2=0 means not in search path.
! </p><pre><b><a name="29">: &quot;LOADED? &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( addr len -- flag )
! </a></b></pre><p>True if a file addr len is loaded. The filename must contain a full path.
! </p><pre><b><a name="30">: LOADED? &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( -&lt;name&gt;- -- flag ) &nbsp;{ \ current$ }
  </a></b></pre><p>True if the following file is loaded. The filename may be relative.
! </p><pre><b><a name="31">: \LOADED- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( -&lt;name&gt;- )
  </a></b></pre><p>If the following file IS NOT LOADED interpret line.
! </p><pre><b><a name="32">: \LOADED &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( -&lt;name&gt;- )
  </a></b></pre><p>&nbsp;If the following file IS LOADED interpret line.
! </p><pre><b><a name="33">: NEEDS &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;( -&lt;name&gt;- )
  </a></b></pre><p>Conditionally load file &quot;name&quot; if not loaded.
! </p><pre><b><a name="34">synonym Require needs
  </a></b></pre><p>Forth 200X name for needs.
! </p><pre><b><a name="35">: &quot;file-clip&quot; &nbsp;&nbsp;{ adr len limit \ temp$ pre -- 'adr 'len }
  </a></b></pre><p>Clip filename to limit.
! </p><hr />
  </body></html>

Thread: [Win32forth-cvs] win32forth/doc Paths.htm,1.4,1.5

win32forth-cvs