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)
35 #include FORMS_H_LOCATION
58 #include "support/filetools.h"
59 #include "LyXView.h" // just because of form_main
61 #include "LaTeXFeatures.h"
64 #include "lyx_gui_misc.h" // CancelCloseBoxCB
65 #include "support/FileInfo.h"
66 #include "support/lyxlib.h"
69 extern BufferView * current_view;
70 extern FL_OBJECT * figinset_canvas;
72 extern char ** environ; // is this only redundtant on linux systems? Lgb.
74 extern void ProhibitInput();
75 extern void AllowInput();
77 static float const DEG2PI = 57.295779513;
79 struct queue_element {
80 float rx, ry; // resolution x and y
81 int ofsx, ofsy; // x and y translation
82 figdata * data; // we are doing it for this data
85 static int const MAXGS = 3; /* maximum 3 gs's at a time */
87 typedef vector<Figref *> figures_type;
88 typedef vector<figdata *> bitmaps_type;
89 static figures_type figures; // all figures
90 static bitmaps_type bitmaps; // all bitmaps
92 static queue<queue_element> gsqueue; // queue for ghostscripting
94 static int gsrunning = 0; /* currently so many gs's are running */
95 static bool bitmap_waiting = false; /* bitmaps are waiting finished */
96 static char bittable[256]; /* bit reversion table */
98 static bool gs_color; // do we allocate colors for gs?
99 static bool color_visual; // is the visual color?
100 static bool gs_xcolor = false; // allocated extended colors
101 static unsigned long gs_pixels[128]; // allocated pixels
102 static int gs_num_pixels; // number of pixels allocated
103 static int gs_spc; // shades per color
104 static bool gs_gray; // is grayscale?
105 static int gs_allcolors; // number of all colors
107 static list<int> pidwaitlist; // pid wait list
114 val.foreground = BlackPixel(fl_display,
115 DefaultScreen(fl_display));
118 val.graphics_exposures = false;
119 val.line_style = LineSolid;
121 return XCreateGC(fl_display, RootWindow(fl_display, 0),
122 GCForeground | GCFunction | GCGraphicsExposures
123 | GCLineWidth | GCLineStyle , &val);
131 void addpidwait(int pid)
133 // adds pid to pid wait list
134 pidwaitlist.push_back(pid);
136 if (lyxerr.debugging()) {
137 lyxerr << "Pids to wait for: \n";
138 for (list<int>::const_iterator cit = pidwaitlist.begin();
139 cit != pidwaitlist.end(); ++cit) {
140 lyxerr << (*cit) << '\n';
148 int GhostscriptMsg(FL_OBJECT *, Window, int, int,
153 XClientMessageEvent * e = reinterpret_cast<XClientMessageEvent*>(ev);
155 if(lyxerr.debugging()) {
156 lyxerr << "ClientMessage, win:[xx] gs:[" << e->data.l[0]
157 << "] pm:[" << e->data.l[1] << "]" << endl;
160 // just kill gs, that way it will work for sure
161 // This loop looks like S**T so it probably is...
162 //for (bitmaps_type::size_type i = 0; i < bitmaps.size(); ++i)
163 for (bitmaps_type::iterator it = bitmaps.begin();
164 it != bitmaps.end(); ++it)
165 if (static_cast<long>((*it)->bitmap) ==
166 static_cast<long>(e->data.l[1])) {
171 // first update p->bitmap, if necessary
172 if (p->bitmap != None
173 && p->flags > (1|8) && gs_color && p->wid) {
174 // query current colormap and re-render
175 // the pixmap with proper colors
176 XWindowAttributes wa;
177 register XImage * im;
181 int spc1 = gs_spc - 1;
182 int spc2 = gs_spc * gs_spc;
186 GC gc = local_gc_copy;
188 XGetWindowAttributes(fl_display,
193 if (lyxerr.debugging()) {
194 lyxerr << "Starting image translation "
197 << p->wid << "x" << p->hgh
199 << " " << XYPixmap << endl;
201 // now fork rendering process
203 if (forkstat == -1) {
205 << "Cannot fork, using slow "
206 "method for pixmap translation." << endl;
207 tmpdisp = fl_display;
208 } else if (forkstat > 0) { // parent
210 if (lyxerr.debugging()) {
211 lyxerr << "Spawned child "
214 addpidwait(forkstat);
217 tmpdisp = XOpenDisplay(XDisplayName(0));
220 im = XGetImage(tmpdisp, p->bitmap, 0, 0,
221 p->wid, p->hgh, (1<<wa.depth)-1, XYPixmap);
223 if (lyxerr.debugging()) {
224 lyxerr << "Got the image" << endl;
227 if (lyxerr.debugging()) {
228 lyxerr << "Error getting the image" << endl;
233 // query current colormap
234 XColor * cmap = new XColor[gs_allcolors];
235 for (i = 0; i < gs_allcolors; ++i) cmap[i].pixel = i;
236 XQueryColors(tmpdisp,
237 fl_state[fl_get_vclass()]
242 // now we process all the image
243 for (y = 0; y < p->hgh; ++y) {
244 for (int x = 0; x < wid; ++x) {
249 gs_pixels[((pc->red+6553)*
250 spc1/65535)*spc2+((pc->green+6553)*
251 spc1/65535)*gs_spc+((pc->blue+6553)*
256 // This must be correct.
258 if (lyxerr.debugging()) {
259 lyxerr << "Putting image back"
262 XPutImage(tmpdisp, p->bitmap,
264 0, 0, p->wid, p->hgh);
266 if (lyxerr.debugging()) {
267 lyxerr << "Done translation"
272 if (lyxerr.debugging()) {
273 lyxerr << "Killing gs "
276 lyx::kill(p->gspid, SIGHUP);
278 sprintf(tmp, "%s/~lyxgs%d.ps",
279 system_tempdir.c_str(),
283 XCloseDisplay(tmpdisp);
287 if (lyxerr.debugging()) {
288 lyxerr << "Killing gs "
291 lyx::kill(p->gspid, SIGHUP);
293 sprintf(tmp, "%s/~lyxgs%d.ps",
294 system_tempdir.c_str(),
305 void AllocColors(int num)
306 // allocate color cube numxnumxnum, if possible
308 if (lyxerr.debugging()) {
309 lyxerr << "Allocating color cube " << num
310 << 'x' << num << 'x' << num << endl;
314 lyxerr << "Error allocating color colormap." << endl;
318 if (num > 5) num = 5;
320 for (int i = 0; i < num * num * num; ++i) {
321 xcol.red = 65535 * (i / (num * num)) / (num - 1);
322 xcol.green = 65535 * ((i / num) % num) / (num - 1);
323 xcol.blue = 65535 * (i % num) / (num - 1);
324 xcol.flags = DoRed | DoGreen | DoBlue;
325 if (!XAllocColor(fl_display,
326 fl_state[fl_get_vclass()].colormap, &xcol)) {
327 if (i) XFreeColors(fl_display,
328 fl_state[fl_get_vclass()].colormap,
330 if(lyxerr.debugging()) {
331 lyxerr << "Cannot allocate color cube "
334 AllocColors(num - 1);
337 gs_pixels[i] = xcol.pixel;
342 gs_num_pixels = num * num * num;
346 // allocate grayscale ramp
348 void AllocGrays(int num)
350 if (lyxerr.debugging()) {
351 lyxerr << "Allocating grayscale colormap "
356 lyxerr << "Error allocating grayscale colormap." << endl;
360 if (num > 128) num = 128;
362 for (int i = 0; i < num; ++i) {
363 xcol.red = xcol.green = xcol.blue = 65535 * i / (num - 1);
364 xcol.flags = DoRed | DoGreen | DoBlue;
365 if (!XAllocColor(fl_display,
366 fl_state[fl_get_vclass()].colormap, &xcol)) {
367 if (i) XFreeColors(fl_display,
368 fl_state[fl_get_vclass()].colormap,
370 if (lyxerr.debugging()) {
371 lyxerr << "Cannot allocate grayscale "
377 gs_pixels[i] = xcol.pixel;
388 // if bitmaps and figures are not empty we will leak mem
393 for (unsigned int i = 0; i < 256; ++i) {
395 for (unsigned int j = 0; j < 8; ++j)
396 if (i & (1 << (7-j))) k |= 1 << j;
397 bittable[i] = char(~k);
400 fl_add_canvas_handler(figinset_canvas, ClientMessage,
401 GhostscriptMsg, current_view->owner()->getMainForm());
403 // allocate color cube on pseudo-color display
406 local_gc_copy = createGC();
408 Visual * vi = DefaultVisual(fl_display, DefaultScreen(fl_display));
409 if (lyxerr.debugging()) {
410 printf("Visual ID: %ld, class: %d, bprgb: %d, mapsz: %d\n",
411 vi->visualid, vi->c_class,
412 vi->bits_per_rgb, vi->map_entries);
414 color_visual = ( (vi->c_class == StaticColor) ||
415 (vi->c_class == PseudoColor) ||
416 (vi->c_class == TrueColor) ||
417 (vi->c_class == DirectColor) );
418 if ((vi->c_class & 1) == 0) return;
419 // now allocate colors
420 if (vi->c_class == GrayScale) {
421 // allocate grayscale
422 AllocGrays(vi->map_entries/2);
424 // allocate normal color
426 while (i * i * i * 2 > vi->map_entries) --i;
429 gs_allcolors = vi->map_entries;
436 // if bitmaps and figures are not empty we will leak mem
440 lyxerr.debug() << "Unregistering figures..." << endl;
442 fl_remove_canvas_handler(figinset_canvas, ClientMessage,
448 void freefigdata(figdata * tmpdata)
451 if (tmpdata->ref) return;
453 if (tmpdata->gspid > 0) {
454 int pid = tmpdata->gspid;
456 // kill ghostscript and unlink it's files
458 lyx::kill(pid, SIGKILL);
459 sprintf(buf, "%s/~lyxgs%d.ps", system_tempdir.c_str(), pid);
463 if (tmpdata->bitmap) XFreePixmap(fl_display, tmpdata->bitmap);
464 bitmaps.erase(find(bitmaps.begin(), bitmaps.end(), tmpdata));
472 // run queued requests for ghostscript, if any
473 if (!gsrunning && gs_color && !gs_xcolor) {
474 // here alloc all colors, so that gs will use only
475 // those we allocated for it
480 while (gsrunning < MAXGS) {
481 char tbuf[384], tbuf2[80];
485 if (gsqueue.empty()) {
486 if (!gsrunning && gs_xcolor) {
487 // de-allocate rest of colors
493 queue_element * p = &gsqueue.front();
502 if (lyxerr.debugging()) {
503 lyxerr << "GS start error! Cannot fork."
506 p->data->broken = true;
507 p->data->reading = false;
510 if (pid == 0) { // child
511 char ** env, rbuf[80], gbuf[40];
513 Display * tempdisp = XOpenDisplay(XDisplayName(0));
515 // create translation file
516 sprintf(tbuf, "%s/~lyxgs%d.ps", system_tempdir.c_str(),
520 ofs << "gsave clippath pathbbox grestore\n"
522 << "/ury exch def /urx exch def /lly exch def "
524 << p->data->wid / 2.0 << " "
525 << p->data->hgh / 2.0 << " translate\n"
526 << p->data->angle << " rotate\n"
527 << -(p->data->raw_wid / 2.0) << " "
528 << -(p->data->raw_hgh / 2.0) << " translate\n"
529 << p->rx / 72.0 << " " << p->ry / 72.0
531 << -p->ofsx << " " << -p->ofsy << " translate\n"
533 ofs.close(); // Don't remove this.
535 // gs process - set ghostview environment first
536 sprintf(tbuf2, "GHOSTVIEW=%ld %ld", fl_get_canvas_id(
537 figinset_canvas), p->data->bitmap);
539 // now set up ghostview property on a window
540 sprintf(tbuf, "0 0 0 0 %d %d 72 72 0 0 0 0",
541 p->data->wid, p->data->hgh);
542 // #warning BUG seems that the only bug here
543 // might be the hardcoded dpi.. Bummer!
545 if (lyxerr.debugging()) {
546 lyxerr << "Will set GHOSTVIEW property to ["
547 << tbuf << "]" << endl;
549 // wait until property is deleted if executing multiple
552 // grab server to prevent other child
553 // interfering with setting GHOSTVIEW property
554 if (lyxerr.debugging()) {
555 lyxerr << "Grabbing the server"
558 XGrabServer(tempdisp);
559 prop = XListProperties(tempdisp,
561 figinset_canvas), &nprop);
565 for (i = 0; i < nprop; ++i) {
566 char * p = XGetAtomName(tempdisp,
568 if (strcmp(p, "GHOSTVIEW") == 0) {
574 XFree(reinterpret_cast<char *>(prop)); // jc:
576 // release the server
577 XUngrabServer(tempdisp);
579 // ok, property found, we must wait until
580 // ghostscript deletes it
581 if (lyxerr.debugging()) {
582 lyxerr << "Releasing the server\n["
584 << "] GHOSTVIEW property"
585 " found. Waiting." << endl;
591 XChangeProperty(tempdisp,
592 fl_get_canvas_id(figinset_canvas),
593 XInternAtom(tempdisp, "GHOSTVIEW", false),
594 XInternAtom(tempdisp, "STRING", false),
596 reinterpret_cast<unsigned char*>(tbuf),
599 switch (p->data->flags & 3) {
600 case 0: tbuf[0] = 'H'; break; // Hidden
601 case 1: tbuf[0] = 'M'; break; // Mono
602 case 2: tbuf[0] = 'G'; break; // Gray
605 tbuf[0] = 'C'; // Color
607 tbuf[0] = 'G'; // Gray
611 sprintf(tbuf+1, " %ld %ld", BlackPixelOfScreen(
612 DefaultScreenOfDisplay(fl_display)),
613 fl_get_pixel(FL_WHITE));
615 XChangeProperty(tempdisp,
616 fl_get_canvas_id(figinset_canvas),
617 XInternAtom(tempdisp,
618 "GHOSTVIEW_COLORS", false),
619 XInternAtom(tempdisp, "STRING", false),
621 reinterpret_cast<unsigned char*>(tbuf),
623 XUngrabServer(tempdisp);
625 if (lyxerr.debugging()) {
626 lyxerr << "Releasing the server" << endl;
628 XCloseDisplay(tempdisp);
630 // set up environment
631 while (environ[ne]) ++ne;
632 typedef char * char_p;
633 env = new char_p[ne + 2];
635 memcpy(&env[1], environ, sizeof(char*) * (ne + 1));
638 // now make gs command
640 // close(1); do NOT close. If GS writes out
641 // errors it would hang. (Matthias 290596)
642 sprintf(rbuf, "-r%gx%g", p->rx, p->ry);
643 sprintf(gbuf, "-g%dx%d", p->data->wid, p->data->hgh);
644 // now chdir into dir with .eps file, to be on the safe
646 chdir(OnlyPath(p->data->fname).c_str());
647 // make temp file name
648 sprintf(tbuf, "%s/~lyxgs%d.ps", system_tempdir.c_str(),
650 if (lyxerr.debugging()) {
651 lyxerr << "starting gs " << tbuf << " "
653 << ", pid: " << getpid() << endl;
656 int err = execlp(lyxrc.ps_command.c_str(),
657 lyxrc.ps_command.c_str(),
659 "-dNOPAUSE", "-dQUIET",
662 p->data->fname.c_str(),
663 "showpage.ps", "quit.ps", "-", 0);
664 // if we are still there, an error occurred.
665 lyxerr << "Error executing ghostscript. "
666 << "Code: " << err << endl;
667 lyxerr.debug() << "Cmd: "
671 << p->data->fname << endl;
674 // normal process (parent)
675 if (lyxerr.debugging()) {
676 lyxerr << "GS [" << pid << "] started" << endl;
679 p->data->gspid = pid;
687 void addwait(int psx, int psy, int pswid, int pshgh, figdata * data)
689 // recompute the stuff and put in the queue
693 p.rx = (float(data->raw_wid) * 72.0) / pswid;
694 p.ry = (float(data->raw_hgh) * 72.0) / pshgh;
700 // if possible, run the queue
706 figdata * getfigdata(int wid, int hgh, string const & fname,
707 int psx, int psy, int pswid, int pshgh,
708 int raw_wid, int raw_hgh, float angle, char flags)
710 /* first search for an exact match with fname and width/height */
712 if (fname.empty()) return 0;
714 for (bitmaps_type::iterator it = bitmaps.begin();
715 it != bitmaps.end(); ++it) {
716 if ((*it)->wid == wid && (*it)->hgh == hgh &&
717 (*it)->flags == flags && (*it)->fname == fname &&
718 (*it)->angle == angle) {
723 figdata * p = new figdata;
726 p->raw_wid = raw_wid;
727 p->raw_hgh = raw_hgh;
731 bitmaps.push_back(p);
732 XWindowAttributes wa;
733 XGetWindowAttributes(fl_display, fl_get_canvas_id(
734 figinset_canvas), &wa);
736 if (lyxerr.debugging()) {
737 lyxerr << "Create pixmap disp:" << fl_display
738 << " scr:" << DefaultScreen(fl_display)
741 << " depth:" << wa.depth << endl;
749 p->bitmap = XCreatePixmap(fl_display, fl_get_canvas_id(
750 figinset_canvas), wid, hgh, wa.depth);
752 // initialize reading of .eps file with correct sizes and stuff
753 addwait(psx, psy, pswid, pshgh, p);
765 void getbitmap(figdata * p)
772 void makeupdatelist(figdata * p)
774 for(figures_type::iterator it = figures.begin();
775 it != figures.end(); ++it)
776 if ((*it)->data == p) {
777 if (lyxerr.debugging()) {
778 lyxerr << "Updating inset "
782 // add inset figures[i]->inset into to_update list
783 current_view->pushIntoUpdateList((*it)->inset);
788 // this func is only "called" in spellchecker.C
789 void sigchldchecker(pid_t pid, int * status)
791 lyxerr.debug() << "Got pid = " << pid << endl;
792 bool pid_handled = false;
793 for (bitmaps_type::iterator it = bitmaps.begin();
794 it != bitmaps.end(); ++it) {
795 if ((*it)->reading && pid == (*it)->gspid) {
796 lyxerr.debug() << "Found pid in bitmaps" << endl;
797 // now read the file and remove it from disk
800 if ((*it)->gsdone) *status = 0;
802 lyxerr.debug() << "GS [" << pid
803 << "] exit OK." << endl;
805 lyxerr << "GS [" << pid << "] error "
807 << WIFEXITED(*status)
808 << " " << WEXITSTATUS(*status)
809 << " S:" << WIFSIGNALED(*status)
810 << " " << WTERMSIG(*status) << endl;
813 bitmap_waiting = true;
816 // remove temporary files
818 sprintf(tmp, "%s/~lyxgs%d.ps",
819 system_tempdir.c_str(),
825 makeupdatelist((*it));
832 lyxerr.debug() << "Checking pid in pidwait" << endl;
833 list<int>::iterator it = find(pidwaitlist.begin(),
834 pidwaitlist.end(), pid);
835 if (it != pidwaitlist.end()) {
836 lyxerr.debug() << "Found pid in pidwait\n"
837 << "Caught child pid of recompute "
838 "routine" << pid << endl;
839 pidwaitlist.erase(it);
843 lyxerr.debug() << "waitpid error" << endl;
846 lyxerr << "The process or process group specified by "
847 "pid does not exist or is not a child of "
848 "the calling process or can never be in the "
849 "states specified by options." << endl;
852 lyxerr << "waitpid() was interrupted due to the "
853 "receipt of a signal sent by the calling "
857 lyxerr << "An invalid value was specified for "
861 lyxerr << "Unknown error from waitpid" << endl;
864 } else if (pid == 0) {
865 lyxerr << "waitpid nohang" << endl;;
867 lyxerr.debug() << "normal exit from childhandler" << endl;
875 bitmap_waiting = false;
876 for (bitmaps_type::iterator it = bitmaps.begin();
877 it != bitmaps.end(); ++it)
878 if ((*it)->gspid > 0 && !(*it)->reading)
884 void RegisterFigure(InsetFig * fi)
886 if (figures.empty()) InitFigures();
888 Figref * tmpfig = new Figref;
891 figures.push_back(tmpfig);
894 if (lyxerr.debugging()) {
895 lyxerr << "Register Figure: buffer:["
896 << current_view->buffer() << "]" << endl;
902 void UnregisterFigure(InsetFig * fi)
904 Figref * tmpfig = fi->figure;
906 if (tmpfig->data) freefigdata(tmpfig->data);
907 if (tmpfig->inset->form) {
908 if (tmpfig->inset->form->Figure->visible) {
909 fl_set_focus_object(tmpfig->inset->form->Figure,
910 tmpfig->inset->form->OkBtn);
911 fl_hide_form(tmpfig->inset->form->Figure);
913 #if FL_REVISION == 89
914 #warning Reactivate this free_form calls
916 fl_free_form(tmpfig->inset->form->Figure);
917 free(tmpfig->inset->form); // Why free?
918 tmpfig->inset->form = 0;
921 figures.erase(find(figures.begin(), figures.end(), tmpfig));
924 if (figures.empty()) DoneFigures();
929 string NextToken(istream & is)
937 } while (!is.eof() && !isspace(c));
938 token.erase(token.length() - 1); // remove the isspace
944 InsetFig::InsetFig(int tmpx, int tmpy, Buffer * o)
954 psubfigure = subfigure = false;
955 xwid = xhgh = angle = 0;
957 raw_wid = raw_hgh = 0;
958 changedfname = false;
959 RegisterFigure(this);
963 InsetFig::~InsetFig()
965 if (lyxerr.debugging()) {
966 lyxerr << "Figure destructor called" << endl;
968 UnregisterFigure(this);
972 int InsetFig::ascent(Painter &, LyXFont const &) const
978 int InsetFig::descent(Painter &, LyXFont const &) const
984 int InsetFig::width(Painter &, LyXFont const &) const
990 void InsetFig::draw(Painter & pain, LyXFont const & f,
991 int baseline, float & x) const
995 if (bitmap_waiting) getbitmaps();
997 // I wish that I didn't have to use this
998 // but the figinset code is so complicated so
999 // I don't want to fiddle with it now.
1001 if (figure && figure->data && figure->data->bitmap &&
1002 !figure->data->reading && !figure->data->broken) {
1004 pain.pixmap(int(x + 1), baseline - hgh,
1005 wid, hgh, figure->data->bitmap);
1008 pain.rectangle(int(x), baseline - hgh - 1,
1014 pain.rectangle(x, baseline - hgh - 1, wid + 1, hgh + 1);
1016 if (figure && figure->data) {
1017 if (figure->data->broken) msg = _("[render error]");
1018 else if (figure->data->reading) msg = _("[rendering ... ]");
1020 if (fname.empty()) msg = _("[no file]");
1021 else if ((flags & 3) == 0) msg = _("[not displayed]");
1022 else if (lyxrc.ps_command.empty()) 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 - font.maxAscent() - 4,
1032 font.setSize(LyXFont::SIZE_TINY);
1033 pain.text(int(x + 8), baseline - 4, msg, strlen(msg), font);
1035 x += width(pain, font); // ?
1039 void InsetFig::Write(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(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(ostream & os, signed char /* fragile*/, bool /* fs*/) const
1145 if (!cmd.empty()) os << cmd << " ";
1150 int InsetFig::Linuxdoc(ostream &) const
1156 int InsetFig::DocBook(ostream & os) const
1158 string figurename = fname;
1160 if(suffixIs(figurename, ".eps"))
1161 figurename.erase(fname.length() - 5);
1163 os << "@<graphic fileref=\"" << figurename << "\"></graphic>";
1168 void InsetFig::Validate(LaTeXFeatures & features) const
1170 features.graphics = true;
1171 if (subfigure) features.subfigure = true;
1175 Inset::EDITABLE InsetFig::Editable() const
1181 bool InsetFig::Deletable() const
1187 void InsetFig::Edit(BufferView * bv, int, int, unsigned int)
1189 lyxerr.debug() << "Editing InsetFig." << endl;
1192 // We should have RO-versions of the form instead.
1193 // The actual prevention of altering a readonly doc
1194 // is done in CallbackFig()
1195 if(bv->buffer()->isReadonly())
1196 WarnReadonly(bv->buffer()->fileName());
1199 form = create_form_Figure();
1200 fl_set_form_atclose(form->Figure, CancelCloseBoxCB, 0);
1201 fl_set_object_return(form->Angle, FL_RETURN_ALWAYS);
1202 fl_set_object_return(form->Width, FL_RETURN_ALWAYS);
1203 fl_set_object_return(form->Height, FL_RETURN_ALWAYS);
1206 if (form->Figure->visible) {
1207 fl_raise_form(form->Figure);
1209 fl_show_form(form->Figure, FL_PLACE_MOUSE | FL_PLACE_SIZE,
1210 FL_FULLBORDER, _("Figure"));
1215 Inset * InsetFig::Clone() const
1217 InsetFig * tmp = new InsetFig(100, 100, owner);
1219 if (lyxerr.debugging()) {
1220 lyxerr << "Clone Figure: buffer:["
1221 << current_view->buffer()
1222 << "], cbuffer:[xx]" << endl;
1227 tmp->raw_wid = raw_wid;
1228 tmp->raw_hgh = raw_hgh;
1233 tmp->pflags = pflags;
1234 tmp->subfigure = subfigure;
1235 tmp->psubfigure = psubfigure;
1243 if (!fname.empty() && (flags & 3) && !lyxrc.ps_command.empty()) {
1244 // do not display if there is
1245 // "do not display" chosen (Matthias 260696)
1246 tmp->figure->data = getfigdata(wid, hgh, fname, psx, psy,
1247 pswid, pshgh, raw_wid, raw_hgh,
1248 angle, flags & (3|8));
1249 } else tmp->figure->data = 0;
1250 tmp->subcaption = subcaption;
1251 tmp->changedfname = false;
1258 Inset::Code InsetFig::LyxCode() const
1260 return Inset::GRAPHICS_CODE;
1264 void InsetFig::Regenerate() const
1267 string resizeW, resizeH;
1268 string rotate, recmd;
1270 if (fname.empty()) {
1271 cmd = "\\fbox{\\rule[-0.5in]{0pt}{1in}";
1272 cmd += _("empty figure path");
1277 string buf1 = OnlyPath(owner->fileName());
1278 string fname2 = MakeRelPath(fname, buf1);
1280 string gcmd = "\\includegraphics{" + fname2 + '}';
1285 case CM:{// \resizebox*{h-length}{v-length}{text}
1287 sprintf(buf, "%g", xwid); // should find better
1294 sprintf(buf, "%g", xwid);
1301 sprintf(buf, "%g", xwid/100);
1303 resizeW += "\\textwidth";
1308 sprintf(buf, "%g", xwid/100);
1310 resizeW += "\\columnwidth";
1320 sprintf(buf, "%g", xhgh);
1327 sprintf(buf, "%g", xhgh);
1334 sprintf(buf, "%g", xhgh/100);
1336 resizeH += "\\textheight";
1340 // Doesn't occur; case exists to suppress compiler warnings.
1345 if (!resizeW.empty() || !resizeH.empty()) {
1346 recmd = "\\resizebox*{";
1347 if (!resizeW.empty())
1352 if (!resizeH.empty())
1362 sprintf(buf, "%g", angle);
1363 // \rotatebox{angle}{text}
1364 rotate = "\\rotatebox{";
1372 if (!rotate.empty()) cmdbuf += '}';
1373 if (!recmd.empty()) cmdbuf += '}';
1375 if (!subcaption.empty())
1376 cmdbuf = "\\subfigure[" + subcaption +
1377 "]{" + cmdbuf + "}";
1379 cmdbuf = "\\subfigure{" + cmdbuf + "}";
1386 void InsetFig::TempRegenerate()
1389 string resizeW, resizeH;
1390 string rotate, recmd;
1392 char const * tfname = fl_get_input(form->EpsFile);
1393 string tsubcap = fl_get_input(form->Subcaption);
1394 float tangle = atof(fl_get_input(form->Angle));
1395 float txwid = atof(fl_get_input(form->Width));
1396 float txhgh = atof(fl_get_input(form->Height));
1398 if (!tfname || !*tfname) {
1399 cmd = "\\fbox{\\rule[-0.5in]{0pt}{1in}";
1400 cmd += _("empty figure path");
1405 string buf1 = OnlyPath(owner->fileName());
1406 string fname2 = MakeRelPath(tfname, buf1);
1407 // \includegraphics*[<llx,lly>][<urx,ury>]{file}
1408 string gcmd = "\\includegraphics{" + fname2 + '}';
1413 case CM: {// \resizebox*{h-length}{v-length}{text}
1415 sprintf(buf, "%g", txwid); // should find better
1422 sprintf(buf, "%g", txwid);
1429 sprintf(buf, "%g", txwid/100);
1431 resizeW += "\\textwidth";
1436 sprintf(buf, "%g", txwid/100);
1438 resizeW += "\\columnwidth";
1448 sprintf(buf, "%g", txhgh);
1455 sprintf(buf, "%g", txhgh);
1462 sprintf(buf, "%g", txhgh/100);
1464 resizeH += "\\textheight";
1468 // Doesn't occur; case exists to suppress compiler warnings.
1473 // \resizebox*{h-length}{v-length}{text}
1474 if (!resizeW.empty() || !resizeH.empty()) {
1475 recmd = "\\resizebox*{";
1476 if (!resizeW.empty())
1481 if (!resizeH.empty())
1490 sprintf(buf, "%g", tangle);
1491 // \rotatebox{angle}{text}
1492 rotate = "\\rotatebox{";
1500 if (!rotate.empty()) cmdbuf += '}';
1501 if (!recmd.empty()) cmdbuf += '}';
1502 if (psubfigure && !tsubcap.empty()) {
1503 cmdbuf = string("\\subfigure{") + tsubcap
1504 + string("}{") + cmdbuf + "}";
1509 void InsetFig::Recompute()
1511 bool changed = changedfname;
1512 int newx, newy, nraw_x, nraw_y;
1514 if (changed) GetPSSizes();
1516 float sin_a = sin (angle / DEG2PI); /* rotation; H. Zeller 021296 */
1517 float cos_a = cos (angle / DEG2PI);
1518 int frame_wid = int(ceil(fabs(cos_a * pswid) + fabs(sin_a * pshgh)));
1519 int frame_hgh= int(ceil(fabs(cos_a * pshgh) + fabs(sin_a * pswid)));
1521 /* now recompute wid and hgh, and if that is changed, set changed */
1522 /* this depends on chosen size of the picture and its bbox */
1523 // This will be redone in 0.13 ... (hen)
1524 if (!fname.empty()) {
1525 // say, total width is 595 pts, as A4 in TeX, thats in 1/72" */
1533 newx = int(28.346 * xwid);
1536 newx = int(72 * xwid);
1538 case PER_PAGE: /* % of page */
1539 newx = int(5.95 * xwid);
1541 case PER_COL: /* % of col */
1542 newx = int(2.975 * xwid);
1546 if (wtype && frame_wid) newy = newx*frame_hgh/frame_wid;
1550 //lyxerr << "This should not happen!" << endl;
1553 newy = int(28.346 * xhgh);
1556 newy = int(72 * xhgh);
1558 case PER_PAGE: /* % of page */
1559 newy = int(8.42 * xhgh);
1562 // Doesn't occur; case exists to suppress
1563 // compiler warnings.
1566 if (htype && !wtype && frame_hgh)
1567 newx = newy*frame_wid/frame_hgh;
1576 nraw_x = int((1.0 * pswid * newx)/frame_wid);
1581 nraw_y = int((1.0 * pshgh * newy)/frame_hgh);
1583 // cannot be zero, actually, set it to some minimum, so its clickable
1584 if (newx < 5) newx = 5;
1585 if (newy < 5) newy = 5;
1587 if (newx != wid || newy != hgh ||
1588 nraw_x != raw_wid || nraw_y != raw_hgh ||
1589 flags != pflags || subfigure != psubfigure)
1597 subfigure = psubfigure;
1600 figdata * pf = figure->data;
1603 if (!fname.empty() && (flags & 3)
1604 && !lyxrc.ps_command.empty()) {
1605 // do not display if there is "do not display"
1606 // chosen (Matthias 260696)
1607 figure->data = getfigdata(wid, hgh, fname,
1608 psx, psy, pswid, pshgh,
1610 angle, flags & (3|8));
1611 } else figure->data = 0;
1613 // free the old data
1614 if (pf) freefigdata(pf);
1617 changedfname = false;
1621 void InsetFig::GetPSSizes()
1623 /* get %%BoundingBox: from postscript file */
1625 /* defaults to associated size
1626 * ..just in case the PS-file is not readable (Henner, 24-Aug-97)
1633 if (fname.empty()) return;
1635 ifstream ifs(fname.c_str());
1637 if (!ifs) return; // file not found !!!!
1639 /* defaults to A4 page */
1645 char lastchar = 0; ifs.get(lastchar);
1647 char c = 0; ifs.get(c);
1649 lyxerr.debug() << "End of (E)PS file reached and"
1650 " no BoundingBox!" << endl;
1653 if (c == '%' && lastchar == '%') {
1655 if (p.empty()) break;
1656 // we should not use this, with it we cannot
1657 // discover bounding box and end of file.
1658 //if (strcmp(p, "EndComments") == 0) break;
1659 lyxerr.debug() << "Token: `" << p << "'" << endl;
1660 if (p == "BoundingBox:") {
1661 float fpsx, fpsy, fpswid, fpshgh;
1662 if (ifs >> fpsx >> fpsy >> fpswid >> fpshgh) {
1665 pswid = int(fpswid);
1666 pshgh = int(fpshgh);
1668 if (lyxerr.debugging()) {
1669 lyxerr << "%%%%BoundingBox:"
1687 void InsetFig::CallbackFig(long arg)
1692 if (lyxerr.debugging()) {
1693 lyxerr << "Figure callback, arg " << arg << endl;
1699 case 12: /* width type */
1706 fl_deactivate_object(form->Width);
1711 fl_activate_object(form->Width);
1716 fl_activate_object(form->Width);
1721 fl_activate_object(form->Width);
1726 fl_activate_object(form->Width);
1729 lyxerr.debug() << "Unknown type!" << endl;
1736 case 22: /* height type */
1742 fl_deactivate_object(form->Height);
1747 fl_activate_object(form->Height);
1752 fl_activate_object(form->Height);
1757 fl_activate_object(form->Height);
1760 lyxerr.debug() << "Unknown type!" << endl;
1766 pflags = pflags & ~3; /* wysiwyg0 */
1769 pflags = (pflags & ~3) | 1; /* wysiwyg1 */
1772 pflags = (pflags & ~3) | 2; /* wysiwyg2 */
1775 pflags = (pflags & ~3) | 3; /* wysiwyg3 */
1778 pflags ^= 4; /* frame */
1781 pflags ^= 8; /* do translations */
1784 psubfigure = !psubfigure; /* This is a subfigure */
1787 regen = true; /* regenerate command */
1789 case 0: /* browse file */
1793 case 1: /* preview */
1794 p = fl_get_input(form->EpsFile);
1798 case 8: /* ok (apply and close) */
1799 if(!current_view->buffer()->isReadonly()) {
1802 xwid = atof(fl_get_input(form->Width));
1803 xhgh = atof(fl_get_input(form->Height));
1804 angle = atof(fl_get_input(form->Angle));
1805 p = fl_get_input(form->EpsFile);
1807 string buf1 = OnlyPath(owner->fileName());
1808 fname = MakeAbsPath(p, buf1);
1809 changedfname = true;
1811 if (!fname.empty()) {
1812 changedfname = true;
1816 subcaption = fl_get_input(form->Subcaption);
1820 /* now update inset */
1821 if (lyxerr.debugging()) {
1822 lyxerr << "Update: ["
1823 << wid << 'x' << hgh << ']' << endl;
1825 current_view->updateInset(this, true);
1827 fl_set_focus_object(form->Figure, form->OkBtn);
1828 fl_hide_form(form->Figure);
1829 #if FL_REVISION == 89
1830 #warning Reactivate this free_form calls
1832 fl_free_form(form->Figure);
1833 free(form); // Why free?
1839 // The user has already been informed about RO in ::Edit
1840 if(arg == 7) // if 'Apply'
1843 case 9: /* cancel = restore and close */
1844 fl_set_focus_object(form->Figure, form->OkBtn);
1845 fl_hide_form(form->Figure);
1846 #if FL_REVISION == 89
1847 #warning Reactivate this free_form calls
1848 #warning Jug, is this still a problem?
1850 fl_free_form(form->Figure);
1851 free(form); // Why free?
1857 if (regen) TempRegenerate();
1862 void DisableFigurePanel(FD_Figure * const form)
1864 fl_deactivate_object(form->EpsFile);
1865 fl_deactivate_object(form->Browse);
1866 fl_deactivate_object(form->Width);
1867 fl_deactivate_object(form->Height);
1868 fl_deactivate_object(form->Frame);
1869 fl_deactivate_object(form->Translations);
1870 fl_deactivate_object(form->Angle);
1871 fl_deactivate_object(form->HeightGrp);
1872 fl_deactivate_object(form->page2);
1873 fl_deactivate_object(form->Default2);
1874 fl_deactivate_object(form->cm2);
1875 fl_deactivate_object(form->in2);
1876 fl_deactivate_object(form->HeightLabel);
1877 fl_deactivate_object(form->WidthLabel);
1878 fl_deactivate_object(form->DisplayGrp);
1879 fl_deactivate_object(form->Wysiwyg3);
1880 fl_deactivate_object(form->Wysiwyg0);
1881 fl_deactivate_object(form->Wysiwyg2);
1882 fl_deactivate_object(form->Wysiwyg1);
1883 fl_deactivate_object(form->WidthGrp);
1884 fl_deactivate_object(form->Default1);
1885 fl_deactivate_object(form->cm1);
1886 fl_deactivate_object(form->in1);
1887 fl_deactivate_object(form->page1);
1888 fl_deactivate_object(form->column1);
1889 fl_deactivate_object(form->Subcaption);
1890 fl_deactivate_object(form->Subfigure);
1891 fl_deactivate_object (form->OkBtn);
1892 fl_deactivate_object (form->ApplyBtn);
1893 fl_set_object_lcol (form->OkBtn, FL_INACTIVE);
1894 fl_set_object_lcol (form->ApplyBtn, FL_INACTIVE);
1899 void EnableFigurePanel(FD_Figure * const form)
1901 fl_activate_object(form->EpsFile);
1902 fl_activate_object(form->Browse);
1903 fl_activate_object(form->Width);
1904 fl_activate_object(form->Height);
1905 fl_activate_object(form->Frame);
1906 fl_activate_object(form->Translations);
1907 fl_activate_object(form->Angle);
1908 fl_activate_object(form->HeightGrp);
1909 fl_activate_object(form->page2);
1910 fl_activate_object(form->Default2);
1911 fl_activate_object(form->cm2);
1912 fl_activate_object(form->in2);
1913 fl_activate_object(form->HeightLabel);
1914 fl_activate_object(form->WidthLabel);
1915 fl_activate_object(form->DisplayGrp);
1916 fl_activate_object(form->Wysiwyg3);
1917 fl_activate_object(form->Wysiwyg0);
1918 fl_activate_object(form->Wysiwyg2);
1919 fl_activate_object(form->Wysiwyg1);
1920 fl_activate_object(form->WidthGrp);
1921 fl_activate_object(form->Default1);
1922 fl_activate_object(form->cm1);
1923 fl_activate_object(form->in1);
1924 fl_activate_object(form->page1);
1925 fl_activate_object(form->column1);
1926 fl_activate_object(form->Subcaption);
1927 fl_activate_object(form->Subfigure);
1928 fl_activate_object (form->OkBtn);
1929 fl_activate_object (form->ApplyBtn);
1930 fl_set_object_lcol (form->OkBtn, FL_BLACK);
1931 fl_set_object_lcol (form->ApplyBtn, FL_BLACK);
1935 void InsetFig::RestoreForm()
1939 EnableFigurePanel(form);
1942 fl_set_button(form->Default1, (wtype == 0));
1943 fl_set_button(form->cm1, (wtype == 1));
1944 fl_set_button(form->in1, (wtype == 2));
1945 fl_set_button(form->page1, (wtype == 3));
1946 fl_set_button(form->column1, (wtype == 4));
1948 fl_deactivate_object(form->Width);
1950 fl_activate_object(form->Width);
1953 // enable and disable should be put here.
1955 fl_set_button(form->Default2, (htype == 0));
1956 fl_set_button(form->cm2, (htype == 1));
1957 fl_set_button(form->in2, (htype == 2));
1958 fl_set_button(form->page2, (htype == 3));
1959 // enable and disable should be put here.
1961 fl_deactivate_object(form->Height);
1963 fl_activate_object(form->Height);
1966 int pflags = flags & 3;
1967 fl_set_button(form->Wysiwyg0, (pflags == 0));
1968 fl_set_button(form->Wysiwyg1, (pflags == 1));
1969 fl_set_button(form->Wysiwyg2, (pflags == 2));
1970 fl_set_button(form->Wysiwyg3, (pflags == 3));
1971 fl_set_button(form->Frame, ((flags & 4) != 0));
1972 fl_set_button(form->Translations, ((flags & 8) != 0));
1973 fl_set_button(form->Subfigure, (subfigure != 0));
1975 psubfigure = subfigure;
1976 sprintf(buf, "%g", xwid);
1977 fl_set_input(form->Width, buf);
1978 sprintf(buf, "%g", xhgh);
1979 fl_set_input(form->Height, buf);
1980 sprintf(buf, "%g", angle);
1981 fl_set_input(form->Angle, buf);
1982 if (!fname.empty()){
1983 string buf1 = OnlyPath(owner->fileName());
1984 string fname2 = MakeRelPath(fname, buf1);
1985 fl_set_input(form->EpsFile, fname2.c_str());
1987 else fl_set_input(form->EpsFile, "");
1988 fl_set_input(form->Subcaption, subcaption.c_str());
1989 if(current_view->buffer()->isReadonly())
1990 DisableFigurePanel(form);
1996 void InsetFig::Preview(char const * p)
2001 lyxerr << "Cannot fork process!" << endl;
2006 return; // parent process
2009 string buf1 = OnlyPath(owner->fileName());
2010 string buf2 = MakeAbsPath(p, buf1);
2012 lyxerr << "Error during rendering "
2013 << execlp(lyxrc.view_pspic_command.c_str(),
2014 lyxrc.view_pspic_command.c_str(),
2021 void InsetFig::BrowseFile()
2023 static string current_figure_path;
2024 static int once = 0;
2027 if (lyxerr.debugging()) {
2028 lyxerr << "Filename: "
2029 << owner->fileName() << endl;
2031 string p = fl_get_input(form->EpsFile);
2033 string buf = MakeAbsPath(owner->fileName());
2034 string buf2 = OnlyPath(buf);
2036 buf = MakeAbsPath(p, buf2);
2037 buf = OnlyPath(buf);
2039 buf = OnlyPath(owner->fileName().c_str());
2042 // Does user clipart directory exist?
2043 string bufclip = AddName (user_lyxdir, "clipart");
2044 FileInfo fileInfo(bufclip);
2045 if (!(fileInfo.isOK() && fileInfo.isDir()))
2046 // No - bail out to system clipart directory
2047 bufclip = AddName (system_lyxdir, "clipart");
2050 fileDlg.SetButton(0, _("Clipart"), bufclip);
2051 fileDlg.SetButton(1, _("Document"), buf);
2057 p = fileDlg.Select(_("EPS Figure"),
2058 current_figure_path,
2061 p = fileDlg.Select(_("EPS Figure"), buf,
2066 if (p.empty()) return;
2068 buf = MakeRelPath(p, buf2);
2069 current_figure_path = OnlyPath(p);
2072 if (contains(p, "#") || contains(p, "~") || contains(p, "$")
2073 || contains(p, "%") || contains(p, " "))
2075 WriteAlert(_("Filename can't contain any "
2076 "of these characters:"),
2077 // xgettext:no-c-format
2078 _("space, '#', '~', '$' or '%'."));
2083 if (form) fl_set_input(form->EpsFile, buf.c_str());
2087 void GraphicsCB(FL_OBJECT * obj, long arg)
2089 /* obj->form contains the form */
2091 if (lyxerr.debugging()) {
2092 lyxerr << "GraphicsCB callback: " << arg << endl;
2095 /* find inset we were reacting to */
2096 for (figures_type::iterator it = figures.begin();
2097 it != figures.end(); ++it)
2098 if ((*it)->inset->form && (*it)->inset->form->Figure
2100 if (lyxerr.debugging()) {
2101 lyxerr << "Calling back figure "
2104 (*it)->inset->CallbackFig(arg);
2110 void HideFiguresPopups()
2112 for (figures_type::iterator it = figures.begin();
2113 it != figures.end(); ++it)
2114 if ((*it)->inset->form
2115 && (*it)->inset->form->Figure->visible) {
2116 if (lyxerr.debugging()) {
2117 lyxerr << "Hiding figure " << (*it) << endl;
2119 // hide and free the form
2120 (*it)->inset->CallbackFig(9);