]> git.lyx.org Git - lyx.git/blobdiff - src/Session.cpp
Avoid full metrics computation with Update:FitCursor
[lyx.git] / src / Session.cpp
index 9291ef1c2213bfcd974a4a992544446915bee8fe..9ec18f1d0141852646217929a47bd1563abb2f62 100644 (file)
@@ -31,15 +31,18 @@ string const sec_lastfiles = "[recent files]";
 string const sec_lastfilepos = "[cursor positions]";
 string const sec_lastopened = "[last opened files]";
 string const sec_bookmarks = "[bookmarks]";
-string const sec_session = "[session info]";
-string const sec_toolbars = "[toolbars]";
+string const sec_lastcommands = "[last commands]";
+string const sec_authfiles = "[auth files]";
+string const sec_shellescape = "[shell escape files]";
+// currently unused:
+//string const sec_session = "[session info]";
+//string const sec_toolbars = "[toolbars]";
 
-} // anon namespace
+} // namespace
 
 
 namespace lyx {
 
-
 LastFilesSection::LastFilesSection(unsigned int num) :
        default_num_last_files(4),
        absolute_max_last_files(100)
@@ -56,11 +59,11 @@ void LastFilesSection::read(istream & is)
                if (c == '[')
                        break;
                getline(is, tmp);
-               FileName const file(tmp);
-               if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ' || !file.isAbsolute())
+               if (tmp.empty() || tmp[0] == '#' || tmp[0] == ' ' || !FileName::isAbsolute(tmp))
                        continue;
 
                // read lastfiles
+               FileName const file(tmp);
                if (file.exists() && !file.isDirectory()
                    && lastfiles.size() < num_lastfiles)
                        lastfiles.push_back(file);
@@ -84,7 +87,7 @@ void LastFilesSection::add(FileName const & file)
        LastFiles::iterator it = find(lastfiles.begin(), lastfiles.end(), file);
        if (it != lastfiles.end())
                lastfiles.erase(it);
-       lastfiles.push_front(file);
+       lastfiles.insert(lastfiles.begin(), file);
        if (lastfiles.size() > num_lastfiles)
                lastfiles.pop_back();
 }
@@ -110,14 +113,31 @@ void LastOpenedSection::read(istream & is)
                if (c == '[')
                        break;
                getline(is, tmp);
-               FileName const file(tmp);
-               if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ' || !file.isAbsolute())
+               if (tmp.empty() || tmp[0] == '#' || tmp[0] == ' ')
                        continue;
 
-               if (file.exists() && !file.isDirectory())
-                       lastopened.push_back(file);
-               else
-                       LYXERR(Debug::INIT, "LyX: Warning: Ignore last opened file: " << tmp);
+               try {
+                       LastOpenedFile lof;
+                       istringstream itmp(tmp);
+                       itmp >> lof.active;
+                       itmp.ignore(2);  // ignore ", "
+                       string fname;
+                       getline(itmp, fname);
+                       if (!FileName::isAbsolute(fname))
+                               continue;
+
+                       FileName const file(fname);
+                       if (file.exists() && !file.isDirectory()) {
+                               lof.file_name = file;
+                               lastopened.push_back(lof);
+                       } else {
+                               LYXERR(Debug::INIT,
+                                       "LyX: Warning: Ignore last opened file: " << tmp);
+                       }
+               } catch (...) {
+                       LYXERR(Debug::INIT,
+                               "LyX: Warning: unknown state of last opened file: " << tmp);
+               }
        } while (is.good());
 }
 
@@ -125,14 +145,25 @@ void LastOpenedSection::read(istream & is)
 void LastOpenedSection::write(ostream & os) const
 {
        os << '\n' << sec_lastopened << '\n';
-       copy(lastopened.begin(), lastopened.end(),
-            ostream_iterator<FileName>(os, "\n"));
+       for (auto const & last : lastopened)
+               os << last.active << ", " << last.file_name << '\n';
 }
 
 
-void LastOpenedSection::add(FileName const & file)
+void LastOpenedSection::add(FileName const & file, bool active)
 {
-       lastopened.push_back(file);
+       LastOpenedFile lof(file, active);
+       // check if file is already recorded (this can happen
+       // with multiple buffer views). We do only record each
+       // file once, since we cannot restore multiple views
+       // currently, we even crash in some cases (see #9483).
+       // FIXME: Add session support for multiple views of
+       //        the same buffer (split-view etc.).
+       for (auto const & last : lastopened) {
+               if (last.file_name == file)
+                       return;
+       }
+       lastopened.push_back(lof);
 }
 
 
