/*   (C) Copyright 2002, 2003, 2004, 2005 Stijn van Dongen
 *   (C) Copyright 2006, 2007 Stijn van Dongen
 *
 * This file is part of tingea.  You can redistribute and/or modify tingea
 * under the terms of the GNU General Public License; either version 3 of the
 * License or (at your option) any later version.  You should have received a
 * copy of the GPL along with tingea, in the file COPYING.
*/

/* TODO
 *    does display skip account for hidden options?
*/

#include <stdio.h>
#include <string.h>
#include <stdlib.h>


#include "opt.h"
#include "alloc.h"
#include "types.h"
#include "ding.h"
#include "err.h"
#include "equate.h"
#include "minmax.h"
#include "compile.h"


static int strcmp_void
(  const void* s1
,  const void* s2
)
   {  return strcmp(s1, s2)
;  }


mcxHash* mcxOptHash
(  mcxOptAnchor*  opts
,  mcxHash*       hash
)
   {  mcxOptAnchor*  anch  =  opts ? opts+0 : NULL

   ;  hash  =  hash
               ?  hash
               :  mcxHashNew
                  (  100
                  ,  mcxStrHash
                  ,  strcmp_void
                  )
   ;  if (!hash)
      return NULL

   ;  while (anch && anch->tag)
      {  mcxKV*  kv =  mcxHashSearch(anch->tag, hash, MCX_DATUM_INSERT)

      ;  if (!kv)
         {  mcxHashFree(&hash, NULL, NULL)
         ;  return NULL
      ;  }

         if (kv->val)
         mcxErr
         (  "mcxOptHash"
         ,  "warning: option <%s> already present"
         ,  anch->tag
         )
      ;  kv->val = anch
      ;  anch++
   ;  }
      return hash
;  }


void mcxOptHashFree
(  mcxHash**   hashpp
)
   {  mcxHashFree(hashpp, NULL, NULL)
;  }


void* mcxOptInit
(  void* opt
)
   {  mcxOption* option = opt
   ;  option->anch = NULL
   ;  option->val = NULL
   ;  return option
;  }


mcxOptAnchor* mcxOptFind
(  char*  tag
,  mcxHash*    hopts  
)
   {  mcxKV* kv = mcxHashSearch(tag, hopts, MCX_DATUM_FIND)
   ;  return kv ? (mcxOptAnchor*) kv->val : NULL
;  }


