1 .\" Copyright (c) 1989, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" This code is derived from software contributed to Berkeley by
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. All advertising materials mentioning features or use of this software
15 .\" must display the following acknowledgement:
16 .\" This product includes software developed by the University of
17 .\" California, Berkeley and its contributors.
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\" may be used to endorse or promote products derived from this software
20 .\" without specific prior written permission.
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .\" @(#)bitstring.3 8.1 (Berkeley) 7/19/93
35 .\" $FreeBSD: src/share/man/man3/bitstring.3,v 1.6.2.5 2001/12/17 11:30:11 ru Exp $
36 .\" $DragonFly: src/share/man/man3/bitstring.3,v 1.2 2003/06/17 04:36:58 dillon Exp $
53 .Nd bit-string manipulation macros
57 .Fn bit_alloc "int nbits"
59 .Fn bit_decl "bitstr_t *name" "int nbits"
61 .Fn bit_clear "bitstr_t *name" "int bit"
63 .Fn bit_ffc "bitstr_t *name" "int nbits" "int *value"
65 .Fn bit_ffs "bitstr_t *name" "int nbits" "int *value"
67 .Fn bit_fls "bitstr_t *name" "int nbits" "int *value"
69 .Fn bit_nclear "bitstr_t *name" "int start" "int stop"
71 .Fn bit_nset "bitstr_t *name" "int start" "int stop"
73 .Fn bit_nsearch "bitstr_t *name" "int nbits" "int *value" "int len"
75 .Fn bit_set "bitstr_t *name" "int bit"
77 .Fn bitstr_size "int nbits"
79 .Fn bit_test "bitstr_t *name" "int bit"
81 These macros operate on strings of bits.
85 returns a pointer of type
87 to sufficient space to store
91 if no space is available.
95 allocates sufficient space to store
101 returns the number of elements of type
106 This is useful for copying bit strings.
112 clear or set the zero-based numbered bit
122 set or clear the zero-based numbered bits from
132 evaluates to non-zero if the zero-based numbered bit
136 is set, and zero otherwise.
141 stores in the location referenced by
143 the zero-based number of the first bit set in the array of
147 If no bits are set, the location referenced by
153 stores in the location referenced by
155 the zero-based number of the first bit not set in the array of
159 If all bits are set, the location referenced by
165 stores in the location referenced by
167 the zero-based number of the highest bit set in array of
174 stores in the location referenced by
176 the zero-based index of a span of clear bits of length
183 The arguments to these macros are evaluated only once and may safely
186 .Bd -literal -offset indent
188 #include <bitstring.h>
191 #define LPR_BUSY_BIT 0
192 #define LPR_FORMAT_BIT 1
193 #define LPR_DOWNLOAD_BIT 2
195 #define LPR_AVAILABLE_BIT 9
196 #define LPR_MAX_BITS 10
200 bitstr_t bit_decl(bitlist, LPR_MAX_BITS);
202 bit_nclear(bitlist, 0, LPR_MAX_BITS - 1);
204 if (!bit_test(bitlist, LPR_BUSY_BIT)) {
205 bit_clear(bitlist, LPR_FORMAT_BIT);
206 bit_clear(bitlist, LPR_DOWNLOAD_BIT);
207 bit_set(bitlist, LPR_AVAILABLE_BIT);
216 functions first appeared in
222 routines first appeared in