xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_add_directory_decl.3 (revision 0957b409a90fd597c1e9124cbaf3edd2b488f4ac)
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_directory_decl.3 3640 2018-10-14 14:09:13Z jkoshy $
26.\"
27.Dd September 17, 2011
28.Dt DWARF_ADD_DIRECTORY_DECL 3
29.Os
30.Sh NAME
31.Nm dwarf_add_directory_decl
32.Nd add a directory name to a producer instance
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft "Dwarf_Unsigned"
38.Fo dwarf_add_directory_decl
39.Fa "Dwarf_P_Debug dbg"
40.Fa "char *name"
41.Fa "Dwarf_Error *err"
42.Fc
43.Sh DESCRIPTION
44Function
45.Fn dwarf_add_directory_decl
46adds a source directory name to a producer instance and returns the
47index value generated for the directory name.
48.Pp
49Argument
50.Ar dbg
51should reference a DWARF producer instance allocated using
52.Xr dwarf_producer_init 3
53or
54.Xr dwarf_producer_init_b 3 .
55.Pp
56Argument
57.Ar name
58should point a NUL-terminated string containing the name of
59the directory.
60.Pp
61If argument
62.Ar err
63is not NULL, it will be used to store error information in case
64of an error.
65.Sh RETURN VALUES
66On success, function
67.Fn dwarf_add_directory_decl
68returns the index value generated for the directory.
69In case of an error, function
70.Fn dwarf_add_directory_decl
71returns
72.Dv DW_DLV_NOCOUNT
73and sets the argument
74.Ar err .
75.Sh ERRORS
76Function
77.Fn dwarf_add_directory_decl
78can fail with:
79.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
80.It Bq Er DW_DLE_ARGUMENT
81Either of the arguments
82.Ar dbg
83or
84.Ar name
85was NULL.
86.It Bq Er DW_DLE_MEMORY
87An out of memory condition was encountered during the execution of the
88function.
89.El
90.Sh SEE ALSO
91.Xr dwarf 3 ,
92.Xr dwarf_add_file_decl 3 ,
93.Xr dwarf_add_line_entry 3 ,
94.Xr dwarf_lne_end_sequence 3 ,
95.Xr dwarf_lne_set_address 3 ,
96.Xr dwarf_producer_init 3 ,
97.Xr dwarf_producer_init_b 3
98