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

;;

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

;; TODO: These could be a little more thorough

;;

(require 'dflet)

(require 'workgroups-misc)

;; Dired

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

  "Deserialize Dired buffer."

  (wg-dbind (this-function params) (wg-buf-special-data buf)

    (let ((dir (car params)))

          (if (file-exists-p dir)

      (current-buffer))))

(defun wg-serialize-dired-buffer (buffer)

  "Serialize Dired buffer."

  (with-current-buffer buffer

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

      (list 'wg-deserialize-dired-buffer

            (wg-take-until-unreadable (list (or (buffer-file-name) default-directory)))

            ))))

;; 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)

               (boundp 'help-xref-forward-stack))

      (list 'wg-deserialize-help-buffer

            (wg-take-until-unreadable help-xref-stack-item)

            (mapcar 'wg-take-until-unreadable help-xref-stack)

            (mapcar 'wg-take-until-unreadable help-xref-forward-stack)))))

;; ielm buffer serdes

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

  "Deserialize an `inferior-emacs-lisp-mode' buffer."

  (ielm)

  (current-buffer))

(defun wg-serialize-ielm-buffer (buffer)

  "Serialize an `inferior-emacs-lisp-mode' buffer."

  (with-current-buffer buffer

    (when (eq major-mode 'inferior-emacs-lisp-mode)

      (list 'wg-deserialize-ielm-buffer))))

;; Magit buffers

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

  ""

  (if (require 'magit nil 'noerror)

      (if (fboundp 'magit-status)

          (wg-dbind (this-function dir) (wg-buf-special-data buf)

            (let ((default-directory (car dir)))

              (if (file-exists-p default-directory)

                  (magit-status default-directory))

              (current-buffer))))))

(defun wg-serialize-magit-buffer (buffer)

  ""

  (if (fboundp 'magit-status-mode)

      (with-current-buffer buffer

        (when (eq major-mode 'magit-status-mode)

          (list 'wg-deserialize-magit-buffer

;; Then, since it's not overwritten on every call to

;; `wg-workgroup-working-wconfig', its restoration can be retried after manually

;; recreating buffers that couldn't be restored.  So it takes over the

;; 'incorrect restoration' portion of the base wconfig's duty.  All that leaves

;; to base wconfigs is that they're a saved wconfig the user felt was important.

;; So why not allow more of of them?  A workgroup could stash an unlimited

;; number of wconfigs.

;;

;; 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-dired-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

  :group 'workgroups)

(defcustom wg-restore-scroll-bars t

  "Non-nil means restore scroll-bar settings on workgroup restore."

  :type 'boolean

  :group 'workgroups)

(defcustom wg-restore-fringes t

  "Non-nil means restore fringe settings on workgroup restore."

  :type 'boolean

  :group 'workgroups)

(defcustom wg-restore-margins t

  "Non-nil means restore margin settings on workgroup restore."

  :type 'boolean

  :group 'workgroups)

(defcustom wg-restore-point t

  "Non-nil means restore `point' on workgroup restore.

This is included mainly so point restoration can be suspended

during `wg-morph' -- you probably want this non-nil."

  :type 'boolean

  :group 'workgroups)

(defcustom wg-restore-point-max t

  "Controls point restoration when point is at `point-max'.

If `point' is at `point-max' when a wconfig is created, put

`point' back at `point-max' when the wconfig is restored, even if

`point-max' has increased in the meantime.  This is useful in,

say, irc buffers where `point-max' is constantly increasing."

  :type 'boolean

  :group 'workgroups)

(defcustom wg-restore-mark t

  "Non-nil means restore mark data on workgroup restore."

  :type 'boolean

  :group 'workgroups)

(defcustom wg-restore-window-dedicated-p t

  "Non-nil means restore `window-dedicated-p' on workgroup restore."

  :type 'boolean

  :group 'workgroups)

;; wconfig undo/redo customization

(defcustom wg-wconfig-undo-list-max 20

  "Number of past window configs to retain for undo."

  :type 'integer

  :group 'workgroups)

;; wconfig kill-ring customization

(defcustom wg-wconfig-kill-ring-max 20

  "Maximum length of the `wg-wconfig-kill-ring'."

  :type 'integer

  :group 'workgroups)

;; buffer-list filtration customization

(defcustom wg-buffer-list-filtration-on t

  "Non-nil means Workgroups' buffer-list filtration feature is on.

Nil means ido and iswitchb behave normally.  See

`wg-buffer-list-filter-definitions' for more info."

  :type 'boolean

  :group 'workgroups)

(defcustom wg-buffer-list-filter-definitions

  '((all "all" wg-buffer-list-filter-all)

    (associated "associated" wg-buffer-list-filter-associated)

    (unassociated "unassociated" wg-buffer-list-filter-unassociated)

    (fallback "fallback" nil))

  "List of buffer list filter definitions.

Each entry should be a list containing an identifier symbol, a

prompt string, and a function form that's funcall'd to produce

the filtered buffer-list.

The prompt string is displayed as part of the minibuffer prompt

when its filter is active.

The function form should be either a function-symbol or a lambda, and

should take two arguments: a workgroup and a list of live Emacs

buffers.  The function should return a new list of live buffers,

typically by filtering its second argument in some way.