mcxOption* mcxOptParse__
(  mcxHash*       opthash
,  char**         argv
,  int            argc
,  int            prefix   /* skip these */
,  int            suffix   /* skip those too */
,  int*           n_elems_read
,  mcxstatus*     status
)
   {  char**   argp  =  argv+prefix
   ;  char**   argl  =  argv+argc-suffix     /* arg last */
   ;  mcxbool  do_exhaust = n_elems_read ? TRUE : FALSE
                                  /* fixme: very ugly internal iface*/

   ;  mcxOption* opts
      =  mcxNAlloc
         (argc+1, sizeof(mcxOption), mcxOptInit, RETURN_ON_FAIL)

   ;  mcxOption* opt = opts

   ;  if (!opts)
      {  *status = MCX_OPT_STATUS_NOMEM
      ;  return NULL
   ;  }

      *status = MCX_OPT_STATUS_OK

   ;  if (do_exhaust)
      *n_elems_read = 0

   ;  while (argp < argl)
      {  char* arg            =  *argp
      ;  const char* embedded_val =  NULL
      ;  mcxKV* kv            =  mcxHashSearch(arg, opthash, MCX_DATUM_FIND)
      ;  mcxOptAnchor* anch   =  kv ? (mcxOptAnchor*) kv->val : NULL
      ;  const char* eq       =  strchr(arg, '=')

      ;  if (!kv && eq)
         {  char argcpy[501]
         ;  if (eq - arg < 500)
            {  strncpy(argcpy, arg, (eq-arg))
            ;  argcpy[eq-arg] = '\0'
            ;  if
               (  (kv = mcxHashSearch(argcpy, opthash, MCX_DATUM_FIND))
               && (anch = (mcxOptAnchor*) kv->val)
               && (anch->flags & MCX_OPT_EMBEDDED)
               )
               embedded_val = eq+1
            ;  else if
               (  !strncmp(argcpy, "--", 2)
               && (kv = mcxHashSearch(argcpy+1, opthash, MCX_DATUM_FIND))
               && (anch = (mcxOptAnchor*) kv->val)
               )
               embedded_val = eq+1
            ;  else
               kv = NULL
               ;
            }
            else
            {  /* fimxe do sth */
            }
         }

      ;  if (kv)
         {  opt->anch = anch
         ;  if (do_exhaust)
            (*n_elems_read)++

         ;  if (embedded_val)
            opt->val = embedded_val
         ;  else if
            (  anch->flags & MCX_OPT_HASARG
            && anch->flags & MCX_OPT_EMBEDDED   /* fixme: embedded is stale? */
            )
            {  mcxErr("mcxOptParse", "option <%s> takes =value", anch->tag)
            ;  *status  =  MCX_OPT_STATUS_NOARG
            ;  break
         ;  }
            else if (anch->flags & MCX_OPT_HASARG) 
            {  argp++
            ;  if (argp >= argl)
               {  mcxErr("mcxOptParse", "option <%s> takes value", anch->tag)
               ;  *status  =  MCX_OPT_STATUS_NOARG
               ;  break
            ;  }
               opt->val = *argp    /* mq note: shallow copy */
            ;  if (do_exhaust)
               (*n_elems_read)++
         ;  }
         }
         else
         {  if (do_exhaust)
            break
         ;  else
            {  mcxErr("mcxOptParse", "unsupported option <%s>", arg)
            ;  *status  =  MCX_OPT_STATUS_UNKNOWN
            ;  break
         ;  }
         }
         argp++
      ;  opt++
   ;  }

      if (*status)
      mcxOptFree(&opts)

   ;  return opts
;  }


mcxOption* mcxOptExhaust
(  mcxOptAnchor  *anch
,  char         **argv
,  int            argc
,  int            prefix   /* skip these */
,  int           *n_elems_read
,  mcxstatus     *status
)
   {  mcxHash* opthash  =  mcxOptHash(anch, NULL)
   ;  mcxOption* opts   =  mcxOptParse__
                           (opthash, argv, argc, prefix, 0, n_elems_read, status)
   ;  mcxOptHashFree(&opthash)
   ;  return opts
;  }


mcxOption* mcxOptParse
(  mcxOptAnchor  *anch
,  char         **argv
,  int            argc
,  int            prefix   /* skip these */
,  int            suffix   /* skip those too */
,  mcxstatus     *status
)
   {  mcxHash* opthash  =  mcxOptHash(anch, NULL)
   ;  mcxOption* opts   =  mcxOptParse__(opthash, argv, argc, prefix, suffix, NULL, status)
   ;  mcxOptHashFree(&opthash)
   ;  return opts
;  }


mcxOption* mcxHOptExhaust
(  mcxHash       *opthash
,  char         **argv
,  int            argc
,  int            prefix   /* skip these */
,  int           *n_elems_read
,  mcxstatus     *status
)
   {  return mcxOptParse__
      (opthash, argv, argc, prefix, 0, n_elems_read, status)
;  }


mcxOption* mcxHOptParse
(  mcxHash       *opthash
,  char         **argv
,  int            argc
,  int            prefix   /* skip these */
,  int            suffix   /* skip those too */
,  mcxstatus     *status
)
   {  return mcxOptParse__(opthash, argv, argc, prefix, suffix, NULL, status)
;  }


void mcxOptFree
(  mcxOption** optpp
)
   {  if (*optpp)
      mcxFree(*optpp)
   ;  *optpp = NULL
;  }


