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

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-comint-buffer

    wg-serialize-speedbar-buffer)

  "List of functions providing special buffer serialization/deserialization.

Use `wg-support' macro and this variable will be filled

automatically.

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-nowg-string "No workgroups"

  "Display this string if there are no workgroups and

`wg-display-nowg' is t."

  :type 'string

  :group 'workgroups)

(defcustom wg-display-nowg nil

  "Display something if there are no workgroups."

  :type 'boolean

  :group 'workgroups)

;; What to restore:

(defcustom wg-restore-remote-buffers t

  "Restore buffers that get \"t\" with `file-remote-p'."

  :type 'boolean

  :group 'workgroups)

(defcustom wg-restore-associated-buffers nil

  "Non-nil means restore ALL buffers associated (opened in) with

the workgroup on workgroup restore.  \"nil\" means to restore

only needed buffers to show them to you."

  :type 'boolean

  :group 'workgroups)

(defcustom wg-restore-frame-position t

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

(defcustom wg-remember-frame-for-each-wg nil

  "When switching workgroups - restore frame parameters for each workgroup.

When nil - save/restore frame parameters to/from the first workgroup."

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

Default buffer-list-filters include:

`all'           All buffer names

`associated'    Only the names of those live buffers that have

                been associated with the current workgroup

`unassociated'  Only the names of those live buffers that are

                unassociated with the current workgroup

`fallback'      A special case used to fallback to the

                original (non-ido/iswitchb) Emacs command.

                `fallback' isn't actually a buffer-list-filter

                itself, but can be used in

                `wg-buffer-list-filter-order-alist' just the

                same.

A few example custom buffer-list filtration functions are

included, like `wg-buffer-list-filter-home-dir',

`wg-buffer-list-filter-irc' and `wg-buffer-list-filter-elisp'.

See their definitions for more info on how they're defined, and

the utilities they're built on.

Here's an example of how to add an `elisp' buffer-list-filter

definition to `wg-buffer-list-filter-definitions' using the

example function `wg-buffer-list-filter-elisp':