Fix assorted bugs in ecpg's macro mechanism.
commit2b6a74afe17045d3f3c02330ec0331af7782c5e6
authorTom Lane <tgl@sss.pgh.pa.us>
Tue, 16 Apr 2024 16:31:32 +0000 (16 12:31 -0400)
committerTom Lane <tgl@sss.pgh.pa.us>
Tue, 16 Apr 2024 16:31:32 +0000 (16 12:31 -0400)
treef45f0123f49bc9b7fc724bcb98eb25ca6dc435ff
parentf502849d49a4744a8b6ce8abaf7af7c320c4ea0b
Fix assorted bugs in ecpg's macro mechanism.

The code associated with EXEC SQL DEFINE was unreadable and full of
bugs, notably:

* It'd attempt to free a non-malloced string if the ecpg program
tries to redefine a macro that was defined on the command line.

* Possible memory stomp if user writes "-D=foo".

* Undef'ing or redefining a macro defined on the command line would
change the state visible to the next file, when multiple files are
specified on the command line.  (While possibly that could have been
an intentional choice, the code clearly intends to revert to the
original macro state; it's just failing to consider this interaction.)

* Missing "break" in defining a new macro meant that redefinition
of an existing name would cause an extra entry to be added to the
definition list.  While not immediately harmful, a subsequent undef
would result in the prior entry becoming visible again.

* The interactions with input buffering are subtle and were entirely
undocumented.

It's not that surprising that we hadn't noticed these bugs,
because there was no test coverage at all of either the -D
command line switch or multiple input files.  This patch adds
such coverage (in a rather hacky way I guess).

In addition to the code bugs, the user documentation was confused
about whether the -D switch defines a C macro or an ecpg one, and
it failed to mention that you can write "-Dsymbol=value".

These problems are old, so back-patch to all supported branches.

Discussion: https://postgr.es/m/998011.1713217712@sss.pgh.pa.us
doc/src/sgml/ecpg.sgml
doc/src/sgml/ref/ecpg-ref.sgml
src/interfaces/ecpg/preproc/ecpg.c
src/interfaces/ecpg/preproc/pgc.l
src/interfaces/ecpg/preproc/type.h
src/interfaces/ecpg/test/expected/sql-define.c
src/interfaces/ecpg/test/expected/sql-define.stderr
src/interfaces/ecpg/test/expected/sql-define.stdout
src/interfaces/ecpg/test/sql/Makefile
src/interfaces/ecpg/test/sql/define.pgc
src/interfaces/ecpg/test/sql/define_prelim.pgc [new file with mode: 0644]