Aren/NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

document CIRCLEQ_LOOP

Browse Source
This commit is contained in:
pooka 2006-03-07 18:13:43 +00:00
parent b28fd3a188
commit cbb99f35f7
2 changed files with 29 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
share/man/man3/Makefile
View File

@ -1,4 +1,4 @@
# $NetBSD: Makefile,v 1.27 2005/09/30 20:55:26 rpaulo Exp $
# $NetBSD: Makefile,v 1.28 2006/03/07 18:13:43 pooka Exp $
# @(#)Makefile 8.2 (Berkeley) 12/13/93
MAN= _DIAGASSERT.3 assert.3 bitstring.3 dlfcn.3 end.3 intro.3 queue.3 \
@ -85,7 +85,9 @@ MLINKS+=queue.3 CIRCLEQ_HEAD.3 \
queue.3 CIRCLEQ_FIRST.3 \
queue.3 CIRCLEQ_LAST.3 \
queue.3 CIRCLEQ_NEXT.3 \
queue.3 CIRCLEQ_PREV.3
queue.3 CIRCLEQ_PREV.3 \
queue.3 CIRCLEQ_LOOP_NEXT.3 \
queue.3 CIRCLEQ_LOOP_PREV.3
MLINKS+=stdarg.3 va_arg.3 stdarg.3 va_copy.3 \
stdarg.3 va_end.3 stdarg.3 va_start.3
MLINKS+=dlfcn.3 dlopen.3 dlfcn.3 dlclose.3 dlfcn.3 dlsym.3 dlfcn.3 dlctl.3 \

28
share/man/man3/queue.3
View File

@ -1,4 +1,4 @@
.\" $NetBSD: queue.3,v 1.32 2005/12/15 11:41:58 pooka Exp $
.\" $NetBSD: queue.3,v 1.33 2006/03/07 18:13:43 pooka Exp $
.\"
.\" Copyright (c) 2000, 2002 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -60,7 +60,7 @@
.\"
.\" @(#)queue.3 8.1 (Berkeley) 12/13/93
.\"
.Dd April 18, 2004
.Dd March 7, 2006
.Dt QUEUE 3
.Os
.Sh NAME
@ -145,7 +145,9 @@
.Nm CIRCLEQ_FIRST ,
.Nm CIRCLEQ_LAST ,
.Nm CIRCLEQ_NEXT ,
.Nm CIRCLEQ_PREV
.Nm CIRCLEQ_PREV ,
.Nm CIRCLEQ_LOOP_NEXT ,
.Nm CIRCLEQ_LOOP_PREV
.Nd "implementations of singly-linked lists, simple queues, lists, tail queues, and circular queues"
.Sh SYNOPSIS
.In sys/queue.h
@ -259,6 +261,10 @@
.Fn CIRCLEQ_NEXT "TYPE *elm" "CIRCLEQ_ENTRY NAME"
.Ft TYPE *
.Fn CIRCLEQ_PREV "TYPE *elm" "CIRCLEQ_ENTRY NAME"
.Ft TYPE *
.Fn CIRCLEQ_LOOP_NEXT "CIRCLEQ_HEAD *head" "TYPE *elm" "CIRCLEQ_ENTRY NAME"
.Ft TYPE *
.Fn CIRCLEQ_LOOP_PREV "CIRCLEQ_HEAD *head" "TYPE *elm" "CIRCLEQ_ENTRY NAME"
.Sh DESCRIPTION
These macros define and operate on five types of data structures:
singly-linked lists, simple queues, lists, tail queues, and circular queues.
@ -1074,6 +1080,22 @@ The macro
.Nm CIRCLEQ_PREV
returns the element before the element
.Fa elm .
.Pp
The macro
.Nm CIRCLEQ_LOOP_NEXT
returns the element after the element
.Fa elm .
If
.Fa elm
was the last element in the queue, the first element is returned.
.Pp
The macro
.Nm CIRCLEQ_LOOP_PREV
returns the element before the element
.Fa elm .
If
.Fa elm
was the first element in the queue, the last element is returned.
.Sh CIRCULAR QUEUE EXAMPLE
.Bd -literal
CIRCLEQ_HEAD(circleq, entry) head;