]> git.lyx.org Git - lyx.git/blob - src/insets/Inset.cpp
Introduce BufferException so that we don't crash if a problem affects only current...
[lyx.git] / src / insets / Inset.cpp
1 /**
2  * \file Inset.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Alejandro Aguilar Sierra
7  * \author Jürgen Vigna
8  * \author Lars Gullik Bjønnes
9  * \author Matthias Ettrich
10  * \author André Pönitz
11  *
12  * Full author contact details are available in file CREDITS.
13  */
14
15 #include <config.h>
16
17 #include "Inset.h"
18
19 #include "Buffer.h"
20 #include "BufferParams.h"
21 #include "BufferView.h"
22 #include "CoordCache.h"
23 #include "Cursor.h"
24 #include "Dimension.h"
25 #include "DispatchResult.h"
26 #include "FuncRequest.h"
27 #include "FuncStatus.h"
28 #include "MetricsInfo.h"
29 #include "Text.h"
30 #include "TextClass.h"
31
32 #include "frontends/Painter.h"
33 #include "frontends/Application.h"
34
35 #include "support/convert.h"
36 #include "support/debug.h"
37 #include "support/docstream.h"
38 #include "support/ExceptionMessage.h"
39 #include "support/gettext.h"
40
41 #include <map>
42
43 using namespace std;
44 using namespace lyx::support;
45
46 namespace lyx {
47
48 class InsetName {
49 public:
50         InsetName(string const & n, InsetCode c) : name(n), code(c) {}
51         string name;
52         InsetCode code;
53 };
54
55
56 typedef map<string, InsetCode> TranslatorMap;
57
58
59 static TranslatorMap const build_translator()
60 {
61         InsetName const insetnames[] = {
62                 InsetName("toc", TOC_CODE),
63                 InsetName("quote", QUOTE_CODE),
64                 InsetName("ref", REF_CODE),
65                 InsetName("href", HYPERLINK_CODE),
66                 InsetName("separator", SEPARATOR_CODE),
67                 InsetName("ending", ENDING_CODE),
68                 InsetName("label", LABEL_CODE),
69                 InsetName("note", NOTE_CODE),
70                 InsetName("accent", ACCENT_CODE),
71                 InsetName("math", MATH_CODE),
72                 InsetName("index", INDEX_CODE),
73                 InsetName("nomenclature", NOMENCL_CODE),
74                 InsetName("include", INCLUDE_CODE),
75                 InsetName("graphics", GRAPHICS_CODE),
76                 InsetName("bibitem", BIBITEM_CODE),
77                 InsetName("bibtex", BIBTEX_CODE),
78                 InsetName("text", TEXT_CODE),
79                 InsetName("ert", ERT_CODE),
80                 InsetName("foot", FOOT_CODE),
81                 InsetName("margin", MARGIN_CODE),
82                 InsetName("float", FLOAT_CODE),
83                 InsetName("wrap", WRAP_CODE),
84                 InsetName("specialchar", SPECIALCHAR_CODE),
85                 InsetName("tabular", TABULAR_CODE),
86                 InsetName("external", EXTERNAL_CODE),
87                 InsetName("caption", CAPTION_CODE),
88                 InsetName("mathmacro", MATHMACRO_CODE),
89                 InsetName("citation", CITE_CODE),
90                 InsetName("floatlist", FLOAT_LIST_CODE),
91                 InsetName("index_print", INDEX_PRINT_CODE),
92                 InsetName("nomencl_print", NOMENCL_PRINT_CODE),
93                 InsetName("optarg", OPTARG_CODE),
94                 InsetName("environment", ENVIRONMENT_CODE),
95                 InsetName("hfill", HFILL_CODE),
96                 InsetName("newline", NEWLINE_CODE),
97                 InsetName("line", LINE_CODE),
98                 InsetName("branch", BRANCH_CODE),
99                 InsetName("box", BOX_CODE),
100                 InsetName("flex", FLEX_CODE),
101                 InsetName("vspace", VSPACE_CODE),
102                 InsetName("mathmacroarg", MATHMACROARG_CODE),
103                 InsetName("listings", LISTINGS_CODE),
104                 InsetName("info", INFO_CODE),
105                 InsetName("collapsable", COLLAPSABLE_CODE),
106                 InsetName("newpage", NEWPAGE_CODE),
107         };
108
109         size_t const insetnames_size =
110                 sizeof(insetnames) / sizeof(insetnames[0]);
111
112         map<string, InsetCode> data;
113         for (size_t i = 0; i != insetnames_size; ++i) {
114                 InsetName const & var = insetnames[i];
115                 data[var.name] = var.code;
116         }
117
118         return data;
119 }
120
121
122 void Inset::setBuffer(Buffer & buffer)
123 {
124         buffer_ = &buffer;
125 }
126
127
128 Buffer & Inset::buffer()
129 {
130         if (!buffer_) {
131                 odocstringstream s;
132                 s << "LyX Code: " << lyxCode() << " name: " << name();
133                 throw ExceptionMessage(BufferException, 
134                         from_ascii("Inset::buffer_ member not initialized!"), s.str());
135         }
136         return *buffer_;
137 }
138
139
140 Buffer const & Inset::buffer() const
141 {
142         return const_cast<Inset *>(this)->buffer();
143 }
144
145
146 docstring Inset::name() const
147 {
148         return from_ascii("unknown");
149 }
150
151
152 docstring Inset::toolTip(BufferView const &, int, int) const
153 {
154         return docstring();
155 }
156
157
158 docstring Inset::contextMenu(BufferView const &, int, int) const
159 {
160         return docstring();
161 }
162
163
164 Dimension const Inset::dimension(BufferView const & bv) const
165 {
166         return bv.coordCache().getInsets().dim(this);
167 }
168
169
170 InsetCode insetCode(string const & name)
171 {
172         static TranslatorMap const translator = build_translator();
173
174         TranslatorMap::const_iterator it = translator.find(name);
175         return it == translator.end() ? NO_CODE : it->second;
176 }
177
178
179 string insetName(InsetCode c) 
180 {
181         static TranslatorMap const translator = build_translator();
182
183         TranslatorMap::const_iterator it =  translator.begin();
184         TranslatorMap::const_iterator end = translator.end();
185         for (; it != end; ++it) {
186                 if (it->second == c)
187                         return it->first;
188         }
189         return string();
190 }
191
192
193 void Inset::dispatch(Cursor & cur, FuncRequest & cmd)
194 {
195         cur.updateFlags(Update::Force | Update::FitCursor);
196         cur.dispatched();
197         doDispatch(cur, cmd);
198 }
199
200
201 void Inset::doDispatch(Cursor & cur, FuncRequest &)
202 {
203         cur.noUpdate();
204         cur.undispatched();
205 }
206
207
208 bool Inset::getStatus(Cursor &, FuncRequest const & cmd,
209         FuncStatus & flag) const
210 {
211         // LFUN_INSET_APPLY is sent from the dialogs when the data should
212         // be applied. This is either changed to LFUN_INSET_MODIFY (if the
213         // dialog belongs to us) or LFUN_INSET_INSERT (if the dialog does
214         // not belong to us, i. e. the dialog was open, and the user moved
215         // the cursor in our inset) in LyXFunc::getStatus().
216         // Dialogs::checkStatus() ensures that the dialog is deactivated if
217         // LFUN_INSET_APPLY is disabled.
218
219         switch (cmd.action) {
220         case LFUN_INSET_MODIFY:
221                 // Allow modification of our data.
222                 // This needs to be handled in the doDispatch method of our
223                 // instantiatable children.
224                 flag.enabled(true);
225                 return true;
226
227         case LFUN_INSET_INSERT:
228                 // Don't allow insertion of new insets.
229                 // Every inset that wants to allow new insets from open
230                 // dialogs needs to override this.
231                 flag.enabled(false);
232                 return true;
233
234         default:
235                 return false;
236         }
237 }
238
239
240 void Inset::edit(Cursor &, bool, EntryDirection)
241 {
242         LYXERR(Debug::INSETS, "edit left/right");
243 }
244
245
246 Inset * Inset::editXY(Cursor &, int x, int y)
247 {
248         LYXERR(Debug::INSETS, "x: " << x << " y: " << y);
249         return this;
250 }
251
252
253 Inset::idx_type Inset::index(row_type row, col_type col) const
254 {
255         if (row != 0)
256                 LYXERR0("illegal row: " << row);
257         if (col != 0)
258                 LYXERR0("illegal col: " << col);
259         return 0;
260 }
261
262
263 bool Inset::idxBetween(idx_type idx, idx_type from, idx_type to) const
264 {
265         return from <= idx && idx <= to;
266 }
267
268
269 bool Inset::idxUpDown(Cursor &, bool) const
270 {
271         return false;
272 }
273
274
275 int Inset::docbook(odocstream &, OutputParams const &) const
276 {
277         return 0;
278 }
279
280
281 bool Inset::directWrite() const
282 {
283         return false;
284 }
285
286
287 Inset::EDITABLE Inset::editable() const
288 {
289         return NOT_EDITABLE;
290 }
291
292
293 bool Inset::autoDelete() const
294 {
295         return false;
296 }
297
298
299 docstring Inset::editMessage() const
300 {
301         return _("Opened inset");
302 }
303
304
305 void Inset::cursorPos(BufferView const & /*bv*/, CursorSlice const &,
306                 bool, int & x, int & y) const
307 {
308         LYXERR0("Inset::cursorPos called directly");
309         x = 100;
310         y = 100;
311 }
312
313
314 void Inset::metricsMarkers(Dimension & dim, int framesize) const
315 {
316         dim.wid += 2 * framesize;
317         dim.des += framesize;
318 }
319
320
321 void Inset::metricsMarkers2(Dimension & dim, int framesize) const
322 {
323         dim.wid += 2 * framesize;
324         dim.asc += framesize;
325         dim.des += framesize;
326 }
327
328
329 void Inset::drawMarkers(PainterInfo & pi, int x, int y) const
330 {
331         ColorCode pen_color = mouseHovered() || editing(pi.base.bv)?
332                 Color_mathframe : Color_mathcorners;
333
334         Dimension const dim = dimension(*pi.base.bv);
335
336         int const t = x + dim.width() - 1;
337         int const d = y + dim.descent();
338         pi.pain.line(x, d - 3, x, d, pen_color);
339         pi.pain.line(t, d - 3, t, d, pen_color);
340         pi.pain.line(x, d, x + 3, d, pen_color);
341         pi.pain.line(t - 3, d, t, d, pen_color);
342         setPosCache(pi, x, y);
343 }
344
345
346 void Inset::drawMarkers2(PainterInfo & pi, int x, int y) const
347 {
348         ColorCode pen_color = mouseHovered() || editing(pi.base.bv)?
349                 Color_mathframe : Color_mathcorners;
350
351         drawMarkers(pi, x, y);
352         Dimension const dim = dimension(*pi.base.bv);
353         int const t = x + dim.width() - 1;
354         int const a = y - dim.ascent();
355         pi.pain.line(x, a + 3, x, a, pen_color);
356         pi.pain.line(t, a + 3, t, a, pen_color);
357         pi.pain.line(x, a, x + 3, a, pen_color);
358         pi.pain.line(t - 3, a, t, a, pen_color);
359         setPosCache(pi, x, y);
360 }
361
362
363 bool Inset::editing(BufferView const * bv) const
364 {
365         return bv->cursor().isInside(this);
366 }
367
368
369 int Inset::xo(BufferView const & bv) const
370 {
371         return bv.coordCache().getInsets().x(this);
372 }
373
374
375 int Inset::yo(BufferView const & bv) const
376 {
377         return bv.coordCache().getInsets().y(this);
378 }
379
380
381 bool Inset::covers(BufferView const & bv, int x, int y) const
382 {
383         return bv.coordCache().getInsets().covers(this, x, y);
384 }
385
386
387 InsetLayout const & Inset::getLayout(BufferParams const & bp) const
388 {
389         return bp.documentClass().insetLayout(name());  
390 }
391
392
393 void Inset::dump() const
394 {
395         write(lyxerr);
396 }
397
398
399 ColorCode Inset::backgroundColor() const
400 {
401         return Color_background;
402 }
403
404
405 void Inset::setPosCache(PainterInfo const & pi, int x, int y) const
406 {
407         //LYXERR("Inset: set position cache to " << x << " " << y);
408         pi.base.bv->coordCache().insets().add(this, x, y);
409 }
410
411
412 void Inset::setDimCache(MetricsInfo const & mi, Dimension const & dim) const
413 {
414         mi.base.bv->coordCache().insets().add(this, dim);
415 }
416
417
418 Buffer const * Inset::updateFrontend() const
419 {
420         return theApp() ? theApp()->updateInset(this) : 0;
421 }
422
423 } // namespace lyx