To: vim-dev@vim.org

Subject: Patch 7.1.256

Fcc: outbox

From: Bram Moolenaar <Bram@moolenaar.net>

Mime-Version: 1.0

Content-Type: text/plain; charset=ISO-8859-1

Content-Transfer-Encoding: 8bit

------------

Patch 7.1.256

Problem:    findfile() also returns directories.

Solution:   Cleanup the code for finding files and directories in a list of

            directories.  Remove the ugly global ff_search_ctx.

Files:      src/eval.c, src/misc2.c, src/vim.h, src/tag.c

*** ../vim-7.1.255/src/eval.c	Wed Feb 13 12:41:30 2008

--- src/eval.c	Wed Feb 20 11:08:21 2008

***************

*** 9203,9215 ****

      rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));

  }

! static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int dir));

      static void

! findfilendir(argvars, rettv, dir)

      typval_T	*argvars;

      typval_T	*rettv;

!     int		dir;

  {

  #ifdef FEAT_SEARCHPATH

      char_u	*fname;

--- 9205,9217 ----

      rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));

  }

! static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));

      static void

! findfilendir(argvars, rettv, find_what)

      typval_T	*argvars;

      typval_T	*rettv;

!     int		find_what;

  {

  #ifdef FEAT_SEARCHPATH

      char_u	*fname;

***************

*** 9254,9261 ****

  		vim_free(fresult);

  	    fresult = find_file_in_path_option(first ? fname : NULL,

  					       first ? (int)STRLEN(fname) : 0,

! 					0, first, path, dir, curbuf->b_ffname,

! 					dir ? (char_u *)"" : curbuf->b_p_sua);

  	    first = FALSE;

  	    if (fresult != NULL && rettv->v_type == VAR_LIST)

--- 9256,9266 ----

  		vim_free(fresult);

  	    fresult = find_file_in_path_option(first ? fname : NULL,

  					       first ? (int)STRLEN(fname) : 0,

! 					0, first, path,

! 					find_what,

! 					curbuf->b_ffname,

! 					find_what == FINDFILE_DIR

! 					    ? (char_u *)"" : curbuf->b_p_sua);

  	    first = FALSE;

  	    if (fresult != NULL && rettv->v_type == VAR_LIST)

***************

*** 9445,9451 ****

      typval_T	*argvars;

      typval_T	*rettv;

  {

!     findfilendir(argvars, rettv, TRUE);

  }

  /*

--- 9450,9456 ----

      typval_T	*argvars;

      typval_T	*rettv;

  {

!     findfilendir(argvars, rettv, FINDFILE_DIR);

  }

  /*

***************

*** 9456,9462 ****

      typval_T	*argvars;

      typval_T	*rettv;

  {

!     findfilendir(argvars, rettv, FALSE);

  }

  /*

--- 9461,9467 ----

      typval_T	*argvars;

      typval_T	*rettv;

  {

!     findfilendir(argvars, rettv, FINDFILE_FILE);

  }

  /*

*** ../vim-7.1.255/src/misc2.c	Fri Jan  4 21:25:01 2008

--- src/misc2.c	Wed Feb 13 17:19:21 2008

***************

*** 3777,3785 ****

      char_u		ffs_filearray_cur;   /* needed for partly handled dirs */

      /* to store status of partly handled directories

!      * 0: we work the on this directory for the first time

       * 1: this directory was partly searched in an earlier step

!     */

      int			ffs_stage;

      /* How deep are we in the directory tree?

--- 3778,3786 ----

      char_u		ffs_filearray_cur;   /* needed for partly handled dirs */

      /* to store status of partly handled directories

!      * 0: we work on this directory for the first time

       * 1: this directory was partly searched in an earlier step

!      */

      int			ffs_stage;

      /* How deep are we in the directory tree?

***************

*** 3848,3853 ****

--- 3849,3855 ----

   * Set the default maximum depth.

   */

  #define FF_MAX_STAR_STAR_EXPAND ((char_u)30)

+ 

  /*

   * The search context:

   *   ffsc_stack_ptr:	the stack for the dirs to search

***************

*** 3862,3868 ****

   *   ffsc_wc_path:	the part of the given path containing wildcards

   *   ffsc_level:	how many levels of dirs to search downwards

   *   ffsc_stopdirs_v:	array of stop directories for upward search

!  *   ffsc_need_dir:	TRUE if we search for a directory

   */

  typedef struct ff_search_ctx_T

  {

--- 3864,3870 ----

   *   ffsc_wc_path:	the part of the given path containing wildcards

   *   ffsc_level:	how many levels of dirs to search downwards

   *   ffsc_stopdirs_v:	array of stop directories for upward search

!  *   ffsc_find_what:	FINDFILE_BOTH, FINDFILE_DIR or FINDFILE_FILE

   */

  typedef struct ff_search_ctx_T

  {

***************

*** 3879,3889 ****

       int			ffsc_level;

       char_u			**ffsc_stopdirs_v;

  #endif

!      int			ffsc_need_dir;

  } ff_search_ctx_T;

- static ff_search_ctx_T *ff_search_ctx = NULL;

- 

  /* locally needed functions */

  #ifdef FEAT_PATH_EXTRA

  static int ff_check_visited __ARGS((ff_visited_T **, char_u *, char_u *));

--- 3881,3889 ----

       int			ffsc_level;

       char_u			**ffsc_stopdirs_v;

  #endif

!      int			ffsc_find_what;

  } ff_search_ctx_T;

  /* locally needed functions */

  #ifdef FEAT_PATH_EXTRA

  static int ff_check_visited __ARGS((ff_visited_T **, char_u *, char_u *));

***************

*** 3897,3906 ****

  static int ff_wc_equal __ARGS((char_u *s1, char_u *s2));

  #endif

! static void ff_push __ARGS((ff_stack_T *));

! static ff_stack_T * ff_pop __ARGS((void));

! static void ff_clear __ARGS((void));

! static void ff_free_stack_element __ARGS((ff_stack_T *));

  #ifdef FEAT_PATH_EXTRA

  static ff_stack_T *ff_create_stack_element __ARGS((char_u *, char_u *, int, int));

  #else

--- 3897,3906 ----

  static int ff_wc_equal __ARGS((char_u *s1, char_u *s2));

  #endif

! static void ff_push __ARGS((ff_search_ctx_T *search_ctx, ff_stack_T *stack_ptr));

! static ff_stack_T *ff_pop __ARGS((ff_search_ctx_T *search_ctx));

! static void ff_clear __ARGS((ff_search_ctx_T *search_ctx));

! static void ff_free_stack_element __ARGS((ff_stack_T *stack_ptr));

  #ifdef FEAT_PATH_EXTRA

  static ff_stack_T *ff_create_stack_element __ARGS((char_u *, char_u *, int, int));

  #else

***************

*** 3961,3966 ****

--- 3961,3969 ----

   * not related to restricts given to the '**' wildcard. If 'level' is 100

   * and you use '**200' vim_findfile() will stop after 100 levels.

   *

+  * 'filename' cannot contain wildcards!  It is used as-is, no backslashes to

+  * escape special characters.

+  *

   * If 'stopdirs' is not NULL and nothing is found downward, the search is

   * restarted on the next higher directory level. This is repeated until the

   * start-directory of a search is contained in 'stopdirs'. 'stopdirs' has the

***************

*** 3980,4053 ****

   * The list of visited files/dirs can also be cleared with the function

   * vim_findfile_free_visited().

   *

!  * Set the parameter 'need_dir' to TRUE if you want to search for a directory

!  * instead of a file.

   *

   * A search context returned by a previous call to vim_findfile_init() can be

!  * passed in the parameter 'search_ctx'. This context is than reused and

!  * reinitialized with the new parameters. The list of already viseted

   * directories from this context is only deleted if the parameter

!  * 'free_visited' is true. Be aware that the passed search_context is freed if

!  * the reinitialization fails.

   *

!  * If you don't have a search context from a previous call 'search_ctx' must be

!  * NULL.

   *

   * This function silently ignores a few errors, vim_findfile() will have

   * limited functionality then.

   */

  /*ARGSUSED*/

      void *

! vim_findfile_init(path, filename, stopdirs, level, free_visited, need_dir,

! 						search_ctx, tagfile, rel_fname)

      char_u	*path;

      char_u	*filename;

      char_u	*stopdirs;

      int		level;

      int		free_visited;

!     int		need_dir;

!     void	*search_ctx;

      int		tagfile;

      char_u	*rel_fname;	/* file name to use for "." */

  {

  #ifdef FEAT_PATH_EXTRA

!     char_u	*wc_part;

  #endif

!     ff_stack_T	*sptr;

      /* If a search context is given by the caller, reuse it, else allocate a

       * new one.

       */

!     if (search_ctx != NULL)

! 	ff_search_ctx = search_ctx;

      else

      {

! 	ff_search_ctx = (ff_search_ctx_T*)alloc(

! 					   (unsigned)sizeof(ff_search_ctx_T));

! 	if (ff_search_ctx == NULL)

  	    goto error_return;

! 	memset(ff_search_ctx, 0, sizeof(ff_search_ctx_T));

      }

      /* clear the search context, but NOT the visited lists */

!     ff_clear();

      /* clear visited list if wanted */

      if (free_visited == TRUE)

! 	vim_findfile_free_visited(ff_search_ctx);

      else

      {

  	/* Reuse old visited lists. Get the visited list for the given

  	 * filename. If no list for the current filename exists, creates a new

! 	 * one.

! 	 */

! 	ff_search_ctx->ffsc_visited_list = ff_get_visited_list(filename,

! 				     &ff_search_ctx->ffsc_visited_lists_list);

! 	if (ff_search_ctx->ffsc_visited_list == NULL)

  	    goto error_return;

! 	ff_search_ctx->ffsc_dir_visited_list = ff_get_visited_list(filename,

! 				 &ff_search_ctx->ffsc_dir_visited_lists_list);

! 	if (ff_search_ctx->ffsc_dir_visited_list == NULL)

  	    goto error_return;

      }

--- 3983,4056 ----

   * The list of visited files/dirs can also be cleared with the function

   * vim_findfile_free_visited().

   *

!  * Set the parameter 'find_what' to FINDFILE_DIR if you want to search for

!  * directories only, FINDFILE_FILE for files only, FINDFILE_BOTH for both.

   *

   * A search context returned by a previous call to vim_findfile_init() can be

!  * passed in the parameter "search_ctx_arg".  This context is reused and

!  * reinitialized with the new parameters.  The list of already visited

   * directories from this context is only deleted if the parameter

!  * "free_visited" is true.  Be aware that the passed "search_ctx_arg" is freed

!  * if the reinitialization fails.

   *

!  * If you don't have a search context from a previous call "search_ctx_arg"

!  * must be NULL.

   *

   * This function silently ignores a few errors, vim_findfile() will have

   * limited functionality then.

   */

  /*ARGSUSED*/

      void *

! vim_findfile_init(path, filename, stopdirs, level, free_visited, find_what,

! 					   search_ctx_arg, tagfile, rel_fname)

      char_u	*path;

      char_u	*filename;

      char_u	*stopdirs;

      int		level;

      int		free_visited;

!     int		find_what;

!     void	*search_ctx_arg;

      int		tagfile;

      char_u	*rel_fname;	/* file name to use for "." */

  {

  #ifdef FEAT_PATH_EXTRA

!     char_u		*wc_part;

  #endif

!     ff_stack_T		*sptr;

!     ff_search_ctx_T	*search_ctx;

      /* If a search context is given by the caller, reuse it, else allocate a

       * new one.

       */

!     if (search_ctx_arg != NULL)

! 	search_ctx = search_ctx_arg;

      else

      {

! 	search_ctx = (ff_search_ctx_T*)alloc((unsigned)sizeof(ff_search_ctx_T));

! 	if (search_ctx == NULL)

  	    goto error_return;

! 	memset(search_ctx, 0, sizeof(ff_search_ctx_T));

      }

+     search_ctx->ffsc_find_what = find_what;

      /* clear the search context, but NOT the visited lists */

!     ff_clear(search_ctx);

      /* clear visited list if wanted */

      if (free_visited == TRUE)

! 	vim_findfile_free_visited(search_ctx);

      else

      {

  	/* Reuse old visited lists. Get the visited list for the given

  	 * filename. If no list for the current filename exists, creates a new

! 	 * one. */

! 	search_ctx->ffsc_visited_list = ff_get_visited_list(filename,

! 					&search_ctx->ffsc_visited_lists_list);

! 	if (search_ctx->ffsc_visited_list == NULL)

  	    goto error_return;

! 	search_ctx->ffsc_dir_visited_list = ff_get_visited_list(filename,

! 				    &search_ctx->ffsc_dir_visited_lists_list);

! 	if (search_ctx->ffsc_dir_visited_list == NULL)

  	    goto error_return;

      }

***************

*** 4071,4082 ****

  	{

  	    /* Make the start dir an absolute path name. */

  	    vim_strncpy(ff_expand_buffer, rel_fname, len);

! 	    ff_search_ctx->ffsc_start_dir = FullName_save(ff_expand_buffer,

! 								       FALSE);

  	}

  	else

! 	    ff_search_ctx->ffsc_start_dir = vim_strnsave(rel_fname, len);

! 	if (ff_search_ctx->ffsc_start_dir == NULL)

  	    goto error_return;

  	if (*++path != NUL)

  	    ++path;

--- 4074,4084 ----

  	{

  	    /* Make the start dir an absolute path name. */

  	    vim_strncpy(ff_expand_buffer, rel_fname, len);

! 	    search_ctx->ffsc_start_dir = FullName_save(ff_expand_buffer, FALSE);

  	}

  	else

! 	    search_ctx->ffsc_start_dir = vim_strnsave(rel_fname, len);

! 	if (search_ctx->ffsc_start_dir == NULL)

  	    goto error_return;

  	if (*++path != NUL)

  	    ++path;

***************

*** 4101,4108 ****

  	if (mch_dirname(ff_expand_buffer, MAXPATHL) == FAIL)

  	    goto error_return;

! 	ff_search_ctx->ffsc_start_dir = vim_strsave(ff_expand_buffer);

! 	if (ff_search_ctx->ffsc_start_dir == NULL)

  	    goto error_return;

  #ifdef BACKSLASH_IN_FILENAME

--- 4103,4110 ----

  	if (mch_dirname(ff_expand_buffer, MAXPATHL) == FAIL)

  	    goto error_return;

! 	search_ctx->ffsc_start_dir = vim_strsave(ff_expand_buffer);

! 	if (search_ctx->ffsc_start_dir == NULL)

  	    goto error_return;

  #ifdef BACKSLASH_IN_FILENAME

***************

*** 4110,4117 ****

  	 * directory (but not for "//machine/dir").  Only use the drive name. */

  	if ((*path == '/' || *path == '\\')

  		&& path[1] != path[0]

! 		&& ff_search_ctx->ffsc_start_dir[1] == ':')

! 	    ff_search_ctx->ffsc_start_dir[2] = NUL;

  #endif

      }

--- 4112,4119 ----

  	 * directory (but not for "//machine/dir").  Only use the drive name. */

  	if ((*path == '/' || *path == '\\')

  		&& path[1] != path[0]

! 		&& search_ctx->ffsc_start_dir[1] == ':')

! 	    search_ctx->ffsc_start_dir[2] = NUL;

  #endif

      }

***************

*** 4121,4127 ****

       * If this fails (mem allocation), there is no upward search at all or a

       * stop directory is not recognized -> continue silently.

       * If stopdirs just contains a ";" or is empty,

!      * ff_search_ctx->ffsc_stopdirs_v will only contain a  NULL pointer. This

       * is handled as unlimited upward search.  See function

       * ff_path_in_stoplist() for details.

       */

--- 4123,4129 ----

       * If this fails (mem allocation), there is no upward search at all or a

       * stop directory is not recognized -> continue silently.

       * If stopdirs just contains a ";" or is empty,

!      * search_ctx->ffsc_stopdirs_v will only contain a  NULL pointer. This

       * is handled as unlimited upward search.  See function

       * ff_path_in_stoplist() for details.

       */

***************

*** 4134,4143 ****

  	    walker++;

  	dircount = 1;

! 	ff_search_ctx->ffsc_stopdirs_v =

! 	    (char_u **)alloc((unsigned)sizeof(char_u *));

! 	if (ff_search_ctx->ffsc_stopdirs_v != NULL)

  	{

  	    do

  	    {

--- 4136,4145 ----

  	    walker++;

  	dircount = 1;

! 	search_ctx->ffsc_stopdirs_v =

! 				 (char_u **)alloc((unsigned)sizeof(char_u *));

! 	if (search_ctx->ffsc_stopdirs_v != NULL)

  	{

  	    do

  	    {

***************

*** 4145,4181 ****

  		void	*ptr;

  		helper = walker;

! 		ptr = vim_realloc(ff_search_ctx->ffsc_stopdirs_v,

  					   (dircount + 1) * sizeof(char_u *));

  		if (ptr)

! 		    ff_search_ctx->ffsc_stopdirs_v = ptr;

  		else

  		    /* ignore, keep what we have and continue */

  		    break;

  		walker = vim_strchr(walker, ';');

  		if (walker)

  		{

! 		    ff_search_ctx->ffsc_stopdirs_v[dircount-1] =

! 			vim_strnsave(helper, (int)(walker - helper));

  		    walker++;

  		}

  		else

  		    /* this might be "", which means ascent till top

  		     * of directory tree.

  		     */

! 		    ff_search_ctx->ffsc_stopdirs_v[dircount-1] =

! 			vim_strsave(helper);

  		dircount++;

  	    } while (walker != NULL);

! 	    ff_search_ctx->ffsc_stopdirs_v[dircount-1] = NULL;

  	}

      }

  #endif

  #ifdef FEAT_PATH_EXTRA

!     ff_search_ctx->ffsc_level = level;

      /* split into:

       *  -fix path

--- 4147,4183 ----

  		void	*ptr;

  		helper = walker;

! 		ptr = vim_realloc(search_ctx->ffsc_stopdirs_v,

  					   (dircount + 1) * sizeof(char_u *));

  		if (ptr)

! 		    search_ctx->ffsc_stopdirs_v = ptr;

  		else

  		    /* ignore, keep what we have and continue */

  		    break;

  		walker = vim_strchr(walker, ';');

  		if (walker)

  		{

! 		    search_ctx->ffsc_stopdirs_v[dircount-1] =

! 				 vim_strnsave(helper, (int)(walker - helper));

  		    walker++;

  		}

  		else

  		    /* this might be "", which means ascent till top

  		     * of directory tree.

  		     */

! 		    search_ctx->ffsc_stopdirs_v[dircount-1] =

! 							  vim_strsave(helper);

  		dircount++;

  	    } while (walker != NULL);

! 	    search_ctx->ffsc_stopdirs_v[dircount-1] = NULL;

  	}

      }

  #endif

  #ifdef FEAT_PATH_EXTRA

