patch 7.4.1315

brammool · brammool · commit 7707344ddec9 · 2016-02-13T23:23:53.000+01:00
Problem:    Using a channel handle does not allow for freeing it when unused.
Solution:   Add the Channel variable type.
diff --git a/src/channel.c b/src/channel.c
diff --git a/src/eval.c b/src/eval.c
diff --git a/src/gui_w48.c b/src/gui_w48.c
@@ -1780,14 +1780,14 @@ process_message(void)
 #ifdef FEAT_CHANNEL
     if (msg.message == WM_NETBEANS)
     {
-	int channel_idx = channel_fd2idx((sock_T)msg.wParam);
+	channel_T *channel = channel_fd2channel((sock_T)msg.wParam);
 
-	if (channel_idx >= 0)
+	if (channel != NULL)
 	{
 	    /* Disable error messages, they can mess up the display and throw
 	     * an exception. */
 	    ++emsg_off;
-	    channel_read(channel_idx, FALSE, "process_message");
+	    channel_read(channel, FALSE, "process_message");
 	    --emsg_off;
 	}
 	return;
diff --git a/src/if_python.c b/src/if_python.c
@@ -1561,6 +1561,7 @@ do_pyeval (char_u *str, typval_T *rettv)
 	case VAR_FLOAT:
 	case VAR_SPECIAL:
 	case VAR_JOB:
+	case VAR_CHANNEL:
 	    break;
     }
 }
diff --git a/src/if_python3.c b/src/if_python3.c
@@ -1654,6 +1654,7 @@ do_py3eval (char_u *str, typval_T *rettv)
 	case VAR_FLOAT:
 	case VAR_SPECIAL:
 	case VAR_JOB:
+	case VAR_CHANNEL:
 	    break;
     }
 }
diff --git a/src/json.c b/src/json.c
@@ -183,6 +183,7 @@ json_encode_item(garray_T *gap, typval_T *val, int copyID, int options)
 
 	case VAR_FUNC:
 	case VAR_JOB:
+	case VAR_CHANNEL:
 	    /* no JSON equivalent TODO: better error */
 	    EMSG(_(e_invarg));
 	    return FAIL;
diff --git a/src/misc2.c b/src/misc2.c
@@ -1138,6 +1138,9 @@ free_all_mem(void)
 # endif
 # ifdef FEAT_DIFF
     diff_clear(curtab);
+# endif
+# ifdef FEAT_CHANNEL
+    channel_free_all();
 # endif
     clear_sb_text();	      /* free any scrollback text */
 
diff --git a/src/netbeans.c b/src/netbeans.c
@@ -63,8 +63,8 @@ static int  nb_do_cmd(int, char_u *, int, int, char_u *);
 static void nb_send(char *buf, char *fun);
 static void nb_free(void);
 
-#define NETBEANS_OPEN (nb_channel_idx >= 0 && channel_is_open(nb_channel_idx))
-static int nb_channel_idx = -1;
+#define NETBEANS_OPEN (channel_can_write_to(nb_channel))
+static channel_T *nb_channel = NULL;
 
 static int r_cmdno;			/* current command number for reply */
 static int dosetvisible = FALSE;
@@ -85,7 +85,7 @@ static int inAtomic = 0;
     static void
 nb_channel_closed(void)
 {
-    nb_channel_idx = -1;
+    nb_channel = NULL;
 }
 
 /*
@@ -98,10 +98,10 @@ netbeans_close(void)
     if (NETBEANS_OPEN)
     {
 	netbeans_send_disconnect();
-	if (nb_channel_idx >= 0)
+	if (nb_channel != NULL)
 	    /* Close the socket and remove the input handlers. */
-	    channel_close(nb_channel_idx);
-	nb_channel_idx = -1;
+	    channel_close(nb_channel);
+	nb_channel = NULL;
     }
 
 #ifdef FEAT_BEVAL
@@ -213,8 +213,8 @@ netbeans_connect(char *params, int doabort)
     if (hostname != NULL && address != NULL && password != NULL)
     {
 	port = atoi(address);
-	nb_channel_idx = channel_open(hostname, port, 0, nb_channel_closed);
-	if (nb_channel_idx >= 0)
+	nb_channel = channel_open(hostname, port, 0, nb_channel_closed);
+	if (nb_channel != NULL)
 	{
 	    /* success */
 # ifdef FEAT_BEVAL
@@ -230,7 +230,7 @@ netbeans_connect(char *params, int doabort)
 	}
     }
 
