Merge pull request #115 from mlipok/patch-1

Update NetWebView2Lib.au3 ++ __NetWebView2_Sleep()

Author: ioa747

NetWebView2Lib.au3

@@ -29,6 +29,7 @@
 Global $_g_bNetWebView2_DebugInfo = True
 ;~ Global $_g_bNetWebView2_DebugDev = False
 Global $_g_bNetWebView2_DebugDev = (@Compiled = 1)
+Global $_g_bNetWebView2_Sleep = Sleep                  ; Default to calling standard Sleep function
 
 #Region ; === NetWebView2Lib UDF === ENUMS
 
@@ -92,6 +93,7 @@ Global Enum _ ; $NETWEBVIEW2_MESSAGE__* are set by mainly by __NetWebView2_Event
 		$NETWEBVIEW2_MESSAGE__DOWNLOAD_COMPLETED, _
 		$NETWEBVIEW2_MESSAGE__RESPONSE_RECEIVED, _
 		$NETWEBVIEW2_MESSAGE__UNKNOWN_MESSAGE, _
+		$NETWEBVIEW2_MESSAGE__USER_ABORT, _
 		$NETWEBVIEW2_MESSAGE___FAKE_COUNTER
 
 Global Enum _
@@ -211,7 +213,9 @@ Func _NetWebView2_Initialize($oWebV2M, $hUserGUI, $s_ProfileDirectory, $i_Left =
 	Local $iTimeOut_ms = 10000 ; max 10 seconds for initialization
 	Local $iMessage
 	Do
-		Sleep(50)
+		__NetWebView2_Sleep(10)
+		If @error Then Return SetError(@error, @extended, '')
+
 		$iMessage = __NetWebView2_LastMessage_KEEPER($oWebV2M)
 		If $iMessage = $NETWEBVIEW2_MESSAGE__INIT_FAILED _
 				Or $iMessage = $NETWEBVIEW2_MESSAGE__PROFILE_NOT_READY _
@@ -466,8 +470,9 @@ Func _NetWebView2_LoadWait($oWebV2M, $iWaitMessage = $NETWEBVIEW2_MESSAGE__TITLE
 	__NetWebView2_LastMessage_Navigation($oWebV2M, $NETWEBVIEW2_MESSAGE__NONE)
 
 	While 1
-		; Allow AutoIt to "breathe" and process the GUI messages
-		Sleep(10)
+		; Allow AutoIt to "breathe" and process the GUI messages, also allow user to abort
+		__NetWebView2_Sleep(10)
+		If @error Then Return SetError(@error, @extended, '')
 
 		; RULE 1: If we reached the target status or higher
 		Local $bWebIsReady = $oWebV2M.IsReady
@@ -719,14 +724,14 @@ EndFunc   ;==>_NetWebView2_GetSource
 ; Name ..........: _NetWebView2_NavigateToPDF
 ; Description ...: Navigate to a PDF (local PDF file or online direct URL link to PDF file)
 ; Syntax ........: _NetWebView2_NavigateToPDF($oWebV2M, $s_URL_or_FilePath[, $s_Parameters = ''[, $iWaitMessage = $NETWEBVIEW2_MESSAGE__TITLE_CHANGED[,
-;                  $sExpectedTitle = ""[, $iTimeOut_ms = 5000[, $iSleep_ms = 1000[, $bFreeze = True]]]]]])
+;                  $sExpectedTitle = ""[, $iTimeOut_ms = 5000[, $iSleepAfter_ms = 1000[, $bFreeze = True]]]]]])
 ; Parameters ....: $oWebV2M             - an object.
 ;                  $s_URL_or_FilePath   - a string value.
 ;                  $s_Parameters        - [optional] a string value. Default is ''.
 ;                  $iWaitMessage        - [optional] an integer value. Default is $NETWEBVIEW2_MESSAGE__TITLE_CHANGED.
 ;                  $sExpectedTitle      - [optional] Expected title to LoadWait for, as StringRegExp() pattern, By Default vaule it will compute the $s_URL_or_FilePath to guess RegExp for the Title
 ;                  $iTimeOut_ms         - [optional] Maximum time to wait in milliseconds. 0 for infinite. Default is 5000ms
-;                  $iSleep_ms           - [optional] an integer value. Default is 1000.
+;                  $iSleepAfter_ms      - [optional] an integer value. Default is 1000.
 ;                  $bFreeze             - [optional] a boolean value. Default is True.
 ; Return values .: None
 ; Author ........: mLipok
