vim-patch:7.4.1042

Problem:    g-CTRL-G shows the word count, but there is no way to get the word
            count in a script.
Solution:   Add the wordcount() function. (Christian Brabandt)

ed767a2073

src/nvim/eval.c

@@ -6949,6 +6949,7 @@ static struct fst {
   { "winrestview",       1, 1, f_winrestview },
   { "winsaveview",       0, 0, f_winsaveview },
   { "winwidth",          1, 1, f_winwidth },
+  { "wordcount",         0, 0, f_wordcount },
   { "writefile",         2, 3, f_writefile },
   { "xor",               2, 2, f_xor },
 };
@@ -16910,6 +16911,13 @@ static void f_winwidth(typval_T *argvars, typval_T *rettv)
     rettv->vval.v_number = wp->w_width;
 }
 
+/// "wordcount()" function
+static void f_wordcount(typval_T *argvars, typval_T *rettv)
+{
+  rettv_dict_alloc(rettv);
+  cursor_pos_info(rettv->vval.v_dict);
+}
+
 /// "writefile()" function
 static void f_writefile(typval_T *argvars, typval_T *rettv)
 {

src/nvim/normal.c

@@ -6737,16 +6737,12 @@ static void nv_g_cmd(cmdarg_T *cap)
       clearopbeep(oap);
     break;
 
-  /*
-   * "g CTRL-G": display info about cursor position
-   */
+  // "g CTRL-G": display info about cursor position
   case Ctrl_G:
-    cursor_pos_info();
+    cursor_pos_info(NULL);
     break;
 
-  /*
-   * "gi": start Insert at the last position.
-   */
+  // "gi": start Insert at the last position.
   case 'i':
     if (curbuf->b_last_insert.mark.lnum != 0) {
       curwin->w_cursor = curbuf->b_last_insert.mark;

src/nvim/ops.c

@@ -5165,18 +5165,18 @@ static long line_count_info(char_u *line, long *wc, long *cc, long limit, int eo
   return i;
 }
 
-/*
- * Give some info about the position of the cursor (for "g CTRL-G").
- * In Visual mode, give some info about the selected region.  (In this case,
- * the *_count_cursor variables store running totals for the selection.)
- */
-void cursor_pos_info(void)
+/// Give some info about the position of the cursor (for "g CTRL-G").
+/// In Visual mode, give some info about the selected region.  (In this case,
+/// the *_count_cursor variables store running totals for the selection.)
+/// When "dict" is not NULL store the info there instead of showing it.
+void cursor_pos_info(dict_T *dict)
 {
   char_u      *p;
   char_u buf1[50];
   char_u buf2[40];
   linenr_T lnum;
   long byte_count = 0;
+  long bom_count = 0;
   long byte_count_cursor = 0;
   long char_count = 0;
   long char_count_cursor = 0;
@@ -5191,11 +5191,12 @@ void cursor_pos_info(void)
   const int l_VIsual_active = VIsual_active;
   const int l_VIsual_mode = VIsual_mode;
 
-  /*
-   * Compute the length of the file in characters.
-   */
+  // Compute the length of the file in characters.
   if (curbuf->b_ml.ml_flags & ML_EMPTY) {
-    MSG(_(no_lines_msg));
+    if (dict == NULL) {
+      MSG(_(no_lines_msg));
+      return;
+    }
   } else {
     if (get_fileformat(curbuf) == EOL_DOS)
       eol_size = 2;
@@ -5300,78 +5301,105 @@ void cursor_pos_info(void)
           &char_count, (long)MAXCOL, eol_size);
     }
 
-    /* Correction for when last line doesn't have an EOL. */
-    if (!curbuf->b_p_eol && (curbuf->b_p_bin || !curbuf->b_p_fixeol))
+    // Correction for when last line doesn't have an EOL.
+    if (!curbuf->b_p_eol && (curbuf->b_p_bin || !curbuf->b_p_fixeol)) {
       byte_count -= eol_size;
-
-    if (l_VIsual_active) {
-      if (l_VIsual_mode == Ctrl_V && curwin->w_curswant < MAXCOL) {
-        getvcols(curwin, &min_pos, &max_pos, &min_pos.col,
-            &max_pos.col);
-        vim_snprintf((char *)buf1, sizeof(buf1), _("%" PRId64 " Cols; "),
-            (int64_t)(oparg.end_vcol - oparg.start_vcol + 1));
-      } else
-        buf1[0] = NUL;
-
-      if (char_count_cursor == byte_count_cursor
-          && char_count == byte_count)
-        vim_snprintf((char *)IObuff, IOSIZE,
-            _("Selected %s%" PRId64 " of %" PRId64 " Lines; %" PRId64
-              " of %" PRId64 " Words; %" PRId64 " of %" PRId64 " Bytes"),
-            buf1, (int64_t)line_count_selected,
-            (int64_t)curbuf->b_ml.ml_line_count,
-            (int64_t)word_count_cursor, (int64_t)word_count,
-            (int64_t)byte_count_cursor, (int64_t)byte_count);
-      else
-        vim_snprintf((char *)IObuff, IOSIZE,
-            _("Selected %s%" PRId64 " of %" PRId64 " Lines; %" PRId64
-              " of %" PRId64 " Words; %" PRId64 " of %" PRId64
-              " Chars; %" PRId64 " of %" PRId64 " Bytes"),
-            buf1, (int64_t)line_count_selected,
-            (int64_t)curbuf->b_ml.ml_line_count,
-            (int64_t)word_count_cursor, (int64_t)word_count,
-            (int64_t)char_count_cursor, (int64_t)char_count,
-            (int64_t)byte_count_cursor, (int64_t)byte_count);
-    } else {
-      p = get_cursor_line_ptr();
-      validate_virtcol();
-      col_print(buf1, sizeof(buf1), (int)curwin->w_cursor.col + 1,
-          (int)curwin->w_virtcol + 1);
-      col_print(buf2, sizeof(buf2), (int)STRLEN(p), linetabsize(p));
-
-      if (char_count_cursor == byte_count_cursor
-          && char_count == byte_count)
-        vim_snprintf((char *)IObuff, IOSIZE,
-            _("Col %s of %s; Line %" PRId64 " of %" PRId64 "; Word %" PRId64
-              " of %" PRId64 "; Byte %" PRId64 " of %" PRId64 ""),
-            (char *)buf1, (char *)buf2,
-            (int64_t)curwin->w_cursor.lnum,
-            (int64_t)curbuf->b_ml.ml_line_count,
-            (int64_t)word_count_cursor, (int64_t)word_count,
-            (int64_t)byte_count_cursor, (int64_t)byte_count);
-      else
-        vim_snprintf((char *)IObuff, IOSIZE,
-            _(
-                "Col %s of %s; Line %" PRId64 " of %" PRId64 "; Word %" PRId64
-                " of %" PRId64 "; Char %" PRId64 " of %" PRId64
-                "; Byte %" PRId64 " of %" PRId64 ""),
-            (char *)buf1, (char *)buf2,
-            (int64_t)curwin->w_cursor.lnum,
-            (int64_t)curbuf->b_ml.ml_line_count,
-            (int64_t)word_count_cursor, (int64_t)word_count,
-            (int64_t)char_count_cursor, (int64_t)char_count,
-            (int64_t)byte_count_cursor, (int64_t)byte_count);
     }
 
-    byte_count = bomb_size();
-    if (byte_count > 0)
-      sprintf((char *)IObuff + STRLEN(IObuff), _("(+%" PRId64 " for BOM)"),
-          (int64_t)byte_count);
-    /* Don't shorten this message, the user asked for it. */
-    p = p_shm;
-    p_shm = (char_u *)"";
-    msg(IObuff);
-    p_shm = p;
+    if (dict == NULL) {
+      if (l_VIsual_active) {
+        if (l_VIsual_mode == Ctrl_V && curwin->w_curswant < MAXCOL) {
+          getvcols(curwin, &min_pos, &max_pos, &min_pos.col, &max_pos.col);
+          vim_snprintf((char *)buf1, sizeof(buf1), _("%" PRId64 " Cols; "),
+                       (int64_t)(oparg.end_vcol - oparg.start_vcol + 1));
+        } else {
+          buf1[0] = NUL;
+        }
+
+        if (char_count_cursor == byte_count_cursor
+            && char_count == byte_count) {
+          vim_snprintf((char *)IObuff, IOSIZE,
+                       _("Selected %s%" PRId64 " of %" PRId64 " Lines;"
+                         " %" PRId64 " of %" PRId64 " Words;"
+                         " %" PRId64 " of %" PRId64 " Bytes"),
+                       buf1, (int64_t)line_count_selected,
+                       (int64_t)curbuf->b_ml.ml_line_count,
+                       (int64_t)word_count_cursor, (int64_t)word_count,
+                       (int64_t)byte_count_cursor, (int64_t)byte_count);
+        } else {
+          vim_snprintf((char *)IObuff, IOSIZE,
+                       _("Selected %s%" PRId64 " of %" PRId64 " Lines;"
+                         " %" PRId64 " of %" PRId64 " Words;"
+                         " %" PRId64 " of %" PRId64 " Chars;"
+                         " %" PRId64 " of %" PRId64 " Bytes"),
+                       buf1, (int64_t)line_count_selected,
+                       (int64_t)curbuf->b_ml.ml_line_count,
+                       (int64_t)word_count_cursor, (int64_t)word_count,
+                       (int64_t)char_count_cursor, (int64_t)char_count,
+                       (int64_t)byte_count_cursor, (int64_t)byte_count);
+        }
+      } else {
+        p = get_cursor_line_ptr();
+        validate_virtcol();
+        col_print(buf1, sizeof(buf1), (int)curwin->w_cursor.col + 1,
+                  (int)curwin->w_virtcol + 1);
+        col_print(buf2, sizeof(buf2), (int)STRLEN(p), linetabsize(p));
+
+        if (char_count_cursor == byte_count_cursor
+            && char_count == byte_count) {
+          vim_snprintf((char *)IObuff, IOSIZE,
+                       _("Col %s of %s; Line %" PRId64 " of %" PRId64 ";"
+                         " Word %" PRId64 " of %" PRId64 ";"
+                         " Byte %" PRId64 " of %" PRId64 ""),
+                       (char *)buf1, (char *)buf2,
+                       (int64_t)curwin->w_cursor.lnum,
+                       (int64_t)curbuf->b_ml.ml_line_count,
+                       (int64_t)word_count_cursor, (int64_t)word_count,
+                       (int64_t)byte_count_cursor, (int64_t)byte_count);
+        } else {
+          vim_snprintf((char *)IObuff, IOSIZE,
+                       _("Col %s of %s; Line %" PRId64 " of %" PRId64 ";"
+                         " Word %" PRId64 " of %" PRId64 ";"
+                         " Char %" PRId64 " of %" PRId64 ";"
+                         " Byte %" PRId64 " of %" PRId64 ""),
+                       (char *)buf1, (char *)buf2,
+                       (int64_t)curwin->w_cursor.lnum,
+                       (int64_t)curbuf->b_ml.ml_line_count,
+                       (int64_t)word_count_cursor, (int64_t)word_count,
+                       (int64_t)char_count_cursor, (int64_t)char_count,
+                       (int64_t)byte_count_cursor, (int64_t)byte_count);
+        }
+      }
+    }
+
+    // Don't shorten this message, the user asked for it.
+    bom_count = bomb_size();
+    if (bom_count > 0) {
+      vim_snprintf((char *)IObuff + STRLEN(IObuff), IOSIZE - STRLEN(IObuff),
+                   _("(+%" PRId64 " for BOM)"), (int64_t)byte_count);
+    }
+    if (dict == NULL) {
+      p = p_shm;
+      p_shm = (char_u *)"";
+      msg(IObuff);
+      p_shm = p;
+    }
+  }
+
+  if (dict != NULL) {
+    dict_add_nr_str(dict, "words", word_count, NULL);
+    dict_add_nr_str(dict, "chars", char_count, NULL);
+    dict_add_nr_str(dict, "bytes", byte_count + bom_count, NULL);
+
+    if (l_VIsual_active) {
+      dict_add_nr_str(dict, "visual_bytes", byte_count_cursor, NULL);
+      dict_add_nr_str(dict, "visual_chars", char_count_cursor, NULL);
+      dict_add_nr_str(dict, "visual_words", word_count_cursor, NULL);
+    } else {
+      dict_add_nr_str(dict, "cursor_bytes", byte_count_cursor, NULL);
+      dict_add_nr_str(dict, "cursor_chars", char_count_cursor, NULL);
+      dict_add_nr_str(dict, "cursor_words", word_count_cursor, NULL);
+    }
   }
 }
 

src/nvim/version.c

@@ -636,7 +636,7 @@ static int included_patches[] = {
   // 1045 NA
   // 1044 NA
   // 1043 NA
-  // 1042,
+  1042,
   1041,
   // 1040 NA
   // 1039,