strings.c File Reference

#include <assert.h>
#include <inttypes.h>
#include <math.h>
#include <stdarg.h>
#include <stdbool.h>
#include <string.h>
#include "nvim/ascii.h"
#include "nvim/buffer.h"
#include "nvim/charset.h"
#include "nvim/diff.h"
#include "nvim/edit.h"
#include "nvim/eval.h"
#include "nvim/eval/encode.h"
#include "nvim/ex_cmds.h"
#include "nvim/ex_docmd.h"
#include "nvim/ex_getln.h"
#include "nvim/file_search.h"
#include "nvim/fileio.h"
#include "nvim/fold.h"
#include "nvim/func_attr.h"
#include "nvim/getchar.h"
#include "nvim/mark.h"
#include "nvim/mbyte.h"
#include "nvim/memfile.h"
#include "nvim/memline.h"
#include "nvim/memory.h"
#include "nvim/message.h"
#include "nvim/move.h"
#include "nvim/ops.h"
#include "nvim/option.h"
#include "nvim/os/os.h"
#include "nvim/os/shell.h"
#include "nvim/os_unix.h"
#include "nvim/path.h"
#include "nvim/quickfix.h"
#include "nvim/regexp.h"
#include "nvim/screen.h"
#include "nvim/search.h"
#include "nvim/spell.h"
#include "nvim/strings.h"
#include "nvim/syntax.h"
#include "nvim/tag.h"
#include "nvim/vim.h"
#include "nvim/window.h"

Macros
#define	ESCAPE_COND(p, inquote, string_end)   (*p == '\\' && inquote && p + 1 < string_end && (p[1] == '\\' || p[1] == '"'))
#define	OFF(attr)   offsetof(union typval_vval_union, attr)
#define	TMP_LEN   350

Functions
char_u *	vim_strsave (const char_u *string) FUNC_ATTR_NONNULL_RET FUNC_ATTR_MALLOC FUNC_ATTR_NONNULL_ALL
	Copy "string" into newly allocated memory. More...
char_u *	vim_strnsave (const char_u *string, size_t len) FUNC_ATTR_NONNULL_RET FUNC_ATTR_MALLOC FUNC_ATTR_NONNULL_ALL
char *	xstrnsave (const char *string, size_t len) FUNC_ATTR_NONNULL_RET FUNC_ATTR_MALLOC FUNC_ATTR_NONNULL_ALL
	A clone of vim_strnsave() that uses char* instead of char_u*. More...