-    if (nb_channel_idx < 0 && doabort)
+    if (nb_channel == NULL && doabort)
 	getout(1);
 
     vim_free(hostname);
@@ -383,9 +383,9 @@ netbeans_parse_messages(void)
     char_u	*p;
     int		own_node;
 
-    while (nb_channel_idx >= 0)
+    while (nb_channel != NULL)
     {
-	buffer = channel_peek(nb_channel_idx);
+	buffer = channel_peek(nb_channel);
 	if (buffer == NULL)
 	    break;	/* nothing to read */
 
@@ -396,7 +396,7 @@ netbeans_parse_messages(void)
 	    /* Command isn't complete.  If there is no following buffer,
 	     * return (wait for more). If there is another buffer following,
 	     * prepend the text to that buffer and delete this one.  */
-	    if (channel_collapse(nb_channel_idx) == FAIL)
+	    if (channel_collapse(nb_channel) == FAIL)
 		return;
 	}
 	else
@@ -409,7 +409,7 @@ netbeans_parse_messages(void)
 	    if (*p == NUL)
 	    {
 		own_node = TRUE;
-		channel_get(nb_channel_idx);
+		channel_get(nb_channel);
 	    }
 	    else
 		own_node = FALSE;
@@ -600,8 +600,8 @@ nb_free(void)
     }
 
     /* free the queued netbeans commands */
-    if (nb_channel_idx >= 0)
-	channel_clear(nb_channel_idx);
+    if (nb_channel != NULL)
+	channel_clear(nb_channel);
 }
 
 /*
@@ -756,8 +756,8 @@ netbeans_end(void)
     static void
 nb_send(char *buf, char *fun)
 {
-    if (nb_channel_idx >= 0)
-	channel_send(nb_channel_idx, (char_u *)buf, fun);
+    if (nb_channel != NULL)
+	channel_send(nb_channel, (char_u *)buf, fun);
 }
 
 /*
diff --git a/src/os_unix.c b/src/os_unix.c
@@ -5043,7 +5043,7 @@ mch_start_job(char **argv, job_T *job)
     int		fd_in[2];	/* for stdin */
     int		fd_out[2];	/* for stdout */
     int		fd_err[2];	/* for stderr */
-    int		ch_idx;
+    channel_T	*channel;
 
     /* default is to fail */
     job->jv_status = JOB_FAILED;
@@ -5055,8 +5055,8 @@ mch_start_job(char **argv, job_T *job)
     if ((pipe(fd_in) < 0) || (pipe(fd_out) < 0) ||(pipe(fd_err) < 0))
 	goto failed;
 
-    ch_idx = add_channel();
-    if (ch_idx < 0)
+    channel = add_channel();
+    if (channel == NULL)
 	goto failed;
 
     pid = fork();	/* maybe we should use vfork() */
@@ -5108,14 +5108,14 @@ mch_start_job(char **argv, job_T *job)
     /* parent */
     job->jv_pid = pid;
     job->jv_status = JOB_STARTED;
-    job->jv_channel = ch_idx;
+    job->jv_channel = channel;
 
     /* child stdin, stdout and stderr */
     close(fd_in[0]);
     close(fd_out[1]);
     close(fd_err[1]);
-    channel_set_pipes(ch_idx, fd_in[1], fd_out[0], fd_err[0]);
-    channel_set_job(ch_idx, job);
+    channel_set_pipes(channel, fd_in[1], fd_out[0], fd_err[0]);
+    channel_set_job(channel, job);
 
     return;
 
diff --git a/src/proto/channel.pro b/src/proto/channel.pro
@@ -1,33 +1,36 @@
 /* channel.c */
 void ch_logfile(FILE *file);
-int add_channel(void);
+channel_T *add_channel(void);
+void channel_free(channel_T *channel);
 void channel_gui_register_all(void);
