verilog_rename 0.0.1

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rspec/core/rake_task'
+
+file_list = FileList['spec/*_spec.rb']
+
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = file_list
+  t.rspec_opts = ["--colour", "--format progress"]
+end
+
+desc 'Default: run specs.'
+task :default => 'spec'

data/bin/rename-verilog

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'verilog_rename'
+
+#operate on current directory
+this_dir = Dir.pwd
+
+## TODO slop command line option parsing
+#Parameter 1 old_name
+old_name = ARGV[0]
+
+#Parameter 2 new_name
+new_name = ARGV[1]
+
+
+path_files = Verilog::PathFiles.new( this_dir )
+  path_files.read_all
+
+rename = Verilog::Rename.new(old_name, new_name, path_files)
+  rename.rename_module

data/lib/verilog/path_files.rb

@@ -0,0 +1,51 @@
+
+module Verilog
+
+  class PathFiles
+    attr_reader :files
+
+    def initialize( path="" )
+      @files = []
+      load_path( path )
+    end
+
+    def load_path( paths )
+      #path is single string or array of strings
+      paths.each do |path|
+        files = Dir.glob( ::File.join( path, '*.*') )
+        files.each do |file|
+          #Skip if Directory got passed *.* Filter
+          next if ::File.directory?( file )
+
+          file_name = ::File.basename(file)  
+          @files << Verilog::File.new(file_name, {:path => path})
+
+        end
+      end
+    end
+
+    def read_all
+      @files.each do |file|
+        file.read_from_disk
+      end
+    end
+
+    def find_by_module( name )
+      result = @files.select do |file| 
+         file.module_name == name 
+      end
+      return result[0]
+    end
+
+    def includes_file( name )
+        @files.select { |file| file.includes.include?( name ) }
+    end
+
+    def instantiates_module( name )
+        @files.select { |file| file.instantiations.include?( name ) }
+    end
+
+  end
+
+end
+

data/lib/verilog/prefix.rb

@@ -0,0 +1,8 @@
+module Verilog  
+  
+  class Prefix
+    #Verilog class to prefix module names. Iterates over cached files and renames all with a given prefix.
+  end
+
+end
+

data/lib/verilog/rename-backup.rb

