Falcon::FlexyModule Class Reference

Flexible module class. More...

#include <flexymodule.h>

Inheritance diagram for Falcon::FlexyModule:

Inheritance graph

List of all members.

Public Member Functions

virtual bool isConst () const
 Describe this module constness.
virtual bool isFlexy () const
 Mark this module as a Flexy module.
virtual SymbolonSymbolRequest (const String &name)=0
 Provides symbol on VM dynamic request.

Detailed Description

Flexible module class.

Normally, modules are read-only from a VM standpoint.

However, modules willing to be dynamically changed by the VM can declare their disponibility by inheriting from this class.

Such modules should be given only to the VM they are linked first. Modules created by a VM for internal needs (i.e. by the reflexive system) are of this type.

The most interesting feature of this kind of modules is that of being able to provide new symbols at runtime. See the onSymbolRequest() method.

Member Function Documentation

virtual bool Falcon::FlexyModule::isConst (  )  const [inline, virtual]

Describe this module constness.

Flexy modules should not normally be cached by applications willing to cache modules on a global map and serving to the VMs through a modified module loader.

However, if the module guarantees that it doesn't modify the interface it presents when loaded by other vms, i.e. by not creating new symbols or changing the valence and internals of existing ones, they can change this mehtod to return true.

Application are advised that flexy modules returning true in isConst are safe to be shared among different VMs and can be cached at application level.

virtual bool Falcon::FlexyModule::isFlexy (  )  const [inline, virtual]

Mark this module as a Flexy module.

Reimplemented from Falcon::Module.

virtual Symbol* Falcon::FlexyModule::onSymbolRequest ( const String name  )  [pure virtual]

Provides symbol on VM dynamic request.

The onSymbolRequest() method is a callback that the VM lanunches on all the regiestered modules when a module wants to link a symbol that is not found in the global export table. The flexy module then able to provide the symbol to the VM, and to get it linked just-in-time, on script request.

This makes room for full by-request import, as supported by many scripting languages.

The flexy module may respect this call and still be const; the module may create the needed symbol locally and refuse to export them. Then, on VM request, it can provide the local symbol returing them through this callback. Doing so, it is granted that the module won't be changed in runtime, and this makes possible to share a flexy module across several VMs too.

The documentation for this class was generated from the following file:

Generated on Mon Oct 19 10:11:35 2009 for Falcon_Core by  doxygen 1.5.8