patch 8.0.0832: terminal function arguments are not consistent

Problem:    Terminal function arguments are not consistent.
Solution:   Use one-based instead of zero-based rows and cols.  Use "." for
            the current row.

diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index f43e7164a4ffe408808e2e5d3d1a7f64840aa3d3..cbe5565c7f97ba49d16ca3816ec825cfcc1e1c4f 100644 (file)
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -1,4 +1,4 @@
-*eval.txt*     For Vim version 8.0.  Last change: 2017 Jul 30
+*eval.txt*     For Vim version 8.0.  Last change: 2017 Aug 01
 
 
                  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -1815,7 +1815,7 @@ v:scrollstart     String describing the script or function that caused the
                hit-enter prompt.
 
                                        *v:servername* *servername-variable*
-v:servername   The resulting registered |x11-clientserver| name if any.
+v:servername   The resulting registered |client-server-name| if any.
                Read-only.
 
                
@@ -2372,12 +2372,12 @@ tempname()                      String  name for a temporary file
 term_getattr({attr}, {what}    Number  get the value of attribute {what}
 term_getcursor({buf})          List    get the cursor position of a terminal
 term_getjob({buf})             Job     get the job associated with a terminal
-term_getline({buf}[, {row}])   String  get a line of text from a terminal
+term_getline({buf}, {row})     String  get a line of text from a terminal
 term_getsize({buf})            List    get the size of a terminal
 term_getstatus({buf})          String  get the status of a terminal
 term_gettitle({buf})           String  get the title of a terminal
 term_list()                    List    get the list of terminal buffers
-term_scrape({buf}[, {row}])    List    get row of a terminal screen
+term_scrape({buf}, {row})      List    get row of a terminal screen
 term_sendkeys({buf}, {keys})   none    send keystrokes to a terminal
 term_start({cmd}, {options})   Job     open a terminal window and run a job
 term_wait({buf})               Number  wait for screen to be updated
@@ -7916,8 +7916,9 @@ term_getattr({attr}, {what})                              *term_getattr()*
 term_getcursor({buf})                                  *term_getcursor()*
                Get the cusor position of terminal {buf}. Returns a list with
                three numbers: [rows, cols, visible].  "rows" and "cols" are
-               zero based.  "visible" is one when the cursor is visible, zero
-               when it is hidden.
+               one based, the first sceen cell is row 1, column 1.
+               "visible" is one when the cursor is visible, zero when it is
+               hidden.
                
                This is the cursor position of the terminal itself, not of the
                Vim window.
@@ -7930,13 +7931,12 @@ term_getjob({buf})                                      *term_getjob()*
                Get the Job associated with terminal window {buf}.
                {buf} is used as with |term_getsize()|.
 
-term_getline({buf} [, {row}])                          *term_getline()*
+term_getline({buf}, {row})                             *term_getline()*
                Get a line of text from the terminal window of {buf}.
                {buf} is used as with |term_getsize()|.
 
-               The first line has {row} zero.  When {row} is invalid an empty
-               string is returned. When {row} is omitted, the cursor line is
-               used.
+               The first line has {row} one.  When {row} "." the cursor line
+               is used.  When {row} is invalid an empty string is returned.
 
 term_getsize({buf})                                    *term_getsize()*
                Get the size of terminal {buf}. Returns a list with two
@@ -7971,12 +7971,12 @@ term_list()                                             *term_list()*
                Return a list with the buffer numbers of all buffers for
                terminal windows.
 
-term_scrape({buf} [, {row}])                           *term_scrape()*
+term_scrape({buf}, {row})                              *term_scrape()*
                Get the contents of {row} of terminal screen of {buf}.
                For {buf} see |term_getsize()|.
 
-               The first {row} is zero.  When {row} is invalid an empty list
-               is returned. When {row} is omitted the cursor line is used.
+               The first line has {row} one.  When {row} "." the cursor line
+               is used.  When {row} is invalid an empty string is returned.
 
                Return a List containing a Dict for each screen cell: 
                    "chars"     character(s) at the cell
@@ -8728,6 +8728,7 @@ tag_any_white             Compiled with support for any white characters in tags
                        files |tag-any-white|.
 tcl                    Compiled with Tcl interface.
 termguicolors          Compiled with true color in terminal support.
+terminal               Compiled with |terminal| support.
 terminfo               Compiled with terminfo instead of termcap.
 termresponse           Compiled with support for |t_RV| and |v:termresponse|.
 textobjects            Compiled with support for |text-objects|.

diff --git a/src/terminal.c b/src/terminal.c
index 1f235872483de8bc2a2b22f2a140e9720378578b..9dc2d32028b418a2e6e410a398a75cc2bd91303a 100644 (file)
--- a/src/terminal.c
+++ b/src/terminal.c
@@ -36,8 +36,6 @@
  * that buffer, attributes come from the scrollback buffer tl_scrollback.
  *
  * TODO:
- * - Use "." for current line instead of optional argument.
- * - make row and cols one-based instead of zero-based in term_ functions.
  * - Add StatusLineTerm highlighting
  * - in bash mouse clicks are inserting characters.
  * - mouse scroll: when over other window, scroll that window.
@@ -1773,8 +1771,8 @@ f_term_getcursor(typval_T *argvars, typval_T *rettv)
        return;
 
     l = rettv->vval.v_list;
-    list_append_number(l, buf->b_term->tl_cursor_pos.row);
-    list_append_number(l, buf->b_term->tl_cursor_pos.col);
+    list_append_number(l, buf->b_term->tl_cursor_pos.row + 1);
+    list_append_number(l, buf->b_term->tl_cursor_pos.col + 1);
     list_append_number(l, buf->b_term->tl_cursor_visible);
 }
 
