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_file_decl.3 2072 2011-10-27 03:26:49Z jkoshy $
26.\"
27.Dd September 17, 2011
28.Os
29.Dt DWARF_ADD_FILE_DECL 3
30.Sh NAME
31.Nm dwarf_add_file_decl
32.Nd add a source file entry 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_file_decl
39.Fa "Dwarf_P_Debug dbg"
40.Fa "char *name"
41.Fa "Dwarf_Unsigned dirndx"
42.Fa "Dwarf_Unsigned mtime"
43.Fa "Dwarf_Unsigned size"
44.Fa "Dwarf_Error *err"
45.Fc
46.Sh DESCRIPTION
47Function
48.Fn dwarf_add_file_decl
49adds a source file entry to a producer instance.
50.Pp
51Argument
52.Ar dbg
53should reference a DWARF producer instance allocated using
54.Xr dwarf_producer_init 3
55or
56.Xr dwarf_producer_init_b 3 .
57.Pp
58Argument
59.Ar name
60should point to a NUL-terminated string containing the name of
61the source file.
62.Pp
63If the file name in argument
64.Ar name
65is not a fully qualified pathname, argument
66.Ar dirndx
67should specify the index of the directory where the source file resides.
68Otherwise, argument
69.Ar dirndx
70should be 0.
71Valid directory indices are those returned by the function
72.Xr dwarf_add_directory_decl 3 .
73.Pp
74Argument
75.Ar mtime
76specifies the time when the file was last modified.
77.Pp
78Argument
79.Ar size
80specifies the size of the file in bytes.
81.Pp
82If argument
83.Ar err
84is not NULL, it will be used to store error information in case
85of an error.
86.Sh RETURN VALUES
87On success, function
88.Fn dwarf_add_file_decl
89returns the index value generated for the source file.
90In case of an error, function
91.Fn dwarf_add_file_decl
92returns
93.Dv DW_DLV_NOCOUNT
94and sets the argument
95.Ar err .
96.Sh ERRORS
97Function
98.Fn dwarf_add_file_decl
99can fail with:
100.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
101.It Bq Er DW_DLE_ARGUMENT
102Either arguments
103.Ar dbg
104or
105.Ar name
106was NULL.
107.It Bq Er DW_DLE_ARGUMENT
108The length of the NUL-teminated string pointed to by argument
109.Ar name
110was 0.
111.It Bq Er DW_DLE_MEMORY
112An out of memory condition was encountered during the execution of the
113function.
114.El
115.Sh SEE ALSO
116.Xr dwarf 3 ,
117.Xr dwarf_add_directory_decl 3 ,
118.Xr dwarf_add_line_entry 3 ,
119.Xr dwarf_lne_end_sequence 3 ,
120.Xr dwarf_lne_set_address 3 ,
121.Xr dwarf_producer_init 3 ,
122.Xr dwarf_producer_init_b 3
123