Class: Struct

Inherits:
Object show all
Includes:
Enumerable
Defined in:
opal/opal/corelib/struct.rb,
opal/opal/corelib/marshal/write_buffer.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Enumerable

#all?, #any?, #chunk, #collect, #collect_concat, #count, #cycle, #detect, #drop, #drop_while, #each_cons, #each_entry, #each_slice, #each_with_index, #each_with_object, #entries, #enumerator_size, #find_all, #find_index, #first, #grep, #group_by, #include?, #inject, #lazy, #max, #max_by, #min, #min_by, #minmax, #minmax_by, #none?, #one?, #partition, #reject, #reverse_each, #slice_before, #sort, #sort_by, #take, #take_while, #zip

Constructor Details

#initialize(*args) ⇒ Struct

Returns a new instance of Struct


76
77
78
79
80
81
82
83
84
# File 'opal/opal/corelib/struct.rb', line 76

def initialize(*args)
  if args.length > self.class.members.length
    raise ArgumentError, "struct size differs"
  end

  self.class.members.each_with_index {|name, index|
    self[name] = args[index]
  }
end

Class Method Details

._load(args) ⇒ Object


264
265
266
267
# File 'opal/opal/corelib/struct.rb', line 264

def self._load(args)
  attributes = args.values_at(*members)
  self.new(*attributes)
end

.define_struct_attribute(name) ⇒ Object


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'opal/opal/corelib/struct.rb', line 44

def self.define_struct_attribute(name)
  if self == Struct
    raise ArgumentError, 'you cannot define attributes to the Struct class'
  end

  members << name

  define_method name do
    `self.$$data[name]`
  end

  define_method "#{name}=" do |value|
    `self.$$data[name] = value`
  end
end

.inherited(klass) ⇒ Object


68
69
70
71
72
73
74
# File 'opal/opal/corelib/struct.rb', line 68

def self.inherited(klass)
  members = @members

  klass.instance_eval {
    @members = members
  }
end

.membersObject


60
61
62
63
64
65
66
# File 'opal/opal/corelib/struct.rb', line 60

def self.members
  if self == Struct
    raise ArgumentError, 'the Struct class has no members'
  end

  @members ||= []
end

.new(const_name, *args, &block) ⇒ Object


6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# File 'opal/opal/corelib/struct.rb', line 6

def self.new(const_name, *args, &block)
  if const_name
    begin
      const_name = Opal.const_name!(const_name)
    rescue TypeError, NameError
      args.unshift(const_name)
      const_name = nil
    end
  end

  args.map do |arg|
    Opal.coerce_to!(arg, String, :to_str)
  end

  klass = Class.new(self) do
    args.each { |arg| define_struct_attribute(arg) }

    class << self
      def new(*args)
        instance = allocate
        `#{instance}.$$data = {};`
        instance.initialize(*args)
        instance
      end

      alias [] new
    end
  end

  klass.module_eval(&block) if block

  if const_name
    Struct.const_set(const_name, klass)
  end

  klass
end

Instance Method Details

#==(other) ⇒ Object


130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'opal/opal/corelib/struct.rb', line 130

