Good coding practices in AutoIt

[czardas]

There are definately scenarios where using Default is more convenient, including internal functions. It has a small, but noticeable, overhead.

Edited April 22, 2013 by czardas

[czardas]

This is kind of related to the above and I was wondering what your thoughts are on this method. The following function needs to run twice (for whatever reason). It is necessary to test if the function has been called previously. Only one parameter is passed to the function originally. The second parameter is only needed the second time the function is called, and is handled internally by the function itself.

Func _Recursion($vData, $bRecursion = False)
    If Not $bRecursion Then _Recursion($vData, True)
    Return $vData
EndFunc

The code could easily be modified to prevent the user passing more than one parameter, however the syntax is nice and neat as it is. Like many functions, if you ignore the documentation (in this case passing the wrong number of parameters), the function will not perform as expected. Is it always necessary to add extra lines of code in case someone doesn't read or understand the documentation?

Edit - modified example

Edited April 22, 2013 by czardas

[Bowmore]

A better way to control the recursion level might be to use a local static variable.

Func _Recursion($vData)
    Local Static $iRecursionLevel = 1
    
    If $iRecursionLevel > 1 Then
        Return $vData
    Else
        $iRecursionLevel += 1
        _Recursion($vData)
    EndIf
EndFunc

[czardas]

I have to stop writing pseudo code examples without testing them. Bowmore, your approach only allows the function to work one time. Subsequent calls fail. Here's the alternative I was thinking of. It is more secure, but requires a whole new function (plus additional documentation). I just wonder - where does one draw the line? Isn't this just bloat code? I think this is a worthwhile question for debate.

ConsoleWrite(_CallRecursion(1) & @LF)
ConsoleWrite(_CallRecursion(2) & @LF)
ConsoleWrite(_CallRecursion(3) & @LF)

Func _CallRecursion($vData) ; UDF function
    Return _Recursion($vData)
EndFunc

Func _Recursion($vData, $bRecursion = False) ; Internal function
    If Not $bRecursion Then _Recursion($vData, True)
    Return $vData
EndFunc

Edit : On reflection it's probably better to do this for a UDF function, but I don't see it being necessary for an internal function. Comments have been added to the code above.

Edited April 22, 2013 by czardas

[guinness]

$b... in AutoIt Hungarian-like naming is binary. I think you meant $f.

Yeh, I don't get it either?!

Edited April 22, 2013 by guinness

[czardas]

$b... in AutoIt Hungarian-like naming is binary. I think you meant $f.

I take my info from wiki. UDF Spec ... $b = boolean and $f = float

Yeh, I don't get it either?!

