utils/scripts/pcb_backannotate

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