ExtUtils::ParseXS::Utilities(3perl) | Perl Programmers Reference Guide | ExtUtils::ParseXS::Utilities(3perl) |
ExtUtils::ParseXS::Utilities - Subroutines used with ExtUtils::ParseXS
use ExtUtils::ParseXS::Utilities qw( standard_typemap_locations trim_whitespace C_string valid_proto_string process_typemaps map_type standard_XS_defs assign_func_args analyze_preprocessor_statements set_cond Warn blurt death check_conditional_preprocessor_statements escape_file_for_line_directive report_typemap_failure );
The following functions are not considered to be part of the public interface. They are documented here for the benefit of future maintainers of this module.
Provide a list of filepaths where typemap files may be found. The filepaths -- relative paths to files (not just directory paths) -- appear in this list in lowest-to-highest priority.
The highest priority is to look in the current directory.
'typemap'
The second and third highest priorities are to look in the parent of the current directory and a directory called lib/ExtUtils underneath the parent directory.
'../typemap', '../lib/ExtUtils/typemap',
The fourth through ninth highest priorities are to look in the corresponding grandparent, great-grandparent and great-great-grandparent directories.
'../../typemap', '../../lib/ExtUtils/typemap', '../../../typemap', '../../../lib/ExtUtils/typemap', '../../../../typemap', '../../../../lib/ExtUtils/typemap',
The tenth and subsequent priorities are to look in directories named ExtUtils which are subdirectories of directories found in @INC -- provided a file named typemap actually exists in such a directory. Example:
'/usr/local/lib/perl5/5.10.1/ExtUtils/typemap',
However, these filepaths appear in the list returned by "standard_typemap_locations()" in reverse order, i.e., lowest-to-highest.
'/usr/local/lib/perl5/5.10.1/ExtUtils/typemap', '../../../../lib/ExtUtils/typemap', '../../../../typemap', '../../../lib/ExtUtils/typemap', '../../../typemap', '../../lib/ExtUtils/typemap', '../../typemap', '../lib/ExtUtils/typemap', '../typemap', 'typemap'
my @stl = standard_typemap_locations( \@INC );
Reference to @INC.
Array holding list of directories to be searched for typemap files.
Perform an in-place trimming of leading and trailing whitespace from the first argument provided to the function.
trim_whitespace($arg);
None. Remember: this is an in-place modification of the argument.
Escape backslashes ("\") in prototype strings.
$ProtoThisXSUB = C_string($_);
String needing escaping.
Properly escaped string.
Validate prototype string.
String needing checking.
Upon success, returns the same string passed as argument.
Upon failure, returns 0.
Process all typemap files.
my $typemaps_object = process_typemaps( $args{typemap}, $pwd );
List of two elements: "typemap" element from %args; current working directory.
Upon success, returns an ExtUtils::Typemaps object.
Performs a mapping at several places inside "PARAGRAPH" loop.
$type = map_type($self, $type, $varname);
List of three arguments.
String holding augmented version of second argument.
Writes to the ".c" output file certain preprocessor directives and function headers needed in all such files.
None.
Returns true.
Perform assignment to the "func_args" attribute.
$string = assign_func_args($self, $argsref, $class);
List of three elements. Second is an array reference; third is a string.
String.
Within each function inside each Xsub, print to the .c output file certain preprocessor statements.
( $self, $XSS_work_idx, $BootCode_ref ) = analyze_preprocessor_statements( $self, $statement, $XSS_work_idx, $BootCode_ref );
List of four elements.
Modifed values of three of the arguments passed to the function. In particular, the "XSStack" and "InitFileCode" attributes are modified.
Figures out the current line number in the XS file.
$self
The current line number.
Escapes a given code source name (typically a file name but can also be a command that was read from) so that double-quotes and backslashes are escaped.
A string.
A string with escapes for double-quotes and backslashes.
Do error reporting for missing typemaps.
The "ExtUtils::ParseXS" object.
An "ExtUtils::Typemaps" object.
The string that represents the C type that was not found in the typemap.
Optionally, the string "death" or "blurt" to choose whether the error is immediately fatal or not. Default: "blurt"
Returns nothing. Depending on the arguments, this may call "death" or "blurt", the former of which is fatal.
2023-11-25 | perl v5.36.0 |