*
* Copyright (c) 2000-2003, PostgreSQL Global Development Group
*
- * $PostgreSQL: pgsql/src/bin/psql/common.c,v 1.82 2004/01/25 03:07:22 neilc Exp $
+ * $PostgreSQL: pgsql/src/bin/psql/common.c,v 1.83 2004/03/14 04:25:17 tgl Exp $
*/
#include "postgres_fe.h"
#include "common.h"
}
+/*
+ * on errors, print syntax error position if available.
+ *
+ * the query is expected to be in the client encoding.
+ */
+static void
+ReportSyntaxErrorPosition(const PGresult *result, const char *query)
+{
+#define DISPLAY_SIZE 60 /* screen width limit, in screen cols */
+#define MIN_RIGHT_CUT 10 /* try to keep this far away from EOL */
+
+ int loc = 0;
+ const char *sp;
+ int clen, slen, i, *qidx, *scridx, qoffset, scroffset, ibeg, iend,
+ loc_line;
+ char *wquery;
+ bool beg_trunc, end_trunc;
+ PQExpBufferData msg;
+
+ if (query == NULL)
+ return; /* nothing to do */
+ sp = PQresultErrorField(result, PG_DIAG_STATEMENT_POSITION);
+ if (sp == NULL)
+ return; /* no syntax error location */
+ /*
+ * We punt if the report contains any CONTEXT. This typically means that
+ * the syntax error is from inside a function, and the cursor position
+ * is not relevant to the original query string.
+ */
+ if (PQresultErrorField(result, PG_DIAG_CONTEXT) != NULL)
+ return;
+
+ if (sscanf(sp, "%d", &loc) != 1)
+ {
+ psql_error("INTERNAL ERROR: unexpected statement position \"%s\"\n",
+ sp);
+ return;
+ }
+
+ /* Make a writable copy of the query, and a buffer for messages. */
+ wquery = pg_strdup(query);
+
+ initPQExpBuffer(&msg);
+
+ /*
+ * The returned cursor position is measured in logical characters.
+ * Each character might occupy multiple physical bytes in the string,
+ * and in some Far Eastern character sets it might take more than one
+ * screen column as well. We compute the starting byte offset and
+ * starting screen column of each logical character, and store these
+ * in qidx[] and scridx[] respectively.
+ */
+
+ /* we need a safe allocation size... */
+ slen = strlen(query) + 1;
+
+ qidx = (int *) pg_malloc(slen * sizeof(int));
+ scridx = (int *) pg_malloc(slen * sizeof(int));
+
+ qoffset = 0;
+ scroffset = 0;
+ for (i = 0; query[qoffset] != '\0'; i++)
+ {
+ qidx[i] = qoffset;
+ scridx[i] = scroffset;
+ scroffset += 1; /* XXX fix me when we have screen width info */
+ qoffset += PQmblen(&query[qoffset], pset.encoding);
+ }
+ qidx[i] = qoffset;
+ scridx[i] = scroffset;
+ clen = i;
+ psql_assert(clen < slen);
+
+ /* convert loc to zero-based offset in qidx/scridx arrays */
+ loc--;
+
+ /* do we have something to show? */
+ if (loc >= 0 && loc <= clen)
+ {
+ /* input line number of our syntax error. */
+ loc_line = 1;
+ /* first included char of extract. */
+ ibeg = 0;
+ /* last-plus-1 included char of extract. */
+ iend = clen;
+
+ /*
+ * Replace tabs with spaces in the writable copy. (Later we might
+ * want to think about coping with their variable screen width,
+ * but not today.)
+ *
+ * Extract line number and begin and end indexes of line containing
+ * error location. There will not be any newlines or carriage
+ * returns in the selected extract.
+ */
+ for (i=0; i<clen; i++)
+ {
+ /* character length must be 1 or it's not ASCII */
+ if ((qidx[i+1]-qidx[i]) == 1)
+ {
+ if (wquery[qidx[i]] == '\t')
+ wquery[qidx[i]] = ' ';
+ else if (wquery[qidx[i]] == '\r' || wquery[qidx[i]] == '\n')
+ {
+ if (i < loc)
+ {
+ /*
+ * count lines before loc. Each \r or \n counts
+ * as a line except when \r \n appear together.
+ */
+ if (wquery[qidx[i]] == '\r' ||
+ i == 0 ||
+ (qidx[i]-qidx[i-1]) != 1 ||
+ wquery[qidx[i-1]] != '\r')
+ loc_line++;
+ /* extract beginning = last line start before loc. */
+ ibeg = i+1;
+ }
+ else
+ {
+ /* set extract end. */
+ iend = i;
+ /* done scanning. */
+ break;
+ }
+ }
+ }
+ }
+
+ /* If the line extracted is too long, we truncate it. */
+ beg_trunc = false;
+ end_trunc = false;
+ if (scridx[iend]-scridx[ibeg] > DISPLAY_SIZE)
+ {
+ /*
+ * We first truncate right if it is enough. This code might
+ * be off a space or so on enforcing MIN_RIGHT_CUT if there's
+ * a wide character right there, but that should be okay.
+ */
+ if (scridx[ibeg]+DISPLAY_SIZE >= scridx[loc]+MIN_RIGHT_CUT)
+ {
+ while (scridx[iend]-scridx[ibeg] > DISPLAY_SIZE)
+ iend--;
+ end_trunc = true;
+ }
+ else
+ {
+ /* Truncate right if not too close to loc. */
+ while (scridx[loc]+MIN_RIGHT_CUT < scridx[iend])
+ {
+ iend--;
+ end_trunc = true;
+ }
+
+ /* Truncate left if still too long. */
+ while (scridx[iend]-scridx[ibeg] > DISPLAY_SIZE)
+ {
+ ibeg++;
+ beg_trunc = true;
+ }
+ }
+ }
+
+ /* the extract MUST contain the target position! */
+ psql_assert(ibeg<=loc && loc<=iend);
+
+ /* truncate working copy at desired endpoint */
+ wquery[qidx[iend]] = '\0';
+
+ /* Begin building the finished message. */
+ printfPQExpBuffer(&msg, gettext("LINE %d: "), loc_line);
+ if (beg_trunc)
+ appendPQExpBufferStr(&msg, "...");
+
+ /*
+ * While we have the prefix in the msg buffer, compute its screen
+ * width.
+ */
+ scroffset = 0;
+ for (i = 0; i < msg.len; i += PQmblen(&msg.data[i], pset.encoding))
+ {
+ scroffset += 1; /* XXX fix me when we have screen width info */
+ }
+
+ /* Finish and emit the message. */
+ appendPQExpBufferStr(&msg, &wquery[qidx[ibeg]]);
+ if (end_trunc)
+ appendPQExpBufferStr(&msg, "...");
+
+ psql_error("%s\n", msg.data);
+
+ /* Now emit the cursor marker line. */
+ scroffset += scridx[loc] - scridx[ibeg];
+ resetPQExpBuffer(&msg);
+ for (i = 0; i < scroffset; i++)
+ appendPQExpBufferChar(&msg, ' ');
+ appendPQExpBufferChar(&msg, '^');
+
+ psql_error("%s\n", msg.data);
+ }
+
+ /* Clean up. */
+ termPQExpBuffer(&msg);
+
+ free(wquery);
+ free(qidx);
+ free(scridx);
+}
+
+
/*
* AcceptResult
*
* Returns true for valid result, false for error state.
*/
static bool
-AcceptResult(const PGresult *result)
+AcceptResult(const PGresult *result, const char *query)
{
bool OK = true;
if (!OK)
{
psql_error("%s", PQerrorMessage(pset.db));
+ ReportSyntaxErrorPosition(result, query);
CheckConnection();
}
res = PQexec(pset.db, query);
- if (!AcceptResult(res) && res)
+ if (!AcceptResult(res, query) && res)
{
PQclear(res);
res = NULL;
results = PQexec(pset.db, query);
/* these operations are included in the timing result: */
- OK = (AcceptResult(results) && ProcessCopyResult(results));
+ OK = (AcceptResult(results, query) && ProcessCopyResult(results));
if (pset.timing)
GETTIMEOFDAY(&after);
-- missing relation name
select;
ERROR: syntax error at or near ";" at character 7
+LINE 1: select;
+ ^
-- no such relation
select * from nonesuch;
ERROR: relation "nonesuch" does not exist
-- missing target list
select from pg_database;
ERROR: syntax error at or near "from" at character 8
+LINE 1: select from pg_database;
+ ^
-- bad name in target list
select nonesuch from pg_database;
ERROR: column "nonesuch" does not exist
-- bad select distinct on syntax, distinct attribute missing
select distinct on (foobar) from pg_database;
ERROR: syntax error at or near "from" at character 29
+LINE 1: select distinct on (foobar) from pg_database;
+ ^
-- bad select distinct on syntax, distinct attribute not in target list
select distinct on (foobar) * from pg_database;
ERROR: column "foobar" does not exist
-- missing relation name (this had better not wildcard!)
delete from;
ERROR: syntax error at or near ";" at character 12
+LINE 1: delete from;
+ ^
-- no such relation
delete from nonesuch;
ERROR: relation "nonesuch" does not exist
-- missing relation name (this had better not wildcard!)
drop table;
ERROR: syntax error at or near ";" at character 11
+LINE 1: drop table;
+ ^
-- no such relation
drop table nonesuch;
ERROR: table "nonesuch" does not exist
-- missing relation name
alter table rename;
ERROR: syntax error at or near ";" at character 19
+LINE 1: alter table rename;
+ ^
-- no such relation
alter table nonesuch rename to newnonesuch;
ERROR: relation "nonesuch" does not exist
-- missing index name
drop index;
ERROR: syntax error at or near ";" at character 11
+LINE 1: drop index;
+ ^
-- bad index name
drop index 314159;
ERROR: syntax error at or near "314159" at character 12
+LINE 1: drop index 314159;
+ ^
-- no such index
drop index nonesuch;
ERROR: index "nonesuch" does not exist
-- missing aggregate name
drop aggregate;
ERROR: syntax error at or near ";" at character 15
+LINE 1: drop aggregate;
+ ^
-- missing aggregate type
drop aggregate newcnt1;
ERROR: syntax error at or near ";" at character 23
+LINE 1: drop aggregate newcnt1;
+ ^
-- bad aggregate name
drop aggregate 314159 (int);
ERROR: syntax error at or near "314159" at character 16
+LINE 1: drop aggregate 314159 (int);
+ ^
-- bad aggregate type
drop aggregate newcnt (nonesuch);
ERROR: type "nonesuch" does not exist
-- missing function name
drop function ();
ERROR: syntax error at or near "(" at character 15
+LINE 1: drop function ();
+ ^
-- bad function name
drop function 314159();
ERROR: syntax error at or near "314159" at character 15
+LINE 1: drop function 314159();
+ ^
-- no such function
drop function nonesuch();
ERROR: function nonesuch() does not exist
-- missing type name
drop type;
ERROR: syntax error at or near ";" at character 10
+LINE 1: drop type;
+ ^
-- bad type name
drop type 314159;
ERROR: syntax error at or near "314159" at character 11
+LINE 1: drop type 314159;
+ ^
-- no such type
drop type nonesuch;
ERROR: type "nonesuch" does not exist
-- missing everything
drop operator;
ERROR: syntax error at or near ";" at character 14
+LINE 1: drop operator;
+ ^
-- bad operator name
drop operator equals;
ERROR: syntax error at or near ";" at character 21
+LINE 1: drop operator equals;
+ ^
-- missing type list
drop operator ===;
ERROR: syntax error at or near ";" at character 18
+LINE 1: drop operator ===;
+ ^
-- missing parentheses
drop operator int4, int4;
ERROR: syntax error at or near "," at character 19
+LINE 1: drop operator int4, int4;
+ ^
-- missing operator name
drop operator (int4, int4);
ERROR: syntax error at or near "(" at character 15
+LINE 1: drop operator (int4, int4);
+ ^
-- missing type list contents
drop operator === ();
ERROR: syntax error at or near ")" at character 20
+LINE 1: drop operator === ();
+ ^
-- no such operator
drop operator === (int4);
ERROR: missing argument
-- no such type1
drop operator = ( , int4);
ERROR: syntax error at or near "," at character 19
+LINE 1: drop operator = ( , int4);
+ ^
-- no such type1
drop operator = (nonesuch, int4);
ERROR: type nonesuch does not exist
-- no such type2
drop operator = (int4, );
ERROR: syntax error at or near ")" at character 24
+LINE 1: drop operator = (int4, );
+ ^
--
-- DROP RULE
-- missing rule name
drop rule;
ERROR: syntax error at or near ";" at character 10
+LINE 1: drop rule;
+ ^
-- bad rule name
drop rule 314159;
ERROR: syntax error at or near "314159" at character 11
+LINE 1: drop rule 314159;
+ ^
-- no such rule
drop rule nonesuch on noplace;
ERROR: relation "noplace" does not exist
--- bad keyword
+-- these postquel variants are no longer supported
drop tuple rule nonesuch;
ERROR: syntax error at or near "tuple" at character 6
--- no such rule
+LINE 1: drop tuple rule nonesuch;
+ ^
drop instance rule nonesuch on noplace;
ERROR: syntax error at or near "instance" at character 6
--- no such rule
+LINE 1: drop instance rule nonesuch on noplace;
+ ^
drop rewrite rule nonesuch;
ERROR: syntax error at or near "rewrite" at character 6
+LINE 1: drop rewrite rule nonesuch;
+ ^
--
-- Check that division-by-zero is properly caught.
--
ERROR: division by zero
select 1/0::float4;
ERROR: division by zero
+--
+-- Test psql's reporting of syntax error location
+--
+xxx;
+ERROR: syntax error at or near "xxx" at character 1
+LINE 1: xxx;
+ ^
+CREATE foo;
+ERROR: syntax error at or near "foo" at character 8
+LINE 1: CREATE foo;
+ ^
+CREATE TABLE ;
+ERROR: syntax error at or near ";" at character 14
+LINE 1: CREATE TABLE ;
+ ^
+CREATE TABLE
+\g
+ERROR: syntax error at end of input at character 13
+LINE 1: CREATE TABLE
+ ^
+INSERT INTO foo VALUES(123) foo;
+ERROR: syntax error at or near "foo" at character 29
+LINE 1: INSERT INTO foo VALUES(123) foo;
+ ^
+INSERT INTO 123
+VALUES(123);
+ERROR: syntax error at or near "123" at character 13
+LINE 1: INSERT INTO 123
+ ^
+INSERT INTO foo
+VALUES(123) 123
+;
+ERROR: syntax error at or near "123" at character 30
+LINE 2: VALUES(123) 123
+ ^
+-- with a tab
+CREATE TABLE foo
+ (id INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY,
+ id3 INTEGER NOT NUL,
+ id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL);
+ERROR: syntax error at or near "NUL" at character 94
+LINE 3: id3 INTEGER NOT NUL,
+ ^
+-- long line to be truncated on the left
+CREATE TABLE foo(id INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL,
+id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL);
+ERROR: syntax error at or near "NUL" at character 90
+LINE 1: ...T NULL, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL,
+ ^
+-- long line to be truncated on the right
+CREATE TABLE foo(
+id3 INTEGER NOT NUL, id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL, id INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY);
+ERROR: syntax error at or near "NUL" at character 35
+LINE 2: id3 INTEGER NOT NUL, id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQ...
+ ^
+-- long line to be truncated both ways
+CREATE TABLE foo(id INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL, id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL);
+ERROR: syntax error at or near "NUL" at character 90
+LINE 1: ...L, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL, id4 I...
+ ^
+-- long line to be truncated on the left, many lines
+CREATE
+TEMPORARY
+TABLE
+foo(id INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL,
+id4 INT4
+UNIQUE
+NOT
+NULL,
+id5 TEXT
+UNIQUE
+NOT
+NULL)
+;
+ERROR: syntax error at or near "NUL" at character 101
+LINE 4: ...T NULL, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL,
+ ^
+-- long line to be truncated on the right, many lines
+CREATE
+TEMPORARY
+TABLE
+foo(
+id3 INTEGER NOT NUL, id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL, id INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY)
+;
+ERROR: syntax error at or near "NUL" at character 47
+LINE 5: id3 INTEGER NOT NUL, id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQ...
+ ^
+-- long line to be truncated both ways, many lines
+CREATE
+TEMPORARY
+TABLE
+foo
+(id
+INT4
+UNIQUE NOT NULL, idx INT4 UNIQUE NOT NULL, idy INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL, id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL,
+idz INT4 UNIQUE NOT NULL,
+idv INT4 UNIQUE NOT NULL);
+ERROR: syntax error at or near "NUL" at character 157
+LINE 7: ...L, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL, id4 I...
+ ^
+-- more than 10 lines...
+CREATE
+TEMPORARY
+TABLE
+foo
+(id
+INT4
+UNIQUE
+NOT
+NULL
+,
+idm
+INT4
+UNIQUE
+NOT
+NULL,
+idx INT4 UNIQUE NOT NULL, idy INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL, id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL,
+idz INT4 UNIQUE NOT NULL,
+idv
+INT4
+UNIQUE
+NOT
+NULL);
+ERROR: syntax error at or near "NUL" at character 190
+LINE 16: ...L, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL, id4 I...
+ ^
' - third line'
AS "Illegal comment within continuation";
ERROR: syntax error at or near "' - third line'" at character 75
+LINE 3: ' - third line'
+ ^
--
-- test conversions between various string types
-- E021-10 implicit casting among the character data types
-- test for extraneous comma
CREATE TABLE error_tbl (i int DEFAULT (100, ));
ERROR: syntax error at or near "," at character 43
+LINE 1: CREATE TABLE error_tbl (i int DEFAULT (100, ));
+ ^
-- this will fail because gram.y uses b_expr not a_expr for defaults,
-- to avoid a shift/reduce conflict that arises from NOT NULL being
-- part of the column definition syntax:
CREATE TABLE error_tbl (b1 bool DEFAULT 1 IN (1, 2));
ERROR: syntax error at or near "IN" at character 43
+LINE 1: CREATE TABLE error_tbl (b1 bool DEFAULT 1 IN (1, 2));
+ ^
-- this should work, however:
CREATE TABLE error_tbl (b1 bool DEFAULT (1 IN (1, 2)));
DROP TABLE error_tbl;
-- no such rule
drop rule nonesuch on noplace;
--- bad keyword
+-- these postquel variants are no longer supported
drop tuple rule nonesuch;
-
--- no such rule
drop instance rule nonesuch on noplace;
-
--- no such rule
drop rewrite rule nonesuch;
--
select 1::float4/0;
select 1/0::float4;
+
+
+--
+-- Test psql's reporting of syntax error location
+--
+
+xxx;
+
+CREATE foo;
+
+CREATE TABLE ;
+
+CREATE TABLE
+\g
+
+INSERT INTO foo VALUES(123) foo;
+
+INSERT INTO 123
+VALUES(123);
+
+INSERT INTO foo
+VALUES(123) 123
+;
+
+-- with a tab
+CREATE TABLE foo
+ (id INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY,
+ id3 INTEGER NOT NUL,
+ id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL);
+
+-- long line to be truncated on the left
+CREATE TABLE foo(id INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL,
+id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL);
+
+-- long line to be truncated on the right
+CREATE TABLE foo(
+id3 INTEGER NOT NUL, id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL, id INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY);
+
+-- long line to be truncated both ways
+CREATE TABLE foo(id INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL, id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL);
+
+-- long line to be truncated on the left, many lines
+CREATE
+TEMPORARY
+TABLE
+foo(id INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL,
+id4 INT4
+UNIQUE
+NOT
+NULL,
+id5 TEXT
+UNIQUE
+NOT
+NULL)
+;
+
+-- long line to be truncated on the right, many lines
+CREATE
+TEMPORARY
+TABLE
+foo(
+id3 INTEGER NOT NUL, id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL, id INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY)
+;
+
+-- long line to be truncated both ways, many lines
+CREATE
+TEMPORARY
+TABLE
+foo
+(id
+INT4
+UNIQUE NOT NULL, idx INT4 UNIQUE NOT NULL, idy INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL, id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL,
+idz INT4 UNIQUE NOT NULL,
+idv INT4 UNIQUE NOT NULL);
+
+-- more than 10 lines...
+CREATE
+TEMPORARY
+TABLE
+foo
+(id
+INT4
+UNIQUE
+NOT
+NULL
+,
+idm
+INT4
+UNIQUE
+NOT
+NULL,
+idx INT4 UNIQUE NOT NULL, idy INT4 UNIQUE NOT NULL, id2 TEXT NOT NULL PRIMARY KEY, id3 INTEGER NOT NUL, id4 INT4 UNIQUE NOT NULL, id5 TEXT UNIQUE NOT NULL,
+idz INT4 UNIQUE NOT NULL,
+idv
+INT4
+UNIQUE
+NOT
+NULL);
projects / postgresql / commitdiff