src/ui/terminal/read-line.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2007 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #include <config.h>
  18
  19 #include "read-line.h"
  20
  21 #include <stdlib.h>
  22 #include <stdbool.h>
  23 #include <assert.h>
  24 #include <errno.h>
  25
  26 #include "msg-ui.h"
  27
  28 #include <data/file-name.h>
  29 #include <data/settings.h>
  30 #include <language/command.h>
  31 #include <libpspp/message.h>
  32 #include <libpspp/str.h>
  33 #include <libpspp/version.h>
  34 #include <language/prompt.h>
  35 #include <output/journal.h>
  36 #include <output/manager.h>
  37
  38 #include "xalloc.h"
  39
  40 #include "gettext.h"
  41 #define _(msgid) gettext (msgid)
  42
  43 #if HAVE_READLINE
  44 #include <readline/readline.h>
  45 #include <readline/history.h>
  46
  47 static char *history_file;
  48
  49 static char **complete_command_name (const char *, int, int);
  50 static char **dont_complete (const char *, int, int);
  51 #endif /* HAVE_READLINE */
  52
  53
  54 struct readln_source
  55 {
  56   struct getl_interface parent ;
  57
  58   bool (*interactive_func) (struct string *line,
  59                             enum prompt_style) ;
  60 };
  61
  62
  63 static bool initialised = false;
  64
  65 /* Initialize getl. */
  66 void
  67 readln_initialize (void)
  68 {
  69   initialised = true;
  70
  71 #if HAVE_READLINE
  72   rl_basic_word_break_characters = "\n";
  73   using_history ();
  74   stifle_history (500);
  75   if (history_file == NULL)
  76     {
  77       const char *home_dir = getenv ("HOME");
  78       if (home_dir != NULL)
  79         {
  80           history_file = xasprintf ("%s/.pspp_history", home_dir);
  81           read_history (history_file);
  82         }
  83     }
  84 #endif
  85 }
  86
  87 /* Close getl. */
  88 void
  89 readln_uninitialize (void)
  90 {
  91   initialised = false;
  92
  93 #if HAVE_READLINE
  94   if (history_file != NULL && false == get_testing_mode() )
  95     write_history (history_file);
  96   clear_history ();
  97   free (history_file);
  98 #endif
  99 }
 100
 101
 102 static bool
 103 read_interactive (struct getl_interface *s,
 104                   struct string *line)
 105 {
 106   struct readln_source *is  =
 107     (struct readln_source *) s ;
 108
 109   return is->interactive_func (line, prompt_get_style ());
 110 }
 111
 112 static bool
 113 always_true (const struct getl_interface *s UNUSED)
 114 {
 115   return true;
 116 }
 117
 118 /* Display a welcoming message. */
 119 static void
 120 welcome (void)
 121 {
 122   static bool welcomed = false;
 123   if (welcomed)
 124     return;
 125   welcomed = true;
 126   fputs ("PSPP is free software and you are welcome to distribute copies of "
 127          "it\nunder certain conditions; type \"show copying.\" to see the "
 128          "conditions.\nThere is ABSOLUTELY NO WARRANTY for PSPP; type \"show "
 129          "warranty.\" for details.\n", stdout);
 130   puts (stat_version);
 131   readln_initialize ();
 132   journal_enable ();
 133 }
 134
 135 /* Gets a line from the user and stores it into LINE.
 136    Prompts the user with PROMPT.
 137    Returns true if successful, false at end of file.
 138    */
 139 static bool
 140 readln_read (struct string *line, enum prompt_style style)
 141 {
 142   const char *prompt = prompt_get (style);
 143 #if HAVE_READLINE
 144   char *string;
 145 #endif
 146
 147   assert (initialised);
 148
 149   reset_msg_count ();
 150
 151   welcome ();
 152
 153   if (style == PROMPT_FIRST)
 154     som_flush ();
 155
 156 #if HAVE_READLINE
 157   rl_attempted_completion_function = (style == PROMPT_FIRST
 158                                       ? complete_command_name
 159                                       : dont_complete);
 160   string = readline (prompt);
 161   if (string == NULL)
 162     return false;
 163   else
 164     {
 165       if (string[0])
 166         add_history (string);
 167       ds_assign_cstr (line, string);
 168       free (string);
 169       return true;
 170     }
 171 #else
 172   fputs (prompt, stdout);
 173   fflush (stdout);
 174   if (ds_read_line (line, stdin))
 175     {
 176       ds_chomp (line, '\n');
 177       return true;
 178     }
 179   else
 180     return false;
 181 #endif
 182 }
 183
 184
 185 static void
 186 readln_close (struct getl_interface *i)
 187 {
 188   free (i);
 189 }
 190
 191 /* Creates a source which uses readln to get its line */
 192 struct getl_interface *
 193 create_readln_source (void)
 194 {
 195   struct readln_source *rlns  = xzalloc (sizeof (*rlns));
 196
 197   rlns->interactive_func = readln_read;
 198
 199   rlns->parent.interactive = always_true;
 200   rlns->parent.read = read_interactive;
 201   rlns->parent.close = readln_close;
 202
 203   return (struct getl_interface *) rlns;
 204 }
 205
 206
 207 #if HAVE_READLINE
 208 static char *command_generator (const char *text, int state);
 209
 210 /* Returns a set of command name completions for TEXT.
 211    This is of the proper form for assigning to
 212    rl_attempted_completion_function. */
 213 static char **
 214 complete_command_name (const char *text, int start, int end UNUSED)
 215 {
 216   if (start == 0)
 217     {
 218       /* Complete command name at start of line. */
 219       return rl_completion_matches (text, command_generator);
 220     }
 221   else
 222     {
 223       /* Otherwise don't do any completion. */
 224       rl_attempted_completion_over = 1;
 225       return NULL;
 226     }
 227 }
 228
 229 /* Do not do any completion for TEXT. */
 230 static char **
 231 dont_complete (const char *text UNUSED, int start UNUSED, int end UNUSED)
 232 {
 233   rl_attempted_completion_over = 1;
 234   return NULL;
 235 }
 236
 237 /* If STATE is 0, returns the first command name matching TEXT.
 238    Otherwise, returns the next command name matching TEXT.
 239    Returns a null pointer when no matches are left. */
 240 static char *
 241 command_generator (const char *text, int state)
 242 {
 243   static const struct command *cmd;
 244   const char *name;
 245
 246   if (state == 0)
 247     cmd = NULL;
 248   name = cmd_complete (text, &cmd);
 249   return name ? xstrdup (name) : NULL;
 250 }
 251 #endif /* HAVE_READLINE */