!     search_ctx->ffsc_level = level;

      /* split into:

       *  -fix path

***************

*** 4189,4196 ****

  	char	*errpt;

  	/* save the fix part of the path */

! 	ff_search_ctx->ffsc_fix_path = vim_strnsave(path,

! 						       (int)(wc_part - path));

  	/*

  	 * copy wc_path and add restricts to the '**' wildcard.

--- 4191,4197 ----

  	char	*errpt;

  	/* save the fix part of the path */

! 	search_ctx->ffsc_fix_path = vim_strnsave(path, (int)(wc_part - path));

  	/*

  	 * copy wc_path and add restricts to the '**' wildcard.

***************

*** 4229,4275 ****

  		ff_expand_buffer[len++] = *wc_part++;

  	}

  	ff_expand_buffer[len] = NUL;

! 	ff_search_ctx->ffsc_wc_path = vim_strsave(ff_expand_buffer);

! 	if (ff_search_ctx->ffsc_wc_path == NULL)

  	    goto error_return;

      }

      else

  #endif

! 	ff_search_ctx->ffsc_fix_path = vim_strsave(path);

!     if (ff_search_ctx->ffsc_start_dir == NULL)

      {

  	/* store the fix part as startdir.

  	 * This is needed if the parameter path is fully qualified.

  	 */

