pg_query 1.3.0 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +86 -52
- data/README.md +72 -65
- data/Rakefile +82 -1
- data/ext/pg_query/extconf.rb +2 -39
- data/ext/pg_query/guc-file.c +0 -0
- data/ext/pg_query/pg_query.c +104 -0
- data/ext/pg_query/pg_query.pb-c.c +37628 -0
- data/ext/pg_query/pg_query_deparse.c +9953 -0
- data/ext/pg_query/pg_query_fingerprint.c +292 -0
- data/ext/pg_query/pg_query_fingerprint.h +8 -0
- data/ext/pg_query/pg_query_internal.h +24 -0
- data/ext/pg_query/pg_query_json_plpgsql.c +738 -0
- data/ext/pg_query/pg_query_json_plpgsql.h +9 -0
- data/ext/pg_query/pg_query_normalize.c +437 -0
- data/ext/pg_query/pg_query_outfuncs.h +10 -0
- data/ext/pg_query/pg_query_outfuncs_json.c +297 -0
- data/ext/pg_query/pg_query_outfuncs_protobuf.c +237 -0
- data/ext/pg_query/pg_query_parse.c +148 -0
- data/ext/pg_query/pg_query_parse_plpgsql.c +460 -0
- data/ext/pg_query/pg_query_readfuncs.h +11 -0
- data/ext/pg_query/pg_query_readfuncs_protobuf.c +142 -0
- data/ext/pg_query/pg_query_ruby.c +108 -12
- data/ext/pg_query/pg_query_scan.c +173 -0
- data/ext/pg_query/pg_query_split.c +221 -0
- data/ext/pg_query/protobuf-c.c +3660 -0
- data/ext/pg_query/src_backend_catalog_namespace.c +1051 -0
- data/ext/pg_query/src_backend_catalog_pg_proc.c +142 -0
- data/ext/pg_query/src_backend_commands_define.c +117 -0
- data/ext/pg_query/src_backend_libpq_pqcomm.c +651 -0
- data/ext/pg_query/src_backend_nodes_bitmapset.c +513 -0
- data/ext/pg_query/src_backend_nodes_copyfuncs.c +6013 -0
- data/ext/pg_query/src_backend_nodes_equalfuncs.c +4003 -0
- data/ext/pg_query/src_backend_nodes_extensible.c +99 -0
- data/ext/pg_query/src_backend_nodes_list.c +922 -0
- data/ext/pg_query/src_backend_nodes_makefuncs.c +417 -0
- data/ext/pg_query/src_backend_nodes_nodeFuncs.c +1363 -0
- data/ext/pg_query/src_backend_nodes_value.c +84 -0
- data/ext/pg_query/src_backend_parser_gram.c +47456 -0
- data/ext/pg_query/src_backend_parser_parse_expr.c +313 -0
- data/ext/pg_query/src_backend_parser_parser.c +497 -0
- data/ext/pg_query/src_backend_parser_scan.c +7091 -0
- data/ext/pg_query/src_backend_parser_scansup.c +160 -0
- data/ext/pg_query/src_backend_postmaster_postmaster.c +2230 -0
- data/ext/pg_query/src_backend_storage_ipc_ipc.c +192 -0
- data/ext/pg_query/src_backend_storage_lmgr_s_lock.c +370 -0
- data/ext/pg_query/src_backend_tcop_postgres.c +776 -0
- data/ext/pg_query/src_backend_utils_adt_datum.c +326 -0
- data/ext/pg_query/src_backend_utils_adt_expandeddatum.c +98 -0
- data/ext/pg_query/src_backend_utils_adt_format_type.c +136 -0
- data/ext/pg_query/src_backend_utils_adt_ruleutils.c +1683 -0
- data/ext/pg_query/src_backend_utils_error_assert.c +74 -0
- data/ext/pg_query/src_backend_utils_error_elog.c +1748 -0
- data/ext/pg_query/src_backend_utils_fmgr_fmgr.c +570 -0
- data/ext/pg_query/src_backend_utils_hash_dynahash.c +1086 -0
- data/ext/pg_query/src_backend_utils_init_globals.c +168 -0
- data/ext/pg_query/src_backend_utils_mb_mbutils.c +839 -0
- data/ext/pg_query/src_backend_utils_misc_guc.c +1831 -0
- data/ext/pg_query/src_backend_utils_mmgr_aset.c +1560 -0
- data/ext/pg_query/src_backend_utils_mmgr_mcxt.c +1006 -0
- data/ext/pg_query/src_common_encnames.c +158 -0
- data/ext/pg_query/src_common_keywords.c +39 -0
- data/ext/pg_query/src_common_kwlist_d.h +1081 -0
- data/ext/pg_query/src_common_kwlookup.c +91 -0
- data/ext/pg_query/src_common_psprintf.c +158 -0
- data/ext/pg_query/src_common_string.c +86 -0
- data/ext/pg_query/src_common_stringinfo.c +336 -0
- data/ext/pg_query/src_common_wchar.c +1651 -0
- data/ext/pg_query/src_pl_plpgsql_src_pl_comp.c +1133 -0
- data/ext/pg_query/src_pl_plpgsql_src_pl_funcs.c +877 -0
- data/ext/pg_query/src_pl_plpgsql_src_pl_gram.c +6533 -0
- data/ext/pg_query/src_pl_plpgsql_src_pl_handler.c +107 -0
- data/ext/pg_query/src_pl_plpgsql_src_pl_reserved_kwlist_d.h +123 -0
- data/ext/pg_query/src_pl_plpgsql_src_pl_scanner.c +671 -0
- data/ext/pg_query/src_pl_plpgsql_src_pl_unreserved_kwlist_d.h +255 -0
- data/ext/pg_query/src_port_erand48.c +127 -0
- data/ext/pg_query/src_port_pg_bitutils.c +246 -0
- data/ext/pg_query/src_port_pgsleep.c +69 -0
- data/ext/pg_query/src_port_pgstrcasecmp.c +83 -0
- data/ext/pg_query/src_port_qsort.c +240 -0
- data/ext/pg_query/src_port_random.c +31 -0
- data/ext/pg_query/src_port_snprintf.c +1449 -0
- data/ext/pg_query/src_port_strerror.c +324 -0
- data/ext/pg_query/src_port_strnlen.c +39 -0
- data/ext/pg_query/xxhash.c +43 -0
- data/lib/pg_query.rb +7 -4
- data/lib/pg_query/constants.rb +21 -0
- data/lib/pg_query/deparse.rb +15 -1673
- data/lib/pg_query/filter_columns.rb +86 -85
- data/lib/pg_query/fingerprint.rb +122 -87
- data/lib/pg_query/json_field_names.rb +1402 -0
- data/lib/pg_query/node.rb +31 -0
- data/lib/pg_query/param_refs.rb +42 -37
- data/lib/pg_query/parse.rb +220 -203
- data/lib/pg_query/parse_error.rb +1 -1
- data/lib/pg_query/pg_query_pb.rb +3211 -0
- data/lib/pg_query/scan.rb +23 -0
- data/lib/pg_query/treewalker.rb +24 -40
- data/lib/pg_query/truncate.rb +64 -43
- data/lib/pg_query/version.rb +2 -2
- metadata +101 -11
- data/ext/pg_query/pg_query_ruby.h +0 -10
- data/lib/pg_query/deep_dup.rb +0 -16
- data/lib/pg_query/deparse/alter_table.rb +0 -42
- data/lib/pg_query/deparse/interval.rb +0 -105
- data/lib/pg_query/deparse/keywords.rb +0 -159
- data/lib/pg_query/deparse/rename.rb +0 -41
- data/lib/pg_query/legacy_parsetree.rb +0 -109
- data/lib/pg_query/node_types.rb +0 -297
@@ -0,0 +1,91 @@
|
|
1
|
+
/*--------------------------------------------------------------------
|
2
|
+
* Symbols referenced in this file:
|
3
|
+
* - ScanKeywordLookup
|
4
|
+
*--------------------------------------------------------------------
|
5
|
+
*/
|
6
|
+
|
7
|
+
/*-------------------------------------------------------------------------
|
8
|
+
*
|
9
|
+
* kwlookup.c
|
10
|
+
* Key word lookup for PostgreSQL
|
11
|
+
*
|
12
|
+
*
|
13
|
+
* Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
|
14
|
+
* Portions Copyright (c) 1994, Regents of the University of California
|
15
|
+
*
|
16
|
+
*
|
17
|
+
* IDENTIFICATION
|
18
|
+
* src/common/kwlookup.c
|
19
|
+
*
|
20
|
+
*-------------------------------------------------------------------------
|
21
|
+
*/
|
22
|
+
#include "c.h"
|
23
|
+
|
24
|
+
#include "common/kwlookup.h"
|
25
|
+
|
26
|
+
|
27
|
+
/*
|
28
|
+
* ScanKeywordLookup - see if a given word is a keyword
|
29
|
+
*
|
30
|
+
* The list of keywords to be matched against is passed as a ScanKeywordList.
|
31
|
+
*
|
32
|
+
* Returns the keyword number (0..N-1) of the keyword, or -1 if no match.
|
33
|
+
* Callers typically use the keyword number to index into information
|
34
|
+
* arrays, but that is no concern of this code.
|
35
|
+
*
|
36
|
+
* The match is done case-insensitively. Note that we deliberately use a
|
37
|
+
* dumbed-down case conversion that will only translate 'A'-'Z' into 'a'-'z',
|
38
|
+
* even if we are in a locale where tolower() would produce more or different
|
39
|
+
* translations. This is to conform to the SQL99 spec, which says that
|
40
|
+
* keywords are to be matched in this way even though non-keyword identifiers
|
41
|
+
* receive a different case-normalization mapping.
|
42
|
+
*/
|
43
|
+
int
|
44
|
+
ScanKeywordLookup(const char *str,
|
45
|
+
const ScanKeywordList *keywords)
|
46
|
+
{
|
47
|
+
size_t len;
|
48
|
+
int h;
|
49
|
+
const char *kw;
|
50
|
+
|
51
|
+
/*
|
52
|
+
* Reject immediately if too long to be any keyword. This saves useless
|
53
|
+
* hashing and downcasing work on long strings.
|
54
|
+
*/
|
55
|
+
len = strlen(str);
|
56
|
+
if (len > keywords->max_kw_len)
|
57
|
+
return -1;
|
58
|
+
|
59
|
+
/*
|
60
|
+
* Compute the hash function. We assume it was generated to produce
|
61
|
+
* case-insensitive results. Since it's a perfect hash, we need only
|
62
|
+
* match to the specific keyword it identifies.
|
63
|
+
*/
|
64
|
+
h = keywords->hash(str, len);
|
65
|
+
|
66
|
+
/* An out-of-range result implies no match */
|
67
|
+
if (h < 0 || h >= keywords->num_keywords)
|
68
|
+
return -1;
|
69
|
+
|
70
|
+
/*
|
71
|
+
* Compare character-by-character to see if we have a match, applying an
|
72
|
+
* ASCII-only downcasing to the input characters. We must not use
|
73
|
+
* tolower() since it may produce the wrong translation in some locales
|
74
|
+
* (eg, Turkish).
|
75
|
+
*/
|
76
|
+
kw = GetScanKeyword(h, keywords);
|
77
|
+
while (*str != '\0')
|
78
|
+
{
|
79
|
+
char ch = *str++;
|
80
|
+
|
81
|
+
if (ch >= 'A' && ch <= 'Z')
|
82
|
+
ch += 'a' - 'A';
|
83
|
+
if (ch != *kw++)
|
84
|
+
return -1;
|
85
|
+
}
|
86
|
+
if (*kw != '\0')
|
87
|
+
return -1;
|
88
|
+
|
89
|
+
/* Success! */
|
90
|
+
return h;
|
91
|
+
}
|
@@ -0,0 +1,158 @@
|
|
1
|
+
/*--------------------------------------------------------------------
|
2
|
+
* Symbols referenced in this file:
|
3
|
+
* - pvsnprintf
|
4
|
+
* - psprintf
|
5
|
+
*--------------------------------------------------------------------
|
6
|
+
*/
|
7
|
+
|
8
|
+
/*-------------------------------------------------------------------------
|
9
|
+
*
|
10
|
+
* psprintf.c
|
11
|
+
* sprintf into an allocated-on-demand buffer
|
12
|
+
*
|
13
|
+
*
|
14
|
+
* Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
|
15
|
+
* Portions Copyright (c) 1994, Regents of the University of California
|
16
|
+
*
|
17
|
+
*
|
18
|
+
* IDENTIFICATION
|
19
|
+
* src/common/psprintf.c
|
20
|
+
*
|
21
|
+
*-------------------------------------------------------------------------
|
22
|
+
*/
|
23
|
+
|
24
|
+
#ifndef FRONTEND
|
25
|
+
|
26
|
+
#include "postgres.h"
|
27
|
+
|
28
|
+
#include "utils/memutils.h"
|
29
|
+
|
30
|
+
#else
|
31
|
+
|
32
|
+
#include "postgres_fe.h"
|
33
|
+
|
34
|
+
/* It's possible we could use a different value for this in frontend code */
|
35
|
+
#define MaxAllocSize ((Size) 0x3fffffff) /* 1 gigabyte - 1 */
|
36
|
+
|
37
|
+
#endif
|
38
|
+
|
39
|
+
|
40
|
+
/*
|
41
|
+
* psprintf
|
42
|
+
*
|
43
|
+
* Format text data under the control of fmt (an sprintf-style format string)
|
44
|
+
* and return it in an allocated-on-demand buffer. The buffer is allocated
|
45
|
+
* with palloc in the backend, or malloc in frontend builds. Caller is
|
46
|
+
* responsible to free the buffer when no longer needed, if appropriate.
|
47
|
+
*
|
48
|
+
* Errors are not returned to the caller, but are reported via elog(ERROR)
|
49
|
+
* in the backend, or printf-to-stderr-and-exit() in frontend builds.
|
50
|
+
* One should therefore think twice about using this in libpq.
|
51
|
+
*/
|
52
|
+
char *
|
53
|
+
psprintf(const char *fmt,...)
|
54
|
+
{
|
55
|
+
int save_errno = errno;
|
56
|
+
size_t len = 128; /* initial assumption about buffer size */
|
57
|
+
|
58
|
+
for (;;)
|
59
|
+
{
|
60
|
+
char *result;
|
61
|
+
va_list args;
|
62
|
+
size_t newlen;
|
63
|
+
|
64
|
+
/*
|
65
|
+
* Allocate result buffer. Note that in frontend this maps to malloc
|
66
|
+
* with exit-on-error.
|
67
|
+
*/
|
68
|
+
result = (char *) palloc(len);
|
69
|
+
|
70
|
+
/* Try to format the data. */
|
71
|
+
errno = save_errno;
|
72
|
+
va_start(args, fmt);
|
73
|
+
newlen = pvsnprintf(result, len, fmt, args);
|
74
|
+
va_end(args);
|
75
|
+
|
76
|
+
if (newlen < len)
|
77
|
+
return result; /* success */
|
78
|
+
|
79
|
+
/* Release buffer and loop around to try again with larger len. */
|
80
|
+
pfree(result);
|
81
|
+
len = newlen;
|
82
|
+
}
|
83
|
+
}
|
84
|
+
|
85
|
+
/*
|
86
|
+
* pvsnprintf
|
87
|
+
*
|
88
|
+
* Attempt to format text data under the control of fmt (an sprintf-style
|
89
|
+
* format string) and insert it into buf (which has length len).
|
90
|
+
*
|
91
|
+
* If successful, return the number of bytes emitted, not counting the
|
92
|
+
* trailing zero byte. This will always be strictly less than len.
|
93
|
+
*
|
94
|
+
* If there's not enough space in buf, return an estimate of the buffer size
|
95
|
+
* needed to succeed (this *must* be more than the given len, else callers
|
96
|
+
* might loop infinitely).
|
97
|
+
*
|
98
|
+
* Other error cases do not return, but exit via elog(ERROR) or exit().
|
99
|
+
* Hence, this shouldn't be used inside libpq.
|
100
|
+
*
|
101
|
+
* Caution: callers must be sure to preserve their entry-time errno
|
102
|
+
* when looping, in case the fmt contains "%m".
|
103
|
+
*
|
104
|
+
* Note that the semantics of the return value are not exactly C99's.
|
105
|
+
* First, we don't promise that the estimated buffer size is exactly right;
|
106
|
+
* callers must be prepared to loop multiple times to get the right size.
|
107
|
+
* (Given a C99-compliant vsnprintf, that won't happen, but it is rumored
|
108
|
+
* that some implementations don't always return the same value ...)
|
109
|
+
* Second, we return the recommended buffer size, not one less than that;
|
110
|
+
* this lets overflow concerns be handled here rather than in the callers.
|
111
|
+
*/
|
112
|
+
size_t
|
113
|
+
pvsnprintf(char *buf, size_t len, const char *fmt, va_list args)
|
114
|
+
{
|
115
|
+
int nprinted;
|
116
|
+
|
117
|
+
nprinted = vsnprintf(buf, len, fmt, args);
|
118
|
+
|
119
|
+
/* We assume failure means the fmt is bogus, hence hard failure is OK */
|
120
|
+
if (unlikely(nprinted < 0))
|
121
|
+
{
|
122
|
+
#ifndef FRONTEND
|
123
|
+
elog(ERROR, "vsnprintf failed: %m with format string \"%s\"", fmt);
|
124
|
+
#else
|
125
|
+
fprintf(stderr, "vsnprintf failed: %s with format string \"%s\"\n",
|
126
|
+
strerror(errno), fmt);
|
127
|
+
exit(EXIT_FAILURE);
|
128
|
+
#endif
|
129
|
+
}
|
130
|
+
|
131
|
+
if ((size_t) nprinted < len)
|
132
|
+
{
|
133
|
+
/* Success. Note nprinted does not include trailing null. */
|
134
|
+
return (size_t) nprinted;
|
135
|
+
}
|
136
|
+
|
137
|
+
/*
|
138
|
+
* We assume a C99-compliant vsnprintf, so believe its estimate of the
|
139
|
+
* required space, and add one for the trailing null. (If it's wrong, the
|
140
|
+
* logic will still work, but we may loop multiple times.)
|
141
|
+
*
|
142
|
+
* Choke if the required space would exceed MaxAllocSize. Note we use
|
143
|
+
* this palloc-oriented overflow limit even when in frontend.
|
144
|
+
*/
|
145
|
+
if (unlikely((size_t) nprinted > MaxAllocSize - 1))
|
146
|
+
{
|
147
|
+
#ifndef FRONTEND
|
148
|
+
ereport(ERROR,
|
149
|
+
(errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
|
150
|
+
errmsg("out of memory")));
|
151
|
+
#else
|
152
|
+
fprintf(stderr, _("out of memory\n"));
|
153
|
+
exit(EXIT_FAILURE);
|
154
|
+
#endif
|
155
|
+
}
|
156
|
+
|
157
|
+
return nprinted + 1;
|
158
|
+
}
|
@@ -0,0 +1,86 @@
|
|
1
|
+
/*--------------------------------------------------------------------
|
2
|
+
* Symbols referenced in this file:
|
3
|
+
* - strtoint
|
4
|
+
*--------------------------------------------------------------------
|
5
|
+
*/
|
6
|
+
|
7
|
+
/*-------------------------------------------------------------------------
|
8
|
+
*
|
9
|
+
* string.c
|
10
|
+
* string handling helpers
|
11
|
+
*
|
12
|
+
*
|
13
|
+
* Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
|
14
|
+
* Portions Copyright (c) 1994, Regents of the University of California
|
15
|
+
*
|
16
|
+
*
|
17
|
+
* IDENTIFICATION
|
18
|
+
* src/common/string.c
|
19
|
+
*
|
20
|
+
*-------------------------------------------------------------------------
|
21
|
+
*/
|
22
|
+
|
23
|
+
|
24
|
+
#ifndef FRONTEND
|
25
|
+
#include "postgres.h"
|
26
|
+
#else
|
27
|
+
#include "postgres_fe.h"
|
28
|
+
#endif
|
29
|
+
|
30
|
+
#include "common/string.h"
|
31
|
+
|
32
|
+
|
33
|
+
/*
|
34
|
+
* Returns whether the string `str' has the postfix `end'.
|
35
|
+
*/
|
36
|
+
|
37
|
+
|
38
|
+
|
39
|
+
/*
|
40
|
+
* strtoint --- just like strtol, but returns int not long
|
41
|
+
*/
|
42
|
+
int
|
43
|
+
strtoint(const char *pg_restrict str, char **pg_restrict endptr, int base)
|
44
|
+
{
|
45
|
+
long val;
|
46
|
+
|
47
|
+
val = strtol(str, endptr, base);
|
48
|
+
if (val != (int) val)
|
49
|
+
errno = ERANGE;
|
50
|
+
return (int) val;
|
51
|
+
}
|
52
|
+
|
53
|
+
|
54
|
+
/*
|
55
|
+
* pg_clean_ascii -- Replace any non-ASCII chars with a '?' char
|
56
|
+
*
|
57
|
+
* Modifies the string passed in which must be '\0'-terminated.
|
58
|
+
*
|
59
|
+
* This function exists specifically to deal with filtering out
|
60
|
+
* non-ASCII characters in a few places where the client can provide an almost
|
61
|
+
* arbitrary string (and it isn't checked to ensure it's a valid username or
|
62
|
+
* database name or similar) and we don't want to have control characters or other
|
63
|
+
* things ending up in the log file where server admins might end up with a
|
64
|
+
* messed up terminal when looking at them.
|
65
|
+
*
|
66
|
+
* In general, this function should NOT be used- instead, consider how to handle
|
67
|
+
* the string without needing to filter out the non-ASCII characters.
|
68
|
+
*
|
69
|
+
* Ultimately, we'd like to improve the situation to not require stripping out
|
70
|
+
* all non-ASCII but perform more intelligent filtering which would allow UTF or
|
71
|
+
* similar, but it's unclear exactly what we should allow, so stick to ASCII only
|
72
|
+
* for now.
|
73
|
+
*/
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
/*
|
78
|
+
* pg_strip_crlf -- Remove any trailing newline and carriage return
|
79
|
+
*
|
80
|
+
* Removes any trailing newline and carriage return characters (\r on
|
81
|
+
* Windows) in the input string, zero-terminating it.
|
82
|
+
*
|
83
|
+
* The passed in string must be zero-terminated. This function returns
|
84
|
+
* the new length of the string.
|
85
|
+
*/
|
86
|
+
|
@@ -0,0 +1,336 @@
|
|
1
|
+
/*--------------------------------------------------------------------
|
2
|
+
* Symbols referenced in this file:
|
3
|
+
* - initStringInfo
|
4
|
+
* - resetStringInfo
|
5
|
+
* - appendStringInfoString
|
6
|
+
* - appendBinaryStringInfo
|
7
|
+
* - appendStringInfoChar
|
8
|
+
* - appendStringInfoVA
|
9
|
+
* - enlargeStringInfo
|
10
|
+
* - appendStringInfo
|
11
|
+
* - appendStringInfoSpaces
|
12
|
+
*--------------------------------------------------------------------
|
13
|
+
*/
|
14
|
+
|
15
|
+
/*-------------------------------------------------------------------------
|
16
|
+
*
|
17
|
+
* stringinfo.c
|
18
|
+
*
|
19
|
+
* StringInfo provides an extensible string data type (currently limited to a
|
20
|
+
* length of 1GB). It can be used to buffer either ordinary C strings
|
21
|
+
* (null-terminated text) or arbitrary binary data. All storage is allocated
|
22
|
+
* with palloc() (falling back to malloc in frontend code).
|
23
|
+
*
|
24
|
+
* Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
|
25
|
+
* Portions Copyright (c) 1994, Regents of the University of California
|
26
|
+
*
|
27
|
+
* src/common/stringinfo.c
|
28
|
+
*
|
29
|
+
*-------------------------------------------------------------------------
|
30
|
+
*/
|
31
|
+
|
32
|
+
#ifndef FRONTEND
|
33
|
+
|
34
|
+
#include "postgres.h"
|
35
|
+
#include "utils/memutils.h"
|
36
|
+
|
37
|
+
#else
|
38
|
+
|
39
|
+
#include "postgres_fe.h"
|
40
|
+
|
41
|
+
/* It's possible we could use a different value for this in frontend code */
|
42
|
+
#define MaxAllocSize ((Size) 0x3fffffff) /* 1 gigabyte - 1 */
|
43
|
+
|
44
|
+
#endif
|
45
|
+
|
46
|
+
#include "lib/stringinfo.h"
|
47
|
+
|
48
|
+
|
49
|
+
/*
|
50
|
+
* makeStringInfo
|
51
|
+
*
|
52
|
+
* Create an empty 'StringInfoData' & return a pointer to it.
|
53
|
+
*/
|
54
|
+
|
55
|
+
|
56
|
+
/*
|
57
|
+
* initStringInfo
|
58
|
+
*
|
59
|
+
* Initialize a StringInfoData struct (with previously undefined contents)
|
60
|
+
* to describe an empty string.
|
61
|
+
*/
|
62
|
+
void
|
63
|
+
initStringInfo(StringInfo str)
|
64
|
+
{
|
65
|
+
int size = 1024; /* initial default buffer size */
|
66
|
+
|
67
|
+
str->data = (char *) palloc(size);
|
68
|
+
str->maxlen = size;
|
69
|
+
resetStringInfo(str);
|
70
|
+
}
|
71
|
+
|
72
|
+
/*
|
73
|
+
* resetStringInfo
|
74
|
+
*
|
75
|
+
* Reset the StringInfo: the data buffer remains valid, but its
|
76
|
+
* previous content, if any, is cleared.
|
77
|
+
*/
|
78
|
+
void
|
79
|
+
resetStringInfo(StringInfo str)
|
80
|
+
{
|
81
|
+
str->data[0] = '\0';
|
82
|
+
str->len = 0;
|
83
|
+
str->cursor = 0;
|
84
|
+
}
|
85
|
+
|
86
|
+
/*
|
87
|
+
* appendStringInfo
|
88
|
+
*
|
89
|
+
* Format text data under the control of fmt (an sprintf-style format string)
|
90
|
+
* and append it to whatever is already in str. More space is allocated
|
91
|
+
* to str if necessary. This is sort of like a combination of sprintf and
|
92
|
+
* strcat.
|
93
|
+
*/
|
94
|
+
void
|
95
|
+
appendStringInfo(StringInfo str, const char *fmt,...)
|
96
|
+
{
|
97
|
+
int save_errno = errno;
|
98
|
+
|
99
|
+
for (;;)
|
100
|
+
{
|
101
|
+
va_list args;
|
102
|
+
int needed;
|
103
|
+
|
104
|
+
/* Try to format the data. */
|
105
|
+
errno = save_errno;
|
106
|
+
va_start(args, fmt);
|
107
|
+
needed = appendStringInfoVA(str, fmt, args);
|
108
|
+
va_end(args);
|
109
|
+
|
110
|
+
if (needed == 0)
|
111
|
+
break; /* success */
|
112
|
+
|
113
|
+
/* Increase the buffer size and try again. */
|
114
|
+
enlargeStringInfo(str, needed);
|
115
|
+
}
|
116
|
+
}
|
117
|
+
|
118
|
+
/*
|
119
|
+
* appendStringInfoVA
|
120
|
+
*
|
121
|
+
* Attempt to format text data under the control of fmt (an sprintf-style
|
122
|
+
* format string) and append it to whatever is already in str. If successful
|
123
|
+
* return zero; if not (because there's not enough space), return an estimate
|
124
|
+
* of the space needed, without modifying str. Typically the caller should
|
125
|
+
* pass the return value to enlargeStringInfo() before trying again; see
|
126
|
+
* appendStringInfo for standard usage pattern.
|
127
|
+
*
|
128
|
+
* Caution: callers must be sure to preserve their entry-time errno
|
129
|
+
* when looping, in case the fmt contains "%m".
|
130
|
+
*
|
131
|
+
* XXX This API is ugly, but there seems no alternative given the C spec's
|
132
|
+
* restrictions on what can portably be done with va_list arguments: you have
|
133
|
+
* to redo va_start before you can rescan the argument list, and we can't do
|
134
|
+
* that from here.
|
135
|
+
*/
|
136
|
+
int
|
137
|
+
appendStringInfoVA(StringInfo str, const char *fmt, va_list args)
|
138
|
+
{
|
139
|
+
int avail;
|
140
|
+
size_t nprinted;
|
141
|
+
|
142
|
+
Assert(str != NULL);
|
143
|
+
|
144
|
+
/*
|
145
|
+
* If there's hardly any space, don't bother trying, just fail to make the
|
146
|
+
* caller enlarge the buffer first. We have to guess at how much to
|
147
|
+
* enlarge, since we're skipping the formatting work.
|
148
|
+
*/
|
149
|
+
avail = str->maxlen - str->len;
|
150
|
+
if (avail < 16)
|
151
|
+
return 32;
|
152
|
+
|
153
|
+
nprinted = pvsnprintf(str->data + str->len, (size_t) avail, fmt, args);
|
154
|
+
|
155
|
+
if (nprinted < (size_t) avail)
|
156
|
+
{
|
157
|
+
/* Success. Note nprinted does not include trailing null. */
|
158
|
+
str->len += (int) nprinted;
|
159
|
+
return 0;
|
160
|
+
}
|
161
|
+
|
162
|
+
/* Restore the trailing null so that str is unmodified. */
|
163
|
+
str->data[str->len] = '\0';
|
164
|
+
|
165
|
+
/*
|
166
|
+
* Return pvsnprintf's estimate of the space needed. (Although this is
|
167
|
+
* given as a size_t, we know it will fit in int because it's not more
|
168
|
+
* than MaxAllocSize.)
|
169
|
+
*/
|
170
|
+
return (int) nprinted;
|
171
|
+
}
|
172
|
+
|
173
|
+
/*
|
174
|
+
* appendStringInfoString
|
175
|
+
*
|
176
|
+
* Append a null-terminated string to str.
|
177
|
+
* Like appendStringInfo(str, "%s", s) but faster.
|
178
|
+
*/
|
179
|
+
void
|
180
|
+
appendStringInfoString(StringInfo str, const char *s)
|
181
|
+
{
|
182
|
+
appendBinaryStringInfo(str, s, strlen(s));
|
183
|
+
}
|
184
|
+
|
185
|
+
/*
|
186
|
+
* appendStringInfoChar
|
187
|
+
*
|
188
|
+
* Append a single byte to str.
|
189
|
+
* Like appendStringInfo(str, "%c", ch) but much faster.
|
190
|
+
*/
|
191
|
+
void
|
192
|
+
appendStringInfoChar(StringInfo str, char ch)
|
193
|
+
{
|
194
|
+
/* Make more room if needed */
|
195
|
+
if (str->len + 1 >= str->maxlen)
|
196
|
+
enlargeStringInfo(str, 1);
|
197
|
+
|
198
|
+
/* OK, append the character */
|
199
|
+
str->data[str->len] = ch;
|
200
|
+
str->len++;
|
201
|
+
str->data[str->len] = '\0';
|
202
|
+
}
|
203
|
+
|
204
|
+
/*
|
205
|
+
* appendStringInfoSpaces
|
206
|
+
*
|
207
|
+
* Append the specified number of spaces to a buffer.
|
208
|
+
*/
|
209
|
+
void
|
210
|
+
appendStringInfoSpaces(StringInfo str, int count)
|
211
|
+
{
|
212
|
+
if (count > 0)
|
213
|
+
{
|
214
|
+
/* Make more room if needed */
|
215
|
+
enlargeStringInfo(str, count);
|
216
|
+
|
217
|
+
/* OK, append the spaces */
|
218
|
+
while (--count >= 0)
|
219
|
+
str->data[str->len++] = ' ';
|
220
|
+
str->data[str->len] = '\0';
|
221
|
+
}
|
222
|
+
}
|
223
|
+
|
224
|
+
/*
|
225
|
+
* appendBinaryStringInfo
|
226
|
+
*
|
227
|
+
* Append arbitrary binary data to a StringInfo, allocating more space
|
228
|
+
* if necessary. Ensures that a trailing null byte is present.
|
229
|
+
*/
|
230
|
+
void
|
231
|
+
appendBinaryStringInfo(StringInfo str, const char *data, int datalen)
|
232
|
+
{
|
233
|
+
Assert(str != NULL);
|
234
|
+
|
235
|
+
/* Make more room if needed */
|
236
|
+
enlargeStringInfo(str, datalen);
|
237
|
+
|
238
|
+
/* OK, append the data */
|
239
|
+
memcpy(str->data + str->len, data, datalen);
|
240
|
+
str->len += datalen;
|
241
|
+
|
242
|
+
/*
|
243
|
+
* Keep a trailing null in place, even though it's probably useless for
|
244
|
+
* binary data. (Some callers are dealing with text but call this because
|
245
|
+
* their input isn't null-terminated.)
|
246
|
+
*/
|
247
|
+
str->data[str->len] = '\0';
|
248
|
+
}
|
249
|
+
|
250
|
+
/*
|
251
|
+
* appendBinaryStringInfoNT
|
252
|
+
*
|
253
|
+
* Append arbitrary binary data to a StringInfo, allocating more space
|
254
|
+
* if necessary. Does not ensure a trailing null-byte exists.
|
255
|
+
*/
|
256
|
+
|
257
|
+
|
258
|
+
/*
|
259
|
+
* enlargeStringInfo
|
260
|
+
*
|
261
|
+
* Make sure there is enough space for 'needed' more bytes
|
262
|
+
* ('needed' does not include the terminating null).
|
263
|
+
*
|
264
|
+
* External callers usually need not concern themselves with this, since
|
265
|
+
* all stringinfo.c routines do it automatically. However, if a caller
|
266
|
+
* knows that a StringInfo will eventually become X bytes large, it
|
267
|
+
* can save some palloc overhead by enlarging the buffer before starting
|
268
|
+
* to store data in it.
|
269
|
+
*
|
270
|
+
* NB: In the backend, because we use repalloc() to enlarge the buffer, the
|
271
|
+
* string buffer will remain allocated in the same memory context that was
|
272
|
+
* current when initStringInfo was called, even if another context is now
|
273
|
+
* current. This is the desired and indeed critical behavior!
|
274
|
+
*/
|
275
|
+
void
|
276
|
+
enlargeStringInfo(StringInfo str, int needed)
|
277
|
+
{
|
278
|
+
int newlen;
|
279
|
+
|
280
|
+
/*
|
281
|
+
* Guard against out-of-range "needed" values. Without this, we can get
|
282
|
+
* an overflow or infinite loop in the following.
|
283
|
+
*/
|
284
|
+
if (needed < 0) /* should not happen */
|
285
|
+
{
|
286
|
+
#ifndef FRONTEND
|
287
|
+
elog(ERROR, "invalid string enlargement request size: %d", needed);
|
288
|
+
#else
|
289
|
+
fprintf(stderr, "invalid string enlargement request size: %d\n", needed);
|
290
|
+
exit(EXIT_FAILURE);
|
291
|
+
#endif
|
292
|
+
}
|
293
|
+
if (((Size) needed) >= (MaxAllocSize - (Size) str->len))
|
294
|
+
{
|
295
|
+
#ifndef FRONTEND
|
296
|
+
ereport(ERROR,
|
297
|
+
(errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
|
298
|
+
errmsg("out of memory"),
|
299
|
+
errdetail("Cannot enlarge string buffer containing %d bytes by %d more bytes.",
|
300
|
+
str->len, needed)));
|
301
|
+
#else
|
302
|
+
fprintf(stderr,
|
303
|
+
_("out of memory\n\nCannot enlarge string buffer containing %d bytes by %d more bytes.\n"),
|
304
|
+
str->len, needed);
|
305
|
+
exit(EXIT_FAILURE);
|
306
|
+
#endif
|
307
|
+
}
|
308
|
+
|
309
|
+
needed += str->len + 1; /* total space required now */
|
310
|
+
|
311
|
+
/* Because of the above test, we now have needed <= MaxAllocSize */
|
312
|
+
|
313
|
+
if (needed <= str->maxlen)
|
314
|
+
return; /* got enough space already */
|
315
|
+
|
316
|
+
/*
|
317
|
+
* We don't want to allocate just a little more space with each append;
|
318
|
+
* for efficiency, double the buffer size each time it overflows.
|
319
|
+
* Actually, we might need to more than double it if 'needed' is big...
|
320
|
+
*/
|
321
|
+
newlen = 2 * str->maxlen;
|
322
|
+
while (needed > newlen)
|
323
|
+
newlen = 2 * newlen;
|
324
|
+
|
325
|
+
/*
|
326
|
+
* Clamp to MaxAllocSize in case we went past it. Note we are assuming
|
327
|
+
* here that MaxAllocSize <= INT_MAX/2, else the above loop could
|
328
|
+
* overflow. We will still have newlen >= needed.
|
329
|
+
*/
|
330
|
+
if (newlen > (int) MaxAllocSize)
|
331
|
+
newlen = (int) MaxAllocSize;
|
332
|
+
|
333
|
+
str->data = (char *) repalloc(str->data, newlen);
|
334
|
+
|
335
|
+
str->maxlen = newlen;
|
336
|
+
}
|