changeset 8388:f5972de59001 v7.4.1486

commit https://github.com/vim/vim/commit/f3654827368e6204608036353a0360e9e7c21e02 Author: Bram Moolenaar <Bram@vim.org> Date: Fri Mar 4 22:12:23 2016 +0100 patch 7.4.1486 Problem: ":loadplugin" is not optimal, some people find it confusing. Solution: Only use ":packadd" with an optional "!".
author Christian Brabandt <cb@256bit.org>
date Fri, 04 Mar 2016 22:15:04 +0100
parents e0b156d7b321
children 45859983b3c3
files runtime/doc/repeat.txt src/ex_cmds.h src/ex_cmds2.c src/testdir/Make_all.mak src/testdir/test_loadplugin.vim src/testdir/test_packadd.vim src/version.c
diffstat 7 files changed, 152 insertions(+), 148 deletions(-) [+]
line wrap: on
line diff
--- a/runtime/doc/repeat.txt
+++ b/runtime/doc/repeat.txt
@@ -433,6 +433,12 @@ You would now have these files under ~/.
 	pack/my/ever/always/syntax/always.vim
 	pack/my/opt/mydebug/plugin/debugger.vim
 
+If you don't have a package but a single plugin, you need to create the extra
+directory level:
+	% mkdir -p ~/.vim/pack/my/ever/always
+	% cd ~/.vim/pack/my/ever/always
+	% unzip /tmp/myplugin.zip
+
 When Vim starts up it scans all directories in 'packpath' for plugins under the
 "ever" directory and loads them.  When found that directory is added to
 'runtimepath'.
@@ -443,11 +449,11 @@ In the example Vim will find "my/ever/al
 If the "always" plugin kicks in and sets the 'filetype' to "always", Vim will
 find the syntax/always.vim file, because its directory is in 'runtimepath'.
 
-Vim will also load ftdetect files, like with |:loadplugin|.
+Vim will also load ftdetect files, like with |:packadd|.
 
-							*load-plugin*
-To load an optional plugin from a pack use the `:loadplugin` command: >
-	:loadplugin mydebug
+							*pack-add*
+To load an optional plugin from a pack use the `:packadd` command: >
+	:packadd mydebug
 This could be done inside always.vim, if some conditions are met.
 Or you could add this command to your |.vimrc|.
 
--- a/src/ex_cmds.h
+++ b/src/ex_cmds.h
@@ -810,9 +810,6 @@ EX(CMD_loadview,	"loadview",	ex_loadview
 EX(CMD_loadkeymap,	"loadkeymap",	ex_loadkeymap,
 			CMDWIN,
 			ADDR_LINES),
-EX(CMD_loadplugin,	"loadplugin",	ex_loadplugin,
-			BANG|FILE1|TRLBAR|SBOXOK|CMDWIN,
-			ADDR_LINES),
 EX(CMD_lockmarks,	"lockmarks",	ex_wrongmodifier,
 			NEEDARG|EXTRA|NOTRLCOM,
 			ADDR_LINES),
--- a/src/ex_cmds2.c
+++ b/src/ex_cmds2.c
@@ -3057,88 +3057,75 @@ do_in_runtimepath(
     return do_in_path(p_rtp, name, all ? DIP_ALL : 0, callback, cookie);
 }
 
-#ifdef FEAT_AUTOCMD
 /*
- * Source filetype detection scripts, if filetype.vim was already done.
+ * Expand wildcards in "pat" and invoke do_source() for each match.
  */
     static void
-may_do_filetypes(char_u *pat)
+source_all_matches(char_u *pat)
 {
-    char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
-
-    /* If runtime/filetype.vim wasn't loaded yet, the scripts will be found
-     * when it loads. */
-    if (cmd != NULL && eval_to_number(cmd) > 0)
+    int	    num_files;
+    char_u  **files;
+    int	    i;
+
+    if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK)
     {
-	do_cmdline_cmd((char_u *)"augroup filetypedetect");
-	do_in_path(p_pp, pat, DIP_ALL, source_callback, NULL);
-	do_cmdline_cmd((char_u *)"augroup END");
+	for (i = 0; i < num_files; ++i)
+	    (void)do_source(files[i], FALSE, DOSO_NONE);
+	FreeWild(num_files, files);
     }
-    vim_free(cmd);
 }
