package.lisp

;;;; SPDX-FileCopyrightText: Atlas Engineer LLC
;;;; SPDX-License-Identifier: BSD-3-Clause

(uiop:define-package #:njson
  (:use #:common-lisp)
  (:export
   ;; Conditions
   #:jerror
   #:decode-from-stream-not-implemented
   #:encode-to-stream-not-implemented
   #:invalid-key #:non-indexable #:value-mismatch #:invalid-pointer #:no-key
   ;; Main generics
   #:decode #:encode
   ;; Generics to implement for backends.
   #:decode-from-stream #:decode-from-string #:decode-from-file
   #:encode-to-stream #:encode-to-string #:encode-to-file
   ;; Helpers
   #:jget #:jget* #:jcopy #:jkeys
   #:jtruep #:jtrue-p #:jtrue?
   #:ensure-array #:ensure-object
   ;; Macro helpers
   #:jif #:jwhen #:jor #:jand #:jnot
   ;; Binding macros.
   #:jbind #:jmatch)
  (:documentation "NJSON is a convenience library for JSON handling. Important functions/APIs:
- `njson:encode' and `njson:decode' as universal (en|de)coding functions working
  on strings, streams, and pathnames.
- `njson:jget' (and `njson:get_' alias) to get the value from decoded
  and arbitrarily nested JSON array/object.
- `njson:jtruep' (and aliases) to check the non-falsity of a decoded
  value.
- `njson:jif', `njson:jwhen', `njson:jor', `njson:jand', and
  `njson:jnot' (and aliases) as convenience macros for JSON
  non-falsity-based control flow.

Generics to implement:
- `njson:encode-to-stream' and `njson:decode-from-stream' as the basic
  methods to specialize for every backend.
- `njson:encode-to-string' and `njson:encode-to-file', as more specific
  methods to speed things up.
- `njson:decode-from-string' and `njson:decode-from-file', as more
  specific decoding methods."))