ghc/driver/ghc-iface.lprl

   1 %************************************************************************
   2 %*                                                                      *
   3 \section[Driver-iface-thing]{Interface-file handling}
   4 %*                                                                      *
   5 %************************************************************************
   6
   7 \begin{code}
   8 %OldVersion = ();
   9 %Decl    = (); # details about individual definitions
  10 %Stuff   = (); # where we glom things together
  11 %HiExists      = ('old',-1,  'new',-1); # 1 <=> definitely exists; 0 <=> doesn't
  12 %HiHasBeenRead = ('old', 0,  'new', 0);
  13 %ModuleVersion = ('old', 0,  'new', 0);
  14
  15
  16
  17 sub postprocessHiFile {
  18     local($hsc_hi,              # The iface info produced by hsc.
  19           $hifile_target,       # The name both of the .hi file we
  20                                 # already have and which we *might*
  21                                 # replace.
  22           $going_interactive) = @_;
  23
  24     local($new_hi) = "$Tmp_prefix.hi-new";
  25     local($show_hi_diffs) = $HiDiff_flag && ! $HiOnStdout && ! $going_interactive && -f $hifile_target;
  26
  27     print STDERR "*** New hi file follows...\n" if $Verbose;
  28     system("$Cat $hsc_hi 1>&2") if $Verbose;
  29
  30     &constructNewHiFile($hsc_hi, $hifile_target, $new_hi, $show_hi_diffs);
  31
  32     # run diff if they asked for it
  33     if ($show_hi_diffs) {
  34         if ( $HiDiff_flag eq 'usages' ) {
  35             # lots of near-useless info; but if you want it...
  36             &run_something("$Cmp -s $hifile_target $new_hi || $Diff $hifile_target $new_hi 1>&2 || exit 0",
  37                 "Diff'ing old and new .$HiSuffix files"); # NB: to stderr
  38         } else {
  39             # strip out usages, *then* run diff
  40             local($hi_before) = "$Tmp_prefix.hi-before";
  41             local($hi_after)  = "$Tmp_prefix.hi-now";
  42
  43             &deUsagifyHi($hifile_target, $hi_before);
  44             &deUsagifyHi($new_hi,        $hi_after);
  45
  46             &run_something("$Cmp -s $hi_before $hi_after || $Diff $hi_before $hi_after 1>&2 || exit 0",
  47                 "Diff'ing old and new .$HiSuffix files"); # NB: to stderr
  48         }
  49     }
  50
  51     # if we produced an interface file "no matter what",
  52     # print what we got on stderr (ToDo: honor -ohi flag)
  53     if ( $HiOnStdout ) {
  54         system("$Cat $new_hi 1>&2") if $Verbose;
  55     } else {
  56         &run_something("$Cmp -s $hifile_target $new_hi || ( $Rm $hifile_target && $Cp $new_hi $hifile_target )",
  57            "Replace .$HiSuffix file, if changed");
  58     }
  59 }
  60
  61 sub deUsagifyHi {
  62     local($ifile,$ofile) = @_;
  63
  64     open(OLDHIF, "< $ifile") || &tidy_up_and_die(1,"Can't open $ifile (read)\n");
  65     open(NEWHIF, "> $ofile") || &tidy_up_and_die(1,"Can't open $ofile (write)\n");
  66
  67     # read up to _usages_ line
  68     $_ = <OLDHIF>;
  69     while ($_ ne '' && ! /^_usages_/) {
  70         print NEWHIF $_ unless /^(_interface_ |\{-# GHC_PRAGMA)/;
  71         $_ = <OLDHIF>;
  72     }
  73     if ( $_ ne '' ) {
  74         # skip to next _<anything> line
  75         $_ = <OLDHIF>;
  76         while ($_ ne '' && ! /^_/) { $_ = <OLDHIF>; }
  77
  78         # print the rest
  79         while ($_ ne '') {
  80             print NEWHIF $_;
  81             $_ = <OLDHIF>;
  82         }
  83     }
  84
  85     close(OLDHIF) || &tidy_up_and_die(1,"Failed reading from $ifile\n");
  86     close(NEWHIF) || &tidy_up_and_die(1,"Failed writing to $ofile\n");
  87 }
  88 \end{code}
  89
  90 \begin{code}
  91 sub constructNewHiFile {
  92     local($hsc_hi,          # The iface info produced by hsc.
  93           $hifile_target,   # Pre-existing .hi filename (if it exists)
  94           $new_hi,          # Filename for new one
  95           $show_hi_diffs) = @_;
  96
  97     &readHiFile('old',$hifile_target) unless $HiHasBeenRead{'old'} == 1;
  98     &readHiFile('new',$hsc_hi)        unless $HiHasBeenRead{'new'} == 1;
  99
 100     open(NEWHI, "> $new_hi") || &tidy_up_and_die(1,"Can't open $new_hi (write)\n");
 101
 102     local(@decl_names) = ();    # Entities in _declarations_ section of new module
 103     foreach $v (sort (keys %Decl)) {
 104         next unless $v =~ /^new:(.*$)/;
 105         push(@decl_names,$1);
 106     }
 107
 108     local($new_module_version) = &calcNewModuleVersion(@decl_names);
 109     print NEWHI "_interface_ ", $ModuleName{'new'}, " $new_module_version\n";
 110
 111     if ( $Stuff{'new:instance_modules'} ) {
 112         print NEWHI "_instance_modules_\n";
 113         print NEWHI $Stuff{'new:instance_modules'};
 114     }
 115
 116     print NEWHI "_usages_\n", $Stuff{'new:usages'} unless $Stuff{'new:usages'} eq '';
 117
 118     print NEWHI "_exports_\n";
 119     print NEWHI $Stuff{'new:exports'};
 120
 121     if ( $Stuff{'new:fixities'} ) {
 122         print NEWHI "_fixities_\n";
 123         print NEWHI $Stuff{'new:fixities'};
 124     }
 125
 126     if ( $Stuff{'new:instances'} ) {
 127         print NEWHI "_instances_\n";
 128         print NEWHI $Stuff{'new:instances'};
 129     }
 130
 131     print NEWHI "_declarations_\n";
 132     foreach $v (@decl_names) {
 133         &printNewItemVersion(NEWHI, $v, $new_module_version, $show_hi_diffs);           # Print new version number
 134         print NEWHI $Decl{"new:$v"};            # Print the new decl itself
 135     }
 136
 137
 138
 139     close(NEWHI) || &tidy_up_and_die(1,"Failed writing to $new_hi\n");
 140 }
 141 \end{code}
 142
 143 \begin{code}
 144 sub readHiFile {
 145     local($mod,             # module to read; can be special tag 'old'
 146                             # (old .hi file for module being compiled) or
 147                             # 'new' (new proto-.hi file for...)
 148           $hifile) = @_;    # actual file to read
 149
 150     # info about the old version of this module's interface
 151     $HiExists{$mod}      = -1; # 1 <=> definitely exists; 0 <=> doesn't
 152     $HiHasBeenRead{$mod} = 0;
 153     $ModuleVersion{$mod} = 0;
 154     $Stuff{"$mod:instance_modules"} = '';
 155     $Stuff{"$mod:usages"}           = ''; # stuff glommed together
 156     $Stuff{"$mod:exports"}          = '';
 157     $Stuff{"$mod:fixities"}         = '';
 158     $Stuff{"$mod:instances"}        = '';
 159     $Stuff{"$mod:declarations"}     = '';
 160
 161     if (! -f $hifile) { # no pre-existing .hi file
 162         $HiExists{$mod} = 0;
 163         return();
 164     }
 165
 166     open(HIFILE, "< $hifile") || &tidy_up_and_die(1,"Can't open $hifile (read)\n");
 167     $HiExists{$mod} = 1;
 168     local($now_in) = '';
 169     hi_line: while (<HIFILE>) {
 170         next if /^ *$/; # blank line
 171         next if /\{-# GHC_PRAGMA INTERFACE VERSION 20 #-\}/;
 172
 173         # avoid pre-1.3 interfaces
 174         #print STDERR "now_in:$now_in:$_";
 175         if ( /\{-# GHC_PRAGMA INTERFACE VERSION . #-\}/ ) {
 176             $HiExists{$mod} = 0;
 177             last hi_line;
 178         }
 179
 180         if ( /^_interface_ ([A-Z]\S*) (\d+)/ ) {
 181             $ModuleName{$mod}    = $1; # not sure this is used much...
 182             $ModuleVersion{$mod} = $2;
 183
 184         } elsif ( /^_interface_ ([A-Z]\S*)/ && $mod eq 'new' ) { # special case: no version
 185             $ModuleName{'new'} = $1;
 186
 187         } elsif ( /^_([a-z_]+)_$/ ) {
 188             $now_in = $1;
 189
 190         } elsif ( $now_in eq 'usages' && /^(\S+)\s+(\d+)\s+:: (.*)/ ) {
 191             $Stuff{"$mod:usages"} .= $_; # save the whole thing
 192
 193
 194         } elsif ( $now_in =~ /^(exports|instance_modules|instances|fixities)$/ ) {
 195             $Stuff{"$mod:$1"} .= $_; # just save it up
 196
 197         } elsif ( $now_in eq 'declarations' ) { # relatively special treatment needed...
 198         # We're in a declaration
 199
 200         # Strip off the initial version number, if any
 201            if ( /^([0-9]+) (.*\n)/ ) {
 202                 # The "\n" is because we need to keep the newline at the end, so that
 203                 # it looks the same as if there's no version number and this if statement
 204                 # doesn't fire.
 205
 206                 # So there's an initial version number
 207                 $version = $1;
 208                 $_ = $2;
 209            }
 210
 211             if ( /^(\S+)\s+_:_\s+/ ) {
 212                 $current_name = $1;
 213                 $Decl{"$mod:$current_name"} = $_;
 214                 if ($mod eq "old") { $OldVersion{$current_name} = $version; }
 215
 216             } elsif ( /^type\s+(\S+)/ ) {
 217                 $current_name = $1;
 218                 $Decl{"$mod:$current_name"} = $_;
 219                 if ($mod eq "old") { $OldVersion{$current_name} = $version; }
 220
 221             } elsif ( /^(newtype|data)\s+(.*\s+=>\s+)?(\S+)\s+/ ) {
 222                 $current_name = $3;
 223                 $Decl{"$mod:$current_name"} = $_;
 224                 if ($mod eq "old") { $OldVersion{$current_name} = $version; }
 225
 226             } elsif ( /class\s+(.*\s+=>\s+)?(\S+)\s+.*where\s+\{.*\};/ ) {
 227                 # must be wary of => bit matching after "where"...
 228                 $current_name = $2;
 229                 $Decl{"$mod:$current_name"} = $_;
 230                 if ($mod eq "old") { $OldVersion{$current_name} = $version; }
 231
 232             } elsif ( /class\s+(.*\s+=>\s+)?(\S+)\s+/ ) {
 233                 $current_name = $2;
 234                 $Decl{"$mod:$current_name"} = $_;
 235                 if ($mod eq "old") { $OldVersion{$current_name} = $version; }
 236
 237             } else { # Continuation line
 238                 $Decl{"$mod:$current_name"} .= $_
 239             }
 240
 241         } elsif ( /^--.*/ ) { # silently ignore comment lines.
 242             ;
 243         } else {
 244             print STDERR "$Pgm:junk old iface line?:section:$now_in:$_";
 245         }
 246     }
 247
 248 #   foreach $i ( sort (keys %Decl)) {
 249 #       print STDERR "$i: ",$Decl{$i}, "\n";
 250 #   }
 251
 252     close(HIFILE) || &tidy_up_and_die(1,"Failed reading from $hifile\n");
 253     $HiHasBeenRead{$mod} = 1;
 254 }
 255 \end{code}
 256
 257 \begin{code}
 258 sub calcNewModuleVersion {
 259     local (@decl_names) = @_;
 260
 261     return(&mv_change(1,'no old .hi file')) if $HiExists{'old'} == 0;
 262         # could use "time()" as initial version; if a module existed, then was deleted,
 263         # then comes back, we don't want the resurrected one to have an
 264         # lower version number than the original (in case there are any
 265         # lingering references to the original in other .hi files).
 266
 267     local($unchanged_version) = $ModuleVersion{'old'}; # will return one of these two
 268     local($changed_version)   = $unchanged_version + 1;
 269
 270 # This statement is curious; it is subsumed by the foreach!
 271 #    return(&mv_change($changed_version,'usages changed')) if $Stuff{'old:usages'} ne $Stuff{'new:usages'};
 272
 273     foreach $t ( 'usages' , 'exports', 'instance_modules', 'instances', 'fixities' ) {
 274         return(&mv_change($changed_version,"$t changed")) if $Stuff{"old:$t"} ne $Stuff{"new:$t"};
 275     }
 276
 277 # Decl need separate treatment; they aren't in $Stuff
 278     foreach $v (@decl_names) {
 279         return(&mv_change($changed_version,"$v changed")) if $Decl{"old:$v"} ne $Decl{"new:$v"};
 280     }
 281
 282     print STDERR "Module version unchanged at $unchanged_version\n";
 283     return($unchanged_version);
 284 }
 285
 286 sub mv_change {
 287     local($mv, $str) = @_;
 288
 289     print STDERR "$Pgm: module version changed to $mv; reason: $str\n";
 290     return($mv);
 291 }
 292
 293 sub printNewItemVersion {
 294     local($hifile, $item, $mod_version, $show_hi_diffs) = @_;
 295     local($idecl) = $Decl{"new:$item"};
 296
 297     if (! defined($Decl{"old:$item"})) {        # Old decl doesn't exist
 298         if ($show_hi_diffs) {print STDERR "new: $item\n";}
 299         print $hifile  "$mod_version ";         # Use module version
 300
 301     } elsif ($idecl ne $Decl{"old:$item"})  {   # Old decl differs from new decl
 302         local($odecl) = $Decl{"old:$item"};
 303         if ($show_hi_diffs) {print STDERR "changed: $item\nOld: $odecl\nNew: $idecl\n";}
 304         print $hifile  "$mod_version ";         # Use module version
 305
 306     } elsif (! defined($OldVersion{"$item"}) ) {
 307         if ($show_hi_diffs) {print STDERR "$item: no old version?!\n";}
 308         print $hifile  "$mod_version ";                 # Use module version
 309
 310     } else {                                    # Identical decls, so use old version number
 311         if ($show_hi_diffs) {print STDERR "$item: unchanged\n";}
 312         print $hifile  $OldVersion{"$item"}, " ";
 313     }
 314     return;
 315 }
 316 \end{code}
 317
 318 \begin{code}
 319 sub findHiChanges {
 320     local($hsc_hi,              # The iface info produced by hsc.
 321           $hifile_target) = @_; # Pre-existing .hi filename (if it exists)
 322 }
 323 \end{code}
 324
 325 \begin{code}
 326 # make "require"r happy...
 327 1;
 328 \end{code}