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_start_macro_file.3 3644 2018-10-15 19:55:01Z jkoshy $
26.\"
27.Dd September 25, 2011
28.Dt DWARF_START_MACRO_FILE 3
29.Os
30.Sh NAME
31.Nm dwarf_start_macro_file
32.Nd mark the start of a source file inclusion
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft "int"
38.Fo dwarf_start_macro_file
39.Fa "Dwarf_P_Debug dbg"
40.Fa "Dwarf_Unsigned lineno"
41.Fa "Dwarf_Unsigned fileindex"
42.Fa "Dwarf_Error *err"
43.Fc
44.Sh DESCRIPTION
45Function
46.Fn dwarf_start_macro_file
47marks the start of a new source file inclusion.
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 lineno
58specifies the line number of the source line where the source
59file inclusion occurs.
60A value of zero is used to indicate the file for the compilation unit
61source itself.
62.Pp
63Argument
64.Ar fileindex
65specifies the index of the source file that is being included.
66Valid source file indices are those returned by
67.Xr dwarf_add_file_decl 3 .
68.Pp
69If argument
70.Ar err
71is not NULL, it will be used to store error information in case of an
72error.
73.Sh RETURN VALUES
74On success, function
75.Fn dwarf_start_macro_file
76returns
77.Dv DW_DLV_OK .
78In case of an error, function
79.Fn dwarf_start_macro_file
80returns
81.Dv DW_DLV_ERROR
82and sets the argument
83.Ar err .
84.Sh ERRORS
85Function
86.Fn dwarf_start_macro_file
87can fail with:
88.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
89.It Bq Er DW_DLE_ARGUMENT
90Argument
91.Ar dbg
92was NULL.
93.It Bq Er DW_DLE_MEMORY
94An out of memory condition was encountered during the execution of the
95function.
96.El
97.Sh SEE ALSO
98.Xr dwarf 3 ,
99.Xr dwarf_add_file_decl 3 ,
100.Xr dwarf_def_macro 3 ,
101.Xr dwarf_end_macro_file 3 ,
102.Xr dwarf_producer_init 3 ,
103.Xr dwarf_producer_init_b 3 ,
104.Xr dwarf_undef_macro 3 ,
105.Xr dwarf_vendor_ext 3
106