origen 0.0.1 → 0.0.2

data/lib/origen/database/key_value_store.rb

@@ -0,0 +1,111 @@
+module Origen
+  module Database
+    class KeyValueStore
+      attr_reader :name
+      # Returns the parent database (the application's collection of
+      # key-value stores)
+      attr_reader :database
+
+      def initialize(database, name)
+        @name = name
+        @database = database
+      end
+
+      # Read a value from the store
+      def [](key)
+        refresh if stale?
+        store[key]
+      end
+
+      # Persist a new value to the store
+      def []=(key, val)
+        refresh if persisted?
+        store[key] = val
+        save_to_file
+        val
+      end
+
+      # Force a refresh of the database
+      def refresh
+        unless @uncommitted || !persisted?
+          dssc.check_out(file, version: 'Trunk', force: true)
+          record_refresh
+        end
+      end
+
+      def record_refresh
+        database.record_refresh(name)
+        @store = nil
+      end
+
+      # Returns true if the database is due a time-based refresh, note that
+      # this has no bearing on whether or not someone else has committed to
+      # the store since the last refresh
+      def stale?
+        if persisted?
+          t = database.time_since_refresh(name)
+          !t || store[:refresh_interval_in_minutes] == 0 || t > store[:refresh_interval_in_minutes]
+        else
+          false
+        end
+      end
+
+      def persisted?
+        database.persisted?
+      end
+
+      private
+
+      def dssc
+        @dssc ||= Origen::Utility::DesignSync.new
+      end
+
+      def store
+        @store ||= begin
+          if file.exist?
+            load_from_file
+          elsif persisted? && dssc.managed_by_design_sync?(file)
+            refresh
+            load_from_file
+          else
+            @uncommitted = true
+            { refresh_interval_in_minutes: 60 }
+          end
+        end
+      end
+
+      def load_from_file
+        s = nil
+        File.open(file.to_s) do |f|
+          s = Marshal.load(f)
+        end
+        s
+      end
+
+      def save_to_file
+        unless file.dirname.exist?
+          FileUtils.mkdir_p(file.dirname.to_s)
+        end
+        `chmod u+w #{file}` if file.exist?
+        if @uncommitted
+          database.record_new_store(name)
+          @uncommitted = false
+        end
+        File.open(file.to_s, 'w') do |f|
+          Marshal.dump(store, f)
+        end
+        if persisted?
+          dssc.check_in file, new: true, keep: true, branch: 'Trunk'
+        end
+      end
+
+      def file
+        if persisted?
+          @file ||= Pathname.new("#{database.app.root}/.db/#{name.to_s.symbolize}")
+        else
+          @file ||= Pathname.new("#{database.app.root}/.session/#{name.to_s.symbolize}")
+        end
+      end
+    end
+  end
+end

data/lib/origen/database/key_value_stores.rb

@@ -0,0 +1,108 @@
+module Origen
+  module Database
+    class KeyValueStores
+      # Returns the application that owns the database
+      attr_reader :app
+
+      def initialize(app, options = {})
+        options = {
+          persist: true
+        }.merge(options)
+        @app = app
+        @persist = options[:persist]
+      end
+
+      def inspect
+        if persisted?
+          "< #{app.class}'s Database >"
+        else
+          "< #{app.class}'s Session >"
+        end
+      end
+
+      # Refresh all stores
+      def refresh
+        if persisted?
+          _system.refresh
+          files = stores.map { |name| send(name).send(:file) }
+          dssc.check_out(files.join(' '), version: 'Trunk', force: true)
+          stores.each { |name| send(name).record_refresh }
+        end
+        nil
+      end
+
+      # Returns the time in minutes since the given store
+      # was last refreshed
+      def time_since_refresh(name)
+        if persisted?
+          if refresh_table[name]
+            ((Time.now - refresh_table[name]) / 60).floor
+          end
+        else
+          Time.now
+        end
+      end
+
+      # Record that the given store was just refreshed
+      def record_refresh(name)
+        if persisted?
+          t = refresh_table
+          t[name] = Time.now
+          app.session._database[:refresh_table] = t
+        end
+      end
+
+      def record_new_store(name)
+        unless name == :_system || name == :_database
+          _system.refresh
+          s = stores
+          s << name unless s.include?(name)
+          _system[:stores] = s
+        end
+      end
+
+      # Used to create new key value stores on the fly.
+      #
+      # On first call of a missing method a method is generated to avoid the missing lookup
+      # next time, this should be faster for repeated lookups of the same method, e.g. reg
+      def method_missing(method, *args, &block)
+        if method.to_s =~ /(=|\(|\)|\.|\[|\]|{|}|\\|\/)/ || [:test, :_system].include?(method)
+          fail "Invalid database name: #{method}"
+        else
+          define_singleton_method(method) do
+            loaded[method] ||= KeyValueStore.new(self, method)
+          end
+        end
+        send(method, *args, &block)
+      end
+
+      # Returns the names of all known stores
+      def stores
+        _system[:stores] || []
+      end
+
+      def persisted?
+        @persist
+      end
+
+      private
+
+      def refresh_table
+        app.session._database[:refresh_table] ||= {}
+      end
+
+      # Persisted key value store used by the database system
+      def _system
+        @_system ||= KeyValueStore.new(self, :_system)
+      end
+
+      def dssc
+        @dssc ||= Origen::Utility::DesignSync.new
+      end
+
+      def loaded
+        @loaded ||= {}
+      end
+    end
+  end
+end

