Skip to content

Commit edabd8f

Browse files
macdicemacdice
committed
Add PGTYPESchar_free() to avoid cross-module problems on Windows.
On Windows, it is sometimes important for corresponding malloc() and free() calls to be made from the same DLL, since some build options can result in multiple allocators being active at the same time. For that reason we already provided PQfreemem(). This commit adds a similar function for freeing string results allocated by the pgtypes library. Author: Takayuki Tsunakawa Reviewed-by: Kyotaro Horiguchi Discussion: https://postgr.es/m/0A3221C70F24FB45833433255569204D1F8AD5D6%40G01JPEXMBYT05
1 parent 12f7d91 commit edabd8f

20 files changed

+192
-139
lines changed

‎doc/src/sgml/ecpg.sgml

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1917,11 +1917,23 @@ EXEC SQL SELECT started, duration INTO :ts1, :iv1 FROM datetbl WHERE d=:date1;
19171917
PGTYPEStimestamp_add_interval(&ts1, &iv1, &tsout);
19181918
out = PGTYPEStimestamp_to_asc(&tsout);
19191919
printf("Started + duration: %s\n", out);
1920-
free(out);
1920+
PGTYPESchar_free(out);
19211921
]]>
19221922
</programlisting>
19231923
</para>
19241924

1925+
<sect2 id="ecpg-pgtypes-cstrings">
1926+
<title>Character Strings</title>
1927+
<para>
1928+
Some functions such as <function>PGTYPESnumeric_to_asc</function> return
1929+
a pointer to a freshly allocated character string. These results should be
1930+
freed with <function>PGTYPESchar_free</function> instead of
1931+
<function>free</function>. (This is important only on Windows, where
1932+
memory allocation and release sometimes need to be done by the same
1933+
library.)
1934+
</para>
1935+
</sect2>
1936+
19251937
<sect2 id="ecpg-pgtypes-numeric">
19261938
<title>The numeric Type</title>
19271939
<para>
@@ -1995,6 +2007,7 @@ char *PGTYPESnumeric_to_asc(numeric *num, int dscale);
19952007
</synopsis>
19962008
The numeric value will be printed with <literal>dscale</literal> decimal
19972009
digits, with rounding applied if necessary.
2010+
The result must be freed with <function>PGTYPESchar_free()</function>.
19982011
</para>
19992012
</listitem>
20002013
</varlistentry>
@@ -2382,9 +2395,10 @@ date PGTYPESdate_from_asc(char *str, char **endptr);
23822395
<synopsis>
23832396
char *PGTYPESdate_to_asc(date dDate);
23842397
</synopsis>
2385-
The function receives the date <literal>dDate</> as its only parameter.
2386-
It will output the date in the form <literal>1999-01-18</>, i.e., in the
2387-
<literal>YYYY-MM-DD</> format.
2398+
The function receives the date <literal>dDate</literal> as its only parameter.
2399+
It will output the date in the form <literal>1999-01-18</literal>, i.e., in the
2400+
<literal>YYYY-MM-DD</literal> format.
2401+
The result must be freed with <function>PGTYPESchar_free()</function>.
23882402
</para>
23892403
</listitem>
23902404
</varlistentry>
@@ -2807,6 +2821,7 @@ char *PGTYPEStimestamp_to_asc(timestamp tstamp);
28072821
The function receives the timestamp <literal>tstamp</> as
28082822
its only argument and returns an allocated string that contains the
28092823
textual representation of the timestamp.
2824+
The result must be freed with <function>PGTYPESchar_free()</function>.
28102825
</para>
28112826
</listitem>
28122827
</varlistentry>
@@ -3315,6 +3330,7 @@ char *PGTYPESinterval_to_asc(interval *span);
33153330
The function converts the interval variable that <literal>span</>
33163331
points to into a C char*. The output looks like this example:
33173332
<literal>@ 1 day 12 hours 59 mins 10 secs</literal>.
3333+
The result must be freed with <function>PGTYPESchar_free()</function>.
33183334
</para>
33193335
</listitem>
33203336
</varlistentry>

‎src/interfaces/ecpg/include/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ install: all installdirs install-headers
1414

1515
.PHONY: install-headers
1616
ecpg_headers = ecpgerrno.h ecpglib.h ecpgtype.h sqlca.h sql3types.h ecpg_informix.h \
17-
pgtypes_error.h pgtypes_numeric.h pgtypes_timestamp.h pgtypes_date.h pgtypes_interval.h \
17+
pgtypes_error.h pgtypes_numeric.h pgtypes_timestamp.h pgtypes_date.h pgtypes_interval.h pgtypes.h \
1818
sqlda.h sqlda-compat.h sqlda-native.h
1919
informix_headers = datetime.h decimal.h sqltypes.h
2020

‎src/interfaces/ecpg/include/pgtypes.h

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
/* src/interfaces/ecpg/include/pgtypes.h */
2+
3+
#ifndef PGTYPES_H
4+
#define PGTYPES_H
5+
6+
#ifdef __cplusplus
7+
extern "C"
8+
{
9+
#endif
10+
11+
extern void PGTYPESchar_free(char *ptr);
12+
13+
#ifdef __cplusplus
14+
}
15+
#endif
16+
17+
#endif /* PGTYPES_H */

‎src/interfaces/ecpg/include/pgtypes_date.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
#ifndef PGTYPES_DATETIME
44
#define PGTYPES_DATETIME
55

6+
#include <pgtypes.h>
67
#include <pgtypes_timestamp.h>
78

89
typedef long date;

‎src/interfaces/ecpg/include/pgtypes_interval.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
#define PGTYPES_INTERVAL
55

66
#include <ecpg_config.h>
7+
#include <pgtypes.h>
78

89
#ifndef C_H
910

‎src/interfaces/ecpg/include/pgtypes_numeric.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
#ifndef PGTYPES_NUMERIC
22
#define PGTYPES_NUMERIC
33

4+
#include <pgtypes.h>
5+
46
#define NUMERIC_POS 0x0000
57
#define NUMERIC_NEG 0x4000
68
#define NUMERIC_NAN 0xC000

‎src/interfaces/ecpg/include/pgtypes_timestamp.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
#ifndef PGTYPES_TIMESTAMP
44
#define PGTYPES_TIMESTAMP
55

6+
#include <pgtypes.h>
67
/* pgtypes_interval.h includes ecpg_config.h */
78
#include <pgtypes_interval.h>
89

‎src/interfaces/ecpg/pgtypeslib/common.c

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
#include "postgres_fe.h"
44

55
#include "extern.h"
6+
#include "pgtypes.h"
67

78
/* Return value is zero-filled. */
89
char *
@@ -136,3 +137,12 @@ pgtypes_fmt_replace(union un_fmt_comb replace_val, int replace_type, char **outp
136137
}
137138
return 0;
138139
}
140+
141+
/* Functions declared in pgtypes.h. */
142+
143+
/* Just frees memory (mostly needed for Windows) */
144+
void
145+
PGTYPESchar_free(char *ptr)
146+
{
147+
free(ptr);
148+
}

‎src/interfaces/ecpg/pgtypeslib/exports.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,4 @@ PGTYPEStimestamp_from_asc 42
4545
PGTYPEStimestamp_sub 43
4646
PGTYPEStimestamp_sub_interval 44
4747
PGTYPEStimestamp_to_asc 45
48+
PGTYPESchar_free 46

0 commit comments

Comments
 (0)