/*
 * BRLTTY - A background process providing access to the console screen (when in
 *          text mode) for a blind person using a refreshable braille display.
 *
 * Copyright (C) 1995-2026 by The BRLTTY Developers.
 *
 * BRLTTY comes with ABSOLUTELY NO WARRANTY.
 *
 * This is free software, placed under the terms of the
 * GNU Lesser General Public License, as published by the Free Software
 * Foundation; either version 2.1 of the License, or (at your option) any
 * later version. Please see the file LICENSE-LGPL for details.
 *
 * Web Page: http://brltty.app/
 *
 * This software is maintained by Dave Mielke <dave@mielke.cc>.
 */

#include "prologue.h"

#include "cmdline.h"
#include "log.h"
#include "parse.h"

static int flagOption;
static int counterOption;

static char *textOption;
static char *listOption;

BEGIN_COMMAND_LINE_OPTIONS(programOptions)
  { .word = "flag",
    .letter = 'f',
    .setting.flag = &flagOption,
    .description = "defaults to false - true if specified at least once",
  },

  { .word = "counter",
    .letter = 'c',
    .flags = OPT_Extend,
    .setting.flag = &counterOption,
    .description = "counts the number of times this option is specified",
  },

  { .word = "text",
    .letter = 't',
    .argument = "text",
    .internal.setting = "this is the default text (because this option wasn't specified)",
    .setting.string = &textOption,
    .description = "arbitrary text - rightmost specification wins",
  },

  { .word = "list",
    .letter = 'l',
    .argument = "item",
    .flags = OPT_Extend,
    .setting.string = &listOption,
    .description = "each specification adds an item to the list",
  },
END_COMMAND_LINE_OPTIONS(programOptions)

static const char *firstParameter;
static const char *secondParameter;

BEGIN_COMMAND_LINE_PARAMETERS(programParameters)
  { .name = "first",
    .description = "a required parameter",
    .setting = &firstParameter,
  },

  { .name = "second",
    .description = "an optional parameter",
    .setting = &secondParameter,
    .optional = 1,
  },
END_COMMAND_LINE_PARAMETERS(programParameters)

BEGIN_COMMAND_LINE_NOTES(programNotes)
  "Unspecified optional parameters are set to NULL.",
  "Unspecified text and list options are set to an empty string (\"\").",
  "Unspecified flag options are set to false (0).",
  "Unspecified counter options are set to zero (0).",
  "Items within a list are separated from one another by a comma (,).",
  "",
  "A sequence of unindented lines are formatted into a paragraph,",
  "with a single space being inserted between them.",
  "  Indented and empty lines aren't formatted and interrupt paragraph formatting.",
  "The lines within a paragraph are wrapped at word boundaries",
  "with the maximum length of each being the width of the screen.",
END_COMMAND_LINE_NOTES

BEGIN_COMMAND_LINE_NOTES(additionalNotes)
  "One or more additional notes blocks may be specified.",
  "See brltty-tune.c and tune_builder.[ch] for a practical example -",
  "the notes within brltty-tune are for the command itself",
  "whereas those within tune_builder describe how to write a tune.",
END_COMMAND_LINE_NOTES

BEGIN_COMMAND_LINE_DESCRIPTOR(programDescriptor)
  .name = "cmdtest",
  .purpose = "Test, as well as demonstrate how to use, the command line parser.",

  .options = &programOptions,
  .parameters = &programParameters,
  .notes = COMMAND_LINE_NOTES(programNotes, additionalNotes),

  .extraParameters = {
     .name = "extra",
     .description = "zero or more additional parameters",
  },
END_COMMAND_LINE_DESCRIPTOR

int
main (int argc, char *argv[]) {
  PROCESS_COMMAND_LINE(programDescriptor, argc, argv);

  int logLevel = LOG_NOTICE;

  logMessage(logLevel, "Flag: %s", (flagOption? fkpTrueFalse.on: fkpTrueFalse.off));
  logMessage(logLevel, "Counter: %d", counterOption);

  logMessage(logLevel, "Text: %s", textOption);
  logMessage(logLevel, "List: %s", listOption);

  logMessage(logLevel, "First Parameter: %s", firstParameter);
  if (!secondParameter) secondParameter = "(not specified)";
  logMessage(logLevel, "Second Parameter: %s", secondParameter);

  for (int index=0; index<argc; index+=1) {
    logMessage(logLevel, "Extra Parameter: %s", argv[index]);
  }

  return PROG_EXIT_SUCCESS;
}
