tools/build/fixup_gen_file.pl

   1 #! perl
   2 # Copyright (C) 2007, Parrot Foundation.
   3 # $Id$
   4
   5 =head1 NAME
   6
   7 tools/build/fixup_gen_file.pl - mark a generated file as generated
   8
   9 =head1 SYNOPSIS
  10
  11     % perl tools/build/fixup_gen_file.pl <options> <generated_file> <dest_file>
  12
  13 =head1 DESCRIPTION
  14
  15 This script adds special headers and footers to files generated by tools
  16 outside of Parrot's normal build process.  This is so that people do not
  17 accidentally modify these files.
  18
  19 =head1 OPTIONS
  20
  21 =over 4
  22
  23 =item noheaderizer
  24
  25 This option adds directives to C<dest_file> that instruct headerizer to ignore
  26 the file.
  27
  28 =back
  29
  30 =cut
  31
  32 use strict;
  33 use warnings;
  34
  35 use Getopt::Long;
  36 use lib 'lib';
  37 use Parrot::BuildUtil;
  38
  39 GetOptions( \my %opts, "noheaderizer", ) or die "error processing options";
  40
  41 my ( $gen_file, $source ) = @ARGV;
  42 my $contents =
  43     -e $gen_file
  44     ? Parrot::BuildUtil::slurp_file($gen_file)
  45     : die "Cannot find '$gen_file': $!\n";
  46
  47 # fix slashies in source filename for display in header
  48 $source =~ s/\\/\//g;
  49
  50 my $header = Parrot::BuildUtil::generated_file_header( $source, 'c' );
  51
  52 my $noheaderizer = <<END_NOHEADERIZER;
  53 /* HEADERIZER HFILE: none */
  54 /* HEADERIZER STOP */
  55 END_NOHEADERIZER
  56
  57 # if the generated file exists, make sure the header isn't there already
  58 open( my ($gen_fh), '<', $gen_file )
  59     or die "Cannot read '$gen_file': $!\n";
  60 read $gen_fh, my $block, length $header;
  61 exit if $block eq $header;
  62
  63 open( my $dest_fh, '>', $gen_file )
  64     or die "Cannot write to '$gen_file': $!\n";
  65
  66 print {$dest_fh} $header, ( exists $opts{noheaderizer} ? $noheaderizer : () ), $contents;
  67
  68 close $dest_fh;
  69
  70 # Local Variables:
  71 #   mode: cperl
  72 #   cperl-indent-level: 4
  73 #   fill-column: 100
  74 # End:
  75 # vim: expandtab shiftwidth=4: