postgresql/src/bin/psql/input.h

/*
 * psql - the PostgreSQL interactive terminal
 *
 * Copyright (c) 2000-2014, PostgreSQL Global Development Group
 *
 * src/bin/psql/input.h
 */
#ifndef INPUT_H
#define INPUT_H

/*
 * If some other file needs to have access to readline/history, include this
 * file and save yourself all this work.
 *
 * USE_READLINE is the definite pointers regarding existence or not.
 */
#ifdef HAVE_LIBREADLINE
#define USE_READLINE 1

#if defined(HAVE_READLINE_READLINE_H)
#include <readline/readline.h>
#if defined(HAVE_READLINE_HISTORY_H)
#include <readline/history.h>
#endif
#elif defined(HAVE_EDITLINE_READLINE_H)
#include <editline/readline.h>
#if defined(HAVE_EDITLINE_HISTORY_H)
#include <editline/history.h>
#endif
#elif defined(HAVE_READLINE_H)
#include <readline.h>
#if defined(HAVE_HISTORY_H)
#include <history.h>
#endif
#endif   /* HAVE_READLINE_READLINE_H, etc */
#endif   /* HAVE_LIBREADLINE */

#include "pqexpbuffer.h"


char	   *gets_interactive(const char *prompt);
char	   *gets_fromFile(FILE *source);

void		initializeInput(int flags);
bool		saveHistory(char *fname, int max_lines, bool appendFlag, bool encodeFlag);

void		pg_append_history(const char *s, PQExpBuffer history_buf);
void		pg_send_history(PQExpBuffer history_buf);

#endif   /* INPUT_H */
another set of cleanups 2000-01-19 00:30:24 +01:00			`/*`
			`* psql - the PostgreSQL interactive terminal`
			`*`
Update copyright for 2014 Update all files in head, and files COPYRIGHT and legal.sgml in all back branches. 2014-01-07 22:05:30 +01:00			`* Copyright (c) 2000-2014, PostgreSQL Global Development Group`
another set of cleanups 2000-01-19 00:30:24 +01:00			`*`
Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00			`* src/bin/psql/input.h`
another set of cleanups 2000-01-19 00:30:24 +01:00			`*/`
Major psql overhaul by Peter Eisentraut. 1999-11-04 22:56:02 +01:00			`#ifndef INPUT_H`
			`#define INPUT_H`

another set of cleanups 2000-01-19 00:30:24 +01:00			`/*`
			`* If some other file needs to have access to readline/history, include this`
Major psql overhaul by Peter Eisentraut. 1999-11-04 22:56:02 +01:00			`* file and save yourself all this work.`
			`*`
Readline and Zlib now required by default. Add options --without-readline and --without-zlib to turn them off. 2002-04-11 00:47:09 +02:00			`* USE_READLINE is the definite pointers regarding existence or not.`
Major psql overhaul by Peter Eisentraut. 1999-11-04 22:56:02 +01:00			`*/`
			`#ifdef HAVE_LIBREADLINE`
pgindent run. 2002-09-04 22:31:48 +02:00			`#define USE_READLINE 1`
Fix inclusions of readline/editline header files so that we only attempt to #include the version of history.h that is in the same directory as the readline.h we are using. This avoids problems in some scenarios where both readline and editline are installed. Report and patch by Zdenek Kotala. 2009-08-24 18:18:13 +02:00
pgindent run. 2002-09-04 22:31:48 +02:00			`#if defined(HAVE_READLINE_READLINE_H)`
			`#include <readline/readline.h>`
Fix inclusions of readline/editline header files so that we only attempt to #include the version of history.h that is in the same directory as the readline.h we are using. This avoids problems in some scenarios where both readline and editline are installed. Report and patch by Zdenek Kotala. 2009-08-24 18:18:13 +02:00			`#if defined(HAVE_READLINE_HISTORY_H)`
			`#include <readline/history.h>`
			`#endif`
