Draft: File Library for Coalton #1085

Izaakwltn · 2024-04-05T23:19:42Z

First draft of an IO library for Coalton. This allows for directory navigation, environmental/system information gathering, and simple file-reading.

This mostly repurposes UIOP and ASDF functions, with an intent to make things simple/streamlined without as much unfettered, lispy freedom. I'm focusing on what most users will need for most use-cases, as fringe edge cases can be hand-rolled with lisp.
The current working directory can be accessed with (cwd) and set with (chdir dir), with most file functions automatically operating in the context of the working directory. Note: This distinction is important because UIOP allows you to set the current working directory, but the default directory for operations is still the home directory.

Next steps, open thoughts:

I'm planning on approaching streams next, either built on top of CL streams or a new type with File and Buffer constructors.
File reading and writing, opening and closing streams, which I'm hoping to make straightforward at the expense of creativity.
Decide on a filepath system, though it should ideally just be strings on the user end.
It might be useful to set the current-working-directory, or at least a current-system-directory when loading a coalton project.asd or package.lisp.
I think file searching/managing might be friendliest with some sort of regex/string-matching library. Once such a library exists, I think a lot of the uiop stuff could be supplanted.

eliaslfox

I'll take a more thorough look sometime this week

library/io.lisp

Izaakwltn · 2024-04-16T23:42:59Z

@eliaslfox I think this is at a point that it could be reviewed.

Summary:

system.lisp includes a variety of system/environmental variables, mostly gathered through uiop. (I think I'll probably drop the which- prefix)
file.lisp contains most of the standard directory and file functions. They mostly follow common lisp naming and organization conventions, though also tend to be simplified.
current-working-directory.lisp provides an interface for using do notation to work within a given directory (or to navigate in general). Most of the naming is tailored after shell commands. This should probably be renamed something like shell-nav or nav or be merged into file.lisp.

eliaslfox

I forgot to finish the review

library/file.lisp

library/system.lisp

library/file.lisp

Izaakwltn · 2024-05-03T00:44:49Z

Latest edit:

Most major file functions are implemented.
Result error handling across file operations. The constructors for FileError are not finalized yet.
Signal type class with methods error and warn. There is an instance for String so no existing code using error breaks, but it allows specialized error/warning formatting for specific error types, like this PR's FileError.
Parameterized FileStream type avoids unsafe/unnecessary stream options for incompatible stream types.

library/file.lisp

eliaslfox

some notes

Izaakwltn · 2024-05-07T15:59:45Z

(probably) dependent on #1101 and #1102.

Izaakwltn · 2024-05-08T18:10:30Z

The only files that are really exclusive to this PR are library/file.lisp and library/system.lisp and typical package updates.

The other edits have to do with #1101 and #1102 which will go away if those are merged or shot down.

eliaslfox

another pass. this is looking good

library/file.lisp

Izaakwltn · 2024-05-09T20:26:40Z

All prerequisite merge requests have been assimilated, tests added. Ready for near-final review

library/file.lisp

eliaslfox · 2024-05-09T20:45:59Z

library/file.lisp

+                  (cl:format cl:nil "Captured Lisp Error:~%~%~a" c))))
+        ((EOF)
+         (error (lisp String ()
+                  (cl:format cl:nil "Error:~%~%End of File"))))))))


(error #.(cl:format cl:nil "...")) you can format at read time

Do you mean that that syntax would work instead of the whole lisp-coalton-bridge?

eliaslfox · 2024-05-09T21:01:09Z

library/file.lisp

+
+(coalton-toplevel
+
+  (declare append-file ((Into :p Pathname) (Streamable :a) => :p -> (iter:Iterator :a) -> (Result FileError Unit)))


append-to-file

eliaslfox · 2024-05-09T21:01:15Z

library/file.lisp

+      (fn (stream)
+        (write-sequence stream data))))
+
+  (declare supersede-file ((Into :p Pathname) (Streamable :a) => :p -> (iter:Iterator :a) -> (Result FileError Unit)))


write-to-file

eliaslfox · 2024-05-09T21:01:23Z

library/file.lisp

+      (fn (stream)
+        (write-sequence stream data))))
+
+  (declare read-file-string ((Into :a Pathname) => :a -> (Result FileError String)))


read-file-to-string

eliaslfox · 2024-05-09T21:01:50Z

library/prelude.lisp

@@ -222,6 +222,16 @@
  (:export
   #:Iterator)

+  (:import-from


don't put file stuff in the prelude.

eliaslfox · 2024-05-09T21:02:29Z

library/system.lisp

@@ -6,7 +6,25 @@
  (:export
   #:gc
   #:time
-   #:sleep))
+   #:sleep)


can the system changes go in another pr?

Izaakwltn force-pushed the io-library branch 2 times, most recently from 1fd1c2a to e43ce47 Compare April 5, 2024 23:25

eliaslfox reviewed Apr 8, 2024

View reviewed changes

library/io.lisp Outdated Show resolved Hide resolved

Izaakwltn force-pushed the io-library branch 3 times, most recently from 29aa228 to 70eb2bf Compare April 16, 2024 05:51

Izaakwltn changed the title ~~Draft: IO Library for Coalton~~ Draft: File Library for Coalton Apr 16, 2024

Izaakwltn force-pushed the io-library branch from c7cce17 to 6ccc2de Compare April 19, 2024 17:36

eliaslfox reviewed Apr 26, 2024

View reviewed changes

Izaakwltn force-pushed the io-library branch 3 times, most recently from 7df1a1b to d5a657a Compare May 3, 2024 00:02

Izaakwltn force-pushed the io-library branch from d5a657a to 2a85399 Compare May 3, 2024 00:45