@@ -164,12 +195,12 @@ void LastFilePosSection::read(istream & is)
                        itmp >> filepos.pos;
                        itmp.ignore(2);  // ignore ", "
                        getline(itmp, fname);
-                       FileName const file(fname);
-                       if (!file.isAbsolute())
+                       if (!FileName::isAbsolute(fname))
                                continue;
-                       if (file.exists() && !file.isDirectory()
+                       filepos.file = FileName(fname);
+                       if (filepos.file.exists() && !filepos.file.isDirectory()
                            && lastfilepos.size() < num_lastfilepos)
-                               lastfilepos[file] = filepos;
+                               lastfilepos.push_back(filepos);
                        else
                                LYXERR(Debug::INIT, "LyX: Warning: Ignore pos of last file: " << fname);
                } catch (...) {
@@ -182,26 +213,34 @@ void LastFilePosSection::read(istream & is)
 void LastFilePosSection::write(ostream & os) const
 {
        os << '\n' << sec_lastfilepos << '\n';
-       for (FilePosMap::const_iterator file = lastfilepos.begin();
-               file != lastfilepos.end(); ++file) {
-               os << file->second.pit << ", " << file->second.pos << ", "
-                  << file->first << '\n';
-       }
+       for (auto const & file_p : lastfilepos)
+               os << file_p.pit << ", " << file_p.pos << ", " << file_p.file << '\n';
 }
 
 
-void LastFilePosSection::save(FileName const & fname, FilePos const & pos)
+void LastFilePosSection::save(FilePos const & pos)
 {
-       lastfilepos[fname] = pos;
+       // Remove element if it was already present. Iterating should
+       // not be a problem since the list is small (<100 elements).
+       for (FilePosList::iterator it = lastfilepos.begin();
+            it != lastfilepos.end(); ++it)
+               if (it->file == pos.file) {
+                       lastfilepos.erase(it);
+                       break;
+               }
+
+       // insert new element at front.
+       lastfilepos.push_front(pos);
 }
 
 
 LastFilePosSection::FilePos LastFilePosSection::load(FileName const & fname) const
 {
-       FilePosMap::const_iterator entry = lastfilepos.find(fname);
-       // Has position information, return it.
-       if (entry != lastfilepos.end())
-               return entry->second;
+       for (auto const & fp : lastfilepos)
+               if (fp.file == fname)
+                       // Has position information, return it.
+                       return fp;
+
        // Not found, return the first paragraph
        return FilePos();
 }
@@ -241,11 +280,11 @@ void BookmarksSection::read(istream & is)
                        itmp >> pos;
                        itmp.ignore(2);  // ignore ", "
                        getline(itmp, fname);
-                       FileName const file(fname);
-                       if (!file.isAbsolute())
+                       if (!FileName::isAbsolute(fname))
                                continue;
+                       FileName const file(fname);
                        // only load valid bookmarks
-                       if (file.exists() && !file.isDirectory() && idx <= max_bookmarks)
+                       if (file.exists() && !file.isDirectory() && idx < bookmarks.size())
                                bookmarks[idx] = Bookmark(file, pit, pos, 0, 0);
                        else
                                LYXERR(Debug::INIT, "LyX: Warning: Ignore bookmark of file: " << fname);
@@ -259,7 +298,7 @@ void BookmarksSection::read(istream & is)
 void BookmarksSection::write(ostream & os) const
 {
        os << '\n' << sec_bookmarks << '\n';
-       for (size_t i = 1; i <= max_bookmarks; ++i) {
+       for (size_t i = 0; i < bookmarks.size(); ++i) {
                if (isValid(i))
                        os << i << ", "
                           << bookmarks[i].bottom_pit << ", "
@@ -274,114 +313,65 @@ void BookmarksSection::save(FileName const & fname,
        int top_id, pos_type top_pos, unsigned int idx)
 {
        // silently ignore bookmarks when idx is out of range
-       if (idx <= max_bookmarks)
+       if (idx < bookmarks.size())
                bookmarks[idx] = Bookmark(fname, bottom_pit, bottom_pos, top_id, top_pos);
 }
 
 
 bool BookmarksSection::isValid(unsigned int i) const
 {
-       return i <= max_bookmarks && !bookmarks[i].filename.empty();
+       return i < bookmarks.size() && !bookmarks[i].filename.empty();
 }
 
 
-BookmarksSection::Bookmark const & BookmarksSection::bookmark(unsigned int i) const
+bool BookmarksSection::hasValid() const
 {
-       return bookmarks[i];
+       for (size_t i = 1; i < bookmarks.size(); ++i) {
+               if (isValid(i))
+                       return true;
+       }
+       return false;
 }
 
 
-void ToolbarSection::read(istream & is)
+BookmarksSection::Bookmark const & BookmarksSection::bookmark(unsigned int i) const
 {
-       string tmp;
-       do {
-               char c = is.peek();
-               if (c == '[')
-                       break;
-               getline(is, tmp);
-               if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
-                       continue;
-
-               try {
-                       // Read session info, saved as key/value pairs
-                       // would better yell if pos returns npos
-                       size_t pos = tmp.find_first_of(" = ");
-                       // silently ignore lines without " = "
-                       if (pos != string::npos) {
-                               ToolbarItem item;
-                               item.key = tmp.substr(0, pos);
-                               int state;
-                               int location;
-                               istringstream value(tmp.substr(pos + 3));
-                               value >> state;
-                               value >> location;
-                               value >> item.info.posx;
-                               value >> item.info.posy;
-                               item.info.state = ToolbarInfo::State(state);
-                               item.info.location = ToolbarInfo::Location(location);
-                               toolbars.push_back(item);
-                       } else
-                               LYXERR(Debug::INIT, "LyX: Warning: Ignore toolbar info: " << tmp);
-               } catch (...) {
-                       LYXERR(Debug::INIT, "LyX: Warning: unknown Toolbar info: " << tmp);
-               }
-       } while (is.good());
-       // sort the toolbars by location, line and position
-       sort(toolbars.begin(), toolbars.end());
+       return bookmarks[i];
 }
 
 
-void ToolbarSection::write(ostream & os) const
+BookmarksSection::BookmarkPosList
+BookmarksSection::bookmarksInPar(FileName const & fn, int const par_id) const
 {
-       os << '\n' << sec_toolbars << '\n';
-       for (ToolbarList::const_iterator tb = toolbars.begin();
-               tb != toolbars.end(); ++tb) {
-               os << tb->key << " = "
-                 << static_cast<int>(tb->info.state) << " "
-                 << static_cast<int>(tb->info.location) << " "
-                 << tb->info.posx << " "
-                 << tb->info.posy << '\n';
-       }
+       // FIXME: we do not consider the case of bottom_pit.
+       // This is probably not a problem.
+       BookmarksSection::BookmarkPosList bip;
+       for (size_t i = 1; i < bookmarks.size(); ++i)
+               if (bookmarks[i].filename == fn && bookmarks[i].top_id == par_id)
+                       bip.push_back({i, bookmarks[i].top_pos});
+
+       return bip;
 }
 
 
-ToolbarSection::ToolbarInfo & ToolbarSection::load(string const & name)
+void BookmarksSection::adjustPosAfterPos(FileName const & fn,
+       int const par_id, pos_type pos, int offset)
 {
-       for (ToolbarList::iterator tb = toolbars.begin();
-               tb != toolbars.end(); ++tb)
-               if (tb->key == name)
-                       return tb->info;
-
-       // add a new item
-       ToolbarItem item;
-       item.key = name;
-       toolbars.push_back(item);
-       return toolbars.back().info;
+       for (Bookmark & bkm : bookmarks)
+               if (bkm.filename == fn && bkm.top_id == par_id && bkm.top_pos > pos)
+                       bkm.top_pos += offset;
 }
 
 
-bool operator<(ToolbarSection::ToolbarItem const & a, ToolbarSection::ToolbarItem const & b)
+LastCommandsSection::LastCommandsSection(unsigned int num) :
+       default_num_last_commands(30),
+       absolute_max_last_commands(100)
 {
-       ToolbarSection::ToolbarInfo lhs = a.info;
-       ToolbarSection::ToolbarInfo rhs = b.info;
-       // on if before off
-       if (lhs.state != rhs.state)
-               return static_cast<int>(lhs.state) < static_cast<int>(rhs.state);
-       // order of dock does not really matter
-       if (lhs.location != rhs.location)
-               return static_cast<int>(lhs.location) < static_cast<int>(rhs.location);
-       // if the same dock, the order depends on position
-       if (lhs.location == ToolbarSection::ToolbarInfo::TOP ||
-               lhs.location == ToolbarSection::ToolbarInfo::BOTTOM)
-               return lhs.posy < rhs.posy || (lhs.posy == rhs.posy && lhs.posx < rhs.posx);
-       else if (lhs.location == ToolbarSection::ToolbarInfo::LEFT ||
-               lhs.location == ToolbarSection::ToolbarInfo::RIGHT)
-               return lhs.posx < rhs.posx || (lhs.posx == rhs.posx && lhs.posy < rhs.posy);
-       return true;
+       setNumberOfLastCommands(num);
 }
 
 
-void SessionInfoSection::read(istream & is)
+void LastCommandsSection::read(istream & is)
 {
        string tmp;
        do {
@@ -392,58 +382,54 @@ void SessionInfoSection::read(istream & is)
                if (tmp == "" || tmp[0] == '#' || tmp[0] == ' ')
                        continue;
 
-               try {
-                       // Read session info, saved as key/value pairs
-                       // would better yell if pos returns npos
-                       string::size_type pos = tmp.find_first_of(" = ");
-                       // silently ignore lines without " = "
-                       if (pos != string::npos) {
-                               string key = tmp.substr(0, pos);
-                               string value = tmp.substr(pos + 3);
-                               sessioninfo[key] = value;
-                       } else
-                               LYXERR(Debug::INIT, "LyX: Warning: Ignore session info: " << tmp);
-               } catch (...) {
-                       LYXERR(Debug::INIT, "LyX: Warning: unknown Session info: " << tmp);
-               }
+               lastcommands.push_back(tmp);
        } while (is.good());
 }
 
 
-void SessionInfoSection::write(ostream & os) const
+void LastCommandsSection::write(ostream & os) const
+{
+       os << '\n' << sec_lastcommands << '\n';
+       copy(lastcommands.begin(), lastcommands.end(),
+               ostream_iterator<std::string>(os, "\n"));
+}
+
+
+void LastCommandsSection::setNumberOfLastCommands(unsigned int no)
 {
-       os << '\n' << sec_session << '\n';
-       for (MiscInfo::const_iterator val = sessioninfo.begin();
-               val != sessioninfo.end(); ++val) {
-               os << val->first << " = " << val->second << '\n';
+       if (0 < no && no <= absolute_max_last_commands)
+               num_lastcommands = no;
+       else {
+               LYXERR(Debug::INIT, "LyX: session: too many last commands\n"
+                       << "\tdefault (=" << default_num_last_commands << ") used.");
+               num_lastcommands = default_num_last_commands;
        }
 }
 
 
-void SessionInfoSection::save(string const & key, string const & value)
+void LastCommandsSection::add(std::string const & command)
 {
-       sessioninfo[key] = value;
+       // remove traces of 'command' in history using the erase-remove idiom
+       //   https://en.wikipedia.org/wiki/Erase%E2%80%93remove_idiom
+       lastcommands.erase(remove(lastcommands.begin(), lastcommands.end(), command),
+                          lastcommands.end());
+       // add it at the end of the list.
+       lastcommands.push_back(command);
 }
 
 
-string const SessionInfoSection::load(string const & key, bool release)
+void LastCommandsSection::clear()
 {
-       MiscInfo::const_iterator pos = sessioninfo.find(key);
-       string value;
-       if (pos != sessioninfo.end())
-               value = pos->second;
-       if (release)
-               sessioninfo.erase(key);
-       return value;
+       lastcommands.clear();
 }
 
 
-Session::Session(unsigned int num) :
-       last_files(num)
+Session::Session(unsigned int num_last_files, unsigned int num_last_commands) :
+       last_files(num_last_files), last_commands(num_last_commands)
 {
        // locate the session file
        // note that the session file name 'session' is hard-coded
-       session_file = FileName(addName(package().user_support().absFilename(), "session"));
+       session_file = FileName(addName(package().user_support().absFileName(), "session"));
        //
        readFile();
 }
@@ -470,10 +456,13 @@ void Session::readFile()
                        lastFilePos().read(is);
                else if (tmp == sec_bookmarks)
                        bookmarks().read(is);
-               else if (tmp == sec_toolbars)
-                       toolbars().read(is);
-               else if (tmp == sec_session)
-                       sessionInfo().read(is);
+               else if (tmp == sec_lastcommands)
+                       lastCommands().read(is);
+               else if (tmp == sec_authfiles)
+                       authFiles().read(is);
+               else if (tmp == sec_shellescape)
+                       shellescapeFiles().read(is);
+
                else
                        LYXERR(Debug::INIT, "LyX: Warning: unknown Session section: " << tmp);
        }
@@ -490,12 +479,132 @@ void Session::writeFile() const
                lastFiles().write(os);
                lastOpened().write(os);
                lastFilePos().write(os);
+               lastCommands().write(os);
                bookmarks().write(os);
-               toolbars().write(os);
-               sessionInfo().write(os);
+               authFiles().write(os);
+               shellescapeFiles().write(os);
        } else
                LYXERR(Debug::INIT, "LyX: Warning: unable to save Session: "
                       << session_file);
 }
 
+
+AuthFilesSection::AuthFilesSection() {  }
+
+
+void AuthFilesSection::read(istream & is)
+{
+       string tmp;
+       do {
+               char c = is.peek();
+               if (c == '[')
+                       break;
+               getline(is, tmp);
+               if (tmp.empty() || tmp[0] == '#' || tmp[0] == ' ' || !FileName::isAbsolute(tmp))
+                       continue;
+
+               // read lastfiles
+               FileName const file(tmp);
+               if (file.exists() && !file.isDirectory())
+                       auth_files_.insert(tmp);
+               else
+                       LYXERR(Debug::INIT, "LyX: Warning: Ignore auth file: " << tmp);
+       } while (is.good());
+}
+
+
+void AuthFilesSection::write(ostream & os) const
+{
+       os << '\n' << sec_authfiles << '\n';
+       copy(auth_files_.begin(), auth_files_.end(),
+            ostream_iterator<std::string>(os, "\n"));
 }
+
+
+bool AuthFilesSection::find(string const & name) const
+{
+       return auth_files_.find(name) != auth_files_.end();
+}
+
+
+void AuthFilesSection::insert(string const & name)
+{
+       auth_files_.insert(name);
+}
+
+
+void ShellEscapeSection::read(istream & is)
+{
+       string s;
+       do {
+               char c = is.peek();
+               if (c == '[')
+                       break;
+               getline(is, s);
+               if (s.empty() || s[0] == '#' || s[0] == ' ' || !FileName::isAbsolute(s))
+                       continue;
+
+               // read shellescape files
+               FileName const file(s.substr(0, s.length() - 2));
+               if (file.exists() && !file.isDirectory())
+                       shellescape_files_.insert(s);
+               else
+                       LYXERR(Debug::INIT, "LyX: Warning: Ignore shellescape file: " << file);
+       } while (is.good());
+}
+
+
+void ShellEscapeSection::write(ostream & os) const
+{
+       os << '\n' << sec_shellescape << '\n';
+       copy(shellescape_files_.begin(), shellescape_files_.end(),
+            ostream_iterator<std::string>(os, "\n"));
+}
+
+
+bool ShellEscapeSection::find(string const & name) const
+{
+       if (shellescape_files_.find(name + ",0") != shellescape_files_.end())
+               return true;
+
+       return findAuth(name);
+}
+
+
+bool ShellEscapeSection::findAuth(string const & name) const
+{
+       return shellescape_files_.find(name + ",1") != shellescape_files_.end();
+}
+
+
+void ShellEscapeSection::insert(string const & name, bool auth)
+{
+       set<string>::iterator it;
+       string const name0 = name + ",0";
+       string const name1 = name + ",1";
+
+       if (auth) {
+               it = shellescape_files_.find(name0);
+               if (it != shellescape_files_.end())
+                       shellescape_files_.erase(it);
+               shellescape_files_.insert(name1);
+       } else {
+               it = shellescape_files_.find(name1);
+               if (it != shellescape_files_.end())
+                       shellescape_files_.erase(it);
+               shellescape_files_.insert(name0);
+       }
+}
+
+
+void ShellEscapeSection::remove(string const & name)
+{
+       set<string>::iterator it = shellescape_files_.find(name + ",0");
+       if (it == shellescape_files_.end())
+               it = shellescape_files_.find(name + ",1");
+       if (it != shellescape_files_.end())
+               shellescape_files_.erase(it);
+}
+
+
+} // namespace lyx