raylib_npp_parser.c

/**********************************************************************************************

    raylib_npp_parser - raylib header parser to generate Notepad++ autocompletion data

    This parser scans raylib.h for functions that start with RLAPI and generates Notepad++
    autocompletion xml equivalent for function and parameters.

    Converts:
    RLAPI Color Fade(Color color, float alpha); // Color fade-in or fade-out, alpha goes from 0.0f to 1.0f

    To:
    <KeyWord name="Fade" func="yes">
        <Overload retVal="Color" descr="Color fade-in or fade-out, alpha goes from 0.0 to 1.0">
            <Param name="Color color" />
            <Param name="float alpha" />
        </Overload>
    </KeyWord>
    
    NOTE: Generated XML text should be copied inside raylib\Notepad++\plugins\APIs\c.xml
    
    WARNING: Be careful with functions that split parameters into several lines, it breaks the process!

    LICENSE: zlib/libpng

    raylib is licensed under an unmodified zlib/libpng license, which is an OSI-certified,
    BSD-like license that allows static linking with closed source software:

    Copyright (c) 2018 Ramon Santamaria (@raysan5)

**********************************************************************************************/

#include <stdio.h>
#include <string.h>
#include <stdbool.h>
#include <stdlib.h>

#define MAX_BUFFER_SIZE     512

int main(int argc, char *argv[])
{
    if (argc > 1)
    {
        FILE *rFile = fopen(argv[1], "rt");
        FILE *rxmlFile = fopen("raylib_npp.xml", "wt");
        
        if ((rFile == NULL) || (rxmlFile == NULL))
        {
            printf("File could not be opened.\n");
            return 0;
        }
        
        char *buffer = (char *)calloc(MAX_BUFFER_SIZE, 1);
        int count = 0;

        while (!feof(rFile))
        {
            // Read one full line
            fgets(buffer, MAX_BUFFER_SIZE, rFile);
            
            if (buffer[0] == '/') fprintf(rxmlFile, "        <!--%.*s -->\n", strlen(buffer) - 3, buffer + 2);
            else if (buffer[0] == '\n') fprintf(rxmlFile, "%s", buffer);      // Direct copy of code comments
            else if (strncmp(buffer, "RLAPI", 5) == 0)      // raylib function declaration
            {
                char funcType[64];
                char funcTypeAux[64];
                char funcName[64];
                char funcDesc[256];
                
                char params[128];
                char paramType[16][16];
                char paramName[16][32];
                
                int index = 0;
                char *ptr = NULL;
                
                sscanf(buffer, "RLAPI %s %[^(]s", funcType, funcName);
                
                if (strcmp(funcType, "const") == 0)
                {            
                    sscanf(buffer, "RLAPI %s %s %[^(]s", funcType, funcTypeAux, funcName);
                    strcat(funcType, " ");
                    strcat(funcType, funcTypeAux);
                }
                
                ptr = strchr(buffer, '/');
                index = (int)(ptr - buffer);
                
                sscanf(buffer + index, "%[^\n]s", funcDesc);        // Read function comment after declaration
                
                ptr = strchr(buffer, '(');
                
                if (ptr != NULL) index = (int)(ptr - buffer);
                else printf("Character not found!\n");
                
                sscanf(buffer + (index + 1), "%[^)]s", params);     // Read what's inside '(' and ')'

                // Scan params string for number of func params, type and name
                char *paramPtr[16];         // Allocate 16 pointers for possible parameters
                int paramsCount = 0;
                paramPtr[paramsCount] = strtok(params, ",");

                if ((funcName[0] == '*') && (funcName[1] == '*')) fprintf(rxmlFile, "        <KeyWord name=\"%s\" func=\"yes\">\n", funcName + 2);
                else if (funcName[0] == '*') fprintf(rxmlFile, "        <KeyWord name=\"%s\" func=\"yes\">\n", funcName + 1);
                else fprintf(rxmlFile, "        <KeyWord name=\"%s\" func=\"yes\">\n", funcName);
                
                fprintf(rxmlFile, "            <Overload retVal=\"%s\" descr=\"%s\">", funcType, funcDesc + 3);
                 
                bool paramsVoid = false;
                
                char paramConst[8][16];

                while (paramPtr[paramsCount] != NULL)
                {
                    sscanf(paramPtr[paramsCount], "%s %s\n", paramType[paramsCount], paramName[paramsCount]);
                      
                    if (strcmp(paramType[paramsCount], "void") == 0)
                    {
                        paramsVoid = true;
                        break;
                    }
                    
                    if ((strcmp(paramType[paramsCount], "const") == 0) || (strcmp(paramType[paramsCount], "unsigned") == 0))
                    {
                        sscanf(paramPtr[paramsCount], "%s %s %s\n", paramConst[paramsCount], paramType[paramsCount], paramName[paramsCount]);
                        fprintf(rxmlFile, "\n                <Param name=\"%s %s %s\" />", paramConst[paramsCount], paramType[paramsCount], paramName[paramsCount]);
                    }
                    else if (strcmp(paramType[paramsCount], "...") == 0) fprintf(rxmlFile, "\n                <Param name=\"...\" />");
                    else fprintf(rxmlFile, "\n                <Param name=\"%s %s\" />", paramType[paramsCount], paramName[paramsCount]);

                    paramsCount++;
                    paramPtr[paramsCount] = strtok(NULL, ",");
                }
                
                fprintf(rxmlFile, "%s</Overload>\n", paramsVoid ? "" : "\n            ");
                fprintf(rxmlFile, "        </KeyWord>\n");

                count++;
                printf("Function processed %02i: %s\n", count, funcName);
                
                memset(buffer, 0, MAX_BUFFER_SIZE);
            }
        }
        
        free(buffer);
        fclose(rFile);
        fclose(rxmlFile);
    }

    return 0;
}