-int channel_open(char *hostname, int port_in, int waittime, void (*close_cb)(void));
-void channel_set_pipes(int idx, int in, int out, int err);
-void channel_set_job(int idx, job_T *job);
-void channel_set_json_mode(int idx, ch_mode_T ch_mode);
-void channel_set_timeout(int idx, int timeout);
-void channel_set_callback(int idx, char_u *callback);
-void channel_set_req_callback(int idx, char_u *callback, int id);
-char_u *channel_get(int idx);
-int channel_collapse(int idx);
-int channel_can_write_to(int idx);
-int channel_is_open(int idx);
-void channel_close(int idx);
-int channel_save(int idx, char_u *buf, int len);
-char_u *channel_peek(int idx);
-void channel_clear(int idx);
+channel_T *channel_open(char *hostname, int port_in, int waittime, void (*close_cb)(void));
+void channel_set_pipes(channel_T *channel, int in, int out, int err);
+void channel_set_job(channel_T *channel, job_T *job);
+void channel_set_json_mode(channel_T *channel, ch_mode_T ch_mode);
+void channel_set_timeout(channel_T *channel, int timeout);
+void channel_set_callback(channel_T *channel, char_u *callback);
+void channel_set_req_callback(channel_T *channel, char_u *callback, int id);
+char_u *channel_get(channel_T *channel);
+int channel_collapse(channel_T *channel);
+int channel_can_write_to(channel_T *channel);
+int channel_is_open(channel_T *channel);
+char *channel_status(channel_T *channel);
+void channel_close(channel_T *channel);
+int channel_save(channel_T *channel, char_u *buf, int len);
+char_u *channel_peek(channel_T *channel);
+void channel_clear(channel_T *channel);
+void channel_free_all(void);
 int channel_get_id(void);
-void channel_read(int idx, int use_stderr, char *func);
-char_u *channel_read_block(int idx);
-int channel_read_json_block(int ch_idx, int id, typval_T **rettv);
-int channel_fd2idx(sock_T fd);
-int channel_send(int idx, char_u *buf, char *fun);
+void channel_read(channel_T *channel, int use_stderr, char *func);
+char_u *channel_read_block(channel_T *channel);
+int channel_read_json_block(channel_T *channel, int id, typval_T **rettv);
+channel_T *channel_fd2channel(sock_T fd);
+int channel_send(channel_T *channel, char_u *buf, char *fun);
 int channel_poll_setup(int nfd_in, void *fds_in);
 int channel_poll_check(int ret_in, void *fds_in);
 int channel_select_setup(int maxfd_in, void *rfds_in);
 int channel_select_check(int ret_in, void *rfds_in);
 int channel_parse_messages(void);
 int set_ref_in_channel(int copyID);
-ch_mode_T channel_get_mode(int idx);
+ch_mode_T channel_get_mode(channel_T *channel);
 /* vim: set ft=c : */
diff --git a/src/structs.h b/src/structs.h
@@ -1127,7 +1127,8 @@ typedef enum
     VAR_DICT,	 /* "v_dict" is used */
     VAR_FLOAT,	 /* "v_float" is used */
     VAR_SPECIAL, /* "v_number" is used */
-    VAR_JOB	 /* "v_job" is used */
+    VAR_JOB,	 /* "v_job" is used */
+    VAR_CHANNEL	 /* "v_channel" is used */
 } vartype_T;
 
 /*
@@ -1148,6 +1149,9 @@ typedef struct
 	dict_T		*v_dict;	/* dict value (can be NULL!) */
 #ifdef FEAT_JOB
 	job_T		*v_job;		/* job value (can be NULL!) */
+#endif
+#ifdef FEAT_CHANNEL
+	channel_T	*v_channel;	/* channel value (can be NULL!) */
 #endif
     }		vval;
 } typval_T;
@@ -1260,43 +1264,49 @@ struct jobvar_S
     jobstatus_T	jv_status;
 
     int		jv_refcount;	/* reference count */
