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