1.\" Copyright (c) 2011 Kai Wang
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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $Id: dwarf_add_AT_flag.3 2072 2011-10-27 03:26:49Z jkoshy $
26.\"
27.Dd September 4, 2011
28.Os
29.Dt DWARF_ADD_AT_FLAG 3
30.Sh NAME
31.Nm dwarf_add_AT_flag
32.Nd create and attach a flag attribute
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft Dwarf_P_Attribute
38.Fo dwarf_add_AT_flag
39.Fa "Dwarf_P_Debug dbg"
40.Fa "Dwarf_P_Die die"
41.Fa "Dwarf_Half attr"
42.Fa "Dwarf_Small flag"
43.Fa "Dwarf_Error *err"
44.Fc
45.Sh DESCRIPTION
46Function
47.Fn dwarf_add_AT_flag
48creates an attribute descriptor belonging to the
49.Sq flag
50class, and attaches it to the debugging information entry referenced
51by argument
52.Ar die .
53The created attribute descriptor will have DWARF form
54.Dv DW_FORM_flag .
55.Pp
56Argument
57.Ar dbg
58should reference a DWARF producer instance allocated using
59.Xr dwarf_producer_init 3
60or
61.Xr dwarf_producer_init_b 3 .
62.Pp
63Argument
64.Ar die
65should reference a debugging information entry allocated using
66.Xr dwarf_new_die 3 .
67.Pp
68Argument
69.Ar attr
70should specify the attribute code for the new attribute descriptor.
71.Pp
72Argument
73.Ar flag
74should specify the value of the new attribute descriptor.
75A zero value is treated as
76.Sq false
77and a non-zero value as
78.Sq true .
79.Pp
80If argument
81.Ar err
82is not NULL, it will be used to store error information in case of an
83error.
84.Sh RETURN VALUES
85On success, function
86.Fn dwarf_add_AT_flag
87returns the created attribute descriptor.
88In case of an error, function
89.Fn dwarf_add_AT_flag
90returns
91.Dv DW_DLV_BADADDR
92and sets the argument
93.Ar err .
94.Sh ERRORS
95Function
96.Fn dwarf_add_AT_flag
97can fail with:
98.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
99.It Bq Er DW_DLE_ARGUMENT
100Either of the arguments
101.Ar dbg
102or
103.Ar die
104was NULL.
105.It Bq Er DW_DLE_MEMORY
106An out of memory condition was encountered during the execution of the
107function.
108.El
109.Sh SEE ALSO
110.Xr dwarf 3 ,
111.Xr dwarf_add_AT_signed_const 3 ,
112.Xr dwarf_add_AT_unsigned_const 3 ,
113.Xr dwarf_new_die 3 ,
114.Xr dwarf_producer_init 3 ,
115.Xr dwarf_producer_init_b 3
116