1.\" $NetBSD: dwarf_add_directory_decl.3,v 1.6 2024/03/03 17:37:30 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_add_directory_decl.3 3961 2022-03-12 15:13:22Z jkoshy 28.\" 29.Dd September 17, 2011 30.Dt DWARF_ADD_DIRECTORY_DECL 3 31.Os 32.Sh NAME 33.Nm dwarf_add_directory_decl 34.Nd add a directory name to a producer instance 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft "Dwarf_Unsigned" 40.Fo dwarf_add_directory_decl 41.Fa "Dwarf_P_Debug dbg" 42.Fa "char *name" 43.Fa "Dwarf_Error *err" 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_add_directory_decl 48adds a source directory name to a producer instance and returns the 49index value generated for the directory name. 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 name 60should point a NUL-terminated string containing the name of 61the directory. 62.Pp 63If argument 64.Fa err 65is not 66.Dv NULL , 67it will be used to store error information in case of an error. 68.Sh RETURN VALUES 69On success, function 70.Fn dwarf_add_directory_decl 71returns the index value generated for the directory. 72In case of an error, function 73.Fn dwarf_add_directory_decl 74returns 75.Dv DW_DLV_NOCOUNT 76and sets the argument 77.Fa err . 78.Sh ERRORS 79Function 80.Fn dwarf_add_directory_decl 81can fail with: 82.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 83.It Bq Er DW_DLE_ARGUMENT 84Either of the arguments 85.Fa dbg 86or 87.Fa name 88was 89.Dv NULL . 90.It Bq Er DW_DLE_MEMORY 91An out of memory condition was encountered during the execution of the 92function. 93.El 94.Sh SEE ALSO 95.Xr dwarf 3 , 96.Xr dwarf_add_file_decl 3 , 97.Xr dwarf_add_line_entry 3 , 98.Xr dwarf_lne_end_sequence 3 , 99.Xr dwarf_lne_set_address 3 , 100.Xr dwarf_producer_init 3 , 101.Xr dwarf_producer_init_b 3 102