AndyS01

@ScriptName for #include files

18 posts in this topic

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 ...")

 

Share this post


Link to post
Share on other sites



Only directly possible:

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

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

Share this post


Link to post
Share on other sites

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.


My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2017-04-18 - Version 1.4.8.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX (NEW 2017-02-27 - Version 1.3.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2015-04-01 - Version 0.4.0.0) - Download - General Help & Support - Example Scripts
Excel - Example Scripts - Wiki
Word - Wiki
PowerPoint (2015-06-06 - Version 0.0.5.0) - Download - General Help & Support

Tutorials:
ADO - Wiki

 

Share this post


Link to post
Share on other sites
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.

Share this post


Link to post
Share on other sites

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


My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2017-04-18 - Version 1.4.8.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX (NEW 2017-02-27 - Version 1.3.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2015-04-01 - Version 0.4.0.0) - Download - General Help & Support - Example Scripts
Excel - Example Scripts - Wiki
Word - Wiki
PowerPoint (2015-06-06 - Version 0.0.5.0) - Download - General Help & Support

Tutorials:
ADO - Wiki

 

Share this post


Link to post
Share on other sites

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.

Share this post


Link to post
Share on other sites

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


My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2017-04-18 - Version 1.4.8.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX (NEW 2017-02-27 - Version 1.3.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2015-04-01 - Version 0.4.0.0) - Download - General Help & Support - Example Scripts
Excel - Example Scripts - Wiki
Word - Wiki
PowerPoint (2015-06-06 - Version 0.0.5.0) - Download - General Help & Support

Tutorials:
ADO - Wiki

 

Share this post


Link to post
Share on other sites

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.

Share this post


Link to post
Share on other sites

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?


My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2017-04-18 - Version 1.4.8.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX (NEW 2017-02-27 - Version 1.3.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2015-04-01 - Version 0.4.0.0) - Download - General Help & Support - Example Scripts
Excel - Example Scripts - Wiki
Word - Wiki
PowerPoint (2015-06-06 - Version 0.0.5.0) - Download - General Help & Support

Tutorials:
ADO - Wiki

 

Share this post


Link to post
Share on other sites

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.

Share this post


Link to post
Share on other sites

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.

 

 

Share this post


Link to post
Share on other sites

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?

 

Share this post


Link to post
Share on other sites

#13 ·  Posted (edited)

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 by mLipok
typo

Signature beginning:   Wondering who uses AutoIT and what it can be used for ?
* GHAPI UDF - modest begining - comunication with GitHub REST API *
ADO.au3 UDF     POP3.au3 UDF     XML.au3 UDF    How to use IE.au3  UDF with  AutoIt v3.3.14.x  for other useful stuff click the following button

Spoiler

Any of my own code posted anywhere on the forum is available for use by others without any restriction of any kind. 

My contribution (my own projects): * Debenu Quick PDF Library - UDF * Debenu PDF Viewer SDK - UDF * Acrobat Reader - ActiveX Viewer * UDF for PDFCreator v1.x.x * XZip - UDF * AppCompatFlags UDF * CrowdinAPI UDF * _WinMergeCompare2Files() * _JavaExceptionAdd() * _IsBeta() * Writing DPI Awareness App - workaround * _AutoIt_RequiredVersion() * Chilkatsoft.au3 UDF * TeamViewer.au3 UDF * JavaManagement UDF * VIES over SOAP * WinSCP UDF * GHAPI UDF - modest begining - comunication with GitHub REST API *

My contribution to others projects or UDF based on  others projects: * _sql.au3 UDF  * POP3.au3 UDF *  RTF Printer - UDF * XML.au3 - BETA * ADO.au3 UDF SMTP Mailer UDF *

Useful links: * Forum Rules * Forum etiquette *  Forum Information and FAQs * How to post code on the forum * AutoIt Online Documentation * AutoIt Online Beta Documentation * SciTE4AutoIt3 getting started * Convert text blocks to AutoIt code * Games made in Autoit * Programming related sites * Polish AutoIt Tutorial * DllCall Code Generator * 

Wiki: Expand your knowledge - AutoIt Wiki * Collection of User Defined Functions * How to use HelpFile * Best coding practices * 

IE Related:  * How to use IE.au3  UDF with  AutoIt v3.3.14.x * Why isn't Autoit able to click a Javascript Dialog? * Clicking javascript button with no ID * IE document >> save as MHT file * IETab Switcher (by LarsJ ) * HTML Entities * _IEquerySelectorAll() (by uncommon) * 