@@ -1796,6 +1794,16 @@ f_term_getjob(typval_T *argvars, typval_T *rettv)
        ++rettv->vval.v_job->jv_refcount;
 }
 
+    static int
+get_row_number(typval_T *tv, term_T *term)
+{
+    if (tv->v_type == VAR_STRING
+           && tv->vval.v_string != NULL
+           && STRCMP(tv->vval.v_string, ".") == 0)
+       return term->tl_cursor_pos.row;
+    return (int)get_tv_number(tv) - 1;
+}
+
 /*
  * "term_getline(buf, row)" function
  */
@@ -1810,10 +1818,7 @@ f_term_getline(typval_T *argvars, typval_T *rettv)
     if (buf == NULL)
        return;
     term = buf->b_term;
-    if (argvars[1].v_type == VAR_UNKNOWN)
-       row = term->tl_cursor_pos.row;
-    else
-       row = (int)get_tv_number(&argvars[1]);
+    row = get_row_number(&argvars[1], term);
 
     if (term->tl_vterm == NULL)
     {
@@ -1944,10 +1949,7 @@ f_term_scrape(typval_T *argvars, typval_T *rettv)
        screen = vterm_obtain_screen(term->tl_vterm);
 
     l = rettv->vval.v_list;
-    if (argvars[1].v_type == VAR_UNKNOWN)
-       pos.row = term->tl_cursor_pos.row;
-    else
-       pos.row = (int)get_tv_number(&argvars[1]);
+    pos.row = get_row_number(&argvars[1], term);
     for (pos.col = 0; pos.col < term->tl_cols; )
     {
        dict_T          *dcell;

diff --git a/src/version.c b/src/version.c
index 71ee6d29f3920cdae664929aadc25467c71e97e8..67862d09066ab4d6a3a1383a9e7e03ac256e91fb 100644 (file)
--- a/src/version.c
+++ b/src/version.c
@@ -769,6 +769,8 @@ static char *(features[]) =
 
 static int included_patches[] =
 {   /* Add new patch number below this line */
+/**/
+    832,
 /**/
     831,
 /**/