src/Session.cpp

   1 /**
   2  * \file Session.cpp
   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 <fstream>
  20 #include <sstream>
  21 #include <algorithm>
  22 #include <iterator>
  23
  24 using lyx::support::absolutePath;
  25 using lyx::support::addName;
  26 using lyx::support::FileName;
  27 using lyx::support::package;
  28
  29 using std::vector;
  30 using std::getline;
  31 using std::string;
  32 using std::ifstream;
  33 using std::ofstream;
  34 using std::istream;
  35 using std::ostream;
  36 using std::endl;
  37 using std::istringstream;
  38 using std::copy;
  39 using std::find;
  40 using std::ostream_iterator;
  41
  42 namespace {
  43
  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]";
  50
  51 } // anon namespace
  52
  53
  54 namespace lyx {
  55
  56 LastFilesSection::LastFilesSection(unsigned int num) :
  57         default_num_last_files(4),
  58         absolute_max_last_files(100)
  59 {
  60         setNumberOfLastFiles(num);
  61 }
  62
  63
  64 void LastFilesSection::read(istream & is)
  65 {
  66         string tmp;
  67         do {
  68                 char c = is.peek();
  69                 if (c == '[')
  70                         break;
  71                 getline(is, tmp);
  72                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ' || !absolutePath(tmp))
  73                         continue;
  74
  75                 // read lastfiles
  76                 FileName const file(tmp);
  77                 if (file.exists() && !file.isDirectory()
  78                     && lastfiles.size() < num_lastfiles)
  79                         lastfiles.push_back(file);
  80                 else
  81                         LYXERR(Debug::INIT) << "LyX: Warning: Ignore last file: " << tmp << endl;
  82         } while (is.good());
  83 }
  84
  85
  86 void LastFilesSection::write(ostream & os) const
  87 {
  88         os << '\n' << sec_lastfiles << '\n';
  89         copy(lastfiles.begin(), lastfiles.end(),
  90              ostream_iterator<FileName>(os, "\n"));
  91 }
  92
  93
  94 void LastFilesSection::add(FileName const & file)
  95 {
  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())
  99                 lastfiles.erase(it);
 100         lastfiles.push_front(file);
 101         if (lastfiles.size() > num_lastfiles)
 102                 lastfiles.pop_back();
 103 }
 104
 105
 106 void LastFilesSection::setNumberOfLastFiles(unsigned int no)
 107 {
 108         if (0 < no && no <= absolute_max_last_files)
 109                 num_lastfiles = no;
 110         else {
 111                 LYXERR(Debug::INIT) << "LyX: session: too many last files\n"
 112                        << "\tdefault (=" << default_num_last_files
 113                        << ") used." << endl;
 114                 num_lastfiles = default_num_last_files;
 115         }
 116 }
 117
 118
 119 void LastOpenedSection::read(istream & is)
 120 {
 121         string tmp;
 122         do {
 123                 char c = is.peek();
 124                 if (c == '[')
 125                         break;
 126                 getline(is, tmp);
 127                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ' || !absolutePath(tmp))
 128                         continue;
 129
 130                 FileName const file(tmp);
 131                 if (file.exists() && !file.isDirectory())
 132                         lastopened.push_back(file);
 133                 else
 134                         LYXERR(Debug::INIT) << "LyX: Warning: Ignore last opened file: " << tmp << endl;
 135         } while (is.good());
 136 }
 137
 138
 139 void LastOpenedSection::write(ostream & os) const
 140 {
 141         os << '\n' << sec_lastopened << '\n';
 142         copy(lastopened.begin(), lastopened.end(),
 143              ostream_iterator<FileName>(os, "\n"));
 144 }
 145
 146
 147 void LastOpenedSection::add(FileName const & file)
 148 {
 149         lastopened.push_back(file);
 150 }
 151
 152
 153 void LastOpenedSection::clear()
 154 {
 155         lastopened.clear();
 156 }
 157
 158
 159 void LastFilePosSection::read(istream & is)
 160 {
 161         string tmp;
 162         do {
 163                 char c = is.peek();
 164                 if (c == '[')
 165                         break;
 166                 getline(is, tmp);
 167                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
 168                         continue;
 169
 170                 try {
 171                         // read lastfilepos
 172                         // pos, file\n
 173                         FilePos filepos;
 174                         string fname;
 175                         istringstream itmp(tmp);
 176                         itmp >> filepos.pit;
 177                         itmp.ignore(2);  // ignore ", "
 178                         itmp >> filepos.pos;
 179                         itmp.ignore(2);  // ignore ", "
 180                         getline(itmp, fname);
 181                         if (!absolutePath(fname))
 182                                 continue;
 183                         FileName const file(fname);
 184                         if (file.exists() && !file.isDirectory()
 185                             && lastfilepos.size() < num_lastfilepos)
 186                                 lastfilepos[file] = filepos;
 187                         else
 188                                 LYXERR(Debug::INIT) << "LyX: Warning: Ignore pos of last file: " << fname << endl;
 189                 } catch (...) {
 190                         LYXERR(Debug::INIT) << "LyX: Warning: unknown pos of last file: " << tmp << endl;
 191                 }
 192         } while (is.good());
 193 }
 194
 195
 196 void LastFilePosSection::write(ostream & os) const
 197 {
 198         os << '\n' << sec_lastfilepos << '\n';
 199         for (FilePosMap::const_iterator file = lastfilepos.begin();
 200                 file != lastfilepos.end(); ++file) {
 201                 os << file->second.pit << ", " << file->second.pos << ", "
 202                    << file->first << '\n';
 203         }
 204 }
 205
 206
 207 void LastFilePosSection::save(FileName const & fname, FilePos const & pos)
 208 {
 209         lastfilepos[fname] = pos;
 210 }
 211
 212
 213 LastFilePosSection::FilePos LastFilePosSection::load(FileName const & fname) const
 214 {
 215         FilePosMap::const_iterator entry = lastfilepos.find(fname);
 216         // Has position information, return it.
 217         if (entry != lastfilepos.end())
 218                 return entry->second;
 219         // Not found, return the first paragraph
 220         return FilePos();
 221 }
 222
 223
 224 void BookmarksSection::clear()
 225 {
 226         // keep bookmark[0], the temporary one
 227         bookmarks.resize(1);
 228         bookmarks.resize(max_bookmarks + 1);
 229 }
 230
 231
 232 void BookmarksSection::read(istream & is)
 233 {
 234         string tmp;
 235         do {
 236                 char c = is.peek();
 237                 if (c == '[')
 238                         break;
 239                 getline(is, tmp);
 240                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
 241                         continue;
 242
 243                 try {
 244                         // read bookmarks
 245                         // idx, pit, pos, file\n
 246                         unsigned int idx;
 247                         pit_type pit;
 248                         pos_type pos;
 249                         string fname;
 250                         istringstream itmp(tmp);
 251                         itmp >> idx;
 252                         itmp.ignore(2);  // ignore ", "
 253                         itmp >> pit;
 254                         itmp.ignore(2);  // ignore ", "
 255                         itmp >> pos;
 256                         itmp.ignore(2);  // ignore ", "
 257                         getline(itmp, fname);
 258                         if (!absolutePath(fname))
 259                                 continue;
 260                         FileName const file(fname);
 261                         // only load valid bookmarks
 262                         if (file.exists() && !file.isDirectory() && idx <= max_bookmarks)
 263                                 bookmarks[idx] = Bookmark(file, pit, pos, 0, 0);
 264                         else
 265                                 LYXERR(Debug::INIT) << "LyX: Warning: Ignore bookmark of file: " << fname << endl;
 266                 } catch (...) {
 267                         LYXERR(Debug::INIT) << "LyX: Warning: unknown Bookmark info: " << tmp << endl;
 268                 }
 269         } while (is.good());
 270 }
 271
 272
 273 void BookmarksSection::write(ostream & os) const
 274 {
 275         os << '\n' << sec_bookmarks << '\n';
 276         for (size_t i = 1; i <= max_bookmarks; ++i) {
 277                 if (isValid(i))
 278                         os << i << ", "
 279                            << bookmarks[i].bottom_pit << ", "
 280                            << bookmarks[i].bottom_pos << ", "
 281                            << bookmarks[i].filename << '\n';
 282         }
 283 }
 284
 285
 286 void BookmarksSection::save(FileName const & fname,
 287         pit_type bottom_pit, pos_type bottom_pos,
 288         int top_id, pos_type top_pos, unsigned int idx)
 289 {
 290         // silently ignore bookmarks when idx is out of range
 291         if (idx <= max_bookmarks)
 292                 bookmarks[idx] = Bookmark(fname, bottom_pit, bottom_pos, top_id, top_pos);
 293 }
 294
 295
 296 bool BookmarksSection::isValid(unsigned int i) const
 297 {
 298         return i <= max_bookmarks && !bookmarks[i].filename.empty();
 299 }
 300
 301
 302 BookmarksSection::Bookmark const & BookmarksSection::bookmark(unsigned int i) const
 303 {
 304         return bookmarks[i];
 305 }
 306
 307
 308 void ToolbarSection::read(istream & is)
 309 {
 310         string tmp;
 311         do {
 312                 char c = is.peek();
 313                 if (c == '[')
 314                         break;
 315                 getline(is, tmp);
 316                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
 317                         continue;
 318
 319                 try {
 320                         // Read session info, saved as key/value pairs
 321                         // would better yell if pos returns npos
 322                         size_t pos = tmp.find_first_of(" = ");
 323                         // silently ignore lines without " = "
 324                         if (pos != string::npos) {
 325                                 ToolbarItem item;
 326                                 item.key = tmp.substr(0, pos);
 327                                 int state;
 328                                 int location;
 329                                 istringstream value(tmp.substr(pos + 3));
 330                                 value >> state;
 331                                 value >> location;
 332                                 value >> item.info.posx;
 333                                 value >> item.info.posy;
 334                                 item.info.state = ToolbarInfo::State(state);
 335                                 item.info.location = ToolbarInfo::Location(location);
 336                                 toolbars.push_back(item);
 337                         } else
 338                                 LYXERR(Debug::INIT) << "LyX: Warning: Ignore toolbar info: " << tmp << endl;
 339                 } catch (...) {
 340                         LYXERR(Debug::INIT) << "LyX: Warning: unknown Toolbar info: " << tmp << endl;
 341                 }
 342         } while (is.good());
 343         // sort the toolbars by location, line and position
 344         std::sort(toolbars.begin(), toolbars.end());
 345 }
 346
 347
 348 void ToolbarSection::write(ostream & os) const
 349 {
 350         os << '\n' << sec_toolbars << '\n';
 351         for (ToolbarList::const_iterator tb = toolbars.begin();
 352                 tb != toolbars.end(); ++tb) {
 353                 os << tb->key << " = "
 354                   << static_cast<int>(tb->info.state) << " "
 355                   << static_cast<int>(tb->info.location) << " "
 356                   << tb->info.posx << " "
 357                   << tb->info.posy << '\n';
 358         }
 359 }
 360
 361
 362 ToolbarSection::ToolbarInfo & ToolbarSection::load(string const & name)
 363 {
 364         for (ToolbarList::iterator tb = toolbars.begin();
 365                 tb != toolbars.end(); ++tb)
 366                 if (tb->key == name)
 367                         return tb->info;
 368
 369         // add a new item
 370         ToolbarItem item;
 371         item.key = name;
 372         toolbars.push_back(item);
 373         return toolbars.back().info;
 374 }
 375
 376
 377 bool operator<(ToolbarSection::ToolbarItem const & a, ToolbarSection::ToolbarItem const & b)
 378 {
 379         ToolbarSection::ToolbarInfo lhs = a.info;
 380         ToolbarSection::ToolbarInfo rhs = b.info;
 381         // on if before off
 382         if (lhs.state != rhs.state)
 383                 return static_cast<int>(lhs.state) < static_cast<int>(rhs.state);
 384         // order of dock does not really matter
 385         if (lhs.location != rhs.location)
 386                 return static_cast<int>(lhs.location) < static_cast<int>(rhs.location);
 387         // if the same dock, the order depends on position
 388         if (lhs.location == ToolbarSection::ToolbarInfo::TOP ||
 389                 lhs.location == ToolbarSection::ToolbarInfo::BOTTOM)
 390                 return lhs.posy < rhs.posy || (lhs.posy == rhs.posy && lhs.posx < rhs.posx);
 391         else if (lhs.location == ToolbarSection::ToolbarInfo::LEFT ||
 392                 lhs.location == ToolbarSection::ToolbarInfo::RIGHT)
 393                 return lhs.posx < rhs.posx || (lhs.posx == rhs.posx && lhs.posy < rhs.posy);
 394         return true;
 395 }
 396
 397
 398 void SessionInfoSection::read(istream & is)
 399 {
 400         string tmp;
 401         do {
 402                 char c = is.peek();
 403                 if (c == '[')
 404                         break;
 405                 getline(is, tmp);
 406                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
 407                         continue;
 408
 409                 try {
 410                         // Read session info, saved as key/value pairs
 411                         // would better yell if pos returns npos
 412                         string::size_type pos = tmp.find_first_of(" = ");
 413                         // silently ignore lines without " = "
 414                         if (pos != string::npos) {
 415                                 string key = tmp.substr(0, pos);
 416                                 string value = tmp.substr(pos + 3);
 417                                 sessioninfo[key] = value;
 418                         } else
 419                                 LYXERR(Debug::INIT) << "LyX: Warning: Ignore session info: " << tmp << endl;
 420                 } catch (...) {
 421                         LYXERR(Debug::INIT) << "LyX: Warning: unknown Session info: " << tmp << endl;
 422                 }
 423         } while (is.good());
 424 }
 425
 426
 427 void SessionInfoSection::write(ostream & os) const
 428 {
 429         os << '\n' << sec_session << '\n';
 430         for (MiscInfo::const_iterator val = sessioninfo.begin();
 431                 val != sessioninfo.end(); ++val) {
 432                 os << val->first << " = " << val->second << '\n';
 433         }
 434 }
 435
 436
 437 void SessionInfoSection::save(string const & key, string const & value)
 438 {
 439         sessioninfo[key] = value;
 440 }
 441
 442
 443 string const SessionInfoSection::load(string const & key, bool release)
 444 {
 445         MiscInfo::const_iterator pos = sessioninfo.find(key);
 446         string value;
 447         if (pos != sessioninfo.end())
 448                 value = pos->second;
 449         if (release)
 450                 sessioninfo.erase(key);
 451         return value;
 452 }
 453
 454
 455 Session::Session(unsigned int num) :
 456         last_files(num)
 457 {
 458         // locate the session file
 459         // note that the session file name 'session' is hard-coded
 460         session_file = FileName(addName(package().user_support().absFilename(), "session"));
 461         //
 462         readFile();
 463 }
 464
 465
 466 void Session::readFile()
 467 {
 468         // we will not complain if we can't find session_file nor will
 469         // we issue a warning. (Lgb)
 470         ifstream is(session_file.toFilesystemEncoding().c_str());
 471         string tmp;
 472
 473         while (getline(is, tmp)) {
 474                 // Ignore comments, empty line or line stats with ' '
 475                 if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
 476                         continue;
 477
 478                 // Determine section id
 479                 if (tmp == sec_lastfiles)
 480                         lastFiles().read(is);
 481                 else if (tmp == sec_lastopened)
 482                         lastOpened().read(is);
 483                 else if (tmp == sec_lastfilepos)
 484                         lastFilePos().read(is);
 485                 else if (tmp == sec_bookmarks)
 486                         bookmarks().read(is);
 487                 else if (tmp == sec_toolbars)
 488                         toolbars().read(is);
 489                 else if (tmp == sec_session)
 490                         sessionInfo().read(is);
 491                 else
 492                         LYXERR(Debug::INIT) << "LyX: Warning: unknown Session section: " << tmp << endl;
 493         }
 494 }
 495
 496
 497 void Session::writeFile() const
 498 {
 499         ofstream os(session_file.toFilesystemEncoding().c_str());
 500         if (os) {
 501                 os << "## Automatically generated lyx session file \n"
 502                     << "## Editing this file manually may cause lyx to crash.\n";
 503
 504                 lastFiles().write(os);
 505                 lastOpened().write(os);
 506                 lastFilePos().write(os);
 507                 bookmarks().write(os);
 508                 toolbars().write(os);
 509                 sessionInfo().write(os);
 510         } else
 511                 LYXERR(Debug::INIT) << "LyX: Warning: unable to save Session: "
 512                        << session_file << endl;
 513 }
 514
 515 }