path: root/include/ctype.h

/**
 * slibc — Yet another C library
 * Copyright © 2015, 2016  Mattias Andrée (maandree@member.fsf.org)
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef _CTYPE_H
#define _CTYPE_H
#include <slibc/version.h>
#include <slibc/features.h>

#ifndef _SLIBC_SUPPRESS_WARNINGS
# warning "Functions in <ctype.h>, 'isascii' and 'toascii', only support ASCII."
# warning "Functions in <ctype.h>, do not support wider characets than 8 bits."
#endif



#define __NEED_locale_t

#include <bits/types.h>


/**
 * Check whether a character is an alphabetical
 * character or a decimal digit.
 * 
 * @etymology  (Is) character either (al)phabetical or (num)erical [(al)pha(num)erical]?
 * 
 * @param   c  The character.
 * @return     Whether the character is in
 *             ['0', '9'], ['A', 'Z'], or ['a', 'z'].
 * 
 * @since  Always.
 */
int (isalnum)(int)  /* [0x30, 0x39], [0x41, 0x5A], [0x61, 0x7A] */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#if defined (__GNUC__)
# define isalnum(c)  \
  ({ int __c = (c); (isalpha(__c) || isdigit(__c)); })
#endif


/**
 * Check whether a character is an alphabetical character.
 * 
 * @etymology  (Is) character (alpha)betical?
 * 
 * @param   c  The character.
 * @return     Whether the character is in
 *             ['A', 'Z'] or ['a', 'z'].
 * 
 * @since  Always.
 */
int (isalpha)(int)  /* [0x41, 0x5A], [0x61, 0x7A] */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#define isalpha(c)  (islower(tolower(c)))


#if defined(__GNU_SOURCE)
/**
 * Check whether a character is a regular blank space
 * or a horizontal tabulation.
 * 
 * This is a GNU extension.
 * 
 * @etymology  (Is) character a (blank) space?
 * 
 * @param   c  The character.
 * @return     Whether the character is a ' ' or a '\t'.
 * 
 * @since  Always.
 */
int (isblank)(int) /* ' ', '\t' */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
# if defined(__GNUC__)
#  define isblank(c)  \
  ({ int __c = (c); ((__c == ' ') || (__c == '\t')); })
# endif
#endif


/**
 * Check whether a character is a non-printable
 * ASCII character.
 * 
 * @etymology  (Is) character a (c)o(ntr)o(l) character?
 * 
 * @param   c  The character.
 * @return     Whether the character is lower than ' ',
 *             or is 0x7F.
 * 
 * @since  Always.
 */
int (iscntrl)(int)  /* [0x00, 0x1F], 0x7F */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#if defined(__GNUC__)
# define iscntrl(c)  \
  ({ int __c = (c); (((unsigned)__c < ' ') || (__c == 0x7F)); })
#endif


/**
 * Check whether a character is a decimal digit.
 * 
 * @etymology  (Is) character a (digit)?
 * 
 * @param   c  The character.
 * @return     Whether the character is in ['0', '9'].
 * 
 * @since  Always.
 */
int (isdigit)(int)  /* [0x30, 0x39] */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#define isdigit(c)  (int)((unsigned)((c) - '0') < 10)


/**
 * Check whether a character is has a printable glyph.
 * 
 * @etymology  (Is) character (graph)ical?
 * 
 * @param   c  The character.
 * @return     Whether the character is greater
 *             than ' ', but is not 0x7F.
 * 
 * @since  Always.
 */
int (isgraph)(int)  /* [0x21, 0x7E] */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#define isgraph(c)  (int)((unsigned)(c - 0x21) < 0x5E)


/**
 * Check whether a character is a lowercase
 * alphabetical character.
 * 
 * @etymology  (Is) character a (lower)case character?
 * 
 * @param   c  The character.
 * @return     Whether the character is in ['a', 'z'].
 * 
 * @since  Always.
 */
int (islower)(int)  /* [0x61, 0x7A] */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#define islower(c)  (int)((unsigned)((c) - 'a') < 26)


