Our own, locale independent, character handling routines. More...

#include "ruby/internal/config.h"
#include "ruby/internal/attr/artificial.h"
#include "ruby/internal/attr/const.h"
#include "ruby/internal/attr/constexpr.h"
#include "ruby/internal/attr/nonnull.h"
#include "ruby/internal/dllexport.h"

Include dependency graph for ctype.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	ISASCII rb_isascii
Old character classification macros
What is this ISPRINT business? Well, according to our VCS and some internet surfing, it appears that the initial intent of these macros were to mimic codes appear in common in several GNU projects. As far as @shyouhei detects they seem to originate GNU regex (that standalone one rather than Gnulib or Glibc), and at least date back to 1995. Let me lawfully quote from a GNU coreutils commit https://git.savannah.gnu.org/cgit/coreutils.git/commit/?id=49803907f5dbd7646184a8912c9db9b09dcd0f22 Jim Meyering writes: "... Some ctype macros are valid only for character codes that isascii says are ASCII (SGI's IRIX-4.0.5 is one such system –when using /bin/cc or gcc but without giving an ansi option). So, all ctype uses should be through macros like ISPRINT... If STDC_HEADERS is defined, then autoconf has verified that the ctype macros don't need to be guarded with references to isascii. ... Defining isascii to 1 should let any compiler worth its salt eliminate the && through constant folding." Bruno Haible adds: "... Furthermore, isupper(c) etc. have an undefined result if c is outside the range -1 <= c <= 255. One is tempted to write isupper(c) with c being of type `char', but this is wrong if c is an 8-bit character >= 128 which gets sign-extended to a negative value. The macro ISUPPER protects against this as well." So the intent was to reroute old problematic systems that no longer exist. At the same time the problems described above no longer hurt us, because we decided to completely avoid using system-provided isupper etc. to reinvent the wheel. These macros are entirely legacy; please ignore them. But let me also put stress that GNU people are wise; they use those macros only inside of their own implementations and never let them be public. On the other hand ruby has thoughtlessly publicised them to 3rd party libraries since its beginning, which is a very bad idea. These macros are too easy to get conflicted with definitions elsewhere. New programs should stick to the rb_ prefixed names. Note It seems we just mimic the API. We do not share their implementation with GPL-ed programs. / define ISASCII /*< @old{rb_isascii}
#define	ISPRINT rb_isprint
	@old{rb_isprint}
#define	ISGRAPH rb_isgraph
	@old{rb_isgraph}
#define	ISSPACE rb_isspace
	@old{rb_isspace}
#define	ISUPPER rb_isupper
	@old{rb_isupper}
#define	ISLOWER rb_islower
	@old{rb_islower}
#define	ISALNUM rb_isalnum
	@old{rb_isalnum}
#define	ISALPHA rb_isalpha
	@old{rb_isalpha}
#define	ISDIGIT rb_isdigit
	@old{rb_isdigit}
#define	ISXDIGIT rb_isxdigit
	@old{rb_isxdigit}
#define	ISBLANK rb_isblank
	@old{rb_isblank}
#define	ISCNTRL rb_iscntrl
	@old{rb_iscntrl}
#define	ISPUNCT rb_ispunct
	@old{rb_ispunct}
#define	TOUPPER rb_toupper
	@old{rb_toupper}
#define	TOLOWER rb_tolower
	@old{rb_tolower}
#define	STRCASECMP st_locale_insensitive_strcasecmp
	@old{st_locale_insensitive_strcasecmp}
#define	STRNCASECMP st_locale_insensitive_strncasecmp
	@old{st_locale_insensitive_strncasecmp}
#define	STRTOUL ruby_strtoul
	@old{ruby_strtoul}

Functions
locale insensitive functions
int	st_locale_insensitive_strcasecmp (const char s1, const char s2)
	Our own locale-insensitive version of strcasecmp(3).
int	st_locale_insensitive_strncasecmp (const char s1, const char s2, size_t n)
	Our own locale-insensitive version of strcnasecmp(3).
unsigned long	ruby_strtoul (const char str, char *endptr, int base)
	Our own locale-insensitive version of strtoul(3).
static int	rb_isascii (int c)
	Our own locale-insensitive version of isascii(3).
static int	rb_isupper (int c)
	Our own locale-insensitive version of isupper(3).
static int	rb_islower (int c)
	Our own locale-insensitive version of islower(3).
static int	rb_isalpha (int c)
	Our own locale-insensitive version of isalpha(3).
static int	rb_isdigit (int c)
	Our own locale-insensitive version of isdigit(3).
static int	rb_isalnum (int c)
	Our own locale-insensitive version of isalnum(3).
static int	rb_isxdigit (int c)
	Our own locale-insensitive version of isxdigit(3).
