Class: Rufus::Lua::Table

Inherits:
Ref
  • Object
show all
Includes:
Enumerable
Defined in:
lib/rufus/lua/objects.rb

Overview

A Lua table.

For now, the only thing you can do with it is cast it into a Hash or an Array (will raise an exception if casting to an Array is not possible).

Note that direct manipulation of the Lua table (inside Lua) is not possible (as of now).

Constant Summary

Constants included from StateMixin

StateMixin::LUA_ENVIRONINDEX, StateMixin::LUA_GCCOLLECT, StateMixin::LUA_GCCOUNT, StateMixin::LUA_GCCOUNTB, StateMixin::LUA_GCRESTART, StateMixin::LUA_GCSETPAUSE, StateMixin::LUA_GCSETSTEPMUL, StateMixin::LUA_GCSTEP, StateMixin::LUA_GCSTOP, StateMixin::LUA_GLOBALSINDEX, StateMixin::LUA_MULTRET, StateMixin::LUA_NOREF, StateMixin::LUA_REFNIL, StateMixin::LUA_REGISTRYINDEX, StateMixin::SIMPLE_TYPES, StateMixin::TBOOLEAN, StateMixin::TFUNCTION, StateMixin::TLIGHTUSERDATA, StateMixin::TNIL, StateMixin::TNONE, StateMixin::TNUMBER, StateMixin::TSTRING, StateMixin::TTABLE, StateMixin::TTHREAD, StateMixin::TUSERDATA

Instance Attribute Summary

Attributes inherited from Ref

#ref

Instance Method Summary collapse

Methods inherited from Ref

#free, #initialize

Constructor Details

This class inherits a constructor from Rufus::Lua::Ref

Instance Method Details

#[](k) ⇒ Object

Returns the value behind the key, or else nil.



187
188
189
190
191
192
193
 
# File 'lib/rufus/lua/objects.rb', line 187

def [] (k)

  load_onto_stack # table
  stack_push(k) # key
  Lib.lua_gettable(@pointer, -2) # fetch val for key at top and table at -2
  stack_pop
end

#[]=(k, v) ⇒ Object

Sets a value in the table

TODO : have something for adding in the array part…



200
201
202
203
204
205
206
207
208
209
 
# File 'lib/rufus/lua/objects.rb', line 200

def []= (k, v)

  load_onto_stack

  stack_push(k)
  stack_push(v)
  Lib.lua_settable(@pointer, -3)

  v
end

#each ⇒ Object

The classical ‘each’.

Note it cheats by first turning the table into a Ruby Hash and calling the each of that Hash instance (this way, the stack isn’t involved in the iteration).



162
163
164
165
166
 
# File 'lib/rufus/lua/objects.rb', line 162

def each

  return unless block_given?
  self.to_h.each { |k, v| yield(k, v) }
end

#keys ⇒ Object

Returns the array of keys of this Table.



171
172
173
174
 
# File 'lib/rufus/lua/objects.rb', line 171

def keys

  self.to_h.keys
end

#objlen ⇒ Object

Returns the size of the table, corresponds to the Lua ‘#’ operator.

Will thus return 0 if the table doesn’t hold any value in its ‘array’ part.



217
218
219
220
221
 
# File 'lib/rufus/lua/objects.rb', line 217

def objlen

  load_onto_stack
  Lib.lua_objlen(@pointer, -1)
end

#size ⇒ Object Also known as: length

Returns the real size of the table (number of entries + number of elements in array side)



227
228
229
230
 
# File 'lib/rufus/lua/objects.rb', line 227

def size

  self.to_h.size
end

#to_a ⇒ Object

Returns a Ruby Array instance representing this Lua table.

Will raise an error if the ‘rendering’ is not possible.



267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/rufus/lua/objects.rb', line 267

def to_a

  h = self.to_h

  keys = h.keys.sort

  keys.find { |k| not [ Float ].include?(k.class) } &&
    raise("cannot turn hash into array, some keys are not numbers")

  keys.inject([]) { |a, k| a << h[k]; a }
end

#to_h ⇒ Object

Returns a Ruby Hash instance representing this Lua table.



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/rufus/lua/objects.rb', line 236

def to_h

  load_onto_stack

  table_pos = stack_top

  Lib.lua_pushnil(@pointer)

  h = {}

  while Lib.lua_next(@pointer, table_pos) != 0 do

    value = stack_fetch(-1)
    value.load_onto_stack if value.is_a?(Ref)

    key = stack_fetch(-2)
    key.load_onto_stack if key.is_a?(Ref)

    stack_unstack # leave key on top

    h[key] = value
  end

  h
end

#values ⇒ Object

Returns the array of values in this Table.



179
180
181
182
 
# File 'lib/rufus/lua/objects.rb', line 179

def values

  self.to_h.values
end