;;; workgroups-variables --- Workgroups vars and consts

;;; Commentary:

;;; Code:

  "Current version of workgroups.")

;;; customization

(defgroup workgroups nil

  "Workgroups for Emacs -- Emacs session manager"

  :group 'convenience

  :version wg-version)

(defcustom workgroups-mode nil

  "Non-nil if Workgroups mode is enabled."

  :set 'custom-set-minor-mode

  :initialize 'custom-initialize-default

  :group 'workgroups

  :type 'boolean)

(defcustom wg-load-last-workgroup nil

  "Load last active, not first, workgroup from all your workgroups."

  :group 'workgroups

  :type 'boolean)

;; keybinding customization

(defcustom wg-prefix-key (kbd "C-c z")

  "Workgroups' prefix key.

Setting this variable requires that `workgroups-mode' be turned

off and then on again to take effect."

  :type 'string

  :group 'workgroups)

;; hooks

(defcustom workgroups-mode-hook nil

  "Hook run when `workgroups-mode' is turned on."

  :type 'hook

  :group 'workgroups)

(defcustom workgroups-mode-exit-hook nil

  "Hook run when `workgroups-mode' is turned off."

  :type 'hook

  :group 'workgroups)

(defcustom wg-switch-to-workgroup-hook nil

  "Hook run by `wg-switch-to-workgroup'."

  :type 'hook

  :group 'workgroups)

(defcustom wg-buffer-list-finalization-hook nil

  "Functions in this hook can modify `wg-temp-buffer-list'

arbitrarily, provided its final value is still a list of the

names of live buffer.  Any final adjustments the user wishes to

make to the filtered buffer list before ido/iswitchb get ahold of

it should be made here."

  :type 'hook

  :group 'workgroups)

(defcustom wg-pre-window-configuration-change-hook nil

  "Hook run before any function that triggers

`window-configuration-change-hook'."

  :type 'hook

  :group 'workgroups)

;; save and load customization

(defcustom wg-use-default-session-file (not (daemonp))

  "Generally, non-nil means take care of saving and loading automatically,

and nil means leave it up to the user.

FIXME: docstring this"

  :type 'boolean

  :group 'workgroups)

(defcustom wg-default-session-file

  "~/.emacs_workgroups"

  "Default filename to be used to save workgroups."

  :type 'file

  :group 'workgroups)

(defcustom wg-open-this-wg nil

  "Try to open this workgroup on start. If nil - nothing happens."

  :type 'string

  :group 'workgroups)

(defcustom wg-switch-to-first-workgroup-on-find-session-file t

  "Non-nil means switch to the first workgroup in a session file

when it's found with `wg-find-session-file'."

  :type 'boolean

  :group 'workgroups)

(defcustom wg-emacs-exit-save-behavior 'save

  "Determines save behavior on Emacs exit.

Possible values:

`ask'           Ask the user whether to save if there are unsaved changes

`save'          Call `wg-save-session' when there are unsaved changes

Anything else   Exit Emacs without saving changes"

  :type 'symbol

  :group 'workgroups)

(defcustom wg-workgroups-mode-exit-save-behavior 'save

  "Determines save behavior on `workgroups-mode' exit.

Possible values:

`ask'           Ask the user whether to saveif there are unsaved changes

`save'          Call `wg-save-session' when there are unsaved changes

Anything else   Exit `workgroups-mode' without saving changes"

  :type 'symbol

  :group 'workgroups)

;; minibuffer customization

(defcustom wg-confirm-on-get-workgroup-create nil

  "Non-nil means request confirmation before creating a new

workgroup when `wg-get-workgroup-create' is called with a string

that doesn't name an existing workgroup."

  :type 'boolean

  :group 'workgroups)

(defcustom wg-no-confirm-on-destructive-operation nil

  "Non-nil means don't request confirmation before various

destructive operations, like `wg-reset'."

  :type 'boolean

  :group 'workgroups)

(defcustom wg-minibuffer-message-timeout 0.75

  "Bound to `minibuffer-message-timeout' when messaging while the

minibuffer is active."

  :type 'float

  :group 'workgroups)

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

;;

;; FIXME:

;;

;; Only set `wg-workgroup-base-wconfig' on `wg-write-session-file' or

;; `delete-frame' and only with the most recently changed working-wconfig.

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