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 2075 2011-10-27 03:47:28Z jkoshy $ 26.\" 27.Dd September 25, 2011 28.Os 29.Dt DWARF_START_MACRO_FILE 3 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.Fa 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_start_macro_file 48marks the start of a new source file inclusion. 49.Pp 50Argument 51.Ar dbg 52should reference a DWARF producer instance allocated using 53.Xr dwarf_producer_init 3 54or 55.Xr dwarf_producer_init_b 3 . 56.Pp 57Argument 58.Ar lineno 59specifies the line number of the source line where the source 60file inclusion occurs. 61A value of zero is used to indicate the file for the compilation unit 62source itself. 63.Pp 64Argument 65.Ar fileindex 66specifies the index of the source file that is being included. 67Valid source file indices are those returned by 68.Xr dwarf_add_file_decl 3 . 69.Pp 70If argument 71.Ar err 72is not NULL, it will be used to store error information in case of an 73error. 74.Sh RETURN VALUES 75On success, function 76.Fn dwarf_start_macro_file 77returns 78.Dv DW_DLV_OK . 79In case of an error, function 80.Fn dwarf_start_macro_file 81returns 82.Dv DW_DLV_ERROR 83and sets the argument 84.Ar err . 85.Sh ERRORS 86Function 87.Fn dwarf_start_macro_file 88can fail with: 89.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 90.It Bq Er DW_DLE_ARGUMENT 91Argument 92.Ar dbg 93was NULL. 94.It Bq Er DW_DLE_MEMORY 95An out of memory condition was encountered during the execution of the 96function. 97.El 98.Sh SEE ALSO 99.Xr dwarf 3 , 100.Xr dwarf_add_file_decl 3 , 101.Xr dwarf_def_macro 3 , 102.Xr dwarf_end_macro_file 3 , 103.Xr dwarf_producer_init 3 , 104.Xr dwarf_producer_init_b 3 , 105.Xr dwarf_undef_macro 3 , 106.Xr dwarf_vendor_ext 3 107