ShellPAK  Check-in [392bdcb90e]

## Supported Platforms<a id="sec-1-2" name="sec-1-2"></a>

The following operating systems are known to be supported:

-   Mac OS X 10.9 (Darwin)
-   NetBSD 6.1.x
-   OpenBSD 5.8
-   CentOS 6.5
-   Debian 9 (Stretch) and derivatives
-   SunOS solaris 5.10
-   AIX 1 7

In addition, ShellPAK has been known to run on OpenSuSE, SuSE
Enterprise Linux, Ubuntu, FreeBSD, and Cygwin.

# Obtaining ShellPAK<a id="sec-2" name="sec-2"></a>

# Author<a id="sec-5" name="sec-5"></a>

Christopher M. Fuhrman
[cfuhrman@pobox.com](cfuhrman@pobox.com)

# Copyright<a id="sec-6" name="sec-6"></a>

Copyright (c) 2000-2018 Christopher M. Fuhrman
All rights reserved.

All files contained herein can be redistributed and/or modified
under the terms of the Simplified BSD License (also known as the
"2-Clause License" or "FreeBSD License".) unless otherwise noted.

** Supported Platforms

   The following operating systems are known to be supported:

    - Mac OS X 10.9 (Darwin)
    - NetBSD 6.1.x
    - OpenBSD 5.8
    - CentOS 6.5
    - Debian 9 (Stretch) and derivatives
    - SunOS solaris 5.10
    - AIX 1 7

   In addition, ShellPAK has been known to run on OpenSuSE, SuSE
   Enterprise Linux, Ubuntu, FreeBSD, and Cygwin.

* Obtaining ShellPAK

* Author

  Christopher M. Fuhrman
  [[mailto:cfuhrman@pobox.com][cfuhrman@pobox.com]]

* Copyright

  Copyright (c) 2000-2018 Christopher M. Fuhrman
  All rights reserved.

  All files contained herein can be redistributed and/or modified
  under the terms of the Simplified BSD License (also known as the
  "2-Clause License" or "FreeBSD License".) unless otherwise noted.

(defvar cmf-custom-256 "~/.emacs.d/custom-nox256.el")

;; List of paths to search
(defvar cmf-path-list '("/usr/texbin"
                        "/usr/pkg/bin"
                        "/usr/local/bin"
                        "~/.composer/vendor/bin"
                        "~/go/bin"
                        "/Library/TeX/texbin"))

