Minimalistisches PlugIn-System

[ehX]

Also, generell ist es so (stark vereinfacht, und das ganze wird natürlich dann in Plugin- / API-Klassen gekapselt):


1) Du bindest erstmal die Lua-Header (Lua, LuaLib, LualAuxlib) ein.
In meinem Fall verwende ich für Delphi Lua 5.1.4.
Die Header liegen natürlich erstmal in C vor und müssen für Delphi konvertiert werden.
Das ist aber nicht sonderlich schwer, nur nervig :-)

2) Du deklarierst eine API-Funktion im Host, auf die Lua dann Zugriff haben soll, z.B. ein simples Showmessage:

Delphi-Quellcode:

function lua__Showmessage(L:Lua_State):Integer; cdecl ;
var
  i,pCount : Integer ;
  FAddOn : TehXAddon ;
begin
  // Ausführendes Plugin anhand des Lua-States ermitteln (diese Funktion ist dann in der Plugin -Klasse und ist für das Beispiel nun nicht sonderlich relevant)
  FAddOn := LuaHandler.FindAddOnByState(L) ;
  
  // Hole dir die Anzahl der von der Lua-Funktion auf dem Lua-Stack abgelegten Parameter
  // An der höchsten Position des Lua-Stacks befindet sich immer die Anzahl der Parameter auf dem Stack
  // In diesem Fall bedeutet jeder Parameter ein eigenes Showmessage
  pCount := lua_gettop(L) ;
  
  for i := 1 to pCount do
  begin
    // Parameter vom Lua-Stack holen, als string casten und per showmessage() ausgeben
    // Man zählt von der höchsten Lua-Stack-Position rückwärts
    Showmessage(lua_tostring(L,-i)) ;
  end;
  
  // Lua-Stack bereinigen => Parameter vom Stapel nehmen
  lua_pop(L,lua_gettop(L));
  
  // Rückgabewert 0 an Lua => Anzahl der von der Funktion auf den Stack gelegten Variablen 
  // => Es wurde in diesem simplen Beispiel nichts abgelegt
  Result := 0;
end;

3) Man initialisiert im Host einen neuen Lua-State über die Lua-API über luaL_open() ;

4) Die vorhin deklarierte Funktion muss für den Lua-State registriert werden, damit Lua sie auch verwenden kann, das geht mit lua_register.
Wir nennen die Funktion in Lua simpel "Showmessage", wie im Delphi-Original

Delphi-Quellcode:

lua_register(FLuaState,PAnsiChar('Showmessage'),lua__Showmessage);

5) Jetzt kann man die Funktion in einem Lua-Script verwenden:
Folgender Aufruf in einem Lua-Script führt nun zwei Showmessage des Hostprogramms aus, einmal mit "Hello" und einmal mit "World"

Code:

Showmessage('Hello','World');

6) Das Host-Programm muss dazu gebraucht werden, den Lua-Code auch zu laden und auszuführen, das passiert ähnlich wie bei einer DLL (Datei laden und initialisieren über lua_dofile oder auch einzelne Funktionen, um Lua-Chunks auszuführen. Die Logik, wann was passiert, wird natürlich über deine Programmlogik (Eventhandler etc.) gesteuert)

Umgekehrt geht das ganze natürlich auch, der Host kann jegliche Funktionen eigenen API über Lua, und auch alle Funktionen, die in den Scripten deklariert wurden, über call /pCall aufrufen, aber das würde jetzt das kleine Beispiel sprengen :-)

Ich hoffe, die generelle Vorgehensweise ist nun klar? :-)
Durch die Implementierung von Lua kannst du also nun Funktionen als API schreiben, die der Script-Engine zur Verfügung stehen sollen und deine Kunden können daraus dann Plugins und Addons basteln. Wie diese Funktionen aussehen und was sie machen, ist nicht beschränkt, da sind dir alle Möglichkeiten offen.
Zudem hast du so auch die Möglichkeit, z.B. verschiedenen User-Accesslevels auch unterschiedliche API-Funktionen über lua_register() zu registrieren, so dass nicht jeder alles verwenden darf.

[neo4a]

Dein Ansatz ist ganz ähnlich dem hier und warum sollte es auch nicht so sein.

Für LUA muss man ja immer eine DLL mit ausliefern, oder gibt es bereits eine OBJ-Lösung zum embedden?

AFAIK, läuft LUA auch unter iOS. Wäre interessant zu wissen, ob diese Einbindung unter allen Systemen funktioniert, die XE2 und LUA unterstützen.

Bei LUA wird neben der immensen Verbreitung immer die Performanz hervor gehoben. Gibt es aus Deiner Sicht noch weitere heraus ragende Merkmale?

Würde LUA nun auch noch mit verschiedenen Sprachsyntaxe unterstützen (Pascal, JavaScript, VB etc.) und Kaffee kochen können...

[ehX]

Zitat:

Dein Ansatz ist ganz ähnlich dem hier und warum sollte es auch nicht so sein.

