Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "LDT/User Area/Compatible Lua VMs"

< LDT
 
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This page aims to list the Lua VMs which works with Lua Development Tools (LDT).
+
= Compatible VMs =
 +
This page aims to list the Lua VMs which work with Lua Development Tools (LDT).
  
(feel free to complete with your tests)
+
By "work", we mean :
 +
* VM which is compatible with our debugger.
 +
* VM for which an execution environment is available. (enable API's autocompletion and documentation)
 +
 
 +
(Feel free to complete this list with your tests)
  
 
{| border="1" border="1" cellpadding="3" cellspacing="0"
 
{| border="1" border="1" cellpadding="3" cellspacing="0"
Line 20: Line 25:
 
|[http://w3.impa.br/~diego/software/luasocket/ LuaSocket] 2.0 needed.
 
|[http://w3.impa.br/~diego/software/luasocket/ LuaSocket] 2.0 needed.
 
|
 
|
|[[Image:Ok_green.gif]]Officially available since 0.8, deliver with LDT since 0.9.
+
|[[Image:Ok_green.gif]]Officially available since 0.8, shipped with LDT since 0.9.
 
|-
 
|-
 
|[http://code.google.com/p/jnlua/ Jnlua-0.9]
 
|[http://code.google.com/p/jnlua/ Jnlua-0.9]
Line 26: Line 31:
 
|[[Image:Ok_green.gif]] Since LDT 0.9.
 
|[[Image:Ok_green.gif]] Since LDT 0.9.
 
| Based on Java Socket.  
 
| Based on Java Socket.  
|Interpreter based on Jnlua 0.9 delivered with LDT since 0.9.
+
|Interpreter based on Jnlua 0.9 shipped with LDT since 0.9.
|[[Image:Ok_green.gif]]Officially available since 0.8 (use Lua 5.1 one), deliver with LDT since 0.9.
+
|[[Image:Ok_green.gif]]Officially available since 0.8 (use Lua 5.1 one), shipped with LDT since 0.9.
 
|-
 
|-
 
|[http://eclipse.org/mihini/ Mihini-0.8]
 
|[http://eclipse.org/mihini/ Mihini-0.8]
 
|Lua-5.1
 
|Lua-5.1
 
|[[Image:Progress.gif]] Coming soon.
 
|[[Image:Progress.gif]] Coming soon.
| LuaSocket 2.0 is deliver with Mihini.
+
| LuaSocket 2.0 available in Mihini.
 
|
 
|
|[[Image:Progress.gif]] Coming soon.
+
||Available at [[LDT/User_Area/Available_Execution_Environments#Mihini_0.8 | Execution Environment page]]
 
|-
 
|-
 
|[http://www.lua.org/ Lua-5.2]
 
|[http://www.lua.org/ Lua-5.2]
 
|Lua-5.2
 
|Lua-5.2
|[[Image:Progress.gif]] In Progress.
+
|[[Image:Ok_green.gif]] Since LDT 1.0
| [https://github.com/diegonehab/luasocket/tree/unstable LuaSocket 2.1] needed (not released yet).
+
| [https://github.com/diegonehab/luasocket/tree/v3.0-rc1 LuaSocket 3.0 RC1] needed (not released yet).
| Could partially work with the 0.9.
+
|  
| Not available for now (we are looking for community help).
+
| [[Image:Ok_green.gif]] Shipped with LDT since 1.0.
 
|-
 
|-
 
|[http://code.google.com/p/jnlua/ Jnlua-1.0]
 
|[http://code.google.com/p/jnlua/ Jnlua-1.0]
 
|Lua-5.2
 
|Lua-5.2
| Should work, not tested.
+
| [[Image:Ok_green.gif]] Shipped since LDT 1.0
| Need a transport layer, perhaps works with LuaSocket 2.1.
+
| Based on Java Socket.  
| Could be nice to delivered it with LDT.
+
|  
| (see Lua 5.2)
+
| [[Image:Ok_green.gif]] Shipped since LDT 1.0
 
|-
 
|-
 
|[http://luajit.org/ LuaJIT-2.0]
 
|[http://luajit.org/ LuaJIT-2.0]
 
|Lua-5.1
 
|Lua-5.1
|[[Image:Progress.gif]] In Progress.
+
|[[Image:Ok_green.gif]] Since 1.0
| Should work with LuaSocket 2.0 patched ([https://github.com/diegonehab/luasocket/pull/24 here] the patches to apply) and perhaps with [https://github.com/diegonehab/luasocket/tree/unstable LuaSocket 2.1] (not released yet).
+
| Work with [https://github.com/diegonehab/luasocket/tree/v3.0-rc1 LuaSocket 3.0 RC1] (not released yet).
| Should work soon with a nightly build.
+
|  
 
| Lua 5.1 Execution environment could be used.
 
| Lua 5.1 Execution environment could be used.
 
|-
 
|-
Line 63: Line 68:
 
| Tested v2.8.10 on windows with LuaSocket 2.0 and LDT 0.9: works out of the box.
 
| Tested v2.8.10 on windows with LuaSocket 2.0 and LDT 0.9: works out of the box.
 
| We don't know about any. Perhaps it could be partially generated from [http://wxlua.sourceforge.net/documentation.php doxygen documentation] (we are looking for community help).  
 
| We don't know about any. Perhaps it could be partially generated from [http://wxlua.sourceforge.net/documentation.php doxygen documentation] (we are looking for community help).  
Lua 5.1 execution environement could be used waiting for better.
+
Lua 5.1 execution environment could be used waiting for better.
 
|-
 
|-
 
|MOAI
 
|MOAI
 
|Lua-5.1
 
|Lua-5.1
 
|Not officially supported.
 
|Not officially supported.
|LuaSocket deliver with MOAI.
+
|LuaSocket shipped by MOAI.
|Tested MOAI sdk v1.3-149 on windows : Works only with the [http://wiki.eclipse.org/Koneki/LDT/Developer_Area/User_Guides/User_Guide_0.9#Attach_session "Lua Attach To Application"] and seems there are problems with coroutine create with MOAI API.
+
|Tested MOAI sdk v1.3-149 on windows : Works only with the [[LDT/Developer_Area/User_Guides/User_Guide_0.9#Attach_session|Lua Attach To Application] and seems there are problems with coroutines created with MOAI's API.
 
Could be nice to offer a better support.
 
Could be nice to offer a better support.
Could work out of the box if MOAI interpreter supported "-e" option. :/
+
Could work out of the box if MOAI's interpreter was able to handle "-e" option. :/
|available at  [http://wiki.eclipse.org/Koneki/LDT/User_Area/Available_Execution_Environments Available Execution Environement]  
+
|Available at  [[LDT/User_Area/Available_Execution_Environments#MOAI_SDK_1.2_Execution_Environment_.28alpha.29 | Execution Environment page]]
 
|-
 
|-
 
|Gideros
 
|Gideros
Line 79: Line 84:
 
|LuaSocket ?
 
|LuaSocket ?
 
|Not tested.
 
|Not tested.
|available at [http://wiki.eclipse.org/Koneki/LDT/User_Area/Available_Execution_Environments Available Execution Environement]
+
|Available at [[LDT/User_Area/Available_Execution_Environments#Gideros_Studio_2012.2.2.1_.28alpha.29 | Execution Environment page]]
 
|-
 
|-
 
|Corona
 
|Corona
 
|Lua-5.1
 
|Lua-5.1
 
|Not officially supported.
 
|Not officially supported.
|LuaSocket ?
+
|Included in Corona
|Not tested.
+
|Successfully tested, see [[http://forums.coronalabs.com/topic/35188-windows-eclipse-koneki-corona-first-steps-setup/?p=183754 Corona forum]]
 
|We don't know about any (we are looking for community help).
 
|We don't know about any (we are looking for community help).
Lua 5.1 execution environement could be used waiting for better.
+
Lua 5.1 execution environment could be used waiting for better.
 
|-
 
|-
 
|LÖVE
 
|LÖVE
 
|Lua-5.1
 
|Lua-5.1
 
|Not officially supported.
 
|Not officially supported.
|LuaSocket ?
+
|LuaSocket shipped by LOVE.
|Not tested.
+
|Successfully tested on windows but need to define interpeter which does not support -e and file as arguments. Need to bootstrap debugger manually with <code>if os.getenv('DEBUG_MODE') then require "debugger"() end</code>. And add project path as interpreter arguments.
|We don't know about any (we are looking for community help).
+
|Available at [[LDT/User_Area/Available_Execution_Environments#L.C3.96VE_11.1 | Execution Environment page]]
Lua 5.1 execution environement could be used waiting for better.
+
 
|}
 
|}
 +
 +
 +
= Make my VM LDT Compatible =
 +
'''If you want to provide an execution environment for your VM, you could read [[LDT/User_Area/Execution_Environment_file_format |this]].'''
 +
 +
'''To be compatible with our debugger, you need to :'''
 +
* be based on a Lua VM 5.1 or 5.2.
 +
* integrate (or be compatible) with "standard" luasocket (2.0 or 2.1) to create a TCP connection between the VM and the IDE.
 +
(if you ''cannot/do not want to'' use luasocket, you can also implement your own transport layer : see the transport parameter of debuger in the [[LDT/Developer_Area/User_Guides/User_Guide_0.9#Attach_session|user guide]])
 +
 +
'''To have full debug integration with the IDE, you need to :'''
 +
* have an interpreter which handles the [http://www.lua.org/manual/5.1/manual.html#6 '-e' option] to bootstrap the debugger code.
 +
* have an interpreter which takes in parameter the lua script file to run ([http://www.lua.org/manual/5.1/manual.html#6 see lua interpreter documentation]).
 +
* respect the <code>LUA_PATH</code> and <code>LUA_CPATH</code> environment variable.
 +
* (optional) ship luasocket.

Latest revision as of 21:33, 5 December 2018

Compatible VMs

This page aims to list the Lua VMs which work with Lua Development Tools (LDT).

By "work", we mean :

  • VM which is compatible with our debugger.
  • VM for which an execution environment is available. (enable API's autocompletion and documentation)

(Feel free to complete this list with your tests)

VM Debugger Compatibility Execution Environment
Name-Version Based on Officially supported Transport Layer Comments Execution environment is only used to enable some user assistance (autocompletion, documentation) for a given VM
Lua-5.1 Lua-5.1 Ok green.gif Since LDT 0.1. LuaSocket 2.0 needed. Ok green.gifOfficially available since 0.8, shipped with LDT since 0.9.
Jnlua-0.9 Lua-5.1 Ok green.gif Since LDT 0.9. Based on Java Socket. Interpreter based on Jnlua 0.9 shipped with LDT since 0.9. Ok green.gifOfficially available since 0.8 (use Lua 5.1 one), shipped with LDT since 0.9.
Mihini-0.8 Lua-5.1 Progress.gif Coming soon. LuaSocket 2.0 available in Mihini. Available at Execution Environment page
Lua-5.2 Lua-5.2 Ok green.gif Since LDT 1.0 LuaSocket 3.0 RC1 needed (not released yet). Ok green.gif Shipped with LDT since 1.0.
Jnlua-1.0 Lua-5.2 Ok green.gif Shipped since LDT 1.0 Based on Java Socket. Ok green.gif Shipped since LDT 1.0
LuaJIT-2.0 Lua-5.1 Ok green.gif Since 1.0 Work with LuaSocket 3.0 RC1 (not released yet). Lua 5.1 Execution environment could be used.
wxLua Lua-5.1 Not officially supported, but should work. LuaSocket 2.0 needed. Tested v2.8.10 on windows with LuaSocket 2.0 and LDT 0.9: works out of the box. We don't know about any. Perhaps it could be partially generated from doxygen documentation (we are looking for community help).

Lua 5.1 execution environment could be used waiting for better.

MOAI Lua-5.1 Not officially supported. LuaSocket shipped by MOAI. Tested MOAI sdk v1.3-149 on windows : Works only with the [[LDT/Developer_Area/User_Guides/User_Guide_0.9#Attach_session|Lua Attach To Application] and seems there are problems with coroutines created with MOAI's API.

Could be nice to offer a better support. Could work out of the box if MOAI's interpreter was able to handle "-e" option. :/

Available at Execution Environment page
Gideros Lua-5.1 Not officially supported. LuaSocket ? Not tested. Available at Execution Environment page
Corona Lua-5.1 Not officially supported. Included in Corona Successfully tested, see [Corona forum] We don't know about any (we are looking for community help).

Lua 5.1 execution environment could be used waiting for better.

LÖVE Lua-5.1 Not officially supported. LuaSocket shipped by LOVE. Successfully tested on windows but need to define interpeter which does not support -e and file as arguments. Need to bootstrap debugger manually with if os.getenv('DEBUG_MODE') then require "debugger"() end. And add project path as interpreter arguments. Available at Execution Environment page


Make my VM LDT Compatible

If you want to provide an execution environment for your VM, you could read this.

To be compatible with our debugger, you need to :

  • be based on a Lua VM 5.1 or 5.2.
  • integrate (or be compatible) with "standard" luasocket (2.0 or 2.1) to create a TCP connection between the VM and the IDE.

(if you cannot/do not want to use luasocket, you can also implement your own transport layer : see the transport parameter of debuger in the user guide)

To have full debug integration with the IDE, you need to :

  • have an interpreter which handles the '-e' option to bootstrap the debugger code.
  • have an interpreter which takes in parameter the lua script file to run (see lua interpreter documentation).
  • respect the LUA_PATH and LUA_CPATH environment variable.
  • (optional) ship luasocket.

Back to the top