diff options
Diffstat (limited to '')
| -rw-r--r-- | man3/circleq.3 | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/man3/circleq.3 b/man3/circleq.3 index c03ab16..47b8213 100644 --- a/man3/circleq.3 +++ b/man3/circleq.3 @@ -5,7 +5,7 @@ .\" SPDX-License-Identifier: BSD-3-Clause .\" .\" -.TH CIRCLEQ 3 2023-05-03 "Linux man-pages 6.05.01" +.TH CIRCLEQ 3 2023-10-31 "Linux man-pages 6.7" .SH NAME CIRCLEQ_EMPTY, CIRCLEQ_ENTRY, @@ -32,15 +32,15 @@ Standard C library .SH SYNOPSIS .nf .B #include <sys/queue.h> -.PP +.P .B CIRCLEQ_ENTRY(TYPE); -.PP +.P .B CIRCLEQ_HEAD(HEADNAME, TYPE); .BI "CIRCLEQ_HEAD CIRCLEQ_HEAD_INITIALIZER(CIRCLEQ_HEAD " head ); .BI "void CIRCLEQ_INIT(CIRCLEQ_HEAD *" head ); -.PP +.P .BI "int CIRCLEQ_EMPTY(CIRCLEQ_HEAD *" head ); -.PP +.P .BI "void CIRCLEQ_INSERT_HEAD(CIRCLEQ_HEAD *" head , .BI " struct TYPE *" elm ", CIRCLEQ_ENTRY " NAME ); .BI "void CIRCLEQ_INSERT_TAIL(CIRCLEQ_HEAD *" head , @@ -49,7 +49,7 @@ Standard C library .BI " struct TYPE *" elm ", CIRCLEQ_ENTRY " NAME ); .BI "void CIRCLEQ_INSERT_AFTER(CIRCLEQ_HEAD *" head ", struct TYPE *" listelm , .BI " struct TYPE *" elm ", CIRCLEQ_ENTRY " NAME ); -.PP +.P .BI "struct TYPE *CIRCLEQ_FIRST(CIRCLEQ_HEAD *" head ); .BI "struct TYPE *CIRCLEQ_LAST(CIRCLEQ_HEAD *" head ); .BI "struct TYPE *CIRCLEQ_PREV(struct TYPE *" elm ", CIRCLEQ_ENTRY " NAME ); @@ -58,18 +58,18 @@ Standard C library .BI " struct TYPE *" elm ", CIRCLEQ_ENTRY " NAME ); .BI "struct TYPE *CIRCLEQ_LOOP_NEXT(CIRCLEQ_HEAD *" head , .BI " struct TYPE *" elm ", CIRCLEQ_ENTRY " NAME ); -.PP +.P .BI "CIRCLEQ_FOREACH(struct TYPE *" var ", CIRCLEQ_HEAD *" head , .BI " CIRCLEQ_ENTRY " NAME ); .BI "CIRCLEQ_FOREACH_REVERSE(struct TYPE *" var ", CIRCLEQ_HEAD *" head , .BI " CIRCLEQ_ENTRY " NAME ); -.PP +.P .BI "void CIRCLEQ_REMOVE(CIRCLEQ_HEAD *" head ", struct TYPE *" elm , .BI " CIRCLEQ_ENTRY " NAME ); .fi .SH DESCRIPTION These macros define and operate on doubly linked circular queues. -.PP +.P In the macro definitions, .I TYPE is the name of a user-defined structure, @@ -99,43 +99,43 @@ or at the end of the queue. A .I CIRCLEQ_HEAD structure is declared as follows: -.PP +.P .in +4 .EX CIRCLEQ_HEAD(HEADNAME, TYPE) head; .EE .in -.PP +.P where .I struct HEADNAME is the structure to be defined, and .I struct TYPE is the type of the elements to be linked into the queue. A pointer to the head of the queue can later be declared as: -.PP +.P .in +4 .EX struct HEADNAME *headp; .EE .in -.PP +.P (The names .I head and .I headp are user selectable.) -.PP +.P .BR CIRCLEQ_ENTRY () declares a structure that connects the elements in the queue. -.PP +.P .BR CIRCLEQ_HEAD_INITIALIZER () evaluates to an initializer for the queue .IR head . -.PP +.P .BR CIRCLEQ_INIT () initializes the queue referenced by .IR head . -.PP +.P .BR CIRCLEQ_EMPTY () evaluates to true if there are no items on the queue. .SS Insertion @@ -143,18 +143,18 @@ evaluates to true if there are no items on the queue. inserts the new element .I elm at the head of the queue. -.PP +.P .BR CIRCLEQ_INSERT_TAIL () inserts the new element .I elm at the end of the queue. -.PP +.P .BR CIRCLEQ_INSERT_BEFORE () inserts the new element .I elm before the element .IR listelm . -.PP +.P .BR CIRCLEQ_INSERT_AFTER () inserts the new element .I elm @@ -163,32 +163,32 @@ after the element .SS Traversal .BR CIRCLEQ_FIRST () returns the first item on the queue. -.PP +.P .BR CIRCLEQ_LAST () returns the last item on the queue. -.PP +.P .BR CIRCLEQ_PREV () returns the previous item on the queue, or .I &head if this item is the first one. -.PP +.P .BR CIRCLEQ_NEXT () returns the next item on the queue, or .I &head if this item is the last one. -.PP +.P .BR CIRCLEQ_LOOP_PREV () returns the previous item on the queue. If .I elm is the first element on the queue, the last element is returned. -.PP +.P .BR CIRCLEQ_LOOP_NEXT () returns the next item on the queue. If .I elm is the last element on the queue, the first element is returned. -.PP +.P .BR CIRCLEQ_FOREACH () traverses the queue referenced by .I head @@ -198,7 +198,7 @@ in the forward direction, assigning each element in turn to is set to .I &head if the loop completes normally, or if there were no elements. -.PP +.P .BR CIRCLEQ_FOREACH_REVERSE () traverses the queue referenced by .I head @@ -214,7 +214,7 @@ from the queue. .BR CIRCLEQ_EMPTY () returns nonzero if the queue is empty, and zero if the queue contains at least one entry. -.PP +.P .BR CIRCLEQ_FIRST (), .BR CIRCLEQ_LAST (), .BR CIRCLEQ_LOOP_PREV (), @@ -223,7 +223,7 @@ and return a pointer to the first, last, previous, or next .I TYPE structure, respectively. -.PP +.P .BR CIRCLEQ_PREV (), and .BR CIRCLEQ_NEXT () @@ -233,7 +233,7 @@ counterparts, except that if the argument is the first or last element, respectively, they return .IR &head . -.PP +.P .BR CIRCLEQ_HEAD_INITIALIZER () returns an initializer that can be assigned to the queue .IR head . |