Stimmt, obwohl ich das bis jetzt gar nicht kannte :-D Da hatte wohl jemand eine ähnliche Idee. Und er ist wohl "weiter", dermaßen komplex wie diese ist meine Implementation noch nicht.
Als ich angefangen hatte, mein lua-basiertes Plugin-System für Delphi zu schreiben, gab es das noch nicht (oder ich hatte es nicht gefunden :-))
Sonst hätte ich wohl gleich das genommen :-D
Lustig, das dort vorgestellte Beispiel ist auch ein showmessage() und sieht fast identisch aus :-)

Zitat:

Für LUA muss man ja immer eine DLL mit ausliefern, oder gibt es bereits eine OBJ-Lösung zum embedden?

AFAIK über ein OBJ nein, aber es geht über Umwege: In die Applikation z.B. BoxedApp einbauen, die DLL als Resource einbinden und über BoxedApp dann virtuell laden.
Dann ist die Lua-DLL in der EXE und wird unter einer virtuellen Umgebung geladen. Habe ich testweise mal ausprobiert, klappt einwandfrei.

Zitat:

Bei LUA wird neben der immensen Verbreitung immer die Performanz hervor gehoben. Gibt es aus Deiner Sicht noch weitere heraus ragende Merkmale?

Ja, Lua ist sehr schnell. Was ich herausragend finde: Die Syntax finde ich gerade das Merkmal, das Lua herausragend macht. Sie ist einfach und auch für Nicht-Programmierer leicht erlernbar, so können viele sich ihr Addon zusammenstricken. Zudem ist die C-API Implementation über den Lua-Stack sehr transparent. Einmal verstanden sind neue Dinge im Host sehr schnell implementiert und man braucht nur sehr wenig Code, um eine Funktion als API nach aussen zu porten.
Weiteres Merkmal: Es gibt für Lua viele nette Erweiterungen, die man Einbinden kann. Zudem lässt sich genau kontrollieren, welche Std-Libs geladen werden können, einzelne Funktionen sperren ist auch leicht möglich etc.

Zitat:

AFAIK, läuft LUA auch unter iOS. Wäre interessant zu wissen, ob diese Einbindung unter allen Systemen funktioniert, die XE2 und LUA unterstützen.

Das interesisert mich auch. Aber erstmal sehen, wie XE2 und iOS überhaupt "zusammearbeiten" :-) Ich hab meine Finger an XE2 noch nicht dran, wie auch...

[neo4a]

Zitat:

Zitat von ehX (Beitrag 1119627)

Zitat:

Dein Ansatz ist ganz ähnlich dem hier und warum sollte es auch nicht so sein.

Stimmt, obwohl ich das bis jetzt gar nicht kannte :-D Da hatte wohl jemand eine ähnliche Idee. Und er ist wohl "weiter",

Ja, er übertreibt in jeder Beziehung. Er programmiert z.B. an 3 27"-Monitoren. Das ist ja pervers. Aber seine TKinect- Implementierung zur Fuchtelsteuerung hat schon was...

Zitat:

BoxedApp

Stimmt das habe ich hier schon einmal eingesetzt. Da ich aber nur noch "Multi-Plattform" denke, ist dieser Ansatz nicht so primär.

Zitat:

Zitat:

AFAIK, läuft LUA auch unter iOS. Wäre interessant zu wissen, ob diese Einbindung unter allen Systemen funktioniert, die XE2 und LUA unterstützen.

Das interesisert mich auch. Aber erstmal sehen, wie XE2 und iOS überhaupt "zusammearbeiten" :-) Ich hab meine Finger an XE2 noch nicht dran, wie auch...

Na hier hatten die bisherigen Veröffentlichungen zu FireMonkey etwas Substanz: Für iOS muss auf OSX-Seite noch XCode verwendet werden (u.a. wegen dieses ganzen Signatur-Geraffels). Heißt aber auch: Läuft LUA unter iOS und ist FPC in der Lage, Schnittstellen zwischen Pascal und ext. Libs wie LUA zu binden, dann, ja dann... Aber da hört leider das Substanzielle der derzeitigen schönen XE2-Marketingwelt auch schon wieder auf.

[BUG]

Zitat:

Zitat von neo4a (Beitrag 1119624)

Bei LUA wird neben der immensen Verbreitung immer die Performanz hervor gehoben. Gibt es ... noch weitere heraus ragende Merkmale?

Portabilität:

http://www.lua.org/about.html

... builds out-of-the-box in all platforms that have an ANSI/ISO C compiler ...

Was man auch nicht vergessen sollte: da viele Spiele mit Lua gescriptet werden können, gibt es Leute, die sich damit in der Freizeit beschäftigen (Mods, AddOns, usw.).

[neo4a]

Hast Du Infos, inwieweit das Einbinden ext. Libs wie LUA durch FreePascal auch unter OSX funktioniert?

Leider beschränken sich meine FreePascal-Cross-Plattform-Kenntnisse auf einen (seinerzeit durchaus erfolgreichen) Versuch beim Kompilieren meiner Firebird-UDF für Linux.