@ScriptName for #include files

[AndyS01]

I want to display the file name of the #include file in my _DebugOut() statements, but I always get the file name of the main script that includes it.  The @ScriptLineNumber macro gives me the line number in the #include file, but I don't see a way to display its file name.

Like this:

_Debugout("+++:" & @ScriptLineNumber & ": [" & @ScriptFullPath & "] bla bla bla ...")

 

[AutoBert]

Only directly possible:

_Debugout("+++:" & @ScriptLineNumber & ": [IncudedFileName] bla bla bla ...")

Using Search / Replace in Scite (Ctrl-h) does this job.

[water]

The suggested way is to use AU3stripper to save the source in expanded form so you can check the exact lin number where the script failed.
Has been described a few times here on the forum.

[AndyS01]

Quote

Only directly possible:

_Debugout("+++:" & @ScriptLineNumber & ": [IncudedFileName] bla bla bla ...")

Using Search / Replace in Scite (Ctrl-h) does this job.

Inserting the actual #include file filename is not what I want because these are library files and I move functions from one to another. Also, I sometimes rename the #include file.

Quote

The suggested way is to use AU3stripper to save the source in expanded form so you can check the exact lin number where the script failed.
Has been described a few times here on the forum.

I'm looking for the filename not the line number.  The @ScriptLineNumber macro returns the line number in the #include file, but the @ScriptFullPath returns the file name of the main script.

[water]

Can you please describe what you want to achieve? Why do you need the name of the include file?

[AndyS01]

Sure.  When I'm debugging a script that includes several #include files and these include several #include files, and in one of them, I call _debugOut() to display some value like $ret, I call it like this:

_Debugout("+++:" & @scriptLineNumber & ": $ret = " & $ret)

_Debugout("+++:" & @scriptLineNumber & ": $ret = " & $ret)

When I run the script, I see this in my debug output:

+++:123: $ret = 6

I don't know which library #include file this came from.

[water]

Can't you output the name of the UDF and/or the name of the called function in your _DebugOut statement?

[AndyS01]

How do I out the name of the called function?   I could use this elsewhere.

Although it world get me closer, this isn't what I need.  I could be several calls deep before I use the _DebugOut call.

[water]

You need to provide the function name as a string or a global variable to your _DebugOut statement.
Or do you need the stack off all called functions when you call _DebugOut?

[AndyS01]

The thing is, the compiler knows that @ScriptLineNumber refers to the current file, but @ScriptFullPath refers to the main file.  Perhaps there is a SCiTE way to do it.

[InunoTaishou]

I don't think I've seen anything for this and I can't find anything myself. I was looking at OOP.au3 the other day and you could do what the author did. When you use the UDF and make classes you're not really making classes and objects in autoit. When you run the script the OOP.au3 main function kicks in and goes through all of the included files. Looking for declarations and class functions, replacing them with autoit functions and variables (structs).

Basically, have your own #include for your own parsing script that goes through the working script and all of its includes. Replace all of the instances of whatever your keyword is (@ThisFile or whatever) with the name of your current file, remove your parser script, and then launch the @AutoItexe using the path to the new script.

Sounds like it would take a while to write something like that. But if you REALLY want the file name of the current file, this would be how to do it. Unless the devs of scite decide to add an @ThisFile lol.

Here's the udf though, if you want to take a look.

 

 

[AndyS01]

Interesting, but not what I need.  I think it's autoit3.exe that does the converting of @xxx macros.  This is not part of SciTE.  If I wanted to create a new @ThisFileName macro, how would I go about it?  Is this a thing that I have to go to the developers for?

 

[mLipok]

You should parse all your own UDF just before compile process.

_Debugout("+++:" & @scriptLineNumber & ": $ret = " & $ret)

for example to this form:

_Debugout("+++:UDFNAME:" & @scriptLineNumber & ": $ret = " & $ret)

 

Here is esample of how to do this in AutoIt :

StringRegExpReplace($sUDFContent,'(?i)_Debugout\("\+{3}(.*?)"','$1:' & $sUDFFileName & ':$3')

You should also look to this:
#AutoIt3Wrapper_Run_Before=

 

Edited March 21, 2016 by mLipok
typo

[AndyS01]

That's almost what I need.  However, the '#AutoIt3Wrapper_Run_Before=' directive is only used when compiling (F7), not when it's run (F5).  In another thread on this forum, I'm asking for help on a directive that is acted on when running (F5). here 

I'm almost there.

 

[mLipok]

But you do not understand.
This is unimportant how this directive is behave.

Just compile to change each UDF you want.
Then you will be have changed all UDF.

You can also run this StringRegExp... in any way, just when you want to run it.
So run it by hand just before you push F5.

If you change few things ie. add few new _DebugOut then you exactly know which kind of message you will expect in Debug window or file...
If you make many changes then just run StringRegExp... or compile.

Is't it easy ?

btw.
I work in this way from few years, and have solved many problems.

Edited March 21, 2016 by mLipok

[AndyS01]

The issue is that I don't want to run the string replacement on each UDF because I frequently move functions to other UDFs and I sometimes rename UDFs.  I guess that I could add a context menu item to run the StringRegExp on the current file, but the problem is that if I copy a number of functions from one UDF to another, the  StringRegExp will not pick up the old file name references.  I was looking for something that would temporarily make the string replacements, do the run/compile and restore the original script.  This gives me the ability to move things around.

[BrewManNH]

You don't need to play musical chairs with your functions to other files, just get the functions together in one or a few UDFs and just include them in your scripts, you don't need to run every function that's in a UDF when it's included.

[mLipok]

Just now, AndyS01 said:

but the problem is that if I copy a number of functions from one UDF to another, the  StringRegExp will not pick up the old file name references. 

Did you try before exactly what I sugest ?
Can you show what you make so far ?

If no why you are talking that this "will not pick up the old file name references" ?

Here is my example to show you what I mean:

#include <Debug.au3>
#include <FileConstants.au3>

_DebugOut("+++:UDFNAME1.au3:" & 'Description 1213')
_DebugOut("+++:UDFNAME2.au3:" & 'Description 1213')
_DebugOut("+++:UDFNAME3.au3:" & 'Description 1213')
_DebugOut("+++:UDFNAME4.au3:" & 'Description 1213')

_Example(@ScriptFullPath, @ScriptName)

Func _Example($sUDF_FileFullPath, $sUDFFileName)
    Local $sUDFContent = FileRead($sUDF_FileFullPath)
    $sUDFContent = StringRegExpReplace($sUDFContent, '(?i)(_Debugout\("\+{3})(.*?)(")', '$1:' & $sUDFFileName & ':$3')

    Local $hUDF_File = FileOpen($sUDF_FileFullPath, $FO_OVERWRITE)
    FileWrite($hUDF_File, $sUDFContent)
    FileClose($hUDF_File)

EndFunc   ;==>_Example