Added some comments.

This commit is contained in:
Adam Harrison
2021-09-16 16:22:33 -04:00
parent 03b467d9d9
commit 801b7dd0d9
2 changed files with 38 additions and 7 deletions
+36 -5
View File
@@ -1,13 +1,44 @@
#ifndef LITE_XL_PLUGIN_API
#define LITE_XL_PLUGIN_API
/* This file was automatically generated by the below code. Do not modify directly.
#!/bin/sh
# Takes lua folder, outputs a header file that includes all the necessary macros for writing a lite plugin.
# Takes a minimal approach, and strips out problematic functions. Should be good enough for most purposes.
/*
The lite_xl plugin API is quite simple. Any shared library can be a plugin file, so long
as it has an entrypoint that looks like the following, where xxxxx is the plugin name:
#include "lite_xl_plugin_api.h"
int lua_open_xxxxx(lua_State* L, void* XL) {
lite_xl_plugin_init(XL);
...
return 1;
}
In linux, to compile this file, you'd do: 'gcc -o xxxxx.so -shared xxxxx.c'. Simple!
Due to the way the API is structured, you *should not* link or include lua libraries.
This file was automatically generated by the below code. Do NOT MODIFY DIRECTLY.
#!/bin/sh
echo "#ifndef LITE_XL_PLUGIN_API"
echo "#define LITE_XL_PLUGIN_API"
echo "/* This file was automatically generated by the below code. Do not modify directly."
echo "/* "
echo "The lite_xl plugin API is quite simple. Any shared library can be a plugin file, so long"
echo "as it has an entrypoint that looks like the following, where xxxxx is the plugin name:"
echo
echo '#include "lite_xl_plugin_api.h"'
echo
echo "int lua_open_xxxxx(lua_State* L, void* XL) {"
echo " lite_xl_plugin_init(XL);"
echo " ..."
echo " return 1;"
echo "}"
echo
echo "In linux, to compile this file, you'd do: 'gcc -o xxxxx.so -shared xxxxx.c'. Simple!"
echo "Due to the way the API is structured, you *should not* link or include lua libraries."
echo
echo "This file was automatically generated by the below code. Do NOT MODIFY DIRECTLY."
echo
echo
cat $0
echo "*""/"
echo "#include <stddef.h>"