packages.lisp

;;; packages.lisp --- package definitions

;; Copyright (C) 2025 Ralph Schleicher

;; Redistribution and use in source and binary forms, with or without
;; modification, are permitted provided that the following conditions
;; are met:
;;
;;    * Redistributions of source code must retain the above copyright
;;      notice, this list of conditions and the following disclaimer.
;;
;;    * Redistributions in binary form must reproduce the above copyright
;;      notice, this list of conditions and the following disclaimer in
;;      the documentation and/or other materials provided with the
;;      distribution.
;;
;;    * Neither the name of the copyright holder nor the names of its
;;      contributors may be used to endorse or promote products derived
;;      from this software without specific prior written permission.
;;
;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
;; FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
;; COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
;; INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
;; BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
;; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
;; CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
;; LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
;; ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
;; POSSIBILITY OF SUCH DAMAGE.

;;; Code:

(in-package :common-lisp-user)

(defpackage :open-location-code
  (:nicknames :olc)
  (:use :common-lisp
        :iterate)
  (:export #:validp
           #:fullp
           #:shortp
           #:encode
           #:decode
           #:shorten
           #:recover
           #:code-error
           #:code-length-error
           #:invalid-code-error
           #:full-code-error
           #:short-code-error
           #:code-area
           #:south-west-corner
           #:north-east-corner
           #:center
           #:precision
           #:code-length
           #:separator-position
           #:pad-characters
           #:read-code)
  (:documentation
   "Open Location Code is a location encoding system for addresses,
independent of street names and building numbers.  The encoded
location identifier is called Plus Code since it always contains
a plus sign character.  For example, 8FX8QJ2G+QH is the Plus Code
of the Roman bridge in Trier, Germany.

See <https://plus.codes>."))

;;; packages.lisp ends here