-#endif
 
     static void
 add_pack_plugin(char_u *fname, void *cookie)
 {
-    char_u  *p6, *p5, *p4, *p3, *p2, *p1, *p;
+    char_u  *p4, *p3, *p2, *p1, *p;
+    char_u  *insp;
     int	    c;
     char_u  *new_rtp;
     int	    keep;
     int	    oldlen;
     int	    addlen;
     char_u  *ffname = fix_fname(fname);
-    int	    load_file = cookie != NULL;
+    int	    load_files = cookie != NULL;
 
     if (ffname == NULL)
 	return;
-    p6 = p5 = p4 = p3 = p2 = p1 = get_past_head(ffname);
-    for (p = p1; *p; mb_ptr_adv(p))
-	if (vim_ispathsep_nocolon(*p))
-	{
-	    p6 = p5; p5 = p4; p4 = p3; p3 = p2; p2 = p1; p1 = p;
-	}
-
-    /* now we have, load_file == TRUE:
-     * rtp/pack/name/ever/name/plugin/name.vim
-     *    p6   p5   p4   p3   p2     p1
-     *
-     * with load_file == FALSE:
-     * rtp/pack/name/ever/name
-     *    p4   p3   p2   p1
-     */
-    if (load_file)
-	p4 = p6;
-
-    /* find the part up to "pack" in 'runtimepath' */
-    c = *p4;
-    *p4 = NUL;
-    p = (char_u *)strstr((char *)p_rtp, (char *)ffname);
-    if (p == NULL)
-	/* not found, append at the end */
-	p = p_rtp + STRLEN(p_rtp);
-    else
-	/* append after the matching directory. */
-	p += STRLEN(ffname);
-    *p4 = c;
-
-    if (load_file)
-    {
-	c = *p2;
-	*p2 = NUL;
-    }
     if (strstr((char *)p_rtp, (char *)ffname) == NULL)
     {
 	/* directory not in 'runtimepath', add it */
+	p4 = p3 = p2 = p1 = get_past_head(ffname);
+	for (p = p1; *p; mb_ptr_adv(p))
+	    if (vim_ispathsep_nocolon(*p))
+	    {
+		p4 = p3; p3 = p2; p2 = p1; p1 = p;
+	    }
+
+	/* now we have:
+	 * rtp/pack/name/ever/name
+	 *    p4   p3   p2   p1
+	 *
+	 * find the part up to "pack" in 'runtimepath' */
+	c = *p4;
+	*p4 = NUL;
+	insp = (char_u *)strstr((char *)p_rtp, (char *)ffname);
+	if (insp == NULL)
+	    /* not found, append at the end */
+	    insp = p_rtp + STRLEN(p_rtp);
+	else
+	{
+	    /* append after the matching directory. */
+	    insp += STRLEN(ffname);
+	    while (*insp != NUL && *insp != ',')
+		++insp;
+	}
+	*p4 = c;
+
 	oldlen = (int)STRLEN(p_rtp);
 	addlen = (int)STRLEN(ffname);
 	new_rtp = alloc(oldlen + addlen + 2);
 	if (new_rtp == NULL)
-	{
-	    *p2 = c;
-	    return;
-	}
-	keep = (int)(p - p_rtp);
+	    goto theend;
+	keep = (int)(insp - p_rtp);
 	mch_memmove(new_rtp, p_rtp, keep);
 	new_rtp[keep] = ',';
 	mch_memmove(new_rtp + keep + 1, ffname, addlen + 1);
@@ -3148,53 +3135,55 @@ add_pack_plugin(char_u *fname, void *coo
 	set_option_value((char_u *)"rtp", 0L, new_rtp, 0);
 	vim_free(new_rtp);
     }
+
+    if (load_files)
+    {
+	static char *plugpat = "%s/plugin/*.vim";
+	static char *ftpat = "%s/ftdetect/*.vim";
+	int	    len;
+	char_u	    *pat;
+
+	len = (int)STRLEN(ffname) + (int)STRLEN(ftpat);
+	pat = alloc(len);
+	if (pat == NULL)
+	    goto theend;
+	vim_snprintf((char *)pat, len, plugpat, ffname);
+	source_all_matches(pat);
+
+#ifdef FEAT_AUTOCMD
+	{
+	    char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
+
+	    /* If runtime/filetype.vim wasn't loaded yet, the scripts will be
+	     * found when it loads. */
+	    if (cmd != NULL && eval_to_number(cmd) > 0)
+	    {
+		do_cmdline_cmd((char_u *)"augroup filetypedetect");
+		vim_snprintf((char *)pat, len, ftpat, ffname);
+		source_all_matches(pat);
+		do_cmdline_cmd((char_u *)"augroup END");
+	    }
+	    vim_free(cmd);
+	}
+#endif
+    }
+
+theend:
     vim_free(ffname);
-
-    if (load_file)
-	(void)do_source(fname, FALSE, DOSO_NONE);
 }
 
 /*
- * Source the plugins in the package directories.
+ * Find plugins in the package directories and source them.
  */
     void
 source_packages()
 {
-    do_in_path(p_pp, (char_u *)"pack/*/ever/*/plugin/*.vim",
-					      DIP_ALL, add_pack_plugin, p_pp);
-#ifdef FEAT_AUTOCMD
-    may_do_filetypes((char_u *)"pack/*/ever/*/ftdetect/*.vim");
-#endif
+    do_in_path(p_pp, (char_u *)"pack/*/ever/*",
+				    DIP_ALL + DIP_DIR, add_pack_plugin, p_pp);
 }
 
 /*
- * ":loadplugin {name}"
- */
-    void
-ex_loadplugin(exarg_T *eap)
-{
-    static char *plugpat = "pack/*/opt/%s/plugin/*.vim";
-    static char *ftpat = "pack/*/opt/%s/ftdetect/*.vim";
-    int		len;
-    char	*pat;
-
-    len = (int)STRLEN(ftpat) + (int)STRLEN(eap->arg);
-    pat = (char *)alloc(len);
-    if (pat == NULL)
-	return;
-    vim_snprintf(pat, len, plugpat, eap->arg);
-    do_in_path(p_pp, (char_u *)pat, DIP_ALL, add_pack_plugin, p_pp);
-
-#ifdef FEAT_AUTOCMD
-    vim_snprintf(pat, len, ftpat, eap->arg);
-    may_do_filetypes((char_u *)pat);
-#endif
-
-    vim_free(pat);
-}
-
-/*
- * ":packadd {name}"
+ * ":packadd[!] {name}"
  */
     void
 ex_packadd(exarg_T *eap)
@@ -3208,7 +3197,8 @@ ex_packadd(exarg_T *eap)
     if (pat == NULL)
 	return;
     vim_snprintf(pat, len, plugpat, eap->arg);
-    do_in_path(p_pp, (char_u *)pat, DIP_ALL + DIP_DIR, add_pack_plugin, NULL);
+    do_in_path(p_pp, (char_u *)pat, DIP_ALL + DIP_DIR, add_pack_plugin,
+						  eap->forceit ? NULL : p_pp);
     vim_free(pat);
 }
 
