This documenta- tion describes the current state of development.
Note that interfaces and functionality may still change.

Prokee Modules:

open all | close all

GUI Elements:

open all | close all

GUI Interactions:

open all | close all

GUI Layouts:

open all | close all

Games/Demos:

open all | close all

Third Party Libraries:

open all | close all

Information about this Website / Informationen zu dieser Webseite:

In case of any questions, or comments, please feel free to contact me via email at apoll500@gmail.com.

Module bmc_extract [Version: v01]

[Documentation]

[Details]

[Wiki]

[Tests]

This documentation describes the Prokee module interface.

Static Methods:

reset
int bmc_extract::reset(const char *target_filename)

extract
int bmc_extract::extract(const char *source_filename,const char *target_filename)

extract_file
int bmc_extract::extract_file(const char *source_filename,const char *target_filename)

Motivation

In some cases it is more convenient to put DEF-Blocks (for bmc) directly into source files. When writing DEF-Blocks within a C/C++ file, the blocks have to be put inside of C/C++-comments.

Because bmc can not read DEF-Blocks directly from a C/C++ source file, we provide the following work-around.
This module copies all DEF-blocks from inside of special comments of C/C++ files (or other source files) into an aditional file which then can be interpreted by bmc. Actually the module does not only copy DEF-blocks (which would require parsing them), but copies all the content from within special comments. The special comments are C-block-comments marked with the word 'bmc' in the first line, as described below.

bmc Comments

The red marked part will be copied.
The ... in the example above stand for none or any number of stars and spaces.

Syntax specfication: '/' '*' { {' '} {'*'} } 'b' 'm' 'c' < content > '*' '/'

Blöcke des Quellcodes exportieren:

1) Den nachfolgenden C/C++ Codeblock einbinden:

CODE=?\n

oder:

CODE=?;

Das Kommando muss entweder mit ';' oder mit einem Zeilenumbruch '\n' enden.

2) Einen oder mehrere (bis zu 9) nachfolgende C/C++ Codeblöcke einbinden:

CODE=?n

wobei n ∈{1,2,...,9}

3) Einen zusätzlichen Codeblock benennen und einbinden:

CODE=?X

wobei X ∈{A,B,...,Z}

4) Einen zusätzlichen benannten Codeblock einbinden (hier für X:=A):

CODE2="@CODE_A";

oder (zusätzlich eine eindeutige id vergeben, falls mehrere benannte zus. Blöcke unter einer Funktion/Methode eingebunden werden sollen)

CODE2
{
    "@CODE_A";
    id="1";
}

Static Methods

reset

Resets the target file. This discardes all contents of the target file.

Signature:

int bmc_extract::reset(const char *target_filename)

Parameters:

Type	Name	Direction	Description
const char *	target_filename	[IN]	Filename of the target file.

Return value:
unspecified

Code: toggle

int bmc_extract::reset(const char *target_filename)
{
    FILE *f=fopen(target_filename,"wb");

    if(!f)
    {
        fprintf(stderr,"Failed to open output file.");
        return 0;
    }

    fprintf(f,"//------------------------------------------------------------------------------\n");
    fprintf(f,"// Interface specifications and documentation extracted from source files.\n");
    fprintf(f,"//------------------------------------------------------------------------------\n");

    fclose(f);

    return 0;
}

extract

Extracts bmc-documentation from a source file and appends it to another file.

Signature:

int bmc_extract::extract(const char *source_filename,const char *target_filename)

Parameters:

Type	Name	Direction	Description
const char *	source_filename	[IN]	Filename of the source file.
const char *	target_filename	[IN]	Filename of the target file.

Return value:
unspecified

Remarks:

This method allows source_filename to be a path to a directory. If so, the method searches through all files in this directory and all its subdirectories.

Code: toggle

int bmc_extract::extract(const char *source_filename,const char *target_filename)
{
    if(path::pathtype(source_filename) & PATH_DIR)
    {
        DIRECTORY *d=dir::opendir(source_filename);
        char *a;
        while((a=dir::getNextItem(d))[0]!=0)
        {
            char *b=(char *)malloc((str::len(source_filename)+str::len(a)+1)*sizeof(char));
            str::cpy(b,source_filename);
            str::cat(b,a);
            extract(b,target_filename);
            free(b);
        }
        dir::closedir(d);
    }
    else
    {
        return extract_file(source_filename,target_filename);
    }
    return 0;
}

extract_file

Extracts bmc-documentation from a source file and appends it to another file.

Signature:

