Migrate AMI VarSet events raised by GoSub local variables
authorMatthew Jordan <mjordan@digium.com>
Thu, 2 May 2013 20:59:20 +0000 (20:59 +0000)
committerMatthew Jordan <mjordan@digium.com>
Thu, 2 May 2013 20:59:20 +0000 (20:59 +0000)
This patch moves VarSet events for local variables raised by GoSub
over to Stasis-Core. It also tweaks up the post-processing documentation
scripts to not combine parameters if both parameters are already documented.

(issue ASTERISK-21462)

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@387519 65c4cc65-6c06-0410-ace0-fbb531ad65f3

apps/app_stack.c
build_tools/post_process_documentation.py

index 73731be..9260f2a 100644 (file)
@@ -40,6 +40,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/manager.h"
 #include "asterisk/channel.h"
 #include "asterisk/agi.h"
+#include "asterisk/stasis_channels.h"
 
 /*** DOCUMENTATION
        <application name="Gosub" language="en_US">
@@ -202,7 +203,32 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <para>Cause the channel to execute the specified dialplan subroutine,
                        returning to the dialplan with execution of a Return().</para>
                </description>
+               <see-also>
+                       <ref type="application">GoSub</ref>
+               </see-also>
        </agi>
+       <managerEvent language="en_US" name="VarSet">
+               <managerEventInstance class="EVENT_FLAG_DIALPLAN">
+                       <synopsis>Raised when a variable local to the gosub stack frame is set due to a subroutine call.</synopsis>
+                       <syntax>
+                               <xi:include xpointer="xpointer(/docs/managerEvent[@name='Newchannel']/managerEventInstance/syntax/parameter)" />
+                               <parameter name="Variable">
+                                       <para>The LOCAL variable being set.</para>
+                                       <note><para>The variable name will always be enclosed with
+                                       <literal>LOCAL()</literal></para></note>
+                               </parameter>
+                               <parameter name="Value">
+                                       <para>The new value of the variable.</para>
+                               </parameter>
+                       </syntax>
+                       <see-also>
+                               <ref type="application">GoSub</ref>
+                               <ref type="agi">gosub</ref>
+                               <ref type="function">LOCAL</ref>
+                               <ref type="function">LOCAL_PEEK</ref>
+                       </see-also>
+               </managerEventInstance>
+       </managerEvent>
  ***/
 
 static const char app_gosub[] = "Gosub";
@@ -235,6 +261,8 @@ static int frame_set_var(struct ast_channel *chan, struct gosub_stack_frame *fra
 {
        struct ast_var_t *variables;
        int found = 0;
+       int len;
+       RAII_VAR(char *, local_buffer, NULL, ast_free);
 
        /* Does this variable already exist? */
        AST_LIST_TRAVERSE(&frame->varshead, variables, entries) {
@@ -252,20 +280,13 @@ static int frame_set_var(struct ast_channel *chan, struct gosub_stack_frame *fra
                pbx_builtin_setvar_helper(chan, var, value);
        }
 
-       /*** DOCUMENTATION
-       <managerEventInstance>
-               <synopsis>Raised when a LOCAL channel variable is set due to a subroutine call.</synopsis>
-               <see-also>
-                       <ref type="application">GoSub</ref>
-               </see-also>
-       </managerEventInstance>
-       ***/
-       manager_event(EVENT_FLAG_DIALPLAN, "VarSet",
-               "Channel: %s\r\n"
-               "Variable: LOCAL(%s)\r\n"
-               "Value: %s\r\n"
-               "Uniqueid: %s\r\n",
-               ast_channel_name(chan), var, value, ast_channel_uniqueid(chan));
+       len = 8 + strlen(var); /* LOCAL() + var */
+       local_buffer = ast_malloc(len);
+       if (!local_buffer) {
+               return 0;
+       }
+       sprintf(local_buffer, "LOCAL(%s)", var);
+       ast_channel_publish_varset(chan, local_buffer, value);
        return 0;
 }
 
index b2d9e5e..678328d 100644 (file)
@@ -22,9 +22,9 @@ def merge_parameter_information(managerEvent):
 
     def __swap_parameter_documentation(one, two):
         # See who has the better documentation and use it
-        if (one.hasChildNodes()):
+        if (one.hasChildNodes() and not two.hasChildNodes()):
             two.parentNode.replaceChild(one.cloneNode(True), two)
-        elif (two.hasChildNodes()):
+        elif (two.hasChildNodes() and not one.hasChildNodes()):
             one.parentNode.replaceChild(two.cloneNode(True), one)
 
     def __merge_parameter(param, other_instances):