xref: /netbsd-src/share/man/man9/scanc.9 (revision 5bbd2a12505d72a8177929a37b5cee489d0a1cfd)
1.\"	$NetBSD: scanc.9,v 1.2 2011/11/01 23:18:07 wiz Exp $
2.\"
3.\" Copyright (c)2011 YAMAMOTO Takashi,
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
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.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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.\" ------------------------------------------------------------
28.Dd November 1, 2011
29.Dt SCANC 9
30.Os
31.\" ------------------------------------------------------------
32.Sh NAME
33.Nm scanc
34.Nd use byte string as lookup table index
35.\" ------------------------------------------------------------
36.Sh SYNOPSIS
37.In lib/libkern/libkern.h
38.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
39.Ft int
40.Fn scanc \
41"size_t size" "const u_char *cp" "const u_char table[]" "int mask"
42.\" ------------------------------------------------------------
43.Sh DESCRIPTION
44The
45.Fn scanc
46function scans the byte string
47.Fa cp ,
48whose length is
49.Fa size .
50A character in the string is used as an index in the 256-byte
51.Fa table .
52If a bitwise-AND of the byte from the table and
53.Fa mask
54isn't zero or the string is exhausted, the scan stops.
55.\" ------------------------------------------------------------
56.Sh RETURN VALUES
57The
58.Fn scanc
59function returns the number of characters skipped.
60.\" ------------------------------------------------------------
61.Sh HISTORY
62The
63.Fn scanc
64function emulates a VAX instruction with the same name.
65