Small but handy tool - GameCreators Forum

Author

Message

Ravey

Retired TGC Developer

22

Years of Service

User Offline

Joined: 2nd Nov 2002

Location: Southern TGC Nerve Centre

Posted: 30th Jan 2013 11:53 Edited at: 30th Jan 2013 11:55

Link

Hi guys,

I just thought I would share a small utility I used when developing with AGK.

With a large project you can end up with many files and some of those files can get quite large.

I wanted a way to see all the functions at once and ideally see which line each function resided at.

The attached little tool runs in the projects folder and scans through each file producing a header at the top listing all functions and line numbers.

You get something like this:

//----------- Function List -----------//
/*

98 : function Network_Connect ( )
123 : function Network_SetupErrorDialog ( )
153 : function Network_ClearErrorDialog ( )
163 : function Network_Close ( )
167 : function Network_ResetState ( )
172 : function Network_RegisterUser ( name$, password$, email$ )
178 : function Network_ForgottenDetails ( name$, email$ )
184 : function Network_LoginUser ( name$, password$ )

*/
//-------------------------------------//

You can then copy the line number, do CTRL+G and jump straight to the function.

>> If you need to refresh the info you will have to remove the header code first and re run the tool. <<

Might not be any use to you, but I thought I would share it none the less.

PS - Back up your source code before use, better safe than sorry

Dave Milton
TGC Team

Attachments

Login to view attachments

Back to top

Profile PM Email Website

MarcoBruti

13

Years of Service

User Offline

Joined: 20th Nov 2011

Location: Caput Mundi

Posted: 30th Jan 2013 12:17

Link

interesting, but it would be far more useful to have such a tool embedded into the IDE, as it currently happens with DBPro. For each source file, DBPro displays functions, variables, etc.

Back to top

Profile PM Email Website

Van B

Moderator

22

Years of Service

User Offline

Joined: 8th Oct 2002

Location: Sunnyvale

Posted: 30th Jan 2013 12:17

Link

Nice

- It kinda annoys me that I don't have all the functions listed, like with DBPro's IDE - this should proove very handy with larger projects.

I got a fever, and the only prescription, is more memes.

Back to top

Profile PM Email

AgentSam

12

Years of Service

User Offline

Joined: 14th Mar 2012

Location: Virtual Space

Posted: 30th Jan 2013 13:26 Edited at: 30th Jan 2013 13:30

Link

Ravey, it would be nice of you to include the source code to your utility.

Not many are keen to run unknown executables on their development machines (despite having antivirus, etc).

Also, the EditPlus programmer's editor works as a great replacement for the AppGameKit Tier 1 CodeBlocks based editor.. (but not without some significant customization. After that -- it beats the default IDE hands down.)

