1XSBuilder::ParseSource(U3s)er Contributed Perl DocumentatXiSoBnuilder::ParseSource(3)
2
3
4
6 ExtUtils::XSBuilder::ParseSource - parse C source files
7
8 DESCRIPTION
9 For more information, see ExtUtils::XSBuilder
10
11 extent_parser (o)
12 Allows the user to call the Extent or Replace method of the parser to
13 add new syntax rules. This is mainly useful to include expansions for
14 preprocessor macros.
15
16 preprocess (o)
17 Allows the user to preprocess the source before it is given to the
18 parser. You may modify the source, which is given as first argument in
19 place.
20
21 include_dirs (o)
22 Returns a reference to the list of directories that should be searched
23 for include files which contain the functions, structures, etc. to be
24 extracted.
25
26 Default: '.'
27
28 include_paths (o)
29 Returns a reference to a list of directories that are given as include
30 directories to the C compiler. This is mainly used to strip these
31 directories from filenames to convert absolute paths to relative paths.
32
33 Default: empty list ("[]")
34
35 unwanted_includes (o)
36 Returns a reference to a list of include files that should not be
37 processed.
38
39 Default: empty list ("[]")
40
41 sort_includes (o, include_list)
42 Passed an array ref of include files, it allows the user to define the
43 sort order, so includes are processed correctly.
44
45 Default: return the passed array reference.
46
47 find_includes (o)
48 Returns a list of include files to be processed.
49
50 Default: search directories given by "include_dirs" for all files and
51 build a list of include files. All files starting with a word matched
52 by "unwanted_includes" are not included in the list.
53
54 handle_define (o)
55 Passed a hash ref with the definition of a define, may modify it.
56 Return false to discard it, return true to keep it.
57
58 Default: 1
59
60 handle_enum (o)
61 Passed a hash ref with the definition of a enum value, may modify it.
62 Return false to discard it, return true to keep it.
63
64 Default: 1
65
66 handle_struct (o)
67 Passed a hash ref with the definition of a struct, may modify it.
68 Return false to discard it, return true to keep it.
69
70 Default: 1
71
72 handle_function (o)
73 Passed a hash ref with the definition of a function, may modify it.
74 Return false to discard it, return true to keep it.
75
76 Default: 1
77
78 handle_callback (o)
79 Passed a hash ref with the definition of a callback, may modify it.
80 Return false to discard it, return true to keep it.
81
82 Default: 1
83
84 package (o)
85 Return package name for tables
86
87 Default: 'MY'
88
89 targetdir (o)
90 Return name of target directory where to write tables
91
92 Default: './xsbuilder/tables'
93
94 run
95 Call this class method to parse your source. Before you can do so you
96 must provide a class that overrides the defaults in
97 ExtUtils::XSBuilder::ParseSource. After that you scan the source files
98 with
99
100 MyClass -> run ;
101
102
103
104perl v5.36.0 2023-01-20 XSBuilder::ParseSource(3)