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::clear()
236 // keep bookmark[0], the temporary one
238 bookmarks.resize(max_bookmarks + 1);
242 void BookmarksSection::read(istream & is)
250 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
255 // idx, pit, pos, file\n
260 istringstream itmp(tmp);
262 itmp.ignore(2); // ignore ", "
264 itmp.ignore(2); // ignore ", "
266 itmp.ignore(2); // ignore ", "
267 getline(itmp, fname);
268 if (!absolutePath(fname))
270 FileName const file(fname);
271 // only load valid bookmarks
272 if (fs::exists(file.toFilesystemEncoding()) &&
273 !fs::is_directory(file.toFilesystemEncoding()) &&
274 idx <= max_bookmarks)
275 bookmarks[idx] = Bookmark(file, pit, 0, pos);
277 lyxerr[Debug::INIT] << "LyX: Warning: Ignore bookmark of file: " << fname << endl;
279 lyxerr[Debug::INIT] << "LyX: Warning: unknown Bookmark info: " << tmp << endl;
285 void BookmarksSection::write(ostream & os) const
287 os << '\n' << sec_bookmarks << '\n';
288 for (size_t i = 1; i <= max_bookmarks; ++i) {
291 << bookmarks[i].par_pit << ", "
292 << bookmarks[i].par_pos << ", "
293 << bookmarks[i].filename << '\n';
298 void BookmarksSection::save(FileName const & fname, pit_type par_pit, int par_id, pos_type par_pos, unsigned int idx)
300 // silently ignore bookmarks when idx is out of range
301 if (idx <= max_bookmarks)
302 bookmarks[idx] = Bookmark(fname, par_pit, par_id, par_pos);
306 bool BookmarksSection::isValid(unsigned int i) const
308 return i <= max_bookmarks && !bookmarks[i].filename.empty();
312 BookmarksSection::Bookmark const & BookmarksSection::bookmark(unsigned int i) const
318 void ToolbarSection::read(istream & is)
326 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
330 // Read session info, saved as key/value pairs
331 // would better yell if pos returns npos
332 string::size_type pos = tmp.find_first_of(" = ");
333 // silently ignore lines without " = "
334 if (pos != string::npos) {
335 string key = tmp.substr(0, pos);
340 istringstream value(tmp.substr(pos + 3));
345 toolbars.push_back(boost::make_tuple(key, ToolbarInfo(state, location, posx, posy)));
347 lyxerr[Debug::INIT] << "LyX: Warning: Ignore toolbar info: " << tmp << endl;
349 lyxerr[Debug::INIT] << "LyX: Warning: unknown Toolbar info: " << tmp << endl;
352 // sort the toolbars by location, line and position
353 std::sort(toolbars.begin(), toolbars.end());
357 void ToolbarSection::write(ostream & os) const
359 os << '\n' << sec_toolbars << '\n';
360 for (ToolbarList::const_iterator tb = toolbars.begin();
361 tb != toolbars.end(); ++tb) {
362 os << tb->get<0>() << " = "
363 << static_cast<int>(tb->get<1>().state) << " "
364 << static_cast<int>(tb->get<1>().location) << " "
365 << tb->get<1>().posx << " "
366 << tb->get<1>().posy << '\n';
371 ToolbarSection::ToolbarInfo & ToolbarSection::load(string const & name)
373 for (ToolbarList::iterator tb = toolbars.begin();
374 tb != toolbars.end(); ++tb)
375 if (tb->get<0>() == name)
378 toolbars.push_back(boost::make_tuple(name, ToolbarSection::ToolbarInfo()));
379 return toolbars.back().get<1>();
383 bool operator<(ToolbarSection::ToolbarItem const & a, ToolbarSection::ToolbarItem const & b)
385 ToolbarSection::ToolbarInfo lhs = a.get<1>();
386 ToolbarSection::ToolbarInfo rhs = b.get<1>();
388 if (lhs.state != rhs.state)
389 return static_cast<int>(lhs.state) < static_cast<int>(rhs.state);
390 // order of dock does not really matter
391 if (lhs.location != rhs.location)
392 return static_cast<int>(lhs.location) < static_cast<int>(rhs.location);
393 // if the same dock, the order depends on position
394 if (lhs.location == ToolbarSection::ToolbarInfo::TOP ||
395 lhs.location == ToolbarSection::ToolbarInfo::BOTTOM)
396 return lhs.posy < rhs.posy || (lhs.posy == rhs.posy && lhs.posx < rhs.posx);
397 else if (lhs.location == ToolbarSection::ToolbarInfo::LEFT ||
398 lhs.location == ToolbarSection::ToolbarInfo::RIGHT)
399 return lhs.posx < rhs.posx || (lhs.posx == rhs.posx && lhs.posy < rhs.posy);
405 void SessionInfoSection::read(istream & is)
413 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
417 // Read session info, saved as key/value pairs
418 // would better yell if pos returns npos
419 string::size_type pos = tmp.find_first_of(" = ");
420 // silently ignore lines without " = "
421 if (pos != string::npos) {
422 string key = tmp.substr(0, pos);
423 string value = tmp.substr(pos + 3);
424 sessioninfo[key] = value;
426 lyxerr[Debug::INIT] << "LyX: Warning: Ignore session info: " << tmp << endl;
428 lyxerr[Debug::INIT] << "LyX: Warning: unknown Session info: " << tmp << endl;
434 void SessionInfoSection::write(ostream & os) const
436 os << '\n' << sec_session << '\n';
437 for (MiscInfo::const_iterator val = sessioninfo.begin();
438 val != sessioninfo.end(); ++val) {
439 os << val->first << " = " << val->second << '\n';
444 void SessionInfoSection::save(string const & key, string const & value)
446 sessioninfo[key] = value;
450 string const SessionInfoSection::load(string const & key, bool release)
452 MiscInfo::const_iterator pos = sessioninfo.find(key);
454 if (pos != sessioninfo.end())
457 sessioninfo.erase(key);
462 Session::Session(unsigned int num) :
465 // locate the session file
466 // note that the session file name 'session' is hard-coded
467 session_file = FileName(addName(package().user_support(), "session"));
473 void Session::readFile()
475 // we will not complain if we can't find session_file nor will
476 // we issue a warning. (Lgb)
477 ifstream is(session_file.toFilesystemEncoding().c_str());
480 while (getline(is, tmp)) {
481 // Ignore comments, empty line or line stats with ' '
482 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
485 // Determine section id
486 if (tmp == sec_lastfiles)
487 lastFiles().read(is);
488 else if (tmp == sec_lastopened)
489 lastOpened().read(is);
490 else if (tmp == sec_lastfilepos)
491 lastFilePos().read(is);
492 else if (tmp == sec_bookmarks)
493 bookmarks().read(is);
494 else if (tmp == sec_toolbars)
496 else if (tmp == sec_session)
497 sessionInfo().read(is);
499 lyxerr[Debug::INIT] << "LyX: Warning: unknown Session section: " << tmp << endl;
504 void Session::writeFile() const
506 ofstream os(session_file.toFilesystemEncoding().c_str());
508 os << "## Automatically generated lyx session file \n"
509 << "## Editing this file manually may cause lyx to crash.\n";
511 lastFiles().write(os);
512 lastOpened().write(os);
513 lastFilePos().write(os);
514 bookmarks().write(os);
515 toolbars().write(os);
516 sessionInfo().write(os);
518 lyxerr[Debug::INIT] << "LyX: Warning: unable to save Session: "
519 << session_file << endl;