3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
16 #include "support/package.h"
17 #include "support/filetools.h"
19 #include <boost/filesystem/operations.hpp>
26 using lyx::support::absolutePath;
27 using lyx::support::addName;
28 using lyx::support::FileName;
29 using lyx::support::package;
31 namespace fs = boost::filesystem;
41 using std::istringstream;
44 using std::ostream_iterator;
48 string const sec_lastfiles = "[recent files]";
49 string const sec_lastfilepos = "[cursor positions]";
50 string const sec_lastopened = "[last opened files]";
51 string const sec_bookmarks = "[bookmarks]";
52 string const sec_session = "[session info]";
53 string const sec_toolbars = "[toolbars]";
60 LastFilesSection::LastFilesSection(unsigned int num) :
61 default_num_last_files(4),
62 absolute_max_last_files(100)
64 setNumberOfLastFiles(num);
68 void LastFilesSection::read(istream & is)
76 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ' || !absolutePath(tmp))
80 FileName const file(tmp);
81 if (fs::exists(file.toFilesystemEncoding()) &&
82 !fs::is_directory(file.toFilesystemEncoding()) &&
83 lastfiles.size() < num_lastfiles)
84 lastfiles.push_back(file);
86 lyxerr[Debug::INIT] << "LyX: Warning: Ignore last file: " << tmp << endl;
91 void LastFilesSection::write(ostream & os) const
93 os << '\n' << sec_lastfiles << '\n';
94 copy(lastfiles.begin(), lastfiles.end(),
95 ostream_iterator<FileName>(os, "\n"));
99 void LastFilesSection::add(FileName const & file)
101 // If file already exist, delete it and reinsert at front.
102 LastFiles::iterator it = find(lastfiles.begin(), lastfiles.end(), file);
103 if (it != lastfiles.end())
105 lastfiles.push_front(file);
106 if (lastfiles.size() > num_lastfiles)
107 lastfiles.pop_back();
111 void LastFilesSection::setNumberOfLastFiles(unsigned int no)
113 if (0 < no && no <= absolute_max_last_files)
116 lyxerr[Debug::INIT] << "LyX: session: too many last files\n"
117 << "\tdefault (=" << default_num_last_files
118 << ") used." << endl;
119 num_lastfiles = default_num_last_files;
124 void LastOpenedSection::read(istream & is)
132 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ' || !absolutePath(tmp))
135 FileName const file(tmp);
136 if (fs::exists(file.toFilesystemEncoding()) &&
137 !fs::is_directory(file.toFilesystemEncoding()))
138 lastopened.push_back(file);
140 lyxerr[Debug::INIT] << "LyX: Warning: Ignore last opened file: " << tmp << endl;
145 void LastOpenedSection::write(ostream & os) const
147 os << '\n' << sec_lastopened << '\n';
148 copy(lastopened.begin(), lastopened.end(),
149 ostream_iterator<FileName>(os, "\n"));
153 void LastOpenedSection::add(FileName const & file)
155 lastopened.push_back(file);
159 void LastOpenedSection::clear()
165 void LastFilePosSection::read(istream & is)
173 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
182 istringstream itmp(tmp);
184 itmp.ignore(2); // ignore ", "
186 itmp.ignore(2); // ignore ", "
187 getline(itmp, fname);
188 if (!absolutePath(fname))
190 FileName const file(fname);
191 if (fs::exists(file.toFilesystemEncoding()) &&
192 !fs::is_directory(file.toFilesystemEncoding()) &&
193 lastfilepos.size() < num_lastfilepos)
194 lastfilepos[file] = boost::tie(pit, pos);
196 lyxerr[Debug::INIT] << "LyX: Warning: Ignore pos of last file: " << fname << endl;
198 lyxerr[Debug::INIT] << "LyX: Warning: unknown pos of last file: " << tmp << endl;
204 void LastFilePosSection::write(ostream & os) const
206 os << '\n' << sec_lastfilepos << '\n';
207 for (FilePosMap::const_iterator file = lastfilepos.begin();
208 file != lastfilepos.end(); ++file) {
209 os << file->second.get<0>() << ", "
210 << file->second.get<1>() << ", "
211 << file->first << '\n';
216 void LastFilePosSection::save(FileName const & fname, FilePos pos)
218 lastfilepos[fname] = pos;
222 LastFilePosSection::FilePos LastFilePosSection::load(FileName const & fname) const
224 FilePosMap::const_iterator entry = lastfilepos.find(fname);
225 // Has position information, return it.
226 if (entry != lastfilepos.end())
227 return entry->second;
228 // Not found, return the first paragraph
234 void BookmarksSection::read(istream & is)
242 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
251 istringstream itmp(tmp);
253 itmp.ignore(2); // ignore ", "
255 itmp.ignore(2); // ignore ", "
256 getline(itmp, fname);
257 if (!absolutePath(fname))
259 FileName const file(fname);
260 // only load valid bookmarks
261 if (fs::exists(file.toFilesystemEncoding()) &&
262 !fs::is_directory(file.toFilesystemEncoding()) &&
263 bookmarks.size() < max_bookmarks)
264 bookmarks.push_back(Bookmark(file, pit, 0, pos));
266 lyxerr[Debug::INIT] << "LyX: Warning: Ignore bookmark of file: " << fname << endl;
268 lyxerr[Debug::INIT] << "LyX: Warning: unknown Bookmark info: " << tmp << endl;
274 void BookmarksSection::write(ostream & os) const
276 os << '\n' << sec_bookmarks << '\n';
277 for (size_t i = 0; i < bookmarks.size(); ++i) {
278 os << bookmarks[i].par_pit << ", "
279 << bookmarks[i].par_pos << ", "
280 << bookmarks[i].filename << '\n';
285 void BookmarksSection::save(FileName const & fname, pit_type par_pit, int par_id, pos_type par_pos, bool persistent)
288 bookmarks.push_back(Bookmark(fname, par_pit, par_id, par_pos));
289 if (bookmarks.size() > max_bookmarks)
290 bookmarks.pop_back();
293 temp_bookmark = Bookmark(fname, par_pit, par_id, par_pos);
297 bool BookmarksSection::isValid(unsigned int i) const
300 return !temp_bookmark.filename.empty();
302 return i <= bookmarks.size() && !bookmarks[i-1].filename.empty();
306 BookmarksSection::Bookmark const & BookmarksSection::bookmark(unsigned int i) const
309 return temp_bookmark;
311 return bookmarks[i-1];
315 void ToolbarSection::read(istream & is)
323 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
327 // Read session info, saved as key/value pairs
328 // would better yell if pos returns npos
329 string::size_type pos = tmp.find_first_of(" = ");
330 // silently ignore lines without " = "
331 if (pos != string::npos) {
332 string key = tmp.substr(0, pos);
337 istringstream value(tmp.substr(pos + 3));
342 toolbars.push_back(boost::make_tuple(key, ToolbarInfo(state, location, posx, posy)));
344 lyxerr[Debug::INIT] << "LyX: Warning: Ignore toolbar info: " << tmp << endl;
346 lyxerr[Debug::INIT] << "LyX: Warning: unknown Toolbar info: " << tmp << endl;
349 // sort the toolbars by location, line and position
350 std::sort(toolbars.begin(), toolbars.end());
354 void ToolbarSection::write(ostream & os) const
356 os << '\n' << sec_toolbars << '\n';
357 for (ToolbarList::const_iterator tb = toolbars.begin();
358 tb != toolbars.end(); ++tb) {
359 os << tb->get<0>() << " = "
360 << static_cast<int>(tb->get<1>().state) << " "
361 << static_cast<int>(tb->get<1>().location) << " "
362 << tb->get<1>().posx << " "
363 << tb->get<1>().posy << '\n';
368 ToolbarSection::ToolbarInfo & ToolbarSection::load(string const & name)
370 for (ToolbarList::iterator tb = toolbars.begin();
371 tb != toolbars.end(); ++tb)
372 if (tb->get<0>() == name)
375 toolbars.push_back(boost::make_tuple(name, ToolbarSection::ToolbarInfo()));
376 return toolbars.back().get<1>();
380 bool operator<(ToolbarSection::ToolbarItem const & a, ToolbarSection::ToolbarItem const & b)
382 ToolbarSection::ToolbarInfo lhs = a.get<1>();
383 ToolbarSection::ToolbarInfo rhs = b.get<1>();
385 if (lhs.state != rhs.state)
386 return static_cast<int>(lhs.state) < static_cast<int>(rhs.state);
387 // order of dock does not really matter
388 if (lhs.location != rhs.location)
389 return static_cast<int>(lhs.location) < static_cast<int>(rhs.location);
390 // if the same dock, the order depends on position
391 if (lhs.location == ToolbarSection::ToolbarInfo::TOP ||
392 lhs.location == ToolbarSection::ToolbarInfo::BOTTOM)
393 return lhs.posy < rhs.posy || (lhs.posy == rhs.posy && lhs.posx < rhs.posx);
394 else if (lhs.location == ToolbarSection::ToolbarInfo::LEFT ||
395 lhs.location == ToolbarSection::ToolbarInfo::RIGHT)
396 return lhs.posx < rhs.posx || (lhs.posx == rhs.posx && lhs.posy < rhs.posy);
402 void SessionInfoSection::read(istream & is)
410 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
414 // Read session info, saved as key/value pairs
415 // would better yell if pos returns npos
416 string::size_type pos = tmp.find_first_of(" = ");
417 // silently ignore lines without " = "
418 if (pos != string::npos) {
419 string key = tmp.substr(0, pos);
420 string value = tmp.substr(pos + 3);
421 sessioninfo[key] = value;
423 lyxerr[Debug::INIT] << "LyX: Warning: Ignore session info: " << tmp << endl;
425 lyxerr[Debug::INIT] << "LyX: Warning: unknown Session info: " << tmp << endl;
431 void SessionInfoSection::write(ostream & os) const
433 os << '\n' << sec_session << '\n';
434 for (MiscInfo::const_iterator val = sessioninfo.begin();
435 val != sessioninfo.end(); ++val) {
436 os << val->first << " = " << val->second << '\n';
441 void SessionInfoSection::save(string const & key, string const & value)
443 sessioninfo[key] = value;
447 string const SessionInfoSection::load(string const & key, bool release)
449 MiscInfo::const_iterator pos = sessioninfo.find(key);
451 if (pos != sessioninfo.end())
454 sessioninfo.erase(key);
459 Session::Session(unsigned int num) :
462 // locate the session file
463 // note that the session file name 'session' is hard-coded
464 session_file = FileName(addName(package().user_support(), "session"));
470 void Session::readFile()
472 // we will not complain if we can't find session_file nor will
473 // we issue a warning. (Lgb)
474 ifstream is(session_file.toFilesystemEncoding().c_str());
477 while (getline(is, tmp)) {
478 // Ignore comments, empty line or line stats with ' '
479 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
482 // Determine section id
483 if (tmp == sec_lastfiles)
484 lastFiles().read(is);
485 else if (tmp == sec_lastopened)
486 lastOpened().read(is);
487 else if (tmp == sec_lastfilepos)
488 lastFilePos().read(is);
489 else if (tmp == sec_bookmarks)
490 bookmarks().read(is);
491 else if (tmp == sec_toolbars)
493 else if (tmp == sec_session)
494 sessionInfo().read(is);
496 lyxerr[Debug::INIT] << "LyX: Warning: unknown Session section: " << tmp << endl;
501 void Session::writeFile() const
503 ofstream os(session_file.toFilesystemEncoding().c_str());
505 os << "## Automatically generated lyx session file \n"
506 << "## Editing this file manually may cause lyx to crash.\n";
508 lastFiles().write(os);
509 lastOpened().write(os);
510 lastFilePos().write(os);
511 bookmarks().write(os);
512 toolbars().write(os);
513 sessionInfo().write(os);
515 lyxerr[Debug::INIT] << "LyX: Warning: unable to save Session: "
516 << session_file << endl;