@@ -0,0 +1,130 @@
+require 'FileUtils'
+
+module Verilog
+
+  class Rename
+    attr_reader :path_files
+    attr_reader :old_name, :new_name
+    attr_reader :old_file, :new_file
+
+
+    def initialize(old_name, new_name, path_files) 
+      @old_name   = old_name
+      @new_name   = new_name
+      @path_files = path_files
+    end
+
+    def rename
+      #@old_file, @new_file = find_rename_verilog_file
+
+      #Analyse file and rename module
+      rename_module
+
+      #update_refferences
+    end
+
+    def update_refferences
+      files = Dir.glob('*.*')
+      #puts "File list searching for insatances of #{@old_name}"
+      files.each do |file|
+        next if File.directory?( file )
+        contents = Verilog::FileReader.get_file_as_string( file )
+
+        #Update Instatiations
+        updated_instance_b = contents.gsub!(
+          /(^\s*)#{@old_name}(\s\w+\s*\()/i, "\\1#{@new_name}\\2")
+          if updated_instance_b  
+            puts "Updating instantiation of #{@old_name} to #{@new_name} in #{file.to_s}"
+          end
+
+          #Update inculde
+          ## want filename of file being moved
+          updated_include_b = contents.gsub!(/(^\s*`include [\'\"])#{@old_file}([\'\"])/i, "\\1#{@new_file}\\2")
+          if updated_include_b  
+            puts "Updating include of #{@old_file} to #{@new_file} in #{file.to_s}"
+          end
+
+
+          #Update lines in *.do runscripts
+          updated_run_b = contents.gsub!(/(\s+)#{@old_file}(\s+)/, "\\1#{@new_file}\\2")
+          if updated_instance_b  
+            puts "Updating call to #{@old_file} to #{@new_file} in #{file.to_s}"
+          end
+
+          #Update File
+          if updated_instance_b or updated_include_b or updated_run_b
+            write_file_to_string( file, contents )
+          end
+
+
+      end
+
+    end
+
+    def rename_module
+
+      #find the correct file first
+      puts @old_name
+
+      file_to_rename = @path_files.find_by_module( @old_name )
+
+      file_to_rename.contents.gsub!(/(^\s*module )#{@old_name}(\s+|;|\()/i, "\\1#{@new_name}\\2")
+      
+      extension = ::File.extname( file_to_rename.filename )
+      
+      #Need to change file name but keep extension
+      file_to_rename.filename = @new_name + extension
+
+      pp file_to_rename
+
+                             #Save file, will use new name.
+
+                             #Delete Old file
+
+                             #Update other files refferencing it.
+
+
+      #file_contents = Verilog::FileReader.get_file_as_string( new_file )
+
+      #file_contents
+
+      # if updated_b 
+      #   Verilog::FileReader.write_file_to_string( new_file, file_contents )
+      # end
+    end
+
+    def find_rename_verilog_file
+      old_file, ext = find_module_file( @old_name )
+
+      if old_file 
+        new_file = @new_name + ext
+        puts "Moving #{old_file} to #{new_file}"
+        FileUtils.move( old_file, new_file ) 
+      else
+        #Old_filename does not exists
+        # This could be second tim running script.
+        # Look for newfile incase already moved.
+        new_file, ext = find_module_file( @new_name )
+      end
+
+      return [old_file, new_file]
+    end
+
+  end
+
+
+end
+
+if $0 == __FILE__
+  #puts "Running Verilog Rename"
+  #operate on current directory (future parse testbench.f)
+  this_dir = Dir.pwd
+
+  #Parameter 1 old_name
+  old_name = ARGV[0]
+  #Parameter 2 new_name
+  new_name = ARGV[1]
+
+  a = Verilog::Rename::File.new(this_dir, old_name, new_name)
+  a.rename
+end

data/lib/verilog/rename-oldf.rb

@@ -0,0 +1,195 @@
+require 'FileUtils'
+require 'pp'
+
+module Verilog
+
+  EXTENSIONS = [".v", ".bh.v", ".sv"]
+
+   class File
+      attr_reader :path
+      attr_reader :file_name
+      attr_reader :ext
+
+      def initialise( path, file_name="", ext="" )
+        #TODO if path is a file then create file_name and ext
+        @path      = path
+        @file_name = file_name
+        #TODO check ext starts with .
+        @ext       = ext
+      end
+
+      def absolute_path
+        File.join( File.expand_path( path ), file_name ext )
+      end
+
+      def read
+        if File.exist?( absolute_path )
+          data = ''
+          f = File.open(absolute_path, "r") 
+          f.each_line do |line|
+            data += line
+          end
+          f.close
+          return data
+        else
+          #TODO raise correct exception here
+          puts "ERROR File Not Found #{absolute_path}"
+        end
+
+      end
+
+      def save( contents )
+        f = File.open(absolute_path, "w")
+        f.write(contents)
+        f.close
+      end
+
+
+    end
+
+    class PathFiles
+      attr_reader :files
+
+      def initalize( path="" )
+        @files = []
+        load_path( path )
+      end
+
+      def load_path( paths )
+        #path is single string or array of strings
+        paths.each do |path|
+          files = Dir.glob('*.*')
+          files.each do |file|
+             #Skip if Directory got passed *.* Filter
+              next if File.directory?( file )
+             
+             file_extension = File.extname(file)
+             name = File.basename(file,file_extension)  
+             @files << Verilog::File.new(path, name, file_extension)
+
+          end
+        end
+      end
+
+      def <<( item ) 
+        @files
+      end
+
+      def find_module( name )
+          result = @files.select { |file| file.file_name == name }
+
+          if result.size == 1
+            return result
+          else
+            #TODO Fall back to scanning all files for module declarations 
+            return false
+          end
+      end
+
+
+    end
+
+
+
+  module Rename
+    class Rename
+      attr_reader :dir, :old_name, :new_name
+      attr_reader :old_file, :new_file
+
+
+      def initialize(this_dir, old_name, new_name) 
+        @dir      = this_dir
+        @old_name = old_name
+        @new_name = new_name
+      end
+
+      def rename
+        @old_file, @new_file = find_rename_verilog_file
+
+        #Analyse file and rename module
+        rename_module( @new_file )
+
+        update_refferences
+      end
+
+      def update_refferences
+        files = Dir.glob('*.*')
+        #puts "File list searching for insatances of #{@old_name}"
+        files.each do |file|
+          next if File.directory?( file )
+          contents = Verilog::FileReader.get_file_as_string( file )
+
+          #Update Instatiations
+          updated_instance_b = contents.gsub!(/(^\s*)#{@old_name}(\s\w+\s*\()/i, "\\1#{@new_name}\\2")
+          if updated_instance_b  
+            puts "Updating instantiation of #{@old_name} to #{@new_name} in #{file.to_s}"
+          end
+
+          #Update inculde
+          ## want filename of file being moved
+          updated_include_b = contents.gsub!(/(^\s*`include [\'\"])#{@old_file}([\'\"])/i, "\\1#{@new_file}\\2")
+          if updated_include_b  
+            puts "Updating include of #{@old_file} to #{@new_file} in #{file.to_s}"
+          end
+
+
+          #Update lines in *.do runscripts
+          updated_run_b = contents.gsub!(/(\s+)#{@old_file}(\s+)/, "\\1#{@new_file}\\2")
+          if updated_instance_b  
+            puts "Updating call to #{@old_file} to #{@new_file} in #{file.to_s}"
+          end
+
+          #Update File
+          if updated_instance_b or updated_include_b or updated_run_b
+            write_file_to_string( file, contents )
+          end
+
+
+        end
+
+      end
+
+      def rename_module( new_file )
+        file_contents = Verilog::FileReader.get_file_as_string( new_file )
+
+        updated_b = file_contents.gsub!(/(^\s*module )#{@old_name}(\s+|;|\()/i, "\\1#{@new_name}\\2")
+
+        if updated_b 
+          Verilog::FileReader.write_file_to_string( new_file, file_contents )
+        end
+      end
+
+      def find_rename_verilog_file
+        old_file, ext = find_module_file( @old_name )
+
+        if old_file 
+          new_file = @new_name + ext
+          puts "Moving #{old_file} to #{new_file}"
+            FileUtils.move( old_file, new_file ) 
+        else
+          #Old_filename does not exists
+          # This could be second tim running script.
+          # Look for newfile incase already moved.
+          new_file, ext = find_module_file( @new_name )
+        end
+
+        return [old_file, new_file]
+      end
+
+    end
+  end
+end
+
+if $0 == __FILE__
+  #puts "Running Verilog Rename"
+  #operate on current directory (future parse testbench.f)
+  this_dir = Dir.pwd
+
+  #Parameter 1 old_name
+  old_name = ARGV[0]
+  #Parameter 2 new_name
+  new_name = ARGV[1]
+
+  a = Verilog::Rename::File.new(this_dir, old_name, new_name)
+  a.rename
+end

data/lib/verilog/rename.rb

@@ -0,0 +1,68 @@
+require 'FileUtils'
+
+module Verilog
+
+  class Rename
+    attr_reader :path_files
+    attr_reader :old_name, :new_name
+    attr_reader :old_file, :new_file
+
+
+    def initialize(old_name, new_name, path_files) 
+      @old_name   = old_name
+      @new_name   = new_name
+      @path_files = path_files
+    end
+
+    def rename
+      #Analyse file and rename module
+      rename_module
+
+      #update_refferences
+    end
+
+    def rename_module
+
+      #find the correct file first
+      file_to_rename     = @path_files.find_by_module( @old_name )
+
+      file_to_rename.contents.gsub!(/(^\s*module )#{@old_name}(\s+|;|\()/i, "\\1#{@new_name}\\2")
+      
+      extension                   = ::File.extname( file_to_rename.filename )
+      absolute_original_file_name = file_to_rename.absolute_filename
+      original_file_name          = file_to_rename.filename
+
+      #Need to change file name but keep extension
+      file_to_rename.filename = @new_name + extension
+
+      #TODO Possibly check that that module name is not already in use
+      #TODO check that the file name is not already used
+
+      #Save file, will use new name.
+      file_to_rename.save
+
+      ## Delete Old file
+      ::File.delete( absolute_original_file_name )
+
+      ## Update other files including it.
+      files_including_it = @path_files.includes_file( original_file_name )
+
+      files_including_it.each do |file|
+          file.contents.gsub!(/(^\s*`include [\'\"])#{ original_file_name }([\'\"])/, "\\1#{ file_to_rename.filename }\\2")
+          #This could trigger many writes
+          ## Verilog File needs a modified flag so files can be itereated and modified version can be saved.
+          file.save
+      end 
+
+      ## Update files instatiating it.
+      files_instantiating_it = @path_files.instantiates_module( @old_name )
+
+      files_instantiating_it.each do |file|
+          file.contents.gsub!(/(^\s*)#{ @old_name }(\s+)/,"\\1#{ @new_name }\\2")
+          file.save
+      end 
+
+    end
+  end
+end
+