gui: Fix behavior of print preview in psppire-output-window.
[pspp] / src / libpspp / i18n.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2006, 2010, 2011 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 <stdbool.h>
21 #include <unistr.h>
22
23 void  i18n_done (void);
24 void  i18n_init (void);
25
26 #define UTF8 "UTF-8"
27
28 /* The encoding of literal strings in PSPP source code, as seen at execution
29    time.  In fact this is likely to be some extended ASCII encoding, such as
30    UTF-8 or ISO-8859-1, but ASCII is adequate for our purposes. */
31 #define C_ENCODING "ASCII"
32
33 struct pool;
34
35 char recode_byte (const char *to, const char *from, char);
36
37 char *recode_string (const char *to, const char *from,
38                      const char *text, int len);
39 char *recode_string_pool (const char *to, const char *from,
40                           const char *text, int length, struct pool *);
41 struct substring recode_substring_pool (const char *to, const char *from,
42                                         struct substring text, struct pool *);
43
44 size_t recode_string_len (const char *to, const char *from,
45                           const char *text, int len);
46
47 char *utf8_encoding_trunc (const char *, const char *encoding,
48                            size_t max_len);
49 size_t utf8_encoding_trunc_len (const char *, const char *encoding,
50                                 size_t max_len);
51
52 char *utf8_encoding_concat (const char *head, const char *tail,
53                             const char *encoding, size_t max_len);
54 size_t utf8_encoding_concat_len (const char *head, const char *tail,
55                                  const char *encoding, size_t max_len);
56
57 char *utf8_to_filename (const char *filename);
58 char *filename_to_utf8 (const char *filename);
59
60 bool valid_encoding (const char *enc);
61
62 char get_system_decimal (void);
63
64 const char * get_default_encoding (void);
65 void set_default_encoding (const char *enc);
66
67 bool set_encoding_from_locale (const char *loc);
68
69 const char *uc_name (ucs4_t uc, char buffer[16]);
70 \f
71 /* Information about character encodings. */
72
73 /* ISO C defines a set of characters that a C implementation must support at
74    runtime, called the C basic execution character set, which consists of the
75    following characters:
76
77        A B C D E F G H I J K L M
78        N O P Q R S T U V W X Y Z
79        a b c d e f g h i j k l m
80        n o p q r s t u v w x y z
81        0 1 2 3 4 5 6 7 8 9
82        ! " # % & ' ( ) * + , - . / :
83        ; < = > ? [ \ ] ^ _ { | } ~
84        space \a \b \r \n \t \v \f \0
85
86    The following is true of every member of the C basic execution character
87    set in all "reasonable" encodings:
88
89        1. Every member of the C basic character set is encoded.
90
91        2. Every member of the C basic character set has the same width in
92           bytes, called the "unit width".  Most encodings have a unit width of
93           1 byte, but UCS-2 and UTF-16 have a unit width of 2 bytes and UCS-4
94           and UTF-32 have a unit width of 4 bytes.
95
96        3. In a stateful encoding, the encoding of members of the C basic
97           character set does not vary with shift state.
98
99        4. When a string is read unit-by-unit, a unit that has the encoded value
100           of a member of the C basic character set, EXCEPT FOR THE DECIMAL
101           DIGITS, always represents that member.  That is, if the encoding has
102           multi-unit characters, the units that encode the C basic character
103           set are never part of a multi-unit character.
104
105           The exception for decimal digits is due to GB18030, which uses
106           decimal digits as part of multi-byte encodings.
107
108    All 8-bit and wider encodings that I have been able to find follow these
109    rules.  7-bit and narrower encodings (e.g. UTF-7) do not.  I'm not too
110    concerned about that. */
111
112 #include <stdbool.h>
113
114 /* Maximum width of a unit, in bytes.  UTF-32 with 4-byte units is the widest
115    that I am aware of. */
116 #define MAX_UNIT 4
117
118 /* Information about an encoding. */
119 struct encoding_info
120   {
121     /* Encoding name.  IANA says character set names may be up to 40 US-ASCII
122        characters. */
123     char name[41];
124
125     /* True if this encoding has a unit width of 1 byte, and every character
126        used in ASCII text files has the same value in this encoding. */
127     bool is_ascii_compatible;
128
129     /* Character information. */
130     int unit;                   /* Unit width, in bytes. */
131     char cr[MAX_UNIT];          /* \r in encoding, 'unit' bytes long. */
132     char lf[MAX_UNIT];          /* \n in encoding, 'unit' bytes long. */
133   };
134
135 bool get_encoding_info (struct encoding_info *, const char *name);
136 bool is_encoding_ascii_compatible (const char *encoding);
137 bool is_encoding_supported (const char *encoding);
138
139 #endif /* i18n.h */