Merge pull request livecode#4565 from trevordevore/tkd-support-callback-with-no-target

peter-b · web-flow · commit 398b17debdfe · 2016-09-29T08:25:11.000+01:00
[Bug 18470] Don't require target for libURLSetStatusCallback
diff --git a/docs/dictionary/command/libURLSetStatusCallback.lcdoc b/docs/dictionary/command/libURLSetStatusCallback.lcdoc
@@ -2,7 +2,7 @@ Name: libURLSetStatusCallback
 
 Type: command
 
-Syntax: libURLSetStatusCallback [<messageName>, <objectLongID>]
+Syntax: libURLSetStatusCallback [<messageName>[, <objectLongID>]]
 
 Summary:
 Sets up a <callback|callback message> to be sent periodically during
@@ -24,6 +24,9 @@ libURLSetStatusCallback "putPercentage",the long ID of me
 Example:
 libURLSetStatusCallback myAction,the long ID of button "Upload"
 
+Example:
+libURLSetStatusCallback "putPercentage" -- sends message to url library. Handle the message in a frontscript, backscript, or stack in use.
+
 Example:
 libURLSetStatusCallback -- turns off status callback messages
 
@@ -33,7 +36,10 @@ The name of a message to be sent whenever the URLStatus function is
 updated. 
 
 objectLongID:
-The long ID of the object to send the message to.
+The long ID of the object to send the message to. If <messageName> is 
+not empty and <objectLongID> is not specified then the message will be sent to
+the revLibURL library stack. The message can be handled in a frontscript,
+backscript, or library stack.
 
 Description:
 Use the <libURLSetStatusCallback> <command> if you want to do periodic
diff --git a/docs/notes/feature-libUrlSetStatusCallback-no-object.md b/docs/notes/feature-libUrlSetStatusCallback-no-object.md
@@ -0,0 +1,5 @@
+# libURLSetStatusCallback no longer requires a target object for the message
+
+Passing an object reference as a second parameter to libURLSetStatusCallback 
+is no longer required. If no object is passed in then the message will be sent
+to revLibURL itself and you can handle the message anywhere in the message path.
diff --git a/ide-support/revliburl.livecodescript b/ide-support/revliburl.livecodescript
@@ -3562,7 +3562,13 @@ end libUrlSetLogField
 ---------------------------
 on libUrlSetStatusCallback pMessage,pObject
   ##pObject must be a long ID
-  if pMessage <> empty and exists(pObject)  then
+  ##Allow empty value in which case we use send to self.
+  if pMessage is not empty and the paramCount is 1 then
+    put pMessage & comma into lvStatusCallback
+  else if pMessage is not empty and the paramCount is 2 then
+    if not exists(pObject) then
+      return "invalid callback target object" for error
+    end if
     put pMessage & comma & pObject into lvStatusCallback
   else
     put empty into lvStatusCallback
@@ -3936,15 +3942,20 @@ on ulSendMessage pUrl
 end ulSendMessage
 ----------------------------
 on ulSendCallback pUrl, pStatus
-  local tMessage,tObject
+  local tMessage,tObject,tSendStr
   
   if lvStatusCallback is empty then exit ulSendCallback
   put item 1 of lvStatusCallback into tMessage
 
   put item 2 to -1 of lvStatusCallback into tObject   ##modified dc 220905
+  put tMessage && "pURL, pStatus" into tSendStr
+  
   if exists(tObject) then
     ## need quotes for the url formatting and the possibility of multiple items in second argument
-    send tMessage &&  quote & pUrl & quote & comma & quote & pStatus & quote to tObject in 0 milliseconds
+    send tSendStr to tObject in 0 milliseconds
+   else
+    # If no target then just send to self so it propagates through message path.
+    send tSendStr to me in 0 milliseconds
   end if
 end ulSendCallback
 -----------------------------