-    int		jv_channel;	/* channel for I/O */
+    channel_T	*jv_channel;	/* channel for I/O, reference counted */
 };
 
 /*
  * Structures to hold info about a Channel.
  */
 struct readq_S
 {
-    char_u	*buffer;
-    readq_T	*next;
-    readq_T	*prev;
+    char_u	*rq_buffer;
+    readq_T	*rq_next;
+    readq_T	*rq_prev;
 };
 
 struct jsonq_S
 {
-    typval_T	*value;
-    jsonq_T	*next;
-    jsonq_T	*prev;
+    typval_T	*jq_value;
+    jsonq_T	*jq_next;
+    jsonq_T	*jq_prev;
 };
 
 struct cbq_S
 {
-    char_u	*callback;
-    int		seq_nr;
-    cbq_T	*next;
-    cbq_T	*prev;
+    char_u	*cq_callback;
+    int		cq_seq_nr;
+    cbq_T	*cq_next;
+    cbq_T	*cq_prev;
 };
 
 /* mode for a channel */
 typedef enum
 {
-    MODE_RAW = 0,
+    MODE_NL = 0,
+    MODE_RAW,
     MODE_JSON,
     MODE_JS
 } ch_mode_T;
 
 struct channel_S {
+    channel_T	*ch_next;
+    channel_T	*ch_prev;
+
+    int		ch_id;		/* ID of the channel */
+
     sock_T	ch_sock;	/* the socket, -1 for a closed channel */
 
 #ifdef UNIX
@@ -1342,7 +1352,11 @@ struct channel_S {
 
     int		ch_timeout;	/* request timeout in msec */
 
-    job_T	*ch_job;	/* job that uses this channel */
+    job_T	*ch_job;	/* Job that uses this channel; this does not
+				 * count as a reference to avoid a circular
+				 * reference. */
+
+    int		ch_refcount;	/* reference count */
 };
 
 
diff --git a/src/testdir/test_channel.py b/src/testdir/test_channel.py
@@ -1,13 +1,7 @@
 #!/usr/bin/python
 #
 # Server that will accept connections from a Vim channel.
-# Run this server and then in Vim you can open the channel:
-#  :let handle = ch_open('localhost:8765', 'json')
-#
-# Then Vim can send requests to the server:
-#  :let response = ch_sendexpr(handle, 'hello!')
-#
-# See ":help channel-demo" in Vim.
+# Used by test_channel.vim.
 #
 # This requires Python 2.6 or later.
 
diff --git a/src/testdir/test_channel.vim b/src/testdir/test_channel.vim
diff --git a/src/version.c b/src/version.c

Original file line number	Diff line number	Diff line change
`@@ -1780,14 +1780,14 @@ process_message(void)`
`1780`	`1780`	`#ifdef FEAT_CHANNEL`
`1781`	`1781`	`if (msg.message == WM_NETBEANS)`
`1782`	`1782`	`{`
`1783`		`- int channel_idx = channel_fd2idx((sock_T)msg.wParam);`
	`1783`	`+ channel_T *channel = channel_fd2channel((sock_T)msg.wParam);`
`1784`	`1784`
`1785`		`- if (channel_idx >= 0)`
	`1785`	`+ if (channel != NULL)`
`1786`	`1786`	`{`
`1787`	`1787`	`/* Disable error messages, they can mess up the display and throw`
`1788`	`1788`	`* an exception. */`
`1789`	`1789`	`++emsg_off;`
`1790`		`- channel_read(channel_idx, FALSE, "process_message");`
	`1790`	`+ channel_read(channel, FALSE, "process_message");`
`1791`	`1791`	`--emsg_off;`
`1792`	`1792`	`}`
`1793`	`1793`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -1561,6 +1561,7 @@ do_pyeval (char_u str, typval_T rettv)`
`1561`	`1561`	`case VAR_FLOAT:`
`1562`	`1562`	`case VAR_SPECIAL:`
`1563`	`1563`	`case VAR_JOB:`
	`1564`	`+ case VAR_CHANNEL:`
`1564`	`1565`	`break;`
`1565`	`1566`	`}`
`1566`	`1567`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1654,6 +1654,7 @@ do_py3eval (char_u str, typval_T rettv)`
`1654`	`1654`	`case VAR_FLOAT:`
`1655`	`1655`	`case VAR_SPECIAL:`
`1656`	`1656`	`case VAR_JOB:`
	`1657`	`+ case VAR_CHANNEL:`
`1657`	`1658`	`break;`
`1658`	`1659`	`}`
`1659`	`1660`	`}`