]> git.lyx.org Git - lyx.git/blob - src/Encoding.cpp
lexer cosmetics
[lyx.git] / src / Encoding.cpp
1 /**
2  * \file Encoding.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Lars Gullik Bjønnes
7  * \author Jean-Marc Lasgouttes
8  * \author Dekel Tsur
9  *
10  * Full author contact details are available in file CREDITS.
11  */
12
13 #include <config.h>
14
15 #include "Encoding.h"
16
17 #include "LaTeXFeatures.h"
18 #include "Lexer.h"
19 #include "LyXRC.h"
20
21 #include "support/debug.h"
22 #include "support/FileName.h"
23 #include "support/lstrings.h"
24 #include "support/unicode.h"
25
26 #include <boost/cstdint.hpp>
27
28 #include <sstream>
29
30 using namespace std;
31 using namespace lyx::support;
32
33 namespace lyx {
34
35 Encodings encodings;
36
37 namespace {
38
39 char_type arabic_table[172][4] = {
40         {0xfe80, 0xfe80, 0xfe80, 0xfe80}, // 0x0621 = hamza
41         {0xfe81, 0xfe82, 0xfe81, 0xfe82}, // 0x0622 = ligature madda on alef
42         {0xfe83, 0xfe84, 0xfe83, 0xfe84}, // 0x0623 = ligature hamza on alef
43         {0xfe85, 0xfe86, 0xfe85, 0xfe86}, // 0x0624 = ligature hamza on waw
44         {0xfe87, 0xfe88, 0xfe87, 0xfe88}, // 0x0625 = ligature hamza under alef
45         {0xfe89, 0xfe8a, 0xfe8b, 0xfe8c}, // 0x0626 = ligature hamza on ya
46         {0xfe8d, 0xfe8e, 0xfe8d, 0xfe8e}, // 0x0627 = alef
47         {0xfe8f, 0xfe90, 0xfe91, 0xfe92}, // 0x0628 = baa
48         {0xfe93, 0xfe94, 0xfe93, 0xfe94}, // 0x0629 = taa marbuta
49         {0xfe95, 0xfe96, 0xfe97, 0xfe98}, // 0x062a = taa
50         {0xfe99, 0xfe9a, 0xfe9b, 0xfe9c}, // 0x062b = thaa
51         {0xfe9d, 0xfe9e, 0xfe9f, 0xfea0}, // 0x062c = jeem
52         {0xfea1, 0xfea2, 0xfea3, 0xfea4}, // 0x062d = haa
53         {0xfea5, 0xfea6, 0xfea7, 0xfea8}, // 0x062e = khaa
54         {0xfea9, 0xfeaa, 0xfea9, 0xfeaa}, // 0x062f = dal
55
56         {0xfeab, 0xfeac, 0xfeab, 0xfeac}, // 0x0630 = thal
57         {0xfead, 0xfeae, 0xfead, 0xfeae}, // 0x0631 = ra
58         {0xfeaf, 0xfeb0, 0xfeaf, 0xfeb0}, // 0x0632 = zain
59         {0xfeb1, 0xfeb2, 0xfeb3, 0xfeb4}, // 0x0633 = seen
60         {0xfeb5, 0xfeb6, 0xfeb7, 0xfeb8}, // 0x0634 = sheen
61         {0xfeb9, 0xfeba, 0xfebb, 0xfebc}, // 0x0635 = sad
62         {0xfebd, 0xfebe, 0xfebf, 0xfec0}, // 0x0636 = dad
63         {0xfec1, 0xfec2, 0xfec3, 0xfec4}, // 0x0637 = tah
64         {0xfec5, 0xfec6, 0xfec7, 0xfec8}, // 0x0638 = zah
65         {0xfec9, 0xfeca, 0xfecb, 0xfecc}, // 0x0639 = ain
66         {0xfecd, 0xfece, 0xfecf, 0xfed0}, // 0x063a = ghain
67         {0, 0, 0, 0}, // 0x063b
68         {0, 0, 0, 0}, // 0x063c
69         {0, 0, 0, 0}, // 0x063d
70         {0, 0, 0, 0}, // 0x063e
71         {0, 0, 0, 0}, // 0x063f
72
73         {0, 0, 0, 0}, // 0x0640
74         {0xfed1, 0xfed2, 0xfed3, 0xfed4}, // 0x0641 = fa
75         {0xfed5, 0xfed6, 0xfed7, 0xfed8}, // 0x0642 = qaf
76         {0xfed9, 0xfeda, 0xfedb, 0xfedc}, // 0x0643 = kaf
77         {0xfedd, 0xfede, 0xfedf, 0xfee0}, // 0x0644 = lam
78         {0xfee1, 0xfee2, 0xfee3, 0xfee4}, // 0x0645 = meem
79         {0xfee5, 0xfee6, 0xfee7, 0xfee8}, // 0x0646 = noon
80         {0xfee9, 0xfeea, 0xfeeb, 0xfeec}, // 0x0647 = ha
81         {0xfeed, 0xfeee, 0xfeed, 0xfeee}, // 0x0648 = waw
82         {0xfeef, 0xfef0, 0xfeef, 0xfef0}, // 0x0649 = alef maksura
83         {0xfef1, 0xfef2, 0xfef3, 0xfef4}, // 0x064a = ya
84         {0x065b, 0x065b, 0x065b, 0x065b}, // 0x064b = fathatan
85         {0x065c, 0x065c, 0x065c, 0x065c}, // 0x064c = dammatan
86         {0x064d, 0x064d, 0x064d, 0x064d}, // 0x064d = kasratan
87         {0x064e, 0x064e, 0x064e, 0x064e}, // 0x064e = fatha
88         {0x064f, 0x064f, 0x064f, 0x064f}, // 0x064f = damma
89
90         {0x0650, 0x0650, 0x0650, 0x0650}, // 0x0650 = kasra
91         {0x0651, 0x0651, 0x0651, 0x0651}, // 0x0651 = shadda
92         {0x0652, 0x0652, 0x0652, 0x0652}, // 0x0652 = sukun
93
94         {0, 0, 0, 0}, // 0x0653
95         {0, 0, 0, 0}, // 0x0654
96         {0, 0, 0, 0}, // 0x0655
97         {0, 0, 0, 0}, // 0x0656
98         {0, 0, 0, 0}, // 0x0657
99         {0, 0, 0, 0}, // 0x0658
100         {0, 0, 0, 0}, // 0x0659
101         {0, 0, 0, 0}, // 0x065a
102         {0, 0, 0, 0}, // 0x065b
103         {0, 0, 0, 0}, // 0x065c
104         {0, 0, 0, 0}, // 0x065d
105         {0, 0, 0, 0}, // 0x065e
106         {0, 0, 0, 0}, // 0x065f
107         {0, 0, 0, 0}, // 0x0660
108         {0, 0, 0, 0}, // 0x0661
109         {0, 0, 0, 0}, // 0x0662
110         {0, 0, 0, 0}, // 0x0663
111         {0, 0, 0, 0}, // 0x0664
112         {0, 0, 0, 0}, // 0x0665
113         {0, 0, 0, 0}, // 0x0666
114         {0, 0, 0, 0}, // 0x0667
115         {0, 0, 0, 0}, // 0x0668
116         {0, 0, 0, 0}, // 0x0669
117         {0, 0, 0, 0}, // 0x066a
118         {0, 0, 0, 0}, // 0x066b
119         {0, 0, 0, 0}, // 0x066c
120         {0, 0, 0, 0}, // 0x066d
121         {0, 0, 0, 0}, // 0x066e
122         {0, 0, 0, 0}, // 0x066f
123         {0, 0, 0, 0}, // 0x0670
124         {0, 0, 0, 0}, // 0x0671
125         {0, 0, 0, 0}, // 0x0672
126         {0, 0, 0, 0}, // 0x0673
127         {0, 0, 0, 0}, // 0x0674
128         {0, 0, 0, 0}, // 0x0675
129         {0, 0, 0, 0}, // 0x0676
130         {0, 0, 0, 0}, // 0x0677
131         {0, 0, 0, 0}, // 0x0678
132         {0, 0, 0, 0}, // 0x0679
133         {0, 0, 0, 0}, // 0x067a
134         {0, 0, 0, 0}, // 0x067b
135         {0, 0, 0, 0}, // 0x067c
136         {0, 0, 0, 0}, // 0x067d
137         {0xfb56, 0xfb57, 0xfb58, 0xfb59}, // 0x067e = peh 
138         {0, 0, 0, 0}, // 0x067f
139         {0, 0, 0, 0}, // 0x0680
140         {0, 0, 0, 0}, // 0x0681
141         {0, 0, 0, 0}, // 0x0682
142         {0, 0, 0, 0}, // 0x0683
143         {0, 0, 0, 0}, // 0x0684
144         {0, 0, 0, 0}, // 0x0685
145         {0xfb7a, 0xfb7b, 0xfb7c, 0xfb7d}, // 0x0686 = tcheh 
146         {0, 0, 0, 0}, // 0x0687
147         {0, 0, 0, 0}, // 0x0688
148         {0, 0, 0, 0}, // 0x0689
149         {0, 0, 0, 0}, // 0x068a
150         {0, 0, 0, 0}, // 0x068b
151         {0, 0, 0, 0}, // 0x068c
152         {0, 0, 0, 0}, // 0x068d
153         {0, 0, 0, 0}, // 0x068e
154         {0, 0, 0, 0}, // 0x068f
155         {0, 0, 0, 0}, // 0x0690
156         {0, 0, 0, 0}, // 0x0691
157         {0, 0, 0, 0}, // 0x0692
158         {0, 0, 0, 0}, // 0x0693
159         {0, 0, 0, 0}, // 0x0694
160         {0, 0, 0, 0}, // 0x0695
161         {0, 0, 0, 0}, // 0x0696
162         {0, 0, 0, 0}, // 0x0697
163         {0xfb8a, 0xfb8b, 0xfb8a, 0xfb8b}, // 0x0698 = jeh
164         {0, 0, 0, 0}, // 0x0699
165         {0, 0, 0, 0}, // 0x069a
166         {0, 0, 0, 0}, // 0x069b
167         {0, 0, 0, 0}, // 0x069c
168         {0, 0, 0, 0}, // 0x069d
169         {0, 0, 0, 0}, // 0x069e
170         {0, 0, 0, 0}, // 0x069f
171         {0, 0, 0, 0}, // 0x06a0
172         {0, 0, 0, 0}, // 0x06a1
173         {0, 0, 0, 0}, // 0x06a2
174         {0, 0, 0, 0}, // 0x06a3
175         {0, 0, 0, 0}, // 0x06a4
176         {0, 0, 0, 0}, // 0x06a5
177         {0, 0, 0, 0}, // 0x06a6
178         {0, 0, 0, 0}, // 0x06a7
179         {0, 0, 0, 0}, // 0x06a8
180         {0xfb8e, 0xfb8f, 0xfb90, 0xfb91}, // 0x06a9 = farsi kaf 
181         {0, 0, 0, 0}, // 0x06aa
182         {0, 0, 0, 0}, // 0x06ab
183         {0, 0, 0, 0}, // 0x06ac
184         {0, 0, 0, 0}, // 0x06ad
185         {0, 0, 0, 0}, // 0x06ae
186         {0xfb92, 0xfb93, 0xfb94, 0xfb95}, // 0x06af = gaf 
187         {0, 0, 0, 0}, // 0x06b0
188         {0, 0, 0, 0}, // 0x06b1
189         {0, 0, 0, 0}, // 0x06b2
190         {0, 0, 0, 0}, // 0x06b3
191         {0, 0, 0, 0}, // 0x06b4
192         {0, 0, 0, 0}, // 0x06b5
193         {0, 0, 0, 0}, // 0x06b6
194         {0, 0, 0, 0}, // 0x06b7
195         {0, 0, 0, 0}, // 0x06b8
196         {0, 0, 0, 0}, // 0x06b9
197         {0, 0, 0, 0}, // 0x06ba
198         {0, 0, 0, 0}, // 0x06bb
199         {0, 0, 0, 0}, // 0x06bc
200         {0, 0, 0, 0}, // 0x06bd
201         {0, 0, 0, 0}, // 0x06be
202         {0, 0, 0, 0}, // 0x06bf
203         {0, 0, 0, 0}, // 0x06c0
204         {0, 0, 0, 0}, // 0x06c1
205         {0, 0, 0, 0}, // 0x06c2
206         {0, 0, 0, 0}, // 0x06c3
207         {0, 0, 0, 0}, // 0x06c4
208         {0, 0, 0, 0}, // 0x06c5
209         {0, 0, 0, 0}, // 0x06c6
210         {0, 0, 0, 0}, // 0x06c7
211         {0, 0, 0, 0}, // 0x06c8
212         {0, 0, 0, 0}, // 0x06c9
213         {0, 0, 0, 0}, // 0x06ca
214         {0, 0, 0, 0}, // 0x06cb
215         {0xfbfc, 0xfbfd, 0xfbfe, 0xfbff} // 0x06cc = farsi yeh  
216 };
217
218
219 char_type const arabic_start = 0x0621;
220 char_type const arabic_end = 0x06cc;
221
222
223 /// Information about a single UCS4 character
224 struct CharInfo {
225         /// LaTeX command for this character
226         docstring command;
227         /// Needed LaTeX preamble (or feature)
228         string preamble;
229         /// Is this a combining character?
230         bool combining;
231         /// Is \c preamble a feature known by LaTeXFeatures, or a raw LaTeX
232         /// command?
233         bool feature;
234         /// Always force the LaTeX command, even if the encoding contains
235         /// this character?
236         bool force;
237 };
238
239
240 typedef map<char_type, CharInfo> CharInfoMap;
241 CharInfoMap unicodesymbols;
242
243
244 /// The highest code point in UCS4 encoding (1<<20 + 1<<16)
245 char_type const max_ucs4 = 0x110000;
246
247 } // namespace anon
248
249
250 EncodingException::EncodingException(char_type c)
251         : failed_char(c), par_id(0), pos(0)
252 {
253 }
254
255
256 const char * EncodingException::what() const throw()
257 {
258         return "Could not find LaTeX command for a character";
259 }
260
261
262 Encoding::Encoding(string const & n, string const & l, string const & i,
263                    bool f, Encoding::Package p)
264         : name_(n), latexName_(l), iconvName_(i), fixedwidth_(f), package_(p)
265 {
266         if (n == "ascii") {
267                 // ASCII can encode 128 code points and nothing else
268                 start_encodable_ = 128;
269                 complete_ = true;
270         } else if (i == "UTF-8") {
271                 // UTF8 can encode all UCS4 code points
272                 start_encodable_ = max_ucs4;
273                 complete_ = true;
274         } else {
275                 complete_ = false;
276         }
277 }
278
279
280 void Encoding::init() const
281 {
282         if (complete_)
283                 return;
284
285         start_encodable_ = 0;
286         // temporarily switch off lyxerr, since we will generate iconv errors
287         lyxerr.disable();
288         if (fixedwidth_) {
289                 // We do not need to check all UCS4 code points, it is enough
290                 // if we check all 256 code points of this encoding.
291                 for (unsigned short j = 0; j < 256; ++j) {
292                         char const c = char(j);
293                         vector<char_type> const ucs4 = eightbit_to_ucs4(&c, 1, iconvName_);
294                         if (ucs4.size() != 1)
295                                 continue;
296                         char_type const uc = ucs4[0];
297                         CharInfoMap::const_iterator const it = unicodesymbols.find(uc);
298                         if (it == unicodesymbols.end() || !it->second.force)
299                                 encodable_.insert(uc);
300                 }
301         } else {
302                 // We do not know how many code points this encoding has, and
303                 // they do not have a direct representation as a single byte,
304                 // therefore we need to check all UCS4 code points.
305                 // This is expensive!
306                 for (char_type c = 0; c < max_ucs4; ++c) {
307                         vector<char> const eightbit = ucs4_to_eightbit(&c, 1, iconvName_);
308                         if (!eightbit.empty()) {
309                                 CharInfoMap::const_iterator const it = unicodesymbols.find(c);
310                                 if (it == unicodesymbols.end() || !it->second.force)
311                                         encodable_.insert(c);
312                         }
313                 }
314         }
315         lyxerr.enable();
316         CharSet::iterator it = encodable_.find(start_encodable_);
317         while (it != encodable_.end()) {
318                 encodable_.erase(it);
319                 ++start_encodable_;
320                 it = encodable_.find(start_encodable_);
321         }
322         complete_ = true;
323 }
324
325
326 docstring Encoding::latexChar(char_type c) const
327 {
328         // assure the used encoding is properly initialized
329         init();
330
331         if (c < start_encodable_)
332                 return docstring(1, c);
333         if (encodable_.find(c) != encodable_.end())
334                 return docstring(1, c);
335
336         // c cannot be encoded in this encoding
337         CharInfoMap::const_iterator const it = unicodesymbols.find(c);
338         if (it == unicodesymbols.end())
339                 throw EncodingException(c);
340         return it->second.command;
341 }
342
343
344 vector<char_type> Encoding::symbolsList() const
345 {
346         // assure the used encoding is properly initialized
347         init();
348
349         // first all encodable characters
350         vector<char_type> symbols(encodable_.begin(), encodable_.end());
351         // add those below start_encodable_
352         for (char_type c = 0; c < start_encodable_; ++c)
353                 symbols.push_back(c);
354         // now the ones from the unicodesymbols file
355         CharInfoMap::const_iterator const end = unicodesymbols.end();
356         CharInfoMap::const_iterator it = unicodesymbols.begin();
357         for (; it != end; ++it)
358                 symbols.push_back(it->first);
359         return symbols;
360 }
361
362
363 void Encodings::validate(char_type c, LaTeXFeatures & features)
364 {
365         CharInfoMap::const_iterator const it = unicodesymbols.find(c);
366         if (it != unicodesymbols.end() && !it->second.preamble.empty()) {
367                 if (it->second.feature)
368                         features.require(it->second.preamble);
369                 else
370                         features.addPreambleSnippet(it->second.preamble);
371         }
372 }
373
374
375 bool Encodings::isHebrewComposeChar(char_type c)
376 {
377         return c <= 0x05c2 && c >= 0x05b0 && c != 0x05be && c != 0x05c0;
378 }
379
380
381 // Special Arabic letters are ones that do not get connected from left
382 // they are hamza, alef_madda, alef_hamza, waw_hamza, alef_hamza_under,
383 // alef, tah_marbota, dal, thal, rah, zai, wow, alef_maksoura
384
385 bool Encodings::isArabicSpecialChar(char_type c)
386 {
387         return (c >= 0x0621 && c <= 0x0625) || (c >= 0x0630 && c <= 0x0632)
388                 || c == 0x0627 || c == 0x0629 || c == 0x062f || c == 0x0648
389                 || c == 0x0649 || c == 0x0698;
390 }
391
392
393 bool Encodings::isArabicComposeChar(char_type c)
394 {
395         return c >= 0x064b && c <= 0x0652;
396 }
397
398
399 bool Encodings::isArabicChar(char_type c)
400 {
401         return c >= arabic_start && c <= arabic_end
402                 && arabic_table[c-arabic_start][0];
403 }
404
405
406 char_type Encodings::transformChar(char_type c, Encodings::LetterForm form)
407 {
408         return isArabicChar(c) ? arabic_table[c-arabic_start][form] : c;
409 }
410
411
412 bool Encodings::isCombiningChar(char_type c)
413 {
414         CharInfoMap::const_iterator const it = unicodesymbols.find(c);
415         if (it != unicodesymbols.end())
416                 return it->second.combining;
417         return false;
418 }
419
420
421 bool Encodings::isKnownScriptChar(char_type const c, string & preamble)
422 {
423         CharInfoMap::const_iterator const it = unicodesymbols.find(c);
424
425         if (it == unicodesymbols.end())
426                 return false;
427
428         if (it->second.preamble != "textgreek" && it->second.preamble != "textcyr")
429                 return false;
430
431         if (preamble.empty()) {
432                 preamble = it->second.preamble;
433                 return true;
434         }
435         return it->second.preamble == preamble;
436 }
437
438
439 Encoding const * Encodings::fromLyXName(string const & name) const
440 {
441         EncodingList::const_iterator const it = encodinglist.find(name);
442         return it != encodinglist.end() ? &it->second : 0;
443 }
444
445
446 Encoding const * Encodings::fromLaTeXName(string const & name) const
447 {
448         // We don't use find_if because it makes copies of the pairs in
449         // the map.
450         // This linear search is OK since we don't have many encodings.
451         // Users could even optimize it by putting the encodings they use
452         // most at the top of lib/encodings.
453         EncodingList::const_iterator const end = encodinglist.end();
454         for (EncodingList::const_iterator it = encodinglist.begin(); it != end; ++it)
455                 if (it->second.latexName() == name)
456                         return &it->second;
457         return 0;
458 }
459
460
461 Encodings::Encodings()
462 {
463 }
464
465
466 void Encodings::read(FileName const & encfile, FileName const & symbolsfile)
467 {
468         // We must read the symbolsfile first, because the Encoding
469         // constructor depends on it.
470         Lexer symbolslex;
471         symbolslex.setFile(symbolsfile);
472         while (symbolslex.isOK()) {
473                 char_type symbol;
474                 CharInfo info;
475                 string flags;
476
477                 if (!symbolslex.next(true))
478                         break;
479
480                 istringstream is(symbolslex.getString());
481                 // reading symbol directly does not work if
482                 // char_type == wchar_t.
483                 boost::uint32_t tmp;
484                 if(!(is >> hex >> tmp))
485                         break;
486                 symbol = tmp;
487
488                 if (!symbolslex.next(true))
489                         break;
490                 info.command = symbolslex.getDocString();
491                 if (!symbolslex.next(true))
492                         break;
493                 info.preamble = symbolslex.getString();
494                 if (!symbolslex.next(true))
495                         break;
496                 flags = symbolslex.getString();
497
498                 info.combining = false;
499                 info.feature = false;
500                 info.force = false;
501                 while (!flags.empty()) {
502                         string flag;
503                         flags = split(flags, flag, ',');
504                         if (flag == "combining")
505                                 info.combining = true;
506                         else if (flag == "force")
507                                 info.force = true;
508                         else
509                                 lyxerr << "Ignoring unknown flag `" << flag
510                                        << "' for symbol `0x"
511                                        << hex << symbol << dec
512                                        << "'." << endl;
513                 }
514
515                 if (!info.preamble.empty())
516                         info.feature = info.preamble[0] != '\\';
517
518                 LYXERR(Debug::INFO, "Read unicode symbol " << symbol << " '"
519                         << to_utf8(info.command) << "' '" << info.preamble
520                         << "' " << info.combining << ' ' << info.feature);
521                 unicodesymbols[symbol] = info;
522         }
523
524         // Now read the encodings
525         enum {
526                 et_encoding = 1,
527                 et_end,
528         };
529
530         LexerKeyword encodingtags[] = {
531                 { "encoding", et_encoding },
532                 { "end", et_end }
533         };
534
535         Lexer lex(encodingtags);
536         lex.setFile(encfile);
537         lex.setContext("Encodings::read");
538         while (lex.isOK()) {
539                 switch (lex.lex()) {
540                 case et_encoding:
541                 {
542                         lex.next();
543                         string const name = lex.getString();
544                         lex.next();
545                         string const latexname = lex.getString();
546                         lex.next();
547                         string const iconvname = lex.getString();
548                         lex.next();
549                         string const width = lex.getString();
550                         bool fixedwidth = false;
551                         if (width == "fixed")
552                                 fixedwidth = true;
553                         else if (width == "variable")
554                                 fixedwidth = false;
555                         else
556                                 lex.printError("Unknown width");
557
558                         lex.next();
559                         string const p = lex.getString();
560                         Encoding::Package package = Encoding::none;
561                         if (p == "none")
562                                 package = Encoding::none;
563                         else if (p == "inputenc")
564                                 package = Encoding::inputenc;
565                         else if (p == "CJK")
566                                 package = Encoding::CJK;
567                         else
568                                 lex.printError("Unknown package");
569
570                         LYXERR(Debug::INFO, "Reading encoding " << name);
571                         encodinglist[name] = Encoding(name, latexname,
572                                 iconvname, fixedwidth, package);
573
574                         if (lex.lex() != et_end)
575                                 lex.printError("Missing end");
576                         break;
577                 }
578                 case et_end:
579                         lex.printError("Misplaced end");
580                         break;
581                 case Lexer::LEX_FEOF:
582                         break;
583                 default:
584                         lex.printError("Unknown tag");
585                         break;
586                 }
587         }
588 }
589
590
591 } // namespace lyx