--- a/src/testdir/Make_all.mak
+++ b/src/testdir/Make_all.mak
@@ -178,7 +178,7 @@ NEW_TESTS = test_arglist.res \
 	    test_increment.res \
 	    test_json.res \
 	    test_langmap.res \
-	    test_loadplugin.res \
+	    test_packadd.res \
 	    test_perl.res \
 	    test_quickfix.res \
 	    test_syntax.res \
deleted file mode 100644
--- a/src/testdir/test_loadplugin.vim
+++ /dev/null
@@ -1,48 +0,0 @@
-" Tests for :loadplugin
-
-func SetUp()
-  let s:topdir = expand('%:h') . '/Xdir'
-  exe 'set packpath=' . s:topdir
-  let s:plugdir = s:topdir . '/pack/mine/opt/mytest'
-endfunc
-
-func TearDown()
-  call delete(s:topdir, 'rf')
-endfunc
-
-func Test_loadplugin()
-  call mkdir(s:plugdir . '/plugin', 'p')
-  call mkdir(s:plugdir . '/ftdetect', 'p')
-  set rtp&
-  let rtp = &rtp
-  filetype on
-
-  exe 'split ' . s:plugdir . '/plugin/test.vim'
-  call setline(1, 'let g:plugin_works = 42')
-  wq
-
-  exe 'split ' . s:plugdir . '/ftdetect/test.vim'
-  call setline(1, 'let g:ftdetect_works = 17')
-  wq
-
-  loadplugin mytest
-
-  call assert_equal(42, g:plugin_works)
-  call assert_equal(17, g:ftdetect_works)
-  call assert_true(len(&rtp) > len(rtp))
-  call assert_true(&rtp =~ 'testdir/Xdir/pack/mine/opt/mytest\($\|,\)')
-endfunc
-
-func Test_packadd()
-  call mkdir(s:plugdir . '/syntax', 'p')
-  set rtp&
-  let rtp = &rtp
-  packadd mytest
-  call assert_true(len(&rtp) > len(rtp))
-  call assert_true(&rtp =~ 'testdir/Xdir/pack/mine/opt/mytest\($\|,\)')
-
-  " check the path is not added twice
-  let new_rtp = &rtp
-  packadd mytest
-  call assert_equal(new_rtp, &rtp)
-endfunc
new file mode 100644
--- /dev/null
+++ b/src/testdir/test_packadd.vim
@@ -0,0 +1,57 @@
+" Tests for 'packpath' and :packadd
+
+func SetUp()
+  let s:topdir = expand('%:h') . '/Xdir'
+  exe 'set packpath=' . s:topdir
+  let s:plugdir = s:topdir . '/pack/mine/opt/mytest'
+endfunc
+
+func TearDown()
+  call delete(s:topdir, 'rf')
+endfunc
+
+func Test_packadd()
+  call mkdir(s:plugdir . '/plugin', 'p')
+  call mkdir(s:plugdir . '/ftdetect', 'p')
+  set rtp&
+  let rtp = &rtp
+  filetype on
+
+  exe 'split ' . s:plugdir . '/plugin/test.vim'
+  call setline(1, 'let g:plugin_works = 42')
+  wq
+
+  exe 'split ' . s:plugdir . '/ftdetect/test.vim'
+  call setline(1, 'let g:ftdetect_works = 17')
+  wq
+
+  packadd mytest
+
+  call assert_equal(42, g:plugin_works)
+  call assert_equal(17, g:ftdetect_works)
+  call assert_true(len(&rtp) > len(rtp))
+  call assert_true(&rtp =~ 'testdir/Xdir/pack/mine/opt/mytest\($\|,\)')
+endfunc
+
+func Test_packadd_noload()
+  call mkdir(s:plugdir . '/plugin', 'p')
+  call mkdir(s:plugdir . '/syntax', 'p')
+  set rtp&
+  let rtp = &rtp
+
+  exe 'split ' . s:plugdir . '/plugin/test.vim'
+  call setline(1, 'let g:plugin_works = 42')
+  wq
+  let g:plugin_works = 0
+
+  packadd! mytest
+
+  call assert_true(len(&rtp) > len(rtp))
+  call assert_true(&rtp =~ 'testdir/Xdir/pack/mine/opt/mytest\($\|,\)')
+  call assert_equal(0, g:plugin_works)
+
+  " check the path is not added twice
+  let new_rtp = &rtp
+  packadd! mytest
+  call assert_equal(new_rtp, &rtp)
+endfunc
--- a/src/version.c
+++ b/src/version.c
@@ -744,6 +744,8 @@ static char *(features[]) =
 static int included_patches[] =
 {   /* Add new patch number below this line */
 /**/
+    1486,
+/**/
     1485,
 /**/
     1484,