NAME

Rinchi::Fortran::Preprocessor - An Fortran to XML preprocessor extension for preprocessing Fortran files producing XML SAX parser events for the tokens scanned.

SYNOPSIS

 use Rinchi::Fortran::Preprocessor;

 my @args = (
   'test.pl',
   '-I/usr/include',
   '-Uccc',
 );

 my $closed = 0;

 my $fpp = new Rinchi::Fortran::Preprocessor;
 $fpp->setHandlers('Start'      => \&startElementHandler,
                   'End'        => \&endElementHandler,
                   'Char'       => \&characterDataHandler,
                   'Proc'       => \&processingInstructionHandler,
                   'Comment'    => \&commentHandler,
                   'CdataStart' => \&startCdataHandler,
                   'CdataEnd'   => \&endCdataHandler,
                   'XMLDecl'    => \&xmlDeclHandler,
                   );

 $fpp->process_file('test_src/include_test_1.h',\@args);

 sub startElementHandler() {
   my ($tag, $hasChild, %attrs) = @_;
   print "<$tag";
   foreach my $attr (sort keys %attrs) {
     my $val = $attrs{$attr};
     $val =~ s/&/&amp;/g;
     $val =~ s/</&lt;/g;
     $val =~ s/>/&gt;/g;
     $val =~ s/\"/&quot;/g;
     $val =~ s/\'/&apos;/g;
     print " $attr=\"$val\"";
   }
   if ($hasChild == 0) {
     print " />";
     $closed = 1;
   } else {
     print ">";
     $closed = 0;
   }
 }

 sub endElementHandler() {
   my ($tag) = @_;
   if ($closed == 0) {
     print "</$tag>\n";
   } else {
     $closed = 0;
   }
 }

 sub characterDataHandler() {
   my ($cdata) = @_;
   print $cdata;
 }

 sub processingInstructionHandler() {
   my ($target,$data) = @_;
   print "<?$target $data?>\n";
 }

 sub commentHandler() {
   my ($string) = @_;
   print "<!-- $string -->\n";
 }

 sub startCdataHandler() {
   print "<![CDATA[";
 }

 sub endCdataHandler() {
    print "]]>";
 }

 sub xmlDeclHandler() {
   my ($version, $encoding, $standalone) = @_;
   print "<?xml version=\"$version\" encoding=\"$encoding\" standalone=\"$standalone\"?>\n";
 }

DESCRIPTION

This module provides an interface to a Fortran preprocessor.

EXPORT

None by default.

METHODS

new

Constructor for Fortran::Preprocessor. Options are TBD.

setHandlers(TYPE, HANDLER [, TYPE, HANDLER [...]])

This method registers handlers for the various events.

Setting a handler to something that evaluates to false unsets that handler.

This method returns a list of type, handler pairs corresponding to the input. The handlers returned are the ones that were in effect before the call to setHandlers.

The recognized events and the parameters passed to the corresponding handlers are:

  • Start (tagname, hasChild [, attrName, attrValue [,...]])

      my ($tag, $hasChild, %attrs) = @_;
      print "<$tag";
      foreach my $attr (sort keys %attrs) {
        my $val = $attrs{$attr};
        $val =~ s/&/&amp;/g;
        $val =~ s/</&lt;/g;
        $val =~ s/>/&gt;/g;
        $val =~ s/\"/&quot;/g;
        $val =~ s/\'/&apos;/g;
        print " $attr=\"$val\"";
      }
      print ">\n";

    This event is generated when an XML start tag is recognized. Parameter tagname is the name of the XML element that is opened with the start tag. Parameter hasChild indicates the presence of contained nodes. The attrName and attrValue pairs are generated for each attribute in the start tag.

  • End (tagname)

      my ($tag) = @_;
      print "</$tag>\n";

    This event is generated when an XML end tag is recognized. Note that an XML empty tag (<tagname/>) generates both a start and an end event.

  • Char (String)

      my ($cdata) = @_;
      print $cdata;

    This event is generated when non-markup is recognized. The non-markup sequence of characters is in String. A single non-markup sequence of characters may generate multiple calls to this handler. Whatever the encoding of the string in the original document, this is given to the handler in UTF-8.

  • Proc (target, data)

      my ($target,$data) = @_;
      print "<?$target $data?>\n";

    This event is generated when a processing instruction is created. Processing instructions are used to convey locations and error messages.

  • Comment (String)

      my ($string) = @_;
      print "<!-- $string -->\n";

    This event is generated when a comment is recognized.

  • CdataStart ()

      print "<![CDATA[";

    This is called at the start of a CDATA section.

  • CdataEnd ()

       print "]]>";

    This is called at the end of a CDATA section.

  • XMLDecl (Version, Encoding, Standalone)

    This handler is called for XML declarations. Version is a string containing the version. Encoding is either undefined or contains an encoding string. Standalone is either undefined, or true or false. Undefined indicates that no standalone parameter was given in the XML declaration. True or false indicates "yes" or "no" respectively.

