Update path API (closes #248)

Author: python-processing-unit

docs/specification/10-standard-library.html

@@ -31,18 +31,18 @@
 
 #### 10.1.1 API
 
-- `str NORMALIZE_PATH(str path)` = Replace all backslashes in the path with forward slashes.
-- `str WINPATH(str path)` = Replace all forward slashes in the path with backslashes.
-- `str BASEPATH(str path)` = Return the directory part of the path, excluding the file name.
-- `str BASENAME(str path)` = Return the file name part of the path, excluding the directory.
-- `tensor SPLITEXT(str path)` = Split the path into a tensor containing the base name and the extension.
-- `str EXTNAME(str path)` = Return the file extension from the path, without the dot.
-- `str DELEXT(str path)` = Return the path without the file extension.
-- `str TEMPFILE(str prefix, str suffix)` = Modify the path to originate in the system's temporary directory.
-- `str interpreter` = The path to the Prefix interpreter executable.
-- `str interpreter_dir` = The directory containing the Prefix interpreter executable.
-- `str script` = The path to the currently executing script.
-- `str script_dir` = The directory containing the currently executing script.
+- `str path.normalize_path(str path)` = Replace all backslashes in the path with forward slashes.
+- `str path.windows_path(str path)` = Replace all forward slashes in the path with backslashes.
+- `str path.directory_name(str path)` = Return the directory part of the path, excluding the file name.
+- `str path.file_name(str path)` = Return the file name part of the path, excluding the directory.
+- `tensor path.split_extension(str path)` = Split the path into the path without its extension and its extension.
+- `str path.extension_name(str path)` = Return the file extension from the path, without the dot.
+- `str path.strip_extension(str path)` = Return the path without the file extension.
+- `str path.temp_file(str path)` = Modify the path to originate in the system's temporary directory.
+- `str path.interpreter` = The path to the Prefix interpreter executable.
+- `str path.interpreter_dir` = The directory containing the Prefix interpreter executable.
+- `str path.script` = The path to the currently executing script.
+- `str path.script_dir` = The directory containing the currently executing script.
 
 ### 10.2 Garbage collection
 

lib/std/image/init.pre

@@ -11,7 +11,7 @@ extend("image")
 import("path")
 
 func tensor LOAD(str img_path){
-    str ext = path.EXTNAME(img_path)
+    str ext = path.extension_name(img_path)
     if(eq(ext, "png")){
         return(LOAD_PNG(img_path))
     } elseif (or(eq(ext, "jpg"),eq(ext, "jpeg"))){

lib/std/path.pre

@@ -1,35 +1,37 @@
 ! Path utilities for Prefix
 
-func str NORMALIZE_PATH(str path){
+func str normalize_path(str path){
     return(replace(path,"\\","/"))
 }
 
-func str WINPATH(str path){
+func str windows_path(str path){
     return(replace(path,"/","\\"))
 }
 
-func str BASEPATH(str path){ ! returns directory portion of path
-    str npath = NORMALIZE_PATH(path)
-    str base = BASENAME(npath)
+func str directory_name(str path){ ! returns directory portion of path
+    str npath = normalize_path(path)
+    str base = file_name(npath)
     if(eq(base, "")){
         return("")
     }
+    if(eq(npath, base)){
+        return("")
+    }
     str dir = replace(npath, join("/", base), "")
-    del("npath")
     pop("dir")
 }
 
-func str BASENAME(str path){ ! returns filename portion of path
-    tensor tpath = split(NORMALIZE_PATH(path), "/")
+func str file_name(str path){ ! returns filename portion of path
+    tensor tpath = split(normalize_path(path), "/")
     str basename = tpath[max(len_dim(tpath, 0d1), 0d1)]
     del("tpath")
     pop("basename")
 }
 
-func tensor SPLITEXT(str path){ ! returns [name without ext, ext]
-    str npath = NORMALIZE_PATH(path)
-    str base = BASENAME(npath)
-    str dir = BASEPATH(npath)
+func tensor split_extension(str path){ ! returns [name without ext, ext]
+    str npath = normalize_path(path)
+    str base = file_name(npath)
+    str dir = directory_name(npath)
     tensor parts = split(base, ".")
     ! If there is no dot, return the path unchanged and empty ext
     if(eq(len_dim(parts, 0d1), 0d1)){
@@ -49,7 +51,7 @@ func tensor SPLITEXT(str path){ ! returns [name without ext, ext]
         if( or( eq(dir, npath), eq(dir, join(npath, "/")) ) ){
             delex = name
         } else {
-            delex = join(dir, name)
+            delex = join(dir, "/", name)
         }
     }
     del("dir")
@@ -58,19 +60,19 @@ func tensor SPLITEXT(str path){ ! returns [name without ext, ext]
     pop("result")
 }
 
-func str EXTNAME(str path){ ! returns extension portion of path
-    return(SPLITEXT(path)[0d2])
+func str extension_name(str path){ ! returns extension portion of path
+    return(split_extension(path)[0d2])
 }
 
-func str DELEXT(str path){ ! returns path without extension
-    return(SPLITEXT(path)[0d1])
+func str strip_extension(str path){ ! returns path without extension
+    return(split_extension(path)[0d1])
 }
 
-func str TEMPFILE(str local_path){
+func str temp_file(str local_path){
     if(eq(os(),"win")){
         str temp = "C:/Windows/Temp/"
     } elseif(eq(os(),"mac")){
-        throw("TEMPFILE not implemented for macOS yet")
+        throw("temp_file not implemented for macOS yet")
         ! per-user temp dirs on macOS are more complex
         ! add later
     } else {
@@ -82,10 +84,10 @@ func str TEMPFILE(str local_path){
 }
 
 str interpreter = argv()[0d1]
-str interpreter_dir = NORMALIZE_PATH(BASEPATH(argv()[0d1]))
+str interpreter_dir = normalize_path(directory_name(argv()[0d1]))
 if(gte(len_dim(argv(), 0d1), 0d2)){
     str script = argv()[0d2]
-    str script_dir = NORMALIZE_PATH(BASEPATH(argv()[0d2]))
+    str script_dir = normalize_path(directory_name(argv()[0d2]))
 } else {
     str script = ""
     str script_dir = ""

tests/cases/operators/file-host/deletefile.yaml

@@ -4,7 +4,7 @@ passing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("temp.txt")
+        str p = path.temp_file("temp.txt")
         write_file("Prefix", p)
         assert(exist_file(p))
         assert(delete_file(p))
@@ -15,7 +15,7 @@ failing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("temp.txt")
+        str p = path.temp_file("temp.txt")
         write_file("Prefix", p)
         assert(exist_file(p))
         assert(delete_file(p, "Prefix"))

tests/cases/operators/file-host/readfile.yaml

@@ -33,7 +33,7 @@ passing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("prefix-readfile-utf16-replacement.bin")
+        str p = path.temp_file("prefix-readfile-utf16-replacement.bin")
         
         assert(write_file("00D8", p, coding = "hex"))
         assert(eq(read_file(p, coding = "UTF-16 LE"), "\uFFFD"))
@@ -44,7 +44,7 @@ failing:
     source: |
         import("path")
         
-        str missing = path.TEMPFILE("prefix-readfile-missing.txt")
+        str missing = path.temp_file("prefix-readfile-missing.txt")
         try{ delete_file(missing) } catch { }
         read_file(missing)
         

tests/cases/operators/file-host/writefile.yaml

@@ -4,7 +4,7 @@ passing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("prefix-writefile-ansi.txt")
+        str p = path.temp_file("prefix-writefile-ansi.txt")
         
         assert(write_file("Prefix", p, coding = "ANSI"))
         assert(eq(read_file(p, coding = "ANSI"), "Prefix"))
@@ -14,7 +14,7 @@ passing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("prefix-writefile-bin.bin")
+        str p = path.temp_file("prefix-writefile-bin.bin")
         
         assert(write_file("0100000101111010", p, coding = "bin"))
         assert(eq(read_file(p, coding = "bin"), "0100000101111010"))
@@ -25,7 +25,7 @@ passing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("prefix-writefile-binary.bin")
+        str p = path.temp_file("prefix-writefile-binary.bin")
         
         assert(write_file("0100000101111010", p, coding = "binary"))
         assert(eq(read_file(p, coding = "binary"), "0100000101111010"))
@@ -36,10 +36,10 @@ passing:
     source: |
         import("path")
         
-        str d = path.TEMPFILE("prefix-writefile-fail-dir")
+        str d = path.temp_file("prefix-writefile-fail-dir")
         
         if(eq(os(),"win")){
-            assert(eq(cl(join("powershell -NoProfile -NonInteractive -Command \"New-Item -ItemType Directory -Force -Path '", path.WINPATH(d), "'\"")), 0d0))
+            assert(eq(cl(join("powershell -NoProfile -NonInteractive -Command \"New-Item -ItemType Directory -Force -Path '", path.windows_path(d), "'\"")), 0d0))
         } else {
             assert(eq(cl(join("mkdir -p ", d)), 0d0))
         }
@@ -51,7 +51,7 @@ passing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("prefix-writefile-hex.bin")
+        str p = path.temp_file("prefix-writefile-hex.bin")
         
         assert(write_file("507265666978", p, coding = "hex"))
         assert(eq(read_file(p), "Prefix"))
@@ -62,7 +62,7 @@ passing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("prefix-writefile-utf16-be.txt")
+        str p = path.temp_file("prefix-writefile-utf16-be.txt")
         
         assert(write_file("Prefix", p, coding = "UTF-16 BE"))
         assert(eq(read_file(p, coding = "UTF-16 BE"), "Prefix"))
@@ -72,7 +72,7 @@ passing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("prefix-writefile-utf16-le.txt")
+        str p = path.temp_file("prefix-writefile-utf16-le.txt")
         
         assert(write_file("Prefix", p, coding = "UTF-16 LE"))
         assert(eq(read_file(p, coding = "UTF-16 LE"), "Prefix"))
@@ -82,7 +82,7 @@ passing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("prefix-writefile-utf8-bom.txt")
+        str p = path.temp_file("prefix-writefile-utf8-bom.txt")
         
         assert(write_file("Prefix", p, coding = "UTF-8 BOM"))
         assert(eq(read_file(p), "Prefix"))
@@ -93,7 +93,7 @@ passing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("prefix-writefile-utf8.txt")
+        str p = path.temp_file("prefix-writefile-utf8.txt")
         
         assert(write_file("Prefix", p))
         assert(eq(read_file(p), "Prefix"))
@@ -105,7 +105,7 @@ failing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("prefix-writefile-bad-binary2.txt")
+        str p = path.temp_file("prefix-writefile-bad-binary2.txt")
         
         write_file("010a0101", p, coding = "binary")
         
@@ -114,7 +114,7 @@ failing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("prefix-writefile-bad-binary.txt")
+        str p = path.temp_file("prefix-writefile-bad-binary.txt")
         
         write_file("101", p, coding = "binary")
         
@@ -123,7 +123,7 @@ failing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("prefix-writefile-bad-hex.txt")
+        str p = path.temp_file("prefix-writefile-bad-hex.txt")
         
         write_file("abc", p, coding = "hex")
         
@@ -132,7 +132,7 @@ failing:
     source: |
         import("path")
         
-        str p = path.TEMPFILE("prefix-writefile-unsupported.txt")
+        str p = path.temp_file("prefix-writefile-unsupported.txt")
         
         write_file("Prefix", p, coding = "UTF-7")