For an example take a look at my function (it's the second example). I have decided to call this function using a second function to stop the user inputting more than one parameter. Edited April 22, 2013 by czardas

[guinness]

I meant I don't get why $f is boolean as it should be Float.

This is the link I was talking about. Mat's Wiki is currently unofficial. http://www.autoitscript.com/autoit3/udfs/UDF_Standards.htm

[czardas]

Hmm, yeah that's confusing. I thought it had changed at one point and started to adopt Mat's recommendations which, incidentally, came highly recommended by others. It would be annoying to have to revert back to the old method: it took me long enough to get used to the new one. It looks like the link you posted is rather old and doesn't reflect some of the changes made since it was written.

Edited April 22, 2013 by czardas

[Bowmore]

Modified version of my function in #243 above so that it resets after the recursion is exited

Func _Recursion($vData)
Local Static $iRecursionLevel = 1

   If $iRecursionLevel > 1 Then
        $iRecursionLevel = 1
        Return $vData
    Else
        $iRecursionLevel += 1
         _Recursion($vData)
    EndIf
EndFunc

[FireFox]

$bl is just fine for booleans.

[Trong]

♥

[jaberwacky]

♥

A black heart magician of the night.

Cast bones to gain paranormal sight.

When wisdom dromes

but is not condoned.

Dealt is a card of fright.

Tell us why you invoke these senseless emoticons.

Edited April 25, 2013 by jaberwocky6669

[FireFox]

Thank you both for your contribution.

[Mat]

The only real change I made was making binary data $d, I was going to make some decision on the boolean/float issue, but never got round to it. In my opinion, it should be:

$d - Binary *Data*

$f - Boolean (*F*lag)

$n - *N*umber aka. floats (we don't need 3 prefixes for different number types, a float is a superset (in a mathematical sense) of the integers, so number and float should be interchangeable)

In recent times I've stopped using that system religiously, using some other things like having control type prefixes ($btnOk, $inpName, $calBirthday, $ipServer) and for structs ($rcArea = DllStructCreate($tagRECT)). Usage prefix is always preferred to type prefix, that's why we use $tag rather than $s.

The prefix system has always been on the edge of the standard. It's more a recommendation to use some sort of system that other people would recognize when naming variables.

Edit: I knew I'd already said this somewhere. In the notes page for udf spec:

Variable naming is still a matter of personal style. As long as it's readable and makes sense then it is acceptable. That part remains a guideline as opposed to a standard.

Edited April 28, 2013 by Mat

[czardas]

Your suggested system is very good. Take variable names like $idID, mostly a digit and mostly an integer, It's almost begging to be used. I'm not keen on the idea of abandoning systematic reasoning for the sake of general consensus. I have been using your recommendations for some time already and I think they are clear and logical. The only thing missing is $kConst. ^^

Edited April 28, 2013 by czardas

[guinness]

An example of using multiple flags within a function:

#include <Constants.au3>

Example()

Func Example()
    Local Const $IF_FLAG_ONE = 1, $IF_FLAG_TWO = 2, $IF_FLAG_THREE = 4 ; The values ideally should be: 1, 2, 4, 8, 16, 32, 64, 128 etc...

    ; An example of using flags (like in MsgBox) when using multiple parameters.
    Local $iFlag = $IF_FLAG_ONE + $IF_FLAG_THREE ; BitOR($IF_FLAG_ONE, $IF_FLAG_THREE) is preferred.

    If BitAND($iFlag, $IF_FLAG_ONE) = $IF_FLAG_ONE Then MsgBox($MB_SYSTEMMODAL, '', '$IF_FLAG_ONE was called.')
    If BitAND($iFlag, $IF_FLAG_TWO) = $IF_FLAG_TWO Then MsgBox($MB_SYSTEMMODAL, '', '$IF_FLAG_TWO was called.')
    If BitAND($iFlag, $IF_FLAG_THREE) = $IF_FLAG_THREE Then MsgBox($MB_SYSTEMMODAL, '', '$IF_FLAG_THREE was called.')
EndFunc   ;==>Example

[water]

Guinness,

how about a new tutorial in the wiki named "Best coding practices in AutoIt"?

That's the place where I would look for that kind of information. The forum would only be my 2nd place.

[guinness]

Right now I don't have the time, plus half the stuff I'm writing here I dunno if it's correct or not. It's what I've found on my travels and am really looking for confirmation from those that do know.

Edited June 2, 2013 by guinness

[BrewManNH]

A better way to write that example would be to use the Enum function, then you only have to assign the first value, less typing for the same result.

 
#include <Constants.au3>
 
Example()
 
Func Example()
    Local Enum Step *2 $IF_FLAG_ONE = 1, $IF_FLAG_TWO, $IF_FLAG_THREE ; The values ideally should be: 1, 2, 4, 8, 16, 32, 64, 128 etc...
    ; An example of using flags (like in MsgBox) when using multiple parameters.
    Local $iFlag = $IF_FLAG_ONE + $IF_FLAG_THREE ; BitOR($IF_FLAG_ONE, $IF_FLAG_THREE) is preferred.
 
    If BitAND($iFlag, $IF_FLAG_ONE) = $IF_FLAG_ONE Then MsgBox($MB_SYSTEMMODAL, '', '$IF_FLAG_ONE was called.')
    If BitAND($iFlag, $IF_FLAG_TWO) = $IF_FLAG_TWO Then MsgBox($MB_SYSTEMMODAL, '', '$IF_FLAG_TWO was called.')
    If BitAND($iFlag, $IF_FLAG_THREE) = $IF_FLAG_THREE Then MsgBox($MB_SYSTEMMODAL, '', '$IF_FLAG_THREE was called.')
EndFunc   ;==>Example

[guinness]

Good point, also remove the = 1 and you will see it produces the same result BrewManNH.