;;; workgroups-commands --- main commands

;;; Commentary:

;;; Code:

(require 'cl-lib)

(eval-when-compile

  (require 'ido)

  (require 'iswitchb))

(require 'ring)

(require 'workgroups-variables)

(require 'workgroups-utils-basic)

(require 'workgroups-pickel)

(require 'workgroups-functions)

;;; workgroup switching commands

(defun wg-switch-to-workgroup (workgroup &optional noerror)

  "Switch to WORKGROUP."

  (interactive (list (wg-read-workgroup-name)))

  ;; Set a parameter when using ECB

  (if (wg-current-workgroup t)

      (wg-set-workgroup-parameter (wg-current-workgroup t) 'ecb (and (boundp 'ecb-minor-mode)

                                                                     ecb-minor-mode)))

  (let ((workgroup (wg-get-workgroup-create workgroup))

        (current (wg-current-workgroup t)))

    (when (and (eq workgroup current) (not noerror))

      (error "Already on: %s" (wg-workgroup-name current)))

    (when current (push current wg-deactivation-list))

    (unwind-protect

        (progn

          ;; Before switching - turn off ECB

          ;; https://github.com/pashinin/workgroups2/issues/34

          (if (and (boundp 'ecb-minor-mode)

                   ecb-minor-mode

                   (equal ecb-frame (selected-frame)))

              (let ((ecb-split-edit-window-after-start 'before-deactivation))

                (ecb-deactivate)))

          (wg-restore-workgroup workgroup)

          (wg-set-previous-workgroup current)

          (wg-set-current-workgroup workgroup)

          ;; If a workgroup had ECB - turn it on

          (if (and (boundp 'ecb-minor-mode)

                   (not ecb-minor-mode)

                   (wg-workgroup-parameter (wg-current-workgroup t) 'ecb nil))

              (let ((ecb-split-edit-window-after-start 'before-deactivation))

                (ecb-activate)))

          (run-hooks 'wg-switch-to-workgroup-hook)

          (wg-fontified-message

            (:cmd "Switched: ")

            (wg-workgroup-name (wg-current-workgroup t))

            ))

      (when current (pop wg-deactivation-list)))))

(defun wg-switch-to-workgroup-other-frame (workgroup &optional n)

  "Switch to WORKGROUP in the frame N places cyclically from `selected-frame'.

Use `current-prefix-arg' for N if non-nil.  Otherwise N defaults to 1."

  (interactive (list (wg-read-workgroup-name) current-prefix-arg))

  (with-selected-frame (wg-cyclic-nth-from-frame (or n 1))

    (wg-switch-to-workgroup workgroup)))

(defun wg-switch-to-workgroup-at-index (index)

  "Switch to the workgroup at INDEX in `wg-workgroup-list'."

  (interactive (list (or current-prefix-arg (wg-read-workgroup-index))))

  (let ((wl (wg-workgroup-list-or-error)))

    (wg-switch-to-workgroup

     (or (nth index wl) (error "There are only %d workgroups" (length wl))))))

(cl-macrolet

    ((define-range-of-switch-to-workgroup-at-index (num)

       `(progn

          ,@(wg-docar (i (wg-range 0 num))

              `(defun ,(intern (format "wg-switch-to-workgroup-at-index-%d" i)) ()

                 ,(format "Switch to the workgroup at index %d." i)

                 (interactive)

                 (wg-switch-to-workgroup-at-index ,i))))))

  (define-range-of-switch-to-workgroup-at-index 10))

(defun wg-switch-to-cyclic-nth-from-workgroup (workgroup n)

  "Switch N workgroups cyclically from WORKGROUP in `wg-workgroup-list.'"

  (let ((workgroup-list (wg-workgroup-list-or-error))

        (workgroup (wg-get-workgroup workgroup t)))

    (wg-switch-to-workgroup

     (cond ((not workgroup) (car workgroup-list))

           ((= 1 (length workgroup-list)) (error "There's only one workgroup"))

           (t (wg-cyclic-nth-from-workgroup workgroup n))))))

(defun wg-switch-to-workgroup-left (&optional workgroup n)

  "Switch to the workgroup (- N) places from WORKGROUP in `wg-workgroup-list'.

Use `current-prefix-arg' for N if non-nil.  Otherwise N defaults to 1."

  (interactive (list nil current-prefix-arg))

  (wg-switch-to-cyclic-nth-from-workgroup workgroup (- (or n 1))))

(defun wg-switch-to-workgroup-right (&optional workgroup n)

  "Switch to the workgroup N places from WORKGROUP in `wg-workgroup-list'.

Use `current-prefix-arg' for N if non-nil.  Otherwise N defaults to 1."

  (interactive (list nil current-prefix-arg))

  (wg-switch-to-cyclic-nth-from-workgroup workgroup (or n 1)))

(defun wg-switch-to-workgroup-left-other-frame (&optional n)

  "Like `wg-switch-to-workgroup-left', but operates on the next frame."

  (interactive "p")

  (with-selected-frame (wg-cyclic-nth-from-frame (or n 1))

    (call-interactively 'wg-switch-to-workgroup-left)))

(defun wg-switch-to-workgroup-right-other-frame (&optional n)

  "Like `wg-switch-to-workgroup-right', but operates on the next frame."

  (interactive "p")

  (with-selected-frame (wg-cyclic-nth-from-frame (or n -1))

    (call-interactively 'wg-switch-to-workgroup-right)))

(defun wg-switch-to-previous-workgroup ()

  "Switch to the previous workgroup."

  (interactive)

  (wg-switch-to-workgroup (wg-previous-workgroup)))

;;; workgroup creation commands

(defun wg-create-workgroup (name &optional blank)

  "Create and add a workgroup named NAME.

Optional argument BLANK non-nil (set interactively with a prefix

arg) means use a blank, one window window-config.  Otherwise use

the current window-configuration.  Keep in mind that even though

the current window-config may be used, other parameters of the

current workgroup are not copied to the created workgroup.  For

that, use `wg-clone-workgroup'."

  (interactive (list (wg-read-new-workgroup-name) current-prefix-arg))

  (wg-switch-to-workgroup (wg-make-and-add-workgroup name blank))

  (wg-fontified-message

    (:cmd "Created: ")

    (:cur name) "  "

    (wg-workgroup-list-display)))

(defun wg-clone-workgroup (workgroup name)

      (:cur oldname)

      (:msg " to ")

      (:cur (wg-workgroup-name workgroup)))))

(defun wg-reset (&optional force)

  "Reset Workgroups.

Resets all frame parameters, buffer-local vars, the current

Workgroups session object, etc."

  (interactive "P")

  (unless (or force wg-no-confirm-on-destructive-operation

              (y-or-n-p "Really reset Workgroups? "))

    (error "Canceled"))

  (wg-reset-internal)

  (wg-fontified-message

    (:cmd "Reset: ")

    (:msg "Workgroups")))

;;; file commands

(defun wg-read-session-save-file-name ()

  "Read and return a new session filename."

  (read-file-name "Save session as: "))

(defun wg-write-session-file (filename &optional confirm)

  "Write the current session into file FILENAME.

This makes the session visit that file, and marks it as not modified.

If optional second arg CONFIRM is non-nil, this function asks for

confirmation before overwriting an existing file.  Interactively,

confirmation is required unless you supply a prefix argument.

Think of it as `write-file' for Workgroups sessions."

  (interactive (list (wg-read-session-save-file-name)

                     (not current-prefix-arg)))

  (when (and confirm (file-exists-p filename))

    (unless (y-or-n-p (format "File `%s' exists; overwrite? " filename))

      (error "Cancelled")))

  (unless (file-writable-p filename)

    (error "File %s can't be written to" filename))

  (wg-perform-session-maintenance)

  (setf (wg-session-file-name (wg-current-session)) filename)

  (setf (wg-session-version (wg-current-session)) wg-version)

  (wg-write-sexp-to-file

   (wg-pickel-all-session-parameters (wg-current-session))

   filename)

  (wg-mark-everything-unmodified)

  (wg-fontified-message (:cmd "Wrote: ") (:file filename)))

(defun wg-determine-session-save-file-name ()

  "Return the filename in which to save the session."

  (or (wg-session-file-name (wg-current-session))

      (and wg-use-default-session-file wg-default-session-file)))

(defun wg-save-session (&optional force)

  "Save the current Workgroups session if it's been modified.

Think of it as `save-buffer' for Workgroups sessions.  Optional

argument FORCE non-nil, or interactively with a prefix arg, save

the session regardless of whether it's been modified."

  (interactive "P")

  (if (and (not (wg-modified-p)) (not force))

      (wg-message "(The session is unmodified)")

    (wg-write-session-file

     (or (wg-determine-session-save-file-name)

         (wg-read-session-save-file-name)))))

(defun wg-query-and-save-if-modified ()

  "Query for save when `wg-modified-p'."

  (or (not (wg-modified-p))

      (when (y-or-n-p "Save modified workgroups? ")

        (wg-save-session))))

(defun wg-save-session-on-exit (behavior)

  "Perform session-saving operations based on BEHAVIOR."

  (cl-case behavior

    (ask (wg-query-and-save-if-modified))

    (save

     (if (wg-determine-session-save-file-name)

         (wg-save-session)

       (wg-query-and-save-if-modified)))))

(defun wg-find-session-file (filename)

  "Load a session visiting FILENAME, creating one if none already exists."

  (interactive "FFind session file: ")

  (cond ((file-exists-p filename)

         (let ((session (wg-read-sexp-from-file filename)))

           (unless (wg-session-p session)

             (error "%S is not a Workgroups session file." filename))

           (setf (wg-session-file-name session) filename)

           (wg-reset-internal (wg-unpickel-session-parameters session)))

         (wg-awhen (and wg-switch-to-first-workgroup-on-find-session-file

                        (wg-workgroup-list))

           (if (and wg-open-this-wg

                    (member wg-open-this-wg (wg-workgroup-names)))

               (wg-switch-to-workgroup wg-open-this-wg)

         (wg-fontified-message (:cmd "Loaded: ") (:file filename)))

        (t

         (wg-query-and-save-if-modified)

         (wg-reset-internal (wg-make-session :file-name filename))

         (wg-fontified-message

           (:cmd "(New Workgroups session file)")))))

(defun wg-find-file-in-new-workgroup (filename)

  "Create a new blank workgroup and find file FILENAME in it."

  (interactive "FFind file in new workgroup: ")

  (wg-create-workgroup (file-name-nondirectory filename) t)

  (find-file filename))

(defun wg-find-file-read-only-in-new-workgroup (filename)

  "Create a new workgroup and find file FILENAME read-only in it."

  (interactive "FFind file read only in new workgroup: ")

  (wg-create-workgroup (file-name-nondirectory filename) t)

  (find-file-read-only filename))

(defun wg-dired-in-new-workgroup (dirname &optional switches)

  "Create a workgroup and open DIRNAME in dired with SWITCHES."

  (interactive (list (read-directory-name "Dired (directory): ")

                     current-prefix-arg))

  (wg-create-workgroup dirname)

  (dired dirname switches))

;;; toggle commands

(defun wg-toggle-and-message (symbol)

  "Toggle SYMBOL's truthiness and message the new value."

  (wg-fontified-message

    (:cmd (format "%s: " symbol))

    (:msg (format "%s" (wg-toggle symbol)))))

(defun wg-toggle-buffer-list-filtration ()

  "Toggle `wg-buffer-list-filtration-on'."

  (interactive)

  (wg-toggle-and-message 'wg-buffer-list-filtration-on))

(defun wg-toggle-mode-line-display ()

  "Toggle `wg-mode-line-display-on'."

  (interactive)

  (wg-toggle-and-message 'wg-mode-line-display-on))

;;; echo commands

(defun wg-echo-current-workgroup ()

  "Display the name of the current workgroup in the echo area."

  (interactive)

  (wg-fontified-message

    (:cmd "Current: ")

    (:cur (wg-workgroup-name (wg-current-workgroup)))))

(defun wg-echo-all-workgroups ()

  "Display the names of all workgroups in the echo area."

  (interactive)

  (wg-fontified-message

    (:cmd "Workgroups: ")

    (wg-workgroup-list-display)))

(defun wg-echo-time ()

  "Echo the current time.  Optionally includes `battery' info."

  (interactive)

  (wg-message ;; Pass through format to escape the % in `battery'

   "%s" (wg-fontify

          (:cmd "Current time: ")

          (:msg (format-time-string wg-time-format))

          (when (and wg-display-battery (fboundp 'battery))

            (wg-fontify "\n" (:cmd "Battery: ") (:msg (battery)))))))

(defun wg-echo-version ()

  "Echo Workgroups' current version number."

  (interactive)

  (wg-fontified-message

    (:cmd "Workgroups version: ")

    (:msg wg-version)))

(defun wg-echo-last-message ()

  "Echo the last message Workgroups sent to the echo area.

The string is passed through a format arg to escape %'s."

  (interactive)

  (message "%s" wg-last-message))

;;; help commands

(defun wg-help ()

  "Just call `apropos-command' on \"^wg-\".

There used to be a bunch of help-buffer construction stuff here,

including a `wg-help' variable that basically duplicated every

command's docstring;  But why, when there's `apropos-command'?"

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

;;; Commentary:

;;; Code:

(defconst wg-version "1.0.3"

  "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-first-wg-name "First workgroup"

  "Title of the first workgroup created."

  :type 'string

  :group '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)