1*0a6a1f1dSLionel Sambuc.\" $NetBSD: dwarf_get_form_class.3,v 1.2 2014/03/09 16:58:04 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_get_form_class.3 2071 2011-10-27 03:20:00Z jkoshy 28*0a6a1f1dSLionel Sambuc.\" 29*0a6a1f1dSLionel Sambuc.Dd June 26, 2011 30*0a6a1f1dSLionel Sambuc.Os 31*0a6a1f1dSLionel Sambuc.Dt DWARF_GET_FORM_CLASS 3 32*0a6a1f1dSLionel Sambuc.Sh NAME 33*0a6a1f1dSLionel Sambuc.Nm dwarf_get_form_class 34*0a6a1f1dSLionel Sambuc.Nd retrieve the form class of an attribute 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 enum Dwarf_Form_Class 40*0a6a1f1dSLionel Sambuc.Fo dwarf_get_form_class 41*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Half dwversion" 42*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Half attr" 43*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Half offset_size" 44*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Half form" 45*0a6a1f1dSLionel Sambuc.Fc 46*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 47*0a6a1f1dSLionel SambucFunction 48*0a6a1f1dSLionel Sambuc.Fn dwarf_get_form_class 49*0a6a1f1dSLionel Sambucreturns the class of the form of a DWARF attribute. 50*0a6a1f1dSLionel Sambuc.Pp 51*0a6a1f1dSLionel SambucArgument 52*0a6a1f1dSLionel Sambuc.Ar dwversion 53*0a6a1f1dSLionel Sambucshould specify the version number of DWARF specification 54*0a6a1f1dSLionel Sambucto use: 2 for DWARF2, 3 for DWARF3 and 4 for DWARF4. 55*0a6a1f1dSLionel Sambuc.Pp 56*0a6a1f1dSLionel SambucArgument 57*0a6a1f1dSLionel Sambuc.Ar attr 58*0a6a1f1dSLionel Sambucshould hold the attribute code of the attribute, i.e., one of the 59*0a6a1f1dSLionel Sambuc.Li DW_AT_* 60*0a6a1f1dSLionel Sambucvalues defined in 61*0a6a1f1dSLionel Sambuc.In libdwarf.h . 62*0a6a1f1dSLionel Sambuc.Pp 63*0a6a1f1dSLionel SambucArgument 64*0a6a1f1dSLionel Sambuc.Ar offset_size 65*0a6a1f1dSLionel Sambucshould hold the size of a DWARF offset for the relevant compilation 66*0a6a1f1dSLionel Sambucunit. 67*0a6a1f1dSLionel Sambuc.Pp 68*0a6a1f1dSLionel SambucArgument 69*0a6a1f1dSLionel Sambuc.Ar form 70*0a6a1f1dSLionel Sambucshould hold the form code of the attribute. 71*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 72*0a6a1f1dSLionel SambucOn success, function 73*0a6a1f1dSLionel Sambuc.Fn dwarf_get_form_class 74*0a6a1f1dSLionel Sambucreturns the form class code, which is one of the 75*0a6a1f1dSLionel Sambuc.Dv DW_FORM_CLASS_* 76*0a6a1f1dSLionel Sambuccontants defined in header file 77*0a6a1f1dSLionel Sambuc.In libdwarf.h . 78*0a6a1f1dSLionel SambucIf the function was not able to determine the form class of the 79*0a6a1f1dSLionel Sambucattribute, it returns the special form class code 80*0a6a1f1dSLionel Sambuc.Dv DW_FORM_CLASS_UNKNOWN . 81*0a6a1f1dSLionel Sambuc.Sh ERRORS 82*0a6a1f1dSLionel SambucFunction 83*0a6a1f1dSLionel Sambuc.Fn dwarf_get_form_class 84*0a6a1f1dSLionel Sambucdoes not return an error. 85*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 86*0a6a1f1dSLionel Sambuc.Xr dwarf 3 , 87*0a6a1f1dSLionel Sambuc.Xr dwarf_attr 3 , 88*0a6a1f1dSLionel Sambuc.Xr dwarf_whatattr 3 , 89*0a6a1f1dSLionel Sambuc.Xr dwarf_whatform 3 90