def ==(other)
  return false unless other.instance_of?(self.class)

  %x{
    var recursed1 = {}, recursed2 = {};

    function _eqeq(struct, other) {
      var key, a, b;

      recursed1[#{`struct`.__id__}] = true;
      recursed2[#{`other`.__id__}] = true;

      for (key in struct.$$data) {
        a = struct.$$data[key];
        b = other.$$data[key];

        if (#{Struct === `a`}) {
          if (!recursed1.hasOwnProperty(#{`a`.__id__}) || !recursed2.hasOwnProperty(#{`b`.__id__})) {
            if (!_eqeq(a, b)) {
              return false;
            }
          }
        } else {
          if (!#{`a` == `b`}) {
            return false;
          }
        }
      }

      return true;
    }

    return _eqeq(self, other);
  }
end

#[](name) ⇒ Object


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'opal/opal/corelib/struct.rb', line 94

def [](name)
  if Integer === name
    raise IndexError, "offset #{name} too small for struct(size:#{self.class.members.size})" if name < -self.class.members.size
    raise IndexError, "offset #{name} too large for struct(size:#{self.class.members.size})" if name >= self.class.members.size

    name = self.class.members[name]
  elsif String === name
    %x{
      if(!self.$$data.hasOwnProperty(name)) {
        #{raise NameError.new("no member '#{name}' in struct", name)}
      }
    }
  else
    raise TypeError, "no implicit conversion of #{name.class} into Integer"
  end

  name = Opal.coerce_to!(name, String, :to_str)
  `self.$$data[name]`
end

#[]=(name, value) ⇒ Object


114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'opal/opal/corelib/struct.rb', line 114

def []=(name, value)
  if Integer === name
    raise IndexError, "offset #{name} too small for struct(size:#{self.class.members.size})" if name < -self.class.members.size
    raise IndexError, "offset #{name} too large for struct(size:#{self.class.members.size})" if name >= self.class.members.size

    name = self.class.members[name]
  elsif String === name
    raise NameError.new("no member '#{name}' in struct", name) unless self.class.members.include?(name.to_sym)
  else
    raise TypeError, "no implicit conversion of #{name.class} into Integer"
  end

  name = Opal.coerce_to!(name, String, :to_str)
  `self.$$data[name] = value`
end

#__marshal__(buffer) ⇒ Object


161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'opal/opal/corelib/marshal/write_buffer.rb', line 161

def __marshal__(buffer)
  buffer.save_link(self)
  buffer.write_ivars_prefix(self)
  buffer.write_extends(self)
  buffer.append('S')
  buffer.append_symbol(self.class.name)
  buffer.write_fixnum(self.length)
  each_pair do |attr_name, value|
    buffer.append_symbol(attr_name)
    buffer.write(value)
  end
  buffer.write_ivars_suffix(self)
end

#eachObject


202
203
204
205
206
207
# File 'opal/opal/corelib/struct.rb', line 202

def each
  return enum_for(:each){self.size} unless block_given?

  self.class.members.each { |name| yield self[name] }
  self
end

#each_pairObject


209
210
211
212
213
214
# File 'opal/opal/corelib/struct.rb', line 209

def each_pair
  return enum_for(:each_pair){self.size} unless block_given?

  self.class.members.each { |name| yield [name, self[name]] }
  self
end

#eql?(other) ⇒ Boolean

Returns:


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'opal/opal/corelib/struct.rb', line 166

def eql?(other)
  return false unless other.instance_of?(self.class)

  %x{
    var recursed1 = {}, recursed2 = {};

    function _eqeq(struct, other) {
      var key, a, b;

      recursed1[#{`struct`.__id__}] = true;
      recursed2[#{`other`.__id__}] = true;

      for (key in struct.$$data) {
        a = struct.$$data[key];
        b = other.$$data[key];

        if (#{Struct === `a`}) {
          if (!recursed1.hasOwnProperty(#{`a`.__id__}) || !recursed2.hasOwnProperty(#{`b`.__id__})) {
            if (!_eqeq(a, b)) {
              return false;
            }
          }
        } else {
          if (!#{`a`.eql?(`b`)}) {
            return false;
          }
        }
      }

      return true;
    }

    return _eqeq(self, other);
  }
end

#hashObject


90
91
92
# File 'opal/opal/corelib/struct.rb', line 90

def hash
  Hash.new(`self.$$data`).hash
end

#inspectObject Also known as: to_s


228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
# File 'opal/opal/corelib/struct.rb', line 228

def inspect
  result = "#<struct "

  if Struct === self && self.class.name
    result += "#{self.class} "
  end

  result += each_pair.map {|name, value|
    "#{name}=#{value.inspect}"
  }.join ", "

  result += ">"

  result
end

#lengthObject Also known as: size


216
217
218
# File 'opal/opal/corelib/struct.rb', line 216

def length
  self.class.members.length
end

#membersObject


86
87
88
# File 'opal/opal/corelib/struct.rb', line 86

def members
  self.class.members
end

#to_aObject Also known as: values


222
223
224
# File 'opal/opal/corelib/struct.rb', line 222

def to_a
  self.class.members.map { |name| self[name] }
end

#to_hObject


246
247
248
# File 'opal/opal/corelib/struct.rb', line 246

def to_h
  self.class.members.inject({}) {|h, name| h[name] = self[name]; h}
end

#values_at(*args) ⇒ Object


250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'opal/opal/corelib/struct.rb', line 250

def values_at(*args)
  args = args.map{|arg| `arg.$$is_range ? #{arg.to_a} : arg`}.flatten
  %x{
    var result = [];
    for (var i = 0, len = args.length; i < len; i++) {
      if (!args[i].$$is_number) {
        #{raise TypeError, "no implicit conversion of #{`args[i]`.class} into Integer"}
      }
      result.push(#{self[`args[i]`]});
    }
    return result;
  }
end