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