;;; special buffer serdes functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;;

;; TODO: Possibly add restore-special-data customization option

;; TODO: These could be a little more thorough

;;

(require 'dflet)

;; Info buffer serdes

(defun wg-deserialize-Info-buffer (buf)

  "Deserialize an Info buffer."

  (require 'info)

  (wg-aif (cdr (wg-buf-special-data buf))

      (apply #'Info-find-node it)

    (info))

  (current-buffer))

(defun wg-serialize-Info-buffer (buffer)

  "Serialize an Info buffer."

  (with-current-buffer buffer

    (when (eq major-mode 'Info-mode)

      (wg-when-boundp (Info-current-file Info-current-node)

        (list 'wg-deserialize-Info-buffer

              Info-current-file

              Info-current-node)))))

;; help buffer serdes

(defun wg-deserialize-help-buffer (buf)

  "Deserialize a help buffer.

See `wg-serialize-help-buffer'."

  (require 'help-mode)

  (wg-dbind (this-function item stack forward-stack) (wg-buf-special-data buf)

    (condition-case err

        (apply (car item) (cdr item))

      (error (message "%s" err)))

    (wg-awhen (get-buffer "*Help*")

      (set-buffer it)

      (wg-when-boundp (help-xref-stack help-xref-forward-stack)

        (setq help-xref-stack stack

              help-xref-forward-stack forward-stack))

      (current-buffer))))

(defun wg-serialize-help-buffer (buffer)

  "Serialize a help buffer.

Since `help-mode' is used by many buffers that aren't actually

*Help* buffers (e.g. *Process List*), we also check that

`help-xref-stack-item' has a local binding."

  (with-current-buffer buffer

    (when (and (eq major-mode 'help-mode)

               (local-variable-p 'help-xref-stack-item)

               (boundp 'help-xref-stack-item)

               (boundp 'help-xref-stack)

;; TODO:

;;

;;   * Write new commands for restoring stashed wconfigs

;;

;;   * Add this message on improper restoration of `base-wconfig':

;;

;;       "Unable to restore 'buf1', 'buf2'... Hit C-whatever to retry after

;;        manually recreating these buffers."

;;

;;

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;; workgroup restoration customization

;; TODO: possibly add `buffer-file-coding-system', `text-scale-mode-amount'

(defcustom wg-buffer-local-variables-alist

  `((major-mode nil wg-deserialize-buffer-major-mode)

    (mark-ring wg-serialize-buffer-mark-ring wg-deserialize-buffer-mark-ring)

    (left-fringe-width nil nil)

    (right-fringe-width nil nil)

    (fringes-outside-margins nil nil)

    (left-margin-width nil nil)

    (right-margin-width nil nil)

    (vertical-scroll-bar nil nil))

  "Alist mapping buffer-local variable symbols to serdes functions.

The `car' of each entry should be a buffer-local variable symbol.

The `cadr' of the entry should be either nil or a function of no

arguments.  If nil, the variable's value is used as-is, and

should have a readable printed representation.  If a function,

`funcall'ing it should yield a serialization of the value of the

variable.

The `caddr' of the entry should be either nil or a function of

one argument.  If nil, the serialized value from above is

assigned to the variable as-is.  It a function, `funcall'ing it

on the serialized value from above should do whatever is

necessary to properly restore the original value of the variable.

For example, in the case of `major-mode' it should funcall the

value (a major-mode function symbol) rather than just assigning

it to `major-mode'."

  :type 'alist

  :group 'workgroups)

(defcustom wg-special-buffer-serdes-functions

  '(wg-serialize-Info-buffer

    wg-serialize-org-agenda-buffer

    wg-serialize-help-buffer

    wg-serialize-ielm-buffer

    wg-serialize-shell-buffer

    wg-serialize-eshell-buffer

    wg-serialize-term-buffer

    wg-serialize-magit-buffer

    )

  "List of functions providing special buffer serialization/deserialization.

An entry should be either a function symbol or a lambda, and should

accept a single Emacs buffer object as an argument.

When a buffer is to be serialized, it is passed to each of these

functions in turn until one returns non-nil, or the list ends.  A

return value of nil indicates that the function can't handle

buffers of that type.  A non-nil return value indicates that it

can.  The first non-nil return value becomes the buffer's special

serialization data.  The return value should be a cons, with a

deserialization function (a function symbol or a lambda) as the car,

and any other serialization data as the cdr.

When it comes time to deserialize the buffer, the deserialization

function (the car of the cons mentioned above) is passed the

wg-buf object, from which it should restore the buffer.  The

special serialization data itself can be accessed

with (cdr (wg-buf-special-data <wg-buf>)).  The deserialization

function must return the restored Emacs buffer object.

See the definitions of the functions in this list for examples of

how to write your own."

  :type 'alist

  :group 'workgroups)

(defcustom wg-default-buffer "*scratch*"

  "Buffer made visible a window when the window's actual buffer

can't be restored.  Also used when a blank workgroup is created."

  :type 'string

  :group 'workgroups)

(defcustom wg-restore-associated-buffers t

  "Non-nil means restore all buffers associated with the

workgroup on workgroup restore."

  :type 'boolean

  :group 'workgroups)

(defcustom wg-restore-frame-position nil

  "Non-nil means restore frame position on workgroup restore."

  :type 'boolean