common/ttyio.h

   1 /* ttyio.h
   2  * Copyright (C) 1998, 1999, 2000, 2001, 2003, 2006,
   3  *               2009 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNUPG.
   6  *
   7  * This file is free software; you can redistribute it and/or modify
   8  * it under the terms of either
   9  *
  10  *   - the GNU Lesser General Public License as published by the Free
  11  *     Software Foundation; either version 3 of the License, or (at
  12  *     your option) any later version.
  13  *
  14  * or
  15  *
  16  *   - the GNU General Public License as published by the Free
  17  *     Software Foundation; either version 2 of the License, or (at
  18  *     your option) any later version.
  19  *
  20  * or both in parallel, as here.
  21  *
  22  * This file is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program; if not, see <https://www.gnu.org/licenses/>.
  29  */
  30 #ifndef GNUPG_COMMON_TTYIO_H
  31 #define GNUPG_COMMON_TTYIO_H
  32
  33 #include "util.h" /* Make sure our readline typedef is available. */
  34
  35
  36 const char *tty_get_ttyname (void);
  37 int tty_batchmode (int onoff);
  38 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
  39 void tty_printf (const char *fmt, ... )
  40                  __attribute__ ((format (printf,1,2)));
  41 void tty_fprintf (estream_t fp, const char *fmt, ... )
  42                  __attribute__ ((format (printf,2,3)));
  43 char *tty_getf (const char *promptfmt, ... )
  44                  __attribute__ ((format (printf,1,2)));
  45 #else
  46 void tty_printf (const char *fmt, ... );
  47 void tty_fprintf (estream_t fp, const char *fmt, ... );
  48 char *tty_getf (const char *promptfmt, ... );
  49 #endif
  50 void tty_print_string (estream_t fp, const unsigned char *p, size_t n);
  51 void tty_print_utf8_string (const unsigned char *p, size_t n);
  52 void tty_print_utf8_string2 (estream_t fp,
  53                              const unsigned char *p, size_t n, size_t max_n);
  54 char *tty_get (const char *prompt);
  55 char *tty_get_hidden (const char *prompt);
  56 void tty_kill_prompt (void);
  57 int tty_get_answer_is_yes (const char *prompt);
  58 int tty_no_terminal (int onoff);
  59
  60 #ifdef HAVE_LIBREADLINE
  61 void tty_enable_completion (rl_completion_func_t *completer);
  62 void tty_disable_completion (void);
  63 #else
  64 /* Use a macro to stub out these functions since a macro has no need
  65    to typedef a "rl_completion_func_t" which would be undefined
  66    without readline. */
  67 #define tty_enable_completion(x)
  68 #define tty_disable_completion()
  69 #endif
  70 void tty_cleanup_after_signal (void);
  71 void tty_cleanup_rl_after_signal (void);
  72
  73
  74 #endif /*GNUPG_COMMON_TTYIO_H*/