char_u *	vim_strsave_escaped (const char_u *string, const char_u *esc_chars) FUNC_ATTR_NONNULL_RET FUNC_ATTR_MALLOC FUNC_ATTR_NONNULL_ALL
char_u *	vim_strsave_escaped_ext (const char_u *string, const char_u *esc_chars, char_u cc, bool bsl) FUNC_ATTR_NONNULL_RET FUNC_ATTR_MALLOC FUNC_ATTR_NONNULL_ALL
char *	vim_strnsave_unquoted (const char *const string, const size_t length) FUNC_ATTR_MALLOC FUNC_ATTR_WARN_UNUSED_RESULT FUNC_ATTR_NONNULL_ALL FUNC_ATTR_NONNULL_RET
char_u *	vim_strsave_shellescape (const char_u *string, bool do_special, bool do_newline) FUNC_ATTR_NONNULL_RET FUNC_ATTR_MALLOC FUNC_ATTR_NONNULL_ALL
char_u *	vim_strsave_up (const char_u *string) FUNC_ATTR_NONNULL_RET FUNC_ATTR_MALLOC FUNC_ATTR_NONNULL_ALL
char_u *	vim_strnsave_up (const char_u *string, size_t len) FUNC_ATTR_NONNULL_RET FUNC_ATTR_MALLOC FUNC_ATTR_NONNULL_ALL
void	vim_strup (char_u *p) FUNC_ATTR_NONNULL_ALL
char *	strcase_save (const char *const orig, bool upper) FUNC_ATTR_NONNULL_RET FUNC_ATTR_MALLOC FUNC_ATTR_NONNULL_ALL
void	del_trailing_spaces (char_u *ptr) FUNC_ATTR_NONNULL_ALL
size_t	xstrnlen (const char *s, size_t n) FUNC_ATTR_NONNULL_ALL FUNC_ATTR_PURE
int	vim_stricmp (const char *s1, const char *s2) FUNC_ATTR_NONNULL_ALL FUNC_ATTR_PURE
int	vim_strnicmp (const char *s1, const char *s2, size_t len) FUNC_ATTR_NONNULL_ALL FUNC_ATTR_PURE
char_u *	vim_strchr (const char_u *const string, const int c) FUNC_ATTR_NONNULL_ALL FUNC_ATTR_PURE FUNC_ATTR_WARN_UNUSED_RESULT
void	sort_strings (char_u **files, int count)
bool	has_non_ascii (const char_u *s) FUNC_ATTR_PURE
bool	has_non_ascii_len (const char *const s, const size_t len) FUNC_ATTR_PURE
char_u *	concat_str (const char_u *restrict str1, const char_u *restrict str2) FUNC_ATTR_NONNULL_RET FUNC_ATTR_MALLOC FUNC_ATTR_NONNULL_ALL
int	vim_snprintf_add (char *str, size_t str_m, const char *fmt,...) FUNC_ATTR_PRINTF(3
	if (str_m<=len)
	va_start (ap, fmt)
	va_end (ap)
int	vim_snprintf (char *str, size_t str_m, const char *fmt,...) FUNC_ATTR_PRINTF(3
int	vim_vsnprintf (char *str, size_t str_m, const char *fmt, va_list ap)
int	vim_vsnprintf_typval (char *str, size_t str_m, const char *fmt, va_list ap, typval_T *const tvs)
int	kv_do_printf (StringBuilder *str, const char *fmt,...) FUNC_ATTR_PRINTF(2
	if (printed< 0)
	if ((size_t) printed >=remaining)

Variables
int size_t	space
	else
va_list	ap
const int	str_l = vim_vsnprintf(str + len, space, fmt, ap)
int	printed = vsnprintf(str->items ? str->items + str->size : NULL, remaining, fmt, ap)
str	size = (size_t)printed

Macro Definition Documentation

ESCAPE_COND

#define ESCAPE_COND	(		p,
			inquote,
			string_end
	)		(*p == '\\' && inquote && p + 1 < string_end && (p[1] == '\\' || p[1] == '"'))

OFF

#define OFF

(

attr

)

offsetof(union typval_vval_union, attr)

TMP_LEN

#define TMP_LEN   350

Function Documentation

concat_str()

char_u* concat_str	(	const char_u *restrict	str1,
		const char_u *restrict	str2
	)

del_trailing_spaces()

void del_trailing_spaces

(

char_u *

ptr

)

has_non_ascii()

bool has_non_ascii

(

const char_u *

s

)

has_non_ascii_len()

bool has_non_ascii_len	(	const char *const	s,
		const size_t	len
	)

Return true if string "s" contains a non-ASCII character (128 or higher). When "s" is NULL false is returned.

if() [1/3]

if

(

(size_t) printed >=

remaining

)

if() [2/3]

if

(

)

if() [3/3]

if

(

str_m<=

len

)

kv_do_printf()

int kv_do_printf	(	StringBuilder *	str,
		const char *	fmt,
			...
	)

sort_strings()

void sort_strings	(	char_u **	files,
		int	count
	)

strcase_save()

char* strcase_save	(	const char *const	orig,
		bool	upper
	)

Make given string all upper-case or all lower-case

Handles multi-byte characters as good as possible.

Parameters

[in]	orig	Input string.
[in]	upper	If true make uppercase, otherwise lowercase

Returns

[allocated] upper-cased string.

va_end()

va_end

(

ap

)

va_start()

va_start	(	ap	,
		fmt
	)

vim_snprintf()

int vim_snprintf	(	char *	str,
		size_t	str_m,
		const char *	fmt,
			...
	)

Write formatted value to the string

Parameters

[out]	str	String to write to.
[in]	str_m	String length.
[in]	fmt	String format.

Returns

Number of bytes excluding NUL byte that would be written to the string if str_m was greater or equal to the return value.

vim_snprintf_add()

int vim_snprintf_add	(	char *	str,
		size_t	str_m,
		const char *	fmt,
			...
	)

Append a formatted value to the string

See also

vim_vsnprintf_typval().

vim_strchr()

char_u* vim_strchr	(	const char_u *const	string,
		const int	c
	)

strchr() version which handles multibyte strings

Parameters

[in]	string	String to search in.
[in]	c	Character to search for.

Returns

Pointer to the first byte of the found character in string or NULL if it was not found or character is invalid. NUL character is never found, use strlen() instead.

vim_stricmp()

int vim_stricmp	(	const char *	s1,
		const char *	s2
	)

vim_strnicmp()

int vim_strnicmp	(	const char *	s1,
		const char *	s2,
		size_t	len
	)

vim_strnsave()

char_u* vim_strnsave	(	const char_u *	string,
		size_t	len
	)

Copy up to len bytes of string into newly allocated memory and terminate with a NUL. The allocated memory always has size len + 1, even when string is shorter.

vim_strnsave_unquoted()

char* vim_strnsave_unquoted	(	const char *const	string,
		const size_t	length
	)

Save a copy of an unquoted string

Turns string like a\bc"def\"ghi\
"jkl</tt> into <tt>a\\bcdef"ghi\njkl, for use in shell_build_argv: the only purpose of backslash is making next character be treated literally inside the double quotes, if this character is backslash or quote.

Parameters

[in]	string	String to copy.
[in]	length	Length of the string to copy.

Returns

[allocated] Copy of the string.

vim_strnsave_up()

char_u* vim_strnsave_up	(	const char_u *	string,
		size_t	len
	)

vim_strsave()

char_u* vim_strsave

(

const char_u *

string

)

Copy "string" into newly allocated memory.

vim_strsave_escaped()

char_u* vim_strsave_escaped	(	const char_u *	string,
		const char_u *	esc_chars
	)

vim_strsave_escaped_ext()

char_u* vim_strsave_escaped_ext	(	const char_u *	string,
		const char_u *	esc_chars,
		char_u	cc,
		bool	bsl
	)

vim_strsave_shellescape()

char_u* vim_strsave_shellescape	(	const char_u *	string,
		bool	do_special,
		bool	do_newline
	)

vim_strsave_up()

char_u* vim_strsave_up

(

const char_u *

string

)

vim_strup()

void vim_strup

(

char_u *

p

)

vim_vsnprintf()

int vim_vsnprintf	(	char *	str,
		size_t	str_m,
		const char *	fmt,
		va_list	ap
	)

vim_vsnprintf_typval()

int vim_vsnprintf_typval	(	char *	str,
		size_t	str_m,
		const char *	fmt,
		va_list	ap,
		typval_T *const	tvs
	)

Write formatted value to the string

Parameters

[out]	str	String to write to.
[in]	str_m	String length.
[in]	fmt	String format.
[in]	ap	Values that should be formatted. Ignored if tvs is not NULL.
[in]	tvs	Values that should be formatted, for printf() VimL function. Must be NULL in other cases.

Returns

Number of bytes excluding NUL byte that would be written to the string if str_m was greater or equal to the return value.

xstrnlen()

size_t xstrnlen	(	const char *	s,
		size_t	n
	)

xstrnsave()

char* xstrnsave	(	const char *	string,
		size_t	len
	)

A clone of vim_strnsave() that uses char* instead of char_u*.

Variable Documentation

ap

int va_list ap

Initial value:

{
  size_t remaining = str->capacity - str->size

else

else

Initial value:

{
    space = str_m - len

printed

return printed = vsnprintf(str->items ? str->items + str->size : NULL, remaining, fmt, ap)

size

str size = (size_t)printed

space

int size_t space

Initial value:

{
  const size_t len = strlen(str)

str_l

return str_l = vim_vsnprintf(str + len, space, fmt, ap)