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