ChrisMax

Variable to get function name

10 posts in this topic

Hello all,

I'm in the process of creating a small project for my company. So I've gone through most of the code so far and am quite happy with the result.

Before I show you the code in question, let me tell you, .... am no dev what so ever :):>

Well, that said, the code I'm sending is a logger, that I made for my needs. Out of all the functions in it, there are two that I use all the time 'Logger' and 'Error'. Those two will write OK message and KO messages respectively to the proper files.

Now let's focus on: 

Func Error($sError)
      Local $eTimeStamp = @MON & "-" & @MDAY & "-" & @YEAR & " -- " & @HOUR & ":" & @MIN & ":" & @SEC & "." & @MSEC & " - " & @ScriptName & " - "
      Filewrite($LogError, $eTimeStamp & $sError & @crlf)
EndFunc

The issue I have with this is the "@ScriptName" variable used here which throws the name of my MAIN.au3. What I would like to be able to do, is to log the name of the Function that hanged to make troubleshoot easier. 

This is the way I'm coding this : 

  • Main.au3 - Calls 
    • Install.au3
      • Logger.au3
    • Uninstall
      • Logger.au3

Taking the example above, is there any variable that would write "Install.au3" instead of "Main.au3" or do I have to use a second argument to Error() ?

Thanks for taking the time to read this (if you reached this far ;))

Chris

Share this post


Link to post
Share on other sites



ChrisMax,

I would add a Global variable to the Main script and then set it to the name of each function as the code enters - you can then use that variable in place of @‌ScriptName.

M23


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

Spoiler

ArrayMultiColSort ---- Sort arrays on multiple columns
ChooseFileFolder ---- Single and multiple selections from specified path treeview listing
Date_Time_Convert -- Easily convert date/time formats, including the language used
ExtMsgBox --------- A highly customisable replacement for MsgBox
GUIExtender -------- Extend and retract multiple sections within a GUI
GUIFrame ---------- Subdivide GUIs into many adjustable frames
GUIListViewEx ------- Insert, delete, move, drag, sort, edit and colour ListView items
GUITreeViewEx ------ Check/clear parent and child checkboxes in a TreeView
Marquee ----------- Scrolling tickertape GUIs
NoFocusLines ------- Remove the dotted focus lines from buttons, sliders, radios and checkboxes
Notify ------------- Small notifications on the edge of the display
Scrollbars ----------Automatically sized scrollbars with a single command
StringSize ---------- Automatically size controls to fit text
Toast -------------- Small GUIs which pop out of the notification area

 

Share this post


Link to post
Share on other sites

Yeah ... that's a way I did not think about. Thanks will check how it looks like. Appreciate the tip

Share this post


Link to post
Share on other sites

In practice you'll need to use a LIFO container (= a stack) to cope with nested function calls. You also may want to avoid storing multiple entries when inside a primary recursive call, storing just an invokation counter along with the function name. Non-primary recursion is a bit harder to deal with, however.


This wonderful site allows debugging and testing regular expressions (many flavors available). An absolute must have in your bookmarks.
Another excellent RegExp tutorial. Don't forget downloading your copy of up-to-date pcretest.exe and pcregrep.exe here
RegExp tutorial: enough to get started
PCRE v8.33 regexp documentation latest available release and currently implemented in AutoIt beta.

SQLitespeed is another feature-rich premier SQLite manager (includes import/export). Well worth a try.
SQLite Expert (freeware Personal Edition or payware Pro version) is a very useful SQLite database manager.
An excellent eBook covering almost every aspect of SQLite3: a must-read for anyone doing serious work.
SQL tutorial (covers "generic" SQL, but most of it applies to SQLite as well)
A work-in-progress SQLite3 tutorial. Don't miss other LxyzTHW pages!
SQLite official website with full documentation (may be newer than the SQLite library that comes standard with AutoIt)

Share this post


Link to post
Share on other sites

#5 ·  Posted (edited)

I like to declare a variable within a function with the name (always make it local, but for ease, always the same named variable), and then I always pass it to a logging function to output it in the logs with the message and a date/time stamp.  I also like having a global counter to do indents, so I can visually see in the log what function called which function.

Simple example:

#include <Date.au3>
Global $giSubFunction = 0
Local $sFuncName = @ScriptName

Logging("Starting script")
a()
Logging("EndIng script")



Func a ()
    $giSubFunction +=1
    Local $sFuncName = "a"
    Logging("Starting Func a",$sFuncName)

    b()

    Logging("Ending Func a",$sFuncName)
    $giSubFunction -=1
EndFunc



Func b ()
    $giSubFunction +=1
    Local $sFuncName = "b"
    Logging("Starting Func b",$sFuncName)
    Logging("Ending Func b",$sFuncName)
    $giSubFunction -=1
EndFunc