Here's the patch I promised over on HACKERS - it alters the implementation of '\e' history tracking for systems that have a readline compatability library without replace_history_entry. I fall back to pushing the query onto the history stack after the \e, rather than replacing it. The patch adds one more place to look for readline headers, and a test for replace_history_entry. I've only included the patch for configure.in Ross J. Reedstrom 2003-02-19 05:04:04 +01:00			`#elif defined(HAVE_EDITLINE_READLINE_H)`
			`#include <editline/readline.h>`
Fix inclusions of readline/editline header files so that we only attempt to #include the version of history.h that is in the same directory as the readline.h we are using. This avoids problems in some scenarios where both readline and editline are installed. Report and patch by Zdenek Kotala. 2009-08-24 18:18:13 +02:00			`#if defined(HAVE_EDITLINE_HISTORY_H)`
			`#include <editline/history.h>`
			`#endif`
pgindent run. 2002-09-04 22:31:48 +02:00			`#elif defined(HAVE_READLINE_H)`
			`#include <readline.h>`
Fix inclusions of readline/editline header files so that we only attempt to #include the version of history.h that is in the same directory as the readline.h we are using. This avoids problems in some scenarios where both readline and editline are installed. Report and patch by Zdenek Kotala. 2009-08-24 18:18:13 +02:00			`#if defined(HAVE_HISTORY_H)`
pgindent run. 2002-09-04 22:31:48 +02:00			`#include <history.h>`
			`#endif`
pgindent run for 9.0 2010-02-26 03:01:40 +01:00			`#endif /* HAVE_READLINE_READLINE_H, etc */`
			`#endif /* HAVE_LIBREADLINE */`
Major psql overhaul by Peter Eisentraut. 1999-11-04 22:56:02 +01:00
Code review for psql multiline history patch(es). Fix memory leak, failure to enter commands in history if canceled by control-C, other infelicities. 2006-06-12 01:06:00 +02:00			`#include "pqexpbuffer.h"`

Here's some changes I made last night to psql's common.c (as found in 7.3.2). It removes some code duplication and #ifdeffing, and some unstructured ugliness such as tacky breaks and an unneeded continue. Breaks up a large function into smaller functions and reduces required nesting levels, and kills a variable or two. Jeroen T. Vermeulen 2003-03-20 07:00:12 +01:00
			`char gets_interactive(const char prompt);`
Ye-old pgindent run. Same 4-space tabs. 2000-04-12 19:17:23 +02:00			`char gets_fromFile(FILE source);`
Major psql overhaul by Peter Eisentraut. 1999-11-04 22:56:02 +01:00
Ye-old pgindent run. Same 4-space tabs. 2000-04-12 19:17:23 +02:00			`void initializeInput(int flags);`
Write psql's ~/.psql_history file using history_truncate_file() and append_history(), if libreadline is new enough to have those functions (they seem to be present at least since 4.2; but libedit may not have them). This gives significantly saner behavior when two or more sessions overlap in their use of the history file; although having two sessions exit at just the same time is still perilous to your history. The behavior of \s remains unchanged, ie, overwrite whatever was there. Per bug #5052 from Marek Wójtowicz. 2009-09-14 00:18:22 +02:00			`bool saveHistory(char *fname, int max_lines, bool appendFlag, bool encodeFlag);`
Another pgindent run. Fixes enum indenting, and improves #endif spacing. Also adds space for one-line comments. 2001-10-28 07:26:15 +01:00
Code review for psql multiline history patch(es). Fix memory leak, failure to enter commands in history if canceled by control-C, other infelicities. 2006-06-12 01:06:00 +02:00			`void pg_append_history(const char *s, PQExpBuffer history_buf);`
			`void pg_send_history(PQExpBuffer history_buf);`
o Improve psql's handling of multi-line statements Currently, while \e saves a single statement as one entry, interactive statements are saved one line at a time. Ideally all statements would be saved like \e does. Sergey E. Koposov 2006-02-11 22:55:35 +01:00
New pgindent run with fixes suggested by Tom. Patch manually reviewed, initdb/regression tests pass. 2001-11-05 18:46:40 +01:00			`#endif /* INPUT_H */`