1 | .\" Copyright (c) 2011 Kai Wang |
---|
2 | .\" All rights reserved. |
---|
3 | .\" |
---|
4 | .\" Redistribution and use in source and binary forms, with or without |
---|
5 | .\" modification, are permitted provided that the following conditions |
---|
6 | .\" are met: |
---|
7 | .\" 1. Redistributions of source code must retain the above copyright |
---|
8 | .\" notice, this list of conditions and the following disclaimer. |
---|
9 | .\" 2. Redistributions in binary form must reproduce the above copyright |
---|
10 | .\" notice, this list of conditions and the following disclaimer in the |
---|
11 | .\" documentation and/or other materials provided with the distribution. |
---|
12 | .\" |
---|
13 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
---|
14 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
15 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
16 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
---|
17 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
---|
18 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
---|
19 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
---|
20 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
---|
21 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
---|
22 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
---|
23 | .\" SUCH DAMAGE. |
---|
24 | .\" |
---|
25 | .\" $Id: dwarf_start_macro_file.3 2075 2011-10-27 03:47:28Z jkoshy $ |
---|
26 | .\" |
---|
27 | .Dd September 25, 2011 |
---|
28 | .Os |
---|
29 | .Dt DWARF_START_MACRO_FILE 3 |
---|
30 | .Sh NAME |
---|
31 | .Nm dwarf_start_macro_file |
---|
32 | .Nd mark the start of a source file inclusion |
---|
33 | .Sh LIBRARY |
---|
34 | .Lb libdwarf |
---|
35 | .Sh SYNOPSIS |
---|
36 | .In libdwarf.h |
---|
37 | .Ft "int" |
---|
38 | .Fo dwarf_start_macro_file |
---|
39 | .Fa "Dwarf_P_Debug dbg" |
---|
40 | .Fa "Dwarf_Unsigned lineno" |
---|
41 | .Fa "Dwarf_Unsigned fileindex" |
---|
42 | .Fa "Dwarf_Error *err" |
---|
43 | .Fa |
---|
44 | .Fc |
---|
45 | .Sh DESCRIPTION |
---|
46 | Function |
---|
47 | .Fn dwarf_start_macro_file |
---|
48 | marks the start of a new source file inclusion. |
---|
49 | .Pp |
---|
50 | Argument |
---|
51 | .Ar dbg |
---|
52 | should reference a DWARF producer instance allocated using |
---|
53 | .Xr dwarf_producer_init 3 |
---|
54 | or |
---|
55 | .Xr dwarf_producer_init_b 3 . |
---|
56 | .Pp |
---|
57 | Argument |
---|
58 | .Ar lineno |
---|
59 | specifies the line number of the source line where the source |
---|
60 | file inclusion occurs. |
---|
61 | A value of zero is used to indicate the file for the compilation unit |
---|
62 | source itself. |
---|
63 | .Pp |
---|
64 | Argument |
---|
65 | .Ar fileindex |
---|
66 | specifies the index of the source file that is being included. |
---|
67 | Valid source file indices are those returned by |
---|
68 | .Xr dwarf_add_file_decl 3 . |
---|
69 | .Pp |
---|
70 | If argument |
---|
71 | .Ar err |
---|
72 | is not NULL, it will be used to store error information in case of an |
---|
73 | error. |
---|
74 | .Sh RETURN VALUES |
---|
75 | On success, function |
---|
76 | .Fn dwarf_start_macro_file |
---|
77 | returns |
---|
78 | .Dv DW_DLV_OK . |
---|
79 | In case of an error, function |
---|
80 | .Fn dwarf_start_macro_file |
---|
81 | returns |
---|
82 | .Dv DW_DLV_ERROR |
---|
83 | and sets the argument |
---|
84 | .Ar err . |
---|
85 | .Sh ERRORS |
---|
86 | Function |
---|
87 | .Fn dwarf_start_macro_file |
---|
88 | can fail with: |
---|
89 | .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" |
---|
90 | .It Bq Er DW_DLE_ARGUMENT |
---|
91 | Argument |
---|
92 | .Ar dbg |
---|
93 | was NULL. |
---|
94 | .It Bq Er DW_DLE_MEMORY |
---|
95 | An out of memory condition was encountered during the execution of the |
---|
96 | function. |
---|
97 | .El |
---|
98 | .Sh SEE ALSO |
---|
99 | .Xr dwarf 3 , |
---|
100 | .Xr dwarf_add_file_decl 3 , |
---|
101 | .Xr dwarf_def_macro 3 , |
---|
102 | .Xr dwarf_end_macro_file 3 , |
---|
103 | .Xr dwarf_producer_init 3 , |
---|
104 | .Xr dwarf_producer_init_b 3 , |
---|
105 | .Xr dwarf_undef_macro 3 , |
---|
106 | .Xr dwarf_vendor_ext 3 |
---|