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.
15 #include "support/debug.h"
16 #include "support/Package.h"
17 #include "support/filetools.h"
24 using lyx::support::absolutePath;
25 using lyx::support::addName;
26 using lyx::support::FileName;
27 using lyx::support::package;
37 using std::istringstream;
40 using std::ostream_iterator;
44 string const sec_lastfiles = "[recent files]";
45 string const sec_lastfilepos = "[cursor positions]";
46 string const sec_lastopened = "[last opened files]";
47 string const sec_bookmarks = "[bookmarks]";
48 string const sec_session = "[session info]";
49 string const sec_toolbars = "[toolbars]";
56 LastFilesSection::LastFilesSection(unsigned int num) :
57 default_num_last_files(4),
58 absolute_max_last_files(100)
60 setNumberOfLastFiles(num);
64 void LastFilesSection::read(istream & is)
72 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ' || !absolutePath(tmp))
76 FileName const file(tmp);
77 if (file.exists() && !file.isDirectory()
78 && lastfiles.size() < num_lastfiles)
79 lastfiles.push_back(file);
81 LYXERR(Debug::INIT, "LyX: Warning: Ignore last file: " << tmp);
86 void LastFilesSection::write(ostream & os) const
88 os << '\n' << sec_lastfiles << '\n';
89 copy(lastfiles.begin(), lastfiles.end(),
90 ostream_iterator<FileName>(os, "\n"));
94 void LastFilesSection::add(FileName const & file)
96 // If file already exist, delete it and reinsert at front.
97 LastFiles::iterator it = find(lastfiles.begin(), lastfiles.end(), file);
98 if (it != lastfiles.end())
100 lastfiles.push_front(file);
101 if (lastfiles.size() > num_lastfiles)
102 lastfiles.pop_back();
106 void LastFilesSection::setNumberOfLastFiles(unsigned int no)
108 if (0 < no && no <= absolute_max_last_files)
111 LYXERR(Debug::INIT, "LyX: session: too many last files\n"
112 << "\tdefault (=" << default_num_last_files << ") used.");
113 num_lastfiles = default_num_last_files;
118 void LastOpenedSection::read(istream & is)
126 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ' || !absolutePath(tmp))
129 FileName const file(tmp);
130 if (file.exists() && !file.isDirectory())
131 lastopened.push_back(file);
133 LYXERR(Debug::INIT, "LyX: Warning: Ignore last opened file: " << tmp);
138 void LastOpenedSection::write(ostream & os) const
140 os << '\n' << sec_lastopened << '\n';
141 copy(lastopened.begin(), lastopened.end(),
142 ostream_iterator<FileName>(os, "\n"));
146 void LastOpenedSection::add(FileName const & file)
148 lastopened.push_back(file);
152 void LastOpenedSection::clear()
158 void LastFilePosSection::read(istream & is)
166 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
174 istringstream itmp(tmp);
176 itmp.ignore(2); // ignore ", "
178 itmp.ignore(2); // ignore ", "
179 getline(itmp, fname);
180 if (!absolutePath(fname))
182 FileName const file(fname);
183 if (file.exists() && !file.isDirectory()
184 && lastfilepos.size() < num_lastfilepos)
185 lastfilepos[file] = filepos;
187 LYXERR(Debug::INIT, "LyX: Warning: Ignore pos of last file: " << fname);
189 LYXERR(Debug::INIT, "LyX: Warning: unknown pos of last file: " << tmp);
195 void LastFilePosSection::write(ostream & os) const
197 os << '\n' << sec_lastfilepos << '\n';
198 for (FilePosMap::const_iterator file = lastfilepos.begin();
199 file != lastfilepos.end(); ++file) {
200 os << file->second.pit << ", " << file->second.pos << ", "
201 << file->first << '\n';
206 void LastFilePosSection::save(FileName const & fname, FilePos const & pos)
208 lastfilepos[fname] = pos;
212 LastFilePosSection::FilePos LastFilePosSection::load(FileName const & fname) const
214 FilePosMap::const_iterator entry = lastfilepos.find(fname);
215 // Has position information, return it.
216 if (entry != lastfilepos.end())
217 return entry->second;
218 // Not found, return the first paragraph
223 void BookmarksSection::clear()
225 // keep bookmark[0], the temporary one
227 bookmarks.resize(max_bookmarks + 1);
231 void BookmarksSection::read(istream & is)
239 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
244 // idx, pit, pos, file\n
249 istringstream itmp(tmp);
251 itmp.ignore(2); // ignore ", "
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 (file.exists() && !file.isDirectory() && idx <= max_bookmarks)
262 bookmarks[idx] = Bookmark(file, pit, pos, 0, 0);
264 LYXERR(Debug::INIT, "LyX: Warning: Ignore bookmark of file: " << fname);
266 LYXERR(Debug::INIT, "LyX: Warning: unknown Bookmark info: " << tmp);
272 void BookmarksSection::write(ostream & os) const
274 os << '\n' << sec_bookmarks << '\n';
275 for (size_t i = 1; i <= max_bookmarks; ++i) {
278 << bookmarks[i].bottom_pit << ", "
279 << bookmarks[i].bottom_pos << ", "
280 << bookmarks[i].filename << '\n';
285 void BookmarksSection::save(FileName const & fname,
286 pit_type bottom_pit, pos_type bottom_pos,
287 int top_id, pos_type top_pos, unsigned int idx)
289 // silently ignore bookmarks when idx is out of range
290 if (idx <= max_bookmarks)
291 bookmarks[idx] = Bookmark(fname, bottom_pit, bottom_pos, top_id, top_pos);
295 bool BookmarksSection::isValid(unsigned int i) const
297 return i <= max_bookmarks && !bookmarks[i].filename.empty();
301 BookmarksSection::Bookmark const & BookmarksSection::bookmark(unsigned int i) const
307 void ToolbarSection::read(istream & is)
315 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
319 // Read session info, saved as key/value pairs
320 // would better yell if pos returns npos
321 size_t pos = tmp.find_first_of(" = ");
322 // silently ignore lines without " = "
323 if (pos != string::npos) {
325 item.key = tmp.substr(0, pos);
328 istringstream value(tmp.substr(pos + 3));
331 value >> item.info.posx;
332 value >> item.info.posy;
333 item.info.state = ToolbarInfo::State(state);
334 item.info.location = ToolbarInfo::Location(location);
335 toolbars.push_back(item);
337 LYXERR(Debug::INIT, "LyX: Warning: Ignore toolbar info: " << tmp);
339 LYXERR(Debug::INIT, "LyX: Warning: unknown Toolbar info: " << tmp);
342 // sort the toolbars by location, line and position
343 std::sort(toolbars.begin(), toolbars.end());
347 void ToolbarSection::write(ostream & os) const
349 os << '\n' << sec_toolbars << '\n';
350 for (ToolbarList::const_iterator tb = toolbars.begin();
351 tb != toolbars.end(); ++tb) {
352 os << tb->key << " = "
353 << static_cast<int>(tb->info.state) << " "
354 << static_cast<int>(tb->info.location) << " "
355 << tb->info.posx << " "
356 << tb->info.posy << '\n';
361 ToolbarSection::ToolbarInfo & ToolbarSection::load(string const & name)
363 for (ToolbarList::iterator tb = toolbars.begin();
364 tb != toolbars.end(); ++tb)
371 toolbars.push_back(item);
372 return toolbars.back().info;
376 bool operator<(ToolbarSection::ToolbarItem const & a, ToolbarSection::ToolbarItem const & b)
378 ToolbarSection::ToolbarInfo lhs = a.info;
379 ToolbarSection::ToolbarInfo rhs = b.info;
381 if (lhs.state != rhs.state)
382 return static_cast<int>(lhs.state) < static_cast<int>(rhs.state);
383 // order of dock does not really matter
384 if (lhs.location != rhs.location)
385 return static_cast<int>(lhs.location) < static_cast<int>(rhs.location);
386 // if the same dock, the order depends on position
387 if (lhs.location == ToolbarSection::ToolbarInfo::TOP ||
388 lhs.location == ToolbarSection::ToolbarInfo::BOTTOM)
389 return lhs.posy < rhs.posy || (lhs.posy == rhs.posy && lhs.posx < rhs.posx);
390 else if (lhs.location == ToolbarSection::ToolbarInfo::LEFT ||
391 lhs.location == ToolbarSection::ToolbarInfo::RIGHT)
392 return lhs.posx < rhs.posx || (lhs.posx == rhs.posx && lhs.posy < rhs.posy);
397 void SessionInfoSection::read(istream & is)
405 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
409 // Read session info, saved as key/value pairs
410 // would better yell if pos returns npos
411 string::size_type pos = tmp.find_first_of(" = ");
412 // silently ignore lines without " = "
413 if (pos != string::npos) {
414 string key = tmp.substr(0, pos);
415 string value = tmp.substr(pos + 3);
416 sessioninfo[key] = value;
418 LYXERR(Debug::INIT, "LyX: Warning: Ignore session info: " << tmp);
420 LYXERR(Debug::INIT, "LyX: Warning: unknown Session info: " << tmp);
426 void SessionInfoSection::write(ostream & os) const
428 os << '\n' << sec_session << '\n';
429 for (MiscInfo::const_iterator val = sessioninfo.begin();
430 val != sessioninfo.end(); ++val) {
431 os << val->first << " = " << val->second << '\n';
436 void SessionInfoSection::save(string const & key, string const & value)
438 sessioninfo[key] = value;
442 string const SessionInfoSection::load(string const & key, bool release)
444 MiscInfo::const_iterator pos = sessioninfo.find(key);
446 if (pos != sessioninfo.end())
449 sessioninfo.erase(key);
454 Session::Session(unsigned int num) :
457 // locate the session file
458 // note that the session file name 'session' is hard-coded
459 session_file = FileName(addName(package().user_support().absFilename(), "session"));
465 void Session::readFile()
467 // we will not complain if we can't find session_file nor will
468 // we issue a warning. (Lgb)
469 ifstream is(session_file.toFilesystemEncoding().c_str());
472 while (getline(is, tmp)) {
473 // Ignore comments, empty line or line stats with ' '
474 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
477 // Determine section id
478 if (tmp == sec_lastfiles)
479 lastFiles().read(is);
480 else if (tmp == sec_lastopened)
481 lastOpened().read(is);
482 else if (tmp == sec_lastfilepos)
483 lastFilePos().read(is);
484 else if (tmp == sec_bookmarks)
485 bookmarks().read(is);
486 else if (tmp == sec_toolbars)
488 else if (tmp == sec_session)
489 sessionInfo().read(is);
491 LYXERR(Debug::INIT, "LyX: Warning: unknown Session section: " << tmp);
496 void Session::writeFile() const
498 ofstream os(session_file.toFilesystemEncoding().c_str());
500 os << "## Automatically generated lyx session file \n"
501 << "## Editing this file manually may cause lyx to crash.\n";
503 lastFiles().write(os);
504 lastOpened().write(os);
505 lastFilePos().write(os);
506 bookmarks().write(os);
507 toolbars().write(os);
508 sessionInfo().write(os);
510 LYXERR(Debug::INIT, "LyX: Warning: unable to save Session: "