diff options
author | Bruce Momjian <bruce@momjian.us> | 1997-09-07 05:04:48 +0000 |
---|---|---|
committer | Bruce Momjian <bruce@momjian.us> | 1997-09-07 05:04:48 +0000 |
commit | 1ccd423235a48739d6f7a4d7889705b5f9ecc69b (patch) | |
tree | 8001c4e839dfad8f29ceda7f8c5f5dbb8759b564 /src/include/lib/fstack.h | |
parent | 8fecd4febf8357f3cc20383ed29ced484877d5ac (diff) | |
download | postgresql-1ccd423235a48739d6f7a4d7889705b5f9ecc69b.tar.gz postgresql-1ccd423235a48739d6f7a4d7889705b5f9ecc69b.zip |
Massive commit to run PGINDENT on all *.c and *.h files.
Diffstat (limited to 'src/include/lib/fstack.h')
-rw-r--r-- | src/include/lib/fstack.h | 96 |
1 files changed, 49 insertions, 47 deletions
diff --git a/src/include/lib/fstack.h b/src/include/lib/fstack.h index de2868142a3..99f10b9006c 100644 --- a/src/include/lib/fstack.h +++ b/src/include/lib/fstack.h @@ -1,112 +1,114 @@ /*------------------------------------------------------------------------- * * fstack.h-- - * Fixed format stack definitions. + * Fixed format stack definitions. * * * Copyright (c) 1994, Regents of the University of California * - * $Id: fstack.h,v 1.2 1996/10/31 09:48:46 scrappy Exp $ + * $Id: fstack.h,v 1.3 1997/09/07 04:58:09 momjian Exp $ * *------------------------------------------------------------------------- */ /* * Note: - * Fixed format stacks assist in the construction of FIFO stacks of - * fixed format structures. Structures which are to be stackable - * should contain a FixedItemData component. A stack is initilized - * with the offset of the FixedItemData component of the structure - * it will hold. By doing so, push and pop operations are simplified - * for the callers. All references to stackable items are pointers - * to the base of the structure instead of pointers to the - * FixedItemData component. + * Fixed format stacks assist in the construction of FIFO stacks of + * fixed format structures. Structures which are to be stackable + * should contain a FixedItemData component. A stack is initilized + * with the offset of the FixedItemData component of the structure + * it will hold. By doing so, push and pop operations are simplified + * for the callers. All references to stackable items are pointers + * to the base of the structure instead of pointers to the + * FixedItemData component. * */ -#ifndef FSTACK_H +#ifndef FSTACK_H #define FSTACK_H /* * FixedItem -- - * Fixed format stackable item chain component. + * Fixed format stackable item chain component. * * Note: - * Structures must contain one FixedItemData component per stack in - * which it will be an item. + * Structures must contain one FixedItemData component per stack in + * which it will be an item. */ -typedef struct FixedItemData FixedItemData; -typedef FixedItemData *FixedItem; +typedef struct FixedItemData FixedItemData; +typedef FixedItemData *FixedItem; -struct FixedItemData { - FixedItem next; /* next item or NULL */ +struct FixedItemData +{ + FixedItem next; /* next item or NULL */ }; /* * FixedStack -- - * Fixed format stack. + * Fixed format stack. */ -typedef struct FixedStackData { - FixedItem top; /* Top item on the stack or NULL */ - Offset offset; /* Offset from struct base to item */ +typedef struct FixedStackData +{ + FixedItem top; /* Top item on the stack or NULL */ + Offset offset; /* Offset from struct base to item */ /* this could be signed short int! */ -} FixedStackData; +} FixedStackData; -typedef FixedStackData *FixedStack; +typedef FixedStackData *FixedStack; /* * FixedStackInit -- - * Iniitializes stack for structures with given fixed component offset. + * Iniitializes stack for structures with given fixed component offset. * * Exceptions: - * BadArg if stack is invalid pointer. + * BadArg if stack is invalid pointer. */ -extern void FixedStackInit(FixedStack stack, Offset offset); +extern void FixedStackInit(FixedStack stack, Offset offset); /* * FixedStackPop -- - * Returns pointer to top structure on stack or NULL if empty stack. + * Returns pointer to top structure on stack or NULL if empty stack. * * Exceptions: - * BadArg if stack is invalid. + * BadArg if stack is invalid. */ -Pointer FixedStackPop(FixedStack stack); +Pointer FixedStackPop(FixedStack stack); /* * FixedStackPush -- - * Places structure associated with pointer onto top of stack. + * Places structure associated with pointer onto top of stack. * * Exceptions: - * BadArg if stack is invalid. - * BadArg if pointer is invalid. + * BadArg if stack is invalid. + * BadArg if pointer is invalid. */ -extern void FixedStackPush(FixedStack stack, Pointer pointer); +extern void FixedStackPush(FixedStack stack, Pointer pointer); /* * FixedStackGetTop -- - * Returns pointer to top structure of a stack. This item is not poped. + * Returns pointer to top structure of a stack. This item is not poped. * * Note: - * This is not part of the normal stack interface. It is intended for - * debugging use only. + * This is not part of the normal stack interface. It is intended for + * debugging use only. * * Exceptions: - * BadArg if stack is invalid. + * BadArg if stack is invalid. */ -extern Pointer FixedStackGetTop(FixedStack stack); +extern Pointer FixedStackGetTop(FixedStack stack); /* * FixedStackGetNext -- - * Returns pointer to next structure after pointer of a stack. + * Returns pointer to next structure after pointer of a stack. * * Note: - * This is not part of the normal stack interface. It is intended for - * debugging use only. + * This is not part of the normal stack interface. It is intended for + * debugging use only. * * Exceptions: - * BadArg if stack is invalid. - * BadArg if pointer is invalid. - * BadArg if stack does not contain pointer. + * BadArg if stack is invalid. + * BadArg if pointer is invalid. + * BadArg if stack does not contain pointer. */ -extern Pointer FixedStackGetNext(FixedStack stack, Pointer pointer); +extern Pointer FixedStackGetNext(FixedStack stack, Pointer pointer); -#endif /* FSTACK_H */ +#endif /* FSTACK_H */ |