;; Customize generic variables
(custom-set-variables
 '(c-default-style
   (quote
    ((c-mode . "cmf")

  :init
  (yas-global-mode 1)

  :custom
  (yas-wrap-around-region t)
  )

;; popwin
(use-package popwin
  :ensure t

  :config
  (setq display-buffer-function 'popwin:display-buffer)

  :custom
  (popwin-mode t)
  )

;; ace-window
(use-package ace-window
  :ensure t
  :pin melpa-stable

  :config
  (setq aw-keys '(?a ?s ?d ?f ?g ?h ?j ?k ?l))

  :bind (
         ("C-x o" . ace-window))
  )

;; all-the-icons
(use-package all-the-icons
  :if window-system
  :ensure t
  :pin melpa-stable


  :config

  ;; Install the font files only if we have not already done so
  (defvar cmf-fonts-installed-file "~/SHELL/emacs.d/.icon-fonts-installed")
  (unless (file-exists-p cmf-fonts-installed-file)
    (progn
      (message "Installing icon fonts")
      (all-the-icons-install-fonts t)
      (with-temp-buffer (write-file cmf-fonts-installed-file)))
    )
  )

;; all-the-icons-dired
(use-package all-the-icons-dired
  :if window-system
  :ensure t
  :after all-the-icons

  :config
  (defun nice-all-the-icons-dired-hook ()
    "Hook for disabling font-lock-mode for dired buffers w/ all-the-icons"
    (font-lock-mode 0)
    )

  (add-hook 'dired-mode-hook 'all-the-icons-dired-mode)
  (add-hook 'dired-mode-hook 'nice-all-the-icons-dired-hook)
  )

(use-package all-the-icons-ivy
  :if window-system
  :ensure t
  :after all-the-icons
  :pin melpa-stable

  :config
  (all-the-icons-ivy-setup)
  )

;; apache-mode
(use-package apache-mode
  :ensure t
  :defer t

  :ensure t
  :if window-system

  :init
  (add-to-list 'custom-safe-themes
	       "c74e83f8aa4c78a121b52146eadb792c9facc5b1f02c917e3dbb454fca931223")
  (load-theme 'arjen-grey t)

  :custom-face
  (highlight ((t (:distant-foreground "LightYellow3" :background "DarkOliveGreen"))))
  )

;; auctex
(use-package auctex
  :ensure t
  :no-require t
  )

;; beacon mode
(use-package beacon
  :ensure t
  :pin melpa-stable

  :diminish " 🄱"
  :init
  (require 'beacon)

  :config
  (beacon-mode 1)
  )

;; calfw
(use-package calfw
  :ensure t
  :ensure calfw-gcal
  :ensure calfw-ical
  :ensure calfw-org
  :pin melpa-stable

  :init
  (require 'calfw)
  (require 'calfw-ical)
  (require 'calfw-org)

  ;; See https://github.com/kiwanami/emacs-calfw for setting up your
  ;; own calendars
  :config
  (defun cmf-open-calendar ()
    (interactive)
    (cfw:open-calendar-buffer :contents-sources
			      (list
			       (cfw:org-create-source "Green")  ; orgmode source
			       (cfw:ical-create-source "Google Calendar"
						       "https://calendar.google.com/calendar/ical/jsmith%40example.com/private-set-me-up/basic.ics"
						       "Orange")
			       (cfw:ical-create-source "Trips via Kayak"
			       			       "https://www.kayak.com/trips/ical/tf/blahblah/blahblah/calendar.ics"
			       			       "SteelBlue")
    )
  )

;; [c]perl-mode
(use-package cperl-mode
  :mode ("\\.cgi\\'" . cperl-mode)

  :init
  (defalias 'perl-mode 'cperl-mode)

(use-package crontab-mode
  :ensure t
  :no-require t

  :mode (("\\.cron\\(tab\\)?\\'" . crontab-mode)
         ("cron\\(tab\\)?\\."    . crontab-mode))
  )

;; diff-mode
(use-package diff
  :config
  (push '("[Dd]iff"
	  :regexp   t
	  :noselect t
	  :position right
	  :width    0.40)
	popwin:special-display-config)
  )

;; eldoc
(use-package eldoc
  :diminish eldoc-mode " Doc"
  )

;; emojify

(use-package flycheck
  :ensure t

  :init
  (global-flycheck-mode)

  :custom
  (flycheck-disabled-checkers (quote (php-phpcs go-build)))
  (flycheck-highlighting-mode 'lines)
  (flycheck-phpcs-standard "PSR2")
  )

;; flyspell
(use-package flyspell
  :ensure t

    (forecast-longitude cmf-longitude)
    (forecast-city cmf-location-name)
    (forecast-country "United States")
    (forecast-units 'us)
    (forecast-api-key "f78b853ac0c972cccf06e75e21afbe9d")
    )
  )

;; geben
(use-package geben
  :ensure t
  :pin melpa-stable
  :no-require t
  )

;; gited - dired for git branches
(use-package gited
  :ensure t
  :no-require t

  :bind (

  :diminish ggtags-mode " 🄶"

  :init
  (add-hook 'prog-mode-hook
            (lambda ()
              (ggtags-mode t)))
  )

;; go-mode
(use-package go-mode
  :ensure t
  :ensure go-autocomplete
  :ensure go-direx
  :ensure go-eldoc
  :ensure go-snippets

  :pin melpa-stable
  :no-require t

  :mode ("\\.go\\'" . go-mode)

  :bind (:map go-mode-map
	      ("C-c C-j" . go-direx-pop-to-buffer))

  :init
  (add-hook 'go-mode-hook 'nice-prog-hook)
  (add-hook 'go-mode-hook 'go-eldoc-setup)
  (add-hook 'go-mode-hook (lambda () (subword-mode 1)))

  :config
  (push '("^\*go-direx:"
	  :regexp    t
	  :position  left
	  :width     0.2
	  :dedicated t
	  :stick     t)
	popwin:special-display-config)
  )

;; highlight-parentheses
(use-package highlight-parentheses
  :ensure t
  :diminish highlight-parentheses-mode

  :config

  ;; Org-mode hooks
  (add-hook 'org-mode-hook 'nice-text-hook)
  (add-hook 'org-mode-hook 'nice-org-hook)
  (add-hook 'org-mode-hook (lambda () (org-bullets-mode 1)))
  )

;; org-gcal
;;
;; LATER: When org-gcal is compliant with version 8.2.10 (Default
;; under Emacs 25.3)

;; php-mode
(use-package php-mode
  :ensure t
  :ensure php-auto-yasnippets
  :ensure php-eldoc
  :ensure php-extras
  :ensure phpcbf
  :ensure phpunit

  :no-require t

  :mode ("\\.php\\'" . php-mode)

  :bind (:map php-mode-map
	      ("C-c C--" . php-current-class)
	      ("C-c C-=" . php-current-namespace)
	      ("C-c C-y" . 'yas/create-php-snippet)
	      ("C-x p"   . php-insert-doc-block)
	      )

  :init
  (require 'php-doc)
  (require 'php-ext)
  (add-hook 'php-mode-hook 'nice-prog-hook)
  (add-hook 'php-mode-hook (lambda () (subword-mode 1)))

  :config
  ;; Load php documentor
  (load-file "~/.emacs.d/thirdparty/phpdocumentor.el")

;; twilight-theme
(use-package twilight-theme
  :ensure t
  :if (equal custom-file cmf-custom-256)
  :init
  (load-theme 'twilight t)

  :custom-face
  (cfw:face-toolbar-button-off ((t (:foreground "grey65" :weight bold))))
  )

;; twittering-mode
(use-package twittering-mode
  :ensure t
  :no-require t

      "* %^{Description}  %^G
  Added: %U
  Context: %a

  %?" :empty-lines 1)
     ("j" "Journal Entry" entry
      (file+datetree "~/org/journal.org")
      "** %^{Heading} :JOURNAL:%^G
  Added: %U

  %?" :empty-lines 1)
     ("B" "Blood Pressure Log Entry" table-line
      (file+headline "~/org/journal.org" "Blood Pressure Log")
      "| %^u | %^{Systolic} | %^{Diastolic} |")
     ("E" "Household Expense" table-line

;;; php-doc.el --- doc block generator/extractor for php

;; Copyright (C) 2010, 2013 Stefan Siegl <stesie@brokenpipe.de>

;; Maintainer: Stefan Siegl <stesie@brokenpipe.de>
;; Author: Stefan Siegl <stesie@brokenpipe.de>
;; Keywords: php docblock
;; Created: 2010
;; Modified: 2013-09-14
;; X-URL: https://gist.github.com/stesie

;;; License

;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License
;; as published by the Free Software Foundation; either version 3
;; of the License, or (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
;; 02111-1307, USA.

;;; Usage

;; Put this file in your Emacs lisp path (eg. site-lisp) and add to
;; your .emacs file:
;;
;;   (require 'php-doc)

;; Then bind it to whatever key you like
;;
;; (add-hook 'php-mode-hook
;;           (lambda ()
;;             (local-set-key (kbd "M-P") 'php-insert-doc-block)))


;;; Code:

(defgroup php-doc nil
  "PHP docblock generator"
  :prefix "php-insert-doc-"
  :group 'php)

(defcustom php-insert-doc-access-tag t
  "When set to true a @access tag is added to generated docblocks."
  :type 'boolean
  :group 'php-doc)

(defcustom php-insert-doc-attribute-tags t
  "When set to true tags like @abstract or @static are added to
generated docblocks."
  :type 'boolean
  :group 'php-doc)

(defcustom php-insert-doc-uses-tag t
  "When set to true a @uses tag is added for inheritting classes."
  :type 'boolean
  :group 'php-doc)

(defcustom php-insert-doc-varname-on-var t
  "When set to true the variable name is repeated in the doc block,
otherwise only ``@var mixed'' is written."
  :type 'boolean
  :group 'php-doc)

(defcustom php-insert-doc-package-tag nil
  "When set to NIL no @package tag is written to class doc blocks.
Otherwise the provided string is used."
  :type 'string
  :group 'php-doc)

(defcustom php-insert-doc-global-type-alist nil
  "Alist mapping global variable names to doc block types.
If this alist has no key equal to the variable name, the @global tag
is written with type set to ``mixed''."
  :type '(alist :key-type string :value-type string)
  :group 'php-doc)

(defcustom php-insert-doc-author-name (user-full-name)
  "The name to use for the @author tag.
If set to NIL no @author tag is written at all."
  :type 'string
  :group 'php-doc)

(defcustom php-insert-doc-author-email user-mail-address
  "The email address to use for the @author tag.
If set to NIL no email address is written next to the @author tag."
  :type 'string
  :group 'php-doc)

(defcustom php-insert-doc-copyright-name (user-full-name)
  "The name to use for the @copyright tag.
If set to NIL no @copyright tag is written at all."
  :type 'string
  :group 'php-doc)

(defcustom php-insert-doc-copyright-email user-mail-address
  "The email address to use for the @copyright tag.
If set to NIL no email address is written next to the @copyright tag."
  :type 'string
  :group 'php-doc)


(defun php-insert-doc-block ()
  "Insert php-doc block for current function, class or variable."
  (interactive)
  (let ((end (point)))
    (when (looking-at "\\s\)")
      (backward-list 1))
    (back-to-indentation)

    (let ((start (point)))
      (php-insert-doc-block-for-string
       (buffer-substring-no-properties (point) end))
      (indent-region start (point) nil)
      (indent-according-to-mode)

      ;; last but not least position point at first line of doc block
      (goto-char start)
      (next-line)
      (end-of-line))))


(defun php-insert-doc-block-for-function (attributes arglist)
  "Insert php-doc block for the specified function"
  (dolist (arg (split-string arglist "\s*,\s*"))
    (php-insert-doc-block-param "param" arg t))

  (php-insert-doc-block-tags-for-attributes attributes)
  (php-insert-doc-block-access-tag attributes)

  (let ((content)
	(start 0))
    (save-excursion
      (set-mark (point))
      (php-end-of-defun)
      (setq content (buffer-substring-no-properties (mark) (point))))

    (while (string-match "global \\(\\(\s*,?\s*$[a-zA-Z0-9_]+\\)+\\)\s*;" content start)
      (setq start (match-end 0))
      (dolist (var-name (split-string (match-string 1 content) "\s*,\s*"))
	(insert "* @global ")
	(insert (or
		 (cdr (assoc-string var-name php-insert-doc-global-type-alist))
		 "mixed"))
	(insert " ")
	(insert var-name)
	(insert "\n")))

    (when (string-match "return" content)
      (insert "* @return mixed\n"))))

(defun php-insert-doc-block-tags-for-attributes (attributes)
  (when php-insert-doc-attribute-tags
    (when (string-match "static" attributes) (insert "* @static\n"))
    (when (string-match "final" attributes) (insert "* @final\n"))
    (when (string-match "abstract" attributes) (insert "* @abstract\n"))))

(defun php-insert-doc-block-access-tag (attributes)
  (let ((access "public"))
    (when (string-match "private" attributes) (setq access "private"))
    (when (string-match "protected" attributes) (setq access "protected"))

    (when php-insert-doc-access-tag
      (insert "* @access " access "\n"))))

(defun php-insert-doc-block-for-class (sig)
  (when php-insert-doc-package-tag
    (insert-string "* @package ")
    (insert-string php-insert-doc-package-tag)
    (insert-string "\n"))

  (when php-insert-doc-uses-tag
    (when (string-match "extends\s+\\(\[A-Za-z0-9_\]+\\)" sig)
      (insert (concat "* @uses " (match-string 1 sig) "\n"))))

  (when php-insert-doc-copyright-name
    (insert "* @copyright ")
    (insert (format-time-string "%Y"))
    (insert " ")
    (insert php-insert-doc-copyright-name)
    (when php-insert-doc-copyright-email
      (insert " <")
      (insert php-insert-doc-copyright-email)
      (insert ">"))
    (insert "\n"))

  (when php-insert-doc-author-name
    (insert "* @author ")
    (insert php-insert-doc-author-name)
    (when php-insert-doc-author-email
      (insert " <")
      (insert php-insert-doc-author-email)
      (insert ">"))
    (insert "\n")))


(defun php-insert-doc-block-for-string (sig)
  "Insert php-doc block for provided function, class or variable signature"
  (catch 'handled
    (insert "/**\n* \n*\n")

    ;; handle functions
    (when (string-match "function\s*\\([A-Za-z0-9_]+\\)\s*\(\\([^\)]*\\)\)" sig)
      (php-insert-doc-block-for-function (substring sig 0 (match-beginning 0))
					 (match-string 2 sig))
      (throw 'handled t))

    ;; handle classes
    (when (string-match "class" sig)
      (php-insert-doc-block-for-class sig)
      (throw 'handled t))

    ;; (try to) handle everything else (i.e. variables)
    (php-insert-doc-block-param "var" sig php-insert-doc-varname-on-var)
    (php-insert-doc-block-tags-for-attributes sig)
    (php-insert-doc-block-access-tag sig))

  (insert "*/\n"))

(defun php-insert-doc-block-param (type arg insert-param-name)
  (when (string-match "\s*\\([a-zA-Z0-9_]+\\)?\s*\\($\[a-zA-Z0-9_\]+\\)\s*\\(=\[^;\]*\\)?" arg)
    (let ((param-type "mixed")
	  (param-name (match-string 2 arg)))

      ;; consider type hint
      (when (match-beginning 1)
	(setq param-type (match-string 1 arg))

	;; make sure not to match a keyword
	(dolist (keyword '("final" "abstract" "static" "public" "private" "protected" "var"))
	  (when (string= keyword param-type)
	    (setq param-type "mixed"))))

      ;; check initializer
      (when (and (string= param-type "mixed") (match-beginning 3))
	(setq arg (match-string 3 arg))

	(when (string-match "^=\s*\['\"]" arg)
	  (setq param-type "string"))
	(when (string-match "^=\s*\[0-9\]+$" arg)
	  (setq param-type "int"))
	(when (string-match "^=\s*\[0-9\]*\\.\[0-9\]+$" arg)
	  (setq param-type "float"))
	(when (string-match "^=\s*true$" arg)
	  (setq param-type "bool"))
	(when (string-match "^=\s*false$" arg)
	  (setq param-type "bool")))

      (insert (concat "* @" type " " param-type))

      (when insert-param-name
	(insert " ")
	(insert param-name))

      (insert "\n"))))


(provide 'php-doc)

SHELLDIR=${HOME}/SHELL
BACKUPDIR=${HOME}/Backup/shell
HOMETMPDIR=${HOME}/tmp
RSYNC=rsync
RSYNC_EXCLUDE=global-excludes
RSYNC_OPTS="-Ccav --delete --exclude-from=${RSYNC_EXCLUDE}"
MAKE=make
COPYRIGHT='Copyright (c) 2000-2018 Christopher M. Fuhrman'
OUTPUTSPACING=55
DRYRUN=""
UNINSTALL=0
GOINSTALL=0
GOPATH=${HOME}/go
BUILD_EMACS_PACKAGES=0
EMACS_OUTPUT_LOG=${HOME}/tmp/emacs-pkg-install-$$-`date +%y%m%d`.log

	inform $L2 $TRUE "Environment set up for golang"

	if ! type -p go >/dev/null; then
		inform $L2 $TRUE \
		       "${BOLD}$YELLOW}NOTICE:${NORMAL} Go binary not found in path"
	fi

	# Install gocode for auto-completion
	if [ ! -f {$GOBIN}/gocode ]; then
		inform $L2 $TRUE "Installing gocode"
		go get -u github.com/nsf/gocode
	fi

	# Install gotags for go-direx
	if [ ! -f {$GOBIN}/gotags ]; then
		inform $L2 $TRUE "Installing gotags"
		go get -u github.com/jstemmer/gotags
	fi
}

# Function: headerDisplay
#
# Displays a header for the world to see

headerDisplay ()