]> git.lyx.org Git - lyx.git/blob - src/insets/insetgraphics.C
updates to minipage inset
[lyx.git] / src / insets / insetgraphics.C
1 /* This file is part of
2  * ====================================================== 
3  * 
4  *           LyX, The Document Processor
5  *       
6  *           Copyright 1995-2000 the LyX Team.
7  *           
8  *           This file Copyright 2000 Baruch Even.
9  * ====================================================== */
10
11 /*
12 How to use it for now:
13     * The lyxfunc 'graphics-insert' will insert this inset into the document.
14 */
15
16 /*
17 Immediate tasks:
18         * Make the inline viewing work, there is a preliminary work going on,
19                 need to finish it up.
20         * Support automatic image format conversion, create both a PNG and EPS output.
21
22         * Polishing tasks:
23                 * Add messages in the empty rectangle (in the buffer view) to say how are 
24                   we doing.
25                         - Implemented, needs testing.
26                 * Clean up GraphicsCacheItem(_pimpl)
27         * Pop up a dialog if the widget version is higher than what we accept.
28                 * Prepare code to read FigInset insets to upgrade upwards
29                 * Provide sed/awk/C code to downgrade from InsetGraphics to FigInset.
30         
31 */
32
33 /*
34 Known BUGS:
35     
36     * If the image is from the clipart, and the document is moved to another
37        directory, the user is screwed. Need a way to handle it.
38        This amounts to a problem of when to use relative or absolute file paths
39        We should probably use what the user asks to use... but when he chooses
40        by the file dialog we normally get an absolute path and this may not be 
41        what the user meant.
42     * Bug in FileDlg class (src/filedlg.[hC]) when selecting a file and then
43         pressing ok, it counts as if no real selection done. Apparently
44         when choosing a file it doesn't update the select file input line.
45         * If we are trying to create a file in a read-only directory and there
46                 are graphics that need converting, the converting will fail because
47                 it is done in-place, into the same directory as the original image.
48                 This needs to be fixed in the src/converter.C file
49  
50 TODO Before initial production release:
51     * Replace insetfig everywhere
52         * Read it's file format
53         * Get created by all commands used to create figinset currently.
54         * Search for comments of the form
55             // INSET_GRAPHICS: remove this when InsetFig is thrown.
56           And act upon them.
57  
58     * Finish the basic To-do list.
59     * Extract the general logic of the dialog in order to allow easier porting
60         to Gnome/KDE, and put the general logic in frontends and the inherited
61         platform dependent code in the appropriate dirs.
62                 (Something of this kind is getting done by the GUII guys)
63    
64 TODO Extended features:
65  
66     * Advanced Latex tab folder.
67     * Add support for more features so that it will be better than insetfig.
68         * Keep aspect ratio radio button
69         * Support for complete control over the latex parameters for TeXperts
70         * What advanced features the users want to do?
71             Implement them in a non latex dependent way, but a logical way.
72             LyX should translate it to latex or any other fitting format.
73     * Add a way to roll the image file into the file format.
74     * When loading, if the image is not found in the expected place, try
75        to find it in the clipart, or in the same directory with the image.
76     * Keep a tab on the image file, if it changes, update the lyx view.
77         * The image choosing dialog could show thumbnails of the image formats
78                 it knows of, thus selection based on the image instead of based on
79                 filename.
80         * Add support for the 'picins' package.
81         * Add support for the 'picinpar' package.
82         * Improve support for 'subfigure' - Allow to set the various options
83                 that are possible.
84  */
85
86 /* NOTES:
87  *
88  * Intentions:
89  *  This is currently a moving target, I'm trying stuff and learning what
90  *  is needed and how to accomplish it, since there is no predefined goal or
91  *  way to go I invent it as I go.
92  *
93  *  My current intention is for seperation from LaTeX, the basic needs are 
94  *  resizing and rotating, displaying on screen in various depths and printing
95  *  conversion of depths (independent of the display depth). For this I'll 
96  *  provide a simple interface.
97  *
98  *  The medium level includes clipping of the image, but in a limited way.
99  *
100  *  For the LaTeX gurus I'll provide a complete control over the output, but
101  *  this is latex dependent and guru dependent so I'd rather avoid doing this
102  *  for the normal user. This stuff includes clipping, special image size
103  *  specifications (\textwidth\minus 2in) which I see no way to generalize
104  *  to non-latex specific way.
105  *
106  * Used packages:
107  *  'graphicx' for the graphics inclusion.
108  *  'subfigure' for the subfigures.
109  *
110  * Fileformat:
111  *
112  * Current version is 1 (inset file format version), when changing it
113  * it should be changed in the Write() function when writing in one place
114  * and when reading one should change the version check and the error message.
115  *
116  * The filename is kept in  the lyx file in a relative way, so as to allow
117  * moving the document file and its images with no problem.
118  *
119  * Conversions:
120  *  
121  *  Apparently the PNG output is preferred over PDF images when doing PDF
122  *  documents (i.e. prefer imagemagick eps2png over eps2pdf)
123  */
124
125 #include <config.h> 
126
127 #ifdef __GNUG__
128 #pragma implementation
129 #endif 
130
131 #include "insets/insetgraphics.h"
132 #include "insets/insetgraphicsParams.h"
133 #include "graphics/GraphicsCache.h"
134 #include "graphics/GraphicsCacheItem.h"
135
136 #include "frontends/Dialogs.h"
137 #include "LyXView.h"
138 #include "buffer.h"
139 #include "BufferView.h"
140 #include "converter.h"
141 #include "frontends/support/LyXImage.h"
142 #include "Painter.h"
143 #include "lyx_gui_misc.h"
144 #include "support/FileInfo.h"
145 #include "support/filetools.h"
146 #include "support/lyxlib.h"
147 #include "lyxtext.h"
148 #include "lyxrc.h"
149 #include "font.h" // For the lyxfont class.
150 #include <algorithm> // For the std::max
151 #include "support/lyxmanip.h"
152 #include "debug.h"
153
154 extern string system_tempdir;
155
156 using std::ostream;
157 using std::endl;
158 using std::max;
159
160 // This function is a utility function
161 inline
162 string const RemoveExtension(string const & filename)
163 {
164         return ChangeExtension(filename, string());
165 }
166
167
168 // Initialize only those variables that do not have a constructor.
169 InsetGraphics::InsetGraphics()
170         : cacheHandle(0), imageLoaded(false)
171 {}
172
173 InsetGraphics::~InsetGraphics()
174 {
175         // Emits the hide signal to the dialog connected (if any)
176         hideDialog();
177 }
178
179 char const *
180 InsetGraphics::statusMessage() const
181 {
182         char const * msg = 0;
183
184         if (cacheHandle.get()) {
185                 switch (cacheHandle->getImageStatus()) {
186                 case GraphicsCacheItem::UnknownError:
187                         msg = _("Unknown Error");
188                         break;
189
190                 case GraphicsCacheItem::Loading:
191                         msg = _("Loading...");
192                         break;
193
194                 case GraphicsCacheItem::ErrorReading:
195                         msg = _("Error reading");
196                         break;
197
198                 case GraphicsCacheItem::ErrorConverting:
199                         msg = _("Error converting");
200                         break;
201
202                 case GraphicsCacheItem::Loaded:
203                         // No message to write.
204                         break;
205                 }
206         }
207
208         return msg;
209 }
210
211 int InsetGraphics::ascent(BufferView *, LyXFont const &) const
212 {
213         LyXImage * pixmap = 0;
214         if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
215                 return pixmap->getHeight();
216         else
217                 return 50;
218 }
219
220
221 int InsetGraphics::descent(BufferView *, LyXFont const &) const
222 {
223         // this is not true if viewport is used and clip is not.
224         return 0;
225 }
226
227
228 int InsetGraphics::width(BufferView *, LyXFont const & font) const
229 {
230         LyXImage * pixmap = 0;
231         
232         if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
233                 return pixmap->getWidth();
234         else {
235                 char const * msg = statusMessage();
236                 int font_width = 0;
237                 
238                 if (msg)
239                         font_width = lyxfont::width(msg, font);
240                 
241                 return max(50, font_width + 15);
242         }
243 }
244
245 void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
246                          int baseline, float & x, bool) const
247 {
248         Painter & paint = bv->painter();
249
250         int ldescent = descent(bv, font);
251         int lascent = ascent(bv, font);
252         int lwidth = width(bv, font);
253
254         // Make sure x is updated upon exit from this routine
255         float old_x = x;
256         x += lwidth;
257
258         // This will draw the graphics. If the graphics has not been loaded yet,
259         // we draw just a rectangle.
260         if (imageLoaded) {
261
262                 paint.image(int(old_x) + 2, baseline - lascent,
263                              lwidth - 4, lascent + ldescent,
264                                          cacheHandle->getImage());
265         } else {
266                 
267                 // Get the image status, default to unknown error.
268                 GraphicsCacheItem::ImageStatus status = GraphicsCacheItem::UnknownError;
269                 if (cacheHandle.get())
270                         status = cacheHandle->getImageStatus();
271                 
272                 // Check if the image is now ready.
273                 if (status == GraphicsCacheItem::Loaded) {
274                         imageLoaded = true;
275
276                         // Tell BufferView we need to be updated!
277                         bv->text->status = LyXText::CHANGED_IN_DRAW;
278                         return;
279                 }
280
281                 char const * msg = statusMessage();
282                 
283                 paint.rectangle(int(old_x) + 2, baseline - lascent,
284                                 lwidth - 4,
285                                 lascent + ldescent);
286
287                 if (msg) {
288                         // Print the message.
289                         LyXFont msgFont(font);
290                         msgFont.setFamily(LyXFont::SANS_FAMILY);
291                         msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
292                         string const justname = OnlyFilename (params.filename);
293                         paint.text(int(old_x) + 8, 
294                                         baseline - lyxfont::maxAscent(msgFont) - 4,
295                                     justname, msgFont);
296
297                         msgFont.setSize(LyXFont::SIZE_TINY);
298                         paint.text(int(old_x) + 8, baseline - 4, 
299                                         msg, strlen(msg), msgFont);
300                 }
301         }
302 }
303
304
305 void InsetGraphics::Edit(BufferView *bv, int, int, unsigned int)
306 {
307         bv->owner()->getDialogs()->showGraphics(this);
308 }
309
310
311 Inset::EDITABLE InsetGraphics::Editable() const
312 {
313         return IS_EDITABLE;
314 }
315
316
317 void InsetGraphics::Write(Buffer const * buf, ostream & os) const
318 {
319         os << "GRAPHICS FormatVersion 1" << endl;
320
321         params.Write(buf, os);
322 }
323
324
325 void InsetGraphics::Read(Buffer const * buf, LyXLex & lex)
326 {
327         bool finished = false;
328
329         while (lex.IsOK() && !finished) {
330                 lex.next();
331
332                 string const token = lex.GetString();
333                 lyxerr.debug() << "Token: '" << token << '\'' << endl;
334
335                 if (token.empty()) {
336                         continue;
337                 } else if (token == "\\end_inset") {
338                         finished = true;
339                 } else if (token == "FormatVersion") {
340                         lex.next();
341                         int version = lex.GetInteger();
342                         if (version > 1)
343                                 lyxerr
344                                 << "This document was created with a newer Graphics widget"
345                                 ", You should use a newer version of LyX to read this"
346                                 " file."
347                                 << endl;
348                         // TODO: Possibly open up a dialog?
349                 }
350                 else {
351                         if (! params.Read(buf, lex, token))
352                                 lyxerr << "Unknown token, " << token << ", skipping." << endl;
353                 }
354         }
355
356         updateInset();
357 }
358
359 static
360 void formatResize(ostream & os, string const & key,
361                   InsetGraphicsParams::Resize resizeType, double size)
362 {
363         switch (resizeType) {
364         case InsetGraphicsParams::DEFAULT_SIZE:
365                 break;
366
367         case InsetGraphicsParams::CM:
368                 os << key << '=' << size << "cm,";
369                 break;
370
371         case InsetGraphicsParams::INCH:
372                 os << key << '=' << size << "in,";
373                 break;
374
375         case InsetGraphicsParams::PERCENT_PAGE:
376                 os << key << '=' << size / 100 << "\\text" << key << ',';
377                 break;
378
379         case InsetGraphicsParams::PERCENT_COLUMN:
380                 os << key << '=' << size / 100 << "\\column" << key << ',';
381                 break;
382
383         }
384 }
385
386 string const
387 InsetGraphics::createLatexOptions() const
388 {
389         // Calculate the options part of the command, we must do it to a string
390         // stream since we might have a trailing comma that we would like to remove
391         // before writing it to the output stream.
392         std::ostringstream options;
393
394         formatResize(options, "width", params.widthResize, params.widthSize);
395         formatResize(options, "height", params.heightResize, params.heightSize);
396
397         if (params.rotateAngle != 0) {
398                 options << "angle="
399                         << params.rotateAngle << ',';
400         }
401
402         string opts = options.str().c_str();
403         opts = strip(opts, ',');
404
405         return opts;
406 }
407
408
409
410 string const 
411 InsetGraphics::prepareFile(Buffer const *buf) const
412 {
413
414         // do_convert = Do we need to convert the file?
415         // nice = Do we create a nice version?
416         //        This is used when exporting the latex file only.
417         // 
418         // 
419         // if (!do_convert)
420         //   return original filename
421         // 
422         // if (!nice)
423         //   convert_place = temp directory
424         //   return new filename in temp directory
425         // else
426         //   convert_place = original file directory
427         //   return original filename without the extension
428         //
429         
430         // Get the extension (format) of the original file.
431         string const extension = GetExtension(params.filename);
432         
433         // Are we creating a PDF or a PS file?
434         // (Should actually mean, are we usind latex or pdflatex).
435         string const image_target = (lyxrc.pdf_mode ? "png" : "eps");
436
437         if (extension == image_target)
438                 return params.filename;
439
440         string outfile;
441         if (!buf->niceFile) {
442                 string const temp = AddName(buf->tmppath, params.filename);
443                 outfile = RemoveExtension(temp);
444                 
445                 //lyxerr << "buf::tmppath = " << buf->tmppath << "\n";
446                 //lyxerr << "filename = " << params.filename << "\n";
447                 //lyxerr << "temp = " << temp << "\n";
448                 //lyxerr << "outfile = " << outfile << endl;
449         } else {
450                 string const path = OnlyPath(buf->fileName());
451                 string const relname = MakeRelPath(params.filename, path);
452                 outfile = RemoveExtension(relname);
453         }
454
455         converters.Convert(buf, params.filename, outfile, extension, image_target);
456         
457         return outfile;
458 }
459
460 int InsetGraphics::Latex(Buffer const *buf, ostream & os,
461                 bool /*fragile*/, bool/*fs*/) const
462 {
463         // MISSING: We have to decide how to do the order of the options
464         // that is dependent of order, like width, height, angle. Should
465         // we rotate before scale? Should we let the user decide?
466         // bool rot_before_scale; ?
467
468         // (BE) As a first step we should do a scale before rotate since this is
469         // more like the natural thought of how to do it.
470         // (BE) I believe that a priority list presented to the user with
471         // a default order would be the best, though it would be better to
472         // hide such a thing in an "Advanced options" dialog.
473         // (BE) This should go an advanced LaTeX options dialog.
474
475         // If there is no file specified, just output a message about it in
476         // the latex output.
477         if (params.filename.empty()) {
478                 os  << "\\fbox{\\rule[-0.5in]{0pt}{1in}"
479                         << _("empty figure path")
480                         << "}\n";
481
482                 return 1; // One end of line marker added to the stream.
483         }
484
485         // Keep count of newlines that we issued.
486         int newlines = 0;
487
488         // This variables collect all the latex code that should be before and
489         // after the actual includegraphics command.
490         string before;
491         string after;
492
493         // If it's not an inline image, surround it with the centering paragraph.
494         if (! params.inlineFigure) {
495                 before += "\n" "\\vspace{0.3cm}\n" "{\\par\\centering ";
496                 after = " \\par}\n" "\\vspace{0.3cm}\n" + after;
497                 newlines += 4;
498         }
499
500         // Do we want subcaptions?
501         if (params.subcaption) {
502                 before += "\\subfigure[" + params.subcaptionText + "]{";
503                 after = '}' + after;
504         }
505
506         // We never use the starred form, we use the "clip" option instead.
507         os << before << "\\includegraphics";
508
509         // Write the options if there are any.
510         string const opts = createLatexOptions();
511         if (!opts.empty()) {
512                 os << '[' << opts << ']';
513         }
514
515         // Make the filename relative to the lyx file
516         // and remove the extension so the LaTeX will use whatever is
517         // appropriate (when there are several versions in different formats)
518         string const filename = prepareFile(buf);
519         
520         os << '{' << filename << '}' << after;
521
522         // Return how many newlines we issued.
523         return newlines;
524 }
525
526
527 int InsetGraphics::Ascii(Buffer const *, ostream &, int) const
528 {
529         // No graphics in ascii output. Possible to use gifscii to convert
530         // images to ascii approximation.
531         
532         // 1. Convert file to ascii using gifscii
533         // 2. Read ascii output file and add it to the output stream.
534         
535         return 0;
536 }
537
538
539 int InsetGraphics::Linuxdoc(Buffer const *, ostream &) const
540 {
541         // No graphics in LinuxDoc output. Should check how/what to add.
542         return 0;
543 }
544
545 // For explanation on inserting graphics into DocBook checkout:
546 // http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
547 // See also the docbook guide at http://www.docbook.org/
548 int InsetGraphics::DocBook(Buffer const * buf, ostream & os) const
549 {
550         // Change the path to be relative to the main file.
551         string const buffer_dir = OnlyPath(buf->fileName());
552         string const filename = RemoveExtension(MakeRelPath(params.filename, buffer_dir));
553
554         // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will 
555         // need to switch to MediaObject. However, for now this is sufficient and 
556         // easier to use.
557         os << "<graphic fileref=\"" << filename << "\"></graphic>";
558         return 0;
559 }
560
561
562 void InsetGraphics::Validate(LaTeXFeatures & features) const
563 {
564         // If we have no image, we should not require anything.
565         if (params.filename.empty())
566                 return ;
567
568         features.graphicx = true;
569
570         if (params.subcaption)
571                 features.subfigure = true;
572 }
573
574 // Update the inset after parameters changed (read from file or changed in
575 // dialog.
576 void InsetGraphics::updateInset() const
577 {
578         GraphicsCache & gc = GraphicsCache::getInstance();
579         boost::shared_ptr<GraphicsCacheItem> temp(0);
580
581         // We do it this way so that in the face of some error, we will still
582         // be in a valid state.
583         if (!params.filename.empty()) {
584                 temp = gc.addFile(params.filename);
585         }
586
587         // Mark the image as unloaded so that it gets updated.
588         imageLoaded = false;
589
590         cacheHandle = temp;
591 }
592
593 bool InsetGraphics::setParams(InsetGraphicsParams const & params)
594 {
595         // If nothing is changed, just return and say so.
596         if (this->params == params)
597                 return false;
598
599         // Copy the new parameters.
600         this->params = params;
601
602         // Update the inset with the new parameters.
603         updateInset();
604
605         // We have changed data, report it.
606         return true;
607 }
608
609 InsetGraphicsParams InsetGraphics::getParams() const
610 {
611         return params;
612 }
613
614 Inset * InsetGraphics::Clone(Buffer const &) const
615 {
616         InsetGraphics * newInset = new InsetGraphics;
617
618         newInset->cacheHandle = cacheHandle;
619         newInset->imageLoaded = imageLoaded;
620
621         newInset->setParams(getParams());
622
623         return newInset;
624 }