data/lib/origen/database.rb

@@ -0,0 +1,6 @@
+module Origen
+  module Database
+    autoload :KeyValueStore,   'origen/database/key_value_store'
+    autoload :KeyValueStores,  'origen/database/key_value_stores'
+  end
+end

data/lib/origen/encodings.rb

@@ -0,0 +1,102 @@
+module Origen
+  ENCODINGS = {
+    utf8: {
+      inverted_exclamation_mark:                  "\u00A1",
+      cent_sign:                                  "\u00A2",
+      pound_sign:                                 "\u00A3",
+      currency_sign:                              "\u00A4",
+      yen_sign:                                   "\u00A5",
+      broken_bar:                                 "\u00A6",
+      section_sign:                               "\u00A7",
+      diaeresis:                                  "\u00A8",
+      copyright_sign:                             "\u00A9",
+      feminine_ordinal_indicator:                 "\u00AA",
+      left_pointing_double_angle_quotation_mark:  "\u00AB",
+      not_sign:                                   "\u00AC",
+      soft_hyphen:                                "\u00AD",
+      registered_sign:                            "\u00AE ",
+      macron:                                     "\u00AF",
+      degree_sign:                                "\u00B0",
+      plus_minus_sign:                            "\u00B1",
+      superscript_two:                            "\u00B2",
+      superscript_three:                          "\u00B3",
+      acute_accent:                               "\u00B4",
+      micro_sign:                                 "\u00B5",
+      pilcrow_sign:                               "\u00B6",
+      middle_dot:                                 "\u00B7",
+      cedilla:                                    "\u00B8",
+      superscript_one:                            "\u00B9",
+      masculine_ordinal_indicator:                "\u00BA",
+      right_pointing_double_angle_quotation_mark: "\u00BB",
+      vulgar_fraction_one_quarter:                "\u00BC",
+      vulgar_fraction_one_half:                   "\u00BD",
+      vulgar_fraction_three_quarters:             "\u00BE",
+      inverted_question_mark:                     "\u00BF",
+      latin_capital_letter_a_with_grave:          "\u00C0",
+      latin_capital_letter_a_with_acute:          "\u00C1",
+      latin_capital_letter_a_with_circumflex:     "\u00C2",
+      latin_capital_letter_a_with_tilde:          "\u00C3",
+      latin_capital_letter_a_with_diaeresis:      "\u00C4",
+      latin_capital_letter_a_with_ring_above:     "\u00C5",
+      latin_capital_letter_ae:                    "\u00C6",
+      latin_capital_letter_c_with_cedilla:        "\u00C7",
+      latin_capital_letter_e_with_grave:          "\u00C8",
+      latin_capital_letter_e_with_acute:          "\u00C9",
+      latin_capital_letter_e_with_circumflex:     "\u00CA",
+      latin_capital_letter_e_with_diaeresis:      "\u00CB",
+      latin_capital_letter_i_with_grave:          "\u00CC",
+      latin_capital_letter_i_with_acute:          "\u00CD",
+      latin_capital_letter_i_with_circumflex:     "\u00CE",
+      latin_capital_letter_i_with_diaeresis:      "\u00CF",
+      latin_capital_letter_eth:                   "\u00D0",
+      latin_capital_letter_n_with_tilde:          "\u00D1",
+      latin_capital_letter_o_with_grave:          "\u00D2",
+      latin_capital_letter_o_with_acute:          "\u00D3",
+      latin_capital_letter_o_with_circumflex:     "\u00D4",
+      latin_capital_letter_o_with_tilde:          "\u00D5",
+      latin_capital_letter_o_with_diaeresis:      "\u00D6",
+      multiplication_sign:                        "\u00D7",
+      latin_capital_letter_o_with_stroke:         "\u00D8",
+      latin_capital_letter_u_with_grave:          "\u00D9",
+      latin_capital_letter_u_with_acute:          "\u00DA",
+      latin_capital_letter_u_with_circumflex:     "\u00DB",
+      latin_capital_letter_u_with_diaeresis:      "\u00DC",
+      latin_capital_letter_y_with_acute:          "\u00DD",
+      latin_capital_letter_thorn:                 "\u00DE",
+      latin_small_letter_sharp_s:                 "\u00DF",
+      latin_small_letter_a_with_grave:            "\u00E0",
+      latin_small_letter_a_with_acute:            "\u00E1",
+      latin_small_letter_a_with_circumflex:       "\u00E2",
+      latin_small_letter_a_with_tilde:            "\u00E3",
+      latin_small_letter_a_with_diaeresis:        "\u00E4",
+      latin_small_letter_a_with_ring_above:       "\u00E5",
+      latin_small_letter_ae:                      "\u00E6",
+      latin_small_letter_c_with_cedilla:          "\u00E7",
+      latin_small_letter_e_with_grave:            "\u00E8",
+      latin_small_letter_e_with_acute:            "\u00E9",
+      latin_small_letter_e_with_circumflex:       "\u00EA",
+      latin_small_letter_e_with_diaeresis:        "\u00EB",
+      latin_small_letter_i_with_grave:            "\u00EC",
+      latin_small_letter_i_with_acute:            "\u00ED",
+      latin_small_letter_i_with_circumflex:       "\u00EE",
+      latin_small_letter_i_with_diaeresis:        "\u00EF",
+      latin_small_letter_eth:                     "\u00F0",
+      latin_small_letter_n_with_tilde:            "\u00F1",
+      latin_small_letter_o_with_grave:            "\u00F2",
+      latin_small_letter_o_with_acute:            "\u00F3",
+      latin_small_letter_o_with_circumflex:       "\u00F4",
+      latin_small_letter_o_with_tilde:            "\u00F5",
+      latin_small_letter_o_with_diaeresis:        "\u00F6",
+      division_sign:                              "\u00F7",
+      latin_small_letter_o_with_stroke:           "\u00F8",
+      latin_small_letter_u_with_grave:            "\u00F9",
+      latin_small_letter_u_with_acute:            "\u00FA",
+      latin_small_letter_u_with_circumflex:       "\u00FB",
+      latin_small_letter_u_with_diaeresis:        "\u00FC",
+      latin_small_letter_y_with_acute:            "\u00FD",
+      latin_small_letter_thorn:                   "\u00FE",
+      latin_small_letter_y_with_diaeresis:        "\u00FF",
+      ohm_sign:                                   "\u03A9"
+    }
+  }
+end

