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