2 * \file InsetMathSpace.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
13 #include "InsetMathSpace.h"
15 #include "MathFactory.h"
16 #include "MathStream.h"
17 #include "MathSupport.h"
19 #include "BufferView.h"
21 #include "FuncRequest.h"
22 #include "FuncStatus.h"
23 #include "LaTeXFeatures.h"
24 #include "MetricsInfo.h"
26 #include "insets/InsetSpace.h"
28 #include "frontends/Application.h"
29 #include "frontends/Painter.h"
31 #include "support/lassert.h"
42 InsetSpaceParams::Kind kind;
46 bool escape; ///< whether a backslash needs to be added for writing
49 SpaceInfo space_info[] = {
50 // name width kind negative visible custom escape
51 {"!", 6, InsetSpaceParams::NEGTHIN, true, true, false, true},
52 {"negthinspace", 6, InsetSpaceParams::NEGTHIN, true, true, false, true},
53 {"negmedspace", 8, InsetSpaceParams::NEGMEDIUM, true, true, false, true},
54 {"negthickspace", 10, InsetSpaceParams::NEGTHICK, true, true, false, true},
55 {",", 6, InsetSpaceParams::THIN, false, true, false, true},
56 {"thinspace", 6, InsetSpaceParams::THIN, false, true, false, true},
57 {":", 8, InsetSpaceParams::MEDIUM, false, true, false, true},
58 {"medspace", 8, InsetSpaceParams::MEDIUM, false, true, false, true},
59 {";", 10, InsetSpaceParams::THICK, false, true, false, true},
60 {"thickspace", 10, InsetSpaceParams::THICK, false, true, false, true},
61 {"enskip", 10, InsetSpaceParams::ENSKIP, false, true, false, true},
62 {"enspace", 10, InsetSpaceParams::ENSPACE, false, true, false, true},
63 {"quad", 20, InsetSpaceParams::QUAD, false, true, false, true},
64 {"qquad", 40, InsetSpaceParams::QQUAD, false, true, false, true},
65 {"lyxnegspace", -2, InsetSpaceParams::NEGTHIN, true, false, false, true},
66 {"lyxposspace", 2, InsetSpaceParams::THIN, false, false, false, true},
67 {"hfill", 80, InsetSpaceParams::HFILL, false, true, false, true},
68 {"hspace*{\\fill}", 80, InsetSpaceParams::HFILL_PROTECTED, false, true, false, true},
69 {"hspace*", 0, InsetSpaceParams::CUSTOM_PROTECTED,false, true, true, true},
70 {"hspace", 0, InsetSpaceParams::CUSTOM, false, true, true, true},
71 {" ", 10, InsetSpaceParams::NORMAL, false, true, false, true},
72 {"~", 10, InsetSpaceParams::PROTECTED, false, true, false, false},
75 int const nSpace = sizeof(space_info)/sizeof(SpaceInfo);
76 int const defaultSpace = 4;
80 InsetMathSpace::InsetMathSpace()
81 : space_(defaultSpace)
86 InsetMathSpace::InsetMathSpace(string const & name, string const & length)
87 : space_(defaultSpace)
89 for (int i = 0; i < nSpace; ++i)
90 if (space_info[i].name == name) {
94 if (space_info[space_].custom) {
95 length_ = Length(length);
96 if (length_.zero() || length_.empty()) {
98 length_.unit(Length::EM);
104 InsetMathSpace::InsetMathSpace(Length const & length, bool const prot)
105 : space_(defaultSpace), length_(length)
107 for (int i = 0; i < nSpace; ++i)
108 if ((prot && space_info[i].name == "hspace*")
109 || (!prot && space_info[i].name == "hspace")) {
116 Inset * InsetMathSpace::clone() const
118 return new InsetMathSpace(*this);
122 void InsetMathSpace::metrics(MetricsInfo & mi, Dimension & dim) const
126 if (space_info[space_].custom)
127 dim.wid = abs(length_.inPixels(mi.base));
129 dim.wid = space_info[space_].width;
133 void InsetMathSpace::draw(PainterInfo & pi, int x, int y) const
135 // Sadly, HP-UX CC can't handle that kind of initialization.
136 // XPoint p[4] = {{++x, y-3}, {x, y}, {x+width-2, y}, {x+width-2, y-3}};
137 if (!space_info[space_].visible)
140 Dimension const dim = dimension(*pi.base.bv);
145 xp[0] = ++x; yp[0] = y - 3;
146 xp[1] = x; yp[1] = y;
147 xp[2] = x + w - 2; yp[2] = y;
148 xp[3] = x + w - 2; yp[3] = y - 3;
150 pi.pain.lines(xp, yp, 4,
151 space_info[space_].custom ?
153 (isNegative() ? Color_latex : Color_math));
157 void InsetMathSpace::incSpace()
159 int const oldwidth = space_info[space_].width;
161 space_ = (space_ + 1) % nSpace;
162 while ((space_info[space_].width == oldwidth && !space_info[space_].custom) ||
163 !space_info[space_].visible);
164 if (space_info[space_].custom && (length_.zero() || length_.empty())) {
166 length_.unit(Length::EM);
171 void InsetMathSpace::validate(LaTeXFeatures & features) const
173 if (space_info[space_].name == "negmedspace" ||
174 space_info[space_].name == "negthickspace")
175 features.require("amsmath");
179 void InsetMathSpace::maple(MapleStream & os) const
184 void InsetMathSpace::mathematica(MathematicaStream & os) const
190 void InsetMathSpace::octave(OctaveStream & os) const
196 void InsetMathSpace::mathmlize(MathStream & ms) const
198 SpaceInfo const & si = space_info[space_];
199 if (si.negative || !si.visible)
203 l = length_.asHTMLString();
204 else if (si.kind != InsetSpaceParams::MEDIUM) {
212 ms << " width=\"" << from_ascii(l) << "\"";
217 void InsetMathSpace::htmlize(HtmlStream & ms) const
219 SpaceInfo const & si = space_info[space_];
221 case InsetSpaceParams::THIN:
222 ms << from_ascii(" ");
224 case InsetSpaceParams::MEDIUM:
225 ms << from_ascii(" ");
227 case InsetSpaceParams::THICK:
228 ms << from_ascii(" ");
230 case InsetSpaceParams::ENSKIP:
231 case InsetSpaceParams::ENSPACE:
232 ms << from_ascii(" ");
234 case InsetSpaceParams::QUAD:
235 ms << from_ascii(" ");
237 case InsetSpaceParams::QQUAD:
238 ms << from_ascii("  ");
240 case InsetSpaceParams::HFILL:
241 case InsetSpaceParams::HFILL_PROTECTED:
242 // FIXME: is there a useful HTML entity?
244 case InsetSpaceParams::CUSTOM:
245 case InsetSpaceParams::CUSTOM_PROTECTED: {
246 string l = length_.asHTMLString();
247 ms << MTag("span", "width='" + l + "'")
248 << from_ascii(" ") << ETag("span");
251 case InsetSpaceParams::NORMAL:
252 case InsetSpaceParams::PROTECTED:
253 ms << from_ascii(" ");
261 void InsetMathSpace::normalize(NormalStream & os) const
263 os << "[space " << int(space_) << "] ";
267 void InsetMathSpace::write(WriteStream & os) const
269 // All kinds work in text and math mode, so simply suspend
270 // writing a possibly pending mode closing brace.
271 MathEnsurer ensurer(os, false);
272 if (space_info[space_].escape)
274 os << space_info[space_].name.c_str();
275 if (space_info[space_].custom)
276 os << '{' << length_.asLatexString().c_str() << '}';
277 else if (space_info[space_].escape && space_info[space_].name.length() > 1)
278 os.pendingSpace(true);
282 InsetSpaceParams InsetMathSpace::params() const
284 InsetSpaceParams isp(true);
285 LASSERT(space_info[space_].visible, return isp);
286 isp.kind = space_info[space_].kind;
287 isp.length = GlueLength(length_);
292 string InsetMathSpace::contextMenuName() const
294 return "context-mathspace";
298 bool InsetMathSpace::getStatus(Cursor & cur, FuncRequest const & cmd,
299 FuncStatus & status) const
301 switch (cmd.action()) {
303 case LFUN_INSET_MODIFY:
304 case LFUN_INSET_DIALOG_UPDATE:
305 case LFUN_MOUSE_RELEASE:
306 case LFUN_MOUSE_PRESS:
307 case LFUN_MOUSE_MOTION:
308 status.setEnabled(true);
311 bool retval = InsetMath::getStatus(cur, cmd, status);
317 void InsetMathSpace::doDispatch(Cursor & cur, FuncRequest & cmd)
319 switch (cmd.action()) {
320 case LFUN_INSET_MODIFY:
321 if (cmd.getArg(0) == "mathspace") {
323 if (createInsetMath_fromDialogStr(cmd.argument(), ar)) {
325 *this = *ar[0].nucleus()->asSpaceInset();
332 case LFUN_MOUSE_RELEASE:
333 if (cmd.button() == mouse_button::button1) {
334 showInsetDialog(&cur.bv());
340 case LFUN_MOUSE_PRESS:
341 case LFUN_MOUSE_MOTION:
342 // eat other mouse commands
346 InsetMath::doDispatch(cur, cmd);
352 bool InsetMathSpace::isNegative() const
354 if (space_info[space_].custom)
355 return length_.value() < 0;
356 return space_info[space_].negative;