! 	ff_search_ctx->ffsc_start_dir = vim_strsave(ff_search_ctx->ffsc_fix_path);

! 	if (ff_search_ctx->ffsc_start_dir)

! 	    ff_search_ctx->ffsc_fix_path[0] = NUL;

      }

      /* create an absolute path */

!     STRCPY(ff_expand_buffer, ff_search_ctx->ffsc_start_dir);

      add_pathsep(ff_expand_buffer);

!     STRCAT(ff_expand_buffer, ff_search_ctx->ffsc_fix_path);

      add_pathsep(ff_expand_buffer);

      sptr = ff_create_stack_element(ff_expand_buffer,

  #ifdef FEAT_PATH_EXTRA

! 	    ff_search_ctx->ffsc_wc_path,

  #endif

  	    level, 0);

      if (sptr == NULL)

  	goto error_return;

!     ff_push(sptr);

!     ff_search_ctx->ffsc_file_to_search = vim_strsave(filename);

!     if (ff_search_ctx->ffsc_file_to_search == NULL)

  	goto error_return;

!     return ff_search_ctx;

  error_return:

      /*

--- 4230,4276 ----

  		ff_expand_buffer[len++] = *wc_part++;

  	}

  	ff_expand_buffer[len] = NUL;

! 	search_ctx->ffsc_wc_path = vim_strsave(ff_expand_buffer);

! 	if (search_ctx->ffsc_wc_path == NULL)

  	    goto error_return;

      }

      else

  #endif

! 	search_ctx->ffsc_fix_path = vim_strsave(path);

!     if (search_ctx->ffsc_start_dir == NULL)

      {

  	/* store the fix part as startdir.

  	 * This is needed if the parameter path is fully qualified.

  	 */

