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