changelog shortlog graph tags branches changeset files revisions annotate raw help

Mercurial > core / lisp/lib/cli/clap/proto.lisp

changeset 646: 95fd920af398
parent: 3e6a17fb5712
child: 6e5006dfe7b8
author: Richard Westhaver <ellis@rwest.io>
date: Wed, 11 Sep 2024 18:08:29 -0400
permissions: -rw-r--r--
description: error handling methods for clap 
     1 ;;; cli/clap/proto.lisp --- Clap Protocol
     2 
     3 ;; 
     4 
     5 ;;; Code:
     6 (in-package :cli/clap/proto)
     7 
     8 (define-condition clap-condition () ())
     9 (eval-always
    10   (deferror clap-error (clap-condition) ())
    11   (defwarning clap-warning (clap-condition) ())
    12   (deferror clap-simple-error (simple-error clap-error) () (:auto t))
    13   (deferror clap-unknown-argument (clap-error unknown-argument) ())
    14   (deferror clap-missing-argument (clap-error missing-argument)
    15       ((kind :initarg :kind :initform nil)))
    16   (deferror clap-invalid-argument (clap-error invalid-argument) ())
    17   (defwarning clap-simple-warning (simple-warning clap-warning) () (:auto t)))
    18 
    19 (defun clap-unknown-argument (arg &optional kind)
    20   (error 'clap-unknown-argument :name arg :kind kind))
    21 
    22 (defun clap-missing-argument (arg &optional kind)
    23   (error 'clap-missing-argument :item arg :kind kind))
    24 
    25 (defun clap-invalid-argument (arg &key reason kind)
    26   (error 'clap-invalid-argument :name arg :kind kind :reason reason))
    27 
    28 (defgeneric push-cmd (cmd place))
    29 
    30 (defgeneric push-opt (opt place))
    31 
    32 (defgeneric pop-cmd (place))
    33 
    34 (defgeneric pop-opt (place))
    35 
    36 (defgeneric find-cmd (self name &optional active))
    37 
    38 (defgeneric find-opts (self name &key active recurse))
    39 
    40 (defgeneric active-cmds (self))
    41 
    42 (defgeneric active-opts (self &optional global))
    43 
    44 (defgeneric find-short-opts (self ch &key))
    45 
    46 (defgeneric call-opt (self arg))
    47 
    48 (defgeneric do-opt (self))
    49 
    50 (defgeneric do-opts (self &optional global))
    51 
    52 (defgeneric call-cmd (self args opts))
    53 
    54 (defgeneric do-cmd (self)
    55   (:documentation "Run the command SELF with args parsed at runtime."))
    56 
    57 (defgeneric print-help (self &optional stream)
    58   (:documentation "Format cli SELF as a helpful string."))
    59 
    60 (defgeneric print-version (self &optional stream)
    61   (:documentation "Print the version of SELF."))
    62 
    63 (defgeneric print-usage (self &optional stream)
    64   (:documentation "Format cli SELF as a useful string."))
    65 
    66 (defgeneric handle-unknown-opt (self opt)
    67   (:documentation "Handle an unknown cli-opt."))
    68 
    69 (defgeneric handle-missing-opt (self opt)
    70   (:documentation "Handle a missing cli-opt."))
    71 
    72 (defgeneric handle-invalid-opt (self opt &optional reason)
    73   (:documentation "Handle an invalid cli-opt."))
    74 
    75 (defgeneric handle-unknown-arg (self arg)
    76   (:documentation "Handle an unknown cli-arg."))
    77 
    78 (defgeneric handle-missing-arg (self arg)
    79   (:documentation "Handle a missing cli-arg."))
    80 
    81 (defgeneric handle-invalid-arg (self arg &optional reason)
    82   (:documentation "Handle an invalid cli-arg."))
    83 
    84 (defgeneric cli-equal (a b))