@@ -736,7 +741,7 @@ EndFunc   ;==>_NetWebView2_GetSource
 ; Link ..........:
 ; Example .......: No
 ; ===============================================================================================================================
-Func _NetWebView2_NavigateToPDF($oWebV2M, $s_URL_or_FilePath, Const $s_Parameters = '', $iWaitMessage = $NETWEBVIEW2_MESSAGE__TITLE_CHANGED, $sExpectedTitle = Default, $iTimeOut_ms = 5000, Const $iSleep_ms = 1000, Const $bFreeze = True)
+Func _NetWebView2_NavigateToPDF($oWebV2M, $s_URL_or_FilePath, Const $s_Parameters = '', $iWaitMessage = $NETWEBVIEW2_MESSAGE__TITLE_CHANGED, $sExpectedTitle = Default, $iTimeOut_ms = 5000, Const $iSleepAfter_ms = 1000, Const $bFreeze = True)
 	Local Const $s_Prefix = "[_NetWebView2_NavigateToPDF]: URL_or_File:" & $s_URL_or_FilePath ; #TODO suplement
 
 	If (Not IsObj($oWebV2M)) Or ObjName($oWebV2M, $OBJ_PROGID) <> 'NetWebView2Lib.WebView2Manager' Then Return SetError(1, 0, "ERROR: Invalid Object")
@@ -769,7 +774,9 @@ Func _NetWebView2_NavigateToPDF($oWebV2M, $s_URL_or_FilePath, Const $s_Parameter
 	$oWebV2M.LockWebView()
 	If $bFreeze Then __NetWebView2_freezer($oWebV2M, $idPic)
 	_NetWebView2_Navigate($oWebV2M, $s_URL_or_FilePath, $iWaitMessage, $sExpectedTitle, $iTimeOut_ms)
-	If Not @error Then Sleep($iSleep_ms)
+	If Not @error Then __NetWebView2_Sleep($iSleepAfter_ms)
+	If @error Then Return SetError(@error, @extended, '')
+
 	__NetWebView2_Log(@ScriptLineNumber, $s_Prefix, 1)
 	If $bFreeze And $idPic Then __NetWebView2_freezer($oWebV2M, $idPic)
 	$oWebV2M.UnLockWebView()
@@ -1099,6 +1106,26 @@ EndFunc   ;==>_NetJson_EncodeB64
 #EndRegion ; === NetWebView2Lib UDF === _NetJson_* functions
 
 #Region ; === NetWebView2Lib UDF === #INTERNAL_USE_ONLY#
+; #INTERNAL_USE_ONLY# ===========================================================================================================
+; Name ..........: __NetWebView2_Sleep
+; Description ...: Pause script execution for designated timeframe.
+; Syntax ........: __NetWebView2_Sleep($iPause)
+; Parameters ....: $iPause - Amount of time to pause (in milliseconds)
+; Return values .: Success - None
+;                  Failure - None and sets @error $NETWEBVIEW2_MESSAGE__USER_ABORT
+; Author ........: @Danp2, mLipok
+; Modified ......:
+; Remarks .......: Calls standard Sleep() by default. This can be overridden by setting $_g_bNetWebView2_Sleep so that a user supplied function gets called instead.
+;                  User's function can throw error which will lead to $NETWEBVIEW2_MESSAGE__USER_ABORT
+; Related .......:
+; Link ..........:
+; Example .......: No
+; ===============================================================================================================================
+Func __NetWebView2_Sleep($iPause)
+	$_g_bNetWebView2_Sleep($iPause)
+	If @error Then Return SetError($NETWEBVIEW2_MESSAGE__USER_ABORT, @extended)
+EndFunc   ;==>__NetWebView2_Sleep
+
 ; #INTERNAL_USE_ONLY# ===========================================================================================================
 ; Name ..........: __NetWebView2_WaitForReadyState
 ; Description ...: Polls the browser until the document.readyState reaches 'complete'.
@@ -1143,7 +1170,9 @@ Func __NetWebView2_WaitForReadyState($oWebV2M, $hTimer, $iTimeOut_ms = 5000)
 			__NetWebView2_Log(@ScriptLineNumber, $s_Prefix & " TIMEOUT: Document state is " & $sReadyState & " Timeout_ms: " & Round(TimerDiff($hTimer), 0), 1)
 			Return SetError(1, 0, False)
 		EndIf
-		Sleep(50)
+		__NetWebView2_Sleep(50)
+		If @error Then Return SetError(@error, @extended, '')
+
 	WEnd
 EndFunc   ;==>__NetWebView2_WaitForReadyState