class BinData::Registry

This registry contains a register of name -> class mappings.

Numerics (integers and floating point numbers) have an endian property as part of their name (e.g. int32be, float_le).

Classes can be looked up based on their full name or an abbreviated name with hints.

There are two hints supported, :endian and :search_prefix.

#lookup("int32", { endian: :big }) will return Int32Be.

#lookup("my_type", { search_prefix: :ns }) will return NsMyType.

Names are stored in under_score_style, not camelCase.

Public Class Methods

new() click to toggle source
# File lib/bindata/registry.rb, line 22
def initialize
  @registry = {}
end

Public Instance Methods

lookup(name, hints = {}) click to toggle source
# File lib/bindata/registry.rb, line 39
def lookup(name, hints = {})
  key = normalize_name(name, hints)
  @registry[key] || raise(UnRegisteredTypeError, name.to_s)
end
register(name, class_to_register) click to toggle source
# File lib/bindata/registry.rb, line 26
def register(name, class_to_register)
  return if class_to_register.nil?

  formatted_name = underscore_name(name)
  warn_if_name_is_already_registered(formatted_name, class_to_register)

  @registry[formatted_name] = class_to_register
end
underscore_name(name) click to toggle source

Convert CamelCase name to underscore style.

# File lib/bindata/registry.rb, line 45
def underscore_name(name)
  name.
    to_s.
    sub(/.*::/, "").
    gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
    gsub(/([a-z\d])([A-Z])/, '\1_\2').
    tr("-", "_").
    downcase
end
unregister(name) click to toggle source
# File lib/bindata/registry.rb, line 35
def unregister(name)
  @registry.delete(underscore_name(name))
end

Private Instance Methods

name_with_endian(name, endian) click to toggle source
# File lib/bindata/registry.rb, line 90
def name_with_endian(name, endian)
  return name if endian.nil?

  suffix = (endian == :little) ? "le" : "be"
  if /^u?int\d+$/ =~ name
    name + suffix
  else
    name + "_" + suffix
  end
end
name_with_prefix(name, prefix) click to toggle source
# File lib/bindata/registry.rb, line 81
def name_with_prefix(name, prefix)
  prefix = prefix.to_s.chomp("_")
  if prefix == ""
    name
  else
    "#{prefix}_#{name}"
  end
end
normalize_name(name, hints) click to toggle source
# File lib/bindata/registry.rb, line 58
def normalize_name(name, hints)
  name = underscore_name(name)

  if !registered?(name)
    search_prefix = [""].concat(Array(hints[:search_prefix]))
    search_prefix.each do |prefix|
      nwp = name_with_prefix(name, prefix)
      if registered?(nwp)
        name = nwp
        break
      end

      nwe = name_with_endian(nwp, hints[:endian])
      if registered?(nwe)
        name = nwe
        break
      end
    end
  end

  name
end
register_dynamic_class(name) click to toggle source
# File lib/bindata/registry.rb, line 107
def register_dynamic_class(name)
  if /^u?int\d+(le|be)$/ =~ name || /^s?bit\d+(le)?$/ =~ name
    class_name = name.gsub(/(?:^|_)(.)/) { $1.upcase }
    begin
      BinData.const_get(class_name)
    rescue NameError
    end
  end
end
registered?(name) click to toggle source
# File lib/bindata/registry.rb, line 101
def registered?(name)
  register_dynamic_class(name) unless @registry.key?(name)

  @registry.key?(name)
end
warn_if_name_is_already_registered(name, class_to_register) click to toggle source
# File lib/bindata/registry.rb, line 117
def warn_if_name_is_already_registered(name, class_to_register)
  prev_class = @registry[name]
  if $VERBOSE && prev_class && prev_class != class_to_register
    warn "warning: replacing registered class #{prev_class} " \
         "with #{class_to_register}"
  end
end