about summary refs log tree commit diff
diff options
context:
space:
mode:
authorWilliam Carroll <wpcarro@gmail.com>2020-01-24T10·55+0000
committerWilliam Carroll <wpcarro@gmail.com>2020-01-24T10·55+0000
commit143fc970322237963d5358ae832fd18ea045d67a (patch)
tree0b7602e17e4204d2160348d0ee901db6d9b46e05
parente2e59c63e7899ea06e4273f0ee58a5842f6e3384 (diff)
Start working on f.lisp
I would like to port the `f.el` library to Common Lisp. I'm adding a README,
some build files, and the module itself to get started.
-rw-r--r--lisp/f/README.md5
-rw-r--r--lisp/f/default.nix15
-rw-r--r--lisp/f/main.lisp48
3 files changed, 68 insertions, 0 deletions
diff --git a/lisp/f/README.md b/lisp/f/README.md
new file mode 100644
index 000000000000..34e07180d492
--- /dev/null
+++ b/lisp/f/README.md
@@ -0,0 +1,5 @@
+# f.lisp
+
+In this project, I'm attempting to port the Elisp library [`f.el`][1] to Common Lisp.
+
+[1]: https://github.com/rejeep/f.el
diff --git a/lisp/f/default.nix b/lisp/f/default.nix
new file mode 100644
index 000000000000..6911b2102634
--- /dev/null
+++ b/lisp/f/default.nix
@@ -0,0 +1,15 @@
+{
+  depot ? import <depot> {},
+  universe ? import <universe> {},
+  ...
+}:
+
+depot.nix.buildLisp.library {
+  name = "f";
+  deps = with universe.lisp; [
+    prelude
+  ];
+  srcs = [
+    ./main.lisp
+  ];
+}
diff --git a/lisp/f/main.lisp b/lisp/f/main.lisp
new file mode 100644
index 000000000000..a51c38127815
--- /dev/null
+++ b/lisp/f/main.lisp
@@ -0,0 +1,48 @@
+(in-package #:cl-user)
+(defpackage #:main
+  (:documentation "Modern API for working with files and directories.")
+  (:use #:cl)
+  (:shadow #:type))
+(in-package #:main)
+
+;; Common Lisp distinguishes between `namestrings` and `pathnames` as two types
+;; of filename representations.
+;;
+;; A `pathname` is a structured representation of the name of a file, which
+;; consists of six parts:
+;; 1. host
+;; 2. device
+;; 3. directory
+;; 4. name
+;; 5. type
+;; 6. version
+
+;; TODO: Should I be using `string` as a type or `namestring`?
+
+(defmacro type (name in out)
+  `(declaim (ftype (function ,in ,out) ,name)))
+
+(type join (&rest namestring) pathname)
+(defun join (&rest args)
+  "Join ARGS to a single path."
+  (apply #'merge-pathnames args))
+
+(type ext (pathname) string)
+(defun ext (path)
+  "Return the file extension of PATH."
+  (pathname-type path))
+
+;; TODO: Define these tests elsewhere.
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;; Tests
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+;; join
+(string= (join "path") "path")
+(string= (join "path" "to") "path/to")
+(string= (join "/" "path" "to" "heaven") "/path/to/heaven")
+
+;; ext
+(string= (ext #p"path/to/file.ext") "ext")
+(string= (ext #p"path/to/directory") nil)