Skip to content


Subversion checkout URL

You can clone with
Download ZIP
This is an implementation of a class-oriented Lua module, coded entirely in Lua.
tree: 8d886904ee

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.


A class-oriented OOP module for Lua

This is an implementation of a class-oriented Lua module, coded entirely in Lua. The object model allows you to override 'new()' (see tests), so you can write classes that behave the way you want. While still in design stage, the interface is getting quite stable and I'm in the process of adding Mixin.

This is an early release, please report bugs & feature requests to the project's [ UserVoice page].

=== Features ===

        * Class oriented
        * All classes derive from Object
        * Single inheritance (with Mixins coming soon!)
        * All method calls are virtual, the class of the instance determines the bound method
        * Access to superclass method in overriden methods with a Java-like {{super(self)}} method
        * The use of super only grants access to methods, NOT to data members (prevents many evils)
        * Consistent use of {{:}}, always use {{:}} to call any method of any class or instance
        * Object model allows to redefine {{new()}} in any class (see tests)
        * Hopefully only one way to do things, very predictible results

Note: there is a {{Prototype.lua}} file in the package, which is completely independant, but if you need prototype-based oop have a look at it (it provides a {{super(self)}} function).

=== Warnings ===

        * This is an early release.  Changes can be made in the future
        * No optimization.  This is still in the design stage

=== Code ===

This project's code can be dowloaded from its [ Google code page].

You can also install ObjectLua from LuaRocks:
    $ luarocks install objectlua

=== Tests and Usage ===

See TestObject.

The tests documenting ObjectLua usage can be found in the {{test}} directory. You can run them with:
    $ make test

They use [ LuaUnit].

=== References ===

        * [ PIL], by Roberto Ierusalimschy.
        * The [ Lua Wiki].
        * [ Open Reusable Object Models], by Ian Piumarta & Alessandro Warth, for bootstraping the object model.
        * [ This article] by John Resig for one of the previous implementations of super().
        * [ This exchange] between Guido van Rossum (Python) and Jim Althoff (Smalltalk) for the object model.
        * [ Traits: Composable Units of Behavior] by Nathanael Schärli, Stéphane Ducasse, Oscar Nierstrasz and Andrew Black for Traits

The main point is to bootstrap the object model and then,
build on it to populate {{Class}} with {{new()}}, {{inheritsFrom()}}, {{subclass()}},
and {{Object}} with {{initialize()}}, {{isKindOf()}}, {{clone()}}...

Thanks to Ludovic Perrine for making things clearer with enlightening discussions.
Thanks to Robert Rangel for finding a blocker bug fixed in version 0.0.3.

=== See Also ===

        * The project's [ UserVoice page] for bugs & feature requests.
        * The project's [ Google code page]
        * ObjectOrientedProgramming
Something went wrong with that request. Please try again.