ruby-gdsii 1.0.0

data/bin/rgds-ssplit

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+##############################################################################
+#
+# == gdsssplit.rb
+#
+# Splits a GDSII file into separate GDSII files.  A separate GDSII file will
+# be created for each structure in the original GDSII file and the new GDSII
+# files will be named after their structure name.  At this time there are
+# NO sref or aref intelligence (i.e. no hierarchy dependency checking) - so
+# only one structure will exist per file.
+#
+# === Author
+#
+# James D. Masters (james.d.masters@gmail.com)
+#
+# === History
+#
+# * 03/26/2007 (jdm): Initial version
+#
+##############################################################################
+
+
+require 'getoptlong'
+require 'gdsii'
+include Gdsii
+
+# Build usage message
+usage = "
+Splits a GDSII file into separate GDSII files.  A separate GDSII file will
+be created for each structure in the original GDSII file and the new GDSII
+files will be named after their structure name.  At this time there are
+NO sref or aref intelligence (i.e. no hierarchy dependency checking) - so
+only one structure will exist per file.
+
+Usage: gdsssplit.rb [options] <gds-file> <output-dir>
+
+Options:
+
+ -s, --structs    Specify structure(s) in a space separated list to extract.
+                  The default behavior is to extract all structures.
+ -f, --force      Force overwritting of GDSII files in the output directory
+                  if a file by the same name exists.
+ -e, --extension  Specify the output file GDSII extension to use.  Default
+                  is 'gds'.
+ -h, --help       Displays this usage message.
+
+"
+
+# Get command-line arguments
+force = false
+structs = []
+ext = 'gds'
+
+opts = GetoptLong.new(
+  ['--structs',   '-s', GetoptLong::OPTIONAL_ARGUMENT],
+  ['--force',     '-f', GetoptLong::OPTIONAL_ARGUMENT|GetoptLong::NO_ARGUMENT],
+  ['--extension', '-e', GetoptLong::OPTIONAL_ARGUMENT|GetoptLong::NO_ARGUMENT],
+  ['--help',      '-h', GetoptLong::OPTIONAL_ARGUMENT|GetoptLong::NO_ARGUMENT]
+)
+
+opts.each do |option, argument|
+  case option
+  when '--help'      : abort usage
+  when '--structs'   : structs = argument.split(/\s+/)
+  when '--extension' : ext = argument
+  when '--force'     : force = true
+  end
+end
+
+# Get GDSII file and output directory from command line
+gds_file, output_dir = ARGV
+unless gds_file and output_dir
+  abort usage
+end
+
+# Check that GDSII file is readable and that output dir is writable
+unless File.readable? gds_file
+  abort "\nGDSII file does not exist or is not readable: #{gds_file}\n\n" + usage
+end
+
+# Check that output directory is writable
+unless File.directory? output_dir and File.writable? output_dir
+  abort "\nOutput directory is not writable: #{output_dir}\n\n" + usage
+end
+
+
+# Read the GDSII file and write out resulting GDSII files
+File.open(gds_file, 'rb') do |inf|
+  Library.read_header(inf) do |lib|
+    Structure.read_each_header(inf) do |struct|
+      if structs.empty? or structs.member?(struct.name)
+        # write lib & structure header to file
+        file_name = "#{output_dir}/#{struct.name}.#{ext}"
+        if File.exists? file_name and not force
+          warn "WARNING: #{file_name} already exists; use --force to override"
+        else
+          # open the file 
+          File.open(file_name, 'wb') do |outf|
+            lib.write_header(outf)
+            struct.write_header(outf)
+            Element.read_each(inf) {|element| element.write(outf)}
+            struct.write_footer(outf)
+            lib.write_footer(outf)
+          end
+        end
+      else        
+        # structure not on list; skip to next
+        Structure.seek_next(inf)        
+      end
+    end
+  end
+end
+

data/bin/rgds-stats

