// file      : libbutl/builtin.cli
// license   : MIT; see accompanying LICENSE file

include <string>;
include <vector>;

// Note that options in this file are undocumented because we generate neither
// the usage printing code nor man pages. Instead, they are documented in the
// Testscript Language Manual's builtin descriptions.
//
// @@ Update the above reference when the documentation is moved to another
//    place.
//
// Also note that the string type is used for the path options because their
// parsing depends on the working directory (see parse_path() for details) and
// passing this information to the CLI custom parser would not be easy.
//
namespace butl
{
  class cat_options
  {
    // No options so far.
    //
  };

  class cp_options
  {
    bool --recursive|-R|-r;
    bool --preserve|-p;
  };

  class date_options
  {
    bool --utc|-u;
  };

  class find_options
  {
    // No options so far (expression/primaries handled as arguments).
  };

  class ln_options
  {
    bool --symbolic|-s;
  };

  class mkdir_options
  {
    bool --parents|-p;
  };

  class mv_options
  {
    bool --force|-f;
  };

  class rm_options
  {
    bool --recursive|-r;
    bool --force|-f;
  };

  class rmdir_options
  {
    bool --force|-f;
  };

  class sed_options
  {
    bool --quiet|-n;
    bool --in-place|-i;
    std::vector<std::string> --expression|-e;
  };

  // Common options of the sha256sum and xxh64sum builtins.
  //
  class checksum_options
  {
    bool --binary|-b;
    bool --text|-t;
    bool --sum-only;
  };

  class sleep_options
  {
    // No options so far.
    //
  };

  class test_options
  {
    bool --file|-f;
    bool --directory|-d;
  };

  class touch_options
  {
    std::string --after; // Path (see above).
  };
}