I encourage you to read: * Global Vars * Best Coding Practices * Please explain code used in Help file for several File functions * OOP-like approach in AutoIt * UDF-Spec Questions *  EXAMPLE: How To Catch ConsoleWrite() output to a file or to CMD *

"Homo sum; humani nil a me alienum puto" - Publius Terentius Afer
"Program are meant to be read by humans and only incidentally for computers and execute" - Donald Knuth, "The Art of Computer Programming"
:naughty:  :ranting:, be  :) and       \\//_.

Anticipating Errors :  "Any program that accepts data from a user must include code to validate that data before sending it to the data store. You cannot rely on the data store, ...., or even your programming language to notify you of problems. You must check every byte entered by your users, making sure that data is the correct type for its field and that required fields are not empty."

Signature last update: 2017-06-04

Share this post


Link to post
Share on other sites

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.

 

Share this post


Link to post
Share on other sites

#15 ·  Posted (edited)

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 by mLipok

Signature beginning:   Wondering who uses AutoIT and what it can be used for ?
* GHAPI UDF - modest begining - comunication with GitHub REST API *
ADO.au3 UDF     POP3.au3 UDF     XML.au3 UDF    How to use IE.au3  UDF with  AutoIt v3.3.14.x  for other useful stuff click the following button

Spoiler

Any of my own code posted anywhere on the forum is available for use by others without any restriction of any kind. 

My contribution (my own projects): * Debenu Quick PDF Library - UDF * Debenu PDF Viewer SDK - UDF * Acrobat Reader - ActiveX Viewer * UDF for PDFCreator v1.x.x * XZip - UDF * AppCompatFlags UDF * CrowdinAPI UDF * _WinMergeCompare2Files() * _JavaExceptionAdd() * _IsBeta() * Writing DPI Awareness App - workaround * _AutoIt_RequiredVersion() * Chilkatsoft.au3 UDF * TeamViewer.au3 UDF * JavaManagement UDF * VIES over SOAP * WinSCP UDF * GHAPI UDF - modest begining - comunication with GitHub REST API *

My contribution to others projects or UDF based on  others projects: * _sql.au3 UDF  * POP3.au3 UDF *  RTF Printer - UDF * XML.au3 - BETA * ADO.au3 UDF SMTP Mailer UDF *

Useful links: * Forum Rules * Forum etiquette *  Forum Information and FAQs * How to post code on the forum * AutoIt Online Documentation * AutoIt Online Beta Documentation * SciTE4AutoIt3 getting started * Convert text blocks to AutoIt code * Games made in Autoit * Programming related sites * Polish AutoIt Tutorial * DllCall Code Generator * 

Wiki: Expand your knowledge - AutoIt Wiki * Collection of User Defined Functions * How to use HelpFile * Best coding practices * 

IE Related:  * How to use IE.au3  UDF with  AutoIt v3.3.14.x * Why isn't Autoit able to click a Javascript Dialog? * Clicking javascript button with no ID * IE document >> save as MHT file * IETab Switcher (by LarsJ ) * HTML Entities * _IEquerySelectorAll() (by uncommon) * 

I encourage you to read: * Global Vars * Best Coding Practices * Please explain code used in Help file for several File functions * OOP-like approach in AutoIt * UDF-Spec Questions *  EXAMPLE: How To Catch ConsoleWrite() output to a file or to CMD *

"Homo sum; humani nil a me alienum puto" - Publius Terentius Afer
"Program are meant to be read by humans and only incidentally for computers and execute" - Donald Knuth, "The Art of Computer Programming"
:naughty:  :ranting:, be  :) and       \\//_.

Anticipating Errors :  "Any program that accepts data from a user must include code to validate that data before sending it to the data store. You cannot rely on the data store, ...., or even your programming language to notify you of problems. You must check every byte entered by your users, making sure that data is the correct type for its field and that required fields are not empty."

Signature last update: 2017-06-04

Share this post


Link to post
Share on other sites

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.

Share this post


Link to post
Share on other sites

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.


If I posted any code, assume that code was written using the latest release version unless stated otherwise. Also, if it doesn't work on XP I can't help with that because I don't have access to XP, and I'm not going to.
Give a programmer the correct code and he can do his work for a day. Teach a programmer to debug and he can do his work for a lifetime - by Chirag Gude
How to ask questions the smart way!