void mcxUsage
(  FILE* fp
,  const char*  caller
,  const char** lines
)
   {  int i =  0

   ;  while(lines[i])
      {  fprintf(fp, "%s\n", lines[i])
      ;  i++
   ;  }
      fprintf(fp, "[%s] Printed %d lines\n", caller, i+1)
;  }



static int (*rltFunctions[8])(const void* f1, const void* f2) =  
{  intGt  ,  intGq  ,  fltGt,  fltGq
,  intLt  ,  intLq  ,  fltLt,  fltLq
}  ;


int mcxOptPrintDigits       =  5;


const char* rltSigns[8] =
{  "(",  "[",  "(",  "["
,  ")",  "]",  ")",  "]"
}  ;

/* 
 * todo: NULL lftbound argument & non-NULL lftRelate argument
 * idem for rgt
*/

static int checkBoundsUsage
(  unsigned char type
,  void*       var   cpl__unused
,  int         (*lftRlt) (const void*, const void*)
,  void*       lftBound
,  int         (*rgtRlt) (const void*, const void*)
,  void*       rgtBound
)
   {  int  i
   ;  const char* me  = "checkBoundsUsage PBD"

   ;  if (type != 'f' && type != 'i')
      {  mcxErr(me, "unsupported checkbound type <%c>", type)
      ;  return 1
   ;  }

      if ((lftRlt && !lftBound)||(!lftRlt && lftBound))
      {  mcxErr(me, "abusive lftRlt lftBound combination")
      ;  return 1
   ;  }
      if ((rgtRlt && !rgtBound)||(!rgtRlt && rgtBound))
      {  mcxErr(me, "abusive rgtRlt rgtBound combination")
      ;  return 1
   ;  }

      if (lftRlt)
      {  for(i=0;i<4;i++) if (lftRlt == rltFunctions[i]) break
      ;  if (i == 4)
         {  mcxErr(me, "lftRlt should use gt or gq arg")
         ;  return 1
      ;  }
   ;  }

      if (rgtRlt)
      {  for(i=4;i<8;i++) if (rgtRlt == rltFunctions[i]) break
      ;  if (i==8)
         {  mcxErr(me, "rgtRlt should use lt or lq arg")
         ;  return 1
      ;  }
   ;  }
      return 0
;  }



/*    returns
 *    STATUS_OK      for matching bounds
 *    STATUS_FAIL    for non-matching bounds
 *    STATUS_CB_PBD  for internal error.
*/

enum { STATUS_CB_PBD = STATUS_UNUSED + 1 } ;

static mcxstatus checkBounds
(  unsigned char type
,  void*       var
,  int         (*lftRlt) (const void*, const void*)
,  void*       lftBound
,  int         (*rgtRlt) (const void*, const void*)
,  void*       rgtBound
)
   {  int lftOk, rgtOk
   ;  if (checkBoundsUsage(type, var, lftRlt, lftBound, rgtRlt, rgtBound))
      {  mcxErr("checkBounds PBD", "internal error -- cannot validate")
      ;  return STATUS_CB_PBD
   ;  }
      lftOk =   !lftRlt || lftRlt(var, lftBound)
   ;  rgtOk =   !rgtRlt || rgtRlt(var, rgtBound)
   ;  return (lftOk && rgtOk) ? STATUS_OK : STATUS_FAIL
;  }



