Class: RCGTK::Module::GlobalCollection

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/rcgtk/module.rb

Overview

This class is used to access a module’s global variables.

Instance Method Summary collapse

Constructor Details

#initialize(mod) ⇒ GlobalCollection

Returns a new instance of GlobalCollection.

Parameters:

  • mod (Module) —

    Module for which this is a proxy.



368
369
370
 
# File 'lib/rcgtk/module.rb', line 368

def initialize(mod)
  @module = mod
end

Instance Method Details

#[](key) ⇒ GlobalVariable

Retreive a GlobalVariable object.

Parameters:

  • key (String, Symbol, Integer) —

    Global variable identifier. Either the name of the variable or its index.

Returns:



377
378
379
380
381
382
383
384
385
 
# File 'lib/rcgtk/module.rb', line 377

def [](key)
  case key
  when String, Symbol
    self.named(key)

  when Integer
    (1...key).inject(self.first) { |global| if global then self.next(global) else break end }
  end
end

#add(type, name) ⇒ Object

Add a global variable to a module.

Parameters:

  • type (Type) —

    Type of the global variable.

  • name (String) —

    Name of the global variable in LLVM IR.



391
392
393
 
# File 'lib/rcgtk/module.rb', line 391

def add(type, name)
  GlobalVariable.new(Bindings.add_global(@module, type, name))
end

#delete(global) ⇒ void

This method returns an undefined value.

Remove a global variable from the module.

Parameters:



400
401
402
 
# File 'lib/rcgtk/module.rb', line 400

def delete(global)
  Bindings.delete_global(global)
end

#each {|fun| ... } ⇒ Enumerator

An iterator for each global variable inside this collection.

Yield Parameters:

Returns:

  • (Enumerator) —

    Returns an Enumerator if no block is given.



409
410
411
412
413
414
415
416
417
418
 
# File 'lib/rcgtk/module.rb', line 409

def each
  return to_enum(:each) unless block_given?

  global = self.first

  while global
    yield global
    global = self.next(global)
  end
end

#first ⇒ GlobalVariable?

Returns The module’s first global variable if one has been added.

Returns:

  • (GlobalVariable, nil) —

    The module’s first global variable if one has been added.



421
422
423
 
# File 'lib/rcgtk/module.rb', line 421

def first
  if (ptr = Bindings.get_first_global(@module)).null? then nil else GlobalValue.new(ptr) end
end

#last ⇒ GlobalVariable?

Returns The module’s last global variable if one has been added.

Returns:

  • (GlobalVariable, nil) —

    The module’s last global variable if one has been added.



426
427
428
 
# File 'lib/rcgtk/module.rb', line 426

def last
  if (ptr = Bindings.get_last_global(@module)).null? then nil else GlobalValue.new(ptr) end
end

#named(name) ⇒ GlobalVariable?

Returns The global variable with the given name.

Parameters:

  • name (String, Symbol) —

    Name of the desired global variable.

Returns:



433
434
435
 
# File 'lib/rcgtk/module.rb', line 433

def named(name)
  if (ptr = Bindings.get_named_global(@module, name)).null? then nil else GlobalValue.new(ptr) end
end

#next(global) ⇒ GlobalVariable?

Returns Next global variable in the collection.

Parameters:

  • global (GlobalVariable) —

    Global variable you want the successor for.

Returns:



440
441
442
 
# File 'lib/rcgtk/module.rb', line 440

def next(global)
  if (ptr = Bindings.get_next_global(global)).null? then nil else GlobalValue.new(ptr) end
end

#previous(global) ⇒ GlobalVariable?

Returns Previous global variable in the collection.

Parameters:

  • global (GlobalVariable) —

    Global variable you want the predecessor for.

Returns:

  • (GlobalVariable, nil) —

    Previous global variable in the collection.



447
448
449
 
# File 'lib/rcgtk/module.rb', line 447

def previous(global)
  if (ptr = Bindings.get_previous_global(global)).null? then nil else GlobalValue.new(ptr) end
end