1 .\" Copyright (c) 2011 Kai Wang
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
25 .\" $Id: dwarf_def_macro.3 3182 2015-04-10 16:08:10Z emaste $
32 .Nd add a macro definition to a DWARF producer instance
39 .Fa "Dwarf_P_Debug dbg"
40 .Fa "Dwarf_Unsigned lineno"
43 .Fa "Dwarf_Error *err"
48 adds a macro definition to a DWARF producer instance.
52 should reference a DWARF producer instance allocated using
53 .Xr dwarf_producer_init 3
55 .Xr dwarf_producer_init_b 3 .
59 specifies the line number of the source line where the macro is
61 A line number of zero is used for macros that are defined
62 before any source file is read.
66 should point to a NUL-terminated string containing the name
68 For function-like macros this parameter should also include
69 parentheses and parameter names if any.
73 should point to a NUL-terminated string containing the value
75 If the macro does not have a value, argument
77 should be set to NULL.
81 is not NULL, it will be used to store error information in case of an
88 In case of an error, function
95 To record the fact that a macro named
97 was defined at line 20 of the current macro file, use:
98 .Bd -literal -offset indent
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",
111 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
112 .It Bq Er DW_DLE_ARGUMENT
118 .It Bq Er DW_DLE_MEMORY
119 An out of memory condition was encountered during the execution of the
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