@@ -0,0 +1,134 @@
+#!/usr/bin/env ruby
+##############################################################################
+#
+# == gdsstats.rb
+#
+# Dumps statistical information from a GDSII file.
+#
+# === Author
+#
+# James D. Masters (james.d.masters@gmail.com)
+#
+# === History
+#
+# * 03/26/2007 (jdm): Initial version
+#
+##############################################################################
+
+
+require 'getoptlong'
+require 'gdsii/record.rb'
+include Gdsii
+
+# Build usage message
+usage = "
+Dumps statistical information from a GDSII file.
+
+Usage: gdsssplit.rb [options] <gds-file> 
+
+Options:
+
+ -s, --structs    Specify structure(s) in a space separated list to process.
+                  The default behavior is to process all structures.
+ -h, --help       Displays this usage message.
+
+"
+
+# Get command-line arguments
+structs = []
+
+opts = GetoptLong.new(
+  ['--structs',     '-s', GetoptLong::OPTIONAL_ARGUMENT],
+  ['--help',        '-h', GetoptLong::OPTIONAL_ARGUMENT|GetoptLong::NO_ARGUMENT]
+)
+
+opts.each do |option, argument|
+  case option
+  when '--help'      : abort usage
+  when '--structs'   : structs = argument.split(/\s+/)
+  end
+end
+
+# Get GDSII file directory from command line
+unless (gds_file = ARGV[0])
+  abort usage
+end
+
+# Read the GDSII file and write out resulting GDSII files
+File.open(gds_file, 'rb') do |inf|
+
+  # Set statistics hashes:
+#  lib_stats = Hash.new {|h,k| h[k] = 0}
+  str_stats = Hash.new {|h,k| h[k] = Hash.new {|h2,k2| h2[k2] = 0}}
+  
+  # Set parse flags
+  strname = nil
+  dt_cxt = nil
+  layer = nil
+  
+  # Read each record in the GDSII file
+  Record.read_each(inf) do |record|
+    
+    type = record.type
+    
+    case type
+    when GRT_STRNAME
+      # New structure definition... print header
+      strname = record.data_value
+      if structs.empty? or structs.member?(strname)
+        puts
+        puts '#' * 78
+        puts
+        puts "STRUCTURE: #{strname}"
+        # lib_stats[type] += 1
+      end
+    when GRT_SREF, GRT_AREF
+      # increment count for sref, aref, text, node, box
+      str_stats[nil][type] += 1
+    when GRT_BOUNDARY
+      # set datatype context to BOUNDARY
+      dt_cxt = type
+    when GRT_PATH
+      # set datatype context to PATH
+      dt_cxt = type
+    when GRT_LAYER
+      # capture the layer number - record when context is reached
+      layer = record.data_value
+    when GRT_DATATYPE, GRT_TEXTTYPE, GRT_NODETYPE, GRT_BOXTYPE
+      # record the layer for the given layer context
+      datatype = record.data_value
+      rec_num = (dt_cxt) ? dt_cxt : type
+      str_stats[[layer, datatype]][rec_num] += 1
+      dt_cxt = nil
+    when GRT_ENDSTR
+      # end structure definition
+      if structs.empty? or structs.member?(strname)
+        puts
+        printf("SRefs: %-12d\n", str_stats[nil][GRT_SREF])
+        printf("ARefs: %-12d\n", str_stats[nil][GRT_AREF])
+        puts
+        puts "Layer  Type             # Bnd      # Path      # Text       # Box      # Node"
+        puts '-' * 78
+        
+        # Show layer information
+        layers = str_stats.keys.compact.sort {|a, b| (a[0] <=> b[0]) <=> (a[1] <=> b[1])}
+        layers.each do |layer|
+          printf("%-6d %-6d     %11d %11d %11d %11d %11d\n",
+                 layer[0],
+                 layer[1],
+                 str_stats[layer][GRT_BOUNDARY],
+                 str_stats[layer][GRT_PATH],
+                 str_stats[layer][GRT_TEXTTYPE],
+                 str_stats[layer][GRT_BOXTYPE],
+                 str_stats[layer][GRT_NODETYPE]
+                 )
+        end
+        puts
+      end
+      str_stats.delete_if {|key,value| true}
+    end
+      
+  end
+end
+
+

data/bin/rgds-structs

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+##############################################################################
+#
+# == gdsstructs.rb
+#
+#
+# === Author
+#
+# James D. Masters (james.d.masters@gmail.com)
+#
+# === History
+#
+# * 03/26/2007 (jdm): Initial version
+#
+##############################################################################
+
+
+require 'getoptlong'
+require 'gdsii/record.rb'
+include Gdsii
+
+# Build usage message
+if (file_name = ARGV[0]).nil? then
+  abort "
+Dumps a of structure names defined in the GDSII file.
+
+Usage: gdsstructs.rb <gds-file>
+
+"
+end
+
+# Extract the structure names from  the GDSII file
+File.open(file_name, 'rb') do |file|
+  while (record = Record.read(file)) do
+    if record.is_strname?
+      puts record.data_value
+    end
+  end
+end
+
+

data/bin/rgds-tree