sub process_file($path, [\@args])
 $fpp->process_file('some_file.fpp' ,\@args);

Where $path is the path to the file to be parsed and $args is an optional reference to an array of arguments.

Parse the given file after passing the arguments if given. Event handlers should be set using the setHandlers method before this call is made. Arguments are given similar to command line arguments and are defined as follows:

General options: -d, --depend=file Specify dependency output file. -D, --define=identifier Define an object macro. -U, --use=code Specify a use on code. -I, --incldir=directory Specify a directory to search for include. -C, --comment Output comments. -P, --locate Output locations. -e, --exclude Drop excluded lines. -m, --modtime Inherit mod time. --debug Output parser debugging info. --treebug Output tree debugging info.

Help options: -?, --help Show this help message --usage Display brief usage message

keyword_for_tag($tagName)
  my $keyword = $fpp->keyword_for_tag($tag);

or

  my $keyword = Rinchi::Fortran::Preprocessor->keyword_for_tag($tag);
delimiter_for_open_tag($tagName)
  my $delim = $fpp->delimiter_for_open_tag($tag);

or

  my $delim = Rinchi::Fortran::Preprocessor->delimiter_for_open_tag($tag);
delimiter_for_close_tag($tagName)
  my $delim = $fpp->delimiter_for_close_tag($tag);

or

  my $delim = Rinchi::Fortran::Preprocessor->delimiter_for_close_tag($tag);
op_or_punc_for_tag($tagName)
  my $op_punc = $fpp->op_or_punc_for_tag($tag);

or

  my $op_punc = Rinchi::Fortran::Preprocessor->op_or_punc_for_tag($tag);
startElementHandler()

Default start Element handler.

endElementHandler()

Default end Element handler.

characterDataHandler()

Default Character Data handler.

processingInstructionHandler()

Default Processing Instruction handler.

commentHandler()

Default Comment handler.

startCdataHandler()

Default start CDATA handler.

endCdataHandler()

Default end CDATA handler.

xmlDeclHandler()

Default XML Declaration handler.

sub xml_outpute($path, [\@args])
 $fpp->xml_output('some_file.fpp' ,\@args);

Where $path is the path to the file to be parsed and $args is an optional reference to an array of arguments.

Parse the given file after passing the arguments if given. Print the XML output to standard output.

sub new_source($path, [\@args])
 $fpp->new_source('some_file.fpp' ,\@args);

Where $path is the path to the file to be parsed and $args is an optional reference to an array of arguments.

Parse the given file after passing the arguments if given. Print the new source to standard output.

Macro Expansion:

This Perl extension has been tested to meet the requirements set forth in ISO/IEC 14882:2003(E) with the exception of preservation of white in some cases. This is not really a result of the macro expansion, but the elimination of most white space as unnecessary in the XML output.

XML Elements produced:

The following is a partial list of the elements produced. See the DTD for the complete details.

     translation_unit
     predefined_macro
     object_macro
     command_line
     include_directory
     use_on_code
     preprocessing_file
     identifier
     replaced_identifier
Locations:

Locations are reported as processing instructions as shown in the following example, which indicates line 352 of file /usr/include/features.h.

<?location "/usr/include/features.h" 352?>

Use on code:

This preprocessor includes an extension designed to facilitate the maintenance of multiple configurations in a single file, use on code. To apply use on codes, defined a code for each configuration as shown in the following example:

     lin  Linux
     gnu  GNU/Linux
     unx  Unix
     wno  Windows

Each source line that is not applicable to all configuration can then be tagged using the following method:

     int result;  // Always
    
     result = soundApproach(); //{lin,gnu} // For Linux or GNU/Linux
     result = okApproach(); //{unx}  // For Unix
     result = problematic(); //{wno}  // For Windows
    
     return result;  // Always

Configurations are selected by supplying the desired use on codes in the argument list passed to the process_file method. For example "-Ulin" would select all common lines and all those tagged with lin. Since use on codes are examined before any other parsing takes place, preprocessing instructions may be tagged. Multiple -U arguments result in "or"ing the results.

SEE ALSO

XML::Parser

AUTHOR

Brian M. Ames, <bames@apk.net>

COPYRIGHT AND LICENSE

Copyright (C) 2008 by Brian M. Ames

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 922:

You forgot a '=back' before '=head1'