xref: /netbsd-src/external/bsd/elftoolchain/dist/libdwarf/dwarf_hasattr.3 (revision 5ac3bc719ce6e70593039505b491894133237d12)
1.\"	$NetBSD: dwarf_hasattr.3,v 1.6 2024/03/03 17:37:31 christos Exp $
2.\"
3.\" Copyright (c) 2010 Kai Wang
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.\" Id: dwarf_hasattr.3 3963 2022-03-12 16:07:32Z jkoshy
28.\"
29.Dd April 17, 2010
30.Dt DWARF_HASATTR 3
31.Os
32.Sh NAME
33.Nm dwarf_hasattr
34.Nd check for the presence of an attribute
35.Sh LIBRARY
36.Lb libdwarf
37.Sh SYNOPSIS
38.In libdwarf.h
39.Ft int
40.Fo dwarf_hasattr
41.Fa "Dwarf_Die die"
42.Fa "Dwarf_Half attr"
43.Fa "Dwarf_Bool *ret_bool"
44.Fa "Dwarf_Error *err"
45.Fc
46.Sh DESCRIPTION
47Function
48.Fn dwarf_hasattr
49tests whether the debugging information entry referenced in argument
50.Fa die
51contains the attribute named by argument
52.Fa attr .
53Legal values for argument
54.Fa attr
55are those denoted by the
56.Dv DW_AT_*
57constants in the DWARF specification.
58.Pp
59If the named attribute is present in the debugging information entry,
60function
61.Fn dwarf_hasattr
62returns a non-zero value in the location pointed to by argument
63.Fa ret_bool .
64If the named attribute is not present, a zero is written instead.
65.Pp
66If argument
67.Fa err
68is not
69.Dv NULL ,
70it will be used to return an error descriptor in case of an error.
71.Sh RETURN VALUES
72On success, function
73.Fn dwarf_hasattr
74returns
75.Dv DW_DLV_OK .
76In case of an error, it returns
77.Dv DW_DLV_ERROR
78and sets argument
79.Fa err .
80.Sh ERRORS
81Function
82.Fn dwarf_hasattr
83can fail with the following error:
84.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
85.It Bq Er DW_DLE_ARGUMENT
86Either of argument
87.Va die
88or
89.Va ret_bool
90was
91.Dv NULL .
92.El
93.Sh SEE ALSO
94.Xr dwarf 3 ,
95.Xr dwarf_attr 3 ,
96.Xr dwarf_whatattr 3
97