summaryrefslogtreecommitdiff
path: root/src/include
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2002-08-25 17:20:01 +0000
committerTom Lane <tgl@sss.pgh.pa.us>2002-08-25 17:20:01 +0000
commit58de480999da65ec0fbf256f17800cba89e26dd5 (patch)
treeff80d7c93f5836bbdfdc0b3c6a5165423856cb83 /src/include
parentd46172e4fa930e18768b8b913166108a4909e858 (diff)
Clean up comments to be careful about the distinction between variable-
width types and varlena types, since with the introduction of CSTRING as a more-or-less-real type, these concepts aren't identical. I've tried to use varlena consistently to denote datatypes with typlen = -1, ie, they have a length word and are potentially TOASTable; while the term variable width covers both varlena and cstring (and, perhaps, someday other types with other rules for computing the actual width). No code changes in this commit except for renaming a couple macros.
Diffstat (limited to 'src/include')
-rw-r--r--src/include/access/htup.h7
-rw-r--r--src/include/access/itup.h6
-rw-r--r--src/include/c.h35
-rw-r--r--src/include/catalog/pg_statistic.h4
-rw-r--r--src/include/postgres.h20
5 files changed, 35 insertions, 37 deletions
diff --git a/src/include/access/htup.h b/src/include/access/htup.h
index 5da1c3608ed..f1d9748f5c5 100644
--- a/src/include/access/htup.h
+++ b/src/include/access/htup.h
@@ -7,7 +7,7 @@
* Portions Copyright (c) 1996-2002, PostgreSQL Global Development Group
* Portions Copyright (c) 1994, Regents of the University of California
*
- * $Id: htup.h,v 1.57 2002/07/20 05:16:59 momjian Exp $
+ * $Id: htup.h,v 1.58 2002/08/25 17:20:01 tgl Exp $
*
*-------------------------------------------------------------------------
*/
@@ -95,8 +95,7 @@ typedef HeapTupleHeaderData *HeapTupleHeader;
* information stored in t_infomask:
*/
#define HEAP_HASNULL 0x0001 /* has null attribute(s) */
-#define HEAP_HASVARLENA 0x0002 /* has variable length
- * attribute(s) */
+#define HEAP_HASVARWIDTH 0x0002 /* has variable-width attribute(s) */
#define HEAP_HASEXTERNAL 0x0004 /* has external stored
* attribute(s) */
#define HEAP_HASCOMPRESSED 0x0008 /* has compressed stored
@@ -425,7 +424,7 @@ typedef HeapTupleData *HeapTuple;
(!(((HeapTuple) (tuple))->t_data->t_infomask & HEAP_HASNULL))
#define HeapTupleAllFixed(tuple) \
- (!(((HeapTuple) (tuple))->t_data->t_infomask & HEAP_HASVARLENA))
+ (!(((HeapTuple) (tuple))->t_data->t_infomask & HEAP_HASVARWIDTH))
#define HeapTupleHasExternal(tuple) \
((((HeapTuple)(tuple))->t_data->t_infomask & HEAP_HASEXTERNAL) != 0)
diff --git a/src/include/access/itup.h b/src/include/access/itup.h
index 16ad3db65a4..2978c398cd6 100644
--- a/src/include/access/itup.h
+++ b/src/include/access/itup.h
@@ -7,7 +7,7 @@
* Portions Copyright (c) 1996-2002, PostgreSQL Global Development Group
* Portions Copyright (c) 1994, Regents of the University of California
*
- * $Id: itup.h,v 1.35 2002/06/20 20:29:43 momjian Exp $
+ * $Id: itup.h,v 1.36 2002/08/25 17:20:01 tgl Exp $
*
*-------------------------------------------------------------------------
*/
@@ -28,7 +28,7 @@ typedef struct IndexTupleData
* t_info is layed out in the following fashion:
*
* 15th (high) bit: has nulls
- * 14th bit: has varlenas
+ * 14th bit: has var-width attributes
* 13th bit: unused
* 12-0 bit: size of tuple
* ---------------
@@ -67,7 +67,7 @@ typedef InsertIndexResultData *InsertIndexResult;
#define IndexTupleSize(itup) ((Size) (((IndexTuple) (itup))->t_info & INDEX_SIZE_MASK))
#define IndexTupleDSize(itup) ((Size) ((itup).t_info & INDEX_SIZE_MASK))
#define IndexTupleHasNulls(itup) ((((IndexTuple) (itup))->t_info & INDEX_NULL_MASK))
-#define IndexTupleHasVarlenas(itup) ((((IndexTuple) (itup))->t_info & INDEX_VAR_MASK))
+#define IndexTupleHasVarwidths(itup) ((((IndexTuple) (itup))->t_info & INDEX_VAR_MASK))
#define IndexTupleHasMinHeader(itup) (!IndexTupleHasNulls(itup))
diff --git a/src/include/c.h b/src/include/c.h
index bfae5536a59..96a568712dc 100644
--- a/src/include/c.h
+++ b/src/include/c.h
@@ -4,15 +4,15 @@
* Fundamental C definitions. This is included by every .c file in
* PostgreSQL (via either postgres.h or postgres_fe.h, as appropriate).
*
- * Note that the definitions here are not intended to be exposed to clients of
- * the frontend interface libraries --- so we don't worry much about polluting
- * the namespace with lots of stuff...
+ * Note that the definitions here are not intended to be exposed to clients
+ * of the frontend interface libraries --- so we don't worry much about
+ * polluting the namespace with lots of stuff...
*
*
* Portions Copyright (c) 1996-2002, PostgreSQL Global Development Group
* Portions Copyright (c) 1994, Regents of the University of California
*
- * $Id: c.h,v 1.122 2002/08/21 17:20:58 petere Exp $
+ * $Id: c.h,v 1.123 2002/08/25 17:20:01 tgl Exp $
*
*-------------------------------------------------------------------------
*/
@@ -36,18 +36,19 @@
* 8) system-specific hacks
*
* NOTE: since this file is included by both frontend and backend modules, it's
- * almost certainly wrong to put an "extern" declaration here. typedefs and macros
- * are the kind of thing that might go here.
+ * almost certainly wrong to put an "extern" declaration here. typedefs and
+ * macros are the kind of thing that might go here.
*
*----------------------------------------------------------------
*/
#ifndef C_H
#define C_H
-/* We have to include stdlib.h here because it defines many of these macros
- on some platforms, and we only want our definitions used if stdlib.h doesn't
- have its own. The same goes for stddef and stdarg if present.
-*/
+/*
+ * We have to include stdlib.h here because it defines many of these macros
+ * on some platforms, and we only want our definitions used if stdlib.h doesn't
+ * have its own. The same goes for stddef and stdarg if present.
+ */
#include "pg_config.h"
#include "postgres_ext.h"
@@ -387,10 +388,11 @@ typedef struct
/* ----------------
* Variable-length datatypes all share the 'struct varlena' header.
*
- * NOTE: for TOASTable types, this is an oversimplification, since the value may be
- * compressed or moved out-of-line. However datatype-specific routines are mostly
- * content to deal with de-TOASTed values only, and of course client-side routines
- * should never see a TOASTed value. See postgres.h for details of the TOASTed form.
+ * NOTE: for TOASTable types, this is an oversimplification, since the value
+ * may be compressed or moved out-of-line. However datatype-specific routines
+ * are mostly content to deal with de-TOASTed values only, and of course
+ * client-side routines should never see a TOASTed value. See postgres.h for
+ * details of the TOASTed form.
* ----------------
*/
struct varlena
@@ -662,9 +664,4 @@ extern int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
#define memmove(d, s, c) bcopy(s, d, c)
#endif
-/* ----------------
- * end of c.h
- * ----------------
- */
-
#endif /* C_H */
diff --git a/src/include/catalog/pg_statistic.h b/src/include/catalog/pg_statistic.h
index 7e0c0500daf..478a730e925 100644
--- a/src/include/catalog/pg_statistic.h
+++ b/src/include/catalog/pg_statistic.h
@@ -8,7 +8,7 @@
* Portions Copyright (c) 1996-2002, PostgreSQL Global Development Group
* Portions Copyright (c) 1994, Regents of the University of California
*
- * $Id: pg_statistic.h,v 1.16 2002/06/20 20:29:49 momjian Exp $
+ * $Id: pg_statistic.h,v 1.17 2002/08/25 17:20:01 tgl Exp $
*
* NOTES
* the genbki.sh script reads this file and generates .bki
@@ -43,7 +43,7 @@ CATALOG(pg_statistic) BKI_WITHOUT_OIDS
/*
* stawidth is the average width in bytes of non-null entries. For
* fixed-width datatypes this is of course the same as the typlen, but
- * for varlena types it is more useful. Note that this is the average
+ * for var-width types it is more useful. Note that this is the average
* width of the data as actually stored, post-TOASTing (eg, for a
* moved-out-of-line value, only the size of the pointer object is
* counted). This is the appropriate definition for the primary use
diff --git a/src/include/postgres.h b/src/include/postgres.h
index c509daf0611..04451d794ad 100644
--- a/src/include/postgres.h
+++ b/src/include/postgres.h
@@ -10,7 +10,7 @@
* Portions Copyright (c) 1996-2002, PostgreSQL Global Development Group
* Portions Copyright (c) 1995, Regents of the University of California
*
- * $Id: postgres.h,v 1.59 2002/08/10 20:29:18 momjian Exp $
+ * $Id: postgres.h,v 1.60 2002/08/25 17:20:01 tgl Exp $
*
*-------------------------------------------------------------------------
*/
@@ -30,14 +30,15 @@
*
* NOTES
*
- * In general, this file should contain declarations that are widely needed in the
- * backend environment, but are of no interest outside the backend.
+ * In general, this file should contain declarations that are widely needed
+ * in the backend environment, but are of no interest outside the backend.
*
- * Simple type definitions live in c.h, where they are shared with postgres_fe.h.
- * We do that since those type definitions are needed by frontend modules that want
- * to deal with binary data transmission to or from the backend. Type definitions
- * in this file should be for representations that never escape the backend, such
- * as Datum or TOASTed varlena objects.
+ * Simple type definitions live in c.h, where they are shared with
+ * postgres_fe.h. We do that since those type definitions are needed by
+ * frontend modules that want to deal with binary data transmission to or
+ * from the backend. Type definitions in this file should be for
+ * representations that never escape the backend, such as Datum or
+ * TOASTed varlena objects.
*
*----------------------------------------------------------------
*/
@@ -54,7 +55,8 @@
*/
/* ----------------
- * struct varattrib is the header of a varlena object that may have been TOASTed.
+ * struct varattrib is the header of a varlena object that may have been
+ * TOASTed.
* ----------------
*/
#define TUPLE_TOASTER_ACTIVE