static int	rb_isblank (int c)
	Our own locale-insensitive version of isblank(3).
static int	rb_isspace (int c)
	Our own locale-insensitive version of isspace(3).
static int	rb_iscntrl (int c)
	Our own locale-insensitive version of iscntrl(3).
static int	rb_isprint (int c)
	Identical to rb_isgraph(), except it also returns true for ' '.
static int	rb_ispunct (int c)
	Our own locale-insensitive version of ispunct(3).
static int	rb_isgraph (int c)
	Our own locale-insensitive version of isgraph(3).
static int	rb_tolower (int c)
	Our own locale-insensitive version of tolower(3).
static int	rb_toupper (int c)
	Our own locale-insensitive version of toupper(3).

Detailed Description

Our own, locale independent, character handling routines.

Author: Ruby developers ruby-.nosp@m.core.nosp@m.@ruby.nosp@m.-lan.nosp@m.g.org

Copyright: This file is a part of the programming language Ruby. Permission is hereby granted, to either redistribute and/or modify this file, provided that the conditions mentioned in the file COPYING are met. Consult the file for details.

Warning: Symbols prefixed with either RBIMPL or rbimpl are implementation details. Don't take them as canon. They could rapidly appear then vanish. The name (path) of this header file is also an implementation detail. Do not expect it to persist at the place it is now. Developers are free to move it anywhere anytime at will.

Note: To ruby-core: remember that this header can be possibly recursively included from extension libraries written in C++. Do not expect for instance __VA_ARGS__ is always available. We assume C99 for ruby itself but we don't assume languages of extension libraries. They could be written in C++98.

Definition in file ctype.h.

Macro Definition Documentation

◆ ISALNUM

#define ISALNUM rb_isalnum

@old{rb_isalnum}

Definition at line 91 of file ctype.h.

◆ ISALPHA

#define ISALPHA rb_isalpha

@old{rb_isalpha}

Definition at line 92 of file ctype.h.

◆ ISBLANK

#define ISBLANK rb_isblank

@old{rb_isblank}

Definition at line 95 of file ctype.h.

◆ ISCNTRL

#define ISCNTRL rb_iscntrl

@old{rb_iscntrl}

Definition at line 96 of file ctype.h.

◆ ISDIGIT

#define ISDIGIT rb_isdigit

@old{rb_isdigit}

Definition at line 93 of file ctype.h.

◆ ISGRAPH

#define ISGRAPH rb_isgraph

@old{rb_isgraph}

Definition at line 87 of file ctype.h.

◆ ISLOWER

#define ISLOWER rb_islower

@old{rb_islower}

Definition at line 90 of file ctype.h.

◆ ISPRINT

#define ISPRINT rb_isprint

@old{rb_isprint}

Definition at line 86 of file ctype.h.

Referenced by rb_str_dump(), and rb_str_inspect().

◆ ISPUNCT

#define ISPUNCT rb_ispunct

@old{rb_ispunct}

Definition at line 97 of file ctype.h.

◆ ISSPACE

#define ISSPACE rb_isspace

@old{rb_isspace}

Definition at line 88 of file ctype.h.

Referenced by rb_memory_view_parse_item_format(), ruby_each_words(), and ruby_strtoul().

◆ ISUPPER

#define ISUPPER rb_isupper

@old{rb_isupper}

Definition at line 89 of file ctype.h.

◆ ISXDIGIT

#define ISXDIGIT rb_isxdigit

@old{rb_isxdigit}

Definition at line 94 of file ctype.h.

◆ STRCASECMP

#define STRCASECMP st_locale_insensitive_strcasecmp

@old{st_locale_insensitive_strcasecmp}

Definition at line 102 of file ctype.h.

◆ STRNCASECMP

#define STRNCASECMP st_locale_insensitive_strncasecmp

@old{st_locale_insensitive_strncasecmp}

Definition at line 103 of file ctype.h.

Referenced by ruby_init_loadpath().

◆ STRTOUL

#define STRTOUL ruby_strtoul

@old{ruby_strtoul}

Definition at line 104 of file ctype.h.

◆ TOLOWER

#define TOLOWER rb_tolower

@old{rb_tolower}

Definition at line 101 of file ctype.h.

◆ TOUPPER

#define TOUPPER rb_toupper

@old{rb_toupper}

Definition at line 100 of file ctype.h.

Function Documentation

◆ rb_isalnum()

int rb_isalnum ( int c )

inlinestatic

Our own locale-insensitive version of isalnum(3).

Parameters

[in] c Byte in question to query.

Return values

true	c is listed in either IEEE 1003.1 section 7.3.1.1 "upper", "lower", or "digit".
false	Anything else.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 326 of file ctype.h.

