pae2xml.pl

   1 #!/usr/bin/perl
   2
   3
   4 # Copyright (C) 2003 Rainer Typke
   5 #pae2xml is licensed under the terms of the GNU General Public License Version
   6 #2 as published by the <a href="http://www.fsf.org/" target="_top">Free Software Foundation</a>.
   7 #This gives you legal permission to copy, distribute and/or modify <em>pae2xml</em> under
   8 #certain conditions. Read
   9 #the <a href="http://www.gnu.org/copyleft/gpl.html" target="_top">online version of the license</a>
  10 #for more details. pae2xml is provided AS IS with NO WARRANTY OF ANY KIND,
  11 #INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
  12
  13
  14
  15 $divisions = 960;
  16 $old_duration = $divisions;
  17 $old_octave = 4;
  18
  19 ($mday, $mon, $year) = (localtime()) [3..5];
  20 $encoding_date = sprintf("%4d-%02d-%02d", $year + 1900, $mon+1, $mday);
  21
  22 $TIE = 0;
  23
  24 foreach $a (@ARGV) {
  25   $p = read_file($a);
  26   $toprint = "";
  27   $p =~ s/\s*\=\=+\s*(.*?)\s*\=\=+\s*/$1/sg;
  28   $p =~ s/\s*included.*?-------------*\s*(.*?)\s*/$1/s;
  29
  30   ($q, $r) = ($p, $p);
  31   if ($q !~ /^.*1\.1\.1.*$/gsx && $r =~ /^.*plain.*$/gsx) {
  32     print_error("$a contains 'plain', but not 1.1.1!\n");
  33   } else {
  34     if ($p =~ /^\s*([^\n]+)\n(.*?)\n((\d+\.\d+\.\d.*?plain.*?\n)+)(.*?)\n?([^\n]+)\n([^\n]+)\s*$/gs)    {
  35       my ($comp, $title, $incipits, $sonst, $libsig, $rismsig) = ($1, $2, $3, $5, $6, $7);
  36
  37       $toprint .= "
  38 COMPOSER:   $comp
  39 TITLE:      $title
  40 INCIPIT(S): $incipits
  41 OTHER INFO: $sonst
  42 LIB. SIGN.: $libsig
  43 RISM SIGN.: $rismsig\n\n";
  44       parse_incipits($incipits, $comp, $title, $sonst, $libsig, $rismsig);
  45     }
  46     else { if (index($p,"plain&easy") > -1) {
  47       print_error("Ignoring the following text:\n\n\n$p\n\n\n");
  48            }
  49          }
  50   }
  51 }
  52
  53
  54
  55 sub parse_incipits {
  56   my ($incipits, $comp, $title, $sonst, $libsig, $rismsig) = @_;
  57
  58   $toprint .= "parsing:   $incipits\n";
  59
  60   while ($incipits =~ /^(\d+\.\d+\..+?)(\d+\.\d+\..*)$/gs) {
  61     my ($inc1) = $1;
  62     $incipits = $2;
  63     parse_pe($inc1, $comp, $title, $sonst, $libsig, $rismsig);
  64   }
  65   parse_pe($incipits, $comp, $title, $sonst, $libsig, $rismsig);
  66 }
  67
  68 sub parse_pe {
  69   my ($pe, $comp, $title, $sonst, $libsig, $rismsig) = @_;
  70
  71   $pe =~ s/@ü/@0ü/gs; # make missing time signature explicit
  72   while ($pe =~ s/([^\-])(\d+)(\'|\,)(A|B|C|D|E|F|G)/$1$3$2$4/gs) {};  # octave first, then duration. Truly global.
  73
  74   if ($pe =~ /^\s*(\d+\.\d+\.\d)(\.|:)\s*(.*?)\nplain&easy:\s*(%([\w\-\d]+))?(@([\d\w\/]+))?\s*&?\s*(\$([^ü]+))?ü(.*)$/gs) {
  75     my ($inr, $instr, $clef, $timesig, $keysig, $rest) = ($1, $3, $5, $7, $9, $10);
  76
  77     my $filename="$rismsig-$inr.xml";
  78     $filename =~ s/RISM\s*A\/II\s*:?\s*//gs;
  79     print "Writing $filename...\n";
  80
  81     open(OUT, ">$filename");
  82
  83     if ($clef =~ /^(\w)\-(\d)$/) {
  84       ($clefsign, $clefline) = ($1, $2);
  85     } else {
  86       ($clefsign, $clefline) = ("G", 2);
  87     }
  88
  89     $timesig = timesignature($timesig);
  90
  91     my %fif=("", 0, "xF", 1, "xFC", 2, "xFCG",3, "xFCGD",4, "xFCGDA",5, "xFCGDAE",6, "xFCGDAEB",7, "bB",-1, "bBE",-2, "bBEA",-3, "bBEAD",-4, "bBEADG",-5, "bBEADGC",-6, "bBEADGCF",-7);
  92     $keysig =~ s/(\s+)|&//gs;  # it is unclear what the & means, so we'll ignore it for now.
  93     $keysig =~ s/\[|\]//gs; # IGNORING brackets around a key sig.
  94     $fifths = $fif{$keysig};
  95     if ($fifths eq "") { $fifths = "0";
  96                        print_error("Strange key signature '$keysig'.\n");}
  97
  98     foreach $_ ($rismsig,$title,$inr,$instr,$comp,$encoding_date,$libsig,$sonst)
  99     {
 100         s/
 101 //;
 102     }
 103     print OUT '<?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
 104 <!DOCTYPE score-partwise PUBLIC "-//Recordare//DTD MusicXML 0.6 Partwise//EN" "file:/c:/Program Files/MusicXML/partwise.dtd">
 105 <score-partwise>
 106         <work>
 107                 <work-number>'.$rismsig.'</work-number>
 108                 <work-title>'.$title.'</work-title>
 109         </work>
 110         <movement-number>'.$inr.'</movement-number>
 111         <movement-title>'.$instr.'</movement-title>
 112         <identification>
 113                 <creator type="composer">'.$comp.'</creator>
 114                 <encoding>
 115                         <software>pae2xml by R. Typke</software>
 116                         <encoding-date>'.$encoding_date.'</encoding-date>
 117                 </encoding>
 118                 <source>'.$libsig.'</source>
 119         </identification>
 120         <part-list>
 121                 <score-part id="P1">
 122                         <part-name>'.$sonst.'</part-name>
 123                 </score-part>
 124         </part-list>
 125         <part id="P1">
 126                 <measure number="1">
 127                         <attributes>
 128                                 <divisions>'.$divisions.'</divisions>
 129                                 <key>
 130                                         <fifths>'.$fifths.'</fifths>
 131                                 </key>
 132                                 '.$timesig.'
 133                                 <clef>
 134                                         <sign>'.$clefsign.'</sign>
 135                                         <line>'.$clefline.'</line>
 136                                 </clef>
 137                         </attributes>
 138 ';
 139
 140
 141     $toprint .= "
 142 INCIPIT NO.:  $inr
 143 INSTR.:       $instr
 144 CLEF:         $clef
 145 KEY SIG.:     $keysig
 146 TIME SIG.:    $timesig
 147 REST:         $rest\n";
 148     parse_notes($rest, $keysig);
 149   }
 150   else { print_error("could not parse $pe\n"); }
 151   print OUT "   </part>
 152 </score-partwise>\n";
 153   close OUT;
 154 }
 155
 156
 157 sub parse_notes {
 158   my ($notes, $keysig) = @_;
 159   my $qq = 0; # in group of cue notes
 160
 161   my $meas = 2;   # measure number
 162   my $mopen = 1;  # measure tag still open
 163
 164   if ($notes =~ /^\s*(.*?)\s*$/) {
 165     $notes = $1;
 166   }
 167
 168   $notes =~ s/!([^!]*)!/$1$1/gs;  # write out repetitions
 169   $notes =~ s/\{([^\}]*)\}/$1/gs; # ignore beamings
 170
 171   $notes =~ s/(\d+)\(([^;]+\))/\($1$2/gs;       # pull note lengths into fermatas or triplets
 172   $notes =~ s/(xx|x|bb|b|n)\(/\($1/gs;       # pull accidentals into tuplets or fermatas:
 173   $notes =~ s/(\d+)(xx|x|bb|b|n)(A|B|C|D|E|F|G)/$2$1$3/gs;  # accidentals first, then duration
 174
 175 #  $notes =~ s/x\(/\(x/gs;       # pull accidentals into tuplets or fermatas
 176 #  $notes =~ s/bb\(/\(bb/gs;       # pull accidentals into tuplets or fermatas
 177 #  $notes =~ s/b\(/\(b/gs;       # pull accidentals into tuplets or fermatas
 178 #  $notes =~ s/n\(/\(n/gs;       # pull accidentals into tuplets or fermatas
 179   #  $notes =~ s/(\'+|\,+)\(/\($1/g;       # pull octave marks into tuplets or fermatas
 180
 181   $notes =~ s/(\.|\d|\,|\')qq/qq$1/gs; # pull beginning mark of group of grace notes in front of corresponding notes
 182   $notes =~ s/(xx|x|bb|b|n)qq/qq$1/gs;  # qq first, then parts of notes
 183
 184   $notes =~ s/\=(\d)/$1/gs; # replace multibar rests #n with just n
 185
 186   while ($notes ne "") {
 187     if ($notes =~ /^(\'+|\,+)(.*)$/) {
 188       ($oct, $notes) = ($1, $2);
 189       octave($oct);
 190     } elsif ($notes =~ /^qq(.*)$/) {
 191       $notes = $1;
 192       $qq = 1;
 193     } elsif ($notes =~ /^r(.*)$/) {
 194       $notes = $1;
 195       $qq = 0;
 196     } elsif ($notes =~ /^(\d+|\=)(\/.*)$/) {
 197       $measrest = $1;
 198       $notes = $2;
 199       if ($measrest eq '=') {
 200         $measrest = 1;
 201       }
 202       $toprint .= "$measrest measures of rest.\n";
 203       for $n (1..$measrest) {
 204         print OUT '                     <note>
 205                                 <rest />
 206                                 <duration>'.($beats*$divisions*4/$beattype).'</duration>
 207 '.#                             <type>quarter</type>
 208 '
 209                         </note>
 210 ';
 211         if ($n < $measrest) {
 212           print OUT "           </measure>\n";
 213           if ($notes ne "") {
 214             print OUT '         <measure number="'.$meas.'">
 215 ';
 216             $meas++;
 217           }
 218         }
 219       }
 220     } elsif ($notes =~ /^((\,|\')*(x|xx|b|bb|n)?\d*\.*(g|q)?(\-|A|B|C|D|E|F|G)t?\+?)(.*)$/) {  # a note
 221       ($note, $notes) = ($1,$6);
 222       parse_note($note, $keysig, "", "", $qq);
 223     } elsif ($notes =~ /^(\((\,|\')*(x|xx|b|bb|n)?\d*\.*(g|q)?(\-|A|B|C|D|E|F|G)t?\+?\))(.*)$/) {  # one note with a fermata
 224       ($note, $notes) = ($1,$6);
 225       parse_note($note, $keysig, "", "", $qq);
 226     } elsif ($notes =~ /^(\(((\,|\')*(x|xx|b|bb|n)?\d*\.*(g|q)?(\-|A|B|C|D|E|F|G)t?\+?){3}\))(.*)$/) {  # a triplet
 227       ($triplet, $notes) = ($1,$7);
 228       #      print "TRIPLET: ".$triplet." -> ";
 229       $triplet =~ /^\(((\,|\')*(x|xx|b|bb|n)?\d*\.*(g|q)?(\-|A|B|C|D|E|F|G)t?\+?)(.*)\)$/gs;
 230       ($note, $triplet) = ($1,$6);
 231       #print "$note $triplet\n";
 232       parse_note($note, $keysig, '<tuplet type="start"/>', '                            <time-modification>
 233                                         <actual-notes>3</actual-notes>
 234                                         <normal-notes>2</normal-notes>
 235                                 </time-modification>', $qq);
 236       $triplet =~ /^((\,|\')*(x|xx|b|bb|n)?\d*\.*(g|q)?(\-|A|B|C|D|E|F|G)t?\+?)(.*)$/gs;
 237       ($note, $triplet) = ($1,$6);
 238       #print "$note $triplet\n";
 239       parse_note($note, $keysig,  '', '                         <time-modification>
 240                                         <actual-notes>3</actual-notes>
 241                                         <normal-notes>2</normal-notes>
 242                                 </time-modification>', $qq);
 243       parse_note($triplet,  $keysig, '<tuplet type="stop"/>',  '                                <time-modification>
 244                                         <actual-notes>3</actual-notes>
 245                                         <normal-notes>2</normal-notes>
 246                                 </time-modification>', $qq);
 247     } elsif ($notes =~ /^((\d+)\(((\,|\')*(x|xx|b|bb|n)?\d*\.*(g|q)?(\-|A|B|C|D|E|F|G)t?\+?)+\;(\d+)\))(.*)$/)  {  # an n-tuplet
 248       ($tuplet, $notes) = ($1,$9);
 249       #      print "N-TUPLET: ".$tuplet." -> ";
 250       $tuplet =~ /^(\d+)\(((\,|\')*(x|xx|b|bb|n)?\d*\.*(g|q)?(\-|A|B|C|D|E|F|G)t?\+?)(.*);(\d)\)$/gs;
 251       ($combdur, $note, $tuplet, $numval) = ($1,$2,$7,$8);
 252       #print "i=$combdur, n=$numval; $note / $tuplet\n";
 253       my $ind_dur = duration($combdur)/$numval;
 254       # my $norm_notes =
 255       my $act_notes = $numval;
 256       parse_note($note, $keysig, '<tuplet type="start"/>', '                            <time-modification>
 257                                         <actual-notes>'.$act_notes.'</actual-notes>
 258                                         <normal-notes>1</normal-notes>
 259                                 </time-modification>', $qq);
 260       while ($tuplet =~ /^((\,|\')*(x|xx|b|bb|n)?\d*\.*(g|q)?(\-|A|B|C|D|E|F|G)t?\+?)(.+)$/gs) {
 261         ($note, $tuplet) = ($1,$6);
 262         #print "$note / $tuplet\n";
 263         parse_note($note, $keysig,  '', '                               <time-modification>
 264                                         <actual-notes>'.$act_notes.'</actual-notes>
 265                                         <normal-notes>1</normal-notes>
 266                                 </time-modification>', $qq);
 267       }
 268       parse_note($tuplet,  $keysig, '<tuplet type="stop"/>',  '                         <time-modification>
 269                                         <actual-notes>'.$act_notes.'</actual-notes>
 270                                         <normal-notes>1</normal-notes>
 271                                 </time-modification>', $qq);
 272     } elsif ($notes =~ /^(%\w-\d)(.*)$/) {
 273       ($clef,$notes) = ($1,$2);
 274       $clef =~ /^%(\w)\-(\d)$/;
 275       ($clefsign, $clefline) = ($1, $2);
 276       print OUT '                       <attributes>
 277                                 <clef>
 278                                         <sign>'.$clefsign.'</sign>
 279                                         <line>'.$clefline.'</line>
 280                                 </clef>
 281                         </attributes>
 282 ';
 283     } elsif ($notes =~ /^@(\d\/\d|c\/?)\s*(.*)$/) {
 284       # print "$notes\n";
 285       ($timesig,$notes) = ($1,$2);
 286       #print "-> $timesig / $notes\n"; exit;
 287       $timesig = timesignature($timesig);
 288       print OUT "                       <attributes>\n$timesig
 289                         </attributes>\n";
 290     } elsif ($notes =~ /^\/(.*)$/) {
 291       $notes = $1;
 292       if ($notes =~ /^\/(.*)$/) {
 293         $notes = $1;
 294         print OUT '       <barline location="right">
 295                                 <bar-style>light-light</bar-style>
 296
 297                         </barline>
 298 ';
 299       }
 300       print OUT "               </measure>\n";
 301       if ($notes ne "") {
 302         print OUT '             <measure number="'.$meas.'">
 303 '.$clefattr;
 304         $meas++;
 305       } else {
 306         $mopen = 0;
 307       }
 308       $toprint .= "bar line\n";
 309     } #elsif ($notes =~ /^(\d*\.*\-)(.*)$/) {
 310       #($rst, $notes) = ($1, $2);
 311       #$toprint .= "rest: $rst\n";
 312       #$rst =~ /^(\d*)(\.*)\-$/;
 313       #($rst, $dots) =($1,$2);
 314       #print OUT '                      <note>
 315         #                       <rest />
 316         #                       <duration>'.duration($rst, $dots).'</duration>
 317 #'.#                            <type>quarter</type>
 318 #'
 319 #                       </note>
 320 #';
 321     elsif ($notes =~ /^\((\=)\)(.*)$/) {  # a bar of rest with a fermata
 322       ($rst, $notes) = ($1, $2);
 323       $toprint .= "rest: $rst\n";
 324       print OUT '                       <note>
 325                                 <rest />
 326                                 <duration>'.($beats*$divisions*4/$beattype).'</duration>
 327 '.#                             <type>quarter</type>
 328 '                               <notations>
 329                                         <fermata type="upright"/>
 330                                 </notations>
 331                         </note>
 332 ';
 333     }
 334     elsif ($notes =~ s/(\d+\.*)\(((\,|\')*(x|xx|b|bb|n)?\d*\.*(g|q)?(\-|A|B|C|D|E|F|G)t?\+?)\)/\($1$2\)/gs) { # pull duration into fermata parentheses
 335       #      print "after replacement: $notes\n"; exit;
 336     }
 337     else {
 338       print_error("got stuck with $notes\n");
 339       $notes = "";
 340     }
 341   }
 342   if ($mopen) {
 343     print OUT "         </measure>\n";
 344   }
 345 }
 346
 347
 348 sub parse_note {
 349   my($note, $keysig, $notation, $addition, $in_qq_group) = @_;
 350
 351   my ($fermata) = (0);
 352   my ($actualnotes, $normalnotes) = (1,1);
 353
 354   if ($addition =~ /^\s*<time-modification>\s*<actual-notes>\s*(\d+)\s*<\/actual-notes>\s*<normal-notes>\s*(\d+)\s*<\/normal-notes>\s*<\/time-modification>\s*$/) {
 355     ($actualnotes, $normalnotes) = ($1, $2);
 356   }
 357
 358   if ($note =~ /^\((.*)\)$/) {
 359     $note = $1;
 360     $fermata = 1;
 361   }
 362
 363   $note =~ /^((\,|\')*)(x|xx|b|bb|n)?(\d*)(\.*)(g|q)?(\-|A|B|C|D|E|F|G)(t?)(\+?)$/;
 364   my ($oct, $acc, $dur, $dot, $gracecue, $pitch, $trill, $tie) = ($1, $3, $4, $5, $6, $7, $8, $9);
 365
 366   print OUT '                   <note>
 367 ';
 368   if ($gracecue eq "g") {
 369     print OUT '         <grace steal-time-following="33"/>
 370 ';
 371   }
 372   if ($gracecue eq "q" || $in_qq_group) {
 373     print OUT '         <cue/>
 374 ';
 375   }
 376   if ($pitch eq "-") {
 377     print OUT "                 <rest />\n";
 378   } else {
 379     print OUT '                         <pitch>
 380                                         <step>'.$pitch.'</step>
 381 '.
 382    alter($pitch, $acc, $keysig).'
 383                                         <octave>'.octave($oct).'</octave>
 384                                 </pitch>
 385 ';
 386   }
 387   if ($gracecue ne "g") {
 388     print OUT '                         <duration>'.(duration($dur, $dot)*$normalnotes/$actualnotes).'</duration>
 389 ';
 390   }
 391 #                               <type>quarter</type>
 392
 393   if ($tie eq "+") {
 394     if (!$TIE) {
 395       $TIE = 1;
 396       print OUT '<tie type="start"/>
 397 ';
 398     }
 399   } else {
 400     if ($TIE) {
 401       print OUT '<tie type="stop"/>
 402 ';
 403       $TIE = 0;
 404     }
 405   }
 406
 407   print OUT $addition;
 408
 409   my $notationbracket = $fermata || ($trill eq "t") || ($notation ne "");
 410   if ($notationbracket) {
 411     print OUT "                         <notations>\n";
 412   }
 413   if ($fermata) { print OUT '
 414                                         <fermata type="upright"/>'."\n"; }
 415   if ($trill eq "t") { print OUT '                                      <ornaments>
 416                                                 <trill-mark/>
 417                                         </ornaments>
 418 ';
 419                      }
 420   if ($notation ne "") {
 421     print OUT "                         $notation\n";
 422   }
 423   if ($notationbracket) {
 424     print OUT "                         </notations>\n";
 425   }
 426
 427   print OUT '                   </note>
 428 ';
 429
 430   $toprint .= "note: oct. $oct/acc. $acc/dur. $dur/dots $dot/grace,cue $gracecue/pitch $pitch\n";
 431 }
 432
 433 sub alter {
 434   my ($pitch, $acc, $keysig) = @_;
 435
 436   my $alt = 0;
 437
 438   if (index ($keysig,$pitch) > -1) {
 439     $keysig =~ /^(.).*$/gs;
 440     if ($1 eq 'x') {
 441       $alt = 1;
 442     } else {$alt = -1;}
 443   }
 444
 445   my %acc_alt = ("n", 0, "b", -1, "bb", -2, "x", 1, "xx", 2);
 446   if ($acc_alt{$acc} ne "") {
 447     $alt = $acc_alt{$acc};
 448   }
 449
 450   if ($alt != 0) {
 451     return "<alter>$alt</alter>\n";
 452   }
 453   return "";
 454 }
 455
 456 sub duration {
 457   my ($duration, $dots) = @_;
 458
 459   if ($duration.$dots ne "") {
 460     my %du=("1",4*$divisions,"2",2*$divisions,"4",$divisions,
 461             "8",$divisions/2,"6",$divisions/4,"3",$divisions/8,
 462             "5",$divisions/16,"7",$divisions/32,
 463             "9",$divisions*8,"0",$divisions*16); # breve/long
 464     $old_duration = $du{$duration};
 465     if ($old_duration eq "") {
 466       print_error("strange duration '$duration'\n");
 467     }
 468     my $add = $old_duration;
 469     while ($dots ne "") {
 470       $add /= 2;
 471       $old_duration += $add;
 472       $dots =~ /^.(.*)$/gs;
 473       $dots = $1;
 474     }
 475   }
 476   return $old_duration;
 477 }
 478
 479 sub octave {
 480   my ($octave) = @_;
 481
 482   if ($octave ne "") {
 483     $octave =~ /^(.)(.*)$/gs;
 484     if ($1 eq ",") {
 485       $old_octave = 4 - length $octave;
 486     } else {
 487       $old_octave = 3 + length $octave;
 488     }
 489   }
 490   return $old_octave;
 491 }
 492
 493 sub timesignature {
 494   my ($timesig) = @_;
 495
 496   if ($timesig eq "c3") {
 497     $timesig = "3/2";  # it would be better to display it as "C". Example: 451.023.814
 498   }
 499   if ($timesig =~ /^c(\d+)\/(\d+)$/gs) {
 500     $timesig = "$1/$2";  # it would be better to show the "C"
 501   }
 502
 503   if ($timesig eq "0" || $timesig eq "") {  # unclear how to handle absence of time signature.
 504     $timesig ='<time symbol="common">
 505       <beats>4</beats>
 506       <beat-type>4</beat-type>
 507     </time>
 508 ';  # using 4/4 for now.
 509     ($beats, $beattype) = (4,4);
 510   } elsif ($timesig =~ /^c(\/?)$/gi) {
 511     if ($1 eq "/") {
 512       $timesig = '<time symbol="cut">
 513       <beats>2</beats>
 514       <beat-type>2</beat-type>
 515     </time>
 516 ';
 517       ($beats, $beattype) = (2,2);
 518     } else {
 519       $timesig = '<time symbol="common">
 520       <beats>4</beats>
 521       <beat-type>4</beat-type>
 522     </time>
 523 ';
 524       ($beats, $beattype) = (4,4);
 525     }
 526   } elsif ($timesig =~ /^(\d+)\/(\d+)$/gs) {
 527     ($beats, $beattype) = ($1, $2);
 528     $timesig = '<time>
 529       <beats>'.$beats.'</beats>
 530       <beat-type>'.$beattype.'</beat-type>
 531     </time>
 532 ';
 533   } else {
 534     print_error("Time signature '$timesig' looks strange.\n");
 535     #   $timesig = "";   we assume 4/4 just to  get something legible:
 536     ($beats, $beattype) = (4,4);
 537     $timesig = '<time>
 538       <beats>'.$beats.'</beats>
 539       <beat-type>'.$beattype.'</beat-type>
 540     </time>
 541 ';
 542   }
 543   return $timesig;
 544 }
 545
 546 sub print_error {
 547   my ($msg) = @_;
 548
 549   print "\nAn error occurred; context:\n\n$toprint\n
 550 Error: $msg\n";
 551 }
 552
 553 sub read_file {
 554   my ($fn) = @_;
 555   if (!(open FH, $fn))
 556     {
 557       return "";
 558     }
 559   my $res = "";
 560   while (<FH>) { $res .= $_; } # read all lines
 561   close (FH);
 562   return $res;
 563 }