/**
 * Check whether a character is has a printable glyph
 * or a blank space.
 * 
 * @etymology  (Is) character (print)able?
 * 
 * @param   c  The character.
 * @return     Whether the character is at least
 *             as great as ' ', but is not 0x7F.
 * 
 * @since  Always.
 */
int (isprint)(int)  /* [0x20, 0x7E] */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#define isprint(c)  (int)((unsigned)(c - 0x20) < 0x5F)


/**
 * Check whether a character is has a punctuation,
 * that is, a printable character but a blank space,
 * numerical or alphabetical.
 * 
 * @etymology  (Is) character a (punct)uation?
 * 
 * @param   c  The character.
 * @return     Whether the character is a punctuation.
 * 
 * @since  Always.
 */
int (ispunct)(int)  /* isprint && !isalnum && !isspace */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#if defined (__GNUC__)
# define ispunct(c)  \
  ({ int __c = (c); (isprint(__c) && !isalnum(__c) && !isspace(__c)); })
#endif


/**
 * Check whether a character is a whitespace character.
 * 
 * @etymology  (Is) character white(space)?
 * 
 * @param   c  The character.
 * @return     Whether the character is a ' ', '\f',
 *             '\n', '\r', '\t', or '\v'.
 * 
 * @since  Always.
 */
int (isspace)(int)  /* 0x20, [0x09, 0x0D] */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#if defined (__GNUC__)
# define isspace(c)  \
  ({ int __c = (c); ((__c == ' ') || ((unsigned)(__c - '\t') < 5)); })
#endif


/**
 * Check whether a character is an uppercase
 * alphabetical character.
 * 
 * @etymology  (Is) character a (upper)case character?
 * 
 * @param   c  The character.
 * @return     Whether the character is in ['A', 'Z'].
 * 
 * @since  Always.
 */
int (isupper)(int)  /* [0x41, 0x5A] */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#define isupper(c)  (int)((unsigned)((c) - 'A') < 26)


/**
 * Check whether a character is an ASCII
 * hexadecimal digit. Both uppercase and
 * lowercase is supported.
 * 
 * @etymology  (Is) character a he(x)adecimal digit?
 * 
 * @param   c  The character.
 * @return     Whether the character is in
 *             ['0', '9'], ['A', 'Z'], or ['a', 'z'].
 * 
 * @since  Always.
 */
int (isxdigit)(int)  /* [0x30, 0x39], [0x41, 0x46], [0x61, 0x66] */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#if defined (__GNUC__)
# define isxdigit(c)  \
  ({ int __c = (c); (isdigit(__c) && (tolower(__c) - 'a' < 6)); })
#endif



/**
 * Convert a uppercase ASCII character to
 * an lowercase ASCII character.
 * 
 * @etymology  Convert character (to) (lower)case!
 * 
 * @param   c  The character.
 * @return     The character in lowercase.
 *             Guaranteed to be unchanged if the
 *             character already is in lowercase.
 * 
 * @since  Always.
 */
