Report Help File Issues Here

[czardas]

Here goes nothing:

The BitShift function seems under-documented. The bounds for shift values should be indicated (they appear to be -99999 to 99999 Hmm??? maybe not - I just don't know). I also think that it should be stated that this is an arithmetic shift, as opposed to a logical shift which is the most intuitive however false assumption which anyone might make.

Edited August 14, 2012 by czardas

[jvanegmond]

Here goes nothing:

The BitShift function seems under-documented. The bounds for shift values should be indicated (they appear to be -99999 to 99999 Hmm??? maybe not). I also think that it should be stated that this is an arithmetic shift, as opposed to a logical shift which is the most intuitive however false assumption which anyone might make.

Examples!

Bit operations are performed as 32-bit integers.

$b = BitShift(1, -31)

ConsoleWrite($b & @CRLF)

What's wrong?

[czardas]

If the shift limits are +/- 31 then it should be stated. Otherwise I'm just confused about it. If it was logical shift then I understand that there should be no limit to the shift value.

ConsoleWrite("Test 1"   & @LF)
For $i = 1 To 63
    ConsoleWrite(BitShift(1, $i) & @LF & _
    BitShift(1, -$i)  & @LF  & @LF)
Next


ConsoleWrite("Test 2"   & @LF)
For $i = 99999 To 100005
    ConsoleWrite(BitShift(-4, $i) & @LF & _
    BitShift(1, -$i)  & @LF  & @LF)
Next

Edited August 14, 2012 by czardas

[jvanegmond]

If the shift limits are +/- 31 then it should be stated. Otherwise I'm just confused about it. If it was logical shift then I understand that there should be no limit to the shift value.

ConsoleWrite("Test 1" & @LF)
For $i = 1 To 63
ConsoleWrite(BitShift(1, $i) & @LF & _
BitShift(1, -$i) & @LF & @LF)
Next


ConsoleWrite("Test 2" & @LF)
For $i = 99999 To 100005
ConsoleWrite(BitShift(-4, $i) & @LF & _
BitShift(1, -$i) & @LF & @LF)
Next

It's a 32 bit number. If you shift by 32, you end up where you begun. If you shift by more, you end up wherever you'd get when you shift by Mod(your_number, 32). It wraps in the 32 bits.

[czardas]

So it appears. I think I just got a bit confused about this since there was no mention of the type of shift. From the perspective of a non-programmer, the word shift and wrap are in no way related to each other. Perhaps types of algorithms used in such functions should be stated so users like me can search these terms on google instead of having to ask.

Thanks for another easy to understand explanation.

Edit

Another thing I noticed is that floats seem to be rounded down when passed to (at least some) bitwise functions, and non numeric values appear to be ignored with BitAND, BitOR and BitXOR. Probably nothing to be concerned about, although this also doesn't appear to be documented.

Edited August 14, 2012 by czardas

[Valik]

It's not an algorithm. The bits just move left or right. When one bit drops off one end it appears on the other end.

[czardas]

I understand it now that I have read this article. The other bitwise functions seem easier to understand. Thanks to all.

[guinness]

The example script for the function IniRenameSection is missing a backslash before the file name.

Local $res = IniRenameSection(@ScriptDir & "My.ini", "MySection", "MyNewSection") ; there should be a backslash before the My.ini, ("My.ini")

These functions were rewritten and appear in the latest beta. Thanks for reporting.

[AZJIO]

guinness

Look running.htm, GUIStyles.htm

If ... Then (tutorials, Ru)

Edited August 15, 2012 by AZJIO

[Melba23]

Hi,

The Help file example for StringStripCR is not very helpful as the final result does not really show what has happened. Something like this might be better:

Local $sString = "I am" & Chr(13) & " a string"
MsgBox(4096, "Original string", $sString)
$sStripped_String = StringStripCR($sString)
MsgBox(4096, "String stripped of CR characters", $sStripped_String)

M23

[AZJIO]

Local $sString = "I am" & @CR & " a string"

StringRegExpReplace (compact example)

$sInput = "This example demonstrates a basic replacement.  It replaces the vowels aeiou"
$sOutput = StringRegExpReplace($sInput, "[aeiou]", "-")
MsgBox(0, "Result before and after", $sInput & @LF & $sOutput)

; The following example demonstrates using back-references to change the date
$sInput = 'Date: 12/31/2009 01:02:03'
$sOutput = StringRegExpReplace($sInput, '(d{2})/(d{2})/(d{4})', ' $2.$1.$3 ')
MsgBox(0, "Result before and after", $sInput & @LF & $sOutput)

$sInput = 'Removes the <i>tags</i> in html'
$sOutput = StringRegExpReplace($sInput, '<i>(.*?)</i>', '1')
MsgBox(0, "Result before and after", $sInput & @LF & $sOutput)

$sInput = 'Remove' & @LF & @LF & @LF & 'unnecessary blank lines'
$sOutput = StringRegExpReplace($sInput, '(rn|r|n){2,}', '1')
MsgBox(0, "Result before and after", $sInput & @LF & '--------------' & @LF & $sOutput)

; Splits into groups of three characters
$sInput = '56868797689645'
$sOutput = StringRegExpReplace($sInput, '(Ad{1,3}(?=(d{3})+z)|d{3}(?=d))', '1 ')
MsgBox(0, "Result before and after", $sInput & @LF & $sOutput)

; Gets the file name without extension
$sInput = 'D:DocumFile.au3'
$sOutput = StringRegExpReplace($sInput, '^(?:.*)([^]*?)(?:.[^.]+)?$', '1')
MsgBox(0, "Result before and after", $sInput & @LF & $sOutput)

StringStripWS

$sText = _
    '   The beginning    and   end of the string in this   context    ' & @CRLF & _
    '   means       all the ' & @TAB & 'text,   ' & @CRLF & _
    @TAB & '  not for each line   of the multiline    text.   ' & @TAB & @TAB

MsgBox(0, 'Original string', $sText)
For $i = 1 To 8
    MsgBox(0, 'flag = ' & $i, StringStripWS($sText, $i))
Next

Edited August 17, 2012 by AZJIO

[mLipok]

I have an idea

Do helpfile can contain information about abbreviations

for example help documentation for

If...ElseIf...Else...EndIf

now contain

If...ElseIf...Else...EndIf

Conditionally run statements.

If <expression> Then

statements

...

[ElseIf expression-n Then

[elseif statements ... ]]

...

[Else

[else statements]

...

EndIf

Parameters

expression If the expression is true, the first statement block is executed. If not, the first true ElseIf block is executed. Otherwise, the "Else" block is executed.

Remarks

If statements may be nested.

The expression can contain the boolean operators of AND, OR, and NOT as well as the logical operators <, <=, >, >=, =, ==, and <> grouped with parentheses as needed.

Related

If...Then, Select...Case...EndSelect, Switch...EndSwitch

and finaly i propose something like that

au3abbrev.properties

ifthen=If | Then\nEndIf

I think if this information can be placed in help file

then this be very much easy to remember abbreviations

[AZJIO]

If...Then

To add this example

If MsgBox(1, 'Condition 1', 'Want "Condition 2"?') = 1 And MsgBox(4, 'Condition 2', 'Want to look result?') = 6 Then MsgBox(4096, 'Result', '<img src='http://www.autoitscript.com/forum/public/style_emoticons/<#EMO_DIR#>/wink.png' class='bbc_emoticon' alt=';)' />')

If...ElseIf...Else...EndIf

To add this example

If MsgBox(1, 'Offer 1', 'Exit?') = 1 Or MsgBox(4, 'Offer 2', 'can still exit?') = 6 Then
    MsgBox(4096, 'Result', 'You agree to exit')
    Exit
Else
    MsgBox(4096, 'Result', 'Do you want to continue')
EndIf

Edited August 17, 2012 by AZJIO

[Valik]

I have an idea

Do helpfile can contain information about abbreviations

for example help documentation for

If...ElseIf...Else...EndIf

now contain

and finaly i propose something like that

I think if this information can be placed in help file

then this be very much easy to remember abbreviations

So you want us to document 3rd party programs in our documentation?

[czardas]

AZIJO, I like the regexp examples. I'm not sure about the If...ElseIf...Else...EndIf examples though. Although I like them too, I think that they could be a little simpler. For something so basic as this, it doesn't make sense to have more advanced stuff mixed in like logical operators and expressions such as MsgBox() = value.

$Hour = @HOUR

If $Hour < 12 Then
    MsgBox(0, "Time", "It's morning")
ElseIf $Hour < 18 Then
    MsgBox(0, "Time", "It's afternoon")
Else
    MsgBox(0, "Time", "It's evening")
EndIf

Edited August 18, 2012 by czardas

[AZJIO]

I believe MsgBox is in almost every case. It is this example demonstrates the operators "And" and "Or", and how it works. I very often use these code constructs, to ask the user to make a choice. I'm for practicality.

Frequently used functions must have at least three examples showing that a beginner can not even imagine. A beginner should not restrict themselves only "If $a = 3 Then".

[guinness]

Thanks. I will update the appropriate sections soon. Plus the Inet examples are on my to do list.

[czardas]

A beginner should not restrict themselves only "If $a = 3 Then".

True, but examples of more advanced conditional statements occur throughout the help file. An absolute beginner wondering what 'And' and 'Or' might imply, and why does MsgBox have a numerical value is likely to take longer to grasp If...ElseIf...Else...EndIf. I have seen many examples in the help file that are 99 percent about a different (often much more advanced) subject. If I didn't find myself so busy I would devote more time to looking into this. There are also many examples that appear to not do anything (if at all apparent) different from similar examples - especially in the UDF examples.

Edited August 18, 2012 by czardas

[guinness]

Examples should demonstrate functionality and not confuse the user. I have to say that MsgBox would confuse me and raise questions in the forum.

[czardas]

I agree. Sticking to the simplest code needed to illustrate exactly what a function does is much clearer, particularly for beginners. Obviously there needs to be some additional code for this stuff to be meaningful.

Edited August 18, 2012 by czardas