xref: /minix3/external/bsd/elftoolchain/dist/libdwarf/dwarf_add_file_decl.3 (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)

.\"	$NetBSD: dwarf_add_file_decl.3,v 1.2 2014/03/09 16:58:03 christos Exp $
.\"
.\" Copyright (c) 2011 Kai Wang
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" Id: dwarf_add_file_decl.3 2072 2011-10-27 03:26:49Z jkoshy
.\"
.Dd September 17, 2011
.Os
.Dt DWARF_ADD_FILE_DECL 3
.Sh NAME
.Nm dwarf_add_file_decl
.Nd add a source file entry to a producer instance
.Sh LIBRARY
.Lb libdwarf
.Sh SYNOPSIS
.In libdwarf.h
.Ft "Dwarf_Unsigned"
.Fo dwarf_add_file_decl
.Fa "Dwarf_P_Debug dbg"
.Fa "char *name"
.Fa "Dwarf_Unsigned dirndx"
.Fa "Dwarf_Unsigned mtime"
.Fa "Dwarf_Unsigned size"
.Fa "Dwarf_Error *err"
.Fc
.Sh DESCRIPTION
Function
.Fn dwarf_add_file_decl
adds a source file entry to a producer instance.
.Pp
Argument
.Ar dbg
should reference a DWARF producer instance allocated using
.Xr dwarf_producer_init 3
or
.Xr dwarf_producer_init_b 3 .
.Pp
Argument
.Ar name
should point to a NUL-terminated string containing the name of
the source file.
.Pp
If the file name in argument
.Ar name
is not a fully qualified pathname, argument
.Ar dirndx
should specify the index of the directory where the source file resides.
Otherwise, argument
.Ar dirndx
should be 0.
Valid directory indices are those returned by the function
.Xr dwarf_add_directory_decl 3 .
.Pp
Argument
.Ar mtime
specifies the time when the file was last modified.
.Pp
Argument
.Ar size
specifies the size of the file in bytes.
.Pp
If argument
.Ar err
is not NULL, it will be used to store error information in case
of an error.
.Sh RETURN VALUES
On success, function
.Fn dwarf_add_file_decl
returns the index value generated for the source file.
In case of an error, function
.Fn dwarf_add_file_decl
returns
.Dv DW_DLV_NOCOUNT
and sets the argument
.Ar err .
.Sh ERRORS
Function
.Fn dwarf_add_file_decl
can fail with:
.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
.It Bq Er DW_DLE_ARGUMENT
Either arguments
.Ar dbg
or
.Ar name
was NULL.
.It Bq Er DW_DLE_ARGUMENT
The length of the NUL-teminated string pointed to by argument
.Ar name
was 0.
.It Bq Er DW_DLE_MEMORY
An out of memory condition was encountered during the execution of the
function.
.El
.Sh SEE ALSO
.Xr dwarf 3 ,
.Xr dwarf_add_directory_decl 3 ,
.Xr dwarf_add_line_entry 3 ,
.Xr dwarf_lne_end_sequence 3 ,
.Xr dwarf_lne_set_address 3 ,
.Xr dwarf_producer_init 3 ,
.Xr dwarf_producer_init_b 3