Add additional ASDF systems to support HDDL manipulation (#4)

Add ASDF systems "hddl", "hddl-utils", and "hddl-to-json" to the library.

Author: rpgoldman

.github/workflows/ci.yml

@@ -33,6 +33,9 @@ jobs:
       I_AGREE_TO_ALLEGRO_EXPRESS_LICENSE: yes
 
     steps:
+    - name: install JSON wrangling binaries
+      run: apt update && apt install -y jq python3 python3-pip && python3 -m pip install yq check-jsonschema
+
     - uses: actions/checkout@v3
 
     - run: install-quicklisp

README.org

@@ -1,10 +1,49 @@
-* License
+* PDDL-TOOLS library
+
+This library contains multiple Common Lisp ASDF systems for
+manipulating [[https://planning.wiki/guide/whatis/pddl][Planning Domain Definition Language (PDDL)]], and --
+newly added (summer 2023) -- [[https://arxiv.org/abs/1911.05499][Hierarchical Domain Definition Language (HDDL)]].
+
+These libraries enable a programmer to parse PDDL and HDDL, generate
+and modify parsed PDDL and HDDL expressions, and then write these
+expressions to files for use by AI planners.  Constructs handled
+include domain definitions, problem definitions, and plans.
+
+Two additional special functionalities:
++ PDDL-PLANNERS :: Attempts to provide a uniform CL interface to a
+  number of AI planning systems to support automating their use.
++ HDDL-JSON :: Provides JSON schemas for HDDL constructs (domains and
+  problems) and code for emitting HDDL domains and problems as JSON.
+  We hope to later provide the same capabilities for PDDL, and also
+  support reading domains and problems as JSON, not just writing them,
+  so that planning models can be authored in JSON as well as in PDDL/HDDL.
+  We believe that this can streamline the development of AI planning
+  by obviating the need to incorporate HDDL and PDDL parsers in
+  planners.
+
+** Notes
+
+We plan to provide an executable wrapper around
+these libraries for parsing and translation, which will be available
+for building -- for those comfortable with Common Lisp -- or for use
+through Docker images.
+
+Support for HDDL is as yet only partial.  In particular, the library only
+support /totally-ordered/ subtasks, not partially-ordered ones.  We
+expect to add this shortly.  Since we do not ourselves need these
+constructs, getting it added will be hastened substantially by
+requests from potential users (or, even more, pull requests)!
+
+** License
 
 This code is made publicly available by SIFT, LLC under the terms of the
 3-clause BSD license, attached as [[file:license.txt][license.txt]].
 
-* Component libraries
-** PDDL
+** Component libraries
+
+*** PDDL
+
+**** PDDL system
 
 This does not provide any PDDL-wrangling functions (well, with the exception of
 =PPRINT-PDDL=, whose job it is to print PDDL /readably/).  It simply provides
@@ -14,7 +53,7 @@ bits of code can all wrangle PDDL without getting into package hell.  In
 particular, it means that one bit of code can read PDDL into an s-expression
 that other code can interact with.
 
-** PDDL-UTILS
+**** PDDL-UTILS
 
 PDDL-wrangling functions.  These are made to allow you to read and write PDDL
 files, especially problem files, domain files, and plans.  There are also
@@ -23,7 +62,7 @@ of this library is for programmers to be able to make derivative or templated
 domains and problems.  You can read a problem (domain), set some of its slots
 programmatically, and then write it out to a file.
 
-** PDDL-PLANNERS
+**** PDDL-PLANNERS
 
 This attempts to provide a uniform-ish API to invoke a number of different
 planners from Common Lisp.  This is just the core framework here.
@@ -36,6 +75,31 @@ This approach is only somewhat successful, since we find that planners often
 have very complex invocation procedures with very particular sets of
 configuration options.
 
+*** HDDL
+
+**** HDDL
+
+Playing a role similar to the [[#PDDL system]], this library provides the
+~HDDL~ package (Common Lisp namespace) into which HDDL domain can be
+parsed.
+
+**** HDDL-UTILS
+
+This is the HDDL-wrangling system proper.  It plays an analogous role
+to the [[#PDDL-UTILS]] system.
+
+**** HDDL-JSON
+
+This system provides the two key interface functions
+~HDDL-JSON:JSON-DUMP-DOMAIN~ and ~HDDL-JSON:JSON-DUMP-PROBLEM~ which,
+as their names suggest, provide the ability to write domains and
+problems to JSON files.
+
+*** JSON-SCHEMAS
+
+This is not a library, but rather a repository of JSON schemas for
+HDDL as written to JSON.
+
 
 
 * COMMENT local variables block

do-test.lisp

@@ -36,11 +36,20 @@
            (asdf:*compile-file-warnings-behaviour* :error))
        (ql:quickload ,name :silent nil :verbose t))))
 
+;;; these are done outside the bounds of BUILD-SYSTEM below, because
+;;; CL-PPCRE doesn't build clean (at least on SBCL) and CL-JSON does not
+;;; build clean on Allegro
+(ql:quickload "cl-ppcre")
+(ql:quickload "cl-json")
+
+
 (build-system "pddl-utils")
-;; (build-system "hddl-utils")
+(build-system "hddl-utils")
+(build-system "hddl-to-json")
 
 (ql:quickload "pddl-utils/tests")
-;;(ql:quickload "hddl-utils/tests")
+(ql:quickload "hddl-utils/tests")
+(ql:quickload "hddl-to-json/tests")
 
 (defmacro test-system (name)
   `(handler-case
@@ -49,6 +58,7 @@
        (uiop:quit 1))))
 
 (test-system "pddl-utils")
-;; (test-system "hddl-utils")
+(test-system "hddl-utils")
+(test-system "hddl-to-json")
 
 (uiop:quit 0)

hddl-to-json.asd

@@ -0,0 +1,30 @@
+;;; -------------------------------------------------------------------------
+;;; Copyright 2023, Robert P. Goldman and SIFT, LLC
+;;; Available under the BSD 3-clause license, see license.txt
+;;;---------------------------------------------------------------------------
+
+(defpackage :sift-hddl-to-json-asd
+  (:use :common-lisp :asdf))
+
+(in-package :sift-hddl-to-json-asd)
+
+(load-system :fiveam-asdf)
+
+(defsystem :hddl-to-json
+    :name "SIFT-HDDL-TO-JSON"
+    :license "BSD 3-clause (see license.txt)"
+    :version "3.0"
+    :depends-on (hddl-utils cl-json iterate)
+    :in-order-to ((test-op (test-op hddl-to-json/tests)))
+    :pathname "hddl-utils/"
+    :components ((:file "json")))
+
+(defsystem :hddl-to-json/tests
+  :depends-on (hddl-to-json fiveam cl-ppcre)
+  :defsystem-depends-on (fiveam-asdf)
+  :serial t
+  :class :fiveam-tester-system
+  :test-names ((#:hddl-json-tests . :hddl-json-tests)
+               )
+  :pathname "hddl-utils/tests/"
+  :components ((:file "json-tests")))

hddl-utils.asd

@@ -0,0 +1,36 @@
+;;; -------------------------------------------------------------------------
+;;; Copyright 2011-2016, SIFT, LLC, Robert P. Goldman, and Ugur Kuter
+;;; Available under the BSD 3-clause license, see license.txt
+;;;---------------------------------------------------------------------------
+
+(defpackage :sift-hddl-utils-asd
+  (:use :common-lisp :asdf))
+
+(in-package :sift-hddl-utils-asd)
+
+(defsystem :hddl-utils
+    :name "SIFT-HDDL-UTILS"
+    :license "BSD 3-clause (see license.txt)"
+    :version "3.0"
+    :depends-on (hddl pddl-utils)
+    :in-order-to ((test-op (test-op hddl-utils/tests)))
+    :pathname "hddl-utils/"
+    :components ((:file "package")      ; Package definition.
+                 (:file "decls" :depends-on ("package"))
+                 (:file "commons" :depends-on ("package" "decls"))
+                 #+nil(:file "merger" :depends-on ("package"))
+                 #+nil(:file "problem-macros" :depends-on ("package"))
+;                 (:file "object-methods" :depends-on ("package" "decls"))
+                 ))
+
+
+(defsystem :hddl-utils/tests
+  :depends-on (pddl-utils fiveam)
+  :defsystem-depends-on (fiveam-asdf)
+  :serial t
+  :class :fiveam-tester-system
+  :test-names ((#:hddl-tests . :hddl-utils-tests)
+               )
+  :pathname "hddl-utils/tests/"
+  :components ((:file "tests")
+               (:file "hddl-data")))