diff options
Diffstat (limited to 'doc_parser.lua')
| -rw-r--r-- | doc_parser.lua | 171 |
1 files changed, 171 insertions, 0 deletions
diff --git a/doc_parser.lua b/doc_parser.lua new file mode 100644 index 0000000..dafedb3 --- /dev/null +++ b/doc_parser.lua @@ -0,0 +1,171 @@ +--Create api.md file from c sources. + +local function split( str, sep ) + if sep == nil then + sep = "%s" + end + + local t = {} + + for str in string.gmatch( str, "([^"..sep.."]+)" ) do + table.insert( t, str ) + end + + return t +end + +local apiFile = io.open( "API.md", "w" ) + +-- Header +apiFile:write( "# ReiLua API\n" ) + +-- Usage. + +apiFile:write( "\n## Usage\n" ) +apiFile:write( "\nApplication needs 'main.lua' file as entry point. ReiLua executable will first look it from same directory\ +or it's path can be given by argument. There are three global functions that the engine will call, 'init', 'process' and 'draw'.\n" ) + +apiFile:write( "\n---\n> function init()\n\ +This function will be called first when 'main.lua' is found\n\n---\n" ) +apiFile:write( "\n> function process( delta )\n\ +This function will be called every frame during execution. It will get time duration from last frame on argument 'delta'\n\n---\n" ) +apiFile:write( "\n> function draw()\n\ +This function will be called every frame after process and it should have all rendering related functions.\ +Note: Engine will call Raylib functions 'BeginDrawing()' before this function call and 'EndDrawing()' after it\n\n---\n" ) + +-- Globals. + +local srcFile = io.open( "src/lua_core.c", "r" ) +local writing = false + +repeat + line = srcFile:read( "*l" ) + local lineSplit = split( line, " " ) + + if line == "/*DOC_END*/" then + writing = false + break + end + + if writing then + if lineSplit[1] == "\t/*" then + apiFile:write( "\n## Globals - "..lineSplit[2].."\n" ) + else + -- Remove comma from the end. + apiFile:write( "\n"..lineSplit[2]:sub( 1, -2 ).."\n" ) + end + end + + if line == "/*DOC_START*/" then + writing = true + end +until line == nil + +srcFile:close() + +-- Types. + +apiFile:write( "\n## Types\n\ +Raylib structs in Lua\n\n---\n" ) + +apiFile:write( "\n> Vector2 = { 1.0, 1.0 }\n\ +Vector2 type\n\n---\n" ) +apiFile:write( "\n> Vector3 = { 1.0, 1.0, 1.0 }\n\ +Vector3 type\n\n---\n" ) +apiFile:write( "\n> Vector4 = { 1.0, 1.0, 1.0, 1.0 }\n\ +Vector4 type\n\n---\n" ) +apiFile:write( "\n> Quaternion = { 1.0, 1.0, 1.0, 1.0 }\n\ +Quaternion type\n\n---\n" ) +apiFile:write( "\n> Matrix = { { 1.0, 0.0, 0.0, 0.0 }, { 0.0, 1.0, 0.0, 0.0 }, { 0.0, 0.0, 1.0, 0.0 }, { 0.0, 0.0, 0.0, 1.0 } }\n\ +OpenGL style 4x4. Identity matrix example\n\n---\n" ) +apiFile:write( "\n> Color = { 255, 255, 255, 255 }\n\ +{ r, g, b ,a }. Color type, RGBA (32bit)\n\n---\n" ) +apiFile:write( "\n> Rectangle = { 0.0, 0.0, 1.0, 1.0 }\n\ +{ x, y, w ,h }. Rectangle type\n\n---\n" ) +apiFile:write( "\n> Image = ImageId\n\ +int id. Image type (multiple pixel formats supported). NOTE: Data stored in CPU memory (RAM)\n\n---\n" ) +apiFile:write( "\n> Texture = TextureId\n\ +int id. Texture type (multiple internal formats supported). NOTE: Data stored in GPU memory (VRAM)\n\n---\n" ) +apiFile:write( "\n> RenderTexture = RenderTextureId\n\ +int id. RenderTexture type, for texture rendering\n\n---\n" ) +apiFile:write( "\n> Font = FontId\n\ +int id. Font type, includes texture and chars data\n\n---\n" ) +apiFile:write( "\n> Camera = CameraId\n\ +int id. Defines 3d camera position/orientation\n\n---\n" ) +apiFile:write( "\n> Mesh = MeshId\n\ +int id. Vertex data defining a mesh\n\n---\n" ) +apiFile:write( "\n> Material = MaterialId\n\ +int id. Material type\n\ +```\ +table = {\ + shader = Shader,\ + maps = {\ + {\ + MATERIAL_MAP_ALBEDO,\ + {\ + texture = Texture,\ + color = WHITE,\ + value = 1.0,\ + },\ + },\ + ...\ + },\ + params = { 1.0, 2.0, 3.0, 4.0 },\ +}\ +```\n\n---\n" ) +apiFile:write( "\n> Model = ModelId\n\ +int id. Basic 3d Model type\n\n---\n" ) +apiFile:write( "\n> Ray = { { 0.0, 0.0, 0.0 }, { 1.0, 0.0, 0.0 } }\n\ +{ position, direction }. Ray type (useful for raycast)\n\n---\n" ) +apiFile:write( "\n> RayCollision = { hit = true, distance = 1.0, point = { 0.0, 0.0 }, normal = { 0.0, 0.0, 1.0 } }\n\ +Raycast hit information. NOTE: Data in named keys\n\n---\n" ) +apiFile:write( "\n> BoundingBox = { { 0.0, 0.0, 0.0 }, { 1.0, 1.0, 1.0 } }\n\ +{ min, max }. Bounding box type for 3d mesh\n\n---\n" ) +apiFile:write( "\n> Sound = SoundId\n\ +int id. Basic Sound source and buffer\n\n---\n" ) +apiFile:write( "\n> NPatchInfo = { { 0, 0, 24, 24 }, 0, 0, 0, 0, NPATCH_NINE_PATCH }\n\ +{ Rectangle source, int left, int top, int right, int bottom, int layout }.\ +{ Texture source rectangle, Left border offset, Top border offset, Right border offset, Bottom border offset, Layout of the n-patch: 3x3, 1x3 or 3x1 }\n\n---\n" ) +apiFile:write( "\n> ModelAnimations = ModelAnimationsId\n\ +int id. ModelAnimations\n\n---\n" ) + +-- Functions. + +local sourceFiles = { + "src/core.c", + "src/shapes.c", + "src/textures.c", + "src/text.c", + "src/models.c", + "src/audio.c", + "src/rmath.c", + "src/rgui.c", +} + +for _, src in ipairs( sourceFiles ) do + srcFile = io.open( src, "r" ) + local line = "" + local p = false + + repeat + line = srcFile:read( "*l" ) + + if line == "*/" then + p = false + apiFile:write( "\n---\n" ) + end + + if p then + apiFile:write( line.."\n" ) + end + + if line == "/*" then + p = true + apiFile:write( "\n" ) + end + until line == nil + + srcFile:close() +end + +apiFile:close() |