patch 8.1.1899: sign_place() does not work as documented

Problem:    sign_place() does not work as documented.
Solution:   Make accept line numbers like line(). (Yegappan Lakshmanan,
            closes #4848)

diff --git a/src/sign.c b/src/sign.c
index 7628fcefdfd4cf30e5967037203047ca36ec35ae..73951317e3e2149eb3dd62a679178887b553357d 100644 (file)
--- a/src/sign.c
+++ b/src/sign.c
@@ -2430,9 +2430,12 @@ sign_place_from_dict(
     di = dict_find(dict, (char_u *)"lnum", -1);
     if (di != NULL)
     {
-       lnum = (int)tv_get_number_chk(&di->di_tv, &notanum);
-       if (notanum)
+       lnum = tv_get_lnum(&di->di_tv);
+       if (lnum <= 0)
+       {
+           emsg(_(e_invarg));
            goto cleanup;
+       }
     }
 
     // sign priority

diff --git a/src/testdir/test_signs.vim b/src/testdir/test_signs.vim
index 3d885d6428f931f0d3737a7be2a7c447b093d4a8..06b2571aa29b32574883f5992a4be9e6d891ec00 100644 (file)
--- a/src/testdir/test_signs.vim
+++ b/src/testdir/test_signs.vim
@@ -457,11 +457,11 @@ func Test_sign_funcs()
   call assert_fails('call sign_place(5, "", "sign1", [], {"lnum" : 10})',
              \ 'E158:')
   call assert_fails('call sign_place(21, "", "sign1", "Xsign",
-             \ {"lnum" : -1})', 'E885:')
+             \ {"lnum" : -1})', 'E474:')
   call assert_fails('call sign_place(22, "", "sign1", "Xsign",
-             \ {"lnum" : 0})', 'E885:')
+             \ {"lnum" : 0})', 'E474:')
   call assert_fails('call sign_place(22, "", "sign1", "Xsign",
-             \ {"lnum" : []})', 'E745:')
+             \ {"lnum" : []})', 'E474:')
   call assert_equal(-1, sign_place(1, "*", "sign1", "Xsign", {"lnum" : 10}))
 
   " Tests for sign_getplaced()
@@ -517,6 +517,16 @@ func Test_sign_funcs()
   call assert_fails('call sign_undefine("none")', 'E155:')
   call assert_fails('call sign_undefine({})', 'E731:')
 
+  " Test for using '.' as the line number for sign_place()
+  call sign_define("sign1", attr)
+  call cursor(22, 1)
+  call assert_equal(15, sign_place(15, '', 'sign1', 'Xsign',
+             \ {'lnum' : '.'}))
+  call assert_equal([{'bufnr' : bufnr(''), 'signs' :
+             \ [{'id' : 15, 'group' : '', 'lnum' : 22, 'name' : 'sign1',
+             \ 'priority' : 10}]}],
+             \ sign_getplaced('%', {'lnum' : 22}))
+
   call delete("Xsign")
   call sign_unplace('*')
   call sign_undefine()
@@ -1928,6 +1938,14 @@ func Test_sign_funcs_multi()
   call assert_equal([{'id' : 5, 'name' : 'sign1', 'lnum' : 11,
              \ 'group' : '', 'priority' : 10}], s[0].signs)
 
+  " Place a sign using '.' as the line number
+  call cursor(23, 1)
+  call assert_equal([7], sign_placelist([
+             \ {'id' : 7, 'name' : 'sign1', 'buffer' : '%', 'lnum' : '.'}]))
+  let s = sign_getplaced('%', {'lnum' : '.'})
+  call assert_equal([{'id' : 7, 'name' : 'sign1', 'lnum' : 23,
+             \ 'group' : '', 'priority' : 10}], s[0].signs)
+
   " Place sign without a sign name
   call assert_equal([-1], sign_placelist([{'id' : 10, 'buffer' : 'Xsign',
              \ 'lnum' : 12, 'group' : ''}]))

diff --git a/src/version.c b/src/version.c
index 0689e0345c8f370ae0cd96962003f0e37b17cd0c..f91f07bd88ed7dc1f0a1ecc78ac691d083b3849e 100644 (file)
--- a/src/version.c
+++ b/src/version.c
@@ -765,6 +765,8 @@ static char *(features[]) =
 
 static int included_patches[] =
 {   /* Add new patch number below this line */
+/**/
+    1899,
 /**/
     1898,
 /**/