1 USING: help.markup help.syntax io.backend io.files io.directories strings
2 sequences io.pathnames.private ;
6 { $values { "ch" "a code point" } { "?" "a boolean" } }
7 { $description "Tests if the code point is a platform-specific path separator." }
10 { $example "USING: io.pathnames prettyprint ;" "CHAR: / path-separator? ." "t" }
13 HELP: parent-directory
14 { $values { "path" "a pathname string" } { "parent" "a pathname string" } }
15 { $description "Strips the last component off a pathname." }
16 { $examples { $example "USING: io io.pathnames ;" "\"/etc/passwd\" parent-directory print" "/etc/" } } ;
19 { $values { "path" "a pathname string" } { "string" string } }
20 { $description "Outputs the last component of a pathname string." }
22 { $example "USING: io.pathnames prettyprint ;" "\"/usr/bin/gcc\" file-name ." "\"gcc\"" }
23 { $example "USING: io.pathnames prettyprint ;" "\"/usr/libexec/awk/\" file-name ." "\"awk\"" }
27 { $values { "path" "a pathname string" } { "extension" string } }
28 { $description "Outputs the extension of " { $snippet "path" } ", or " { $link f } " if the filename has no extension." }
30 { $example "USING: io.pathnames prettyprint ;" "\"/usr/bin/gcc\" file-extension ." "f" }
31 { $example "USING: io.pathnames prettyprint ;" "\"/home/csi/gui.vbs\" file-extension ." "\"vbs\"" }
35 { $values { "path" "a pathname string" } { "stem" string } }
36 { $description "Outputs the " { $link file-name } " of " { $snippet "filename" } " with the file extension removed, if any." }
38 { $example "USING: io.pathnames prettyprint ;" "\"/usr/bin/gcc\" file-stem ." "\"gcc\"" }
39 { $example "USING: io.pathnames prettyprint ;" "\"/home/csi/gui.vbs\" file-stem ." "\"gui\"" }
42 { file-name file-stem file-extension } related-words
45 { $values { "path" "a pathnames string" } { "seq" sequence } }
46 { $description "Splits a pathname on the " { $link path-separator } " into its its component strings." } ;
49 { $values { "path1" "a pathname string" } { "path2" "a pathname string" } { "path" "a pathname string" } }
50 { $description "Appends " { $snippet "path1" } " and " { $snippet "path2" } " to form a pathname." }
52 { $unchecked-example """USING: io.pathnames prettyprint ;
53 "first" "second.txt" append-path ."""
59 { $values { "path1" "a pathname string" } { "path2" "a pathname string" } { "path" "a pathname string" } }
60 { $description "Appends " { $snippet "path2" } " and " { $snippet "path1" } " to form a pathname." }
62 { $unchecked-example """USING: io.pathnames prettyprint ;
63 "second.txt" "first" prepend-path ."""
68 { append-path prepend-path } related-words
71 { $values { "path" "a pathname string" } { "?" "a boolean" } }
72 { $description "Tests if a pathname is absolute. Examples of absolute pathnames are " { $snippet "/foo/bar" } " on Unix and " { $snippet "c:\\foo\\bar" } " on Windows." } ;
74 HELP: windows-absolute-path?
75 { $values { "path" "a pathname string" } { "?" "a boolean" } }
76 { $description "Tests if a pathname is absolute on Windows. Examples of absolute pathnames on Windows are " { $snippet "c:\\foo\\bar" } " and " { $snippet "\\\\?\\c:\\foo\\bar" } " for absolute Unicode pathnames." } ;
79 { $values { "path" "a pathname string" } { "?" "a boolean" } }
80 { $description "Tests if a pathname is a root directory. Examples of root directory pathnames are " { $snippet "/" } " on Unix and " { $snippet "c:\\" } " on Windows." } ;
82 { absolute-path? windows-absolute-path? root-directory? } related-words
85 { $values { "path" "a pathname string" } { "newpath" "a pathname string" } }
86 { $description "Resolve a path relative to the Factor source code location." } ;
89 { $class-description "Class of path name objects. Path name objects can be created by calling " { $link <pathname> } "." } ;
92 { $values { "path" "a pathname string" } { "path'" "a new pathname string" } }
93 { $description "Prepends the " { $link current-directory } " to the pathname, resolves a " { $snippet "resource:" } " or " { $snippet "voacb:" } " prefix, if present, and performs any platform-specific pathname normalization." }
94 { $notes "High-level words, such as " { $link <file-reader> } " and " { $link delete-file } " call this word for you. It only needs to be called directly when passing pathnames to C functions or external processes. This is because Factor does not use the operating system's notion of a current directory, and instead maintains its own dynamically-scoped " { $link current-directory } " variable." }
95 { $notes "On Windows NT platforms, this word does prepends the Unicode path prefix." }
97 "For example, if you create a file named " { $snippet "data.txt" } " in the current directory, and wish to pass it to a process, you must normalize it:"
99 "\"1 2 3\" \"data.txt\" ascii set-file-contents"
100 "\"munge\" \"data.txt\" normalize-path 2array run-process"
106 { "path" "a pathname string" }
107 { "path'" "a pathname string" }
109 { $description "Prepends the " { $link current-directory } " to the pathname and resolves a " { $snippet "resource:" } " prefix, if present." }
110 { $notes "This word is exaclty the same as " { $link normalize-path } ", except on Windows NT platforms, where it does not prepend the Unicode path prefix. Most code should call " { $link normalize-path } " instead." } ;
112 HELP: resolve-symlinks
113 { $values { "path" "a pathname string" } { "path'" "a new pathname string" } }
114 { $description "Outputs a path where none of the path components are symlinks. This word is useful for determining the actual path on disk where a file is stored; the root of this absolute path is a mount point in the file-system." }
115 { $notes "Most code should not need to call this word except in very special circumstances. One use case is finding the actual file-system on which a file is stored." } ;
118 { $values { "string" "a pathname string" } { "pathname" pathname } }
119 { $description "Creates a new " { $link pathname } "." } ;
122 { $values { "dir" string } }
123 { $description "Outputs the user's home directory." }
125 { $unchecked-example "USING: io.pathnames prettyprint ;"
131 ARTICLE: "io.pathnames" "Pathnames"
132 "Pathnames are objects that contain a string representing the path to a file on disk. Pathnames are cross-platform; Windows accepts both forward and backward slashes as directory separators and new separators are added as a forward slash on all platforms. Clicking a pathname object in the UI brings up the file in one of the supported editors, but otherwise, pathnames and strings are interchangeable. See " { $link "editor" } " for more details." $nl
133 "Pathname introspection:"
141 "Appending pathnames:"
146 "Pathname presentations:"
152 { $subsections POSTPONE: P" }
153 "Normalizing pathnames for use with native APIs:"
154 { $subsections normalize-path }
155 "Outputting an absolute path from a path:"
156 { $subsection absolute-path }
157 "Removing symlinks from a path:"
158 { $subsections resolve-symlinks } ;
160 ABOUT: "io.pathnames"