int (tolower)(int)  /* [0x41, 0x5A] -> [0x61, 0x7A] */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#if defined (__GNUC__)
# define tolower(c)  \
  ({ int __c = (int)(unsigned)(c); (islower(__c) ? (__c | 0x20) : __c; })
#endif

/**
 * Convert a lowercase ASCII character to
 * an uppercase ASCII character.
 * 
 * @etymology  Convert character (to) (upper)case!
 * 
 * @param   c  The character.
 * @return     The character in uppercase.
 *             Guaranteed to be unchanged if the
 *             character already is in lowercase.
 * 
 * @since  Always.
 */
int (toupper)(int)  /* [0x61, 0x7A] -> [0x41, 0x5A] */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#if defined (__GNUC__)
# define toupper(c)  \
  ({ int __c = (int)(unsigned)(c); (isupper(__c) ? (__c & ~0x20) : __c; })
#endif



/**
 * Check whether a character is an ASCII character.
 * 
 * @etymology  (Is) character an (ASCII) character?
 * 
 * @param   c  The character
 * @return     Whether the character is an ASCII character.
 * 
 * @since  Always.
 */
int (isascii)(int)  /* [0x00, 0x7E] */
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#define isascii(c)  (int)((unsigned)(c) < 0x7F)

/**
 * Remove the 8:th bit from a character.
 * 
 * Note that this does not make a proper character set
 * convertion and the result is virtually arbitrary.
 * 
 * Justification for existence:
 *   The highest bit has historically been used as a
 *   parity bit.
 * 
 * @etymology  Truncate character (to) fit (ASCII) character set!
 * 
 * @param   c  The character.
 * @return     The character with the 8:th bit cleared.
 * 
 * @since  Always.
 */
int (toascii)(int)
  __warning("Using 'toascii' is, generally, unwise.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#if defined(_SLIBC_SUPPRESS_WARNINGS)
# define toascii(c)  (int)((unsigned)(c) & 0x7F)
#endif

/**
 * This function is identical to `tolower`.
 * It is provided for backwards-compatibility with SVID.
 * 
 * @since  Always.
 */
int _tolower(int)
  __deprecated("Use 'tolower' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * This function is identical to `tolower`.
 * It is provided for backwards-compatibility with SVID.
 * 
 * @since  Always.
 */
int _toupper(int)
  __deprecated("Use 'toupper' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));



/**
 * Check whether a character is an alphabetical
 * character or a decimal digit.
 * 
 * @etymology  (Is) character (alpha)betical, with consideration for (l)ocale?
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          Whether the character is
 *                  alphabetical or numerical.
 * 
 * @since  Always.
 */
int isalnum_l(int, locale_t)
  __warning("This function is dangerous, use 'iswalnum_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * Check whether a character is an alphabetical character.
 * 
 * @etymology  (Is) character (alpha)betical, with consideration for (l)ocale?
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          Whether the character is alphabetical.
 * 
 * @since  Always.
 */
int isalpha_l(int, locale_t)
  __warning("This function is dangerous, use 'iswalpha_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

#if defined(__GNU_SOURCE)
/**
 * Check whether a character is a regular blank space
 * or a horizontal tabulation.
 * 
 * This is a GNU extension.
 * 
 * @etymology  (Is) character a (blank) space, with consideration for (l)ocale?
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          Whether the character is a ' ' or a '\t'.
 * 
 * @since  Always.
 */
int isblank_l(int, locale_t)
  __warning("This function is dangerous, use 'iswblank_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));
#endif

/**
 * Check whether a character is a non-printable
 * ASCII character.
 * 
 * @etymology  (Is) character a (c)o(ntr)o(l) character, with consideration for (l)ocale?
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          Whether the character is non-printable.
 * 
 * @since  Always.
 */
int iscntrl_l(int, locale_t)
  __warning("This function is dangerous, use 'iswcntrl_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * Check whether a character is a decimal digit.
 * 
 * @etymology  (Is) character a (digit), with consideration for (l)ocale?
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          Whether the character is numerical.
 * 
 * @since  Always.
 */
int isdigit_l(int, locale_t)
  __warning("This function is dangerous, use 'iswdigit_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * Check whether a character is has a printable glyph.
 * 
 * @etymology  (Is) character (graph)ical, with consideration for (l)ocale?
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          Whether the character has a glyph.
 * 
 * @since  Always.
 */
int isgraph_l(int, locale_t)
  __warning("This function is dangerous, use 'iswgraph_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * Check whether a character is a lowercase
 * alphabetical character.
 * 
 * @etymology  (Is) character a (lower)case character, with consideration for (l)ocale?
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          Whether the character is a lowercase letter.
 * 
 * @since  Always.
 */
int islower_l(int, locale_t)
  __warning("This function is dangerous, use 'iswlower_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * Check whether a character is has a printable glyph
 * or a blank space.
 * 
 * @etymology  (Is) character (print)able, with consideration for (l)ocale?
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          Whether the character has a printable
 *                  glyph or is a blank space.
 * 
 * @since  Always.
 */
int isprint_l(int, locale_t)
  __warning("This function is dangerous, use 'iswprint_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * Check whether a character is has a punctuation,
 * that is, a printable character but a blank space,
 * numerical or alphabetical.
 * 
 * @etymology  (Is) character a (punct)uation, with consideration for (l)ocale?
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          Whether the character is a punctuation.
 * 
 * @since  Always.
 */
int ispunct_l(int, locale_t)
  __warning("This function is dangerous, use 'iswpunct_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * Check whether a character is a whitespace character.
 * 
 * @etymology  (Is) character white(space), with consideration for (l)ocale?
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          Whether the character is a
 *                  whitespace character.
 * 
 * @since  Always.
 */
int isspace_l(int, locale_t)
  __warning("This function is dangerous, use 'iswspace_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * Check whether a character is an uppercase
 * alphabetical character.
 * 
 * @etymology  (Is) character a (upper)case character, with consideration for (l)ocale?
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          Whether the character is a uppercase letter.
 * 
 * @since  Always.
 */
int isupper_l(int, locale_t)
  __warning("This function is dangerous, use 'iswupper_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * Check whether a character is an ASCII
 * hexadecimal digit. Both uppercase and
 * lowercase is supported.
 * 
 * @etymology  (Is) character a he(x)adecimal digit, with consideration for (l)ocale?
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          Whether the character is in
 *                  ['0', '9'], ['A', 'Z'], or ['a', 'z'].
 * 
 * @since  Always.
 */
int isxdigit_l(int, locale_t)
  __warning("This function is dangerous, use 'iswxdigit_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * Check whether a character is an ASCII character.
 * 
 * @etymology  (Is) character an (ASCII) character, with consideration for (l)ocale?
 * 
 * @param   c       The character
 * @param   locale  The locale.
 * @return          Whether the character is an ASCII character.
 * 
 * @since  Always.
 */
int isascii_l(int, locale_t)
  __warning("This function is dangerous, use 'iswascii_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * Remove the 8:th bit from a character.
 * 
 * Note that this does not make a proper character set
 * convertion and the result is virtually arbitrary.
 * 
 * @etymology  Truncate character (to) fit (ASCII) character set, with consideration for (l)ocale!
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          The character with the 8:th bit cleared.
 * 
 * @since  Always.
 */
int toascii_l(int, locale_t)
  __warning("This function is dangerous, use 'towascii_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * Convert a uppercase ASCII character to
 * an lowercase ASCII character.
 * 
 * The function's behaviour is unspecifed
 * of the character is not alphabetical.
 * You should consider running
 * `(isupper_l(c, l) ? tolower_l(c, l) : c)`
 * instead.
 * 
 * @etymology  Convert character (to) (lower)case, with consideration for (l)ocale!
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          The character in lowercase.
 *                  Guaranteed to be unchanged if the
 *                  character already is in lowercase.
 * 
 * @since  Always.
 */
int tolower_l(int, locale_t)
  __warning("This function is dangerous, use 'iswlower_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));

/**
 * Convert a lowercase ASCII character to
 * an uppercase ASCII character.
 * 
 * The function's behaviour is unspecifed
 * of the character is not alphabetical.
 * You should consider running
 * `(isupper_l(c, l) ? tolower_l(c, l) : c)`
 * instead.
 * 
 * @etymology  Convert character (to) (upper)case, with consideration for (l)ocale!
 * 
 * @param   c       The character.
 * @param   locale  The locale.
 * @return          The character in uppercase.
 *                  Guaranteed to be unchanged if the
 *                  character already is in lowercase.
 * 
 * @since  Always.
 */
int toupper_l(int, locale_t)
  __warning("This function is dangerous, use 'iswupper_l' instead.")
  __GCC_ONLY(__attribute__((__const__, __warn_unused_result__)));



#endif