This is postgres.h in view mode; [Download] [Up]
/*-------------------------------------------------------------------------
*
* postgres.h--
* definition of (and support for) postgres system types.
*
*
* Copyright (c) 1994, Regents of the University of California
*
* postgres.h,v 1.7 1995/05/02 00:03:44 jolly Exp
*
*-------------------------------------------------------------------------
*/
/*
* NOTES
* this file will eventually contain the definitions for the
* following (and perhaps other) system types:
*
* bool bytea char
* char16 dt int2
* int28 int4 oid
* oid8 regproc text
* char8
* func_ptr
*
* Currently this file is also the home of struct varlena and
* some other stuff. Some of this may change. -cim 8/6/90
*
* TABLE OF CONTENTS
* 1) simple type definitions
* 1a) oid types (currently being reorganized)
* 2) array types
* 3) name type + support macros \
* 4) datum type + support macros \ being reorganized
* 5) xid type + support macros /
* 6) genbki macros used by catalog/pg_xxx.h files
* 7) old types being obsoleted
* 8) random SIGNBIT, PSIZE, MAXPGPATH, STATUS macros
*
* ----------------------------------------------------------------
*/
#ifndef POSTGRES_H
#define POSTGRES_H
#include "c.h"
/* ----------------------------------------------------------------
* Section 1: simple type definitions
* ----------------------------------------------------------------
*/
/* ----------------
* bool
*
* this is defined in c.h at present, but that will change soon.
* Boolean should be obsoleted.
* ----------------
*/
/* XXX put bool here */
/* ----------------
* dt
* ----------------
*/
typedef int32 dt;
/* ----------------
* int2
* ----------------
*/
typedef int16 int2;
/* ----------------
* int4
* ----------------
*/
typedef int32 int4;
/* ----------------
* float4
* ----------------
*/
typedef float float4;
/* ----------------
* float8
* ----------------
*/
typedef double float8;
/* ptr to func returning (char *) */
typedef char * ((*func_ptr)());
/* ----------------------------------------------------------------
* Section 1a: oid types
* ----------------------------------------------------------------
*/
/* ----------------
* oid
* ----------------
*/
typedef uint32 Oid;
#define InvalidOid 0
#define OidIsValid(objectId) \
((bool) (objectId != InvalidOid))
/* ----------------
* regproc
* ----------------
*/
typedef Oid regproc;
typedef Oid RegProcedure;
#define RegProcedureIsValid(p) OidIsValid(p)
/* ----------------------------------------------------------------
* Section 2: array types
* ----------------------------------------------------------------
*/
/* ----------------
* struct varlena
* ----------------
*/
struct varlena {
int32 vl_len;
char vl_dat[1];
};
#define VARSIZE(PTR) (((struct varlena *)(PTR))->vl_len)
#define VARDATA(PTR) (((struct varlena *)(PTR))->vl_dat)
#define VARHDRSZ sizeof(int32)
/* ----------------
* aclitem
* ----------------
*/
typedef int4 aclitem;
/* ----------------
* bytea
* ----------------
*/
typedef struct varlena bytea;
/* ----------------
* char8
* ----------------
*/
typedef struct char8 {
char data[8];
} char8;
typedef char8 *Char8;
/* ----------------
* char16
* ----------------
*/
typedef struct char16 {
char data[16];
} char16;
typedef char16 *Char16;
/* ----------------
* int28
* ----------------
*/
typedef int2 int28[8];
/* ----------------
* oid8
* ----------------
*/
typedef Oid oid8[8];
/* ----------------
* text
* ----------------
*/
typedef struct varlena text;
/* ----------------
* stub
*
* this is a new system type used by the rule manager.
* ----------------
*/
typedef struct varlena stub;
/* ----------------
* oidint4
*
* this is a new system type used by the file interface.
* ----------------
*/
typedef struct OidInt4Data {
Oid oi_oid;
int32 oi_int4;
} OidInt4Data;
typedef struct OidInt4Data *OidInt4;
/* ----------------
* oidint2
*
* this is a new system type used to define indices on two attrs.
* ----------------
*/
typedef struct OidInt2Data {
Oid oi_oid;
int16 oi_int2;
} OidInt2Data;
typedef struct OidInt2Data *OidInt2;
/* ----------------
* oidchar16
*
* this is a new system type used to define indices on two attrs.
* ----------------
*/
typedef struct OidChar16Data {
Oid id;
char16 name;
} OidChar16Data;
typedef struct OidChar16Data *OidChar16;
/* ----------------------------------------------------------------
* Section 3: name type + support macros
* ----------------------------------------------------------------
*/
/* ----------------
* name
*
* definition of the catalog/system "name" data type.
* This is used by some of the access method and catalog
* support code.
* ----------------
*/
typedef char16 NameData;
typedef NameData *Name;
#define InvalidName ((Name) NULL)
#define NameIsValid(name) PointerIsValid(name)
/* maximum string length of a Name */
#define NAMEDATALEN 16
/* ----------------------------------------------------------------
* Section 4: datum type + support macros
* ----------------------------------------------------------------
*/
/*
* datum.h --
* POSTGRES abstract data type datum representation definitions.
*
* Note:
*
* Port Notes:
* Postgres makes the following assumption about machines:
*
* sizeof(Datum) == sizeof(long) >= sizeof(void *) >= 4
*
* Postgres also assumes that
*
* sizeof(char) == 1
*
* and that
*
* sizeof(short) == 2
*
* If your machine meets these requirements, Datums should also be checked
* to see if the positioning is correct.
*
* This file is MACHINE AND COMPILER dependent!!!
*/
typedef unsigned long Datum; /* XXX sizeof(long) >= sizeof(void *) */
typedef Datum * DatumPtr;
#define GET_1_BYTE(datum) (((Datum) (datum)) & 0x000000ff)
#define GET_2_BYTES(datum) (((Datum) (datum)) & 0x0000ffff)
#define GET_4_BYTES(datum) (((Datum) (datum)) & 0xffffffff)
#define SET_1_BYTE(value) (((Datum) (value)) & 0x000000ff)
#define SET_2_BYTES(value) (((Datum) (value)) & 0x0000ffff)
#define SET_4_BYTES(value) (((Datum) (value)) & 0xffffffff)
/*
* DatumGetChar --
* Returns character value of a datum.
*/
#define DatumGetChar(X) ((char) GET_1_BYTE(X))
/*
* CharGetDatum --
* Returns datum representation for a character.
*/
#define CharGetDatum(X) ((Datum) SET_1_BYTE(X))
/*
* DatumGetInt8 --
* Returns 8-bit integer value of a datum.
*/
#define DatumGetInt8(X) ((int8) GET_1_BYTE(X))
/*
* Int8GetDatum --
* Returns datum representation for an 8-bit integer.
*/
#define Int8GetDatum(X) ((Datum) SET_1_BYTE(X))
/*
* DatumGetUInt8 --
* Returns 8-bit unsigned integer value of a datum.
*/
#define DatumGetUInt8(X) ((uint8) GET_1_BYTE(X))
/*
* UInt8GetDatum --
* Returns datum representation for an 8-bit unsigned integer.
*/
#define UInt8GetDatum(X) ((Datum) SET_1_BYTE(X))
/*
* DatumGetInt16 --
* Returns 16-bit integer value of a datum.
*/
#define DatumGetInt16(X) ((int16) GET_2_BYTES(X))
/*
* Int16GetDatum --
* Returns datum representation for a 16-bit integer.
*/
#define Int16GetDatum(X) ((Datum) SET_2_BYTES(X))
/*
* DatumGetUInt16 --
* Returns 16-bit unsigned integer value of a datum.
*/
#define DatumGetUInt16(X) ((uint16) GET_2_BYTES(X))
/*
* UInt16GetDatum --
* Returns datum representation for a 16-bit unsigned integer.
*/
#define UInt16GetDatum(X) ((Datum) SET_2_BYTES(X))
/*
* DatumGetInt32 --
* Returns 32-bit integer value of a datum.
*/
#define DatumGetInt32(X) ((int32) GET_4_BYTES(X))
/*
* Int32GetDatum --
* Returns datum representation for a 32-bit integer.
*/
#define Int32GetDatum(X) ((Datum) SET_4_BYTES(X))
/*
* DatumGetUInt32 --
* Returns 32-bit unsigned integer value of a datum.
*/
#define DatumGetUInt32(X) ((uint32) GET_4_BYTES(X))
/*
* UInt32GetDatum --
* Returns datum representation for a 32-bit unsigned integer.
*/
#define UInt32GetDatum(X) ((Datum) SET_4_BYTES(X))
/*
* DatumGetObjectId --
* Returns object identifier value of a datum.
*/
#define DatumGetObjectId(X) ((Oid) GET_4_BYTES(X))
/*
* ObjectIdGetDatum --
* Returns datum representation for an object identifier.
*/
#define ObjectIdGetDatum(X) ((Datum) SET_4_BYTES(X))
/*
* DatumGetPointer --
* Returns pointer value of a datum.
*/
#define DatumGetPointer(X) ((Pointer) X)
/*
* PointerGetDatum --
* Returns datum representation for a pointer.
*/
#define PointerGetDatum(X) ((Datum) X)
/*
* DatumGetStructPointer --
* Returns pointer to structure value of a datum.
*/
#define DatumGetStructPointer(X) ((AnyStruct *) X)
/*
* StructPointerGetDatum --
* Returns datum representation for a pointer to structure.
*/
#define StructPointerGetDatum(X) ((Datum) X)
/*
* DatumGetName --
* Returns name value of a datum.
*/
#define DatumGetName(X) ((Name) DatumGetPointer((Datum) X))
/*
* NameGetDatum --
* Returns datum representation for a name.
*/
#define NameGetDatum(X) PointerGetDatum((Pointer) X)
/*
* DatumGetFloat32 --
* Returns 32-bit floating point value of a datum.
* This is really a pointer, of course.
*/
#define DatumGetFloat32(X) ((float32) DatumGetPointer((Datum) X))
/*
* Float32GetDatum --
* Returns datum representation for a 32-bit floating point number.
* This is really a pointer, of course.
*/
#define Float32GetDatum(X) PointerGetDatum((Pointer) X)
/*
* DatumGetFloat64 --
* Returns 64-bit floating point value of a datum.
* This is really a pointer, of course.
*/
#define DatumGetFloat64(X) ((float64) DatumGetPointer(X))
/*
* Float64GetDatum --
* Returns datum representation for a 64-bit floating point number.
* This is really a pointer, of course.
*/
#define Float64GetDatum(X) PointerGetDatum((Pointer) X)
/* ----------------------------------------------------------------
* Section 5: xid type + support macros
* ----------------------------------------------------------------
*/
/*
* TransactionId definition
*/
typedef uint32 TransactionId;
#define InvalidTransactionId 0
typedef uint16 CommandId;
#define FirstCommandId 0
#define TransactionMultiplierPerByte (1 << BitsPerByte)
#define TransactionsPerSecondAdjustment TransactionMultiplierPerByte
/* ----------------------------------------------------------------
* Section 6: genbki macros used by the
* catalog/pg_xxx.h files
* ----------------------------------------------------------------
*/
#define CATALOG(x) \
typedef struct CppConcat(FormData_,x)
#define DATA(x) extern int errno
#define DECLARE_INDEX(x) extern int errno
#define BUILD_INDICES
#define BOOTSTRAP
#define BKI_BEGIN
#define BKI_END
/* ----------------------------------------------------------------
* Section 7: old types being obsoleted
* ----------------------------------------------------------------
*/
typedef char *DATUM;
/* ----------------------------------------------------------------
* Section 8: random stuff
* SIGNBIT, PSIZE, MAXPGPATH, STATUS...
* ----------------------------------------------------------------
*/
/* msb for int/unsigned */
#define SIGNBIT (0x8000)
/* msb for char */
#define CSIGNBIT (1 << 7)
/* ----------------
* PSIZE
* ----------------
*/
#define PSIZE(PTR) (*((int32 *)(PTR) - 1))
#define PSIZEALL(PTR) (*((int32 *)(PTR) - 1) + sizeof (int32))
#define PSIZESKIP(PTR) ((char *)((int32 *)(PTR) + 1))
#define PSIZEFIND(PTR) ((char *)((int32 *)(PTR) - 1))
#define PSIZESPACE(LEN) ((LEN) + sizeof (int32))
/* ----------------
* global variable which should probably go someplace else.
* ----------------
*/
#define MAXPGPATH 128
#define STATUS_OK (0)
#define STATUS_ERROR (-1)
#define STATUS_NOT_FOUND (-2)
#define STATUS_INVALID (-3)
#define STATUS_UNCATALOGUED (-4)
#define STATUS_REPLACED (-5)
#define STATUS_NOT_DONE (-6)
#define STATUS_BAD_PACKET (-7)
#define STATUS_FOUND (1)
/*
* The following is a gimmick to pass functions that return void as
* paramters to other functions. This type defined here is used as
* the cast.
*/
typedef Pointer (*VoidFunctionType)();
/* ----------------------------------------------------------------
* externs
*
* This should be eliminated or moved elsewhere
* ----------------------------------------------------------------
*/
/* not cleaned up yet-- ay */
extern bool NameIsEqual(Name name1, Name name2);
extern uint32 NameComputeLength(Name name);
/*
extern TransactionId NullTransactionId;
extern TransactionId AmiTransactionId;
extern TransactionId FirstTransactionId;
-- moved to access/transam.h */
extern void GetNewTransactionId(TransactionId *xid);
extern TransactionId StringFormTransactionId(String representation);
extern String TransactionIdFormString(TransactionId transactionId);
extern void TransactionIdStore
(TransactionId transactionId, TransactionId *destination);
extern void StoreInvalidTransactionId(TransactionId *destination);
extern bool TransactionIdEquals(TransactionId id1,TransactionId id2);
extern bool TransactionIdIsLessThan (TransactionId id1, TransactionId id2);
/* extern bool TransactionIdValueIsValid(TransactionIdValue value); */
extern void TransactionIdIncrement(TransactionId *transactionId);
/* ----------------
* end of postgres.h
* ----------------
*/
#endif /* POSTGRES_H */
These are the contents of the former NiCE NeXT User Group NeXTSTEP/OpenStep software archive, currently hosted by Netfuture.ch.