Line data Source code
1 : /*-------------------------------------------------------------------------
2 : *
3 : * outfuncs.c
4 : * Output functions for Postgres tree nodes.
5 : *
6 : * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
7 : * Portions Copyright (c) 1994, Regents of the University of California
8 : *
9 : *
10 : * IDENTIFICATION
11 : * src/backend/nodes/outfuncs.c
12 : *
13 : *-------------------------------------------------------------------------
14 : */
15 : #include "postgres.h"
16 :
17 : #include <ctype.h>
18 :
19 : #include "access/attnum.h"
20 : #include "common/shortest_dec.h"
21 : #include "lib/stringinfo.h"
22 : #include "miscadmin.h"
23 : #include "nodes/bitmapset.h"
24 : #include "nodes/nodes.h"
25 : #include "nodes/pg_list.h"
26 : #include "utils/datum.h"
27 :
28 : /* State flag that determines how nodeToStringInternal() should treat location fields */
29 : static bool write_location_fields = false;
30 :
31 : static void outChar(StringInfo str, char c);
32 : static void outDouble(StringInfo str, double d);
33 :
34 :
35 : /*
36 : * Macros to simplify output of different kinds of fields. Use these
37 : * wherever possible to reduce the chance for silly typos. Note that these
38 : * hard-wire conventions about the names of the local variables in an Out
39 : * routine.
40 : */
41 :
42 : /* Write the label for the node type */
43 : #define WRITE_NODE_TYPE(nodelabel) \
44 : appendStringInfoString(str, nodelabel)
45 :
46 : /* Write an integer field (anything written as ":fldname %d") */
47 : #define WRITE_INT_FIELD(fldname) \
48 : appendStringInfo(str, " :" CppAsString(fldname) " %d", node->fldname)
49 :
50 : /* Write an unsigned integer field (anything written as ":fldname %u") */
51 : #define WRITE_UINT_FIELD(fldname) \
52 : appendStringInfo(str, " :" CppAsString(fldname) " %u", node->fldname)
53 :
54 : /* Write a signed integer field (anything written with INT64_FORMAT) */
55 : #define WRITE_INT64_FIELD(fldname) \
56 : appendStringInfo(str, \
57 : " :" CppAsString(fldname) " " INT64_FORMAT, \
58 : node->fldname)
59 :
60 : /* Write an unsigned integer field (anything written with UINT64_FORMAT) */
61 : #define WRITE_UINT64_FIELD(fldname) \
62 : appendStringInfo(str, " :" CppAsString(fldname) " " UINT64_FORMAT, \
63 : node->fldname)
64 :
65 : /* Write an OID field (don't hard-wire assumption that OID is same as uint) */
66 : #define WRITE_OID_FIELD(fldname) \
67 : appendStringInfo(str, " :" CppAsString(fldname) " %u", node->fldname)
68 :
69 : /* Write a long-integer field */
70 : #define WRITE_LONG_FIELD(fldname) \
71 : appendStringInfo(str, " :" CppAsString(fldname) " %ld", node->fldname)
72 :
73 : /* Write a char field (ie, one ascii character) */
74 : #define WRITE_CHAR_FIELD(fldname) \
75 : (appendStringInfo(str, " :" CppAsString(fldname) " "), \
76 : outChar(str, node->fldname))
77 :
78 : /* Write an enumerated-type field as an integer code */
79 : #define WRITE_ENUM_FIELD(fldname, enumtype) \
80 : appendStringInfo(str, " :" CppAsString(fldname) " %d", \
81 : (int) node->fldname)
82 :
83 : /* Write a float field (actually, they're double) */
84 : #define WRITE_FLOAT_FIELD(fldname) \
85 : (appendStringInfo(str, " :" CppAsString(fldname) " "), \
86 : outDouble(str, node->fldname))
87 :
88 : /* Write a boolean field */
89 : #define WRITE_BOOL_FIELD(fldname) \
90 : appendStringInfo(str, " :" CppAsString(fldname) " %s", \
91 : booltostr(node->fldname))
92 :
93 : /* Write a character-string (possibly NULL) field */
94 : #define WRITE_STRING_FIELD(fldname) \
95 : (appendStringInfoString(str, " :" CppAsString(fldname) " "), \
96 : outToken(str, node->fldname))
97 :
98 : /* Write a parse location field (actually same as INT case) */
99 : #define WRITE_LOCATION_FIELD(fldname) \
100 : appendStringInfo(str, " :" CppAsString(fldname) " %d", write_location_fields ? node->fldname : -1)
101 :
102 : /* Write a Node field */
103 : #define WRITE_NODE_FIELD(fldname) \
104 : (appendStringInfoString(str, " :" CppAsString(fldname) " "), \
105 : outNode(str, node->fldname))
106 :
107 : /* Write a bitmapset field */
108 : #define WRITE_BITMAPSET_FIELD(fldname) \
109 : (appendStringInfoString(str, " :" CppAsString(fldname) " "), \
110 : outBitmapset(str, node->fldname))
111 :
112 : /* Write a variable-length array (not a List) of Node pointers */
113 : #define WRITE_NODE_ARRAY(fldname, len) \
114 : (appendStringInfoString(str, " :" CppAsString(fldname) " "), \
115 : writeNodeArray(str, (const Node * const *) node->fldname, len))
116 :
117 : /* Write a variable-length array of AttrNumber */
118 : #define WRITE_ATTRNUMBER_ARRAY(fldname, len) \
119 : (appendStringInfoString(str, " :" CppAsString(fldname) " "), \
120 : writeAttrNumberCols(str, node->fldname, len))
121 :
122 : /* Write a variable-length array of Oid */
123 : #define WRITE_OID_ARRAY(fldname, len) \
124 : (appendStringInfoString(str, " :" CppAsString(fldname) " "), \
125 : writeOidCols(str, node->fldname, len))
126 :
127 : /* Write a variable-length array of Index */
128 : #define WRITE_INDEX_ARRAY(fldname, len) \
129 : (appendStringInfoString(str, " :" CppAsString(fldname) " "), \
130 : writeIndexCols(str, node->fldname, len))
131 :
132 : /* Write a variable-length array of int */
133 : #define WRITE_INT_ARRAY(fldname, len) \
134 : (appendStringInfoString(str, " :" CppAsString(fldname) " "), \
135 : writeIntCols(str, node->fldname, len))
136 :
137 : /* Write a variable-length array of bool */
138 : #define WRITE_BOOL_ARRAY(fldname, len) \
139 : (appendStringInfoString(str, " :" CppAsString(fldname) " "), \
140 : writeBoolCols(str, node->fldname, len))
141 :
142 : #define booltostr(x) ((x) ? "true" : "false")
143 :
144 :
145 : /*
146 : * outToken
147 : * Convert an ordinary string (eg, an identifier) into a form that
148 : * will be decoded back to a plain token by read.c's functions.
149 : *
150 : * If a null string pointer is given, it is encoded as '<>'.
151 : * An empty string is encoded as '""'. To avoid ambiguity, input
152 : * strings beginning with '<' or '"' receive a leading backslash.
153 : */
154 : void
155 2144778 : outToken(StringInfo str, const char *s)
156 : {
157 2144778 : if (s == NULL)
158 : {
159 91458 : appendStringInfoString(str, "<>");
160 91458 : return;
161 : }
162 2053320 : if (*s == '\0')
163 : {
164 0 : appendStringInfoString(str, "\"\"");
165 0 : return;
166 : }
167 :
168 : /*
169 : * Look for characters or patterns that are treated specially by read.c
170 : * (either in pg_strtok() or in nodeRead()), and therefore need a
171 : * protective backslash.
172 : */
173 : /* These characters only need to be quoted at the start of the string */
174 2053320 : if (*s == '<' ||
175 2053308 : *s == '"' ||
176 2053308 : isdigit((unsigned char) *s) ||
177 2053308 : ((*s == '+' || *s == '-') &&
178 0 : (isdigit((unsigned char) s[1]) || s[1] == '.')))
179 12 : appendStringInfoChar(str, '\\');
180 20576476 : while (*s)
181 : {
182 : /* These chars must be backslashed anywhere in the string */
183 18523156 : if (*s == ' ' || *s == '\n' || *s == '\t' ||
184 18522928 : *s == '(' || *s == ')' || *s == '{' || *s == '}' ||
185 18522880 : *s == '\\')
186 276 : appendStringInfoChar(str, '\\');
187 18523156 : appendStringInfoChar(str, *s++);
188 : }
189 : }
190 :
191 : /*
192 : * Convert one char. Goes through outToken() so that special characters are
193 : * escaped.
194 : */
195 : static void
196 76298 : outChar(StringInfo str, char c)
197 : {
198 : char in[2];
199 :
200 : /* Traditionally, we've represented \0 as <>, so keep doing that */
201 76298 : if (c == '\0')
202 : {
203 9772 : appendStringInfoString(str, "<>");
204 9772 : return;
205 : }
206 :
207 66526 : in[0] = c;
208 66526 : in[1] = '\0';
209 :
210 66526 : outToken(str, in);
211 : }
212 :
213 : /*
214 : * Convert a double value, attempting to ensure the value is preserved exactly.
215 : */
216 : static void
217 10514 : outDouble(StringInfo str, double d)
218 : {
219 : char buf[DOUBLE_SHORTEST_DECIMAL_LEN];
220 :
221 10514 : double_to_shortest_decimal_buf(d, buf);
222 10514 : appendStringInfoString(str, buf);
223 10514 : }
224 :
225 : /*
226 : * common implementation for scalar-array-writing functions
227 : *
228 : * The data format is either "<>" for a NULL pointer or "(item item item)".
229 : * fmtstr must include a leading space, and the rest of it must produce
230 : * something that will be seen as a single simple token by pg_strtok().
231 : * convfunc can be empty, or the name of a conversion macro or function.
232 : */
233 : #define WRITE_SCALAR_ARRAY(fnname, datatype, fmtstr, convfunc) \
234 : static void \
235 : fnname(StringInfo str, const datatype *arr, int len) \
236 : { \
237 : if (arr != NULL) \
238 : { \
239 : appendStringInfoChar(str, '('); \
240 : for (int i = 0; i < len; i++) \
241 : appendStringInfo(str, fmtstr, convfunc(arr[i])); \
242 : appendStringInfoChar(str, ')'); \
243 : } \
244 : else \
245 : appendStringInfoString(str, "<>"); \
246 : }
247 :
248 1258 : WRITE_SCALAR_ARRAY(writeAttrNumberCols, AttrNumber, " %d",)
249 3578 : WRITE_SCALAR_ARRAY(writeOidCols, Oid, " %u",)
250 0 : WRITE_SCALAR_ARRAY(writeIndexCols, Index, " %u",)
251 3042 : WRITE_SCALAR_ARRAY(writeIntCols, int, " %d",)
252 370 : WRITE_SCALAR_ARRAY(writeBoolCols, bool, " %s", booltostr)
253 :
254 : /*
255 : * Print an array (not a List) of Node pointers.
256 : *
257 : * The decoration is identical to that of scalar arrays, but we can't
258 : * quite use appendStringInfo() in the loop.
259 : */
260 : static void
261 0 : writeNodeArray(StringInfo str, const Node *const *arr, int len)
262 : {
263 0 : if (arr != NULL)
264 : {
265 0 : appendStringInfoChar(str, '(');
266 0 : for (int i = 0; i < len; i++)
267 : {
268 0 : appendStringInfoChar(str, ' ');
269 0 : outNode(str, arr[i]);
270 : }
271 0 : appendStringInfoChar(str, ')');
272 : }
273 : else
274 0 : appendStringInfoString(str, "<>");
275 0 : }
276 :
277 : /*
278 : * Print a List.
279 : */
280 : static void
281 560632 : _outList(StringInfo str, const List *node)
282 : {
283 : const ListCell *lc;
284 :
285 560632 : appendStringInfoChar(str, '(');
286 :
287 560632 : if (IsA(node, IntList))
288 34696 : appendStringInfoChar(str, 'i');
289 525936 : else if (IsA(node, OidList))
290 13000 : appendStringInfoChar(str, 'o');
291 512936 : else if (IsA(node, XidList))
292 0 : appendStringInfoChar(str, 'x');
293 :
294 4697018 : foreach(lc, node)
295 : {
296 : /*
297 : * For the sake of backward compatibility, we emit a slightly
298 : * different whitespace format for lists of nodes vs. other types of
299 : * lists. XXX: is this necessary?
300 : */
301 4136386 : if (IsA(node, List))
302 : {
303 3302774 : outNode(str, lfirst(lc));
304 3302774 : if (lnext(node, lc))
305 2789838 : appendStringInfoChar(str, ' ');
306 : }
307 833612 : else if (IsA(node, IntList))
308 782550 : appendStringInfo(str, " %d", lfirst_int(lc));
309 51062 : else if (IsA(node, OidList))
310 51062 : appendStringInfo(str, " %u", lfirst_oid(lc));
311 0 : else if (IsA(node, XidList))
312 0 : appendStringInfo(str, " %u", lfirst_xid(lc));
313 : else
314 0 : elog(ERROR, "unrecognized list node type: %d",
315 : (int) node->type);
316 : }
317 :
318 560632 : appendStringInfoChar(str, ')');
319 560632 : }
320 :
321 : /*
322 : * outBitmapset -
323 : * converts a bitmap set of integers
324 : *
325 : * Note: the output format is "(b int int ...)", similar to an integer List.
326 : *
327 : * We export this function for use by extensions that define extensible nodes.
328 : * That's somewhat historical, though, because calling outNode() will work.
329 : */
330 : void
331 1275418 : outBitmapset(StringInfo str, const Bitmapset *bms)
332 : {
333 : int x;
334 :
335 1275418 : appendStringInfoChar(str, '(');
336 1275418 : appendStringInfoChar(str, 'b');
337 1275418 : x = -1;
338 1622348 : while ((x = bms_next_member(bms, x)) >= 0)
339 346930 : appendStringInfo(str, " %d", x);
340 1275418 : appendStringInfoChar(str, ')');
341 1275418 : }
342 :
343 : /*
344 : * Print the value of a Datum given its type.
345 : */
346 : void
347 160876 : outDatum(StringInfo str, Datum value, int typlen, bool typbyval)
348 : {
349 : Size length;
350 : char *s;
351 :
352 160876 : length = datumGetSize(value, typbyval, typlen);
353 :
354 160876 : if (typbyval)
355 : {
356 104000 : s = (char *) (&value);
357 104000 : appendStringInfo(str, "%zu [ ", length);
358 936000 : for (Size i = 0; i < (Size) sizeof(Datum); i++)
359 832000 : appendStringInfo(str, "%d ", (int) (s[i]));
360 104000 : appendStringInfoChar(str, ']');
361 : }
362 : else
363 : {
364 56876 : s = (char *) DatumGetPointer(value);
365 56876 : if (!s)
366 0 : appendStringInfoString(str, "0 [ ]");
367 : else
368 : {
369 56876 : appendStringInfo(str, "%zu [ ", length);
370 2058358 : for (Size i = 0; i < length; i++)
371 2001482 : appendStringInfo(str, "%d ", (int) (s[i]));
372 56876 : appendStringInfoChar(str, ']');
373 : }
374 : }
375 160876 : }
376 :
377 :
378 : #include "outfuncs.funcs.c"
379 :
380 :
381 : /*
382 : * Support functions for nodes with custom_read_write attribute or
383 : * special_read_write attribute
384 : */
385 :
386 : static void
387 186998 : _outConst(StringInfo str, const Const *node)
388 : {
389 186998 : WRITE_NODE_TYPE("CONST");
390 :
391 186998 : WRITE_OID_FIELD(consttype);
392 186998 : WRITE_INT_FIELD(consttypmod);
393 186998 : WRITE_OID_FIELD(constcollid);
394 186998 : WRITE_INT_FIELD(constlen);
395 186998 : WRITE_BOOL_FIELD(constbyval);
396 186998 : WRITE_BOOL_FIELD(constisnull);
397 186998 : WRITE_LOCATION_FIELD(location);
398 :
399 186998 : appendStringInfoString(str, " :constvalue ");
400 186998 : if (node->constisnull)
401 26122 : appendStringInfoString(str, "<>");
402 : else
403 160876 : outDatum(str, node->constvalue, node->constlen, node->constbyval);
404 186998 : }
405 :
406 : static void
407 23390 : _outBoolExpr(StringInfo str, const BoolExpr *node)
408 : {
409 23390 : char *opstr = NULL;
410 :
411 23390 : WRITE_NODE_TYPE("BOOLEXPR");
412 :
413 : /* do-it-yourself enum representation */
414 23390 : switch (node->boolop)
415 : {
416 14082 : case AND_EXPR:
417 14082 : opstr = "and";
418 14082 : break;
419 6272 : case OR_EXPR:
420 6272 : opstr = "or";
421 6272 : break;
422 3036 : case NOT_EXPR:
423 3036 : opstr = "not";
424 3036 : break;
425 : }
426 23390 : appendStringInfoString(str, " :boolop ");
427 23390 : outToken(str, opstr);
428 :
429 23390 : WRITE_NODE_FIELD(args);
430 23390 : WRITE_LOCATION_FIELD(location);
431 23390 : }
432 :
433 : static void
434 0 : _outForeignKeyOptInfo(StringInfo str, const ForeignKeyOptInfo *node)
435 : {
436 0 : WRITE_NODE_TYPE("FOREIGNKEYOPTINFO");
437 :
438 0 : WRITE_UINT_FIELD(con_relid);
439 0 : WRITE_UINT_FIELD(ref_relid);
440 0 : WRITE_INT_FIELD(nkeys);
441 0 : WRITE_ATTRNUMBER_ARRAY(conkey, node->nkeys);
442 0 : WRITE_ATTRNUMBER_ARRAY(confkey, node->nkeys);
443 0 : WRITE_OID_ARRAY(conpfeqop, node->nkeys);
444 0 : WRITE_INT_FIELD(nmatched_ec);
445 0 : WRITE_INT_FIELD(nconst_ec);
446 0 : WRITE_INT_FIELD(nmatched_rcols);
447 0 : WRITE_INT_FIELD(nmatched_ri);
448 : /* for compactness, just print the number of matches per column: */
449 0 : appendStringInfoString(str, " :eclass");
450 0 : for (int i = 0; i < node->nkeys; i++)
451 0 : appendStringInfo(str, " %d", (node->eclass[i] != NULL));
452 0 : appendStringInfoString(str, " :rinfos");
453 0 : for (int i = 0; i < node->nkeys; i++)
454 0 : appendStringInfo(str, " %d", list_length(node->rinfos[i]));
455 0 : }
456 :
457 : static void
458 0 : _outEquivalenceClass(StringInfo str, const EquivalenceClass *node)
459 : {
460 : /*
461 : * To simplify reading, we just chase up to the topmost merged EC and
462 : * print that, without bothering to show the merge-ees separately.
463 : */
464 0 : while (node->ec_merged)
465 0 : node = node->ec_merged;
466 :
467 0 : WRITE_NODE_TYPE("EQUIVALENCECLASS");
468 :
469 0 : WRITE_NODE_FIELD(ec_opfamilies);
470 0 : WRITE_OID_FIELD(ec_collation);
471 0 : WRITE_INT_FIELD(ec_childmembers_size);
472 0 : WRITE_NODE_FIELD(ec_members);
473 0 : WRITE_NODE_ARRAY(ec_childmembers, node->ec_childmembers_size);
474 0 : WRITE_NODE_FIELD(ec_sources);
475 : /* Only ec_derives_list is written; hash is not serialized. */
476 0 : WRITE_NODE_FIELD(ec_derives_list);
477 0 : WRITE_BITMAPSET_FIELD(ec_relids);
478 0 : WRITE_BOOL_FIELD(ec_has_const);
479 0 : WRITE_BOOL_FIELD(ec_has_volatile);
480 0 : WRITE_BOOL_FIELD(ec_broken);
481 0 : WRITE_UINT_FIELD(ec_sortref);
482 0 : WRITE_UINT_FIELD(ec_min_security);
483 0 : WRITE_UINT_FIELD(ec_max_security);
484 0 : }
485 :
486 : static void
487 0 : _outExtensibleNode(StringInfo str, const ExtensibleNode *node)
488 : {
489 : const ExtensibleNodeMethods *methods;
490 :
491 0 : methods = GetExtensibleNodeMethods(node->extnodename, false);
492 :
493 0 : WRITE_NODE_TYPE("EXTENSIBLENODE");
494 :
495 0 : WRITE_STRING_FIELD(extnodename);
496 :
497 : /* serialize the private fields */
498 0 : methods->nodeOut(str, node);
499 0 : }
500 :
501 : static void
502 85498 : _outRangeTblEntry(StringInfo str, const RangeTblEntry *node)
503 : {
504 85498 : WRITE_NODE_TYPE("RANGETBLENTRY");
505 :
506 85498 : WRITE_NODE_FIELD(alias);
507 85498 : WRITE_NODE_FIELD(eref);
508 85498 : WRITE_ENUM_FIELD(rtekind, RTEKind);
509 :
510 85498 : switch (node->rtekind)
511 : {
512 53784 : case RTE_RELATION:
513 53784 : WRITE_OID_FIELD(relid);
514 53784 : WRITE_BOOL_FIELD(inh);
515 53784 : WRITE_CHAR_FIELD(relkind);
516 53784 : WRITE_INT_FIELD(rellockmode);
517 53784 : WRITE_UINT_FIELD(perminfoindex);
518 53784 : WRITE_NODE_FIELD(tablesample);
519 53784 : break;
520 9790 : case RTE_SUBQUERY:
521 9790 : WRITE_NODE_FIELD(subquery);
522 9790 : WRITE_BOOL_FIELD(security_barrier);
523 : /* we re-use these RELATION fields, too: */
524 9790 : WRITE_OID_FIELD(relid);
525 9790 : WRITE_BOOL_FIELD(inh);
526 9790 : WRITE_CHAR_FIELD(relkind);
527 9790 : WRITE_INT_FIELD(rellockmode);
528 9790 : WRITE_UINT_FIELD(perminfoindex);
529 9790 : break;
530 15240 : case RTE_JOIN:
531 15240 : WRITE_ENUM_FIELD(jointype, JoinType);
532 15240 : WRITE_INT_FIELD(joinmergedcols);
533 15240 : WRITE_NODE_FIELD(joinaliasvars);
534 15240 : WRITE_NODE_FIELD(joinleftcols);
535 15240 : WRITE_NODE_FIELD(joinrightcols);
536 15240 : WRITE_NODE_FIELD(join_using_alias);
537 15240 : break;
538 5528 : case RTE_FUNCTION:
539 5528 : WRITE_NODE_FIELD(functions);
540 5528 : WRITE_BOOL_FIELD(funcordinality);
541 5528 : break;
542 82 : case RTE_TABLEFUNC:
543 82 : WRITE_NODE_FIELD(tablefunc);
544 82 : break;
545 356 : case RTE_VALUES:
546 356 : WRITE_NODE_FIELD(values_lists);
547 356 : WRITE_NODE_FIELD(coltypes);
548 356 : WRITE_NODE_FIELD(coltypmods);
549 356 : WRITE_NODE_FIELD(colcollations);
550 356 : break;
551 150 : case RTE_CTE:
552 150 : WRITE_STRING_FIELD(ctename);
553 150 : WRITE_UINT_FIELD(ctelevelsup);
554 150 : WRITE_BOOL_FIELD(self_reference);
555 150 : WRITE_NODE_FIELD(coltypes);
556 150 : WRITE_NODE_FIELD(coltypmods);
557 150 : WRITE_NODE_FIELD(colcollations);
558 150 : break;
559 0 : case RTE_NAMEDTUPLESTORE:
560 0 : WRITE_STRING_FIELD(enrname);
561 0 : WRITE_FLOAT_FIELD(enrtuples);
562 0 : WRITE_NODE_FIELD(coltypes);
563 0 : WRITE_NODE_FIELD(coltypmods);
564 0 : WRITE_NODE_FIELD(colcollations);
565 : /* we re-use these RELATION fields, too: */
566 0 : WRITE_OID_FIELD(relid);
567 0 : break;
568 84 : case RTE_RESULT:
569 : /* no extra fields */
570 84 : break;
571 484 : case RTE_GROUP:
572 484 : WRITE_NODE_FIELD(groupexprs);
573 484 : break;
574 0 : default:
575 0 : elog(ERROR, "unrecognized RTE kind: %d", (int) node->rtekind);
576 : break;
577 : }
578 :
579 85498 : WRITE_BOOL_FIELD(lateral);
580 85498 : WRITE_BOOL_FIELD(inFromCl);
581 85498 : WRITE_NODE_FIELD(securityQuals);
582 85498 : }
583 :
584 : static void
585 0 : _outA_Expr(StringInfo str, const A_Expr *node)
586 : {
587 0 : WRITE_NODE_TYPE("A_EXPR");
588 :
589 0 : switch (node->kind)
590 : {
591 0 : case AEXPR_OP:
592 0 : WRITE_NODE_FIELD(name);
593 0 : break;
594 0 : case AEXPR_OP_ANY:
595 0 : appendStringInfoString(str, " ANY");
596 0 : WRITE_NODE_FIELD(name);
597 0 : break;
598 0 : case AEXPR_OP_ALL:
599 0 : appendStringInfoString(str, " ALL");
600 0 : WRITE_NODE_FIELD(name);
601 0 : break;
602 0 : case AEXPR_DISTINCT:
603 0 : appendStringInfoString(str, " DISTINCT");
604 0 : WRITE_NODE_FIELD(name);
605 0 : break;
606 0 : case AEXPR_NOT_DISTINCT:
607 0 : appendStringInfoString(str, " NOT_DISTINCT");
608 0 : WRITE_NODE_FIELD(name);
609 0 : break;
610 0 : case AEXPR_NULLIF:
611 0 : appendStringInfoString(str, " NULLIF");
612 0 : WRITE_NODE_FIELD(name);
613 0 : break;
614 0 : case AEXPR_IN:
615 0 : appendStringInfoString(str, " IN");
616 0 : WRITE_NODE_FIELD(name);
617 0 : break;
618 0 : case AEXPR_LIKE:
619 0 : appendStringInfoString(str, " LIKE");
620 0 : WRITE_NODE_FIELD(name);
621 0 : break;
622 0 : case AEXPR_ILIKE:
623 0 : appendStringInfoString(str, " ILIKE");
624 0 : WRITE_NODE_FIELD(name);
625 0 : break;
626 0 : case AEXPR_SIMILAR:
627 0 : appendStringInfoString(str, " SIMILAR");
628 0 : WRITE_NODE_FIELD(name);
629 0 : break;
630 0 : case AEXPR_BETWEEN:
631 0 : appendStringInfoString(str, " BETWEEN");
632 0 : WRITE_NODE_FIELD(name);
633 0 : break;
634 0 : case AEXPR_NOT_BETWEEN:
635 0 : appendStringInfoString(str, " NOT_BETWEEN");
636 0 : WRITE_NODE_FIELD(name);
637 0 : break;
638 0 : case AEXPR_BETWEEN_SYM:
639 0 : appendStringInfoString(str, " BETWEEN_SYM");
640 0 : WRITE_NODE_FIELD(name);
641 0 : break;
642 0 : case AEXPR_NOT_BETWEEN_SYM:
643 0 : appendStringInfoString(str, " NOT_BETWEEN_SYM");
644 0 : WRITE_NODE_FIELD(name);
645 0 : break;
646 0 : default:
647 0 : elog(ERROR, "unrecognized A_Expr_Kind: %d", (int) node->kind);
648 : break;
649 : }
650 :
651 0 : WRITE_NODE_FIELD(lexpr);
652 0 : WRITE_NODE_FIELD(rexpr);
653 0 : WRITE_LOCATION_FIELD(rexpr_list_start);
654 0 : WRITE_LOCATION_FIELD(rexpr_list_end);
655 0 : WRITE_LOCATION_FIELD(location);
656 0 : }
657 :
658 : static void
659 0 : _outInteger(StringInfo str, const Integer *node)
660 : {
661 0 : appendStringInfo(str, "%d", node->ival);
662 0 : }
663 :
664 : static void
665 0 : _outFloat(StringInfo str, const Float *node)
666 : {
667 : /*
668 : * We assume the value is a valid numeric literal and so does not need
669 : * quoting.
670 : */
671 0 : appendStringInfoString(str, node->fval);
672 0 : }
673 :
674 : static void
675 0 : _outBoolean(StringInfo str, const Boolean *node)
676 : {
677 0 : appendStringInfoString(str, node->boolval ? "true" : "false");
678 0 : }
679 :
680 : static void
681 1611498 : _outString(StringInfo str, const String *node)
682 : {
683 : /*
684 : * We use outToken to provide escaping of the string's content, but we
685 : * don't want it to convert an empty string to '""', because we're putting
686 : * double quotes around the string already.
687 : */
688 1611498 : appendStringInfoChar(str, '"');
689 1611498 : if (node->sval[0] != '\0')
690 1611342 : outToken(str, node->sval);
691 1611498 : appendStringInfoChar(str, '"');
692 1611498 : }
693 :
694 : static void
695 0 : _outBitString(StringInfo str, const BitString *node)
696 : {
697 : /*
698 : * The lexer will always produce a string starting with 'b' or 'x'. There
699 : * might be characters following that that need escaping, but outToken
700 : * won't escape the 'b' or 'x'. This is relied on by nodeTokenType.
701 : */
702 : Assert(node->bsval[0] == 'b' || node->bsval[0] == 'x');
703 0 : outToken(str, node->bsval);
704 0 : }
705 :
706 : static void
707 0 : _outA_Const(StringInfo str, const A_Const *node)
708 : {
709 0 : WRITE_NODE_TYPE("A_CONST");
710 :
711 0 : if (node->isnull)
712 0 : appendStringInfoString(str, " NULL");
713 : else
714 : {
715 0 : appendStringInfoString(str, " :val ");
716 0 : outNode(str, &node->val);
717 : }
718 0 : WRITE_LOCATION_FIELD(location);
719 0 : }
720 :
721 :
722 : /*
723 : * outNode -
724 : * converts a Node into ascii string and append it to 'str'
725 : */
726 : void
727 5728858 : outNode(StringInfo str, const void *obj)
728 : {
729 : /* Guard against stack overflow due to overly complex expressions */
730 5728858 : check_stack_depth();
731 :
732 5728858 : if (obj == NULL)
733 1152832 : appendStringInfoString(str, "<>");
734 4576026 : else if (IsA(obj, List) || IsA(obj, IntList) || IsA(obj, OidList) ||
735 4015394 : IsA(obj, XidList))
736 560632 : _outList(str, obj);
737 : /* nodeRead does not want to see { } around these! */
738 4015394 : else if (IsA(obj, Integer))
739 0 : _outInteger(str, (Integer *) obj);
740 4015394 : else if (IsA(obj, Float))
741 0 : _outFloat(str, (Float *) obj);
742 4015394 : else if (IsA(obj, Boolean))
743 0 : _outBoolean(str, (Boolean *) obj);
744 4015394 : else if (IsA(obj, String))
745 1611498 : _outString(str, (String *) obj);
746 2403896 : else if (IsA(obj, BitString))
747 0 : _outBitString(str, (BitString *) obj);
748 2403896 : else if (IsA(obj, Bitmapset))
749 154 : outBitmapset(str, (Bitmapset *) obj);
750 : else
751 : {
752 2403742 : appendStringInfoChar(str, '{');
753 2403742 : switch (nodeTag(obj))
754 : {
755 : #include "outfuncs.switch.c"
756 :
757 0 : default:
758 :
759 : /*
760 : * This should be an ERROR, but it's too useful to be able to
761 : * dump structures that outNode only understands part of.
762 : */
763 0 : elog(WARNING, "could not dump unrecognized node type: %d",
764 : (int) nodeTag(obj));
765 0 : break;
766 : }
767 2403742 : appendStringInfoChar(str, '}');
768 : }
769 5728858 : }
770 :
771 : /*
772 : * nodeToString -
773 : * returns the ascii representation of the Node as a palloc'd string
774 : *
775 : * write_loc_fields determines whether location fields are output with their
776 : * actual value rather than -1. The actual value can be useful for debugging,
777 : * but for most uses, the actual value is not useful, since the original query
778 : * string is no longer available.
779 : */
780 : static char *
781 70244 : nodeToStringInternal(const void *obj, bool write_loc_fields)
782 : {
783 : StringInfoData str;
784 : bool save_write_location_fields;
785 :
786 70244 : save_write_location_fields = write_location_fields;
787 70244 : write_location_fields = write_loc_fields;
788 :
789 : /* see stringinfo.h for an explanation of this maneuver */
790 70244 : initStringInfo(&str);
791 70244 : outNode(&str, obj);
792 :
793 70244 : write_location_fields = save_write_location_fields;
794 :
795 70244 : return str.data;
796 : }
797 :
798 : /*
799 : * Externally visible entry points
800 : */
801 : char *
802 70244 : nodeToString(const void *obj)
803 : {
804 70244 : return nodeToStringInternal(obj, false);
805 : }
806 :
807 : char *
808 0 : nodeToStringWithLocations(const void *obj)
809 : {
810 0 : return nodeToStringInternal(obj, true);
811 : }
812 :
813 :
814 : /*
815 : * bmsToString -
816 : * returns the ascii representation of the Bitmapset as a palloc'd string
817 : */
818 : char *
819 0 : bmsToString(const Bitmapset *bms)
820 : {
821 : StringInfoData str;
822 :
823 : /* see stringinfo.h for an explanation of this maneuver */
824 0 : initStringInfo(&str);
825 0 : outBitmapset(&str, bms);
826 0 : return str.data;
827 : }
|
