header-pre.hxx File Reference

#include "pqxx/config-compiler.h"

Include dependency graph for header-pre.hxx:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	PQXX_HEADER_PRE
#define	PQXX_CPLUSPLUS   __cplusplus
#define	PQXX_PURE   /* pure */
#define	PQXX_COLD   /* cold */
#define	PQXX_INLINE_ONLY   /* always inline */
#define	PQXX_INLINE_COV   /* inline-only on coverage runs */
	Don't generate out-of-line version of inline function for coverage runs. More...
#define	PQXX_NOINLINE   /* noinline */
	Never inline this function. More...
#define	PQXX_RETURNS_NONNULL   /* returns nonnull */
#define	PQXX_ZARG(n)   /* null-terminated string arg */
#define	PQXX_ZARGS   /* null-terminated string args */
#define	PQXX_LIBEXPORT   [[gnu::visibility("default")]]
#define	PQXX_PRIVATE   [[gnu::visibility("hidden")]]
#define	PQXX_NOVTABLE   /* novtable */
#define	PQXX_ASSUME(condition)   while (false)

Macro Definition Documentation

PQXX_ASSUME

#define PQXX_ASSUME

(

condition

)

while (false)

PQXX_COLD

#define PQXX_COLD   /* cold */

PQXX_CPLUSPLUS

#define PQXX_CPLUSPLUS   __cplusplus

PQXX_HEADER_PRE

#define PQXX_HEADER_PRE

PQXX_INLINE_COV

#define PQXX_INLINE_COV   /* inline-only on coverage runs */

Don't generate out-of-line version of inline function for coverage runs.

This helps avoid a lot of false positives with gcov. The out-of-line function never gets executed, and so its code is all marked as not covered by the test suite. The code may get executed, but all inline.

We're only defining this for gcc, since that's the compiler we use for test coverage analysis.

PQXX_INLINE_ONLY

#define PQXX_INLINE_ONLY   /* always inline */

PQXX_LIBEXPORT

#define PQXX_LIBEXPORT   [[gnu::visibility("default")]]

PQXX_NOINLINE

#define PQXX_NOINLINE   /* noinline */

Never inline this function.

Bear in mind that this only works for the specific compilers for which we know non-standard attributes that achieve this.

PQXX_NOVTABLE

#define PQXX_NOVTABLE   /* novtable */

PQXX_PRIVATE

#define PQXX_PRIVATE   [[gnu::visibility("hidden")]]

PQXX_PURE

#define PQXX_PURE   /* pure */

PQXX_RETURNS_NONNULL

#define PQXX_RETURNS_NONNULL   /* returns nonnull */

PQXX_ZARG

#define PQXX_ZARG

(

n

)

/* null-terminated string arg */

PQXX_ZARGS

#define PQXX_ZARGS   /* null-terminated string args */