contrib/elftoolchain/libdwarf/dwarf_undef_macro.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_undef_macro.3 3644 2018-10-15 19:55:01Z jkoshy $
  26 .\"
  27 .Dd November 9, 2011
  28 .Dt DWARF_UNDEF_MACRO 3
  29 .Os
  30 .Sh NAME
  31 .Nm dwarf_undef_macro
  32 .Nd record the removal of a macro definition
  33 .Sh LIBRARY
  34 .Lb libdwarf
  35 .Sh SYNOPSIS
  36 .In libdwarf.h
  37 .Ft "int"
  38 .Fo dwarf_undef_macro
  39 .Fa "Dwarf_P_Debug dbg"
  40 .Fa "Dwarf_Unsigned lineno"
  41 .Fa "char *name"
  42 .Fa "Dwarf_Error *err"
  43 .Fc
  44 .Sh DESCRIPTION
  45 Function
  46 .Fn dwarf_undef_macro
  47 records the removal of a macro definition in a DWARF producer
  48 instance.
  49 .Pp
  50 Argument
  51 .Ar dbg
  52 should reference a DWARF producer instance allocated using
  53 .Xr dwarf_producer_init 3
  54 or
  55 .Xr dwarf_producer_init_b 3 .
  56 .Pp
  57 Argument
  58 .Ar lineno
  59 specifies the line number of the source line where the macro
  60 definition was removed.
  61 A value of zero indicates that the macro definition was removed before
  62 any source files were read.
  63 .Pp
  64 Argument
  65 .Ar name
  66 should point to a NUL-terminated string containing the name
  67 of the macro.
  68 .Pp
  69 If argument
  70 .Ar err
  71 is not NULL, it will be used to store error information in case of an
  72 error.
  73 .Sh RETURN VALUES
  74 On success, function
  75 .Fn dwarf_undef_macro
  76 returns
  77 .Dv DW_DLV_OK .
  78 In case of an error, function
  79 .Fn dwarf_undef_macro
  80 returns
  81 .Dv DW_DLV_ERROR
  82 and sets the argument
  83 .Ar err .
  84 .Sh EXAMPLES
  85 To record the fact that the macro named
  86 .Dv _STDIO_H_
  87 was removed at line 220 of the current macro file, use:
  88 .Bd -literal -offset indent
  89 Dwarf_P_Debug dbg;
  90 Dwarf_Error de;
  91
  92 /* ... Assume 'dbg' refers to a DWARF producer instance... */
  93 if (dwarf_undef_macro(dbg, 220, "_STDIO_H_", &de) != DW_DLV_OK)
  94         errx(EXIT_FAILURE, "dwarf_def_macro failed: %s",
  95             dwarf_errmsg(-1));
  96 .Ed
  97 .Sh ERRORS
  98 Function
  99 .Fn dwarf_undef_macro
 100 can fail with:
 101 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
 102 .It Bq Er DW_DLE_ARGUMENT
 103 Either arguments
 104 .Ar dbg
 105 or
 106 .Ar name
 107 was NULL.
 108 .It Bq Er DW_DLE_MEMORY
 109 An out of memory condition was encountered during the execution of the
 110 function.
 111 .El
 112 .Sh SEE ALSO
 113 .Xr dwarf 3 ,
 114 .Xr dwarf_def_macro 3 ,
 115 .Xr dwarf_end_macro_file 3 ,
 116 .Xr dwarf_producer_init 3 ,
 117 .Xr dwarf_producer_init_b 3 ,
 118 .Xr dwarf_start_macro_file 3 ,
 119 .Xr dwarf_vendor_ext 3