I hereby grant any person the right to use any code I post, that I am the original author of, on the autoitscript.com forums, unless I've specifically stated otherwise in the code or the thread post. If you do use my code all I ask, as a courtesy, is to make note of where you got it from.

Back up and restore Windows user files _Array.au3 - Modified array functions that include support for 2D arrays.  -  ColorChooser - An add-on for SciTE that pops up a color dialog so you can select and paste a color code into a script.  -  Customizable Splashscreen GUI w/Progress Bar - Create a custom "splash screen" GUI with a progress bar and custom label.  -  _FileGetProperty - Retrieve the properties of a file  -  SciTE Toolbar - A toolbar demo for use with the SciTE editor  -  GUIRegisterMsg demo - Demo script to show how to use the Windows messages to interact with controls and your GUI.  -   Latin Square password generator

Share this post


Link to post
Share on other sites
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

 


Signature beginning:   Wondering who uses AutoIT and what it can be used for ?
* GHAPI UDF - modest begining - comunication with GitHub REST API *
ADO.au3 UDF     POP3.au3 UDF     XML.au3 UDF    How to use IE.au3  UDF with  AutoIt v3.3.14.x  for other useful stuff click the following button

Spoiler

Any of my own code posted anywhere on the forum is available for use by others without any restriction of any kind. 

My contribution (my own projects): * Debenu Quick PDF Library - UDF * Debenu PDF Viewer SDK - UDF * Acrobat Reader - ActiveX Viewer * UDF for PDFCreator v1.x.x * XZip - UDF * AppCompatFlags UDF * CrowdinAPI UDF * _WinMergeCompare2Files() * _JavaExceptionAdd() * _IsBeta() * Writing DPI Awareness App - workaround * _AutoIt_RequiredVersion() * Chilkatsoft.au3 UDF * TeamViewer.au3 UDF * JavaManagement UDF * VIES over SOAP * WinSCP UDF * GHAPI UDF - modest begining - comunication with GitHub REST API *

My contribution to others projects or UDF based on  others projects: * _sql.au3 UDF  * POP3.au3 UDF *  RTF Printer - UDF * XML.au3 - BETA * ADO.au3 UDF SMTP Mailer UDF *

Useful links: * Forum Rules * Forum etiquette *  Forum Information and FAQs * How to post code on the forum * AutoIt Online Documentation * AutoIt Online Beta Documentation * SciTE4AutoIt3 getting started * Convert text blocks to AutoIt code * Games made in Autoit * Programming related sites * Polish AutoIt Tutorial * DllCall Code Generator * 

Wiki: Expand your knowledge - AutoIt Wiki * Collection of User Defined Functions * How to use HelpFile * Best coding practices * 

IE Related:  * How to use IE.au3  UDF with  AutoIt v3.3.14.x * Why isn't Autoit able to click a Javascript Dialog? * Clicking javascript button with no ID * IE document >> save as MHT file * IETab Switcher (by LarsJ ) * HTML Entities * _IEquerySelectorAll() (by uncommon) * 

I encourage you to read: * Global Vars * Best Coding Practices * Please explain code used in Help file for several File functions * OOP-like approach in AutoIt * UDF-Spec Questions *  EXAMPLE: How To Catch ConsoleWrite() output to a file or to CMD *

"Homo sum; humani nil a me alienum puto" - Publius Terentius Afer
"Program are meant to be read by humans and only incidentally for computers and execute" - Donald Knuth, "The Art of Computer Programming"
:naughty:  :ranting:, be  :) and       \\//_.

Anticipating Errors :  "Any program that accepts data from a user must include code to validate that data before sending it to the data store. You cannot rely on the data store, ...., or even your programming language to notify you of problems. You must check every byte entered by your users, making sure that data is the correct type for its field and that required fields are not empty."

Signature last update: 2017-06-04

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!


Register a new account

Sign in

Already have an account? Sign in here.


Sign In Now

  • Similar Content

    • Jibberish
      By Jibberish
      I am writing several log files with results from my script. The @ScriptName is writing an old script name.
      I uninstalled AutoIt and SCITE and deleted the AutoIt directory, reinstalled everything and reran my script. Same issue.
      I had started out with (for example) "MyScript.au3". Added Debugging and renamed the script "MyScript_Debug.au3". Finished debugging my script and renamed it back to "MyScript.au3". However my @ScriptName is being displayed and written as "MyScript_Debug.au3".
      Where is this saved so I can remove it and get the correct Script Name?
      Thanks
      Jibberish