external/bsd/elftoolchain/dist/libdwarf/dwarf_add_file_decl.3

   1 .\"     $NetBSD: dwarf_add_file_decl.3,v 1.2 2014/03/09 16:58:03 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_file_decl.3 2072 2011-10-27 03:26:49Z jkoshy
  28 .\"
  29 .Dd September 17, 2011
  30 .Os
  31 .Dt DWARF_ADD_FILE_DECL 3
  32 .Sh NAME
  33 .Nm dwarf_add_file_decl
  34 .Nd add a source file entry 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_file_decl
  41 .Fa "Dwarf_P_Debug dbg"
  42 .Fa "char *name"
  43 .Fa "Dwarf_Unsigned dirndx"
  44 .Fa "Dwarf_Unsigned mtime"
  45 .Fa "Dwarf_Unsigned size"
  46 .Fa "Dwarf_Error *err"
  47 .Fc
  48 .Sh DESCRIPTION
  49 Function
  50 .Fn dwarf_add_file_decl
  51 adds a source file entry to a producer instance.
  52 .Pp
  53 Argument
  54 .Ar dbg
  55 should reference a DWARF producer instance allocated using
  56 .Xr dwarf_producer_init 3
  57 or
  58 .Xr dwarf_producer_init_b 3 .
  59 .Pp
  60 Argument
  61 .Ar name
  62 should point to a NUL-terminated string containing the name of
  63 the source file.
  64 .Pp
  65 If the file name in argument
  66 .Ar name
  67 is not a fully qualified pathname, argument
  68 .Ar dirndx
  69 should specify the index of the directory where the source file resides.
  70 Otherwise, argument
  71 .Ar dirndx
  72 should be 0.
  73 Valid directory indices are those returned by the function
  74 .Xr dwarf_add_directory_decl 3 .
  75 .Pp
  76 Argument
  77 .Ar mtime
  78 specifies the time when the file was last modified.
  79 .Pp
  80 Argument
  81 .Ar size
  82 specifies the size of the file in bytes.
  83 .Pp
  84 If argument
  85 .Ar err
  86 is not NULL, it will be used to store error information in case
  87 of an error.
  88 .Sh RETURN VALUES
  89 On success, function
  90 .Fn dwarf_add_file_decl
  91 returns the index value generated for the source file.
  92 In case of an error, function
  93 .Fn dwarf_add_file_decl
  94 returns
  95 .Dv DW_DLV_NOCOUNT
  96 and sets the argument
  97 .Ar err .
  98 .Sh ERRORS
  99 Function
 100 .Fn dwarf_add_file_decl
 101 can fail with:
 102 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
 103 .It Bq Er DW_DLE_ARGUMENT
 104 Either arguments
 105 .Ar dbg
 106 or
 107 .Ar name
 108 was NULL.
 109 .It Bq Er DW_DLE_ARGUMENT
 110 The length of the NUL-teminated string pointed to by argument
 111 .Ar name
 112 was 0.
 113 .It Bq Er DW_DLE_MEMORY
 114 An out of memory condition was encountered during the execution of the
 115 function.
 116 .El
 117 .Sh SEE ALSO
 118 .Xr dwarf 3 ,
 119 .Xr dwarf_add_directory_decl 3 ,
 120 .Xr dwarf_add_line_entry 3 ,
 121 .Xr dwarf_lne_end_sequence 3 ,
 122 .Xr dwarf_lne_set_address 3 ,
 123 .Xr dwarf_producer_init 3 ,
 124 .Xr dwarf_producer_init_b 3