xref: /minix3/external/bsd/elftoolchain/dist/libdwarf/dwarf_get_AT_name.3 (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)
1.\"	$NetBSD: dwarf_get_AT_name.3,v 1.2 2014/03/09 16:58:03 christos Exp $
2.\"
3.\" Copyright (c) 2011 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_get_AT_name.3 2071 2011-10-27 03:20:00Z jkoshy
28.\"
29.Dd April 22, 2011
30.Os
31.Dt DWARF_GET_AT_NAME 3
32.Sh NAME
33.Nm dwarf_get_ACCESS_name ,
34.Nm dwarf_get_AT_name ,
35.Nm dwarf_get_ATE_name ,
36.Nm dwarf_get_CC_name ,
37.Nm dwarf_get_CFA_name ,
38.Nm dwarf_get_CHILDREN_name ,
39.Nm dwarf_get_DS_name ,
40.Nm dwarf_get_DSC_name ,
41.Nm dwarf_get_EH_name ,
42.Nm dwarf_get_END_name ,
43.Nm dwarf_get_FORM_name ,
44.Nm dwarf_get_ID_name ,
45.Nm dwarf_get_INL_name ,
46.Nm dwarf_get_LANG_name ,
47.Nm dwarf_get_LNE_name ,
48.Nm dwarf_get_LNS_name ,
49.Nm dwarf_get_MACINFO_name ,
50.Nm dwarf_get_OP_name ,
51.Nm dwarf_get_ORD_name ,
52.Nm dwarf_get_TAG_name ,
53.Nm dwarf_get_VIRTUALITY_name ,
54.Nm dwarf_get_VIS_name
55.Nd retrieve the symbolic names of DWARF constants
56.Sh LIBRARY
57.Lb libdwarf
58.Sh SYNOPSIS
59.In libdwarf.h
60.Ft int
61.Fo dwarf_get_ACCESS_name
62.Fa "unsigned val"
63.Fa "char **str"
64.Fc
65.Ft int
66.Fo dwarf_get_AT_name
67.Fa "unsigned val"
68.Fa "char **str"
69.Fc
70.Ft int
71.Fo dwarf_get_ATE_name
72.Fa "unsigned val"
73.Fa "char **str"
74.Fc
75.Ft int
76.Fo dwarf_get_CC_name
77.Fa "unsigned val"
78.Fa "char **str"
79.Fc
80.Ft int
81.Fo dwarf_get_CFA_name
82.Fa "unsigned val"
83.Fa "char **str"
84.Fc
85.Ft int
86.Fo dwarf_get_CHILDREN_name
87.Fa "unsigned val"
88.Fa "char **str"
89.Fc
90.Ft int
91.Fo dwarf_get_DS_name
92.Fa "unsigned val"
93.Fa "char **str"
94.Fc
95.Ft int
96.Fo dwarf_get_DSC_name
97.Fa "unsigned val"
98.Fa "char **str"
99.Fc
100.Ft int
101.Fo dwarf_get_EH_name
102.Fa "unsigned val"
103.Fa "char **str"
104.Fc
105.Ft int
106.Fo dwarf_get_END_name
107.Fa "unsigned val"
108.Fa "char **str"
109.Fc
110.Ft int
111.Fo dwarf_get_FORM_name
112.Fa "unsigned val"
113.Fa "char **str"
114.Fc
115.Ft int
116.Fo dwarf_get_ID_name
117.Fa "unsigned val"
118.Fa "char **str"
119.Fc
120.Ft int
121.Fo dwarf_get_INL_name
122.Fa "unsigned val"
123.Fa "char **str"
124.Fc
125.Ft int
126.Fo dwarf_get_LANG_name
127.Fa "unsigned val"
128.Fa "char **str"
129.Fc
130.Ft int
131.Fo dwarf_get_LNE_name
132.Fa "unsigned val"
133.Fa "char **str"
134.Fc
135.Ft int
136.Fo dwarf_get_LNS_name
137.Fa "unsigned val"
138.Fa "char **str"
139.Fc
140.Ft int
141.Fo dwarf_get_MACINFO_name
142.Fa "unsigned val"
143.Fa "char **str"
144.Fc
145.Ft int
146.Fo dwarf_get_OP_name
147.Fa "unsigned val"
148.Fa "char **str"
149.Fc
150.Ft int
151.Fo dwarf_get_ORD_name
152.Fa "unsigned val"
153.Fa "char **str"
154.Fc
155.Ft int
156.Fo dwarf_get_TAG_name
157.Fa "unsigned val"
158.Fa "char **str"
159.Fc
160.Ft int
161.Fo dwarf_get_VIRTUALITY_name
162.Fa "unsigned val"
163.Fa "char **str"
164.Fc
165.Ft int
166.Fo dwarf_get_VIS_name
167.Fa "unsigned val"
168.Fa "char **str"
169.Fc
170.Sh DESCRIPTION
171These functions return the symbolic name of a numeric DWARF constant.
172.Pp
173Argument
174.Ar val
175specifies the numeric value whose symbolic name is desired.
176.Pp
177Argument
178.Ar str
179should point to a location which will hold the returned
180NUL-terminated string containing the symbolic name of the
181specified value.
182.Pp
183The list of functions and the DWARF constants that they accept are:
184.Pp
185.Bl -tag -width ".Fn dwarf_get_VIRTUALITY_name" -compact
186.It Fn dwarf_get_ACCESS_name
187.Dv DW_ACCESS_*
188constants.
189.It Fn dwarf_get_AT_name
190.Dv DW_AT_*
191constants.
192.It Fn dwarf_get_ATE_name
193.Dv DW_ATE_*
194constants.
195.It Fn dwarf_get_CC_name
196.Dv DW_CC_*
197constants.
198.It Fn dwarf_get_CFA_name
199.Dv DW_CFA_*
200constants.
201.It Fn dwarf_get_CHILDREN_name
202.Dv DW_CHILDREN_*
203constants.
204.It Fn dwarf_get_DS_name
205.Dv DW_DS_*
206constants.
207.It Fn dwarf_get_DSC_name
208.Dv DW_DSC_*
209constants.
210.It Fn dwarf_get_EH_name
211.Dv DW_EH_PE_*
212constants.
213.It Fn dwarf_get_END_name
214.Dv DW_END_*
215constants.
216.It Fn dwarf_get_FORM_name
217.Dv DW_FORM_*
218constants.
219.It Fn dwarf_get_ID_name
220.Dv DW_ID_*
221constants.
222.It Fn dwarf_get_INL_name
223.Dv DW_INL_*
224constants.
225.It Fn dwarf_get_LANG_name
226.Dv DW_LANG_*
227constants.
228.It Fn dwarf_get_LNE_name
229.Dv DW_LNE_*
230constants.
231.It Fn dwarf_get_LNS_name
232.Dv DW_LNS_*
233constants.
234.It Fn dwarf_get_MACINFO_name
235.Dv DW_MACINFO_*
236constants.
237.It Fn dwarf_get_OP_name
238.Dv DW_OP_*
239constants.
240.It Fn dwarf_get_ORD_name
241.Dv DW_ORD_*
242constants.
243.It Fn dwarf_get_TAG_name
244.Dv DW_TAG_*
245constants.
246.It Fn dwarf_get_VIRTUALITY_name
247.Dv DW_VIRTUALITY_*
248constants.
249.It Fn dwarf_get_VIS_name
250.Dv DW_VIS_*
251constants.
252.Sh RETURN VALUES
253These functions return
254.Dv DW_DLV_OK on success.
255If the DWARF constant denoted by argument
256.Ar val
257is not recognized, these function return
258.Dv DW_DLV_NO_ENTRY .
259.Sh SEE ALSO
260.Xr dwarf 3
261