xref: /minix3/external/bsd/elftoolchain/dist/libdwarf/dwarf_hasattr.3 (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)
1*0a6a1f1dSLionel Sambuc.\"	$NetBSD: dwarf_hasattr.3,v 1.2 2014/03/09 16:58:04 christos Exp $
2*0a6a1f1dSLionel Sambuc.\"
3*0a6a1f1dSLionel Sambuc.\" Copyright (c) 2010 Kai Wang
4*0a6a1f1dSLionel Sambuc.\" All rights reserved.
5*0a6a1f1dSLionel Sambuc.\"
6*0a6a1f1dSLionel Sambuc.\" Redistribution and use in source and binary forms, with or without
7*0a6a1f1dSLionel Sambuc.\" modification, are permitted provided that the following conditions
8*0a6a1f1dSLionel Sambuc.\" are met:
9*0a6a1f1dSLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright
10*0a6a1f1dSLionel Sambuc.\"    notice, this list of conditions and the following disclaimer.
11*0a6a1f1dSLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright
12*0a6a1f1dSLionel Sambuc.\"    notice, this list of conditions and the following disclaimer in the
13*0a6a1f1dSLionel Sambuc.\"    documentation and/or other materials provided with the distribution.
14*0a6a1f1dSLionel Sambuc.\"
15*0a6a1f1dSLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16*0a6a1f1dSLionel Sambuc.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17*0a6a1f1dSLionel Sambuc.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18*0a6a1f1dSLionel Sambuc.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19*0a6a1f1dSLionel Sambuc.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20*0a6a1f1dSLionel Sambuc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21*0a6a1f1dSLionel Sambuc.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22*0a6a1f1dSLionel Sambuc.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23*0a6a1f1dSLionel Sambuc.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24*0a6a1f1dSLionel Sambuc.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25*0a6a1f1dSLionel Sambuc.\" SUCH DAMAGE.
26*0a6a1f1dSLionel Sambuc.\"
27*0a6a1f1dSLionel Sambuc.\" Id: dwarf_hasattr.3 2073 2011-10-27 03:30:47Z jkoshy
28*0a6a1f1dSLionel Sambuc.\"
29*0a6a1f1dSLionel Sambuc.Dd April 17, 2010
30*0a6a1f1dSLionel Sambuc.Os
31*0a6a1f1dSLionel Sambuc.Dt DWARF_HASATTR 3
32*0a6a1f1dSLionel Sambuc.Sh NAME
33*0a6a1f1dSLionel Sambuc.Nm dwarf_hasattr
34*0a6a1f1dSLionel Sambuc.Nd check for the presence of an attribute
35*0a6a1f1dSLionel Sambuc.Sh LIBRARY
36*0a6a1f1dSLionel Sambuc.Lb libdwarf
37*0a6a1f1dSLionel Sambuc.Sh SYNOPSIS
38*0a6a1f1dSLionel Sambuc.In libdwarf.h
39*0a6a1f1dSLionel Sambuc.Ft int
40*0a6a1f1dSLionel Sambuc.Fo dwarf_hasattr
41*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Die die"
42*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Half attr"
43*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Bool *ret_bool"
44*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Error *err"
45*0a6a1f1dSLionel Sambuc.Fc
46*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION
47*0a6a1f1dSLionel SambucFunction
48*0a6a1f1dSLionel Sambuc.Fn dwarf_hasattr
49*0a6a1f1dSLionel Sambuctests whether the debugging information entry referenced in argument
50*0a6a1f1dSLionel Sambuc.Ar die
51*0a6a1f1dSLionel Sambuccontains the attribute named by argument
52*0a6a1f1dSLionel Sambuc.Ar attr .
53*0a6a1f1dSLionel SambucLegal values for argument
54*0a6a1f1dSLionel Sambuc.Ar attr
55*0a6a1f1dSLionel Sambucare those denoted by the
56*0a6a1f1dSLionel Sambuc.Dv DW_AT_*
57*0a6a1f1dSLionel Sambucconstants in the DWARF specification.
58*0a6a1f1dSLionel Sambuc.Pp
59*0a6a1f1dSLionel SambucIf the named attribute is present in the debugging information entry,
60*0a6a1f1dSLionel Sambucfunction
61*0a6a1f1dSLionel Sambuc.Fn dwarf_hasattr
62*0a6a1f1dSLionel Sambucreturns a non-zero value in the location pointed to by argument
63*0a6a1f1dSLionel Sambuc.Ar ret_bool .
64*0a6a1f1dSLionel SambucIf the named attribute is not present, a zero is written instead.
65*0a6a1f1dSLionel Sambuc.Pp
66*0a6a1f1dSLionel SambucIf argument
67*0a6a1f1dSLionel Sambuc.Ar err
68*0a6a1f1dSLionel Sambucis not NULL, it will be used to return an error descriptor in case
69*0a6a1f1dSLionel Sambucof an error.
70*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES
71*0a6a1f1dSLionel SambucOn success, function
72*0a6a1f1dSLionel Sambuc.Fn dwarf_hasattr
73*0a6a1f1dSLionel Sambucreturns
74*0a6a1f1dSLionel Sambuc.Dv DW_DLV_OK .
75*0a6a1f1dSLionel SambucIn case of an error, it returns
76*0a6a1f1dSLionel Sambuc.Dv DW_DLV_ERROR
77*0a6a1f1dSLionel Sambucand sets argument
78*0a6a1f1dSLionel Sambuc.Ar err .
79*0a6a1f1dSLionel Sambuc.Sh ERRORS
80*0a6a1f1dSLionel SambucFunction
81*0a6a1f1dSLionel Sambuc.Fn dwarf_hasattr
82*0a6a1f1dSLionel Sambuccan fail with the following error:
83*0a6a1f1dSLionel Sambuc.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
84*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_ARGUMENT
85*0a6a1f1dSLionel SambucEither of argument
86*0a6a1f1dSLionel Sambuc.Va die
87*0a6a1f1dSLionel Sambucor
88*0a6a1f1dSLionel Sambuc.Va ret_bool
89*0a6a1f1dSLionel Sambucwas NULL.
90*0a6a1f1dSLionel Sambuc.Sh SEE ALSO
91*0a6a1f1dSLionel Sambuc.Xr dwarf 3 ,
92*0a6a1f1dSLionel Sambuc.Xr dwarf_attr 3 ,
93*0a6a1f1dSLionel Sambuc.Xr dwarf_whatattr 3
94