help.h

Go to the documentation of this file.

/* Write commands associated with a given target. */
/*
Copyright (C) 2011, 2020 R. Bernstein <rocky@gnu.org>
This file is part of GNU Make (remake variant).

GNU Make is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Make is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Make; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
/* Debugger help command. */

#include "help/help.h"

void
dbg_help_subcmd_entry(const char *psz_subcmd_name, const char *psz_fmt,
                      subcommand_var_info_t *p_subcmd, bool full_info)
{
    if (full_info) {
      const char *doc = p_subcmd->doc ?
        p_subcmd->doc : p_subcmd->short_doc;
      printf("%s ", psz_subcmd_name);
      printf("%s\n%s.", p_subcmd->name, doc);
    } else {
      printf("%s ", psz_subcmd_name);
      printf(psz_fmt, p_subcmd->name, p_subcmd->short_doc);
      if (p_subcmd->var) {
        if (p_subcmd->b_onoff)
          printf(" is %s.",
                 var_to_on_off(* (int *) p_subcmd->var));
        else
          printf(" is %d.", *(int *)(p_subcmd->var));
      }
    }

    printf("\n");
}

debug_return_t
dbg_help_subcmd(const char *psz_subcmd_name,
                short_cmd_t *p_command, const char *psz_args,
                subcommand_var_info_t *subcommands)
{
    unsigned int i;
    if (!psz_args || !*psz_args) {
        printf("%s\n\n%s\n", p_command->use, p_command->doc);
    } else {
        for (i = 0; subcommands[i].name; i++) {
            if (is_abbrev_of(psz_args, subcommands[i].name,
                             subcommands[i].min_abbrev)) {
                dbg_help_subcmd_entry(psz_subcmd_name, "%s. %s",
                                      &(subcommands[i]), true);
                return debug_readloop;
            }
        }
        dbg_errmsg("There is no \"%s %s\" command.", psz_subcmd_name, psz_args);
    }
    return debug_readloop;
}

static bool
is_alias(const char *psz_command_name, const alias_cmd_t *p_alias)
{
  return strcmp (psz_command_name, p_alias->command) == 0;
}

debug_return_t
dbg_cmd_help(char *psz_args)
{
  unsigned int i;

  if (!psz_args || !*psz_args) {
    printf ("  Command                  Short Name  Aliases\n");
    printf ("  ----------------------   ----------  ---------\n");
    for (i = 0; commands[i].long_name; i++) {
      unsigned int j;
      bool b_alias = false;
      uint8_t s=commands[i].short_name;
      printf("  %-31s (%c)",
             short_command[s].use, commands[i].short_name);
      for (j = 0; aliases[j].alias; j++) {
        if (is_alias(commands[i].long_name, &aliases[j])) {
          if (!b_alias) {
            printf("  %s", aliases[j].alias);
            b_alias = true;
          } else {
            printf(", %s", aliases[j].alias);
          }
        }
      }
      printf("\n");
    }

    dbg_msg("\nReadline command line editing (emacs/vi mode) is available.\n"
"For more detailed help, type 'help COMAMND-NAME' or consult\n"
"the online-documentation.\n");

  } else {
      short_cmd_t *p_command;
      const char *psz_command = "";

      if (1 == strlen(psz_args)) {
          if ( NULL != short_command[(uint8_t)psz_args[0]].func )
              p_command = &short_command[(uint8_t)psz_args[0]];
          else
              p_command = NULL;
      } else {
          psz_command = get_word(&psz_args);
          p_command = find_command (psz_command);
      }
      if (p_command) {
          if ( p_command->func == &dbg_cmd_info ) {
              return dbg_help_subcmd("info", p_command, psz_args, info_subcommands);
          } else if ( p_command->func == &dbg_cmd_show ) {
              return dbg_help_subcmd("show", p_command, psz_args, show_subcommands);
          } else if ( p_command->func == &dbg_cmd_set ) {
              return dbg_help_subcmd("set", p_command, psz_args, set_subcommands);
          } else {
            const long_cmd_t *p_long_command = &commands[p_command->id];
            printf("%s\n\n", p_command->use);
            printf("%s\n", p_command->doc);
            printf("\nShort name and aliases: %c", p_long_command->short_name);
            for (int j = 0; aliases[j].alias; j++) {
              if (p_long_command->long_name && is_alias(p_long_command->long_name, &aliases[j])) {
                printf(", %s", aliases[j].alias);
              }
            }
            printf("\n");
          }

      } else {
          dbg_errmsg("Undefined command `%s'. Try help for a list of commands.\n",
                     psz_command);
      }
  }

  return debug_readloop;
}

static void
dbg_cmd_help_init(unsigned int c)
{
  short_command[c].func = &dbg_cmd_help;
  short_command[c].use  = _("help [COMMAND]");
}


/*
 * Local variables:
 * eval: (c-set-style "gnu")
 * indent-tabs-mode: nil
 * End:
 */