3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Matthias Ettrich
9 * Full author contact details are available in file CREDITS.
17 #include "BufferView.h"
19 #include "CutAndPaste.h"
20 #include "support/debug.h"
25 #include "support/FileName.h"
26 #include "support/filetools.h"
27 #include "support/lstrings.h"
28 #include "support/convert.h"
29 #include "support/docstream.h"
32 using namespace lyx::support;
36 /////////////////////////////////////////////////////////////////////
40 /////////////////////////////////////////////////////////////////////
42 /* the names used by TeX and XWindows for deadkeys/accents are not the same
43 so here follows a table to clearify the differences. Please correct this
46 |------------------|------------------|------------------|--------------|
47 | TeX | XWindows | \bind/LFUN | used by intl |
48 |------------------|------------------|------------------|--------------|
49 | grave | grave |LFUN_ACCENT_GRAVE | grave
50 | acute | acute |LFUN_ACCENT_ACUTE | acute
51 | circumflex | circumflex |LFUN_ACCENT_CIRCUMFLEX | circumflex
52 | umlaut/dieresis | diaeresis |LFUN_ACCENT_UMLAUT | umlaut
53 | tilde | tilde |LFUN_ACCENT_TILDE | tilde
54 | macron | maron |LFUN_ACCENT_MACRON | macron
55 | dot | abovedot |LFUN_ACCENT_DOT | dot
56 | cedilla | cedilla |LFUN_ACCENT_CEDILLA | cedilla
57 | underdot | |LFUN_ACCENT_UNDERDOT | underdot
58 | underbar | |LFUN_ACCENT_UNDERBAR | underbar
59 | hácek | caron |LFUN_ACCENT_CARON | caron
60 | breve | breve |LFUN_ACCENT_BREVE | breve
61 | tie | |LFUN_ACCENT_TIE | tie
62 | Hungarian umlaut | doubleacute |LFUN_ACCENT_HUNGARIAN_UMLAUT | hungarian umlaut
63 | circle | abovering |LFUN_ACCENT_CIRCLE | circle
67 | | semivoiced_sound | |
68 | | |LFUN_ACCENT_SPECIAL_CARON| special caron
70 static tex_accent_struct lyx_accent_table[] = {
71 {TEX_NOACCENT, 0, "", LFUN_NOACTION},
72 {TEX_ACUTE, 0x0301, "acute", LFUN_ACCENT_ACUTE},
73 {TEX_GRAVE, 0x0300, "grave", LFUN_ACCENT_GRAVE},
74 {TEX_MACRON, 0x0304, "macron", LFUN_ACCENT_MACRON},
75 {TEX_TILDE, 0x0303, "tilde", LFUN_ACCENT_TILDE},
76 {TEX_UNDERBAR, 0x0320, "underbar", LFUN_ACCENT_UNDERBAR},
77 {TEX_CEDILLA, 0x0327, "cedilla", LFUN_ACCENT_CEDILLA},
78 {TEX_UNDERDOT, 0x0323, "underdot", LFUN_ACCENT_UNDERDOT},
79 {TEX_CIRCUMFLEX, 0x0302, "circumflex", LFUN_ACCENT_CIRCUMFLEX},
80 {TEX_CIRCLE, 0x030a, "circle", LFUN_ACCENT_CIRCLE},
81 {TEX_TIE, 0x0361, "tie", LFUN_ACCENT_TIE},
82 {TEX_BREVE, 0x0306, "breve", LFUN_ACCENT_BREVE},
83 {TEX_CARON, 0x030c, "caron", LFUN_ACCENT_CARON},
84 // {TEX_SPECIAL_CARON, 0x030c, "ooo", LFUN_ACCENT_SPECIAL_CARON},
85 // Don't fix this typo for compatibility reasons!
86 {TEX_HUNGUML, 0x030b, "hugarian_umlaut", LFUN_ACCENT_HUNGARIAN_UMLAUT},
87 {TEX_UMLAUT, 0x0308, "umlaut", LFUN_ACCENT_UMLAUT},
88 {TEX_DOT, 0x0307, "dot", LFUN_ACCENT_DOT},
89 {TEX_OGONEK, 0x0328, "ogonek", LFUN_ACCENT_OGONEK}
93 tex_accent_struct get_accent(kb_action action)
96 while (i <= TEX_MAX_ACCENT) {
97 if (lyx_accent_table[i].action == action)
98 return lyx_accent_table[i];
101 struct tex_accent_struct temp = { static_cast<tex_accent>(0), 0,
102 0, static_cast<kb_action>(0)};
107 static docstring const doAccent(docstring const & s, tex_accent accent)
110 return docstring(1, lyx_accent_table[accent].ucs4);
114 os.put(lyx_accent_table[accent].ucs4);
115 if (s.length() > 1) {
116 if (accent != TEX_TIE || s.length() > 2)
117 lyxerr << "Warning: Too many characters given for accent "
118 << lyx_accent_table[accent].name << '.' << endl;
121 return normalize_c(os.str());
125 static docstring const doAccent(char_type c, tex_accent accent)
127 return doAccent(docstring(1, c), accent);
132 /////////////////////////////////////////////////////////////////////
136 /////////////////////////////////////////////////////////////////////
139 void Trans::insertException(KmodException & exclist, char_type c,
140 docstring const & data, bool flag, tex_accent accent)
147 exclist.insert(exclist.begin(), p);
149 // exclist.push_back(p);
153 void Trans::freeException(KmodException & exclist)
159 void Trans::freeKeymap()
166 bool Trans::isDefined() const
168 return !name_.empty();
181 struct keyword_item kmapTags[K_LAST - 1] = {
189 tex_accent getkeymod(string const &);
192 void Trans::addDeadkey(tex_accent accent, docstring const & keys)
197 kmod_list_[accent] = tmp;
199 for (docstring::size_type i = 0; i < keys.length(); ++i) {
200 // FIXME This is a hack.
201 // tmp is no valid UCS4 string, but misused to store the
205 tmp += char_type(accent);
206 keymap_[keys[i]] = tmp;
211 int Trans::load(Lexer & lex)
215 while (lex.isOK() && !error) {
219 LYXERR(Debug::KBMAP, "KMOD:\t" << lex.getString());
223 LYXERR(Debug::KBMAP, "key\t`" << lex.getString() << '\'');
225 docstring const keys = lex.getDocString();
230 LYXERR(Debug::KBMAP, "accent\t`" << lex.getString() << '\'');
232 tex_accent accent = getkeymod(lex.getString());
234 if (accent == TEX_NOACCENT)
238 // FIXME: This code should be removed...
239 // But we need to fix up all the kmap files first
240 // so that this field is not present anymore.
244 LYXERR(Debug::KBMAP, "allowed\t`" << lex.getString() << '\'');
246 /* string const allowed = lex.getString(); */
247 addDeadkey(accent, keys /*, allowed*/);
249 addDeadkey(accent, keys);
256 LYXERR(Debug::KBMAP, "KCOMB:");
260 str = lex.getString();
261 LYXERR(Debug::KBMAP, str);
263 tex_accent accent_1 = getkeymod(str);
264 if (accent_1 == TEX_NOACCENT)
270 str = lex.getString();
271 LYXERR(Debug::KBMAP, str);
273 tex_accent accent_2 = getkeymod(str);
274 if (accent_2 == TEX_NOACCENT) return -1;
276 map<tex_accent, KmodInfo>::iterator it1 =
277 kmod_list_.find(accent_1);
278 map<tex_accent, KmodInfo>::iterator it2 =
279 kmod_list_.find(accent_2);
280 if (it1 == kmod_list_.end() || it2 == kmod_list_.end())
283 // Find what key accent_2 is on - should
284 // check about accent_1 also
285 map<char_type, docstring>::iterator it = keymap_.begin();
286 map<char_type, docstring>::iterator end = keymap_.end();
287 for (; it != end; ++it) {
288 if (!it->second.empty()
289 && it->second[0] == 0
290 && it->second[1] == accent_2)
297 allowed = lex.getDocString();
298 LYXERR(Debug::KBMAP, "allowed: " << to_utf8(allowed));
300 insertException(kmod_list_[accent_1].exception_list,
301 it->first, allowed, true, accent_2);
305 unsigned char key_from;
307 LYXERR(Debug::KBMAP, "KMAP:\t" << lex.getString());
312 key_from = lex.getString()[0];
313 LYXERR(Debug::KBMAP, "\t`" << lex.getString() << '\'');
318 docstring const string_to = lex.getDocString();
319 keymap_[key_from] = string_to;
320 LYXERR(Debug::KBMAP, "\t`" << to_utf8(string_to) << '\'');
328 LYXERR(Debug::KBMAP, "KXMOD:\t" << lex.getString());
333 LYXERR(Debug::KBMAP, "\t`" << lex.getString() << '\'');
334 accent = getkeymod(lex.getString());
339 LYXERR(Debug::KBMAP, "\t`" << lex.getString() << '\'');
340 key = lex.getDocString()[0];
345 LYXERR(Debug::KBMAP, "\t`" << lex.getString() << '\'');
346 str = lex.getDocString();
348 insertException(kmod_list_[accent].exception_list,
352 case Lexer::LEX_FEOF:
353 LYXERR(Debug::PARSER, "End of parsing");
356 lex.printError("ParseKeymapFile: Unknown tag: `$$Token'");
364 bool Trans::isAccentDefined(tex_accent accent, KmodInfo & i) const
366 map<tex_accent, KmodInfo>::const_iterator cit = kmod_list_.find(accent);
367 if (cit == kmod_list_.end())
374 docstring const Trans::process(char_type c, TransManager & k)
376 docstring const t = match(c);
378 if (t.empty() && c != 0)
379 return k.normalkey(c);
381 if (!t.empty() && t[0] != 0)
382 return t; //return k.normalkey(c);
384 return k.deadkey(c, kmod_list_[static_cast<tex_accent>(t[1])]);
388 int Trans::load(string const & language)
390 FileName const filename = libFileSearch("kbd", language, "kmap");
391 if (filename.empty())
395 Lexer lex(kmapTags, K_LAST - 1);
396 lex.setFile(filename);
398 int const res = load(lex);
409 tex_accent getkeymod(string const & p)
410 /* return modifier - decoded from p and update p */
412 for (int i = 1; i <= TEX_MAX_ACCENT; ++i) {
413 LYXERR(Debug::KBMAP, "p = " << p
414 << ", lyx_accent_table[" << i
415 << "].name = `" << lyx_accent_table[i].name << '\'');
417 if (lyx_accent_table[i].name
418 && contains(p, lyx_accent_table[i].name)) {
419 LYXERR(Debug::KBMAP, "Found it!");
420 return static_cast<tex_accent>(i);
427 /////////////////////////////////////////////////////////////////////
431 /////////////////////////////////////////////////////////////////////
435 TransFSMData::TransFSMData()
437 deadkey_ = deadkey2_ = 0;
438 deadkey_info_.accent = deadkey2_info_.accent = TEX_NOACCENT;
443 char_type const TransState::TOKEN_SEP = 4;
447 TransInitState::TransInitState()
453 docstring const TransInitState::normalkey(char_type c)
461 docstring const TransInitState::deadkey(char_type c, KmodInfo d)
465 currentState = deadkey_state_;
471 TransDeadkeyState::TransDeadkeyState()
473 deadkey_state_ = this;
477 docstring const TransDeadkeyState::normalkey(char_type c)
481 KmodException::iterator it = deadkey_info_.exception_list.begin();
482 KmodException::iterator end = deadkey_info_.exception_list.end();
484 for (; it != end; ++it) {
491 res = doAccent(c, deadkey_info_.accent);
493 currentState = init_state_;
498 docstring const TransDeadkeyState::deadkey(char_type c, KmodInfo d)
502 // Check if the same deadkey was typed twice
506 deadkey_info_.accent = TEX_NOACCENT;
507 currentState = init_state_;
511 // Check if it is a combination or an exception
512 KmodException::const_iterator cit = deadkey_info_.exception_list.begin();
513 KmodException::const_iterator end = deadkey_info_.exception_list.end();
514 for (; cit != end; ++cit) {
515 if (cit->combined == true && cit->accent == d.accent) {
519 currentState = combined_state_;
525 deadkey_info_.accent = TEX_NOACCENT;
526 currentState = init_state_;
531 // Not a combination or an exception.
532 // Output deadkey1 and keep deadkey2
538 currentState = deadkey_state_;
543 TransCombinedState::TransCombinedState()
545 combined_state_ = this;
549 docstring const TransCombinedState::normalkey(char_type c)
551 docstring const temp = doAccent(c, deadkey2_info_.accent);
552 docstring const res = doAccent(temp, deadkey_info_.accent);
553 currentState = init_state_;
558 docstring const TransCombinedState::deadkey(char_type c, KmodInfo d)
560 // Third key in a row. Output the first one and
561 // reenter with shifted deadkeys
566 deadkey_ = deadkey2_;
567 deadkey_info_ = deadkey2_info_;
568 res += deadkey_state_->deadkey(c, d);
575 : TransFSMData(), TransInitState(), TransDeadkeyState(), TransCombinedState()
577 currentState = init_state_;
583 // Initialize static member.
584 Trans TransManager::default_;
587 TransManager::TransManager()
592 int TransManager::setPrimary(string const & language)
594 if (t1_.getName() == language)
597 return t1_.load(language);
601 int TransManager::setSecondary(string const & language)
603 if (t2_.getName() == language)
606 return t2_.load(language);
610 void TransManager::enablePrimary()
615 LYXERR(Debug::KBMAP, "Enabling primary keymap");
619 void TransManager::enableSecondary()
623 LYXERR(Debug::KBMAP, "Enabling secondary keymap");
627 void TransManager::disableKeymap()
630 LYXERR(Debug::KBMAP, "Disabling keymap");
634 void TransManager::translateAndInsert(char_type c, Text * text, Cursor & cur)
636 docstring res = active_->process(c, *this);
638 // Process with tokens
641 while (res.length() > 0) {
642 res = split(res, temp, TransState::TOKEN_SEP);
643 insert(temp, text, cur);
648 void TransManager::insert(docstring const & str, Text * text, Cursor & cur)
650 for (size_t i = 0, n = str.size(); i != n; ++i)
651 text->insertChar(cur, str[i]);
655 void TransManager::deadkey(char_type c, tex_accent accent, Text * t, Cursor & cur)
657 if (c == 0 && active_ != &default_) {
658 // A deadkey was pressed that cannot be printed
659 // or a accent command was typed in the minibuffer
661 if (active_->isAccentDefined(accent, i) == true) {
662 docstring const res = trans_fsm_
663 .currentState->deadkey(c, i);
669 if (active_ == &default_ || c == 0) {
673 docstring res = trans_fsm_.currentState->deadkey(c, i);
676 // Go through the translation
677 translateAndInsert(c, t, cur);