BURG-grub2/commands/help.c

/* help.c - command to show a help text.  */
/*
 *  GRUB  --  GRand Unified Bootloader
 *  Copyright (C) 2005,2007,2008,2009  Free Software Foundation, Inc.
 *
 *  GRUB 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 3 of the License, or
 *  (at your option) any later version.
 *
 *  GRUB 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 GRUB.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <grub/dl.h>
#include <grub/misc.h>
#include <grub/term.h>
#include <grub/extcmd.h>
#include <grub/i18n.h>
#include <grub/mm.h>
#include <grub/lib.h>
#include <grub/charset.h>

struct grub_cmd_help_closure
{
  int cnt;
  char *currarg;
};

static int
print_command_info (grub_command_t cmd, void *closure)
{
  struct grub_cmd_help_closure *c = closure;

  if ((cmd->prio & GRUB_PRIO_LIST_FLAG_ACTIVE) &&
      (cmd->flags & GRUB_COMMAND_FLAG_CMDLINE))
    {
      struct grub_term_output *term;
      const char *summary_translated = _(cmd->summary);
      char *command_help;
      grub_uint32_t *unicode_command_help;
      grub_uint32_t *unicode_last_position;

      command_help = grub_xasprintf ("%s %s", cmd->name, summary_translated);
      if (! command_help)
	return 1;

      grub_utf8_to_ucs4_alloc (command_help, &unicode_command_help,
			       &unicode_last_position);

      FOR_ACTIVE_TERM_OUTPUTS(term)
	{
	  unsigned stringwidth;
	  grub_uint32_t *unicode_last_screen_position;

	  unicode_last_screen_position = unicode_command_help;

	  stringwidth = 0;

	  while (unicode_last_screen_position < unicode_last_position &&
		 stringwidth < ((grub_term_width (term) / 2) - 2))
	    {
	      stringwidth
		+= grub_term_getcharwidth (term,
					   *unicode_last_screen_position);
	      unicode_last_screen_position++;
	    }

	  grub_print_ucs4 (unicode_command_help,
			   unicode_last_screen_position, term);
	  if (!(c->cnt % 2))
	    grub_print_spaces (term, grub_term_width (term) / 2
			       - stringwidth);
	}
      if (c->cnt % 2)
	grub_printf ("\n");
      c->cnt++;

      grub_free (command_help);
      grub_free (unicode_command_help);
    }
  return 0;
}

static int
print_command_help (grub_command_t cmd, void *closure)
{
  struct grub_cmd_help_closure *c = closure;

  if (cmd->prio & GRUB_PRIO_LIST_FLAG_ACTIVE)
    {
      if (! grub_strncmp (cmd->name, c->currarg, grub_strlen (c->currarg)))
	{
	  if (c->cnt++ > 0)
	    grub_printf ("\n\n");

	  if (cmd->flags & GRUB_COMMAND_FLAG_EXTCMD)
	    grub_arg_show_help ((grub_extcmd_t) cmd->data);
	  else
	    grub_printf ("%s %s %s\n%s\n", _("Usage:"), cmd->name, _(cmd->summary),
			 _(cmd->description));
	}
    }
  return 0;
}

static grub_err_t
grub_cmd_help (grub_extcmd_t ext __attribute__ ((unused)), int argc,
	       char **args)
{
  struct grub_cmd_help_closure c;

  c.cnt = 0;

  if (argc == 0)
    {
      grub_command_iterate (print_command_info, &c);
      if (!(c.cnt % 2))
	grub_printf ("\n");
    }
  else
    {
      int i;

      for (i = 0; i < argc; i++)
	{
	  c.currarg = args[i];
	  grub_command_iterate (print_command_help, &c);
	}
    }

  return 0;
}

static grub_extcmd_t cmd;

GRUB_MOD_INIT(help)
{
  cmd = grub_register_extcmd ("help", grub_cmd_help,
			      GRUB_COMMAND_FLAG_CMDLINE,
			      N_("[PATTERN ...]"),
			      N_("Show a help message."), 0);
}

GRUB_MOD_FINI(help)
{
  grub_unregister_extcmd (cmd);
}