Referenced by rb_isalnum(), and rb_ispunct().

◆ rb_isalpha()

int rb_isalpha ( int c )

inlinestatic

Our own locale-insensitive version of isalpha(3).

Parameters

[in] c Byte in question to query.

Return values

true	c is listed in either IEEE 1003.1 section 7.3.1.1 "upper" or "lower".
false	Anything else.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 279 of file ctype.h.

Referenced by rb_isalnum(), and rb_isalpha().

◆ rb_isascii()

int rb_isascii ( int c )

inlinestatic

Our own locale-insensitive version of isascii(3).

Parameters

[in] c Byte in question to query.

Return values

false	c is out of range of ASCII character set.
true	Yes it is.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 209 of file ctype.h.

Referenced by rb_isascii().

◆ rb_isblank()

int rb_isblank ( int c )

inlinestatic

Our own locale-insensitive version of isblank(3).

Parameters

[in] c Byte in question to query.

Return values

true	c is listed in IEEE 1003.1 section 7.3.1.1 "blank".
false	Anything else.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 372 of file ctype.h.

Referenced by rb_isblank().

◆ rb_iscntrl()

int rb_iscntrl ( int c )

inlinestatic

Our own locale-insensitive version of iscntrl(3).

Parameters

[in] c Byte in question to query.

Return values

true	c is listed in IEEE 1003.1 section 7.3.1.1 "cntrl".
false	Anything else.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 418 of file ctype.h.

Referenced by rb_iscntrl().

◆ rb_isdigit()

int rb_isdigit ( int c )

inlinestatic

Our own locale-insensitive version of isdigit(3).

Parameters

[in] c Byte in question to query.

Return values

true	c is listed in IEEE 1003.1 section 7.3.1.1 "digit".
false	Anything else.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 302 of file ctype.h.

Referenced by rb_isalnum(), rb_isdigit(), and rb_isxdigit().

◆ rb_isgraph()

int rb_isgraph ( int c )

inlinestatic

Our own locale-insensitive version of isgraph(3).

Parameters

[in] c Byte in question to query.

Return values

true	c is listed in either IEEE 1003.1 section 7.3.1.1 "upper", "lower", "digit", or "punct".
false	Anything else.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 489 of file ctype.h.

Referenced by rb_isgraph().

◆ rb_islower()

int rb_islower ( int c )

inlinestatic

Our own locale-insensitive version of islower(3).

Parameters

[in] c Byte in question to query.

Return values

true	c is listed in IEEE 1003.1 section 7.3.1.1 "lower".
false	Anything else.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 255 of file ctype.h.

Referenced by rb_isalpha(), rb_islower(), and rb_toupper().

◆ rb_isprint()

int rb_isprint ( int c )

inlinestatic

Identical to rb_isgraph(), except it also returns true for ' '.

Parameters

[in] c Byte in question to query.

Return values

true	c is listed in either IEEE 1003.1 section 7.3.1.1 "upper", "lower", "digit", "punct", or a ' '.
false	Anything else.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 442 of file ctype.h.

Referenced by rb_isprint().

◆ rb_ispunct()

int rb_ispunct ( int c )

inlinestatic

Our own locale-insensitive version of ispunct(3).

Parameters

[in] c Byte in question to query.

Return values

true	c is listed in IEEE 1003.1 section 7.3.1.1 "punct".
false	Anything else.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 465 of file ctype.h.

Referenced by rb_ispunct().

◆ rb_isspace()

int rb_isspace ( int c )

inlinestatic

Our own locale-insensitive version of isspace(3).

Parameters

[in] c Byte in question to query.

Return values

true	c is listed in IEEE 1003.1 section 7.3.1.1 "space".
false	Anything else.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 395 of file ctype.h.

Referenced by rb_isspace().

◆ rb_isupper()

int rb_isupper ( int c )

inlinestatic

Our own locale-insensitive version of isupper(3).

Parameters

[in] c Byte in question to query.

Return values

true	c is listed in IEEE 1003.1 section 7.3.1.1 "upper".
false	Anything else.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 232 of file ctype.h.

Referenced by rb_isalpha(), rb_isupper(), and rb_tolower().

◆ rb_isxdigit()

int rb_isxdigit ( int c )

inlinestatic

Our own locale-insensitive version of isxdigit(3).

Parameters

[in] c Byte in question to query.

Return values

true	c is listed in IEEE 1003.1 section 7.3.1.1 "xdigit".
false	Anything else.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 349 of file ctype.h.

Referenced by rb_isxdigit().

◆ rb_tolower()

int rb_tolower ( int c )

inlinestatic

Our own locale-insensitive version of tolower(3).

Parameters

[in] c Byte in question to convert.

Return values

