Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Further customizations of emacs environment (docs/README.org) - Bump copyright - Update list of supported operating systems (emacs.d/init.el) - Install and configure the following packages: + popwin[1] + calfw[2] + geben[3] + go-mode[4] and related packages - Pin the following packages to melpa-stable + all-the-icons + all-the-icons-ivy - Break out all-the-icons-dired and all-the-icons-ivy to their separate use-package blocks - Switch to using php-doc.el for automatically generating PHP documentation blocks (emacs-d/cmf-org-settings.el) - Add journal tag to all journal entries (setup.sh) - Install gocode and gotags to use with go-mode Footnotes: [1] https://github.com/m2ym/popwin-el [2] https://github.com/m2ym/popwin-el [3] https://github.com/ahungry/geben [4] https://github.com/dominikh/go-mode.el |
---|---|
Downloads: | Tarball | ZIP archive |
Timelines: | family | ancestors | descendants | both | trunk | v2018.02.11 |
Files: | files | file ages | folders |
SHA1: |
392bdcb90ec9a196708bab1a06c17940 |
User & Date: | cfuhrman 2018-02-10 23:48:40.916 |
Context
2018-08-06
| ||
21:46 | Import latest changes from personal repo (GNUMakefile) - Set rsync(1) timeout to 30 seconds (bash_darwin) - Switch /usr/pkg to /opt/pkg to make installation easier (bashrc) - Make sure /opt/pkg/bin is before /usr/bin on MacOSX. Also, there is no need to have /opt/schily/bin twice in our path - Use an alias instead of GREP_OPTIONS as GREP_OPTIONS is now deprecated[1] (docs/README.org) - Note ShellPAK now support customization of GNU nano(1) editor - Update supported operating systems - It's OpenSUSE, not OpenSuSE - Add instructions for setting up pythong (emacs.d/init.el) - Add /opt/pkg/bin to cmf-path-list - Customize use-fancy-splash-screens-p for emacs version 24.5 (inclusive )-> 25.2.1 (exclusive) - Alignment fixes - Only customize height for when running Emacs under X-Windows - Add hooks via :hook declaration - Remove ac-ispell as it was causing too many issues to be useful - Remove popwin package as it was causing too many issues - Only install ace-window for emacs 24.4 and greater - Only install all-the-icons for emacs 24.4 and greater - Remove diff-mode customizations which were for popwin - Further customize flycheck - Only install gited for emacs 24.4 and greater - Bind gited-list-branches to C-c C-g - Swiper customizations for Emacs 26 - Install and configure markdown-mode - Install and configure org-fancy-priorities - Enable line up of cascading calls when editing PHP files - Set up Python development in Emacs - Add remote-url to VC-Fossil header - which-key requires Emacs 24.4 and greater - Customize org-crypt (emacs.d/shippets/sh-mode/bp) - Align copyright information (global-excludes) - Exclude the following from getting hosed: + .aggrev_defs + .python-environments + tramp (setup.sh) - Add support for customizing python environment (thirdparty/git-completion.bash, thirdparty/git-prompt) - Import git completion and prompt scripts from git v2.15.1 Footnotes: [1] https://www.gnu.org/software/grep/manual/grep.html#index-GREP_005fOPTIONS-environment-variable check-in: a690e0857b user: cfuhrman tags: trunk, v2018.08 | |
2018-02-10
| ||
23:48 | Further customizations of emacs environment (docs/README.org) - Bump copyright - Update list of supported operating systems (emacs.d/init.el) - Install and configure the following packages: + popwin[1] + calfw[2] + geben[3] + go-mode[4] and related packages - Pin the following packages to melpa-stable + all-the-icons + all-the-icons-ivy - Break out all-the-icons-dired and all-the-icons-ivy to their separate use-package blocks - Switch to using php-doc.el for automatically generating PHP documentation blocks (emacs-d/cmf-org-settings.el) - Add journal tag to all journal entries (setup.sh) - Install gocode and gotags to use with go-mode Footnotes: [1] https://github.com/m2ym/popwin-el [2] https://github.com/m2ym/popwin-el [3] https://github.com/ahungry/geben [4] https://github.com/dominikh/go-mode.el check-in: 392bdcb90e user: cfuhrman tags: trunk, v2018.02.11 | |
2017-12-16
| ||
21:04 | Optimize emacs packaging loading & configuration - Move additional mode-spectific variables into their respective use-package blocks - Re-organize where functions are loaded, with mode-specific functions belonging to their respective use-package blocks - Simplify prog-mode-hook & text-mode-hook customization - Customize trash directory on Mac OS X systems - Lose osx-trash which is s-l-o-w - Customize & simplify auto-complete[1] mode setup. Also, set up auto-complete /before/ yasnippet[2] - Massively simplify yasnippet configuration - Switch keybinding for ace-window[3] - Switch to using arjen grey theme[4] - Switch to using melpa stable[5] where applicable - Disable global-emojify-mode-line-mode since it wrecks havoc with cut-n-paste - I haven't found an excuse to use Go, so don't install go-mode. Hopefully this will change - Don't use ac-php since it's resource intensive. I may readdress this in the future Also, do not accidentally hose network-security.data file Footnotes: [1] https://github.com/auto-complete/auto-complete [2] https://github.com/joaotavora/yasnippet [3] https://github.com/abo-abo/ace-window [4] https://github.com/credmp/arjen-grey-theme [5] http://stable.melpa.org/#/ check-in: 178b66d4b7 user: cfuhrman tags: trunk, v2017.12.16 | |
Changes
Changes to README.md.
︙ | ︙ | |||
53 54 55 56 57 58 59 | ## 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 | | | | 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | ## 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> |
︙ | ︙ | |||
143 144 145 146 147 148 149 | # 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> | | | 143 144 145 146 147 148 149 150 151 152 153 154 155 | # 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. |
Changes to docs/README.org.
︙ | ︙ | |||
34 35 36 37 38 39 40 | ** Supported Platforms The following operating systems are known to be supported: - Mac OS X 10.9 (Darwin) - NetBSD 6.1.x | | | | 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | ** 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 |
︙ | ︙ | |||
130 131 132 133 134 135 136 | * Author Christopher M. Fuhrman [[mailto:cfuhrman@pobox.com][cfuhrman@pobox.com]] * Copyright | | | 130 131 132 133 134 135 136 137 138 139 140 141 142 | * 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. |
Changes to emacs.d/init.el.
︙ | ︙ | |||
47 48 49 50 51 52 53 54 55 56 57 58 59 60 | (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" "/Library/TeX/texbin")) ;; Customize generic variables (custom-set-variables '(c-default-style (quote ((c-mode . "cmf") | > | 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 | (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") |
︙ | ︙ | |||
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 | :init (yas-global-mode 1) :custom (yas-wrap-around-region 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 | > > > > > > > > > > > | < | > > > > > > > > > > > > > > > > > > > > > > > | 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 | :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 |
︙ | ︙ | |||
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 | :ensure t :if window-system :init (add-to-list 'custom-safe-themes "c74e83f8aa4c78a121b52146eadb792c9facc5b1f02c917e3dbb454fca931223") (load-theme 'arjen-grey t) ) ;; 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) ) ;; [c]perl-mode (use-package cperl-mode :mode ("\\.cgi\\'" . cperl-mode) :init (defalias 'perl-mode 'cperl-mode) | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 | :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) |
︙ | ︙ | |||
506 507 508 509 510 511 512 513 514 515 516 517 518 519 | (use-package crontab-mode :ensure t :no-require t :mode (("\\.cron\\(tab\\)?\\'" . crontab-mode) ("cron\\(tab\\)?\\." . crontab-mode)) ) ;; eldoc (use-package eldoc :diminish eldoc-mode " Doc" ) ;; emojify | > > > > > > > > > > > | 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 | (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 |
︙ | ︙ | |||
534 535 536 537 538 539 540 | (use-package flycheck :ensure t :init (global-flycheck-mode) :custom | | | 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 | (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 |
︙ | ︙ | |||
573 574 575 576 577 578 579 580 581 582 583 584 585 586 | (forecast-longitude cmf-longitude) (forecast-city cmf-location-name) (forecast-country "United States") (forecast-units 'us) (forecast-api-key "f78b853ac0c972cccf06e75e21afbe9d") ) ) ;; gited - dired for git branches (use-package gited :ensure t :no-require t :bind ( | > > > > > > > | 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 | (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 ( |
︙ | ︙ | |||
596 597 598 599 600 601 602 603 604 605 606 607 608 609 | :diminish ggtags-mode " 🄶" :init (add-hook 'prog-mode-hook (lambda () (ggtags-mode t))) ) ;; highlight-parentheses (use-package highlight-parentheses :ensure t :diminish highlight-parentheses-mode :config | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 | :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 |
︙ | ︙ | |||
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 | ;; 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))) ) ;; 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) | > > > > > | > | 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 | ;; 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") |
︙ | ︙ | |||
868 869 870 871 872 873 874 875 876 877 878 879 880 881 | ;; twilight-theme (use-package twilight-theme :ensure t :if (equal custom-file cmf-custom-256) :init (load-theme 'twilight t) ) ;; twittering-mode (use-package twittering-mode :ensure t :no-require t | > > > | 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 | ;; 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 |
︙ | ︙ |
Changes to emacs.d/lisp/cmf-org-settings.el.
︙ | ︙ | |||
104 105 106 107 108 109 110 | "* %^{Description} %^G Added: %U Context: %a %?" :empty-lines 1) ("j" "Journal Entry" entry (file+datetree "~/org/journal.org") | | | 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | "* %^{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 |
︙ | ︙ |
Added emacs.d/thirdparty/php-doc.el.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | ;;; 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) |
Changes to setup.sh.
︙ | ︙ | |||
33 34 35 36 37 38 39 | 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 | | | 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | 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 |
︙ | ︙ | |||
279 280 281 282 283 284 285 286 287 288 289 290 291 292 | 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 } # Function: headerDisplay # # Displays a header for the world to see headerDisplay () | > > > > > > > > > > > > | 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 | 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 () |
︙ | ︙ |