neovim/src/garray.c

/// @file garray.c
///
/// Functions for handling growing arrays.

#include <string.h>

#include "vim.h"
#include "ascii.h"
#include "misc2.h"
#include "path.h"
#include "garray.h"

// #include "globals.h"
#include "memline.h"

/// Clear an allocated growing array.
void ga_clear(garray_T *gap)
{
  vim_free(gap->ga_data);
  ga_init(gap);
}

/// Clear a growing array that contains a list of strings.
///
/// @param gap
void ga_clear_strings(garray_T *gap)
{
  int i;
  for (i = 0; i < gap->ga_len; ++i) {
    vim_free(((char_u **)(gap->ga_data))[i]);
  }
  ga_clear(gap);
}

/// Initialize a growing array.	Don't forget to set ga_itemsize and
/// ga_growsize!  Or use ga_init2().
///
/// @param gap
void ga_init(garray_T *gap)
{
  gap->ga_data = NULL;
  gap->ga_maxlen = 0;
  gap->ga_len = 0;
}

/// Initialize a growing array.
///
/// @param gap
/// @param itemsize
/// @param growsize
void ga_init2(garray_T *gap, int itemsize, int growsize)
{
  ga_init(gap);
  gap->ga_itemsize = itemsize;
  gap->ga_growsize = growsize;
}

/// Make room in growing array "gap" for at least "n" items.
///
/// @param gap
/// @param n
///
/// @return FAIL for failure, OK otherwise.
int ga_grow(garray_T *gap, int n)
{
  size_t old_len;
  size_t new_len;
  char_u *pp;

  if (gap->ga_maxlen - gap->ga_len < n) {
    if (n < gap->ga_growsize) {
      n = gap->ga_growsize;
    }
    new_len = gap->ga_itemsize * (gap->ga_len + n);
    pp = (gap->ga_data == NULL)
         ? alloc((unsigned)new_len)
         : xrealloc(gap->ga_data, new_len);

    if (pp == NULL) {
      return FAIL;
    }
    old_len = gap->ga_itemsize * gap->ga_maxlen;
    memset(pp + old_len, 0, new_len - old_len);
    gap->ga_maxlen = gap->ga_len + n;
    gap->ga_data = pp;
  }
  return OK;
}

/// Sort "gap" and remove duplicate entries.  "gap" is expected to contain a
/// list of file names in allocated memory.
///
/// @param gap
void ga_remove_duplicate_strings(garray_T *gap)
{
  int i;
  int j;
  char_u  **fnames = (char_u **)gap->ga_data;

  sort_strings(fnames, gap->ga_len);
  for (i = gap->ga_len - 1; i > 0; --i)
    if (fnamecmp(fnames[i - 1], fnames[i]) == 0) {
      vim_free(fnames[i]);
      for (j = i + 1; j < gap->ga_len; ++j)
        fnames[j - 1] = fnames[j];
      --gap->ga_len;
    }
}

/// For a growing array that contains a list of strings: concatenate all the
/// strings with a separating comma.
///
/// @param gap
///
/// @returns NULL when out of memory.
char_u* ga_concat_strings(garray_T *gap)
{
  int i;
  int len = 0;
  char_u *s;

  for (i = 0; i < gap->ga_len; ++i) {
    len += (int)STRLEN(((char_u **)(gap->ga_data))[i]) + 1;
  }

  s = alloc(len + 1);

  if (s != NULL) {
    *s = NUL;

    for (i = 0; i < gap->ga_len; ++i) {
      if (*s != NUL) {
        STRCAT(s, ",");
      }
      STRCAT(s, ((char_u **)(gap->ga_data))[i]);
    }
  }
  return s;
}

/// Concatenate a string to a growarray which contains characters.
/// Note: Does NOT copy the NUL at the end!
///
/// @param gap
/// @param s
void ga_concat(garray_T *gap, char_u *s)
{
  int len = (int)STRLEN(s);
  if (ga_grow(gap, len) == OK) {
    memmove((char *)gap->ga_data + gap->ga_len, s, (size_t)len);
    gap->ga_len += len;
  }
}

/// Append one byte to a growarray which contains bytes.
///
/// @param gap
/// @param c
void ga_append(garray_T *gap, int c)
{
  if (ga_grow(gap, 1) == OK) {
    *((char *) gap->ga_data + gap->ga_len) = c;
    ++gap->ga_len;
  }
}

#if defined(UNIX) || defined(WIN3264)

/// Append the text in "gap" below the cursor line and clear "gap".
///
/// @param gap
void append_ga_line(garray_T *gap)
{
  // Remove trailing CR.
  if ((gap->ga_len > 0)
      && !curbuf->b_p_bin
      && (((char_u *)gap->ga_data)[gap->ga_len - 1] == CAR)) {
    gap->ga_len--;
  }
  ga_append(gap, NUL);
  ml_append(curwin->w_cursor.lnum++, gap->ga_data, 0, FALSE);
  gap->ga_len = 0;
}

#endif  // if defined(UNIX) || defined(WIN3264)