static mcxTing* checkBoundsRange
(  unsigned char type
,  void*       var   cpl__unused
,  int         (*lftRlt) (const void*, const void*)
,  void*       lftBound
,  int         (*rgtRlt) (const void*, const void*)
,  void*       rgtBound
)
   {  mcxTing*  textRange  =  mcxTingEmpty(NULL, 40)
   ;  char* lftToken       =  (char *) "<?"
   ;  char* rgtToken       =  (char *) "?>"
   ;  int i

   ;  if (!textRange)
      return NULL

   ;  if (lftRlt)
      {  for(i=0;i<4;i++)
         if (lftRlt == rltFunctions[i])
         break
      ;  if (i<4)
         lftToken = (char *) rltSigns[i]
   ;  }
      else
      lftToken = (char *) "("

   ;  mcxTingPrint(textRange, "%s", lftToken)
     /*
      * This might fail due to mem shortage;
      * we ignore and simply keep plodding on with more mcxTingPrint-s
      * below. It's actually pretty inconceivable, since we alloced
      * 40 bytes - it depends on mcxOptPrintDigits.
     */

   ;  if (lftBound)
      {  if (type == 'f')
         mcxTingPrintAfter
         (textRange, "%.*f", mcxOptPrintDigits, *((float*)lftBound))
      ;  else if (type == 'i')  
         mcxTingPrintAfter(textRange, "%d", *((int*)lftBound))
   ;  }
      else
      mcxTingPrintAfter(textRange, "%s", "<-")

   ;  mcxTingPrintAfter(textRange, "%s", ",")

   ;  if (rgtBound)
      {  if (type == 'f')
         mcxTingPrintAfter
         (textRange, "%.*f", mcxOptPrintDigits, *((float*)rgtBound))
      ;  else if (type == 'i')
         mcxTingPrintAfter(textRange, "%d", *((int*)rgtBound))
   ;  }
      else
      mcxTingPrintAfter(textRange, "%s", "->")

   ;  if (rgtRlt)
      {  for(i=4;i<8;i++)
         if (rgtRlt == rltFunctions[i])
         break
      ;  if (i<8)
         rgtToken = (char *) rltSigns[i]
   ;  }
      else
      rgtToken = (char *) ")"

   ;  mcxTingPrintAfter(textRange, "%s", rgtToken)
   ;  return textRange
;  }


mcxbool mcxOptCheckBounds
(  const char*    caller
,  const char*    flag
,  unsigned char  type
,  void*          var
,  int            (*lftRlt) (const void*, const void*)
,  void*          lftBound
,  int            (*rgtRlt) (const void*, const void*)
,  void*          rgtBound
)
   {  mcxTing* textRange
   ;  mcxstatus stat
      =  checkBounds(type, var, lftRlt, lftBound, rgtRlt, rgtBound)

   ;  if (stat == STATUS_CB_PBD)
      {  mcxErr("mcxOptCheckBounds", "cannot validate option %s", flag)
      ;  return FALSE
   ;  }
      else if (stat == STATUS_FAIL)
      {  if
         (! (  textRange
            =  checkBoundsRange
               (  type
               ,  var
               ,  lftRlt
               ,  lftBound
               ,  rgtRlt
               ,  rgtBound
         )  )  )
         return FALSE

      ;  mcxErr
         (  caller
         ,  "%s argument to %s should be in range %s"
         ,  type == 'i' ? "integer" : type == 'f' ? "float" : "MICANS"
         ,  flag
         ,  textRange->str
         )
      ;  mcxTingFree(&textRange)
      ;  return FALSE
   ;  }
      return TRUE
;  }


int mcxOptAnchorCmpId
(  const void *a1
,  const void *a2
)
   {  const mcxOptAnchor* A1 = a1
   ;  const mcxOptAnchor* A2 = a2
   ;  return
      A1->id < A2->id ? -1 : A1->id - A2->id 
;  }


int mcxOptAnchorCmpTag
(  const void *a1
,  const void *a2
)
   {  const mcxOptAnchor* A1 = a1
   ;  const mcxOptAnchor* A2 = a2
   ;  return   A1->tag && A2->tag
            ?  strcmp(A1->tag, A2->tag) 
            :     A1->tag
               ?  -1
               :  1
;  }


