xref: /minix3/external/bsd/elftoolchain/dist/libdwarf/dwarf_find_macro_value_start.3 (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)
1*0a6a1f1dSLionel Sambuc.\"	$NetBSD: dwarf_find_macro_value_start.3,v 1.2 2014/03/09 16:58:03 christos Exp $
2*0a6a1f1dSLionel Sambuc.\"
3*0a6a1f1dSLionel Sambuc.\" Copyright (c) 2011 Kai Wang
4*0a6a1f1dSLionel Sambuc.\" All rights reserved.
5*0a6a1f1dSLionel Sambuc.\"
6*0a6a1f1dSLionel Sambuc.\" Redistribution and use in source and binary forms, with or without
7*0a6a1f1dSLionel Sambuc.\" modification, are permitted provided that the following conditions
8*0a6a1f1dSLionel Sambuc.\" are met:
9*0a6a1f1dSLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright
10*0a6a1f1dSLionel Sambuc.\"    notice, this list of conditions and the following disclaimer.
11*0a6a1f1dSLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright
12*0a6a1f1dSLionel Sambuc.\"    notice, this list of conditions and the following disclaimer in the
13*0a6a1f1dSLionel Sambuc.\"    documentation and/or other materials provided with the distribution.
14*0a6a1f1dSLionel Sambuc.\"
15*0a6a1f1dSLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16*0a6a1f1dSLionel Sambuc.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17*0a6a1f1dSLionel Sambuc.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18*0a6a1f1dSLionel Sambuc.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19*0a6a1f1dSLionel Sambuc.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20*0a6a1f1dSLionel Sambuc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21*0a6a1f1dSLionel Sambuc.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22*0a6a1f1dSLionel Sambuc.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23*0a6a1f1dSLionel Sambuc.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24*0a6a1f1dSLionel Sambuc.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25*0a6a1f1dSLionel Sambuc.\" SUCH DAMAGE.
26*0a6a1f1dSLionel Sambuc.\"
27*0a6a1f1dSLionel Sambuc.\" Id: dwarf_find_macro_value_start.3 2073 2011-10-27 03:30:47Z jkoshy
28*0a6a1f1dSLionel Sambuc.\"
29*0a6a1f1dSLionel Sambuc.Dd March 26, 2011
30*0a6a1f1dSLionel Sambuc.Os
31*0a6a1f1dSLionel Sambuc.Dt DWARF_FIND_MACRO_VALUE_START 3
32*0a6a1f1dSLionel Sambuc.Sh NAME
33*0a6a1f1dSLionel Sambuc.Nm dwarf_find_macro_value_start
34*0a6a1f1dSLionel Sambuc.Nd return the address of the first byte of a macro value
35*0a6a1f1dSLionel Sambuc.Sh LIBRARY
36*0a6a1f1dSLionel Sambuc.Lb libdwarf
37*0a6a1f1dSLionel Sambuc.Sh SYNOPSIS
38*0a6a1f1dSLionel Sambuc.In libdwarf.h
39*0a6a1f1dSLionel Sambuc.Ft char *
40*0a6a1f1dSLionel Sambuc.Fo dwarf_find_macro_value_start
41*0a6a1f1dSLionel Sambuc.Fa "char *macro_string"
42*0a6a1f1dSLionel Sambuc.Fc
43*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION
44*0a6a1f1dSLionel SambucGiven a DWARF macro string, function
45*0a6a1f1dSLionel Sambuc.Fn dwarf_find_macro_value_start
46*0a6a1f1dSLionel Sambucreturns a pointer to the first byte of the macro value part of the
47*0a6a1f1dSLionel Sambucmacro string.
48*0a6a1f1dSLionel Sambuc.Pp
49*0a6a1f1dSLionel SambucArgument
50*0a6a1f1dSLionel Sambuc.Ar macro_string
51*0a6a1f1dSLionel Sambucshould be a NUL-terminated string conforming to the macro format
52*0a6a1f1dSLionel Sambucdefined in the DWARF standard; see
53*0a6a1f1dSLionel Sambuc.Xr dwarf 4 .
54*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES
55*0a6a1f1dSLionel SambucOn success, function
56*0a6a1f1dSLionel Sambuc.Fn dwarf_find_macro_value_start
57*0a6a1f1dSLionel Sambucreturns a pointer to the first byte of the macro value.
58*0a6a1f1dSLionel SambucIf the macro value part was not found, function
59*0a6a1f1dSLionel Sambuc.Fn dwarf_find_macro_value_start
60*0a6a1f1dSLionel Sambucreturns a pointer to the NUL-byte terminating argument
61*0a6a1f1dSLionel Sambuc.Ar macro_string .
62*0a6a1f1dSLionel Sambuc.Pp
63*0a6a1f1dSLionel SambucFunction
64*0a6a1f1dSLionel Sambuc.Fn dwarf_find_macro_value_start
65*0a6a1f1dSLionel Sambucreturns NULL if argument
66*0a6a1f1dSLionel Sambuc.Ar macro_string
67*0a6a1f1dSLionel Sambucwas NULL.
68*0a6a1f1dSLionel Sambuc.Sh SEE ALSO
69*0a6a1f1dSLionel Sambuc.Xr dwarf 3 ,
70*0a6a1f1dSLionel Sambuc.Xr dwarf_get_macro_details 3
71