xref: /freebsd-src/contrib/elftoolchain/libdwarf/dwarf_get_form_class.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_get_form_class.3 3640 2018-10-14 14:09:13Z jkoshy $
262de3b87aSKai Wang.\"
272de3b87aSKai Wang.Dd June 26, 2011
282de3b87aSKai Wang.Dt DWARF_GET_FORM_CLASS 3
29*ae500c1fSEd Maste.Os
302de3b87aSKai Wang.Sh NAME
312de3b87aSKai Wang.Nm dwarf_get_form_class
322de3b87aSKai Wang.Nd retrieve the form class of an attribute
332de3b87aSKai Wang.Sh LIBRARY
342de3b87aSKai Wang.Lb libdwarf
352de3b87aSKai Wang.Sh SYNOPSIS
362de3b87aSKai Wang.In libdwarf.h
372de3b87aSKai Wang.Ft enum Dwarf_Form_Class
382de3b87aSKai Wang.Fo dwarf_get_form_class
392de3b87aSKai Wang.Fa "Dwarf_Half dwversion"
402de3b87aSKai Wang.Fa "Dwarf_Half attr"
412de3b87aSKai Wang.Fa "Dwarf_Half offset_size"
422de3b87aSKai Wang.Fa "Dwarf_Half form"
432de3b87aSKai Wang.Fc
442de3b87aSKai Wang.Sh DESCRIPTION
452de3b87aSKai WangFunction
462de3b87aSKai Wang.Fn dwarf_get_form_class
472de3b87aSKai Wangreturns the class of the form of a DWARF attribute.
482de3b87aSKai Wang.Pp
492de3b87aSKai WangArgument
502de3b87aSKai Wang.Ar dwversion
512de3b87aSKai Wangshould specify the version number of DWARF specification
522de3b87aSKai Wangto use: 2 for DWARF2, 3 for DWARF3 and 4 for DWARF4.
532de3b87aSKai Wang.Pp
542de3b87aSKai WangArgument
552de3b87aSKai Wang.Ar attr
562de3b87aSKai Wangshould hold the attribute code of the attribute, i.e., one of the
572de3b87aSKai Wang.Li DW_AT_*
582de3b87aSKai Wangvalues defined in
592de3b87aSKai Wang.In libdwarf.h .
602de3b87aSKai Wang.Pp
612de3b87aSKai WangArgument
622de3b87aSKai Wang.Ar offset_size
632de3b87aSKai Wangshould hold the size of a DWARF offset for the relevant compilation
642de3b87aSKai Wangunit.
652de3b87aSKai Wang.Pp
662de3b87aSKai WangArgument
672de3b87aSKai Wang.Ar form
682de3b87aSKai Wangshould hold the form code of the attribute.
692de3b87aSKai Wang.Sh RETURN VALUES
702de3b87aSKai WangOn success, function
712de3b87aSKai Wang.Fn dwarf_get_form_class
722de3b87aSKai Wangreturns the form class code, which is one of the
732de3b87aSKai Wang.Dv DW_FORM_CLASS_*
742de3b87aSKai Wangcontants defined in header file
752de3b87aSKai Wang.In libdwarf.h .
762de3b87aSKai WangIf the function was not able to determine the form class of the
772de3b87aSKai Wangattribute, it returns the special form class code
782de3b87aSKai Wang.Dv DW_FORM_CLASS_UNKNOWN .
792de3b87aSKai Wang.Sh ERRORS
802de3b87aSKai WangFunction
812de3b87aSKai Wang.Fn dwarf_get_form_class
822de3b87aSKai Wangdoes not return an error.
832de3b87aSKai Wang.Sh SEE ALSO
842de3b87aSKai Wang.Xr dwarf 3 ,
852de3b87aSKai Wang.Xr dwarf_attr 3 ,
862de3b87aSKai Wang.Xr dwarf_whatattr 3 ,
872de3b87aSKai Wang.Xr dwarf_whatform 3
88