]> git.lyx.org Git - lyx.git/blob - src/mathed/math_hullinset.C
6d4e2809918f087a663eacd8be0247aa018231a8
[lyx.git] / src / mathed / math_hullinset.C
1 #include <config.h>
2
3 #ifdef __GNUG__
4 #pragma implementation
5 #endif
6
7 #include "math_hullinset.h"
8 #include "math_mathmlstream.h"
9 #include "math_streamstr.h"
10 #include "math_support.h"
11 #include "math_extern.h"
12 #include "math_charinset.h"
13 #include "debug.h"
14 #include "textpainter.h"
15 #include "funcrequest.h"
16 #include "Lsstream.h"
17 #include "LaTeXFeatures.h"
18 #include "support/LAssert.h"
19 #include "frontends/Painter.h"
20
21 #include "frontends/Alert.h"
22 #include "lyxrc.h"
23 #include "gettext.h"
24 #include "BufferView.h"
25
26 #include <vector>
27
28 using std::vector;
29 using std::max;
30 using std::endl;
31 using std::pair;
32
33 namespace {
34
35         int getCols(string const & type)
36         {
37                 if (type == "eqnarray")
38                         return 3;
39                 if (type == "align")
40                         return 2;
41                 if (type == "alignat")
42                         return 2;
43                 if (type == "xalignat")
44                         return 2;
45                 if (type == "xxalignat")
46                         return 2;
47                 return 1;
48         }
49
50
51         // returns position of first relation operator in the array
52         // used for "intelligent splitting"
53         MathArray::size_type firstRelOp(MathArray const & ar)
54         {
55                 for (MathArray::const_iterator it = ar.begin(); it != ar.end(); ++it)
56                         if ((*it)->isRelOp())
57                                 return it - ar.begin();
58                 return ar.size();
59         }
60
61
62         char const * star(bool numbered)
63         {
64                 return numbered ? "" : "*";
65         }
66
67
68         int typecode(string const & s)
69         {
70                 if (s == "none")      return 0;
71                 if (s == "simple")    return 1;
72                 if (s == "equation")  return 2;
73                 if (s == "eqnarray")  return 3;
74                 if (s == "align")     return 4;
75                 if (s == "alignat")   return 5;
76                 if (s == "xalignat")  return 6;
77                 if (s == "xxalignat") return 7;
78                 if (s == "multline")  return 8;
79                 if (s == "gather")    return 9;
80                 lyxerr << "unknown hull type '" << s << "'\n";
81                 return 0;
82         }
83
84         bool smaller(string const & s, string const & t)
85         {
86                 return typecode(s) < typecode(t);
87         }
88
89
90 } // end anon namespace
91
92
93 MathHullInset::MathHullInset()
94         : MathGridInset(1, 1), type_("none"), nonum_(1), label_(1)
95 {
96         setDefaults();
97 }
98
99
100 MathHullInset::MathHullInset(string const & type)
101         : MathGridInset(getCols(type), 1), type_(type), nonum_(1), label_(1)
102 {
103         setDefaults();
104 }
105
106
107 MathInset * MathHullInset::clone() const
108 {
109         return new MathHullInset(*this);
110 }
111
112
113 MathInset::mode_type MathHullInset::currentMode() const
114 {
115         if (type_ == "none")
116                 return UNDECIDED_MODE;
117         // definitely math mode ...
118         return MATH_MODE;
119 }
120
121
122 bool MathHullInset::idxFirst(idx_type & idx, pos_type & pos) const
123 {
124         idx = 0;
125         pos = 0;
126         return true;
127 }
128
129
130 bool MathHullInset::idxLast(idx_type & idx, pos_type & pos) const
131 {
132         idx = nargs() - 1;
133         pos = cell(idx).size();
134         return true;
135 }
136
137
138 char MathHullInset::defaultColAlign(col_type col)
139 {
140         if (type_ == "eqnarray")
141                 return "rcl"[col];
142         if (typecode(type_) >= typecode("align"))
143                 return "rl"[col & 1];
144         return 'c';
145 }
146
147
148 int MathHullInset::defaultColSpace(col_type col)
149 {
150         if (type_ == "align" || type_ == "alignat")
151                 return 0;
152         if (type_ == "xalignat")
153                 return (col & 1) ? 20 : 0;
154         if (type_ == "xxalignat")
155                 return (col & 1) ? 40 : 0;
156         return 0;
157 }
158
159
160 char const * MathHullInset::standardFont() const
161 {
162         if (type_ == "none")
163                 return "lyxnochange";
164         return "mathnormal";
165 }
166
167
168 void MathHullInset::metrics(MathMetricsInfo & mi) const
169 {
170         MathFontSetChanger dummy1(mi.base, standardFont());
171         MathStyleChanger dummy2(mi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
172
173         // let the cells adjust themselves
174         MathGridInset::metrics(mi);
175
176         if (display()) {
177                 dim_.a += 12;
178                 dim_.d += 12;
179         }
180
181         if (numberedType()) {
182                 MathFontSetChanger dummy(mi.base, "mathbf");
183                 int l = 0;
184                 for (row_type row = 0; row < nrows(); ++row)
185                         l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
186
187                 if (l)
188                         dim_.w += 30 + l;
189         }
190
191         // make it at least as high as the current font
192         int asc = 0;
193         int des = 0;
194         math_font_max_dim(mi.base.font, asc, des);
195         dim_.a = max(dim_.a,  asc);
196         dim_.d = max(dim_.d, des);
197
198         // for markers
199         metricsMarkers2();
200 }
201
202
203 void MathHullInset::draw(MathPainterInfo & pi, int x, int y) const
204 {
205         MathFontSetChanger dummy1(pi.base, standardFont());
206         MathStyleChanger dummy2(pi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
207         MathGridInset::draw(pi, x + 1, y);
208
209         if (numberedType()) {
210                 int const xx = x + colinfo_.back().offset_ + colinfo_.back().width_ + 20;
211                 for (row_type row = 0; row < nrows(); ++row) {
212                         int const yy = y + rowinfo_[row].offset_;
213                         MathFontSetChanger dummy(pi.base, "mathrm");
214                         drawStr(pi, pi.base.font, xx, yy, nicelabel(row));
215                 }
216         }
217
218         drawMarkers2(pi, x, y);
219 }
220
221
222 void MathHullInset::metricsT(TextMetricsInfo const & mi) const
223 {
224         if (display()) {
225                 MathGridInset::metricsT(mi);
226         } else {
227                 ostringstream os;
228                 WriteStream wi(os, false, true);
229                 write(wi);
230                 dim_.w = os.str().size();
231                 dim_.a = 1;
232                 dim_.d = 0;
233         }
234 }
235
236
237 void MathHullInset::drawT(TextPainter & pain, int x, int y) const
238 {
239         if (display()) {
240                 MathGridInset::drawT(pain, x, y);
241         } else {
242                 ostringstream os;
243                 WriteStream wi(os, false, true);
244                 write(wi);
245                 pain.draw(x, y, os.str().c_str());
246         }
247 }
248
249
250 string MathHullInset::label(row_type row) const
251 {
252         row_type n = nrows();
253         lyx::Assert(row < n);
254         return label_[row];
255 }
256
257
258 void MathHullInset::label(row_type row, string const & label)
259 {
260         //lyxerr << "setting label '" << label << "' for row " << row << endl;
261         label_[row] = label;
262 }
263
264
265 void MathHullInset::numbered(row_type row, bool num)
266 {
267         nonum_[row] = !num;
268 }
269
270
271 bool MathHullInset::numbered(row_type row) const
272 {
273         return !nonum_[row];
274 }
275
276
277 bool MathHullInset::ams() const
278 {
279         return
280                 type_ == "align" ||
281                 type_ == "multline" ||
282                 type_ == "gather" ||
283                 type_ == "alignat" ||
284                 type_ == "xalignat" ||
285                 type_ == "xxalignat";
286 }
287
288
289 bool MathHullInset::display() const
290 {
291         return type_ != "simple" && type_ != "none";
292 }
293
294
295 void MathHullInset::getLabelList(std::vector<string> & labels) const
296 {
297         for (row_type row = 0; row < nrows(); ++row)
298                 if (!label_[row].empty() && nonum_[row] != 1)
299                         labels.push_back(label_[row]);
300 }
301
302
303 bool MathHullInset::numberedType() const
304 {
305         if (type_ == "none")
306                 return false;
307         if (type_ == "simple")
308                 return false;
309         if (type_ == "xxalignat")
310                 return false;
311         for (row_type row = 0; row < nrows(); ++row)
312                 if (!nonum_[row])
313                         return true;
314         return false;
315 }
316
317
318 void MathHullInset::validate(LaTeXFeatures & features) const
319 {
320         if (ams())
321                 features.require("amsmath");
322
323
324         // Validation is necessary only if not using AMS math.
325         // To be safe, we will always run mathedvalidate.
326         //if (features.amsstyle)
327         //  return;
328
329         features.require("boldsymbol");
330         //features.binom      = true;
331
332         MathNestInset::validate(features);
333 }
334
335
336 void MathHullInset::header_write(WriteStream & os) const
337 {
338         bool n = numberedType();
339
340         if (type_ == "none")
341                 ;
342
343         else if (type_ == "simple") {
344                 os << '$';
345                 if (cell(0).empty())
346                         os << ' ';
347         }
348
349         else if (type_ == "equation") {
350                 if (n)
351                         os << "\\begin{equation" << star(n) << "}\n";
352                 else
353                         os << "\\[\n";
354         }
355
356         else if (type_ == "eqnarray" || type_ == "align")
357                         os << "\\begin{" << type_ << star(n) << "}\n";
358
359         else if (type_ == "alignat" || type_ == "xalignat")
360                 os << "\\begin{" << type_ << star(n) << "}"
361                   << "{" << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
362
363         else if (type_ == "xxalignat")
364                 os << "\\begin{" << type_ << "}"
365                   << "{" << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
366
367         else if (type_ == "multline" || type_ == "gather")
368                 os << "\\begin{" << type_ << "}\n";
369
370         else
371                 os << "\\begin{unknown" << star(n) << "}";
372 }
373
374
375 void MathHullInset::footer_write(WriteStream & os) const
376 {
377         bool n = numberedType();
378
379         if (type_ == "none")
380                 os << "\n";
381
382         else if (type_ == "simple")
383                 os << '$';
384
385         else if (type_ == "equation")
386                 if (n)
387                         os << "\\end{equation" << star(n) << "}\n";
388                 else
389                         os << "\\]\n";
390
391         else if (type_ == "eqnarray" || type_ == "align" || type_ == "alignat"
392               || type_ == "xalignat")
393                 os << "\n\\end{" << type_ << star(n) << "}\n";
394
395         else if (type_ == "xxalignat" || type_ == "multline" || type_ == "gather")
396                 os << "\n\\end{" << type_ << "}\n";
397
398         else
399                 os << "\\end{unknown" << star(n) << "}";
400 }
401
402
403 bool MathHullInset::colChangeOK() const
404 {
405         return type_ == "align" || type_ == "alignat" || type_ == "xalignat";
406 }
407
408
409 void MathHullInset::addRow(row_type row)
410 {
411         nonum_.insert(nonum_.begin() + row + 1, !numberedType());
412         label_.insert(label_.begin() + row + 1, string());
413         MathGridInset::addRow(row);
414 }
415
416
417 void MathHullInset::delRow(row_type row)
418 {
419         if (nrows() <= 1)
420                 return;
421         MathGridInset::delRow(row);
422         nonum_.erase(nonum_.begin() + row);
423         label_.erase(label_.begin() + row);
424 }
425
426
427 void MathHullInset::addCol(col_type col)
428 {
429         if (colChangeOK()) 
430                 MathGridInset::addCol(col);
431         else
432                 lyxerr << "Can't change number of columns in '" << type_ << "'\n";
433 }
434
435
436 void MathHullInset::delCol(col_type col)
437 {
438         if (colChangeOK()) 
439                 MathGridInset::delCol(col);
440         else
441                 lyxerr << "Can't change number of columns in '" << type_ << "'\n";
442 }
443
444
445 string MathHullInset::nicelabel(row_type row) const
446 {
447         if (nonum_[row])
448                 return string();
449         if (label_[row].empty())
450                 return string("(#)");
451         return "(" + label_[row] + ")";
452 }
453
454
455 void MathHullInset::glueall()
456 {
457         MathArray ar;
458         for (idx_type i = 0; i < nargs(); ++i)
459                 ar.append(cell(i));
460         *this = MathHullInset("simple");
461         cell(0) = ar;
462         setDefaults();
463 }
464
465
466 string const & MathHullInset::getType() const
467 {
468         return type_;
469 }
470
471
472 void MathHullInset::setType(string const & type)
473 {
474         type_ = type;
475         setDefaults();
476 }
477
478
479
480 void MathHullInset::mutate(string const & newtype)
481 {
482         //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'\n";
483
484         // we try to move along the chain
485         // none <-> simple <-> equation <-> eqnarray
486
487         if (newtype == "dump") {
488                 dump();
489         }
490
491         else if (newtype == type_) {
492                 // done
493         }
494
495         else if (type_ == "none") {
496                 setType("simple");
497                 numbered(0, false);
498                 mutate(newtype);
499         }
500
501         else if (type_ == "simple") {
502                 if (newtype == "none") {
503                         setType("none");
504                 } else {
505                         setType("equation");
506                         numbered(0, false);
507                         mutate(newtype);
508                 }
509         }
510
511         else if (type_ == "equation") {
512                 if (smaller(newtype, type_)) {
513                         setType("simple");
514                         mutate(newtype);
515                 } else if (newtype == "eqnarray") {
516                         MathGridInset::addCol(1);
517                         MathGridInset::addCol(1);
518
519                         // split it "nicely" on the firest relop
520                         pos_type pos = firstRelOp(cell(0));
521                         cell(1) = MathArray(cell(0).begin() + pos, cell(0).end());
522                         cell(0).erase(pos, cell(0).size());
523
524                         if (cell(1).size()) {
525                                 cell(2) = MathArray(cell(1).begin() + 1, cell(1).end());
526                                 cell(1).erase(1, cell(1).size());
527                         }
528                         setType("eqnarray");
529                         mutate(newtype);
530                 } else if (newtype == "multline" || newtype == "gather") {
531                         setType(newtype);
532                         numbered(0, false);
533                 } else {
534                         MathGridInset::addCol(1);
535                         // split it "nicely"
536                         pos_type pos = firstRelOp(cell(0));
537                         cell(1) = cell(0);
538                         cell(0).erase(pos, cell(0).size());
539                         cell(1).erase(0, pos);
540                         setType("align");
541                         mutate(newtype);
542                 }
543         }
544
545         else if (type_ == "eqnarray") {
546                 if (smaller(newtype, type_)) {
547                         // set correct (no)numbering
548                         bool allnonum = true;
549                         for (row_type row = 0; row < nrows(); ++row)
550                                 if (!nonum_[row])
551                                         allnonum = false;
552
553                         // set first non-empty label
554                         string label;
555                         for (row_type row = 0; row < nrows(); ++row) {
556                                 if (!label_[row].empty()) {
557                                         label = label_[row];
558                                         break;
559                                 }
560                         }
561
562                         glueall();
563                         nonum_[0] = allnonum;
564                         label_[0] = label;
565                         mutate(newtype);
566                 } else { // align & Co.
567                         for (row_type row = 0; row < nrows(); ++row) {
568                                 idx_type c = 3 * row + 1;
569                                 cell(c).append(cell(c + 1));
570                         }
571                         MathGridInset::delCol(2);
572                         setType("align");
573                         mutate(newtype);
574                 }
575         }
576
577         else if (type_ == "align") {
578                 if (smaller(newtype, type_)) {
579                         MathGridInset::addCol(1);
580                         setType("eqnarray");
581                         mutate(newtype);
582                 } else {
583                         setType(newtype);
584                 }
585         }
586
587         else if (type_ == "multline") {
588                 if (newtype == "gather" || newtype == "align" ||        
589                            newtype == "xalign" || newtype == "xxalign")
590                         setType(newtype);
591                 else if (newtype == "eqnarray") {
592                         MathGridInset::addCol(1);
593                         MathGridInset::addCol(1);
594                         setType("eqnarray");
595                 } else {
596                         lyxerr << "mutation from '" << type_
597                                 << "' to '" << newtype << "' not implemented" << endl;
598                 }
599         }
600
601         else if (type_ == "gather") {
602                 if (newtype == "multline") {
603                         setType("multline");
604                 } else {
605                         lyxerr << "mutation from '" << type_
606                                 << "' to '" << newtype << "' not implemented" << endl;
607                 }
608         }
609
610         else {
611                 lyxerr << "mutation from '" << type_
612                                          << "' to '" << newtype << "' not implemented" << endl;
613         }
614 }
615
616
617 string MathHullInset::eolString(row_type row, bool fragile) const
618 {
619         string res;
620         if (numberedType()) {
621                 if (!label_[row].empty())
622                         res += "\\label{" + label_[row] + "}";
623                 if (nonum_[row])
624                         res += "\\nonumber ";
625         }
626         return res + MathGridInset::eolString(row, fragile);
627 }
628
629
630 void MathHullInset::write(WriteStream & os) const
631 {
632         header_write(os);
633         MathGridInset::write(os);
634         footer_write(os);
635 }
636
637
638 void MathHullInset::normalize(NormalStream & os) const
639 {
640         os << "[formula " << type_ << " ";
641         MathGridInset::normalize(os);
642         os << "] ";
643 }
644
645
646 void MathHullInset::mathmlize(MathMLStream & os) const
647 {
648         MathGridInset::mathmlize(os);
649 }
650
651
652 void MathHullInset::infoize(std::ostream & os) const
653 {
654         os << "Type: " << type_;
655 }
656
657
658 void MathHullInset::check() const
659 {
660         lyx::Assert(nonum_.size() == nrows());
661         lyx::Assert(label_.size() == nrows());
662 }
663
664
665 void MathHullInset::doExtern
666         (FuncRequest const & func, idx_type & idx, pos_type & pos)
667 {
668         string lang;
669         string extra;
670         istringstream iss(func.argument.c_str());
671         iss >> lang >> extra;
672         if (extra.empty())
673                 extra = "noextra";
674
675 #ifdef WITH_WARNINGS
676 #warning temporarily disabled
677         //if (selection()) {
678         //      MathArray ar;
679         //      selGet(ar);
680         //      lyxerr << "use selection: " << ar << "\n";
681         //      insert(pipeThroughExtern(lang, extra, ar));
682         //      return;
683         //}
684 #endif
685
686         MathArray eq;
687         eq.push_back(MathAtom(new MathCharInset('=')));
688
689         // go to first item in line
690         idx -= idx % ncols();
691         pos = 0;
692
693         if (getType() == "simple") {
694                 size_type pos = cell(idx).find_last(eq);
695                 MathArray ar;
696                 if (pos == cell(idx).size()) {
697                         ar = cell(idx);
698                         lyxerr << "use whole cell: " << ar << "\n";
699                 } else {
700                         ar = MathArray(cell(idx).begin() + pos + 1, cell(idx).end());
701                         lyxerr << "use partial cell form pos: " << pos << "\n";
702                 }
703                 cell(idx).append(eq);
704                 cell(idx).append(pipeThroughExtern(lang, extra, ar));
705                 pos = cell(idx).size();
706                 return;
707         }
708
709         if (getType() == "equation") {
710                 lyxerr << "use equation inset\n";
711                 mutate("eqnarray");
712                 MathArray & ar = cell(idx);
713                 lyxerr << "use cell: " << ar << "\n";
714                 cell(idx + 1) = eq;
715                 cell(idx + 2) = pipeThroughExtern(lang, extra, ar);
716                 // move to end of line
717                 idx += 2;
718                 pos = cell(idx).size();
719                 return;
720         }
721
722         {
723                 lyxerr << "use eqnarray\n";
724                 idx -= idx % ncols();
725                 idx += 2;
726                 pos = 0;
727                 MathArray ar = cell(idx);
728                 lyxerr << "use cell: " << ar << "\n";
729 #ifdef WITH_WARNINGS
730 #warning temporarily disabled
731 #endif
732                 addRow(row(idx));
733                 cell(idx + 2) = eq;
734                 cell(idx + 3) = pipeThroughExtern(lang, extra, ar);
735                 idx += 3;
736                 pos = cell(idx).size();
737         }
738 }
739
740
741 MathInset::result_type MathHullInset::dispatch
742         (FuncRequest const & cmd, idx_type & idx, pos_type & pos)
743 {
744         switch (cmd.action) {
745
746                 case LFUN_BREAKLINE:
747                         if (type_ == "simple" || type_ == "equation") {
748                                 mutate("eqnarray");
749                                 idx = 1;
750                                 pos = 0;
751                                 return DISPATCHED_POP;
752                         }
753                         return MathGridInset::dispatch(cmd, idx, pos);
754
755                 case LFUN_MATH_NUMBER:
756                         //lyxerr << "toggling all numbers\n";
757                         if (display()) {
758                                 //bv->lockedInsetStoreUndo(Undo::INSERT);
759                                 bool old = numberedType();
760                                 for (row_type row = 0; row < nrows(); ++row)
761                                         numbered(row, !old);
762                                 //bv->owner()->message(old ? _("No number") : _("Number"));
763                                 //updateLocal(bv, true);
764                         }
765                         return DISPATCHED;
766
767                 case LFUN_MATH_NONUMBER:
768                         if (display()) {
769                                 //bv->lockedInsetStoreUndo(Undo::INSERT);
770                                 bool old = numbered(row(idx));
771                                 //bv->owner()->message(old ? _("No number") : _("Number"));
772                                 numbered(row(idx), !old);
773                                 //updateLocal(bv, true);
774                         }
775                         return DISPATCHED;
776
777                 case LFUN_INSERT_LABEL: {
778                         row_type r = row(idx);
779                         string old_label = label(r);
780                         string new_label = cmd.argument;
781
782                         if (new_label.empty()) {
783                                 string const default_label =
784                                         (lyxrc.label_init_length >= 0) ? "eq:" : "";
785                                 pair<bool, string> const res = old_label.empty()
786                                         ? Alert::askForText(_("Enter new label to insert:"), default_label)
787                                         : Alert::askForText(_("Enter label:"), old_label);
788                                 if (!res.first)
789                                         break;
790                                 new_label = trim(res.second);
791                         }
792
793                         //if (new_label == old_label)
794                         //      break;  // Nothing to do
795
796                         if (!new_label.empty())
797                                 numbered(r, true);
798
799 #warning FIXME: please check you really mean repaint() ... is it needed,
800 #warning and if so, should it be update() instead ?
801                         if (!new_label.empty()
802                                         && cmd.view()->ChangeRefsIfUnique(old_label, new_label))
803                                 cmd.view()->repaint();
804
805                         label(r, new_label);
806                         return DISPATCHED;
807                 }
808
809                 case LFUN_MATH_EXTERN:
810                         doExtern(cmd, idx, pos);
811                         return DISPATCHED_POP;
812
813                 case LFUN_MATH_MUTATE: {
814                         row_type r = row(idx);
815                         col_type c = col(idx);
816                         mutate(cmd.argument);
817                         idx = r * ncols() + c;
818                         if (idx >= nargs())
819                                 idx = nargs() - 1;
820                         if (pos > cell(idx).size()) 
821                                 pos = cell(idx).size();
822                         return DISPATCHED_POP;
823                 }
824
825                 case LFUN_MATH_DISPLAY: {
826                         mutate(type_ == "simple" ? "equation" : "simple");
827                         idx = 0;
828                         pos = cell(idx).size();
829                         return DISPATCHED_POP;
830                 }
831
832                 default:
833                         return MathGridInset::dispatch(cmd, idx, pos);
834
835         }
836         return UNDISPATCHED;
837 }