aboutsummaryrefslogtreecommitdiff
path: root/src/backend/access/attnum.h
blob: 7c999e58e9dd404ca48e125855dd1dd8ed854cc7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/*-------------------------------------------------------------------------
 *
 * attnum.h--
 *    POSTGRES attribute number definitions.
 *
 *
 * Copyright (c) 1994, Regents of the University of California
 *
 * $Id: attnum.h,v 1.1.1.1 1996/07/09 06:21:08 scrappy Exp $
 *
 *-------------------------------------------------------------------------
 */
#ifndef	ATTNUM_H
#define ATTNUM_H

#include "c.h"

/*
 * user defined attribute numbers start at 1.	-ay 2/95
 */
typedef int16		AttrNumber;

#define InvalidAttrNumber	0

/* ----------------
 *	support macros
 * ----------------
 */
/*
 * AttributeNumberIsValid --
 *	True iff the attribute number is valid.
 */
#define AttributeNumberIsValid(attributeNumber) \
    ((bool) ((attributeNumber) != InvalidAttrNumber))

/*
 * AttrNumberIsForUserDefinedAttr --
 *	True iff the attribute number corresponds to an user defined attribute.
 */
#define AttrNumberIsForUserDefinedAttr(attributeNumber) \
    ((bool) ((attributeNumber) > 0))

/*
 * AttrNumberGetAttrOffset --
 *	Returns the attribute offset for an attribute number.
 *
 * Note:
 *	Assumes the attribute number is for an user defined attribute.
 */
#define AttrNumberGetAttrOffset(attNum) \
     (AssertMacro(AttrNumberIsForUserDefinedAttr(attNum)) ? \
      ((attNum - 1)) : 0)

/*
 * AttributeOffsetGetAttributeNumber --
 *	Returns the attribute number for an attribute offset.
 */
#define AttrOffsetGetAttrNumber(attributeOffset) \
     ((AttrNumber) (1 + attributeOffset))

#endif /* ATTNUM_H */