patch 8.1.1766: code for writing session file is spread out
Problem: Code for writing session file is spread out.
Solution: Put it in one file. (Yegappan Lakshmanan, closes #4728)
diff --git a/src/session.c b/src/session.c
new file mode 100644
index 0000000..aa95be1
--- /dev/null
+++ b/src/session.c
@@ -0,0 +1,1346 @@
+/* vi:set ts=8 sts=4 sw=4 noet:
+ *
+ * VIM - Vi IMproved by Bram Moolenaar
+ *
+ * Do ":help uganda" in Vim to read copying and usage conditions.
+ * Do ":help credits" in Vim to see a list of people who contributed.
+ * See README.txt for an overview of the Vim source code.
+ */
+
+/*
+ * session.c: session related functions
+ */
+
+#include "vim.h"
+
+#if defined(FEAT_SESSION) || defined(PROTO)
+
+static int did_lcd; // whether ":lcd" was produced for a session
+
+/*
+ * Write a file name to the session file.
+ * Takes care of the "slash" option in 'sessionoptions' and escapes special
+ * characters.
+ * Returns FAIL if writing fails or out of memory.
+ */
+ static int
+ses_put_fname(FILE *fd, char_u *name, unsigned *flagp)
+{
+ char_u *sname;
+ char_u *p;
+ int retval = OK;
+
+ sname = home_replace_save(NULL, name);
+ if (sname == NULL)
+ return FAIL;
+
+ if (*flagp & SSOP_SLASH)
+ {
+ // change all backslashes to forward slashes
+ for (p = sname; *p != NUL; MB_PTR_ADV(p))
+ if (*p == '\\')
+ *p = '/';
+ }
+
+ // escape special characters
+ p = vim_strsave_fnameescape(sname, FALSE);
+ vim_free(sname);
+ if (p == NULL)
+ return FAIL;
+
+ // write the result
+ if (fputs((char *)p, fd) < 0)
+ retval = FAIL;
+
+ vim_free(p);
+ return retval;
+}
+
+/*
+ * Write a buffer name to the session file.
+ * Also ends the line, if "add_eol" is TRUE.
+ * Returns FAIL if writing fails.
+ */
+ static int
+ses_fname(FILE *fd, buf_T *buf, unsigned *flagp, int add_eol)
+{
+ char_u *name;
+
+ // Use the short file name if the current directory is known at the time
+ // the session file will be sourced.
+ // Don't do this for ":mkview", we don't know the current directory.
+ // Don't do this after ":lcd", we don't keep track of what the current
+ // directory is.
+ if (buf->b_sfname != NULL
+ && flagp == &ssop_flags
+ && (ssop_flags & (SSOP_CURDIR | SSOP_SESDIR))
+#ifdef FEAT_AUTOCHDIR
+ && !p_acd
+#endif
+ && !did_lcd)
+ name = buf->b_sfname;
+ else
+ name = buf->b_ffname;
+ if (ses_put_fname(fd, name, flagp) == FAIL
+ || (add_eol && put_eol(fd) == FAIL))
+ return FAIL;
+ return OK;
+}
+
+/*
+ * Write an argument list to the session file.
+ * Returns FAIL if writing fails.
+ */
+ static int
+ses_arglist(
+ FILE *fd,
+ char *cmd,
+ garray_T *gap,
+ int fullname, // TRUE: use full path name
+ unsigned *flagp)
+{
+ int i;
+ char_u *buf = NULL;
+ char_u *s;
+
+ if (fputs(cmd, fd) < 0 || put_eol(fd) == FAIL)
+ return FAIL;
+ if (put_line(fd, "%argdel") == FAIL)
+ return FAIL;
+ for (i = 0; i < gap->ga_len; ++i)
+ {
+ // NULL file names are skipped (only happens when out of memory).
+ s = alist_name(&((aentry_T *)gap->ga_data)[i]);
+ if (s != NULL)
+ {
+ if (fullname)
+ {
+ buf = alloc(MAXPATHL);
+ if (buf != NULL)
+ {
+ (void)vim_FullName(s, buf, MAXPATHL, FALSE);
+ s = buf;
+ }
+ }
+ if (fputs("$argadd ", fd) < 0
+ || ses_put_fname(fd, s, flagp) == FAIL
+ || put_eol(fd) == FAIL)
+ {
+ vim_free(buf);
+ return FAIL;
+ }
+ vim_free(buf);
+ }
+ }
+ return OK;
+}
+
+/*
+ * Return non-zero if window "wp" is to be stored in the Session.
+ */
+ static int
+ses_do_win(win_T *wp)
+{
+#ifdef FEAT_TERMINAL
+ if (bt_terminal(wp->w_buffer))
+ return !term_is_finished(wp->w_buffer)
+ && (ssop_flags & SSOP_TERMINAL)
+ && term_should_restore(wp->w_buffer);
+#endif
+ if (wp->w_buffer->b_fname == NULL
+#ifdef FEAT_QUICKFIX
+ // When 'buftype' is "nofile" can't restore the window contents.
+ || bt_nofilename(wp->w_buffer)
+#endif
+ )
+ return (ssop_flags & SSOP_BLANK);
+ if (bt_help(wp->w_buffer))
+ return (ssop_flags & SSOP_HELP);
+ return TRUE;
+}
+
+/*
+ * Return TRUE if frame "fr" has a window somewhere that we want to save in
+ * the Session.
+ */
+ static int
+ses_do_frame(frame_T *fr)
+{
+ frame_T *frc;
+
+ if (fr->fr_layout == FR_LEAF)
+ return ses_do_win(fr->fr_win);
+ FOR_ALL_FRAMES(frc, fr->fr_child)
+ if (ses_do_frame(frc))
+ return TRUE;
+ return FALSE;
+}
+
+/*
+ * Skip frames that don't contain windows we want to save in the Session.
+ * Returns NULL when there none.
+ */
+ static frame_T *
+ses_skipframe(frame_T *fr)
+{
+ frame_T *frc;
+
+ FOR_ALL_FRAMES(frc, fr)
+ if (ses_do_frame(frc))
+ break;
+ return frc;
+}
+
+/*
+ * Write commands to "fd" to recursively create windows for frame "fr",
+ * horizontally and vertically split.
+ * After the commands the last window in the frame is the current window.
+ * Returns FAIL when writing the commands to "fd" fails.
+ */
+ static int
+ses_win_rec(FILE *fd, frame_T *fr)
+{
+ frame_T *frc;
+ int count = 0;
+
+ if (fr->fr_layout != FR_LEAF)
+ {
+ // Find first frame that's not skipped and then create a window for
+ // each following one (first frame is already there).
+ frc = ses_skipframe(fr->fr_child);
+ if (frc != NULL)
+ while ((frc = ses_skipframe(frc->fr_next)) != NULL)
+ {
+ // Make window as big as possible so that we have lots of room
+ // to split.
+ if (put_line(fd, "wincmd _ | wincmd |") == FAIL
+ || put_line(fd, fr->fr_layout == FR_COL
+ ? "split" : "vsplit") == FAIL)
+ return FAIL;
+ ++count;
+ }
+
+ // Go back to the first window.
+ if (count > 0 && (fprintf(fd, fr->fr_layout == FR_COL
+ ? "%dwincmd k" : "%dwincmd h", count) < 0
+ || put_eol(fd) == FAIL))
+ return FAIL;
+
+ // Recursively create frames/windows in each window of this column or
+ // row.
+ frc = ses_skipframe(fr->fr_child);
+ while (frc != NULL)
+ {
+ ses_win_rec(fd, frc);
+ frc = ses_skipframe(frc->fr_next);
+ // Go to next window.
+ if (frc != NULL && put_line(fd, "wincmd w") == FAIL)
+ return FAIL;
+ }
+ }
+ return OK;
+}
+
+ static int
+ses_winsizes(
+ FILE *fd,
+ int restore_size,
+ win_T *tab_firstwin)
+{
+ int n = 0;
+ win_T *wp;
+
+ if (restore_size && (ssop_flags & SSOP_WINSIZE))
+ {
+ for (wp = tab_firstwin; wp != NULL; wp = wp->w_next)
+ {
+ if (!ses_do_win(wp))
+ continue;
+ ++n;
+
+ // restore height when not full height
+ if (wp->w_height + wp->w_status_height < topframe->fr_height
+ && (fprintf(fd,
+ "exe '%dresize ' . ((&lines * %ld + %ld) / %ld)",
+ n, (long)wp->w_height, Rows / 2, Rows) < 0
+ || put_eol(fd) == FAIL))
+ return FAIL;
+
+ // restore width when not full width
+ if (wp->w_width < Columns && (fprintf(fd,
+ "exe 'vert %dresize ' . ((&columns * %ld + %ld) / %ld)",
+ n, (long)wp->w_width, Columns / 2, Columns) < 0
+ || put_eol(fd) == FAIL))
+ return FAIL;
+ }
+ }
+ else
+ {
+ // Just equalise window sizes
+ if (put_line(fd, "wincmd =") == FAIL)
+ return FAIL;
+ }
+ return OK;
+}
+
+ static int
+put_view_curpos(FILE *fd, win_T *wp, char *spaces)
+{
+ int r;
+
+ if (wp->w_curswant == MAXCOL)
+ r = fprintf(fd, "%snormal! $", spaces);
+ else
+ r = fprintf(fd, "%snormal! 0%d|", spaces, wp->w_virtcol + 1);
+ return r < 0 || put_eol(fd) == FAIL ? FALSE : OK;
+}
+
+/*
+ * Write commands to "fd" to restore the view of a window.
+ * Caller must make sure 'scrolloff' is zero.
+ */
+ static int
+put_view(
+ FILE *fd,
+ win_T *wp,
+ int add_edit, // add ":edit" command to view
+ unsigned *flagp, // vop_flags or ssop_flags
+ int current_arg_idx) // current argument index of the window, use
+ // -1 if unknown
+{
+ win_T *save_curwin;
+ int f;
+ int do_cursor;
+ int did_next = FALSE;
+
+ // Always restore cursor position for ":mksession". For ":mkview" only
+ // when 'viewoptions' contains "cursor".
+ do_cursor = (flagp == &ssop_flags || *flagp & SSOP_CURSOR);
+
+ // Local argument list.
+ if (wp->w_alist == &global_alist)
+ {
+ if (put_line(fd, "argglobal") == FAIL)
+ return FAIL;
+ }
+ else
+ {
+ if (ses_arglist(fd, "arglocal", &wp->w_alist->al_ga,
+ flagp == &vop_flags
+ || !(*flagp & SSOP_CURDIR)
+ || wp->w_localdir != NULL, flagp) == FAIL)
+ return FAIL;
+ }
+
+ // Only when part of a session: restore the argument index. Some
+ // arguments may have been deleted, check if the index is valid.
+ if (wp->w_arg_idx != current_arg_idx && wp->w_arg_idx < WARGCOUNT(wp)
+ && flagp == &ssop_flags)
+ {
+ if (fprintf(fd, "%ldargu", (long)wp->w_arg_idx + 1) < 0
+ || put_eol(fd) == FAIL)
+ return FAIL;
+ did_next = TRUE;
+ }
+
+ // Edit the file. Skip this when ":next" already did it.
+ if (add_edit && (!did_next || wp->w_arg_idx_invalid))
+ {
+# ifdef FEAT_TERMINAL
+ if (bt_terminal(wp->w_buffer))
+ {
+ if (term_write_session(fd, wp) == FAIL)
+ return FAIL;
+ }
+ else
+# endif
+ // Load the file.
+ if (wp->w_buffer->b_ffname != NULL
+# ifdef FEAT_QUICKFIX
+ && !bt_nofilename(wp->w_buffer)
+# endif
+ )
+ {
+ // Editing a file in this buffer: use ":edit file".
+ // This may have side effects! (e.g., compressed or network file).
+ //
+ // Note, if a buffer for that file already exists, use :badd to
+ // edit that buffer, to not lose folding information (:edit resets
+ // folds in other buffers)
+ if (fputs("if bufexists(\"", fd) < 0
+ || ses_fname(fd, wp->w_buffer, flagp, FALSE) == FAIL
+ || fputs("\") | buffer ", fd) < 0
+ || ses_fname(fd, wp->w_buffer, flagp, FALSE) == FAIL
+ || fputs(" | else | edit ", fd) < 0
+ || ses_fname(fd, wp->w_buffer, flagp, FALSE) == FAIL
+ || fputs(" | endif", fd) < 0
+ || put_eol(fd) == FAIL)
+ return FAIL;
+ }
+ else
+ {
+ // No file in this buffer, just make it empty.
+ if (put_line(fd, "enew") == FAIL)
+ return FAIL;
+#ifdef FEAT_QUICKFIX
+ if (wp->w_buffer->b_ffname != NULL)
+ {
+ // The buffer does have a name, but it's not a file name.
+ if (fputs("file ", fd) < 0
+ || ses_fname(fd, wp->w_buffer, flagp, TRUE) == FAIL)
+ return FAIL;
+ }
+#endif
+ do_cursor = FALSE;
+ }
+ }
+
+ // Local mappings and abbreviations.
+ if ((*flagp & (SSOP_OPTIONS | SSOP_LOCALOPTIONS))
+ && makemap(fd, wp->w_buffer) == FAIL)
+ return FAIL;
+
+ // Local options. Need to go to the window temporarily.
+ // Store only local values when using ":mkview" and when ":mksession" is
+ // used and 'sessionoptions' doesn't include "options".
+ // Some folding options are always stored when "folds" is included,
+ // otherwise the folds would not be restored correctly.
+ save_curwin = curwin;
+ curwin = wp;
+ curbuf = curwin->w_buffer;
+ if (*flagp & (SSOP_OPTIONS | SSOP_LOCALOPTIONS))
+ f = makeset(fd, OPT_LOCAL,
+ flagp == &vop_flags || !(*flagp & SSOP_OPTIONS));
+#ifdef FEAT_FOLDING
+ else if (*flagp & SSOP_FOLDS)
+ f = makefoldset(fd);
+#endif
+ else
+ f = OK;
+ curwin = save_curwin;
+ curbuf = curwin->w_buffer;
+ if (f == FAIL)
+ return FAIL;
+
+#ifdef FEAT_FOLDING
+ // Save Folds when 'buftype' is empty and for help files.
+ if ((*flagp & SSOP_FOLDS)
+ && wp->w_buffer->b_ffname != NULL
+ && (bt_normal(wp->w_buffer) || bt_help(wp->w_buffer)))
+ {
+ if (put_folds(fd, wp) == FAIL)
+ return FAIL;
+ }
+#endif
+
+ // Set the cursor after creating folds, since that moves the cursor.
+ if (do_cursor)
+ {
+
+ // Restore the cursor line in the file and relatively in the
+ // window. Don't use "G", it changes the jumplist.
+ if (fprintf(fd, "let s:l = %ld - ((%ld * winheight(0) + %ld) / %ld)",
+ (long)wp->w_cursor.lnum,
+ (long)(wp->w_cursor.lnum - wp->w_topline),
+ (long)wp->w_height / 2, (long)wp->w_height) < 0
+ || put_eol(fd) == FAIL
+ || put_line(fd, "if s:l < 1 | let s:l = 1 | endif") == FAIL
+ || put_line(fd, "exe s:l") == FAIL
+ || put_line(fd, "normal! zt") == FAIL
+ || fprintf(fd, "%ld", (long)wp->w_cursor.lnum) < 0
+ || put_eol(fd) == FAIL)
+ return FAIL;
+ // Restore the cursor column and left offset when not wrapping.
+ if (wp->w_cursor.col == 0)
+ {
+ if (put_line(fd, "normal! 0") == FAIL)
+ return FAIL;
+ }
+ else
+ {
+ if (!wp->w_p_wrap && wp->w_leftcol > 0 && wp->w_width > 0)
+ {
+ if (fprintf(fd,
+ "let s:c = %ld - ((%ld * winwidth(0) + %ld) / %ld)",
+ (long)wp->w_virtcol + 1,
+ (long)(wp->w_virtcol - wp->w_leftcol),
+ (long)wp->w_width / 2, (long)wp->w_width) < 0
+ || put_eol(fd) == FAIL
+ || put_line(fd, "if s:c > 0") == FAIL
+ || fprintf(fd,
+ " exe 'normal! ' . s:c . '|zs' . %ld . '|'",
+ (long)wp->w_virtcol + 1) < 0
+ || put_eol(fd) == FAIL
+ || put_line(fd, "else") == FAIL
+ || put_view_curpos(fd, wp, " ") == FAIL
+ || put_line(fd, "endif") == FAIL)
+ return FAIL;
+ }
+ else if (put_view_curpos(fd, wp, "") == FAIL)
+ return FAIL;
+ }
+ }
+
+ // Local directory, if the current flag is not view options or the "curdir"
+ // option is included.
+ if (wp->w_localdir != NULL
+ && (flagp != &vop_flags || (*flagp & SSOP_CURDIR)))
+ {
+ if (fputs("lcd ", fd) < 0
+ || ses_put_fname(fd, wp->w_localdir, flagp) == FAIL
+ || put_eol(fd) == FAIL)
+ return FAIL;
+ did_lcd = TRUE;
+ }
+
+ return OK;
+}
+
+#ifdef FEAT_EVAL
+ static int
+store_session_globals(FILE *fd)
+{
+ hashitem_T *hi;
+ dictitem_T *this_var;
+ int todo;
+ char_u *p, *t;
+
+ todo = (int)globvarht.ht_used;
+ for (hi = globvarht.ht_array; todo > 0; ++hi)
+ {
+ if (!HASHITEM_EMPTY(hi))
+ {
+ --todo;
+ this_var = HI2DI(hi);
+ if ((this_var->di_tv.v_type == VAR_NUMBER
+ || this_var->di_tv.v_type == VAR_STRING)
+ && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
+ {
+ // Escape special characters with a backslash. Turn a LF and
+ // CR into \n and \r.
+ p = vim_strsave_escaped(tv_get_string(&this_var->di_tv),
+ (char_u *)"\\\"\n\r");
+ if (p == NULL) // out of memory
+ break;
+ for (t = p; *t != NUL; ++t)
+ if (*t == '\n')
+ *t = 'n';
+ else if (*t == '\r')
+ *t = 'r';
+ if ((fprintf(fd, "let %s = %c%s%c",
+ this_var->di_key,
+ (this_var->di_tv.v_type == VAR_STRING) ? '"'
+ : ' ',
+ p,
+ (this_var->di_tv.v_type == VAR_STRING) ? '"'
+ : ' ') < 0)
+ || put_eol(fd) == FAIL)
+ {
+ vim_free(p);
+ return FAIL;
+ }
+ vim_free(p);
+ }
+#ifdef FEAT_FLOAT
+ else if (this_var->di_tv.v_type == VAR_FLOAT
+ && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
+ {
+ float_T f = this_var->di_tv.vval.v_float;
+ int sign = ' ';
+
+ if (f < 0)
+ {
+ f = -f;
+ sign = '-';
+ }
+ if ((fprintf(fd, "let %s = %c%f",
+ this_var->di_key, sign, f) < 0)
+ || put_eol(fd) == FAIL)
+ return FAIL;
+ }
+#endif
+ }
+ }
+ return OK;
+}
+#endif
+
+/*
+ * Write openfile commands for the current buffers to an .exrc file.
+ * Return FAIL on error, OK otherwise.
+ */
+ static int
+makeopens(
+ FILE *fd,
+ char_u *dirnow) // Current directory name
+{
+ buf_T *buf;
+ int only_save_windows = TRUE;
+ int nr;
+ int restore_size = TRUE;
+ win_T *wp;
+ char_u *sname;
+ win_T *edited_win = NULL;
+ int tabnr;
+ int restore_stal = FALSE;
+ win_T *tab_firstwin;
+ frame_T *tab_topframe;
+ int cur_arg_idx = 0;
+ int next_arg_idx = 0;
+
+ if (ssop_flags & SSOP_BUFFERS)
+ only_save_windows = FALSE; // Save ALL buffers
+
+ // Begin by setting the this_session variable, and then other
+ // sessionable variables.
+#ifdef FEAT_EVAL
+ if (put_line(fd, "let v:this_session=expand(\"<sfile>:p\")") == FAIL)
+ return FAIL;
+ if (ssop_flags & SSOP_GLOBALS)
+ if (store_session_globals(fd) == FAIL)
+ return FAIL;
+#endif
+
+ // Close all windows and tabs but one.
+ if (put_line(fd, "silent only") == FAIL)
+ return FAIL;
+ if ((ssop_flags & SSOP_TABPAGES)
+ && put_line(fd, "silent tabonly") == FAIL)
+ return FAIL;
+
+ // Now a :cd command to the session directory or the current directory
+ if (ssop_flags & SSOP_SESDIR)
+ {
+ if (put_line(fd, "exe \"cd \" . escape(expand(\"<sfile>:p:h\"), ' ')")
+ == FAIL)
+ return FAIL;
+ }
+ else if (ssop_flags & SSOP_CURDIR)
+ {
+ sname = home_replace_save(NULL, globaldir != NULL ? globaldir : dirnow);
+ if (sname == NULL
+ || fputs("cd ", fd) < 0
+ || ses_put_fname(fd, sname, &ssop_flags) == FAIL
+ || put_eol(fd) == FAIL)
+ {
+ vim_free(sname);
+ return FAIL;
+ }
+ vim_free(sname);
+ }
+
+ // If there is an empty, unnamed buffer we will wipe it out later.
+ // Remember the buffer number.
+ if (put_line(fd, "if expand('%') == '' && !&modified && line('$') <= 1 && getline(1) == ''") == FAIL)
+ return FAIL;
+ if (put_line(fd, " let s:wipebuf = bufnr('%')") == FAIL)
+ return FAIL;
+ if (put_line(fd, "endif") == FAIL)
+ return FAIL;
+
+ // Now save the current files, current buffer first.
+ if (put_line(fd, "set shortmess=aoO") == FAIL)
+ return FAIL;
+
+ // the global argument list
+ if (ses_arglist(fd, "argglobal", &global_alist.al_ga,
+ !(ssop_flags & SSOP_CURDIR), &ssop_flags) == FAIL)
+ return FAIL;
+
+ if (ssop_flags & SSOP_RESIZE)
+ {
+ // Note: after the restore we still check it worked!
+ if (fprintf(fd, "set lines=%ld columns=%ld" , Rows, Columns) < 0
+ || put_eol(fd) == FAIL)
+ return FAIL;
+ }
+
+#ifdef FEAT_GUI
+ if (gui.in_use && (ssop_flags & SSOP_WINPOS))
+ {
+ int x, y;
+
+ if (gui_mch_get_winpos(&x, &y) == OK)
+ {
+ // Note: after the restore we still check it worked!
+ if (fprintf(fd, "winpos %d %d", x, y) < 0 || put_eol(fd) == FAIL)
+ return FAIL;
+ }
+ }
+#endif
+
+ // When there are two or more tabpages and 'showtabline' is 1 the tabline
+ // will be displayed when creating the next tab. That resizes the windows
+ // in the first tab, which may cause problems. Set 'showtabline' to 2
+ // temporarily to avoid that.
+ if (p_stal == 1 && first_tabpage->tp_next != NULL)
+ {
+ if (put_line(fd, "set stal=2") == FAIL)
+ return FAIL;
+ restore_stal = TRUE;
+ }
+
+ // May repeat putting Windows for each tab, when "tabpages" is in
+ // 'sessionoptions'.
+ // Don't use goto_tabpage(), it may change directory and trigger
+ // autocommands.
+ tab_firstwin = firstwin; // first window in tab page "tabnr"
+ tab_topframe = topframe;
+ if ((ssop_flags & SSOP_TABPAGES))
+ {
+ tabpage_T *tp;
+
+ // Similar to ses_win_rec() below, populate the tab pages first so
+ // later local options won't be copied to the new tabs.
+ FOR_ALL_TABPAGES(tp)
+ if (tp->tp_next != NULL && put_line(fd, "tabnew") == FAIL)
+ return FAIL;
+ if (first_tabpage->tp_next != NULL && put_line(fd, "tabrewind") == FAIL)
+ return FAIL;
+ }
+ for (tabnr = 1; ; ++tabnr)
+ {
+ tabpage_T *tp = NULL;
+ int need_tabnext = FALSE;
+ int cnr = 1;
+
+ if ((ssop_flags & SSOP_TABPAGES))
+ {
+ tp = find_tabpage(tabnr);
+
+ if (tp == NULL)
+ break; // done all tab pages
+ if (tp == curtab)
+ {
+ tab_firstwin = firstwin;
+ tab_topframe = topframe;
+ }
+ else
+ {
+ tab_firstwin = tp->tp_firstwin;
+ tab_topframe = tp->tp_topframe;
+ }
+ if (tabnr > 1)
+ need_tabnext = TRUE;
+ }
+
+ // Before creating the window layout, try loading one file. If this
+ // is aborted we don't end up with a number of useless windows.
+ // This may have side effects! (e.g., compressed or network file).
+ for (wp = tab_firstwin; wp != NULL; wp = wp->w_next)
+ {
+ if (ses_do_win(wp)
+ && wp->w_buffer->b_ffname != NULL
+ && !bt_help(wp->w_buffer)
+#ifdef FEAT_QUICKFIX
+ && !bt_nofilename(wp->w_buffer)
+#endif
+ )
+ {
+ if (need_tabnext && put_line(fd, "tabnext") == FAIL)
+ return FAIL;
+ need_tabnext = FALSE;
+
+ if (fputs("edit ", fd) < 0
+ || ses_fname(fd, wp->w_buffer, &ssop_flags, TRUE)
+ == FAIL)
+ return FAIL;
+ if (!wp->w_arg_idx_invalid)
+ edited_win = wp;
+ break;
+ }
+ }
+
+ // If no file got edited create an empty tab page.
+ if (need_tabnext && put_line(fd, "tabnext") == FAIL)
+ return FAIL;
+
+ // Save current window layout.
+ if (put_line(fd, "set splitbelow splitright") == FAIL)
+ return FAIL;
+ if (ses_win_rec(fd, tab_topframe) == FAIL)
+ return FAIL;
+ if (!p_sb && put_line(fd, "set nosplitbelow") == FAIL)
+ return FAIL;
+ if (!p_spr && put_line(fd, "set nosplitright") == FAIL)
+ return FAIL;
+
+ // Check if window sizes can be restored (no windows omitted).
+ // Remember the window number of the current window after restoring.
+ nr = 0;
+ for (wp = tab_firstwin; wp != NULL; wp = W_NEXT(wp))
+ {
+ if (ses_do_win(wp))
+ ++nr;
+ else
+ restore_size = FALSE;
+ if (curwin == wp)
+ cnr = nr;
+ }
+
+ // Go to the first window.
+ if (put_line(fd, "wincmd t") == FAIL)
+ return FAIL;
+
+ // If more than one window, see if sizes can be restored.
+ // First set 'winheight' and 'winwidth' to 1 to avoid the windows being
+ // resized when moving between windows.
+ // Do this before restoring the view, so that the topline and the
+ // cursor can be set. This is done again below.
+ // winminheight and winminwidth need to be set to avoid an error if the
+ // user has set winheight or winwidth.
+ if (put_line(fd, "set winminheight=0") == FAIL
+ || put_line(fd, "set winheight=1") == FAIL
+ || put_line(fd, "set winminwidth=0") == FAIL
+ || put_line(fd, "set winwidth=1") == FAIL)
+ return FAIL;
+ if (nr > 1 && ses_winsizes(fd, restore_size, tab_firstwin) == FAIL)
+ return FAIL;
+
+ // Restore the tab-local working directory if specified
+ // Do this before the windows, so that the window-local directory can
+ // override the tab-local directory.
+ if (tp != NULL && tp->tp_localdir != NULL && ssop_flags & SSOP_CURDIR)
+ {
+ if (fputs("tcd ", fd) < 0
+ || ses_put_fname(fd, tp->tp_localdir, &ssop_flags) == FAIL
+ || put_eol(fd) == FAIL)
+ return FAIL;
+ did_lcd = TRUE;
+ }
+
+ // Restore the view of the window (options, file, cursor, etc.).
+ for (wp = tab_firstwin; wp != NULL; wp = wp->w_next)
+ {
+ if (!ses_do_win(wp))
+ continue;
+ if (put_view(fd, wp, wp != edited_win, &ssop_flags,
+ cur_arg_idx) == FAIL)
+ return FAIL;
+ if (nr > 1 && put_line(fd, "wincmd w") == FAIL)
+ return FAIL;
+ next_arg_idx = wp->w_arg_idx;
+ }
+
+ // The argument index in the first tab page is zero, need to set it in
+ // each window. For further tab pages it's the window where we do
+ // "tabedit".
+ cur_arg_idx = next_arg_idx;
+
+ // Restore cursor to the current window if it's not the first one.
+ if (cnr > 1 && (fprintf(fd, "%dwincmd w", cnr) < 0
+ || put_eol(fd) == FAIL))
+ return FAIL;
+
+ // Restore window sizes again after jumping around in windows, because
+ // the current window has a minimum size while others may not.
+ if (nr > 1 && ses_winsizes(fd, restore_size, tab_firstwin) == FAIL)
+ return FAIL;
+
+ // Don't continue in another tab page when doing only the current one
+ // or when at the last tab page.
+ if (!(ssop_flags & SSOP_TABPAGES))
+ break;
+ }
+
+ if (ssop_flags & SSOP_TABPAGES)
+ {
+ if (fprintf(fd, "tabnext %d", tabpage_index(curtab)) < 0
+ || put_eol(fd) == FAIL)
+ return FAIL;
+ }
+ if (restore_stal && put_line(fd, "set stal=1") == FAIL)
+ return FAIL;
+
+ // Now put the remaining buffers into the buffer list.
+ // This is near the end, so that when 'hidden' is set we don't create extra
+ // buffers. If the buffer was already created with another command the
+ // ":badd" will have no effect.
+ FOR_ALL_BUFFERS(buf)
+ {
+ if (!(only_save_windows && buf->b_nwindows == 0)
+ && !(buf->b_help && !(ssop_flags & SSOP_HELP))
+#ifdef FEAT_TERMINAL
+ // Skip terminal buffers: finished ones are not useful, others
+ // will be resurrected and result in a new buffer.
+ && !bt_terminal(buf)
+#endif
+ && buf->b_fname != NULL
+ && buf->b_p_bl)
+ {
+ if (fprintf(fd, "badd +%ld ", buf->b_wininfo == NULL ? 1L
+ : buf->b_wininfo->wi_fpos.lnum) < 0
+ || ses_fname(fd, buf, &ssop_flags, TRUE) == FAIL)
+ return FAIL;
+ }
+ }
+
+ // Wipe out an empty unnamed buffer we started in.
+ if (put_line(fd, "if exists('s:wipebuf') && len(win_findbuf(s:wipebuf)) == 0")
+ == FAIL)
+ return FAIL;
+ if (put_line(fd, " silent exe 'bwipe ' . s:wipebuf") == FAIL)
+ return FAIL;
+ if (put_line(fd, "endif") == FAIL)
+ return FAIL;
+ if (put_line(fd, "unlet! s:wipebuf") == FAIL)
+ return FAIL;
+
+ // Re-apply 'winheight', 'winwidth' and 'shortmess'.
+ if (fprintf(fd, "set winheight=%ld winwidth=%ld shortmess=%s",
+ p_wh, p_wiw, p_shm) < 0 || put_eol(fd) == FAIL)
+ return FAIL;
+ // Re-apply 'winminheight' and 'winminwidth'.
+ if (fprintf(fd, "set winminheight=%ld winminwidth=%ld",
+ p_wmh, p_wmw) < 0 || put_eol(fd) == FAIL)
+ return FAIL;
+
+ // Lastly, execute the x.vim file if it exists.
+ if (put_line(fd, "let s:sx = expand(\"<sfile>:p:r\").\"x.vim\"") == FAIL
+ || put_line(fd, "if file_readable(s:sx)") == FAIL
+ || put_line(fd, " exe \"source \" . fnameescape(s:sx)") == FAIL
+ || put_line(fd, "endif") == FAIL)
+ return FAIL;
+
+ return OK;
+}
+
+/*
+ * Get the name of the view file for the current buffer.
+ */
+ static char_u *
+get_view_file(int c)
+{
+ int len = 0;
+ char_u *p, *s;
+ char_u *retval;
+ char_u *sname;
+
+ if (curbuf->b_ffname == NULL)
+ {
+ emsg(_(e_noname));
+ return NULL;
+ }
+ sname = home_replace_save(NULL, curbuf->b_ffname);
+ if (sname == NULL)
+ return NULL;
+
+ // We want a file name without separators, because we're not going to make
+ // a directory.
+ // "normal" path separator -> "=+"
+ // "=" -> "=="
+ // ":" path separator -> "=-"
+ for (p = sname; *p; ++p)
+ if (*p == '=' || vim_ispathsep(*p))
+ ++len;
+ retval = alloc(STRLEN(sname) + len + STRLEN(p_vdir) + 9);
+ if (retval != NULL)
+ {
+ STRCPY(retval, p_vdir);
+ add_pathsep(retval);
+ s = retval + STRLEN(retval);
+ for (p = sname; *p; ++p)
+ {
+ if (*p == '=')
+ {
+ *s++ = '=';
+ *s++ = '=';
+ }
+ else if (vim_ispathsep(*p))
+ {
+ *s++ = '=';
+#if defined(BACKSLASH_IN_FILENAME) || defined(AMIGA) || defined(VMS)
+ if (*p == ':')
+ *s++ = '-';
+ else
+#endif
+ *s++ = '+';
+ }
+ else
+ *s++ = *p;
+ }
+ *s++ = '=';
+ *s++ = c;
+ STRCPY(s, ".vim");
+ }
+
+ vim_free(sname);
+ return retval;
+}
+
+/*
+ * ":loadview [nr]"
+ */
+ void
+ex_loadview(exarg_T *eap)
+{
+ char_u *fname;
+
+ fname = get_view_file(*eap->arg);
+ if (fname != NULL)
+ {
+ do_source(fname, FALSE, DOSO_NONE);
+ vim_free(fname);
+ }
+}
+
+#if defined(FEAT_GUI) || defined(PROTO)
+/*
+ * Generate a script that can be used to restore the current editing session.
+ * Save the value of v:this_session before running :mksession in order to make
+ * automagic session save fully transparent. Return TRUE on success.
+ */
+ int
+write_session_file(char_u *filename)
+{
+ char_u *escaped_filename;
+ char *mksession_cmdline;
+ unsigned int save_ssop_flags;
+ int failed;
+
+ // Build an ex command line to create a script that restores the current
+ // session if executed. Escape the filename to avoid nasty surprises.
+ escaped_filename = vim_strsave_escaped(filename, escape_chars);
+ if (escaped_filename == NULL)
+ return FALSE;
+ mksession_cmdline = alloc(10 + (int)STRLEN(escaped_filename) + 1);
+ if (mksession_cmdline == NULL)
+ {
+ vim_free(escaped_filename);
+ return FALSE;
+ }
+ strcpy(mksession_cmdline, "mksession ");
+ STRCAT(mksession_cmdline, escaped_filename);
+ vim_free(escaped_filename);
+
+ // Use a reasonable hardcoded set of 'sessionoptions' flags to avoid
+ // unpredictable effects when the session is saved automatically. Also,
+ // we definitely need SSOP_GLOBALS to be able to restore v:this_session.
+ // Don't use SSOP_BUFFERS to prevent the buffer list from becoming
+ // enormously large if the GNOME session feature is used regularly.
+ save_ssop_flags = ssop_flags;
+ ssop_flags = (SSOP_BLANK|SSOP_CURDIR|SSOP_FOLDS|SSOP_GLOBALS
+ |SSOP_HELP|SSOP_OPTIONS|SSOP_WINSIZE|SSOP_TABPAGES);
+
+ do_cmdline_cmd((char_u *)"let Save_VV_this_session = v:this_session");
+ failed = (do_cmdline_cmd((char_u *)mksession_cmdline) == FAIL);
+ do_cmdline_cmd((char_u *)"let v:this_session = Save_VV_this_session");
+ do_unlet((char_u *)"Save_VV_this_session", TRUE);
+
+ ssop_flags = save_ssop_flags;
+ vim_free(mksession_cmdline);
+
+ // Reopen the file and append a command to restore v:this_session,
+ // as if this save never happened. This is to avoid conflicts with
+ // the user's own sessions. FIXME: It's probably less hackish to add
+ // a "stealth" flag to 'sessionoptions' -- gotta ask Bram.
+ if (!failed)
+ {
+ FILE *fd;
+
+ fd = open_exfile(filename, TRUE, APPENDBIN);
+
+ failed = (fd == NULL
+ || put_line(fd, "let v:this_session = Save_VV_this_session")
+ == FAIL
+ || put_line(fd, "unlet Save_VV_this_session") == FAIL);
+
+ if (fd != NULL && fclose(fd) != 0)
+ failed = TRUE;
+
+ if (failed)
+ mch_remove(filename);
+ }
+
+ return !failed;
+}
+# endif
+
+#endif // FEAT_SESSION
+
+#if defined(FEAT_SESSION) && defined(USE_CRNL)
+# define MKSESSION_NL
+static int mksession_nl = FALSE; // use NL only in put_eol()
+#endif
+
+#if defined(FEAT_SESSION) || defined(PROTO)
+/*
+ * ":mkexrc", ":mkvimrc", ":mkview" and ":mksession".
+ */
+ void
+ex_mkrc(exarg_T *eap)
+{
+ FILE *fd;
+ int failed = FALSE;
+ char_u *fname;
+#ifdef FEAT_BROWSE
+ char_u *browseFile = NULL;
+#endif
+#ifdef FEAT_SESSION
+ int view_session = FALSE;
+ int using_vdir = FALSE; // using 'viewdir'?
+ char_u *viewFile = NULL;
+ unsigned *flagp;
+#endif
+
+ if (eap->cmdidx == CMD_mksession || eap->cmdidx == CMD_mkview)
+ {
+#ifdef FEAT_SESSION
+ view_session = TRUE;
+#else
+ ex_ni(eap);
+ return;
+#endif
+ }
+
+#ifdef FEAT_SESSION
+ // Use the short file name until ":lcd" is used. We also don't use the
+ // short file name when 'acd' is set, that is checked later.
+ did_lcd = FALSE;
+
+ // ":mkview" or ":mkview 9": generate file name with 'viewdir'
+ if (eap->cmdidx == CMD_mkview
+ && (*eap->arg == NUL
+ || (vim_isdigit(*eap->arg) && eap->arg[1] == NUL)))
+ {
+ eap->forceit = TRUE;
+ fname = get_view_file(*eap->arg);
+ if (fname == NULL)
+ return;
+ viewFile = fname;
+ using_vdir = TRUE;
+ }
+ else
+#endif
+ if (*eap->arg != NUL)
+ fname = eap->arg;
+ else if (eap->cmdidx == CMD_mkvimrc)
+ fname = (char_u *)VIMRC_FILE;
+#ifdef FEAT_SESSION
+ else if (eap->cmdidx == CMD_mksession)
+ fname = (char_u *)SESSION_FILE;
+#endif
+ else
+ fname = (char_u *)EXRC_FILE;
+
+#ifdef FEAT_BROWSE
+ if (cmdmod.browse)
+ {
+ browseFile = do_browse(BROWSE_SAVE,
+# ifdef FEAT_SESSION
+ eap->cmdidx == CMD_mkview ? (char_u *)_("Save View") :
+ eap->cmdidx == CMD_mksession ? (char_u *)_("Save Session") :
+# endif
+ (char_u *)_("Save Setup"),
+ fname, (char_u *)"vim", NULL,
+ (char_u *)_(BROWSE_FILTER_MACROS), NULL);
+ if (browseFile == NULL)
+ goto theend;
+ fname = browseFile;
+ eap->forceit = TRUE; // since dialog already asked
+ }
+#endif
+
+#if defined(FEAT_SESSION) && defined(vim_mkdir)
+ // When using 'viewdir' may have to create the directory.
+ if (using_vdir && !mch_isdir(p_vdir))
+ vim_mkdir_emsg(p_vdir, 0755);
+#endif
+
+ fd = open_exfile(fname, eap->forceit, WRITEBIN);
+ if (fd != NULL)
+ {
+#ifdef FEAT_SESSION
+ if (eap->cmdidx == CMD_mkview)
+ flagp = &vop_flags;
+ else
+ flagp = &ssop_flags;
+#endif
+
+#ifdef MKSESSION_NL
+ // "unix" in 'sessionoptions': use NL line separator
+ if (view_session && (*flagp & SSOP_UNIX))
+ mksession_nl = TRUE;
+#endif
+
+ // Write the version command for :mkvimrc
+ if (eap->cmdidx == CMD_mkvimrc)
+ (void)put_line(fd, "version 6.0");
+
+#ifdef FEAT_SESSION
+ if (eap->cmdidx == CMD_mksession)
+ {
+ if (put_line(fd, "let SessionLoad = 1") == FAIL)
+ failed = TRUE;
+ }
+
+ if (eap->cmdidx != CMD_mkview)
+#endif
+ {
+ // Write setting 'compatible' first, because it has side effects.
+ // For that same reason only do it when needed.
+ if (p_cp)
+ (void)put_line(fd, "if !&cp | set cp | endif");
+ else
+ (void)put_line(fd, "if &cp | set nocp | endif");
+ }
+
+#ifdef FEAT_SESSION
+ if (!view_session
+ || (eap->cmdidx == CMD_mksession
+ && (*flagp & SSOP_OPTIONS)))
+#endif
+ failed |= (makemap(fd, NULL) == FAIL
+ || makeset(fd, OPT_GLOBAL, FALSE) == FAIL);
+
+#ifdef FEAT_SESSION
+ if (!failed && view_session)
+ {
+ if (put_line(fd, "let s:so_save = &so | let s:siso_save = &siso | set so=0 siso=0") == FAIL)
+ failed = TRUE;
+ if (eap->cmdidx == CMD_mksession)
+ {
+ char_u *dirnow; // current directory
+
+ dirnow = alloc(MAXPATHL);
+ if (dirnow == NULL)
+ failed = TRUE;
+ else
+ {
+ // Change to session file's dir.
+ if (mch_dirname(dirnow, MAXPATHL) == FAIL
+ || mch_chdir((char *)dirnow) != 0)
+ *dirnow = NUL;
+ if (*dirnow != NUL && (ssop_flags & SSOP_SESDIR))
+ {
+ if (vim_chdirfile(fname, NULL) == OK)
+ shorten_fnames(TRUE);
+ }
+ else if (*dirnow != NUL
+ && (ssop_flags & SSOP_CURDIR) && globaldir != NULL)
+ {
+ if (mch_chdir((char *)globaldir) == 0)
+ shorten_fnames(TRUE);
+ }
+
+ failed |= (makeopens(fd, dirnow) == FAIL);
+
+ // restore original dir
+ if (*dirnow != NUL && ((ssop_flags & SSOP_SESDIR)
+ || ((ssop_flags & SSOP_CURDIR) && globaldir != NULL)))
+ {
+ if (mch_chdir((char *)dirnow) != 0)
+ emsg(_(e_prev_dir));
+ shorten_fnames(TRUE);
+ }
+ vim_free(dirnow);
+ }
+ }
+ else
+ {
+ failed |= (put_view(fd, curwin, !using_vdir, flagp,
+ -1) == FAIL);
+ }
+ if (put_line(fd, "let &so = s:so_save | let &siso = s:siso_save")
+ == FAIL)
+ failed = TRUE;
+# ifdef FEAT_SEARCH_EXTRA
+ if (no_hlsearch && put_line(fd, "nohlsearch") == FAIL)
+ failed = TRUE;
+# endif
+ if (put_line(fd, "doautoall SessionLoadPost") == FAIL)
+ failed = TRUE;
+ if (eap->cmdidx == CMD_mksession)
+ {
+ if (put_line(fd, "unlet SessionLoad") == FAIL)
+ failed = TRUE;
+ }
+ }
+#endif
+ if (put_line(fd, "\" vim: set ft=vim :") == FAIL)
+ failed = TRUE;
+
+ failed |= fclose(fd);
+
+ if (failed)
+ emsg(_(e_write));
+#if defined(FEAT_EVAL) && defined(FEAT_SESSION)
+ else if (eap->cmdidx == CMD_mksession)
+ {
+ // successful session write - set this_session var
+ char_u *tbuf;
+
+ tbuf = alloc(MAXPATHL);
+ if (tbuf != NULL)
+ {
+ if (vim_FullName(fname, tbuf, MAXPATHL, FALSE) == OK)
+ set_vim_var_string(VV_THIS_SESSION, tbuf, -1);
+ vim_free(tbuf);
+ }
+ }
+#endif
+#ifdef MKSESSION_NL
+ mksession_nl = FALSE;
+#endif
+ }
+
+#ifdef FEAT_BROWSE
+theend:
+ vim_free(browseFile);
+#endif
+#ifdef FEAT_SESSION
+ vim_free(viewFile);
+#endif
+}
+
+#endif // FEAT_SESSION
+
+#if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
+ var_flavour_T
+var_flavour(char_u *varname)
+{
+ char_u *p = varname;
+
+ if (ASCII_ISUPPER(*p))
+ {
+ while (*(++p))
+ if (ASCII_ISLOWER(*p))
+ return VAR_FLAVOUR_SESSION;
+ return VAR_FLAVOUR_VIMINFO;
+ }
+ else
+ return VAR_FLAVOUR_DEFAULT;
+}
+#endif
+
+/*
+ * Write end-of-line character(s) for ":mkexrc", ":mkvimrc" and ":mksession".
+ * Return FAIL for a write error.
+ */
+ int
+put_eol(FILE *fd)
+{
+ if (
+#ifdef USE_CRNL
+ (
+# ifdef MKSESSION_NL
+ !mksession_nl &&
+# endif
+ (putc('\r', fd) < 0)) ||
+#endif
+ (putc('\n', fd) < 0))
+ return FAIL;
+ return OK;
+}
+
+/*
+ * Write a line to "fd".
+ * Return FAIL for a write error.
+ */
+ int
+put_line(FILE *fd, char *s)
+{
+ if (fputs(s, fd) < 0 || put_eol(fd) == FAIL)
+ return FAIL;
+ return OK;
+}