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

   1 .\"     $NetBSD: dwarf_add_AT_flag.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_AT_flag.3 2072 2011-10-27 03:26:49Z jkoshy
  28 .\"
  29 .Dd September 4, 2011
  30 .Os
  31 .Dt DWARF_ADD_AT_FLAG 3
  32 .Sh NAME
  33 .Nm dwarf_add_AT_flag
  34 .Nd create and attach a flag attribute
  35 .Sh LIBRARY
  36 .Lb libdwarf
  37 .Sh SYNOPSIS
  38 .In libdwarf.h
  39 .Ft Dwarf_P_Attribute
  40 .Fo dwarf_add_AT_flag
  41 .Fa "Dwarf_P_Debug dbg"
  42 .Fa "Dwarf_P_Die die"
  43 .Fa "Dwarf_Half attr"
  44 .Fa "Dwarf_Small flag"
  45 .Fa "Dwarf_Error *err"
  46 .Fc
  47 .Sh DESCRIPTION
  48 Function
  49 .Fn dwarf_add_AT_flag
  50 creates an attribute descriptor belonging to the
  51 .Sq flag
  52 class, and attaches it to the debugging information entry referenced
  53 by argument
  54 .Ar die .
  55 The created attribute descriptor will have DWARF form
  56 .Dv DW_FORM_flag .
  57 .Pp
  58 Argument
  59 .Ar dbg
  60 should reference a DWARF producer instance allocated using
  61 .Xr dwarf_producer_init 3
  62 or
  63 .Xr dwarf_producer_init_b 3 .
  64 .Pp
  65 Argument
  66 .Ar die
  67 should reference a debugging information entry allocated using
  68 .Xr dwarf_new_die 3 .
  69 .Pp
  70 Argument
  71 .Ar attr
  72 should specify the attribute code for the new attribute descriptor.
  73 .Pp
  74 Argument
  75 .Ar flag
  76 should specify the value of the new attribute descriptor.
  77 A zero value is treated as
  78 .Sq false
  79 and a non-zero value as
  80 .Sq true .
  81 .Pp
  82 If argument
  83 .Ar err
  84 is not NULL, it will be used to store error information in case of an
  85 error.
  86 .Sh RETURN VALUES
  87 On success, function
  88 .Fn dwarf_add_AT_flag
  89 returns the created attribute descriptor.
  90 In case of an error, function
  91 .Fn dwarf_add_AT_flag
  92 returns
  93 .Dv DW_DLV_BADADDR
  94 and sets the argument
  95 .Ar err .
  96 .Sh ERRORS
  97 Function
  98 .Fn dwarf_add_AT_flag
  99 can fail with:
 100 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
 101 .It Bq Er DW_DLE_ARGUMENT
 102 Either of the arguments
 103 .Ar dbg
 104 or
 105 .Ar die
 106 was NULL.
 107 .It Bq Er DW_DLE_MEMORY
 108 An out of memory condition was encountered during the execution of the
 109 function.
 110 .El
 111 .Sh SEE ALSO
 112 .Xr dwarf 3 ,
 113 .Xr dwarf_add_AT_signed_const 3 ,
 114 .Xr dwarf_add_AT_unsigned_const 3 ,
 115 .Xr dwarf_new_die 3 ,
 116 .Xr dwarf_producer_init 3 ,
 117 .Xr dwarf_producer_init_b 3