doc/c-strcaseeq.texi

   1 @c Documentation of gnulib module 'c-strcaseeq'.
   2
   3 @c Copyright (C) 2008-2018 Free Software Foundation, Inc.
   4
   5 @c Permission is granted to copy, distribute and/or modify this document
   6 @c under the terms of the GNU Free Documentation License, Version 1.3 or
   7 @c any later version published by the Free Software Foundation; with no
   8 @c Invariant Sections, no Front-Cover Texts, and no Back-Cover
   9 @c Texts.  A copy of the license is included in the ``GNU Free
  10 @c Documentation License'' file as part of this distribution.
  11
  12 The @code{c-strcaseeq} module contains an optimized case-insensitive
  13 string comparison function operating on single-byte character strings, that
  14 operate as if the locale encoding was ASCII.
  15 (The "C" locale on many systems has the locale encoding "ASCII".)
  16
  17 The functions is actually implemented as a macro:
  18 @smallexample
  19 extern int STRCASEEQ (const char *s1, const char *s2,
  20                       int s20, int s21, int s22, int s23, int s24, int s25,
  21                       int s26, int s27, int s28);
  22 @end smallexample
  23
  24 @var{s2} should be a short literal ASCII string, and @var{s20}, @var{s21}, ...
  25 the individual characters of @var{s2}.
  26
  27 For case conversion here, only ASCII characters are considered to be
  28 upper case or lower case.