! 	search_ctx->ffsc_start_dir = vim_strsave(search_ctx->ffsc_fix_path);

! 	if (search_ctx->ffsc_start_dir)

! 	    search_ctx->ffsc_fix_path[0] = NUL;

      }

      /* create an absolute path */

!     STRCPY(ff_expand_buffer, search_ctx->ffsc_start_dir);

      add_pathsep(ff_expand_buffer);

!     STRCAT(ff_expand_buffer, search_ctx->ffsc_fix_path);

      add_pathsep(ff_expand_buffer);

      sptr = ff_create_stack_element(ff_expand_buffer,

  #ifdef FEAT_PATH_EXTRA

! 	    search_ctx->ffsc_wc_path,

  #endif

  	    level, 0);

      if (sptr == NULL)

  	goto error_return;

!     ff_push(search_ctx, sptr);

!     search_ctx->ffsc_file_to_search = vim_strsave(filename);

!     if (search_ctx->ffsc_file_to_search == NULL)

  	goto error_return;

!     return search_ctx;

  error_return:

      /*

***************

*** 4277,4283 ****

       * Even when the caller gave us a (perhaps valid) context we free it here,

       * as we might have already destroyed it.

       */

!     vim_findfile_cleanup(ff_search_ctx);

      return NULL;

  }

--- 4278,4284 ----

       * Even when the caller gave us a (perhaps valid) context we free it here,

       * as we might have already destroyed it.

       */

!     vim_findfile_cleanup(search_ctx);

      return NULL;

  }

***************

*** 4314,4320 ****

  }

  #endif

! /* Clean up the given search context. Can handle a NULL pointer */

      void

  vim_findfile_cleanup(ctx)

      void	*ctx;

--- 4315,4323 ----

  }

  #endif

! /*

!  * Clean up the given search context. Can handle a NULL pointer.

!  */

      void

  vim_findfile_cleanup(ctx)

      void	*ctx;

***************

*** 4322,4333 ****

      if (ctx == NULL)

  	return;

-     ff_search_ctx = ctx;

- 

      vim_findfile_free_visited(ctx);

!     ff_clear();

      vim_free(ctx);

-     ff_search_ctx = NULL;

  }

  /*

--- 4325,4333 ----

      if (ctx == NULL)

  	return;

      vim_findfile_free_visited(ctx);

!     ff_clear(ctx);

      vim_free(ctx);

  }