@@ -0,0 +1,166 @@
+#!/usr/bin/env ruby
+##############################################################################
+#
+# == gdstree.rb
+#
+# Dumps a hierarchy tree of structures used within a given GDSII file.
+#
+# === Author
+#
+# James D. Masters (james.d.masters@gmail.com)
+#
+# === History
+#
+# * 03/27/2007 (jdm): Initial version
+#
+#
+##############################################################################
+
+
+require 'getoptlong'
+require 'gdsii/record.rb'
+include Gdsii
+
+# Build usage message
+usage = "
+Dumps a hierarchy tree of structures used within a given GDSII file.
+
+Usage: gdstree.rb [options] <gds-file> 
+
+Options:
+
+ -t, --top-structs  Explicitly specify the top structure name(s) to use in
+                    the tree.  The default behavior is to identify the top
+                    structure(s) in the hierarchy automatically.
+ -c, --inst-counts  Include instantiation counts in the tree.
+ -b, --broken-refs  Indicate how broken references are handled.  Possible values
+                    are 'annotate' or 'prune'.  The default behavior is to
+                    ignore broken references.
+ -d, --delimiter    Set hierarchy delimiter (default is '/').
+ -h, --help         Displays this usage message.
+
+Examples:
+
+ruby gdstree.rb design.gds
+ruby gdstree.rb --delimiter . design.gds
+ruby gdstree.rb --inst-counts design.gds
+ruby gdstree.rb --top-structs 'mytop othertop' --broken-refs annotate
+
+"
+
+# Get command-line arguments
+top_structs = []
+show_inst_counts = false
+broken_refs = nil
+delimiter = '/'
+
+opts = GetoptLong.new(
+  ['--top-structs', '-t', GetoptLong::OPTIONAL_ARGUMENT],
+  ['--inst-counts', '-c', GetoptLong::NO_ARGUMENT],
+  ['--broken-refs', '-b', GetoptLong::OPTIONAL_ARGUMENT],
+  ['--delimiter',   '-d', GetoptLong::OPTIONAL_ARGUMENT],
+  ['--help',        '-h', GetoptLong::NO_ARGUMENT]
+)
+
+opts.each do |option, argument|
+  case option
+  when '--top-structs' : top_structs = argument.split(/\s+/)
+  when '--inst-counts' : show_inst_counts = argument
+  when '--broken-refs' : broken_refs = argument
+  when '--delimiter'   : delimiter = argument
+  when '--help'        : abort usage
+  end
+end
+
+# Get GDSII file directory from command line
+unless (gds_file = ARGV[0])
+  abort usage
+end
+
+
+#
+# Class to define a structure within the hierarchy
+#
+class HierStruct
+  # Make the attributes accessible
+  attr_accessor :name, :children
+
+  # Create a new HierStruct
+  def initialize(name, delimiter, inst_counts, broken_refs)
+    @name = name
+    @delimiter = delimiter
+    @inst_counts = inst_counts
+    @broken_refs = broken_refs.to_sym unless broken_refs.nil?
+    @children = Hash.new {|hash, key| hash[key] = 0}
+  end
+
+  # Display the hierarchy of this HierStruct
+  def puts(structs, prefix='', suffix='')
+    # build the hierarchy string then display it
+    string = prefix + @delimiter + @name + suffix
+    $stdout.puts string
+
+    # display the hierarchy for all children of this struct
+    @children.each_pair do |struct_name, num_placed|
+      
+      cnt_suffix = (@inst_counts) ? "(#{num_placed})" : ''
+
+      if (struct = structs[struct_name])
+        # display the child's hierarchy
+        struct.puts(structs, string, cnt_suffix)
+      else
+        # broken reference; deal with appropriately
+        case @broken_refs
+        when :annotate : $stdout.puts string + '(MISSING)'
+        when :prune    : nil
+        else
+          $stdout.puts string + @delimiter + struct_name + cnt_suffix
+        end
+      end
+      
+    end
+  end
+end
+
+
+#
+# Main code
+#
+
+# get the structure and instance placement from the gdsii file
+structs = {}
+has_parent = {}
+File.open(gds_file, 'rb') do |file|
+  while (rec=Record.read(file)) do
+    if rec.is_strname?
+      # inside a structure definition
+      str = HierStruct.new(rec.data_value, delimiter, show_inst_counts, broken_refs)
+      structs[str.name] = str
+      has_parent[str.name] = false unless has_parent.has_key?(str.name)
+    elsif rec.is_sname?
+      # instance in this structure
+      ref_str = rec.data_value
+      str.children[ref_str] += 1
+      has_parent[ref_str] = true
+    end
+  end
+end
+
+
+# if the user provides a list of top structure names, then use that list;
+# otherwise build our own.
+if top_structs.empty?
+  top_structs = has_parent.delete_if {|key, value| value}.keys.sort
+end
+
+# Output hierarch(y/ies)...
+unless top_structs.empty?
+  top_structs.each do |struct|
+    if structs.has_key?(struct)
+      structs[struct].puts(structs)
+    else
+      warn "WARNING: structure #{struct} not found"
+    end
+  end
+end
+