c	The byte is not listed in in IEEE 1003.1 section 7.3.1.1 "upper".
otherwise	Byte converted using the map defined in IEEE 1003.1 section 7.3.1 "tolower".

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 514 of file ctype.h.

Referenced by rb_tolower().

◆ rb_toupper()

int rb_toupper ( int c )

inlinestatic

Our own locale-insensitive version of toupper(3).

Parameters

[in] c Byte in question to convert.

Return values

c	The byte is not listed in in IEEE 1003.1 section 7.3.1.1 "lower".
otherwise	Byte converted using the map defined in IEEE 1003.1 section 7.3.1 "toupper".

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: c is an int. This means that when you pass a char value here, it experiences "integer promotion" as defined in ISO/IEC 9899:2018 section 6.3.1.1 paragraph 1.

Definition at line 539 of file ctype.h.

Referenced by rb_toupper().

◆ ruby_strtoul()

unsigned long ruby_strtoul	(	const char *	str,
		char **	endptr,
		int	base )

Our own locale-insensitive version of strtoul(3).

The conversion is done as if the current locale is set to the "C" locale, no matter actual runtime locale settings.

Note: This is needed because strtoul("i", 0, 36) would return zero if it is locale sensitive and the current locale is tr_TR.

Parameters

[in]	str	String of digits, optionally preceded with whitespaces (ignored) and optionally + or - sign.
[out]	endptr	NULL, or an arbitrary pointer (overwritten on return).
[in]	base	2 to 36 inclusive for each base, or special case 0 to detect the base from the contents of the string.

Returns: Converted integer, casted to unsigned long.

Postcondition: If endptr is not NULL, it is updated to point the first such byte where conversion failed.

Note

This function sets errno on failure.

EINVAL: Passed base is out of range.
ERANGE: Converted integer is out of range of long.

Warning: As far as @shyouhei reads ISO/IEC 9899:2018 section 7.22.1.4, a conforming strtoul implementation shall render ERANGE whenever it finds the input string represents a negative integer. Such thing can never be representable using unsigned long. However this implementation does not honour that language. It just casts such negative value to the return type, resulting a very big return value. This behaviour is at least questionable. But we can no longer change that at this point.

Note: Not only does this function works under the "C" locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Definition at line 138 of file util.c.

Referenced by ruby_strtoul().

◆ st_locale_insensitive_strcasecmp()

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

Our own locale-insensitive version of strcasecmp(3).

The "case" here always means that of the POSIX Locale. It doesn't depend on runtime locale settings.

Parameters

[in]	s1	Comparison LHS.
[in]	s2	Comparison RHS.

Return values

-1	s1 is "less" than s2.
0	Both strings converted into lowercase would be identical.
1	s1 is "greater" than s2.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Definition at line 2021 of file st.c.

◆ st_locale_insensitive_strncasecmp()

int st_locale_insensitive_strncasecmp	(	const char *	s1,
		const char *	s2,
		size_t	n )

Our own locale-insensitive version of strcnasecmp(3).

The "case" here always means that of the POSIX Locale. It doesn't depend on runtime locale settings.

Parameters

[in]	s1	Comparison LHS.
[in]	s2	Comparison RHS.
[in]	n	Comparison shall stop after first n bytes are scanned.

Return values

-1	s1 is "less" than s2.
0	Both strings converted into lowercase would be identical.
1	s1 is "greater" than s2.

Note: Not only does this function works under the POSIX Locale, but also assumes its execution character set be what ruby calls an ASCII-compatible character set; which does not include for instance EBCDIC or UTF-16LE.

Warning: This function is not timing safe.

Definition at line 2045 of file st.c.

Macros

define ISASCII /**< @old{rb_isascii}

Functions

Detailed Description

Macro Definition Documentation

◆ ISALNUM

◆ ISALPHA

◆ ISBLANK

◆ ISCNTRL

◆ ISDIGIT

◆ ISGRAPH

◆ ISLOWER

◆ ISPRINT

◆ ISPUNCT

◆ ISSPACE

◆ ISUPPER

◆ ISXDIGIT

◆ STRCASECMP

◆ STRNCASECMP

◆ STRTOUL

◆ TOLOWER

◆ TOUPPER

Function Documentation

◆ rb_isalnum()

◆ rb_isalpha()

◆ rb_isascii()

◆ rb_isblank()

◆ rb_iscntrl()

◆ rb_isdigit()

◆ rb_isgraph()

◆ rb_islower()

◆ rb_isprint()

◆ rb_ispunct()

◆ rb_isspace()

◆ rb_isupper()

◆ rb_isxdigit()

◆ rb_tolower()

◆ rb_toupper()

◆ ruby_strtoul()

◆ st_locale_insensitive_strcasecmp()

◆ st_locale_insensitive_strncasecmp()