void mcxOptAnchorSortByTag
(  mcxOptAnchor *anchors
,  dim n_anchors
)
   {  if (n_anchors)
      qsort(anchors, n_anchors, sizeof(mcxOptAnchor), mcxOptAnchorCmpTag)
;  }


void mcxOptAnchorSortById
(  mcxOptAnchor *anchors
,  dim n_anchors
)
   {  if (n_anchors)
      qsort(anchors, n_anchors, sizeof(mcxOptAnchor), mcxOptAnchorCmpId)
;  }


void parse_descr
(  const char* field
,  const char** descrp
,  const char** markp
,  int* mark_width
)
   {  const char* m = strstr(field, "\tM")
   ;  const char* n = m ? strstr(m+2, "\t") : NULL
   ;  const char* d = strstr(field, "\tD")

   ;  if (m && n)
         *mark_width =  n - m - 2      /* truncintok */
      ,  *markp = m + 2
   ;  else
         *markp = ""
      ,  *mark_width = 0

   ;  *descrp = d ? d + 2 : field
;  }


void mcxOptApropos
(  FILE* fp
,  const char* me cpl__unused
,  const char* syntax
,  int width
,  mcxbits display
,  const mcxOptAnchor opt[]
)
   {  const mcxOptAnchor *baseopt = opt
   ;  mcxTing* scr = mcxTingEmpty(NULL, 100)
   ;  int id_prev = -1
   ;  const char* descr_usage, *descr_mark
   ;  int mark_width = 0, mark_width_max = 0
   ;  int mywidth = 0

   ;  if (syntax)
      fprintf(fp, "%s\n\n", syntax)

   ;  for (opt = baseopt; opt->tag; opt++)
      {  int thislen = strlen(opt->tag)            /* truncintok */
      ;  if (opt->descr_arg)
         thislen += 1 + strlen(opt->descr_arg)     /* truncintok */
      ;  if
         (  !(opt->flags & MCX_OPT_HIDDEN)
         || display & MCX_OPT_DISPLAY_HIDDEN
         )
         mywidth = MAX(mywidth, thislen)

      ;  if (opt->descr_usage)
         {  parse_descr
            (opt->descr_usage, &descr_usage, &descr_mark, &mark_width)
         ;  mark_width_max = MAX(mark_width_max, mark_width)
      ;  }
      }

      if (!width)
      width = mywidth

   ;  for (opt = baseopt; opt->tag; opt++)
      {  const char* skip = ""
      ;  if
         (  opt->flags & MCX_OPT_HIDDEN
         && !(display & MCX_OPT_DISPLAY_HIDDEN)
         )
         {  id_prev = opt->id
         ;  continue
      ;  }

         if (display & MCX_OPT_DISPLAY_SKIP && opt->id - id_prev > 1)
         skip = "\n"
      ;  id_prev = opt->id
      
      ;  if
         (  (  opt->flags & MCX_OPT_HASARG
            || opt->flags & MCX_OPT_EMBEDDED
            )
            && opt->descr_arg
         )
         mcxTingPrint
         (  scr
         ,  "%s%c%s"
         ,  opt->tag
         ,  opt->flags & MCX_OPT_EMBEDDED ? '=' : ' '
         ,  opt->descr_arg
         )
      ;  else
         mcxTingPrint(scr, "%s", opt->tag)

      ;  fputs(skip, fp)

      ;  if (!opt->descr_usage)
         {  fprintf(fp, "%s\n", scr->str)
         ;  continue
      ;  }

         if (mark_width_max)
         {  parse_descr
            (opt->descr_usage, &descr_usage, &descr_mark, &mark_width)
         ;  fprintf(fp, "%-*s", width, scr->str)
         ;  fprintf(fp, " %-*.*s  ",(int) mark_width_max,mark_width, descr_mark)
         ;  fprintf(fp, "%s\n", descr_usage)
      ;  }
         else
         {  fprintf(fp, "%-*s", width, scr->str)
         ;  fprintf(fp, " %s\n", opt->descr_usage)
      ;  }
      }
   }


