lib/libc/stdlib/insque.3

   1 .\" Copyright (c) 1993 John Brezak
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. The name of the author may be used to endorse or promote products
  13 .\"    derived from this software without specific prior written permission.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\"     $NetBSD: insque.3,v 1.5 2010/04/30 10:24:02 jruoho Exp $
  28 .\"
  29 .Dd April 30, 2010
  30 .Dt INSQUE 3
  31 .Os
  32 .Sh NAME
  33 .Nm insque ,
  34 .Nm remque
  35 .Nd insert/remove element from a queue
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In search.h
  40 .Ft void
  41 .Fn insque "void *elem" "void *pred"
  42 .Ft void
  43 .Fn remque "void *elem"
  44 .Sh DESCRIPTION
  45 .Fn insque
  46 and
  47 .Fn remque
  48 manipulate queues built from doubly linked lists.
  49 The queue can be either circular or linear.
  50 The functions expect their
  51 arguments to point to a structure whose first and second members are
  52 pointers to the next and previous element, respectively.
  53 The
  54 .Fn insque
  55 function also allows the
  56 .Fa pred
  57 argument to be a
  58 .Dv NULL
  59 pointer for the initialization of a new linear list's
  60 head element.
  61 .Sh STANDARDS
  62 The
  63 .Fn insque
  64 and
  65 .Fn remque
  66 functions conform to
  67 .St -p1003.1-2001 .
  68 .Sh HISTORY
  69 The
  70 .Fn insque
  71 and
  72 .Fn remque
  73 are derived from the
  74 .Sq insque
  75 and
  76 .Sq remque
  77 instructions on the
  78 .Tn VAX .
  79 They first appeared in
  80 .Bx 4.2 .