int bmc_extract::extract_file(const char *source_filename,const char *target_filename)

Parameters:

Type	Name	Direction	Description
const char *	source_filename	[IN]	Filename of the source file.
const char *	target_filename	[IN]	Filename of the target file.

Return value:
unspecified

Code: toggle

int bmc_extract::extract_file(const char *source_filename,const char *target_filename)
{
    printf("bmc_extract: %s\n",source_filename);

    static int code_id=0;

    FileReader r(source_filename);

    if(r.getLastError())
    {
        fprintf(stderr,"FileReder failed to open input file. Error Code %d",r.getLastErrorDetail());
        return 0;
    }

    FILE *f=fopen(target_filename,"ab");

    if(!f)
    {
        fprintf(stderr,"Failed to open output file.");
        return 0;
    }

    int status=0;
    int ch;

    int substatus=0;
    int nesting_level=0;
    int code_found=0;
    char code_block_name=0;

    while((ch=r.get())!=-1)
    {
        //printf("%c",ch);
        if(status==0)
        {
            if(ch=='/')
            {
                code_block_name=0;
                status=1;
            }
        }
        else if(status==1)
        {
            if(ch=='*')
            {
                status=2;
            }
            else
            {
                status=0;
            }
        }
        else if(status==2)
        {
            if(ch=='*' || ch==' ')
            {
                status=2;
            }
            else if(ch=='b')
            {
                status=3;
            }
            else
            {
                status=0;
            }
        }
        else if(status==3)
        {
            if(ch=='m')
            {
                status=4;
            }
            else
            {
                status=0;
            }
        }
        else if(status==4)
        {
            if(ch=='c')
            {
                status=5;
            }
            else
            {
                status=0;
            }
        }
        else if(status==5)
        {
            if(ch=='*')
            {
                status=6;
            }
            else
            {
                if(ch=='C')
                {
                    fputc(ch,f);
                    substatus=1;
                }
                else if(ch=='O' && substatus==1)
                {
                    fputc(ch,f);
                    substatus=2;
                }
                else if(ch=='D' && substatus==2)
                {
                    fputc(ch,f);
                    substatus=3;
                }
                else if(ch=='E' && substatus==3)
                {
                    fputc(ch,f);
                    substatus=4;
                }
                else if(ch=='=' && substatus==4)
                {
                    fputc(ch,f);
                    substatus=5;
                }
                else if(ch=='?' && substatus==5)
                {
                    substatus=6;
                }
                else if((ch=='\n' || ch==';') && substatus==6)
                {
                    fprintf(f,"\"%d\";\n",code_id);
                    code_found=1;
                    substatus=0;
                }
                else if(ch>='1' && ch<='9' && substatus==6)
                {
                    fprintf(f,"\"%d\";",code_id);
                    code_found=1+ch-'1';
                    substatus=0;
                }
                else if(substatus==6)
                {
                    fprintf(f,"\"%c\";",ch);
                    code_block_name=ch;
                    code_found=1;
                    substatus=0;
                }
                /*
                else if(ch=='2' && substatus==6)
                {
                    fprintf(f,"\"%d\";",code_id);
                    code_found=2;
                    substatus=0;
                }
                */
                else
                {
                    fputc(ch,f);
                    //printf("%c",ch);
                }
            }
        }
        else if(status==6)
        {
            if(ch=='/')
            {
                if(code_found)
                {
                    status=20;
                    //code_found=false;
                }
                else
                {
                    status=0;
                }
            }
            else
            {
                fputc('*',f);
                fputc(ch,f);
                //printf("%c",'*');
                //printf("%c",ch);
                status=5;
            }
        }
        else if(status==20)
        {
            if(code_block_name)
            {
                fprintf(f,"DEF CODE_%c\n{\n->\n",code_block_name);//}
            }
            else
            {
                fprintf(f,"DEF CODE_%d\n{\n->\n",code_id++);//}
            }
            nesting_level=0;
            fputc(ch,f);
            status=21;
            code_found--;
        }
        else if(status==21)
        {
            fputc(ch,f);
            if(ch=='{')
            {
                nesting_level++;
            }
            else if(ch=='}')
            {
                nesting_level--;
                if(nesting_level<=0)
                {
                    if(code_found)
                    {
            code_found--;
                        //status=20;
                    }
                    else
                    {
                    fprintf(f,"\n<");
                    fprintf(f,"-\n}\n");//{
                        status=0;
                    }
                }
            }
        }
        else if(status==22)
        {
        }
    }

    fclose(f);

    return 0;
}