char** mcxOptParseString
(  char* src
,  int*  argc
,  unsigned char delim
)
   {  dim srclen  =  strlen(src)
   ;  dim n_delim =  mcxStrCountChar(src, delim, srclen)
   ;  dim n_args  =  0
   ;  char** argv
   ;  char *z  =  src + srclen
   ;  char *p = src, *os

   ;  *argc = 0

   ;  if (!srclen)
      return NULL

   ;  if (!(argv = mcxAlloc(sizeof(char*) * (n_delim+1), RETURN_ON_FAIL)))
      return NULL

   ;  while (p<z)
      {  while ((unsigned char) p[0] == delim)
         p++
      ;  if (p>=z)
         break
      ;  os = p
      ;  if (!(p = strchr(os, delim)))
         p = z
      ;  *p = '\0'
      ;  argv[n_args++] = os
      ;  p++
   ;  }

      *argc = n_args
   ;  return argv
;  }


mcxbool mcxOptIsInfo
(  const char*  arg
,  mcxOptAnchor* options
)
   {  mcxOptAnchor* opt
   ;  for (opt = options; opt->tag; opt++)
      if (!strcmp(opt->tag, arg))
      break
   ;  return (opt->tag && opt->flags  & MCX_OPT_INFO) ? TRUE : FALSE
;  }


char* mcxOptArgLine
(  const char** argv
,  int argc
,  int quote
)
   {  mcxTing* cl = mcxTingEmpty(NULL, 80)
   ;  int i
   ;  const char* ql = "*", *qr = "*"

   ;  if (quote == '[')
      ql = "[", qr = "]"
   ;  else if (quote == '{')
      ql = "{", qr = "}"
   ;  else if (quote == '<')
      ql = "<", qr = ">"
   ;  else if (quote == '(')
      ql = "(", qr = ")"
   ;  else if (quote == '"')
      ql = "\"", qr = "\""
   ;  else if (quote == '\'')
      ql = "'", qr = "'"

   ;  if (argc)
      mcxTingPrint(cl, "%s%s%s", ql, argv[0], qr)

   ;  for (i=1;i<argc;i++)
      mcxTingPrintAfter(cl, " %s%s%s", ql, argv[i], qr)
   ;  return mcxTinguish(cl)
;  }



mcxOptAnchor mcxDispGiraffe[] =
{  {  "--version"
   ,  MCX_OPT_DEFAULT
   ,  MCX_DISP_GIRAFFE_VERSION
   ,  NULL
   ,  "output version information, exit"
   }
,  {  "--test"
   ,  MCX_OPT_HIDDEN
   ,  MCX_DISP_GIRAFFE_TEST
   ,  NULL
   ,  "test"
   }
,  {  "-debug"
   ,  MCX_OPT_HIDDEN
   ,  MCX_DISP_GIRAFFE_DEBUG
   ,  "<int>"
   ,  "set debug level or bits"
   }
,  {  "-set"
   ,  MCX_OPT_HASARG
   ,  MCX_DISP_GIRAFFE_SET
   ,  "key=val"
   ,  "set key to val in ENV"
   }
,  {  "--nop"
   ,  MCX_OPT_DEFAULT
   ,  MCX_DISP_GIRAFFE_NOP
   ,  NULL
   ,  "this option has no affect but changing the argument count"
   }
,  {  "-h"
   ,  MCX_OPT_DEFAULT
   ,  MCX_DISP_GIRAFFE_HELP
   ,  NULL
   ,  "this"
   }
,  {  "--apropos"
   ,  MCX_OPT_DEFAULT
   ,  MCX_DISP_GIRAFFE_APROPOS
   ,  NULL
   ,  "this"
   }
,  {  "--amoixa"
   ,  MCX_OPT_HIDDEN
   ,  MCX_DISP_GIRAFFE_AMOIXA
   ,  NULL
   ,  "show hidden options too"
   }
,  {  NULL ,  0 ,  0 ,  NULL, NULL}
}  ;


