1*2de3b87aSKai Wang.\" Copyright (c) 2011 Kai Wang 2*2de3b87aSKai Wang.\" All rights reserved. 3*2de3b87aSKai Wang.\" 4*2de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without 5*2de3b87aSKai Wang.\" modification, are permitted provided that the following conditions 6*2de3b87aSKai Wang.\" are met: 7*2de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright 8*2de3b87aSKai Wang.\" notice, this list of conditions and the following disclaimer. 9*2de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright 10*2de3b87aSKai Wang.\" notice, this list of conditions and the following disclaimer in the 11*2de3b87aSKai Wang.\" documentation and/or other materials provided with the distribution. 12*2de3b87aSKai Wang.\" 13*2de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14*2de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15*2de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16*2de3b87aSKai Wang.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17*2de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18*2de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19*2de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20*2de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21*2de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22*2de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23*2de3b87aSKai Wang.\" SUCH DAMAGE. 24*2de3b87aSKai Wang.\" 25*2de3b87aSKai Wang.\" $Id: dwarf_start_macro_file.3 2075 2011-10-27 03:47:28Z jkoshy $ 26*2de3b87aSKai Wang.\" 27*2de3b87aSKai Wang.Dd September 25, 2011 28*2de3b87aSKai Wang.Os 29*2de3b87aSKai Wang.Dt DWARF_START_MACRO_FILE 3 30*2de3b87aSKai Wang.Sh NAME 31*2de3b87aSKai Wang.Nm dwarf_start_macro_file 32*2de3b87aSKai Wang.Nd mark the start of a source file inclusion 33*2de3b87aSKai Wang.Sh LIBRARY 34*2de3b87aSKai Wang.Lb libdwarf 35*2de3b87aSKai Wang.Sh SYNOPSIS 36*2de3b87aSKai Wang.In libdwarf.h 37*2de3b87aSKai Wang.Ft "int" 38*2de3b87aSKai Wang.Fo dwarf_start_macro_file 39*2de3b87aSKai Wang.Fa "Dwarf_P_Debug dbg" 40*2de3b87aSKai Wang.Fa "Dwarf_Unsigned lineno" 41*2de3b87aSKai Wang.Fa "Dwarf_Unsigned fileindex" 42*2de3b87aSKai Wang.Fa "Dwarf_Error *err" 43*2de3b87aSKai Wang.Fa 44*2de3b87aSKai Wang.Fc 45*2de3b87aSKai Wang.Sh DESCRIPTION 46*2de3b87aSKai WangFunction 47*2de3b87aSKai Wang.Fn dwarf_start_macro_file 48*2de3b87aSKai Wangmarks the start of a new source file inclusion. 49*2de3b87aSKai Wang.Pp 50*2de3b87aSKai WangArgument 51*2de3b87aSKai Wang.Ar dbg 52*2de3b87aSKai Wangshould reference a DWARF producer instance allocated using 53*2de3b87aSKai Wang.Xr dwarf_producer_init 3 54*2de3b87aSKai Wangor 55*2de3b87aSKai Wang.Xr dwarf_producer_init_b 3 . 56*2de3b87aSKai Wang.Pp 57*2de3b87aSKai WangArgument 58*2de3b87aSKai Wang.Ar lineno 59*2de3b87aSKai Wangspecifies the line number of the source line where the source 60*2de3b87aSKai Wangfile inclusion occurs. 61*2de3b87aSKai WangA value of zero is used to indicate the file for the compilation unit 62*2de3b87aSKai Wangsource itself. 63*2de3b87aSKai Wang.Pp 64*2de3b87aSKai WangArgument 65*2de3b87aSKai Wang.Ar fileindex 66*2de3b87aSKai Wangspecifies the index of the source file that is being included. 67*2de3b87aSKai WangValid source file indices are those returned by 68*2de3b87aSKai Wang.Xr dwarf_add_file_decl 3 . 69*2de3b87aSKai Wang.Pp 70*2de3b87aSKai WangIf argument 71*2de3b87aSKai Wang.Ar err 72*2de3b87aSKai Wangis not NULL, it will be used to store error information in case of an 73*2de3b87aSKai Wangerror. 74*2de3b87aSKai Wang.Sh RETURN VALUES 75*2de3b87aSKai WangOn success, function 76*2de3b87aSKai Wang.Fn dwarf_start_macro_file 77*2de3b87aSKai Wangreturns 78*2de3b87aSKai Wang.Dv DW_DLV_OK . 79*2de3b87aSKai WangIn case of an error, function 80*2de3b87aSKai Wang.Fn dwarf_start_macro_file 81*2de3b87aSKai Wangreturns 82*2de3b87aSKai Wang.Dv DW_DLV_ERROR 83*2de3b87aSKai Wangand sets the argument 84*2de3b87aSKai Wang.Ar err . 85*2de3b87aSKai Wang.Sh ERRORS 86*2de3b87aSKai WangFunction 87*2de3b87aSKai Wang.Fn dwarf_start_macro_file 88*2de3b87aSKai Wangcan fail with: 89*2de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 90*2de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT 91*2de3b87aSKai WangArgument 92*2de3b87aSKai Wang.Ar dbg 93*2de3b87aSKai Wangwas NULL. 94*2de3b87aSKai Wang.It Bq Er DW_DLE_MEMORY 95*2de3b87aSKai WangAn out of memory condition was encountered during the execution of the 96*2de3b87aSKai Wangfunction. 97*2de3b87aSKai Wang.El 98*2de3b87aSKai Wang.Sh SEE ALSO 99*2de3b87aSKai Wang.Xr dwarf 3 , 100*2de3b87aSKai Wang.Xr dwarf_add_file_decl 3 , 101*2de3b87aSKai Wang.Xr dwarf_def_macro 3 , 102*2de3b87aSKai Wang.Xr dwarf_end_macro_file 3 , 103*2de3b87aSKai Wang.Xr dwarf_producer_init 3 , 104*2de3b87aSKai Wang.Xr dwarf_producer_init_b 3 , 105*2de3b87aSKai Wang.Xr dwarf_undef_macro 3 , 106*2de3b87aSKai Wang.Xr dwarf_vendor_ext 3 107