contrib/elftoolchain/libdwarf/dwarf_add_typename.3

   1 .\" Copyright (c) 2011 Kai Wang
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $Id: dwarf_add_typename.3 3640 2018-10-14 14:09:13Z jkoshy $
  26 .\"
  27 .Dd September 24, 2011
  28 .Dt DWARF_ADD_TYPENAME 3
  29 .Os
  30 .Sh NAME
  31 .Nm dwarf_add_typename
  32 .Nd add information about a user-defined type to a DWARF producer instance
  33 .Sh LIBRARY
  34 .Lb libdwarf
  35 .Sh SYNOPSIS
  36 .In libdwarf.h
  37 .Ft "Dwarf_Unsigned"
  38 .Fo dwarf_add_typename
  39 .Fa "Dwarf_P_Debug dbg"
  40 .Fa "Dwarf_P_Die die"
  41 .Fa "char *name"
  42 .Fa "Dwarf_Error *err"
  43 .Fc
  44 .Sh DESCRIPTION
  45 Function
  46 .Fn dwarf_add_typename
  47 adds information about a user-defined type to a DWARF producer instance.
  48 .Pp
  49 Argument
  50 .Ar dbg
  51 should reference a DWARF producer instance allocated using
  52 .Xr dwarf_producer_init 3
  53 or
  54 .Xr dwarf_producer_init_b 3 .
  55 .Pp
  56 Argument
  57 .Ar die
  58 specifies the debugging information entry associated with the
  59 user-defined type.
  60 .Pp
  61 Argument
  62 .Ar name
  63 should point to a NUL-terminated string containing the name
  64 of the user-defined type.
  65 .Pp
  66 If argument
  67 .Ar err
  68 is not NULL, it will be used to store error information in case of an
  69 error.
  70 .Sh RETURN VALUES
  71 On success, function
  72 .Fn dwarf_add_typename
  73 returns a non-zero value.
  74 In case of an error, function
  75 .Fn dwarf_add_typename
  76 returns 0 and sets
  77 the argument
  78 .Ar err .
  79 .Sh ERRORS
  80 Function
  81 .Fn dwarf_add_typename
  82 can fail with:
  83 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
  84 .It Bq Er DW_DLE_ARGUMENT
  85 One of the arguments
  86 .Ar dbg ,
  87 .Ar die
  88 or
  89 .Ar name
  90 was NULL.
  91 .It Bq Er DW_DLE_MEMORY
  92 An out of memory condition was encountered during the execution of the
  93 function.
  94 .El
  95 .Sh SEE ALSO
  96 .Xr dwarf 3 ,
  97 .Xr dwarf_add_funcname 3 ,
  98 .Xr dwarf_add_pubname 3 ,
  99 .Xr dwarf_add_varname 3 ,
 100 .Xr dwarf_add_weakname 3 ,
 101 .Xr dwarf_new_die 3 ,
 102 .Xr dwarf_producer_init 3 ,
 103 .Xr dwarf_producer_init_b 3