dim mcxDispGiraffeCount = sizeof(mcxDispGiraffe) / sizeof(mcxOptAnchor) -1;

mcxbits mcx_disp_giraffe_debug =  0;
mcxbool mcx_disp_giraffe_test  =  FALSE;


int mcxDispatch
(  int                  argc
,  const char*          argv[]
,  const char*          me
,  const char*          syntax
,  mcxOptAnchor*        dispatcher_options
,  dim                  n_options
,  mcxDispEntry*        entry_dir
,  void                 (*report_version)(const char* me)
)
   {  const char* mode_str
   ;  mcxDispHook* hk = NULL

   ;  mcxOption* opts, *opt
   ;  int n_arg_read = 0
   ;  mcxstatus parseStatus = STATUS_FAIL
   ;  mcxHash *clmOpts, *delgOpts, *mergedOpts
   ;  mcxTing* me_and_it
   ;  mcxDispEntry* entry
   ;  int help = argc <= 1 || !strcmp(argv[1], "-h") ? 1 : 0
   ;  int delg_id_max
   ;  int a

   ;  mcxOptAnchorSortById(dispatcher_options, n_options)
   ;  clmOpts = mcxOptHash(dispatcher_options, NULL)
   ;  delg_id_max = dispatcher_options[n_options-1].id

   ;  if (argc > 1 && !strcmp(argv[1], "--amoixa"))
      help = 2

   ;  if (help)
      {  entry = entry_dir+0
      ;  fprintf(stdout, "%s\n\n", syntax)
      ;  while(entry->id >= 0)
         {  hk = entry->get_hk()
         ;  if ((hk->flags & MCX_DISP_HIDDEN) && help < 2)
            NOTHING
         ;  else
            fprintf(stdout, "%s %s\n", me, hk->syntax)
         ;  entry++
      ;  }
         exit(0)
   ;  }
      else if (!strcmp(argv[1], "--version"))
         report_version(me)
      ,  exit(0)

   ;  mode_str = argv[1]

                  /* Find the mode in which we are invoked */
   ;  {  const char* name
      ;  entry = entry_dir+0
      ;  while (entry->id >= 0)
         {  hk = entry->get_hk()
         ;  name = hk->name
         ;  if (!strcmp(name, mode_str))
            break
         ;  entry++
      ;  }
         if (entry->id < 0)
         mcxDie(1, me, "unknown mode <%s>", mode_str)
   ;  }

      me_and_it = mcxTingPrint(NULL, "%s %s", me, hk->syntax)
   ;  mcxOptAnchorSortById(hk->options, hk->n_options)

   ;  if (delg_id_max >= hk->options[0].id)
      mcxDie(1, me, "PBD option merge is pointless")

   ;  delgOpts    =  mcxOptHash(hk->options, NULL)
   ;  mergedOpts  =  mcxHashMerge(clmOpts, delgOpts, NULL, NULL)
   ;  opts        =  mcxHOptExhaust
                     (mergedOpts, (char**) argv, argc, 2, &n_arg_read, &parseStatus)

   ;  if (parseStatus != STATUS_OK)
      {  mcxErr(me, "initialization failed")
      ;  exit(1)
   ;  }

      if (hk->init())
      mcxDie(1, me, "initialization failed for <%s>", hk->name)

   ;  for (opt=opts;opt->anch;opt++)
      {  mcxOptAnchor* anch = opt->anch
      ;  switch(anch->id)
         {  case MCX_DISP_GIRAFFE_HELP
         :  case MCX_DISP_GIRAFFE_APROPOS
         :  case MCX_DISP_GIRAFFE_AMOIXA
         :  mcxOptApropos
            (  stdout
            ,  hk->name
            ,  me_and_it->str
            ,  15
            ,  0
            ,  dispatcher_options
            )
         ;  mcxOptApropos
            (  stdout
            ,  hk->name
            ,  NULL
            ,  15
            ,     MCX_OPT_DISPLAY_SKIP
               |  (  anch->id == MCX_DISP_GIRAFFE_AMOIXA
                  ?  MCX_OPT_DISPLAY_HIDDEN
                  :  0
                  )
            ,  hk->options
            )
         ;  mcxExit(0)
         ;  break
         ;

            case MCX_DISP_GIRAFFE_VERSION
         :  report_version(me)
         ;  mcxExit(0)
         ;  break
         ;

            case MCX_DISP_GIRAFFE_NOP
         :  NOTHING
         ;  break
         ;

            case MCX_DISP_GIRAFFE_TEST
         :  mcx_disp_giraffe_test = TRUE
         ;  break
         ;

            case MCX_DISP_GIRAFFE_DEBUG
         :  mcx_disp_giraffe_debug = atoi(opt->val)
         ;  break
         ;

            case MCX_DISP_GIRAFFE_SET
         :  mcxSetenv(opt->val)
         ;  break
         ;

            default
         :  if (hk->arg_cb(anch->id, opt->val)) mcxDie(1, me, "curtains")
         ;  break
         ;
         }
      }
#if 0
      {  mcxOptAnchor* anch = opt->anch
      ;  if
         (  anch->id == MCX_DISP_GIRAFFE_HELP
         || anch->id == MCX_DISP_GIRAFFE_APROPOS
         || anch->id == MCX_DISP_GIRAFFE_AMOIXA
         )
         {  mcxOptApropos
            (  stdout
            ,  hk->name
            ,  me_and_it->str
            ,  15
            ,  0
            ,  dispatcher_options
            )
         ;  mcxOptApropos
            (  stdout
            ,  hk->name
            ,  NULL
            ,  15
            ,     MCX_OPT_DISPLAY_SKIP
               |  (  anch->id == MCX_DISP_GIRAFFE_AMOIXA
                  ?  MCX_OPT_DISPLAY_HIDDEN
                  :  0
                  )
            ,  hk->options
            )
         ;  mcxExit(0)
      ;  }
         else if (anch->id == MCX_DISP_GIRAFFE_VERSION)
            report_version(me)
         ,  mcxExit(0)

      ;  else if (anch->id == MCX_DISP_GIRAFFE_NOP)
         NOTHING

      ;  else if (anch->id == MCX_DISP_GIRAFFE_TEST)
         mcx_disp_giraffe_test = TRUE

      ;  else if (anch->id == MCX_DISP_GIRAFFE_DEBUG)
         mcx_disp_giraffe_debug = atoi(opt->val)

      ;  else if (anch->id == MCX_DISP_GIRAFFE_SET)
         mcxSetenv(opt->val)

      ;  else if (hk->arg_cb(anch->id, opt->val))
         mcxDie(1, me, "curtains")
   ;  }
#endif

      a = 2 + n_arg_read

   ;  if (argc == 2)
         mcxOptApropos
         (  stdout
         ,  hk->name
         ,  me_and_it->str
         ,  15
         ,  0
         ,  hk->options
         )
      ,  mcxExit(0)

   ;  if
      (  a + hk->n_at_least > argc
      || (hk->n_at_most >= 0 && a + hk->n_at_most < argc)
      )
      {  mcxTing* t
         =  mcxTingPrint
            (  NULL
            ,  "mode %s needs %s %d trailing arguments"
            ,  mode_str
            ,  hk->n_at_least == hk->n_at_most ? "exactly" : "at least"
            ,  hk->n_at_least
            )
      ;  if (hk->n_at_most > hk->n_at_most)
         mcxTingPrintAfter(t, " and at most %d", hk->n_at_most)

      ;  mcxDie(1, me, t->str)
   ;  }

      return hk->main(argc-a, argv+a)
   ;  return 0
;  }