2 * figinset.C - part of LyX project
5 /* Rework of path-handling (Matthias 04.07.1996 )
6 * ------------------------------------------------
7 * figinsets keep an absolute path to the eps-file.
8 * For the user alway a relative path appears
9 * (in lyx-file, latex-file and edit-popup).
10 * To calculate this relative path the path to the
11 * document where the figinset is in is needed.
12 * This is done by a reference to the buffer, called
13 * figinset::cbuffer. To be up to date the cbuffer
14 * is sometimes set to the current buffer
15 * bufferlist.current(), when it can be assumed that
16 * this operation happens in the current buffer.
17 * This is true for InsetFig::Edit(...),
18 * InsetFig::InsetFig(...), InsetFig::Read(...),
19 * InsetFig::Write and InsetFig::Latex(...).
20 * Therefore the bufferlist has to make sure that
21 * during these operations bufferlist.current()
22 * returns the buffer where the figinsets are in.
23 * This made few changes in buffer.C necessary.
25 * The above is not totally valid anymore. (Lgb)
42 #include FORMS_H_LOCATION
51 #include "frontends/FileDialog.h"
52 #include "support/filetools.h"
53 #include "LyXView.h" // just because of form_main
55 #include "LaTeXFeatures.h"
58 #include "lyx_gui_misc.h" // CancelCloseBoxCB
59 #include "support/FileInfo.h"
60 #include "support/lyxlib.h"
63 #include "bufferview_funcs.h"
64 #include "ColorHandler.h"
65 #include "converter.h"
66 #include "frontends/Dialogs.h" // redrawGUI
78 using std::ostringstream;
83 extern BufferView * current_view;
84 extern FL_OBJECT * figinset_canvas;
86 extern char ** environ; // is this only redundtant on linux systems? Lgb.
88 // xforms doesn't define this (but it should be in <forms.h>).
90 FL_APPEVENT_CB fl_set_preemptive_callback(Window, FL_APPEVENT_CB, void *);
94 float const DEG2PI = 57.295779513;
96 struct queue_element {
97 float rx, ry; // resolution x and y
98 int ofsx, ofsy; // x and y translation
99 figdata * data; // we are doing it for this data
102 int const MAXGS = 3; /* maximum 3 gs's at a time */
104 typedef vector<Figref *> figures_type;
105 typedef vector<figdata *> bitmaps_type;
106 figures_type figures; // all figures
107 bitmaps_type bitmaps; // all bitmaps
109 queue<queue_element> gsqueue; // queue for ghostscripting
111 int gsrunning = 0; /* currently so many gs's are running */
112 bool bitmap_waiting = false; /* bitmaps are waiting finished */
114 bool gs_color; // do we allocate colors for gs?
115 bool color_visual; // is the visual color?
116 bool gs_xcolor = false; // allocated extended colors
117 unsigned long gs_pixels[128]; // allocated pixels
118 int gs_spc; // shades per color
119 int gs_allcolors; // number of all colors
121 list<int> pidwaitlist; // pid wait list
126 val.foreground = BlackPixel(fl_get_display(),
127 DefaultScreen(fl_get_display()));
130 val.graphics_exposures = false;
131 val.line_style = LineSolid;
133 return XCreateGC(fl_get_display(), RootWindow(fl_get_display(), 0),
134 GCForeground | GCFunction | GCGraphicsExposures
135 | GCLineWidth | GCLineStyle , &val);
141 void addpidwait(int pid)
143 // adds pid to pid wait list
144 pidwaitlist.push_back(pid);
146 if (lyxerr.debugging()) {
147 lyxerr << "Pids to wait for: \n";
148 copy(pidwaitlist.begin(), pidwaitlist.end(),
149 std::ostream_iterator<int>(lyxerr, "\n"));
155 string make_tmp(int pid)
157 return system_tempdir + "/~lyxgs" + tostr(pid) + ".ps";
161 void kill_gs(int pid, int sig)
163 if (lyxerr.debugging())
164 lyxerr << "Killing gs " << pid << endl;
166 lyx::unlink(make_tmp(pid));
171 int GhostscriptMsg(XEvent * ev, void *)
173 // bin all events not of interest
174 if (ev->type != ClientMessage)
177 XClientMessageEvent * e = reinterpret_cast<XClientMessageEvent*>(ev);
179 if (lyxerr.debugging()) {
180 lyxerr << "ClientMessage, win:[xx] gs:[" << e->data.l[0]
181 << "] pm:[" << e->data.l[1] << "]" << endl;
184 // just kill gs, that way it will work for sure
185 // This loop looks like S**T so it probably is...
186 for (bitmaps_type::iterator it = bitmaps.begin();
187 it != bitmaps.end(); ++it)
188 if (static_cast<long>((*it)->bitmap) ==
189 static_cast<long>(e->data.l[1])) {
194 // first update p->bitmap, if necessary
195 if (p->bitmap != None
196 && p->flags > (1|8) && gs_color && p->wid) {
197 // query current colormap and re-render
198 // the pixmap with proper colors
199 XWindowAttributes wa;
200 register XImage * im;
203 int spc1 = gs_spc - 1;
204 int spc2 = gs_spc * gs_spc;
208 GC gc = local_gc_copy;
210 XGetWindowAttributes(fl_get_display(),
214 XFlush(fl_get_display());
215 if (lyxerr.debugging()) {
216 lyxerr << "Starting image translation "
219 << p->wid << "x" << p->hgh
221 << " " << XYPixmap << endl;
223 // now fork rendering process
225 if (forkstat == -1) {
227 << "Cannot fork, using slow "
228 "method for pixmap translation." << endl;
229 tmpdisp = fl_get_display();
230 } else if (forkstat > 0) { // parent
232 if (lyxerr.debugging()) {
233 lyxerr << "Spawned child "
236 addpidwait(forkstat);
239 tmpdisp = XOpenDisplay(DisplayString(fl_get_display()));
242 im = XGetImage(tmpdisp, p->bitmap, 0, 0,
243 p->wid, p->hgh, (1<<wa.depth)-1, XYPixmap);
245 if (lyxerr.debugging()) {
246 lyxerr << "Got the image" << endl;
249 if (lyxerr.debugging()) {
250 lyxerr << "Error getting the image" << endl;
255 // query current colormap
256 XColor * cmap = new XColor[gs_allcolors];
257 for (i = 0; i < gs_allcolors; ++i) cmap[i].pixel = i;
258 XQueryColors(tmpdisp,
259 fl_state[fl_get_vclass()]
263 // now we process all the image
264 for (y = 0; y < p->hgh; ++y) {
265 for (int x = 0; x < wid; ++x) {
270 gs_pixels[((pc->red+6553)*
271 spc1/65535)*spc2+((pc->green+6553)*
272 spc1/65535)*gs_spc+((pc->blue+6553)*
277 // This must be correct.
279 if (lyxerr.debugging()) {
280 lyxerr << "Putting image back"
283 XPutImage(tmpdisp, p->bitmap,
285 0, 0, p->wid, p->hgh);
287 if (lyxerr.debugging()) {
288 lyxerr << "Done translation"
293 kill_gs(p->gspid, SIGHUP);
295 XCloseDisplay(tmpdisp);
299 kill_gs(p->gspid, SIGHUP);
307 void AllocColors(int num)
308 // allocate color cube numxnumxnum, if possible
310 if (lyxerr.debugging()) {
311 lyxerr << "Allocating color cube " << num
312 << 'x' << num << 'x' << num << endl;
316 lyxerr << "Error allocating color colormap." << endl;
320 if (num > 5) num = 5;
322 for (int i = 0; i < num * num * num; ++i) {
323 xcol.red = short(65535 * (i / (num * num)) / (num - 1));
324 xcol.green = short(65535 * ((i / num) % num) / (num - 1));
325 xcol.blue = short(65535 * (i % num) / (num - 1));
326 xcol.flags = DoRed | DoGreen | DoBlue;
327 if (!XAllocColor(fl_get_display(),
328 fl_state[fl_get_vclass()].colormap, &xcol)) {
329 if (i) XFreeColors(fl_get_display(),
330 fl_state[fl_get_vclass()].colormap,
332 if (lyxerr.debugging()) {
333 lyxerr << "Cannot allocate color cube "
336 AllocColors(num - 1);
339 gs_pixels[i] = xcol.pixel;
346 // allocate grayscale ramp
347 void AllocGrays(int num)
349 if (lyxerr.debugging()) {
350 lyxerr << "Allocating grayscale colormap "
355 lyxerr << "Error allocating grayscale colormap." << endl;
359 if (num > 128) num = 128;
361 for (int i = 0; i < num; ++i) {
362 xcol.red = xcol.green = xcol.blue = short(65535 * i / (num - 1));
363 xcol.flags = DoRed | DoGreen | DoBlue;
364 if (!XAllocColor(fl_get_display(),
365 fl_state[fl_get_vclass()].colormap, &xcol)) {
366 if (i) XFreeColors(fl_get_display(),
367 fl_state[fl_get_vclass()].colormap,
369 if (lyxerr.debugging()) {
370 lyxerr << "Cannot allocate grayscale "
376 gs_pixels[i] = xcol.pixel;
383 // if bitmaps and figures are not empty we will leak mem
387 // allocate color cube on pseudo-color display
391 /* we want to capture every event, in order to work around an
394 fl_set_preemptive_callback(fl_get_canvas_id(figinset_canvas), GhostscriptMsg, 0);
396 local_gc_copy = createGC();
398 Visual * vi = DefaultVisual(fl_get_display(),
399 DefaultScreen(fl_get_display()));
400 if (lyxerr.debugging()) {
401 printf("Visual ID: %ld, class: %d, bprgb: %d, mapsz: %d\n",
402 vi->visualid, vi->c_class,
403 vi->bits_per_rgb, vi->map_entries);
405 color_visual = ( (vi->c_class == StaticColor) ||
406 (vi->c_class == PseudoColor) ||
407 (vi->c_class == TrueColor) ||
408 (vi->c_class == DirectColor) );
409 if ((vi->c_class & 1) == 0) return;
410 // now allocate colors
411 if (vi->c_class == GrayScale) {
412 // allocate grayscale
413 AllocGrays(vi->map_entries/2);
415 // allocate normal color
417 while (i * i * i * 2 > vi->map_entries) --i;
420 gs_allcolors = vi->map_entries;
427 // if bitmaps and figures are not empty we will leak mem
431 lyxerr.debug() << "Unregistering figures..." << endl;
435 void freefigdata(figdata * tmpdata)
438 if (tmpdata->ref) return;
440 if (tmpdata->gspid > 0) {
441 int pid = tmpdata->gspid;
442 // kill ghostscript and unlink it's files
444 kill_gs(pid, SIGKILL);
447 if (tmpdata->bitmap) XFreePixmap(fl_get_display(), tmpdata->bitmap);
448 bitmaps.erase(find(bitmaps.begin(), bitmaps.end(), tmpdata));
455 // This _have_ to be set before the fork!
456 unsigned long background_pixel =
457 lyxColorHandler->colorPixel(LColor::background);
459 // run queued requests for ghostscript, if any
460 if (!gsrunning && gs_color && !gs_xcolor) {
461 // here alloc all colors, so that gs will use only
462 // those we allocated for it
467 while (gsrunning < MAXGS) {
468 //char tbuf[384]; //, tbuf2[80];
472 if (gsqueue.empty()) {
473 if (!gsrunning && gs_xcolor) {
474 // de-allocate rest of colors
480 queue_element * p = &gsqueue.front();
489 if (lyxerr.debugging()) {
490 lyxerr << "GS start error! Cannot fork."
493 p->data->broken = true;
494 p->data->reading = false;
497 if (pid == 0) { // child
500 Display * tempdisp = XOpenDisplay(DisplayString(fl_get_display()));
502 // create translation file
504 ofs.open(make_tmp(getpid()).c_str());
505 ofs << "gsave clippath pathbbox grestore\n"
507 << "/ury exch def /urx exch def /lly exch def "
509 << p->data->wid / 2.0 << " "
510 << p->data->hgh / 2.0 << " translate\n"
511 << p->data->angle << " rotate\n"
512 << -(p->data->raw_wid / 2.0) << " "
513 << -(p->data->raw_hgh / 2.0) << " translate\n"
514 << p->rx / 72.0 << " " << p->ry / 72.0
516 << -p->ofsx << " " << -p->ofsy << " translate\n"
518 ofs.close(); // Don't remove this.
520 // gs process - set ghostview environment first
522 t2 << "GHOSTVIEW=" << fl_get_canvas_id(figinset_canvas)
523 << ' ' << p->data->bitmap;
524 // now set up ghostview property on a window
525 // #warning BUG seems that the only bug here
526 // might be the hardcoded dpi.. Bummer!
528 t1 << "0 0 0 0 " << p->data->wid << ' '
529 << p->data->hgh << " 72 72 0 0 0 0";
531 if (lyxerr.debugging()) {
532 lyxerr << "Will set GHOSTVIEW property to ["
533 << t1.str() << "]" << endl;
535 // wait until property is deleted if executing multiple
537 XGrabServer(tempdisp);
539 // grab server to prevent other child
540 // interfering with setting GHOSTVIEW property
541 // The grabbing goes on for too long, is it
542 // really needed? (Lgb)
543 // I moved most of the grabs... (Lgb)
544 if (lyxerr.debugging()) {
545 lyxerr << "Grabbing the server"
548 prop = XListProperties(tempdisp,
550 figinset_canvas), &nprop);
554 for (i = 0; i < nprop; ++i) {
555 char * p = XGetAtomName(tempdisp,
557 if (compare(p, "GHOSTVIEW") == 0) {
559 // We free it when we leave so we don't leak.
565 XFree(reinterpret_cast<char *>(prop)); // jc:
567 // ok, property found, we must wait until
568 // ghostscript deletes it
569 if (lyxerr.debugging()) {
570 lyxerr << "Releasing the server\n["
572 << "] GHOSTVIEW property"
573 " found. Waiting." << endl;
575 XUngrabServer(tempdisp);
578 XGrabServer(tempdisp);
580 XChangeProperty(tempdisp,
581 fl_get_canvas_id(figinset_canvas),
582 XInternAtom(tempdisp, "GHOSTVIEW", false),
583 XInternAtom(tempdisp, "STRING", false),
585 reinterpret_cast<unsigned char*>(const_cast<char*>(t1.str().c_str())),
586 int(t1.str().size()));
587 XUngrabServer(tempdisp);
592 switch (p->data->flags & 3) {
593 case 0: t3 << 'H'; break; // Hidden
594 case 1: t3 << 'M'; break; // Mono
595 case 2: t3 << 'G'; break; // Gray
604 t3 << ' ' << BlackPixelOfScreen(DefaultScreenOfDisplay(tempdisp))
605 << ' ' << background_pixel;
607 XGrabServer(tempdisp);
608 XChangeProperty(tempdisp,
609 fl_get_canvas_id(figinset_canvas),
610 XInternAtom(tempdisp,
611 "GHOSTVIEW_COLORS", false),
612 XInternAtom(tempdisp, "STRING", false),
614 reinterpret_cast<unsigned char*>(const_cast<char*>(t3.str().c_str())),
615 int(t3.str().size()));
616 XUngrabServer(tempdisp);
619 if (lyxerr.debugging()) {
620 lyxerr << "Releasing the server" << endl;
622 XCloseDisplay(tempdisp);
624 // set up environment
627 typedef char * char_p;
628 env = new char_p[ne + 2];
629 string tmp = t2.str().c_str();
630 env[0] = new char[tmp.size() + 1];
631 std::copy(tmp.begin(), tmp.end(), env[0]);
632 env[0][tmp.size()] = '\0';
633 ::memcpy(&env[1], environ, sizeof(char*) * (ne + 1));
636 // now make gs command
638 // close(1); do NOT close. If GS writes out
639 // errors it would hang. (Matthias 290596)
641 string rbuf = "-r" + tostr(p->rx) + "x" + tostr(p->ry);
642 string gbuf = "-g" + tostr(p->data->wid) + "x" + tostr(p->data->hgh);
644 // now chdir into dir with .eps file, to be on the safe
646 lyx::chdir(OnlyPath(p->data->fname));
647 // make temp file name
648 string tmpf = make_tmp(getpid());
649 if (lyxerr.debugging()) {
650 lyxerr << "starting gs " << tmpf << " "
652 << ", pid: " << getpid() << endl;
655 int err = ::execlp(lyxrc.ps_command.c_str(),
656 lyxrc.ps_command.c_str(),
658 "-dNOPAUSE", "-dQUIET",
660 rbuf.c_str(), gbuf.c_str(), tmpf.c_str(),
661 p->data->fname.c_str(),
662 "showpage.ps", "quit.ps", "-", 0);
663 // if we are still there, an error occurred.
664 lyxerr << "Error executing ghostscript. "
665 << "Code: " << err << endl;
666 lyxerr.debug() << "Cmd: "
670 << p->data->fname << endl;
673 // normal process (parent)
674 if (lyxerr.debugging()) {
675 lyxerr << "GS [" << pid << "] started" << endl;
678 p->data->gspid = pid;
685 void addwait(int psx, int psy, int pswid, int pshgh, figdata * data)
687 // recompute the stuff and put in the queue
691 p.rx = (float(data->raw_wid) * 72.0) / pswid;
692 p.ry = (float(data->raw_hgh) * 72.0) / pshgh;
698 // if possible, run the queue
703 figdata * getfigdata(int wid, int hgh, string const & fname,
704 int psx, int psy, int pswid, int pshgh,
705 int raw_wid, int raw_hgh, float angle, char flags)
707 /* first search for an exact match with fname and width/height */
709 if (fname.empty() || !IsFileReadable(fname))
712 for (bitmaps_type::iterator it = bitmaps.begin();
713 it != bitmaps.end(); ++it) {
714 if ((*it)->wid == wid && (*it)->hgh == hgh &&
715 (*it)->flags == flags && (*it)->fname == fname &&
716 (*it)->angle == angle) {
721 figdata * p = new figdata;
724 p->raw_wid = raw_wid;
725 p->raw_hgh = raw_hgh;
729 bitmaps.push_back(p);
730 XWindowAttributes wa;
731 XGetWindowAttributes(fl_get_display(), fl_get_canvas_id(
732 figinset_canvas), &wa);
734 if (lyxerr.debugging()) {
735 lyxerr << "Create pixmap disp:" << fl_get_display()
736 << " scr:" << DefaultScreen(fl_get_display())
739 << " depth:" << wa.depth << endl;
747 p->bitmap = XCreatePixmap(fl_get_display(), fl_get_canvas_id(
748 figinset_canvas), wid, hgh, wa.depth);
750 // initialize reading of .eps file with correct sizes and stuff
751 addwait(psx, psy, pswid, pshgh, p);
762 void getbitmap(figdata * p)
768 void makeupdatelist(figdata * p)
770 for (figures_type::iterator it = figures.begin();
771 it != figures.end(); ++it)
772 if ((*it)->data == p) {
773 if (lyxerr.debugging()) {
774 lyxerr << "Updating inset "
778 // add inset figures[i]->inset into to_update list
779 current_view->pushIntoUpdateList((*it)->inset);
786 // this func is only "called" in spellchecker.C
787 void sigchldchecker(pid_t pid, int * status)
789 lyxerr.debug() << "Got pid = " << pid << endl;
790 bool pid_handled = false;
791 for (bitmaps_type::iterator it = bitmaps.begin();
792 it != bitmaps.end(); ++it) {
793 if ((*it)->reading && pid == (*it)->gspid) {
794 lyxerr.debug() << "Found pid in bitmaps" << endl;
795 // now read the file and remove it from disk
798 if ((*it)->gsdone) *status = 0;
800 lyxerr.debug() << "GS [" << pid
801 << "] exit OK." << endl;
803 lyxerr << "GS [" << pid << "] error "
805 << WIFEXITED(*status)
806 << " " << WEXITSTATUS(*status)
807 << " S:" << WIFSIGNALED(*status)
808 << " " << WTERMSIG(*status) << endl;
811 bitmap_waiting = true;
814 // remove temporary files
815 lyx::unlink(make_tmp(p->gspid));
819 makeupdatelist((*it));
826 lyxerr.debug() << "Checking pid in pidwait" << endl;
827 list<int>::iterator it = find(pidwaitlist.begin(),
828 pidwaitlist.end(), pid);
829 if (it != pidwaitlist.end()) {
830 lyxerr.debug() << "Found pid in pidwait\n"
831 << "Caught child pid of recompute "
832 "routine" << pid << endl;
833 pidwaitlist.erase(it);
837 lyxerr.debug() << "waitpid error" << endl;
840 lyxerr << "The process or process group specified by "
841 "pid does not exist or is not a child of "
842 "the calling process or can never be in the "
843 "states specified by options." << endl;
846 lyxerr << "waitpid() was interrupted due to the "
847 "receipt of a signal sent by the calling "
851 lyxerr << "An invalid value was specified for "
855 lyxerr << "Unknown error from waitpid" << endl;
858 } else if (pid == 0) {
859 lyxerr << "waitpid nohang" << endl;;
861 lyxerr.debug() << "normal exit from childhandler" << endl;
870 bitmap_waiting = false;
871 for (bitmaps_type::iterator it = bitmaps.begin();
872 it != bitmaps.end(); ++it)
873 if ((*it)->gspid > 0 && !(*it)->reading)
878 void RegisterFigure(InsetFig * fi)
880 if (figures.empty()) InitFigures();
882 Figref * tmpfig = new Figref;
885 figures.push_back(tmpfig);
888 if (lyxerr.debugging()) {
889 lyxerr << "Register Figure: buffer:["
890 << current_view->buffer() << "]" << endl;
895 void UnregisterFigure(InsetFig * fi)
900 Figref * tmpfig = fi->figure;
902 if (tmpfig->data) freefigdata(tmpfig->data);
903 if (tmpfig->inset->form) {
904 if (tmpfig->inset->form->Figure->visible) {
905 fl_set_focus_object(tmpfig->inset->form->Figure,
906 tmpfig->inset->form->OkBtn);
907 fl_hide_form(tmpfig->inset->form->Figure);
909 #if FL_REVISION == 89
910 // CHECK Reactivate this free_form calls
912 fl_free_form(tmpfig->inset->form->Figure);
913 free(tmpfig->inset->form); // Why free?
914 tmpfig->inset->form = 0;
917 figures.erase(find(figures.begin(), figures.end(), tmpfig));
920 if (figures.empty()) DoneFigures();
926 InsetFig::InsetFig(int tmpx, int tmpy, Buffer const & o)
936 psubfigure = subfigure = false;
937 xwid = xhgh = angle = 0;
939 raw_wid = raw_hgh = 0;
940 changedfname = false;
941 RegisterFigure(this);
942 r_ = Dialogs::redrawGUI.connect(SigC::slot(this, &InsetFig::redraw));
946 InsetFig::~InsetFig()
948 if (lyxerr.debugging()) {
949 lyxerr << "Figure destructor called" << endl;
951 UnregisterFigure(this);
956 void InsetFig::redraw()
958 if (form && form->Figure->visible)
959 fl_redraw_form(form->Figure);
963 int InsetFig::ascent(BufferView *, LyXFont const &) const
969 int InsetFig::descent(BufferView *, LyXFont const &) const
975 int InsetFig::width(BufferView *, LyXFont const &) const
981 void InsetFig::draw(BufferView * bv, LyXFont const & f,
982 int baseline, float & x, bool) const
985 Painter & pain = bv->painter();
987 if (bitmap_waiting) getbitmaps();
989 // I wish that I didn't have to use this
990 // but the figinset code is so complicated so
991 // I don't want to fiddle with it now.
993 if (figure && figure->data && figure->data->bitmap &&
994 !figure->data->reading && !figure->data->broken) {
996 pain.pixmap(int(x + 1), baseline - hgh,
997 wid, hgh, figure->data->bitmap);
1000 pain.rectangle(int(x), baseline - hgh - 1,
1004 char const * msg = 0;
1005 string lfname = fname;
1006 if (!fname.empty() && GetExtension(fname).empty())
1009 pain.rectangle(int(x), baseline - hgh - 1, wid + 1, hgh + 1);
1011 if (figure && figure->data) {
1012 if (figure->data->broken) msg = _("[render error]");
1013 else if (figure->data->reading) msg = _("[rendering ... ]");
1015 else if (fname.empty())
1016 msg = _("[no file]");
1017 else if (!IsFileReadable(lfname))
1018 msg = _("[bad file name]");
1019 else if ((flags & 3) == 0)
1020 msg = _("[not displayed]");
1021 else if (lyxrc.ps_command.empty())
1022 msg = _("[no ghostscript]");
1024 if (!msg) msg = _("[unknown error]");
1026 font.setFamily(LyXFont::SANS_FAMILY);
1027 font.setSize(LyXFont::SIZE_FOOTNOTE);
1028 string justname = OnlyFilename (fname);
1029 pain.text(int(x + 8), baseline - lyxfont::maxAscent(font) - 4,
1032 font.setSize(LyXFont::SIZE_TINY);
1033 pain.text(int(x + 8), baseline - 4, msg, strlen(msg), font);
1035 x += width(bv, font); // ?
1039 void InsetFig::Write(Buffer const *, ostream & os) const
1042 os << "Figure size " << wid << " " << hgh << "\n";
1043 if (!fname.empty()) {
1044 string buf1 = OnlyPath(owner->fileName());
1045 string fname2 = MakeRelPath(fname, buf1);
1046 os << "file " << fname2 << "\n";
1048 if (!subcaption.empty())
1049 os << "subcaption " << subcaption << "\n";
1050 if (wtype) os << "width " << static_cast<int>(wtype) << " " << xwid << "\n";
1051 if (htype) os << "height " << static_cast<int>(htype) << " " << xhgh << "\n";
1052 if (angle != 0) os << "angle " << angle << "\n";
1053 os << "flags " << flags << "\n";
1054 if (subfigure) os << "subfigure\n";
1058 void InsetFig::Read(Buffer const *, LyXLex & lex)
1061 bool finished = false;
1063 while (lex.IsOK() && !finished) {
1066 string const token = lex.GetString();
1067 lyxerr.debug() << "Token: " << token << endl;
1071 else if (token == "\\end_inset") {
1073 } else if (token == "file") {
1075 buf = lex.GetString();
1076 string buf1 = OnlyPath(owner->fileName());
1077 fname = MakeAbsPath(buf, buf1);
1078 changedfname = true;
1080 } else if (token == "extra") {
1082 // kept for backwards compability. Delete in 0.13.x
1083 } else if (token == "subcaption") {
1085 subcaption = lex.GetString();
1086 } else if (token == "label") {
1088 // kept for backwards compability. Delete in 0.13.x
1089 } else if (token == "angle") {
1091 angle = lex.GetFloat();
1092 } else if (token == "size") {
1094 wid = lex.GetInteger();
1096 hgh = lex.GetInteger();
1097 } else if (token == "flags") {
1099 flags = pflags = lex.GetInteger();
1100 } else if (token == "subfigure") {
1101 subfigure = psubfigure = true;
1102 } else if (token == "width") {
1105 typ = lex.GetInteger();
1107 xwid = lex.GetFloat();
1109 case DEF: wtype = DEF; break;
1110 case CM: wtype = CM; break;
1111 case IN: wtype = IN; break;
1112 case PER_PAGE: wtype = PER_PAGE; break;
1113 case PER_COL: wtype = PER_COL; break;
1115 lyxerr.debug() << "Unknown type!" << endl;
1119 } else if (token == "height") {
1122 typ = lex.GetInteger();
1124 xhgh = lex.GetFloat();
1126 case DEF: htype = DEF; break;
1127 case CM: htype = CM; break;
1128 case IN: htype = IN; break;
1129 case PER_PAGE: htype = PER_PAGE; break;
1131 lyxerr.debug() << "Unknown type!" << endl;
1142 int InsetFig::Latex(Buffer const *, ostream & os,
1143 bool /* fragile*/, bool /* fs*/) const
1146 if (!cmd.empty()) os << cmd << " ";
1151 int InsetFig::Ascii(Buffer const *, ostream &, int) const
1157 int InsetFig::Linuxdoc(Buffer const *, ostream &) const
1163 int InsetFig::DocBook(Buffer const *, ostream & os) const
1165 string buf1 = OnlyPath(owner->fileName());
1166 string figurename = MakeRelPath(fname, buf1);
1168 if (suffixIs(figurename, ".eps"))
1169 figurename.erase(figurename.length() - 4);
1171 os << "@<graphic fileref=\"" << figurename << "\"></graphic>";
1176 void InsetFig::Validate(LaTeXFeatures & features) const
1178 features.graphics = true;
1179 if (subfigure) features.subfigure = true;
1183 Inset::EDITABLE InsetFig::Editable() const
1189 bool InsetFig::Deletable() const
1195 string const InsetFig::EditMessage() const
1197 return _("Opened figure");
1201 void InsetFig::Edit(BufferView * bv, int, int, unsigned int)
1203 lyxerr.debug() << "Editing InsetFig." << endl;
1206 // We should have RO-versions of the form instead.
1207 // The actual prevention of altering a readonly doc
1208 // is done in CallbackFig()
1209 if (bv->buffer()->isReadonly())
1210 WarnReadonly(bv->buffer()->fileName());
1213 form = create_form_Figure();
1214 fl_set_form_atclose(form->Figure, CancelCloseBoxCB, 0);
1215 fl_set_object_return(form->Angle, FL_RETURN_ALWAYS);
1216 fl_set_object_return(form->Width, FL_RETURN_ALWAYS);
1217 fl_set_object_return(form->Height, FL_RETURN_ALWAYS);
1220 if (form->Figure->visible) {
1221 fl_raise_form(form->Figure);
1223 fl_show_form(form->Figure,
1224 FL_PLACE_MOUSE | FL_FREE_SIZE, FL_TRANSIENT,
1230 Inset * InsetFig::Clone(Buffer const & buffer) const
1232 InsetFig * tmp = new InsetFig(100, 100, buffer);
1234 if (lyxerr.debugging()) {
1235 lyxerr << "Clone Figure: buffer:["
1237 << "], cbuffer:[xx]" << endl;
1242 tmp->raw_wid = raw_wid;
1243 tmp->raw_hgh = raw_hgh;
1248 tmp->pflags = pflags;
1249 tmp->subfigure = subfigure;
1250 tmp->psubfigure = psubfigure;
1258 string lfname = fname;
1259 if (!fname.empty() && GetExtension(fname).empty())
1261 if (!fname.empty() && IsFileReadable(lfname)
1262 && (flags & 3) && !lyxrc.ps_command.empty()
1264 // do not display if there is
1265 // "do not display" chosen (Matthias 260696)
1266 tmp->figure->data = getfigdata(wid, hgh, lfname, psx, psy,
1267 pswid, pshgh, raw_wid, raw_hgh,
1268 angle, flags & (3|8));
1269 } else tmp->figure->data = 0;
1270 tmp->subcaption = subcaption;
1271 tmp->changedfname = false;
1278 Inset::Code InsetFig::LyxCode() const
1280 return Inset::GRAPHICS_CODE;
1286 string const stringify(InsetFig::HWTYPE hw, float f, string suffix)
1292 case InsetFig::CM:// \resizebox*{h-length}{v-length}{text}
1293 res = tostr(f) + "cm";
1296 res = tostr(f) + "in";
1298 case InsetFig::PER_PAGE:
1299 res = tostr(f/100) + "\\text" + suffix;
1301 case InsetFig::PER_COL:
1302 // Doesn't occur for htype...
1303 res = tostr(f/100) + "\\column" + suffix;
1312 void InsetFig::Regenerate() const
1315 string resizeW, resizeH;
1316 string rotate, recmd;
1318 if (fname.empty()) {
1319 cmd = "\\fbox{\\rule[-0.5in]{0pt}{1in}";
1320 cmd += _("empty figure path");
1325 string buf1 = OnlyPath(owner->fileName());
1326 string fname2 = MakeRelPath(fname, buf1);
1328 string gcmd = "\\includegraphics{" + fname2 + '}';
1329 resizeW = stringify(wtype, xwid, "width");
1330 resizeH = stringify(htype, xhgh, "height");
1332 if (!resizeW.empty() || !resizeH.empty()) {
1333 recmd = "\\resizebox*{";
1334 if (!resizeW.empty())
1339 if (!resizeH.empty())
1348 // \rotatebox{angle}{text}
1349 rotate = "\\rotatebox{" + tostr(angle) + "}{";
1355 if (!rotate.empty()) cmdbuf += '}';
1356 if (!recmd.empty()) cmdbuf += '}';
1358 if (!subcaption.empty())
1359 cmdbuf = "\\subfigure[" + subcaption +
1360 "]{" + cmdbuf + "}";
1362 cmdbuf = "\\subfigure{" + cmdbuf + "}";
1369 void InsetFig::TempRegenerate()
1372 string resizeW, resizeH;
1373 string rotate, recmd;
1375 char const * tfname = fl_get_input(form->EpsFile);
1376 string tsubcap = fl_get_input(form->Subcaption);
1377 float tangle = atof(fl_get_input(form->Angle));
1378 float txwid = atof(fl_get_input(form->Width));
1379 float txhgh = atof(fl_get_input(form->Height));
1381 if (!tfname || !*tfname) {
1382 cmd = "\\fbox{\\rule[-0.5in]{0pt}{1in}";
1383 cmd += _("empty figure path");
1388 string buf1 = OnlyPath(owner->fileName());
1389 string fname2 = MakeRelPath(tfname, buf1);
1390 // \includegraphics*[<llx,lly>][<urx,ury>]{file}
1391 string gcmd = "\\includegraphics{" + fname2 + '}';
1393 resizeW = stringify(twtype, txwid, "width");
1394 resizeH = stringify(thtype, txhgh, "height");
1396 // \resizebox*{h-length}{v-length}{text}
1397 if (!resizeW.empty() || !resizeH.empty()) {
1398 recmd = "\\resizebox*{";
1399 if (!resizeW.empty())
1404 if (!resizeH.empty())
1412 // \rotatebox{angle}{text}
1413 rotate = "\\rotatebox{" + tostr(tangle) + "}{";
1416 cmdbuf = recmd + rotate + gcmd;
1417 if (!rotate.empty()) cmdbuf += '}';
1418 if (!recmd.empty()) cmdbuf += '}';
1419 if (psubfigure && !tsubcap.empty()) {
1420 cmdbuf = string("\\subfigure{") + tsubcap
1421 + string("}{") + cmdbuf + "}";
1426 void InsetFig::Recompute()
1431 bool changed = changedfname;
1432 int newx, newy, nraw_x, nraw_y;
1434 if (changed) GetPSSizes();
1436 float sin_a = sin (angle / DEG2PI); /* rotation; H. Zeller 021296 */
1437 float cos_a = cos (angle / DEG2PI);
1438 int frame_wid = int(ceil(fabs(cos_a * pswid) + fabs(sin_a * pshgh)));
1439 int frame_hgh= int(ceil(fabs(cos_a * pshgh) + fabs(sin_a * pswid)));
1441 string lfname = fname;
1442 if (GetExtension(fname).empty())
1445 /* now recompute wid and hgh, and if that is changed, set changed */
1446 /* this depends on chosen size of the picture and its bbox */
1447 // This will be redone in 0.13 ... (hen)
1448 if (!lfname.empty() && IsFileReadable(lfname)) {
1449 // say, total width is 595 pts, as A4 in TeX, thats in 1/72" */
1457 newx = int(28.346 * xwid);
1460 newx = int(72 * xwid);
1462 case PER_PAGE: /* % of page */
1463 newx = int(5.95 * xwid);
1465 case PER_COL: /* % of col */
1466 newx = int(2.975 * xwid);
1470 if (wtype && frame_wid) newy = newx*frame_hgh/frame_wid;
1474 //lyxerr << "This should not happen!" << endl;
1477 newy = int(28.346 * xhgh);
1480 newy = int(72 * xhgh);
1482 case PER_PAGE: /* % of page */
1483 newy = int(8.42 * xhgh);
1486 // Doesn't occur; case exists to suppress
1487 // compiler warnings.
1490 if (htype && !wtype && frame_hgh)
1491 newx = newy*frame_wid/frame_hgh;
1500 nraw_x = int((1.0 * pswid * newx)/frame_wid);
1505 nraw_y = int((1.0 * pshgh * newy)/frame_hgh);
1507 // cannot be zero, actually, set it to some minimum, so its clickable
1508 if (newx < 5) newx = 5;
1509 if (newy < 5) newy = 5;
1511 if (newx != wid || newy != hgh ||
1512 nraw_x != raw_wid || nraw_y != raw_hgh ||
1513 flags != pflags || subfigure != psubfigure)
1521 subfigure = psubfigure;
1524 figdata * pf = figure->data;
1527 if (!lfname.empty() && IsFileReadable(lfname) && (flags & 3)
1528 && !lyxrc.ps_command.empty()) {
1529 // do not display if there is "do not display"
1530 // chosen (Matthias 260696)
1531 figure->data = getfigdata(wid, hgh, lfname,
1532 psx, psy, pswid, pshgh,
1534 angle, flags & (3|8));
1535 } else figure->data = 0;
1537 // free the old data
1538 if (pf) freefigdata(pf);
1541 changedfname = false;
1545 void InsetFig::GetPSSizes()
1547 /* get %%BoundingBox: from postscript file */
1549 /* defaults to associated size
1550 * ..just in case the PS-file is not readable (Henner, 24-Aug-97)
1557 if (fname.empty()) return;
1559 string lfname = fname;
1560 if (GetExtension(fname).empty())
1562 ifstream ifs(lfname.c_str());
1564 if (!ifs) return; // file not found !!!!
1566 /* defaults to A4 page */
1572 char lastchar = 0; ifs.get(lastchar);
1574 char c = 0; ifs.get(c);
1576 lyxerr.debug() << "End of (E)PS file reached and"
1577 " no BoundingBox!" << endl;
1580 if (c == '%' && lastchar == '%') {
1582 if (p.empty()) break;
1583 lyxerr.debug() << "Token: `" << p << "'" << endl;
1584 if (p == "BoundingBox:") {
1585 float fpsx, fpsy, fpswid, fpshgh;
1586 if (ifs >> fpsx >> fpsy >> fpswid >> fpshgh) {
1589 pswid = int(fpswid);
1590 pshgh = int(fpshgh);
1592 if (lyxerr.debugging()) {
1593 lyxerr << "%%%%BoundingBox:"
1611 void InsetFig::CallbackFig(long arg)
1616 if (lyxerr.debugging()) {
1617 lyxerr << "Figure callback, arg " << arg << endl;
1623 case 12: /* width type */
1630 fl_deactivate_object(form->Width);
1635 fl_activate_object(form->Width);
1640 fl_activate_object(form->Width);
1645 fl_activate_object(form->Width);
1650 fl_activate_object(form->Width);
1653 lyxerr.debug() << "Unknown type!" << endl;
1660 case 22: /* height type */
1666 fl_deactivate_object(form->Height);
1671 fl_activate_object(form->Height);
1676 fl_activate_object(form->Height);
1681 fl_activate_object(form->Height);
1684 lyxerr.debug() << "Unknown type!" << endl;
1690 pflags = pflags & ~3; /* wysiwyg0 */
1693 pflags = (pflags & ~3) | 1; /* wysiwyg1 */
1696 pflags = (pflags & ~3) | 2; /* wysiwyg2 */
1699 pflags = (pflags & ~3) | 3; /* wysiwyg3 */
1702 pflags ^= 4; /* frame */
1705 pflags ^= 8; /* do translations */
1708 psubfigure = !psubfigure; /* This is a subfigure */
1711 regen = true; /* regenerate command */
1713 case 0: /* browse file */
1717 case 1: /* preview */
1718 p = fl_get_input(form->EpsFile);
1722 case 8: /* ok (apply and close) */
1723 if (!current_view->buffer()->isReadonly()) {
1726 xwid = atof(fl_get_input(form->Width));
1727 xhgh = atof(fl_get_input(form->Height));
1728 angle = atof(fl_get_input(form->Angle));
1729 p = fl_get_input(form->EpsFile);
1731 string buf1 = OnlyPath(owner->fileName());
1732 fname = MakeAbsPath(p, buf1);
1733 changedfname = true;
1735 if (!fname.empty()) {
1736 changedfname = true;
1740 subcaption = fl_get_input(form->Subcaption);
1744 /* now update inset */
1745 if (lyxerr.debugging()) {
1746 lyxerr << "Update: ["
1747 << wid << 'x' << hgh << ']' << endl;
1749 current_view->updateInset(this, true);
1751 fl_set_focus_object(form->Figure, form->OkBtn);
1752 fl_hide_form(form->Figure);
1753 #if FL_REVISION == 89
1754 // CHECK Reactivate this free_form calls
1756 fl_free_form(form->Figure);
1757 free(form); // Why free?
1763 // The user has already been informed about RO in ::Edit
1764 if (arg == 7) // if 'Apply'
1767 case 9: /* cancel = restore and close */
1768 fl_set_focus_object(form->Figure, form->OkBtn);
1769 fl_hide_form(form->Figure);
1770 #if FL_REVISION == 89
1771 // CHECK Reactivate this free_form calls
1772 // Jug, is this still a problem?
1774 fl_free_form(form->Figure);
1775 free(form); // Why free?
1781 if (regen) TempRegenerate();
1786 void DisableFigurePanel(FD_Figure * const form)
1788 fl_deactivate_object(form->EpsFile);
1789 fl_deactivate_object(form->Browse);
1790 fl_deactivate_object(form->Width);
1791 fl_deactivate_object(form->Height);
1792 fl_deactivate_object(form->Frame);
1793 fl_deactivate_object(form->Translations);
1794 fl_deactivate_object(form->Angle);
1795 fl_deactivate_object(form->HeightGrp);
1796 fl_deactivate_object(form->page2);
1797 fl_deactivate_object(form->Default2);
1798 fl_deactivate_object(form->cm2);
1799 fl_deactivate_object(form->in2);
1800 fl_deactivate_object(form->HeightLabel);
1801 fl_deactivate_object(form->WidthLabel);
1802 fl_deactivate_object(form->DisplayGrp);
1803 fl_deactivate_object(form->Wysiwyg3);
1804 fl_deactivate_object(form->Wysiwyg0);
1805 fl_deactivate_object(form->Wysiwyg2);
1806 fl_deactivate_object(form->Wysiwyg1);
1807 fl_deactivate_object(form->WidthGrp);
1808 fl_deactivate_object(form->Default1);
1809 fl_deactivate_object(form->cm1);
1810 fl_deactivate_object(form->in1);
1811 fl_deactivate_object(form->page1);
1812 fl_deactivate_object(form->column1);
1813 fl_deactivate_object(form->Subcaption);
1814 fl_deactivate_object(form->Subfigure);
1815 fl_deactivate_object (form->OkBtn);
1816 fl_deactivate_object (form->ApplyBtn);
1817 fl_set_object_lcol (form->OkBtn, FL_INACTIVE);
1818 fl_set_object_lcol (form->ApplyBtn, FL_INACTIVE);
1823 void EnableFigurePanel(FD_Figure * const form)
1825 fl_activate_object(form->EpsFile);
1826 fl_activate_object(form->Browse);
1827 fl_activate_object(form->Width);
1828 fl_activate_object(form->Height);
1829 fl_activate_object(form->Frame);
1830 fl_activate_object(form->Translations);
1831 fl_activate_object(form->Angle);
1832 fl_activate_object(form->HeightGrp);
1833 fl_activate_object(form->page2);
1834 fl_activate_object(form->Default2);
1835 fl_activate_object(form->cm2);
1836 fl_activate_object(form->in2);
1837 fl_activate_object(form->HeightLabel);
1838 fl_activate_object(form->WidthLabel);
1839 fl_activate_object(form->DisplayGrp);
1840 fl_activate_object(form->Wysiwyg3);
1841 fl_activate_object(form->Wysiwyg0);
1842 fl_activate_object(form->Wysiwyg2);
1843 fl_activate_object(form->Wysiwyg1);
1844 fl_activate_object(form->WidthGrp);
1845 fl_activate_object(form->Default1);
1846 fl_activate_object(form->cm1);
1847 fl_activate_object(form->in1);
1848 fl_activate_object(form->page1);
1849 fl_activate_object(form->column1);
1850 fl_activate_object(form->Subcaption);
1851 fl_activate_object(form->Subfigure);
1852 fl_activate_object (form->OkBtn);
1853 fl_activate_object (form->ApplyBtn);
1854 fl_set_object_lcol (form->OkBtn, FL_BLACK);
1855 fl_set_object_lcol (form->ApplyBtn, FL_BLACK);
1859 void InsetFig::RestoreForm()
1861 EnableFigurePanel(form);
1864 fl_set_button(form->Default1, (wtype == 0));
1865 fl_set_button(form->cm1, (wtype == 1));
1866 fl_set_button(form->in1, (wtype == 2));
1867 fl_set_button(form->page1, (wtype == 3));
1868 fl_set_button(form->column1, (wtype == 4));
1870 fl_deactivate_object(form->Width);
1872 fl_activate_object(form->Width);
1875 // enable and disable should be put here.
1877 fl_set_button(form->Default2, (htype == 0));
1878 fl_set_button(form->cm2, (htype == 1));
1879 fl_set_button(form->in2, (htype == 2));
1880 fl_set_button(form->page2, (htype == 3));
1881 // enable and disable should be put here.
1883 fl_deactivate_object(form->Height);
1885 fl_activate_object(form->Height);
1888 int piflags = flags & 3;
1889 fl_set_button(form->Wysiwyg0, (piflags == 0));
1890 fl_set_button(form->Wysiwyg1, (piflags == 1));
1891 fl_set_button(form->Wysiwyg2, (piflags == 2));
1892 fl_set_button(form->Wysiwyg3, (piflags == 3));
1893 fl_set_button(form->Frame, ((flags & 4) != 0));
1894 fl_set_button(form->Translations, ((flags & 8) != 0));
1895 fl_set_button(form->Subfigure, (subfigure != 0));
1897 psubfigure = subfigure;
1898 fl_set_input(form->Width, tostr(xwid).c_str());
1899 fl_set_input(form->Height, tostr(xhgh).c_str());
1900 fl_set_input(form->Angle, tostr(angle).c_str());
1901 if (!fname.empty()){
1902 string buf1 = OnlyPath(owner->fileName());
1903 string fname2 = MakeRelPath(fname, buf1);
1904 fl_set_input(form->EpsFile, fname2.c_str());
1906 else fl_set_input(form->EpsFile, "");
1907 fl_set_input(form->Subcaption, subcaption.c_str());
1908 if (current_view->buffer()->isReadonly())
1909 DisableFigurePanel(form);
1915 void InsetFig::Preview(string const & p)
1918 if (GetExtension(tfname).empty())
1920 string buf1 = OnlyPath(owner->fileName());
1921 string buf2 = MakeAbsPath(tfname, buf1);
1922 if (!formats.View(owner, buf2, "eps"))
1923 lyxerr << "Can't view " << buf2 << endl;
1926 void InsetFig::BrowseFile()
1928 static string current_figure_path;
1929 static int once = 0;
1931 if (lyxerr.debugging()) {
1932 lyxerr << "Filename: "
1933 << owner->fileName() << endl;
1935 string p = fl_get_input(form->EpsFile);
1937 string buf = MakeAbsPath(owner->fileName());
1938 string buf2 = OnlyPath(buf);
1940 buf = MakeAbsPath(p, buf2);
1941 buf = OnlyPath(buf);
1943 buf = OnlyPath(owner->fileName());
1946 // Does user clipart directory exist?
1947 string bufclip = AddName (user_lyxdir, "clipart");
1948 FileInfo fileInfo(bufclip);
1949 if (!(fileInfo.isOK() && fileInfo.isDir()))
1950 // No - bail out to system clipart directory
1951 bufclip = AddName (system_lyxdir, "clipart");
1954 FileDialog fileDlg(current_view->owner(), _("Select an EPS figure"),
1955 LFUN_SELECT_FILE_SYNC,
1956 make_pair(string(_("Clip art")), string(bufclip)),
1957 make_pair(string(_("Documents")), string(buf)));
1961 string const path = (once) ? current_figure_path : buf;
1963 FileDialog::Result result = fileDlg.Select(path, _("*ps| PostScript documents"));
1965 string const p = result.second;
1970 buf = MakeRelPath(p, buf2);
1971 current_figure_path = OnlyPath(p);
1974 if (contains(p, "#") || contains(p, "~") || contains(p, "$")
1975 || contains(p, "%") || contains(p, " ")) {
1976 WriteAlert(_("Filename can't contain any "
1977 "of these characters:"),
1978 // xgettext:no-c-format
1979 _("space, '#', '~', '$' or '%'."));
1984 if (form) fl_set_input(form->EpsFile, buf.c_str());
1988 void GraphicsCB(FL_OBJECT * obj, long arg)
1990 /* obj->form contains the form */
1992 if (lyxerr.debugging()) {
1993 lyxerr << "GraphicsCB callback: " << arg << endl;
1996 /* find inset we were reacting to */
1997 for (figures_type::iterator it = figures.begin();
1998 it != figures.end(); ++it)
1999 if ((*it)->inset->form && (*it)->inset->form->Figure
2001 if (lyxerr.debugging()) {
2002 lyxerr << "Calling back figure "
2005 (*it)->inset->CallbackFig(arg);
2011 void HideFiguresPopups()
2013 for (figures_type::iterator it = figures.begin();
2014 it != figures.end(); ++it)
2015 if ((*it)->inset->form
2016 && (*it)->inset->form->Figure->visible) {
2017 if (lyxerr.debugging()) {
2018 lyxerr << "Hiding figure " << (*it) << endl;
2020 // hide and free the form
2021 (*it)->inset->CallbackFig(9);