Func Logging($sCallersLog,$sCallersFuncName=$sFuncName)
    $sNow = _Now()
    ConsoleWrite(StringFormat("%-" & $giSubFunction + StringLen($sNow) + 1 & "s", $sNow) & $sCallersFuncName & ": " & $sCallersLog & @CRLF)
EndFunc

 

output:

11/6/2015 5:42:48 PM test.au3: Starting script
11/6/2015 5:42:48 PM  a: Starting Func a
11/6/2015 5:42:48 PM   b: Starting Func b
11/6/2015 5:42:48 PM   b: Ending Func b
11/6/2015 5:42:48 PM  a: Ending Func a
11/6/2015 5:42:48 PM test.au3: EndIng script

 

Edited by jdelaney

IEbyXPATH-Grab IE DOM objects by XPATH IEscriptRecord-Makings of an IE script recorder ExcelFromXML-Create Excel docs without excel installed GetAllWindowControls-Output all control data on a given window.

Share this post


Link to post
Share on other sites

#6 ·  Posted (edited)

@jdelaney Good idea

here is my variation:

#include <Date.au3>

LoggingStart("Starting Script")
Main()
LoggingEnd("Ending Script")

Func Main()
    LoggingStart(Main)
    Step2()
    LoggingEnd(Main)
EndFunc   ;==>Main

Func Step2()
    LoggingStart(Step2)
    InternalOrInner()
    LoggingEnd(Step2)
EndFunc   ;==>Step2

Func InternalOrInner()
    LoggingStart(InternalOrInner)
    MsgBox(0, 'Test', @ScriptLineNumber)
    LoggingEnd(InternalOrInner)
EndFunc   ;==>InternalOrInner

#Region Logging Functions
Func LoggingStart($sCallersFuncName)
    __Logging('Starting', $sCallersFuncName, +1)
EndFunc   ;==>LoggingStart

Func LoggingEnd($sCallersFuncName)
    __Logging('Ending', $sCallersFuncName, -1)
EndFunc   ;==>LoggingEnd

Func __Logging($sCallersLog, $sCallersFuncName, $iIndentation)
    Local Static $iIndent_static = 0
    If $iIndentation = +1 Then $iIndent_static += $iIndentation

    If IsFunc($sCallersFuncName) Then $sCallersFuncName = FuncName($sCallersFuncName)
    $sNow = _Now()
    ConsoleWrite(StringFormat("%-" & $iIndent_static + StringLen($sNow) + 1 & "s", $sNow) & $sCallersLog & ' > ' & $sCallersFuncName & " < " & @CRLF)
    If $iIndentation = -1 Then $iIndent_static += $iIndentation
EndFunc   ;==>__Logging
#EndRegion Logging Functions

 

Edited by mLipok
Func __Logging( ..... should be internal
1 person likes this

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

#7 ·  Posted (edited)

Good additions with the functions.  Makes things much easier to modify, and cleaner.  FuncName is a new one to me, but I'm stuck in a legacy version of autoit :)

Edited by jdelaney

IEbyXPATH-Grab IE DOM objects by XPATH IEscriptRecord-Makings of an IE script recorder ExcelFromXML-Create Excel docs without excel installed GetAllWindowControls-Output all control data on a given window.

Share this post


Link to post
Share on other sites

#8 ·  Posted (edited)

Oh joy.
I just now realize that my own logging function (which I use in my daily work), also should be modified.
It should'nt be for me so difficult, ...... as I have only to modify my own script parser .

 

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

#9 ·  Posted (edited)

You said "function" but the example was "file"

Taking the example above, is there any variable that would write "Install.au3" instead of "Main.au3"

If that is the case, you just need to use @ScriptFullPath

 

Nm all that,  the scope problem that fixed for me does not seem to be the same for your intent as you , can the function examples provided be modified to do the file thing in the OP?

dammit, now im going to be up trying to make the functions in my includes log their full path everytime they fire, and make sure that i scope my stuff in the future to accomodate being logged as such.

Edited by boththose

,-. .--. ________ .-. .-. ,---. ,-. .-. .-. .-.
|(| / /\ \ |\ /| |__ __||| | | || .-' | |/ / \ \_/ )/
(_) / /__\ \ |(\ / | )| | | `-' | | `-. | | / __ \ (_)
| | | __ | (_)\/ | (_) | | .-. | | .-' | | \ |__| ) (
| | | | |)| | \ / | | | | | |)| | `--. | |) \ | |
`-' |_| (_) | |\/| | `-' /( (_)/( __.' |((_)-' /(_|
'-' '-' (__) (__) (_) (__)

Share this post


Link to post
Share on other sites

Hello All,

Sorry I did not get back to you earlier on this. In then end I did something of the sort as well.

Thank you all for the help :)

Chris

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