mirror of
https://github.com/zebrajr/postgres.git
synced 2025-12-06 12:20:15 +01:00
8a27d418f8
Several functions in the codebase accept "Datum *" parameters but do not modify the pointed-to data. These have been updated to take "const Datum *" instead, improving type safety and making the interfaces clearer about their intent. This change helps the compiler catch accidental modifications and better documents immutability of arguments. Most of "Datum *" parameters have a pairing "bool *isnull" parameter, they are constified as well. No functional behavior is changed by this patch. Author: Chao Li <lic@highgo.com> Discussion: https://www.postgresql.org/message-id/flat/CAEoWx2msfT0knvzUa72ZBwu9LR_RLY4on85w2a9YpE-o2By5HQ@mail.gmail.com
95 lines
2.8 KiB
C
95 lines
2.8 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* xml.h
|
|
* Declarations for XML data type support.
|
|
*
|
|
*
|
|
* Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
|
|
* Portions Copyright (c) 1994, Regents of the University of California
|
|
*
|
|
* src/include/utils/xml.h
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
|
|
#ifndef XML_H
|
|
#define XML_H
|
|
|
|
#include "executor/tablefunc.h"
|
|
#include "fmgr.h"
|
|
#include "nodes/execnodes.h"
|
|
#include "nodes/primnodes.h"
|
|
|
|
typedef struct varlena xmltype;
|
|
|
|
typedef enum
|
|
{
|
|
XML_STANDALONE_YES,
|
|
XML_STANDALONE_NO,
|
|
XML_STANDALONE_NO_VALUE,
|
|
XML_STANDALONE_OMITTED,
|
|
} XmlStandaloneType;
|
|
|
|
typedef enum
|
|
{
|
|
XMLBINARY_BASE64,
|
|
XMLBINARY_HEX,
|
|
} XmlBinaryType;
|
|
|
|
typedef enum
|
|
{
|
|
PG_XML_STRICTNESS_LEGACY, /* ignore errors unless function result
|
|
* indicates error condition */
|
|
PG_XML_STRICTNESS_WELLFORMED, /* ignore non-parser messages */
|
|
PG_XML_STRICTNESS_ALL, /* report all notices/warnings/errors */
|
|
} PgXmlStrictness;
|
|
|
|
/* struct PgXmlErrorContext is private to xml.c */
|
|
typedef struct PgXmlErrorContext PgXmlErrorContext;
|
|
|
|
static inline xmltype *
|
|
DatumGetXmlP(Datum X)
|
|
{
|
|
return (xmltype *) PG_DETOAST_DATUM(X);
|
|
}
|
|
|
|
static inline Datum
|
|
XmlPGetDatum(const xmltype *X)
|
|
{
|
|
return PointerGetDatum(X);
|
|
}
|
|
|
|
#define PG_GETARG_XML_P(n) DatumGetXmlP(PG_GETARG_DATUM(n))
|
|
#define PG_RETURN_XML_P(x) PG_RETURN_POINTER(x)
|
|
|
|
extern void pg_xml_init_library(void);
|
|
extern PgXmlErrorContext *pg_xml_init(PgXmlStrictness strictness);
|
|
extern void pg_xml_done(PgXmlErrorContext *errcxt, bool isError);
|
|
extern bool pg_xml_error_occurred(PgXmlErrorContext *errcxt);
|
|
extern void xml_ereport(PgXmlErrorContext *errcxt, int level, int sqlcode,
|
|
const char *msg);
|
|
|
|
extern xmltype *xmlconcat(List *args);
|
|
extern xmltype *xmlelement(XmlExpr *xexpr,
|
|
const Datum *named_argvalue, const bool *named_argnull,
|
|
const Datum *argvalue, const bool *argnull);
|
|
extern xmltype *xmlparse(text *data, XmlOptionType xmloption_arg, bool preserve_whitespace);
|
|
extern xmltype *xmlpi(const char *target, text *arg, bool arg_is_null, bool *result_is_null);
|
|
extern xmltype *xmlroot(xmltype *data, text *version, int standalone);
|
|
extern bool xml_is_document(xmltype *arg);
|
|
extern text *xmltotext_with_options(xmltype *data, XmlOptionType xmloption_arg,
|
|
bool indent);
|
|
extern char *escape_xml(const char *str);
|
|
|
|
extern char *map_sql_identifier_to_xml_name(const char *ident, bool fully_escaped, bool escape_period);
|
|
extern char *map_xml_name_to_sql_identifier(const char *name);
|
|
extern char *map_sql_value_to_xml_value(Datum value, Oid type, bool xml_escape_strings);
|
|
|
|
extern PGDLLIMPORT int xmlbinary; /* XmlBinaryType, but int for guc enum */
|
|
|
|
extern PGDLLIMPORT int xmloption; /* XmlOptionType, but int for guc enum */
|
|
|
|
extern PGDLLIMPORT const TableFuncRoutine XmlTableRoutine;
|
|
|
|
#endif /* XML_H */
|