src/session.C

   1 /**
   2  * \file session.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author Bo Peng
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "session.h"
  15 #include "debug.h"
  16 #include "support/package.h"
  17 #include "support/filetools.h"
  18
  19 #include <boost/filesystem/operations.hpp>
  20
  21 #include <fstream>
  22 #include <sstream>
  23 #include <algorithm>
  24 #include <iterator>
  25
  26 using lyx::support::absolutePath;
  27 using lyx::support::addName;
  28 using lyx::support::FileName;
  29 using lyx::support::package;
  30
  31 namespace fs = boost::filesystem;
  32
  33 using std::vector;
  34 using std::getline;
  35 using std::string;
  36 using std::ifstream;
  37 using std::ofstream;
  38 using std::istream;
  39 using std::ostream;
  40 using std::endl;
  41 using std::istringstream;
  42 using std::copy;
  43 using std::find;
  44 using std::ostream_iterator;
  45
  46 namespace {
  47
  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]";
  54
  55 } // anon namespace
  56
  57
  58 namespace lyx {
  59
  60 LastFilesSection::LastFilesSection(unsigned int num) :
  61         default_num_last_files(4),
  62         absolute_max_last_files(100)
  63 {
  64         setNumberOfLastFiles(num);
  65 }
  66
  67
  68 void LastFilesSection::read(istream & is)
  69 {
  70         string tmp;
  71         do {
  72                 char c = is.peek();
  73                 if (c == '[')
  74                         break;
  75                 getline(is, tmp);
  76                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ' || !absolutePath(tmp))
  77                         continue;
  78
  79                 // read lastfiles
  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);
  85                 else
  86                         lyxerr[Debug::INIT] << "LyX: Warning: Ignore last file: " << tmp << endl;
  87         } while (is.good());
  88 }
  89
  90
  91 void LastFilesSection::write(ostream & os) const
  92 {
  93         os << '\n' << sec_lastfiles << '\n';
  94         copy(lastfiles.begin(), lastfiles.end(),
  95              ostream_iterator<FileName>(os, "\n"));
  96 }
  97
  98
  99 void LastFilesSection::add(FileName const & file)
 100 {
 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())
 104                 lastfiles.erase(it);
 105         lastfiles.push_front(file);
 106         if (lastfiles.size() > num_lastfiles)
 107                 lastfiles.pop_back();
 108 }
 109
 110
 111 void LastFilesSection::setNumberOfLastFiles(unsigned int no)
 112 {
 113         if (0 < no && no <= absolute_max_last_files)
 114                 num_lastfiles = no;
 115         else {
 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;
 120         }
 121 }
 122
 123
 124 void LastOpenedSection::read(istream & is)
 125 {
 126         string tmp;
 127         do {
 128                 char c = is.peek();
 129                 if (c == '[')
 130                         break;
 131                 getline(is, tmp);
 132                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ' || !absolutePath(tmp))
 133                         continue;
 134
 135                 FileName const file(tmp);
 136                 if (fs::exists(file.toFilesystemEncoding()) &&
 137                     !fs::is_directory(file.toFilesystemEncoding()))
 138                         lastopened.push_back(file);
 139                 else
 140                         lyxerr[Debug::INIT] << "LyX: Warning: Ignore last opened file: " << tmp << endl;
 141         } while (is.good());
 142 }
 143
 144
 145 void LastOpenedSection::write(ostream & os) const
 146 {
 147         os << '\n' << sec_lastopened << '\n';
 148         copy(lastopened.begin(), lastopened.end(),
 149              ostream_iterator<FileName>(os, "\n"));
 150 }
 151
 152
 153 void LastOpenedSection::add(FileName const & file)
 154 {
 155         lastopened.push_back(file);
 156 }
 157
 158
 159 void LastOpenedSection::clear()
 160 {
 161         lastopened.clear();
 162 }
 163
 164
 165 void LastFilePosSection::read(istream & is)
 166 {
 167         string tmp;
 168         do {
 169                 char c = is.peek();
 170                 if (c == '[')
 171                         break;
 172                 getline(is, tmp);
 173                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
 174                         continue;
 175
 176                 try {
 177                         // read lastfilepos
 178                         // pos, file\n
 179                         pit_type pit;
 180                         pos_type pos;
 181                         string fname;
 182                         istringstream itmp(tmp);
 183                         itmp >> pit;
 184                         itmp.ignore(2);  // ignore ", "
 185                         itmp >> pos;
 186                         itmp.ignore(2);  // ignore ", "
 187                         getline(itmp, fname);
 188                         if (!absolutePath(fname))
 189                                 continue;
 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);
 195                         else
 196                                 lyxerr[Debug::INIT] << "LyX: Warning: Ignore pos of last file: " << fname << endl;
 197                 } catch (...) {
 198                         lyxerr[Debug::INIT] << "LyX: Warning: unknown pos of last file: " << tmp << endl;
 199                 }
 200         } while (is.good());
 201 }
 202
 203
 204 void LastFilePosSection::write(ostream & os) const
 205 {
 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';
 212         }
 213 }
 214
 215
 216 void LastFilePosSection::save(FileName const & fname, FilePos pos)
 217 {
 218         lastfilepos[fname] = pos;
 219 }
 220
 221
 222 LastFilePosSection::FilePos LastFilePosSection::load(FileName const & fname) const
 223 {
 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
 229         else
 230                 return 0;
 231 }
 232
 233
 234 void BookmarksSection::read(istream & is)
 235 {
 236         string tmp;
 237         do {
 238                 char c = is.peek();
 239                 if (c == '[')
 240                         break;
 241                 getline(is, tmp);
 242                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
 243                         continue;
 244
 245                 try {
 246                         // read bookmarks
 247                         // pit, pos, file\n
 248                         pit_type pit;
 249                         pos_type pos;
 250                         string fname;
 251                         istringstream itmp(tmp);
 252                         itmp >> pit;
 253                         itmp.ignore(2);  // ignore ", "
 254                         itmp >> pos;
 255                         itmp.ignore(2);  // ignore ", "
 256                         getline(itmp, fname);
 257                         if (!absolutePath(fname))
 258                                 continue;
 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));
 265                         else
 266                                 lyxerr[Debug::INIT] << "LyX: Warning: Ignore bookmark of file: " << fname << endl;
 267                 } catch (...) {
 268                         lyxerr[Debug::INIT] << "LyX: Warning: unknown Bookmark info: " << tmp << endl;
 269                 }
 270         } while (is.good());
 271 }
 272
 273
 274 void BookmarksSection::write(ostream & os) const
 275 {
 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';
 281         }
 282 }
 283
 284
 285 void BookmarksSection::save(FileName const & fname, pit_type par_pit, int par_id, pos_type par_pos, bool persistent)
 286 {
 287         if (persistent) {
 288                 bookmarks.push_back(Bookmark(fname, par_pit, par_id, par_pos));
 289                 if (bookmarks.size() > max_bookmarks)
 290                         bookmarks.pop_back();
 291                 }
 292         else
 293                 temp_bookmark = Bookmark(fname, par_pit, par_id, par_pos);
 294 }
 295
 296
 297 bool BookmarksSection::isValid(unsigned int i) const
 298 {
 299         if (i == 0)
 300                 return !temp_bookmark.filename.empty();
 301         else
 302                 return i <= bookmarks.size() && !bookmarks[i-1].filename.empty();
 303 }
 304
 305
 306 BookmarksSection::Bookmark const & BookmarksSection::bookmark(unsigned int i) const
 307 {
 308         if (i == 0)
 309                 return temp_bookmark;
 310         else
 311                 return bookmarks[i-1];
 312 }
 313
 314
 315 void ToolbarSection::read(istream & is)
 316 {
 317         string tmp;
 318         do {
 319                 char c = is.peek();
 320                 if (c == '[')
 321                         break;
 322                 getline(is, tmp);
 323                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
 324                         continue;
 325
 326                 try {
 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);
 333                                 int state;
 334                                 int location;
 335                                 int posx;
 336                                 int posy;
 337                                 istringstream value(tmp.substr(pos + 3));
 338                                 value >> state;
 339                                 value >> location;
 340                                 value >> posx;
 341                                 value >> posy;
 342                                 toolbars.push_back(boost::make_tuple(key, ToolbarInfo(state, location, posx, posy)));
 343                         } else
 344                                 lyxerr[Debug::INIT] << "LyX: Warning: Ignore toolbar info: " << tmp << endl;
 345                 } catch (...) {
 346                         lyxerr[Debug::INIT] << "LyX: Warning: unknown Toolbar info: " << tmp << endl;
 347                 }
 348         } while (is.good());
 349         // sort the toolbars by location, line and position
 350         std::sort(toolbars.begin(), toolbars.end());
 351 }
 352
 353
 354 void ToolbarSection::write(ostream & os) const
 355 {
 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';
 364         }
 365 }
 366
 367
 368 ToolbarSection::ToolbarInfo & ToolbarSection::load(string const & name)
 369 {
 370         for (ToolbarList::iterator tb = toolbars.begin();
 371                 tb != toolbars.end(); ++tb)
 372                 if (tb->get<0>() == name)
 373                         return tb->get<1>();
 374         // add a new item
 375         toolbars.push_back(boost::make_tuple(name, ToolbarSection::ToolbarInfo()));
 376         return toolbars.back().get<1>();
 377 }
 378
 379
 380 bool operator<(ToolbarSection::ToolbarItem const & a, ToolbarSection::ToolbarItem const & b)
 381 {
 382         ToolbarSection::ToolbarInfo lhs = a.get<1>();
 383         ToolbarSection::ToolbarInfo rhs = b.get<1>();
 384         // on if before off
 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);
 397         else
 398                 return true;
 399 }
 400
 401
 402 void SessionInfoSection::read(istream & is)
 403 {
 404         string tmp;
 405         do {
 406                 char c = is.peek();
 407                 if (c == '[')
 408                         break;
 409                 getline(is, tmp);
 410                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
 411                         continue;
 412
 413                 try {
 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;
 422                         } else
 423                                 lyxerr[Debug::INIT] << "LyX: Warning: Ignore session info: " << tmp << endl;
 424                 } catch (...) {
 425                         lyxerr[Debug::INIT] << "LyX: Warning: unknown Session info: " << tmp << endl;
 426                 }
 427         } while (is.good());
 428 }
 429
 430
 431 void SessionInfoSection::write(ostream & os) const
 432 {
 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';
 437         }
 438 }
 439
 440
 441 void SessionInfoSection::save(string const & key, string const & value)
 442 {
 443         sessioninfo[key] = value;
 444 }
 445
 446
 447 string const SessionInfoSection::load(string const & key, bool release)
 448 {
 449         MiscInfo::const_iterator pos = sessioninfo.find(key);
 450         string value;
 451         if (pos != sessioninfo.end())
 452                 value = pos->second;
 453         if (release)
 454                 sessioninfo.erase(key);
 455         return value;
 456 }
 457
 458
 459 Session::Session(unsigned int num) :
 460         last_files(num)
 461 {
 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"));
 465         //
 466         readFile();
 467 }
 468
 469
 470 void Session::readFile()
 471 {
 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());
 475         string tmp;
 476
 477         while (getline(is, tmp)) {
 478                 // Ignore comments, empty line or line stats with ' '
 479                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
 480                         continue;
 481
 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)
 492                         toolbars().read(is);
 493                 else if (tmp == sec_session)
 494                         sessionInfo().read(is);
 495                 else
 496                         lyxerr[Debug::INIT] << "LyX: Warning: unknown Session section: " << tmp << endl;
 497         }
 498 }
 499
 500
 501 void Session::writeFile() const
 502 {
 503         ofstream os(session_file.toFilesystemEncoding().c_str());
 504         if (os) {
 505                 os << "## Automatically generated lyx session file \n"
 506                     << "## Editing this file manually may cause lyx to crash.\n";
 507
 508                 lastFiles().write(os);
 509                 lastOpened().write(os);
 510                 lastFilePos().write(os);
 511                 bookmarks().write(os);
 512                 toolbars().write(os);
 513                 sessionInfo().write(os);
 514         } else
 515                 lyxerr[Debug::INIT] << "LyX: Warning: unable to save Session: "
 516                        << session_file << endl;
 517 }
 518
 519 }