grub-core/commands/sleep.c

   1 /* sleep.c - Command to wait a specified number of seconds.  */
   2 /*
   3  *  GRUB  --  GRand Unified Bootloader
   4  *  Copyright (C) 2006,2007,2008  Free Software Foundation, Inc.
   5  *
   6  *  GRUB is free software: you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation, either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  GRUB is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <grub/dl.h>
  21 #include <grub/term.h>
  22 #include <grub/time.h>
  23 #include <grub/types.h>
  24 #include <grub/misc.h>
  25 #include <grub/extcmd.h>
  26 #include <grub/i18n.h>
  27
  28 static const struct grub_arg_option options[] =
  29   {
  30     {"verbose", 'v', 0, N_("Verbose countdown."), 0, 0},
  31     {"interruptible", 'i', 0, N_("Interruptible with ESC."), 0, 0},
  32     {0, 0, 0, 0, 0, 0}
  33   };
  34
  35 static grub_uint16_t *pos;
  36
  37 static void
  38 do_print (int n)
  39 {
  40   grub_term_restore_pos (pos);
  41   /* NOTE: Do not remove the trailing space characters.
  42      They are required to clear the line.  */
  43   grub_printf ("%d    ", n);
  44 }
  45
  46 /* Based on grub_millisleep() from kern/generic/millisleep.c.  */
  47 static int
  48 grub_interruptible_millisleep (grub_uint32_t ms)
  49 {
  50   grub_uint64_t start;
  51
  52   start = grub_get_time_ms ();
  53
  54   while (grub_get_time_ms () - start < ms)
  55     if (grub_checkkey () >= 0 &&
  56         GRUB_TERM_ASCII_CHAR (grub_getkey ()) == GRUB_TERM_ESC)
  57       return 1;
  58
  59   return 0;
  60 }
  61
  62 static grub_err_t
  63 grub_cmd_sleep (grub_extcmd_context_t ctxt, int argc, char **args)
  64 {
  65   struct grub_arg_list *state = ctxt->state;
  66   int n;
  67
  68   if (argc != 1)
  69     return grub_error (GRUB_ERR_BAD_ARGUMENT, "missing operand");
  70
  71   n = grub_strtoul (args[0], 0, 10);
  72
  73   if (n == 0)
  74     {
  75       /* Either `0' or broken input.  */
  76       return 0;
  77     }
  78
  79   pos = grub_term_save_pos ();
  80
  81   for (; n; n--)
  82     {
  83       if (state[0].set)
  84         do_print (n);
  85
  86       if (state[1].set)
  87         {
  88           if (grub_interruptible_millisleep (1000))
  89             return 1;
  90         }
  91       else
  92         grub_millisleep (1000);
  93     }
  94   if (state[0].set)
  95     do_print (0);
  96
  97   return 0;
  98 }
  99
 100 static grub_extcmd_t cmd;
 101 \f
 102 GRUB_MOD_INIT(sleep)
 103 {
 104   cmd = grub_register_extcmd ("sleep", grub_cmd_sleep, GRUB_COMMAND_FLAG_BOTH,
 105                               N_("NUMBER_OF_SECONDS"),
 106                               N_("Wait for a specified number of seconds."),
 107                               options);
 108 }
 109
 110 GRUB_MOD_FINI(sleep)
 111 {
 112   grub_unregister_extcmd (cmd);
 113 }