2003-12-11 Michael Chastain <mec.gnu@mindspring.com>
[external/binutils.git] / readline / rlmbutil.h
1 /* rlmbutil.h -- utility functions for multibyte characters. */
2
3 /* Copyright (C) 2001, 2003 Free Software Foundation, Inc.
4
5    This file is part of the GNU Readline Library, a library for
6    reading lines of text with interactive input and history editing.
7
8    The GNU Readline Library is free software; you can redistribute it
9    and/or modify it under the terms of the GNU General Public License
10    as published by the Free Software Foundation; either version 2, or
11    (at your option) any later version.
12
13    The GNU Readline Library is distributed in the hope that it will be
14    useful, but WITHOUT ANY WARRANTY; without even the implied warranty
15    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    The GNU General Public License is often shipped with GNU software, and
19    is generally kept in a file called COPYING or LICENSE.  If you do not
20    have a copy of the license, write to the Free Software Foundation,
21    59 Temple Place, Suite 330, Boston, MA 02111 USA. */
22
23 #if !defined (_RL_MBUTIL_H_)
24 #define _RL_MBUTIL_H_
25
26 #include "rlstdc.h"
27
28 /************************************************/
29 /* check multibyte capability for I18N code     */
30 /************************************************/
31
32 /* For platforms which support the ISO C amendement 1 functionality we
33    support user defined character classes.
34
35    Some platforms have the multibyte functions such as mbsrtowcs but
36    are lacking the multitype type mbstate_t.  BeOS (unknown version)
37    and HP/UX 11.23 without _XOPEN_SOURCE=500 are like this.
38
39    We really need mbstate_t type to operate properly.  For example, see
40    compute_lcd_of_matches, where two mbstate_t's are active at the same
41    time.  So we require both the functions and the mbstate_t type in
42    order to enable multibyte support.  */
43
44    /* Solaris 2.5 has a bug: <wchar.h> must be included before <wctype.h>.  */
45 #if defined (HAVE_WCTYPE_H) && defined (HAVE_WCHAR_H)
46 #  include <wchar.h>
47 #  include <wctype.h>
48 #  if defined (HAVE_MBSTATE_T) && defined (HAVE_MBSRTOWCS)
49      /* system is supposed to support XPG5 */
50 #    define HANDLE_MULTIBYTE      1
51 #  endif
52 #endif
53
54 /* Make sure MB_LEN_MAX is at least 16 on systems that claim to be able to
55    handle multibyte chars (some systems define MB_LEN_MAX as 1) */
56 #ifdef HANDLE_MULTIBYTE
57 #  include <limits.h>
58 #  if defined(MB_LEN_MAX) && (MB_LEN_MAX < 16)
59 #    undef MB_LEN_MAX
60 #  endif
61 #  if !defined (MB_LEN_MAX)
62 #    define MB_LEN_MAX 16
63 #  endif
64 #endif
65
66 /************************************************/
67 /* end of multibyte capability checks for I18N  */
68 /************************************************/
69
70 /*
71  * Flags for _rl_find_prev_mbchar and _rl_find_next_mbchar:
72  *
73  * MB_FIND_ANY          find any multibyte character
74  * MB_FIND_NONZERO      find a non-zero-width multibyte character
75  */
76
77 #define MB_FIND_ANY     0x00
78 #define MB_FIND_NONZERO 0x01
79
80 extern int _rl_find_prev_mbchar PARAMS((char *, int, int));
81 extern int _rl_find_next_mbchar PARAMS((char *, int, int, int));
82
83 #ifdef HANDLE_MULTIBYTE
84
85 extern int _rl_compare_chars PARAMS((char *, int, mbstate_t *, char *, int, mbstate_t *));
86 extern int _rl_get_char_len PARAMS((char *, mbstate_t *));
87 extern int _rl_adjust_point PARAMS((char *, int, mbstate_t *));
88
89 extern int _rl_read_mbchar PARAMS((char *, int));
90 extern int _rl_read_mbstring PARAMS((int, char *, int));
91
92 extern int _rl_is_mbchar_matched PARAMS((char *, int, int, char *, int));
93
94 #else /* !HANDLE_MULTIBYTE */
95
96 #undef MB_LEN_MAX
97 #undef MB_CUR_MAX
98
99 #define MB_LEN_MAX      1
100 #define MB_CUR_MAX      1
101
102 #define _rl_find_prev_mbchar(b, i, f)           (((i) == 0) ? (i) : ((i) - 1))
103 #define _rl_find_next_mbchar(b, i1, i2, f)      ((i1) + (i2))
104
105 #endif /* !HANDLE_MULTIBYTE */
106
107 extern int rl_byte_oriented;
108
109 #endif /* _RL_MBUTIL_H_ */