Below is a screenshot of EP with the function-list open. (I just placed the editor and the function list side-by-side for the screenshot, and it's just showing example code from the SantasBadElf game.)

Cheers,
AgentSam

Attachments

Login to view attachments

Back to top

Profile PM

Ravey

Retired TGC Developer

22

Years of Service

User Offline

Joined: 2nd Nov 2002

Location: Southern TGC Nerve Centre

Posted: 30th Jan 2013 19:34

Link

Quote: "Ravey, it would be nice of you to include the source code to your utility. "

Sure thing

Dave Milton
TGC Team

Attachments

Login to view attachments

Back to top

Profile PM Email Website

BatVink

Moderator

21

Years of Service

User Offline

Joined: 4th Apr 2003

Location: Gods own County, UK

Posted: 31st Jan 2013 17:31

Link

Very useful, I tried to work out how to add function listing in CodeBlocks, but I couldn't find any information on this essential functionality.

Back to top

Profile PM Email

Markus

Valued Member

20

Years of Service

User Offline

Joined: 10th Apr 2004

Location: Germany

Posted: 31st Jan 2013 19:47 Edited at: 31st Jan 2013 20:04

Link

@Ravey
you inspired me to do this in AGK.
i don't have direct access to the directorys
and i use choosefile in a loop.

@All

rem
rem AGK Application 1.08B8
rem

// MR 31.01.2013.1
// 0815 FunctionList from .agc files

//Use AGK Strg+G for goto to a row number in a open file

fout=opentowrite("FunctionListAGK.txt",0) // > \media\FunctionListAGK.txt
writeline(fout,getcurrentdate()+" "+getcurrenttime())
writeline(fout,"Strg+G in the AGK IDE = Goto line ....")
writeline(fout,"")

do
    //this will copy the file to the app media path!
    file$=Chooserawfile("*.agc") // die Datei landet dann im Media Ordner bei C:\Users\User\Documents\AGK\FunctionList\media\ ^^
    if len(file$)=0 then exit
    SearchFunctions(file$,fout)
    deletefile(file$) // its a copy
loop

closefile(fout)

//open the default web browser
OpenBrowser("file:///"+GetwritePath()+"media/")

end

function SearchFunctions(file$,fout)

// Open the File and then read each line and look for a beginning "function ", then write to output text file as overview list

if right(file$,4)=".agc"

fc=opentoread(file$)
        writeline(fout,"-------------------------------------------")
        writeline(fout,file$)
        writeline(fout,"-------------------------------------------")

c=0
        do
            if fileeof(fc) then exit
            c=c+1
            l$=readline(fc)
            if lower(left(l$,9)) = "function "
                output$=str(c) +" "+ mid(l$,9,len(l$)-8)
                writeline(fout,output$)
            endif
        loop

closefile(fc)

else
        output$="skip file "+file$
        writeline(fout,output$)
    endif

endfunction

+ Code Snippet

rem
rem AGK Application 1.08B8
rem

// MR 31.01.2013.1
// 0815 FunctionList from .agc files

//Use AGK Strg+G for goto to a row number in a open file

fout=opentowrite("FunctionListAGK.txt",0) // > \media\FunctionListAGK.txt
writeline(fout,getcurrentdate()+" "+getcurrenttime())
writeline(fout,"Strg+G in the AGK IDE = Goto line ....")
writeline(fout,"")

do
    //this will copy the file to the app media path!
    file$=Chooserawfile("*.agc") // die Datei landet dann im Media Ordner bei C:\Users\User\Documents\AGK\FunctionList\media\ ^^
    if len(file$)=0 then exit
    SearchFunctions(file$,fout)
    deletefile(file$) // its a copy
loop

closefile(fout)

//open the default web browser
OpenBrowser("file:///"+GetwritePath()+"media/")

end

function SearchFunctions(file$,fout)

    // Open the File and then read each line and look for a beginning "function ", then write to output text file as overview list

    if right(file$,4)=".agc"

        fc=opentoread(file$)
        writeline(fout,"-------------------------------------------")
        writeline(fout,file$)
        writeline(fout,"-------------------------------------------")

        c=0
        do
            if fileeof(fc) then exit
            c=c+1
            l$=readline(fc)
            if lower(left(l$,9)) = "function "
                output$=str(c) +" "+ mid(l$,9,len(l$)-8)
                writeline(fout,output$)
            endif
        loop

        closefile(fc)

    else
        output$="skip file "+file$
        writeline(fout,output$)
    endif

endfunction

Back to top

Profile PM Email

Markus

Valued Member

20

Years of Service

User Offline

Joined: 10th Apr 2004

Location: Germany

Posted: 16th Feb 2013 10:22

Link

i read a little bit about codeblock and found
it have scripting

it have a start script here:
\AGK\IDE\Editor\share\CodeBlocks\scripts\startup.script

and they have a wiki about script
http://wiki.codeblocks.org/index.php?title=Scripting_commands

Back to top

Profile PM Email

Sorry your browser is not supported!

AppGameKit Classic Chat / Small but handy tool

Attachments

Attachments

Attachments