xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_find_macro_value_start.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
12de3b87aSKai Wang.\" Copyright (c) 2011 Kai Wang
22de3b87aSKai Wang.\" All rights reserved.
32de3b87aSKai Wang.\"
42de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without
52de3b87aSKai Wang.\" modification, are permitted provided that the following conditions
62de3b87aSKai Wang.\" are met:
72de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright
82de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer.
92de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright
102de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer in the
112de3b87aSKai Wang.\"    documentation and/or other materials provided with the distribution.
122de3b87aSKai Wang.\"
132de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
142de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
152de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
162de3b87aSKai Wang.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
172de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
182de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
192de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
202de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
212de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
222de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
232de3b87aSKai Wang.\" SUCH DAMAGE.
242de3b87aSKai Wang.\"
25*ae500c1fSEd Maste.\" $Id: dwarf_find_macro_value_start.3 3640 2018-10-14 14:09:13Z jkoshy $
262de3b87aSKai Wang.\"
272de3b87aSKai Wang.Dd March 26, 2011
282de3b87aSKai Wang.Dt DWARF_FIND_MACRO_VALUE_START 3
29*ae500c1fSEd Maste.Os
302de3b87aSKai Wang.Sh NAME
312de3b87aSKai Wang.Nm dwarf_find_macro_value_start
322de3b87aSKai Wang.Nd return the address of the first byte of a macro value
332de3b87aSKai Wang.Sh LIBRARY
342de3b87aSKai Wang.Lb libdwarf
352de3b87aSKai Wang.Sh SYNOPSIS
362de3b87aSKai Wang.In libdwarf.h
372de3b87aSKai Wang.Ft char *
382de3b87aSKai Wang.Fo dwarf_find_macro_value_start
392de3b87aSKai Wang.Fa "char *macro_string"
402de3b87aSKai Wang.Fc
412de3b87aSKai Wang.Sh DESCRIPTION
422de3b87aSKai WangGiven a DWARF macro string, function
432de3b87aSKai Wang.Fn dwarf_find_macro_value_start
442de3b87aSKai Wangreturns a pointer to the first byte of the macro value part of the
452de3b87aSKai Wangmacro string.
462de3b87aSKai Wang.Pp
472de3b87aSKai WangArgument
482de3b87aSKai Wang.Ar macro_string
492de3b87aSKai Wangshould be a NUL-terminated string conforming to the macro format
502de3b87aSKai Wangdefined in the DWARF standard; see
512de3b87aSKai Wang.Xr dwarf 4 .
522de3b87aSKai Wang.Sh RETURN VALUES
532de3b87aSKai WangOn success, function
542de3b87aSKai Wang.Fn dwarf_find_macro_value_start
552de3b87aSKai Wangreturns a pointer to the first byte of the macro value.
562de3b87aSKai WangIf the macro value part was not found, function
572de3b87aSKai Wang.Fn dwarf_find_macro_value_start
582de3b87aSKai Wangreturns a pointer to the NUL-byte terminating argument
592de3b87aSKai Wang.Ar macro_string .
602de3b87aSKai Wang.Pp
612de3b87aSKai WangFunction
622de3b87aSKai Wang.Fn dwarf_find_macro_value_start
632de3b87aSKai Wangreturns NULL if argument
642de3b87aSKai Wang.Ar macro_string
652de3b87aSKai Wangwas NULL.
662de3b87aSKai Wang.Sh SEE ALSO
672de3b87aSKai Wang.Xr dwarf 3 ,
682de3b87aSKai Wang.Xr dwarf_get_macro_details 3
69