pintos-os.org Git - pspp/blob - src/libpspp/i18n.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2006, 2010, 2011, 2012, 2014, 2016 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #ifndef I18N_H
  18 #define I18N_H
  19
  20 #include "libpspp/compiler.h"
  21 #include "libpspp/str.h"
  22 #include <stdbool.h>
  23 #include <unistr.h>
  24
  25 void  i18n_done (void);
  26 void  i18n_init (void);
  27
  28 #define UTF8 "UTF-8"
  29
  30 /* The encoding of literal strings in PSPP source code, as seen at execution
  31    time.  In fact this is likely to be some extended ASCII encoding, such as
  32    UTF-8 or ISO-8859-1, but ASCII is adequate for our purposes. */
  33 #define C_ENCODING "ASCII"
  34
  35 struct pool;
  36
  37 char recode_byte (const char *to, const char *from, char);
  38
  39 char *recode_string (const char *to, const char *from,
  40                      const char *text, int len);
  41 char *recode_string_pool (const char *to, const char *from,
  42                           const char *text, int length, struct pool *);
  43 struct substring recode_substring_pool (const char *to, const char *from,
  44                                         struct substring text, struct pool *);
  45 int recode_pedantically (const char *to, const char *from,
  46                          struct substring text, struct pool *,
  47                          struct substring *out);
  48
  49 size_t recode_string_len (const char *to, const char *from,
  50                           const char *text, int len);
  51
  52 char *utf8_encoding_trunc (const char *, const char *encoding,
  53                            size_t max_len);
  54 size_t utf8_encoding_trunc_len (const char *, const char *encoding,
  55                                 size_t max_len);
  56
  57 char *utf8_encoding_concat (const char *head, const char *tail,
  58                             const char *encoding, size_t max_len);
  59 size_t utf8_encoding_concat_len (const char *head, const char *tail,
  60                                  const char *encoding, size_t max_len);
  61
  62 char *utf8_to_filename (const char *filename);
  63 char *filename_to_utf8 (const char *filename);
  64
  65 bool valid_encoding (const char *enc);
  66
  67 char get_system_decimal (void);
  68
  69 const char * get_default_encoding (void);
  70 void set_default_encoding (const char *enc);
  71
  72 bool set_encoding_from_locale (const char *loc);
  73
  74 const char *uc_name (ucs4_t uc, char buffer[16]);
  75
  76 unsigned int utf8_hash_case_bytes (const char *, size_t n, unsigned int basis) WARN_UNUSED_RESULT;
  77 unsigned int utf8_hash_case_string (const char *, unsigned int basis) WARN_UNUSED_RESULT;
  78 unsigned int utf8_hash_case_substring (struct substring, unsigned int basis)
  79   WARN_UNUSED_RESULT;
  80 int utf8_strcasecmp (const char *, const char *);
  81 int utf8_sscasecmp (struct substring, struct substring);
  82 int utf8_strncasecmp (const char *, size_t, const char *, size_t);
  83 int utf8_strverscasecmp (const char *, const char *);
  84 char *utf8_to_upper (const char *);
  85 char *utf8_to_lower (const char *);
  86 char *utf8_to_title (const char *);
  87 \f
  88 /* Information about character encodings. */
  89
  90 /* ISO C defines a set of characters that a C implementation must support at
  91    runtime, called the C basic execution character set, which consists of the
  92    following characters:
  93
  94        A B C D E F G H I J K L M
  95        N O P Q R S T U V W X Y Z
  96        a b c d e f g h i j k l m
  97        n o p q r s t u v w x y z
  98        0 1 2 3 4 5 6 7 8 9
  99        ! " # % & ' () * + , - . / :
 100        ; < = > ? [ \ ] ^ _ { | } ~
 101        space \a \b \r \n \t \v \f \0
 102
 103    The following is true of every member of the C basic execution character
 104    set in all "reasonable" encodings:
 105
 106        1. Every member of the C basic character set is encoded.
 107
 108        2. Every member of the C basic character set has the same width in
 109           bytes, called the "unit width".  Most encodings have a unit width of
 110           1 byte, but UCS-2 and UTF-16 have a unit width of 2 bytes and UCS-4
 111           and UTF-32 have a unit width of 4 bytes.
 112
 113        3. In a stateful encoding, the encoding of members of the C basic
 114           character set does not vary with shift state.
 115
 116        4. When a string is read unit-by-unit, a unit that has the encoded value
 117           of a member of the C basic character set, EXCEPT FOR THE DECIMAL
 118           DIGITS, always represents that member.  That is, if the encoding has
 119           multi-unit characters, the units that encode the C basic character
 120           set are never part of a multi-unit character.
 121
 122           The exception for decimal digits is due to GB18030, which uses
 123           decimal digits as part of multi-byte encodings.
 124
 125    All 8-bit and wider encodings that I have been able to find follow these
 126    rules.  7-bit and narrower encodings (e.g. UTF-7) do not.  I'm not too
 127    concerned about that. */
 128
 129 #include <stdbool.h>
 130
 131 /* Maximum width of a unit, in bytes.  UTF-32 with 4-byte units is the widest
 132    that I am aware of. */
 133 #define MAX_UNIT 4
 134
 135 /* Information about an encoding. */
 136 struct encoding_info
 137   {
 138     /* Encoding name.  IANA says character set names may be up to 40 US-ASCII
 139        characters. */
 140     char name[41];
 141
 142     /* True if this encoding has a unit width of 1 byte, and every character
 143        used in ASCII text files has the same value in this encoding. */
 144     bool is_ascii_compatible;
 145
 146     /* True if this encoding has a unit width of 1 byte and appears to be
 147        EBCDIC-based.  */
 148     bool is_ebcdic_compatible;
 149
 150     /* Character information. */
 151     int unit;                   /* Unit width, in bytes. */
 152     char cr[MAX_UNIT];          /* \r in encoding, 'unit' bytes long. */
 153     char lf[MAX_UNIT];          /* \n in encoding, 'unit' bytes long. */
 154     char space[MAX_UNIT];       /* ' ' in encoding, 'unit' bytes long. */
 155   };
 156
 157 bool get_encoding_info (struct encoding_info *, const char *name);
 158 bool is_encoding_ascii_compatible (const char *encoding);
 159 bool is_encoding_ebcdic_compatible (const char *encoding);
 160 bool is_encoding_supported (const char *encoding);
 161
 162 bool is_encoding_utf8 (const char *encoding);
 163 \f
 164 /* Database of encodings, by language or region. */
 165
 166 struct encoding_category
 167   {
 168     const char *category;       /* e.g. "Arabic" or "Western European". */
 169     const char **encodings;     /* Encodings within the category. */
 170     size_t n_encodings;         /* Number of encodings in category. */
 171   };
 172
 173 struct encoding_category *get_encoding_categories (void);
 174 size_t get_n_encoding_categories (void);
 175
 176 /* Return the ISO two letter code for the current LC_MESSAGES
 177    locale category.  */
 178 char *get_language (void);
 179
 180 #endif /* i18n.h */