utils/scripts/pcb_backannotate

   1 #!/usr/bin/perl -w
   2 #
   3 # $Id$
   4 #
   5 # Copyright (C) 2003, 2006 Dan McMahill
   6 #
   7 # This program is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 2 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program; if not, write to the Free Software
  19 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20
  21
  22 # This script is used to process annotation files from the PCB
  23 # program (http://pcb.gpleda.org) to backannotate
  24 # changes to gEDA schematics.
  25 #
  26 # It is heavily based on the pads_backannotate program which is also
  27 # part of gEDA
  28
  29 # for parsing input options
  30 use Getopt::Long;
  31
  32 # for ceil function
  33 use POSIX;
  34
  35 # don't allow -he to be interpreted as --help
  36 $Getopt::Long::autoabbrev=0;
  37
  38 &GetOptions( ("help" => \&usage,
  39               "nocopy" => \$nocopy,
  40               "verbose" => \$verbose,
  41               "version" => \&version
  42              ) );
  43
  44 usage() if $Getopt::Long::error;
  45 usage() unless @ARGV;
  46
  47 # Annotation file name
  48 $eco = shift( @ARGV );
  49
  50 # if no schematic names follow, exit
  51 usage() unless @ARGV;
  52
  53 # make sure the input netlist exists and we can open it
  54 $i = 0;
  55 while( @ARGV ) {
  56   $fname[$i] = shift( @ARGV );
  57   die "Schematic file $fname[$i] does not exist or can not be read"
  58     unless -r $fname[$i];
  59   $i++;
  60 }
  61
  62 $filecnt = $i;
  63
  64
  65 if( $verbose ){ print "Loading PCB annotation file file: $eco\n"; }
  66 #$eco_state="DEFAULT";
  67 open( ECO, "$eco" ) or die "Can't open PCB annotation file $eco !\n";
  68
  69 my $ver = 0;
  70 while( $line = <ECO> ) {
  71     if( $line =~ /^\*FILEVERSION\* / ) {
  72         $ver = $line;
  73         $ver =~ s/^\*FILEVERSION\*\s*//;
  74         $ver =~ s/[^0-9]*$//;
  75     } elsif( $line =~ /^\*VERSION\* 20060814/ ) {
  76         $ver = 20060814;
  77     }
  78 }
  79 close( ECO );
  80
  81 if( $ver == 0) {
  82     print "ERROR:  Unable to determine annotation file version.\n";
  83     exit( 1 );
  84 }
  85
  86 print "Annotation file version is $ver\n" if $verbose ;
  87 if( $ver != 20061031 && $ver != 20060814 ) {
  88     print "ERROR:  This version of the program is unable to process\n";
  89     print "        PCB annotation files of version $ver.\n";
  90     exit( 1 );
  91 }
  92
  93
  94 # reopen and parse the file this time
  95 open( ECO, "$eco" ) or die "Can't open PCB annotation file $eco !\n";
  96 while( $line = <ECO> ) {
  97     #  if( $verbose ){ print "$line\n"; }
  98     if( $line =~ /^\*COMMENT\*/ ) {
  99         print "Skipping comment line: $line\n";
 100         next;
 101     } elsif( $line =~ /^\*VERSION\* 20060814/ || $line =~ /^\*FILEVERSION\* [0-9]*/) {
 102         # the version line.  Note that the very first version of the annotation
 103         # file used *VERSION* but it was quickly changed to FILEVERSION to avoid
 104         # confusing it with the program version.
 105         next;
 106     } elsif( $line =~ /^\*RENAME\*/ ) {
 107         # rename refdes in design (forward/backward annotation)
 108         #$eco_state="RENAME";
 109         print " *RENAME* (Refdes Renumber)\n" if $verbose;
 110         $line =~ s/^\*RENAME\*\s*//;
 111         parseRENAME($line);
 112         next;
 113     } elsif( $line =~ /^\*WARN\*/ ) {
 114         # A warning generated by PCB
 115         print "Found the following warning in the annotation file:\n";
 116         print "$line\n";
 117         next;
 118     } elsif( $line =~ /^\*/ ) {
 119         print "WARNING:  Unknown command line:\n";
 120         print "          $line\n";
 121         $eco_state="DEFAULT";
 122         next;
 123     } else {
 124         # this must be a data line
 125         #if( $verbose ){ print "Processing data line: $line"; }
 126     }
 127
 128 }
 129 close( ECO );
 130
 131 for($i=0; $i < $filecnt; $i++) {
 132   print "Processing schematic file #", $i+1, ": $fname[$i]\n";
 133   open(NETLIST,"$fname[$i]") or
 134     die "Can't open schematic $fname[$i]: $!\n";
 135
 136   # open output netlist
 137   $outfname="$fname[$i].new";
 138   open(OUTSCH,">$outfname") or die "Can't open $outfname: $!\n";
 139
 140     while($line = <NETLIST>) {
 141         $line = executeRENAME($line);
 142         print OUTSCH "$line";
 143     }
 144     close(NETLIST);
 145     close(OUTSCH);
 146
 147     if( $nocopy ) {
 148       print "Leaving page #",$i+1," output in $outfname\n";
 149     }
 150     else {
 151       system("mv $outfname $fname[$i]");
 152     }
 153
 154 }
 155
 156 print "\n---- Gate Swapping ----\n";
 157 executeSWPGATES();
 158 print "\n---- Pin  Swapping ----\n";
 159 executeSWPPINS();
 160 print "\nBackannotation finished ", scalar localtime, "\n";
 161
 162 exit;
 163
 164
 165 #######################################################################
 166 #
 167 # Subroutines
 168 #
 169 #######################################################################
 170
 171 #---------------------------------
 172 # executeRENAME(line)
 173 #---------------------------------
 174
 175 sub executeRENAME {
 176   my $line = shift(@_);
 177
 178   return $line unless defined %cmd_rename;
 179   return $line unless $line =~ /^refdes=/;
 180
 181   # pick out the reference designator
 182   $refdes = $line;
 183   $refdes =~ s/^refdes=//;
 184   $refdes =~ s/[\r\n]*$//;
 185
 186   # see if its listed in our hash of reference designators to be
 187   # renamed
 188   return $line unless exists $cmd_rename{$refdes};
 189
 190   print "executeRENAME():  Renaming $refdes to $cmd_rename{$refdes}\n"
 191       if $verbose;
 192   return "refdes=$cmd_rename{$refdes}\n";
 193
 194 }
 195
 196 #---------------------------------
 197 # executeSWPGATES()
 198 #---------------------------------
 199
 200 sub executeSWPGATES {
 201   my $key;
 202
 203   foreach $key (keys %cmd_swap_gates ) {
 204     print "Please manually swap gates $key and  $cmd_swap_gates{$key}\n";
 205   }
 206 }
 207
 208 #---------------------------------
 209 # executeSWPPINS()
 210 #---------------------------------
 211
 212 sub executeSWPPINS {
 213   my $key;
 214   my @pins;
 215
 216   foreach  $key (keys %cmd_swap_pins ) {
 217     @pins = split '\.',,$cmd_swap_pins{$key};
 218     print "Please manually swap pins $pins[0] and $pins[1] on $key\n";
 219   }
 220 }
 221
 222 #---------------------------------
 223 # parseRENAME(line)
 224 #---------------------------------
 225
 226 sub parseRENAME {
 227   my $line = shift(@_);
 228   my @refs;
 229   @refs = split ' ',,$line;
 230
 231   $refs[0] =~ s/"//g; # "
 232   $refs[1] =~ s/"//g; # "
 233
 234   print "parseRENAME():  Scheduling rename of $refs[0] to $refs[1]\n"
 235       if $verbose;
 236   $cmd_rename{$refs[0]} = $refs[1];
 237
 238 }
 239
 240 #---------------------------------
 241 # parseSWPGATES(line)
 242 #---------------------------------
 243
 244 sub parseSWPGATES {
 245   my $line = shift(@_);
 246   my @refs;
 247   @refs = split ' ',,$line;
 248
 249   print "parseSWPGATES():  Scheduling swap of gate $refs[0] with $refs[1]\n"
 250       if $verbose;
 251   $cmd_swap_gates{$refs[0]} = $refs[1];
 252
 253 }
 254
 255 #---------------------------------
 256 # parseSWPPINS(line)
 257 #---------------------------------
 258
 259 sub parseSWPPINS {
 260   my $line = shift(@_);
 261   @refs = split ' ',,$line;
 262   @pins = split '\.',,$refs[1];
 263
 264   print "parseSWPPINS():  Scheduling swap of pins on $refs[0] : pins ",
 265   "$pins[0] and $pins[1]\n" if $verbose;
 266   $cmd_swap_pins{$refs[0]} = $refs[1];
 267
 268 }
 269
 270 #---------------------------------
 271 # usage()
 272 #
 273 # prints program usage
 274 #---------------------------------
 275
 276 sub usage {
 277   my $pname = $0;
 278   $pname =~ s/.*\///g;
 279
 280   print <<EOF;
 281
 282 Usage:
 283
 284   $pname [--nocopy] [--verbose] change.log file1.sch [file2.sch ...]
 285   $pname --help\n
 286   $pname --version\n
 287
 288 $pname reads a PCB annotation file and backannotates changes\n
 289 to a gEDA schematic.
 290
 291 $pname accepts the following options:
 292
 293   --help      Displays this help message.
 294
 295   --nocopy    If given, this flag leaves the modified files in new files
 296               whose names are generated by appending a \".new\" to the
 297               original file names.  The default is to overwrite the original.
 298
 299   --verbose   Enables verbose output.
 300
 301   --version   Shows the version of this program.
 302
 303
 304 $pname was written by Dan McMahill <dmcmahill\@netbsd.org>
 305
 306
 307 EOF
 308
 309   exit;
 310 }
 311
 312 #---------------------------------
 313 # version()
 314 #
 315 # prints program version
 316 #---------------------------------
 317
 318 sub version {
 319   open(PROG,"$0") or die "Could not open \"$0\" to find version\n\n";
 320   my $pname = $0;
 321   $pname =~ s/.*\///g;
 322
 323   while($line = <PROG>) {
 324     if( $line =~ /^#\s*\$Id.*\$/) {
 325       @words = split ' ',,$line;
 326       $version = $words[3];
 327       $date = $words[4];
 328       print "$pname ($0):  Version $version, $date\n";
 329       exit;
 330     }
 331   }
 332   print "Could not determine version of \"$0\"\n\n";
 333   exit;
 334 }
 335