data/lib/origen/features/feature.rb

@@ -0,0 +1,22 @@
+module Origen
+  module Features
+    class Feature
+      attr_reader :name
+      attr_reader :description
+
+      def initialize(name, options = {})
+        @name = name
+        @description = options[:description]
+      end
+
+      def describe
+        return 'No description provided!' if @description == []
+        if @description.class == Array
+          @description.join(' ')
+        else
+          @description
+        end
+      end
+    end
+  end
+end

data/lib/origen/features.rb

@@ -0,0 +1,104 @@
+module Origen
+  module Features
+    extend ActiveSupport::Concern
+
+    autoload :Feature, 'origen/features/feature'
+
+    module ClassMethods
+      def features
+        @features ||= {}
+      end
+
+      # Creates a Feature if it deos not already exists.
+      # Returns the Feature object if it already exists.
+      # Returns an array of features if no argument is provided.
+
+      private
+
+      def feature(name, options = {})
+        name = name.to_s.downcase.to_sym
+        if !features.key?(name)
+          # Add the feature if it does not already exists
+
+          # Read desciption from the caller if the description of feature
+          # is not provided
+          unless options.key?(:description)
+            @file = define_file(caller[0])
+            options[:description] = fetch_description(name)
+          end
+          features[name] = Feature.new(name, options)
+        else          # if feature with given name already exists
+          fail "Feature #{name} already added!"
+        end
+      end
+
+      def fetch_description(name)
+        parse_description unless description_lookup[@file]
+        begin
+          desc = description_lookup[@file][name]
+        rescue
+          desc = []
+        end
+        desc
+      end
+
+      def define_file(file)
+        if Origen.running_on_windows?
+          fields = file.split(':')
+          "#{fields[0]}:#{fields[1]}"
+        else
+          file.split(':').first
+
+        end
+      end
+
+      def description_lookup
+        @@description_lookup ||= {}
+      end
+
+      def parse_description
+        desc = []
+        File.readlines(@file).each do |line|
+          if line =~ /^\s*#(.*)/
+            desc << Regexp.last_match[1].strip
+          elsif line =~ /(\s|:)feature(\s*)(=?>?)(\s?):(\w*)/
+            description_lookup[@file] ||= {}
+            description_lookup[@file][Regexp.last_match[5].to_sym] = desc
+            desc = []
+          else
+            desc = []
+          end
+        end
+      end
+    end
+
+    public
+
+    def has_features?(name = nil)
+      if !name
+        if feature.size == 0
+          return false
+        else
+          return true
+        end
+      else
+        return feature.include?(name)
+      end
+    end
+    alias_method :has_feature?, :has_features?
+
+    # Returns an array of the names of all associated features
+    def feature(name = nil)
+      if !name
+        self.class.features.keys
+      else
+        if self.class.features.key?(name)
+          self.class.features[name]
+        else
+          fail "Feature #{name} does not exist!"
+        end
+      end
+    end
+    alias_method :features, :feature
+  end
+end