9 #include FORMS_H_LOCATION
11 #include "insetinclude.h"
13 #include "bufferlist.h"
15 #include "support/filetools.h"
18 #include "LaTeXFeatures.h"
19 #include "lyx_gui_misc.h" // CancelCloseBoxCB
21 #include "include_form.h"
22 #include "support/FileInfo.h"
24 extern BufferView *current_view;
27 extern BufferList bufferlist;
28 extern void UpdateInset(Inset* inset, bool mark_dirty = true);
31 FD_include *create_form_include(void)
34 FD_include *fdui = (FD_include *) fl_calloc(1, sizeof(FD_include));
36 fdui->include = fl_bgn_form(FL_NO_BOX, 340, 210);
37 obj = fl_add_box(FL_UP_BOX,0,0,340,210,"");
38 obj = fl_add_frame(FL_ENGRAVED_FRAME,10,70,160,90,"");
39 fdui->browsebt = obj = fl_add_button(FL_NORMAL_BUTTON,230,30,100,30,idex(_("Browse|#B")));
40 fl_set_button_shortcut(obj,scex(_("Browse|#B")),1);
41 fl_set_object_lsize(obj,FL_NORMAL_SIZE);
42 fl_set_object_callback(obj,include_cb,0);
43 fdui->flag1 = obj = fl_add_checkbutton(FL_PUSH_BUTTON,180,70,150,30,idex(_("Don't typeset|#D")));
44 fl_set_button_shortcut(obj,scex(_("Don't typeset|#D")),1);
45 fl_set_object_lsize(obj,FL_NORMAL_SIZE);
46 obj = fl_add_button(FL_RETURN_BUTTON,120,170,100,30,_("OK"));
47 fl_set_object_lsize(obj,FL_NORMAL_SIZE);
48 fl_set_object_callback(obj,include_cb,1);
49 obj = fl_add_button(FL_NORMAL_BUTTON,230,170,100,30,idex(_("Cancel|^[")));
50 fl_set_button_shortcut(obj,scex(_("Cancel|^[")),1);
51 fl_set_object_lsize(obj,FL_NORMAL_SIZE);
52 fl_set_object_callback(obj,include_cb,2);
53 obj = fl_add_button(FL_NORMAL_BUTTON,230,130,100,30,idex(_("Load|#L")));
54 fl_set_button_shortcut(obj,scex(_("Load|#L")),1);
55 fl_set_object_lsize(obj,FL_NORMAL_SIZE);
56 fl_set_object_callback(obj,include_cb,5);
57 fdui->input = obj = fl_add_input(FL_NORMAL_INPUT,10,30,210,30,idex(_("File name:|#F")));
58 fl_set_input_shortcut(obj,scex(_("File name:|#F")),1);
59 fl_set_object_lsize(obj,FL_NORMAL_SIZE);
60 fl_set_object_lalign(obj,FL_ALIGN_TOP_LEFT);
61 fdui->flag41 = obj = fl_add_checkbutton(FL_PUSH_BUTTON,180,100,150,30,idex(_("Visible space|#s")));
62 fl_set_button_shortcut(obj,scex(_("Visible space|#s")),1);
63 fl_set_object_lsize(obj,FL_NORMAL_SIZE);
65 fdui->include_grp = fl_bgn_group();
66 fdui->flag4 = obj = fl_add_checkbutton(FL_RADIO_BUTTON,10,130,160,30,idex(_("Verbatim|#V")));
67 fl_set_button_shortcut(obj,scex(_("Verbatim|#V")),1);
68 fl_set_object_lsize(obj,FL_NORMAL_SIZE);
69 fl_set_object_callback(obj,include_cb,10);
70 fdui->flag2 = obj = fl_add_checkbutton(FL_RADIO_BUTTON,10,100,160,30,idex(_("Use input|#i")));
71 fl_set_button_shortcut(obj,scex(_("Use input|#i")),1);
72 fl_set_object_lsize(obj,FL_NORMAL_SIZE);
73 fl_set_object_callback(obj,include_cb,11);
74 fdui->flag3 = obj = fl_add_checkbutton(FL_RADIO_BUTTON,10,70,160,30,idex(_("Use include|#U")));
75 fl_set_button_shortcut(obj,scex(_("Use include|#U")),1);
76 fl_set_object_lsize(obj,FL_NORMAL_SIZE);
77 fl_set_object_callback(obj,include_cb,11);
82 //fdui->include->fdui = fdui;
86 /*---------------------------------------*/
91 void include_cb(FL_OBJECT *, long arg)
94 InsetInclude *inset = (InsetInclude*)form->vdata;
98 // Should browsing too be disabled in RO-mode?
100 string mpath = OnlyPath(inset->getMasterFilename());
103 if (fl_get_button(form->flag2)) // Use Input Button
105 else if (fl_get_button(form->flag4)) // Verbatim all files
110 fileDlg.SetButton(0, _("Documents"), lyxrc->document_path);
112 // Use by default the master's path
113 string filename = fileDlg.Select(_("Select Child Document"),
115 inset->getContents());
116 XFlush(fl_get_display());
118 // check selected filename
119 if (!filename.empty()) {
120 string filename2 = MakeRelPath(filename,
122 if (prefixIs(filename2, ".."))
123 fl_set_input(form->input,
126 fl_set_input(form->input,
133 if(!current_view->currentBuffer()->isReadonly()) {
134 inset->setContents(fl_get_input(form->input));
136 inset->setNoLoad(fl_get_button(form->flag1));
137 if (fl_get_button(form->flag2))
139 else if (fl_get_button(form->flag3))
141 else if (fl_get_button(form->flag4)) {
143 inset->setVisibleSpace(fl_get_button(form->flag41));
146 fl_hide_form(form->include);
152 fl_hide_form(form->include);
155 if(!current_view->currentBuffer()->isReadonly()) {
156 inset->setContents(fl_get_input(form->input));
157 inset->setNoLoad(fl_get_button(form->flag1));
158 if (fl_get_button(form->flag2))
160 else if (fl_get_button(form->flag3))
162 else if (fl_get_button(form->flag4)) {
164 inset->setVisibleSpace(fl_get_button(form->flag41));
167 fl_hide_form(form->include);
169 current_view->getOwner()->getLyXFunc()->Dispatch(LFUN_CHILDOPEN, inset->getContents().c_str());
174 fl_activate_object(form->flag41);
175 fl_set_object_lcol(form->flag41, FL_BLACK);
178 fl_deactivate_object(form->flag41);
179 fl_set_object_lcol(form->flag41, FL_INACTIVE);
180 fl_set_button(form->flag41, 0);
186 InsetInclude::InsetInclude(string const & fname, Buffer *bf)
187 : InsetCommand("include")
191 flag = InsetInclude::INCLUDE;
196 InsetInclude::~InsetInclude()
198 if (form && form->vdata == this) {
199 // this inset is in the popup so hide the popup
200 // and remove the reference to this inset. ARRae
202 if (form->include->visible) {
203 fl_hide_form(form->include);
205 fl_free_form(form->include);
212 Inset * InsetInclude::Clone()
214 InsetInclude * ii = new InsetInclude (contents, master);
215 ii->setNoLoad(isNoLoad());
216 // By default, the newly created inset is of `include' type,
217 // so we do not test this case.
222 ii->setVisibleSpace(isVerbVisibleSpace());
227 void InsetInclude::Edit(int, int)
229 if(current_view->currentBuffer()->isReadonly())
233 form = create_form_include();
234 fl_set_form_atclose(form->include, IgnoreCloseBoxCB, 0);
238 fl_set_input(form->input, contents.c_str());
239 fl_set_button(form->flag1, int(isNoLoad()));
240 fl_set_button(form->flag2, int(isInput()));
241 fl_set_button(form->flag3, int(isInclude()));
242 fl_set_button(form->flag4, int(isVerb()));
244 fl_set_button(form->flag41, int(isVerbVisibleSpace()));
246 fl_set_button(form->flag41, 0);
247 fl_deactivate_object(form->flag41);
248 fl_set_object_lcol(form->flag41, FL_INACTIVE);
251 if (form->include->visible) {
252 fl_raise_form(form->include);
254 fl_show_form(form->include,FL_PLACE_MOUSE, FL_FULLBORDER,
260 void InsetInclude::Write(FILE *file)
262 fprintf(file, "Include %s\n", getCommand().c_str());
266 void InsetInclude::Read(LyXLex &lex)
268 InsetCommand::Read(lex);
270 if (getCmdName()=="include")
272 else if (getCmdName() == "input")
274 else if (contains(getCmdName(), "verbatim")) {
276 if (getCmdName() == "verbatiminput*")
277 setVisibleSpace(true);
282 string InsetInclude::getScreenLabel() const
288 temp += _("Verbatim Input");
289 if (isVerbVisibleSpace()) temp += '*';
290 } else temp += _("Include");
293 if (contents.empty()) {
302 bool InsetInclude::loadIfNeeded() const
304 if (isNoLoad() || isVerb()) return false;
305 if (!IsLyXFilename(getFileName())) return false;
307 if (bufferlist.exists(getFileName())) return true;
309 // the readonly flag can/will be wrong, not anymore I think.
310 FileInfo finfo(getFileName());
311 bool ro = !finfo.writable();
312 return ( bufferlist.readFile(getFileName(), ro) != 0 );
316 int InsetInclude::Latex(FILE *file, signed char /*fragile*/)
319 signed char dummy = 0;
320 Latex(include_file, dummy);
321 fprintf(file, "%s", include_file.c_str());
326 int InsetInclude::Latex(string &file, signed char /*fragile*/)
328 string writefile, incfile;
330 // Do nothing if no file name has been specified
331 if (contents.empty())
334 // Use += to force a copy of contents (JMarc)
337 if (loadIfNeeded()) {
338 Buffer *tmp = bufferlist.getBuffer(getFileName());
340 if (tmp->params.textclass != master->params.textclass) {
341 lyxerr << "ERROR: Cannot handle include file `"
342 << MakeDisplayPath(getFileName())
343 << "' which has textclass `"
344 << lyxstyle.NameOfClass(tmp->params.textclass)
346 << lyxstyle.NameOfClass(master->params.textclass)
351 // write it to a file (so far the complete file)
352 writefile = ChangeExtension(getFileName(), ".tex", false);
353 if (!master->tmppath.empty()
354 && !master->niceFile) {
355 subst(incfile, '/','@');
357 subst(incfile, ':', '$');
359 writefile = AddName(master->tmppath, incfile);
361 writefile = getFileName();
362 writefile = ChangeExtension(writefile,".tex",false);
363 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
364 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
366 tmp->markDepClean(master->tmppath);
368 tmp->makeLaTeXFile(writefile,
369 OnlyPath(getMasterFilename()),
370 master->niceFile, true);
375 file += command + '{';
376 file += incfile + '}';
378 else if (isInput()) {
379 // \input wants file with extension (default is .tex)
380 if (!IsLyXFilename(getFileName())) {
382 file += command + '{';
383 file += incfile + '}';
386 file += command + '{';
387 file += ChangeExtension(incfile, ".tex", false)
391 // \include don't want extension and demands that the
392 // file really have .tex
394 file += command + '{';
395 file += ChangeExtension(incfile, string(), false)
403 void InsetInclude::Validate(LaTeXFeatures& features) const
406 features.verbatim = true;
408 // Here we must do the fun stuff...
409 // Load the file in the include if it needs
411 if (loadIfNeeded()) {
413 Buffer *tmp = bufferlist.getBuffer(getFileName());
414 tmp->validate(features);
419 string InsetInclude::getLabel(int) const
425 if (loadIfNeeded()) {
426 Buffer *tmp = bufferlist.getBuffer(getFileName());
427 tmp->setParentName("");
428 label = tmp->getReferenceList('\n');
429 tmp->setParentName(getMasterFilename());
436 int InsetInclude::GetNumberOfLabels() const {
440 if (loadIfNeeded()) {
441 Buffer *tmp = bufferlist.getBuffer(getFileName());
442 tmp->setParentName("");
443 label = tmp->getReferenceList('\n');
444 tmp->setParentName(getMasterFilename());
446 nl = (label.empty())? 0: 1;
452 string InsetInclude::getKeys() const
456 if (loadIfNeeded()) {
457 Buffer *tmp = bufferlist.getBuffer(getFileName());
458 tmp->setParentName("");
459 list = tmp->getBibkeyList(',');
460 tmp->setParentName(getMasterFilename());