mirror of https://github.com/Chizi123/.emacs.d.git

Joel Grunbaum
2020-10-18 8264c0db73fff0869c8b953ead6ff6a4a375bada
commit | author | age
990949 1 #+TITLE: My Emacs configuration
5a75e4 2 #  LocalWords:  poppler mingw emacs eq nt gnuplot setenv mapconcat el cond minibuffer pdf color Smartparens smartparens yas aindent whitespace eldoc ielm ibuffer hippie pscp pos Spaceline spaceline powerline spacemacs seperator dir Yasnippet yasnippet flycheck magit fullscreen CEDET askifnotset semanticdb EDE ede gdb srefactor analyzer eval cdb autosetup ghostscript math unicode reftex bibtex TeXcount texcount str latin rkt PlantUML plantuml autoload alist matlab verilog ds vh src fontify natively fortran dvipng plist xcolor EXWM Zenburn setq zenburn defun dolist init config DejaVu ispell aspell flyspell kbd recentf sexp ov bg listp defadvice progn prog keyfreq autosave dabbrev hl gc linum linux utf RET ARG arg configs backends contribs AucTex tex auctex LaTeX url htmlize linter backend writegood ggtags gtags dired eshell asm cd dwim VHDL defvar ctags vhdl concat sp html awk defalias cedet mips IPython ein contrib pandoc dokuwiki EMMS MPD emms toc favicon href css stylesheet async dataLayer gtag js UA sitelinks br Github postamble isso center disqus onclick Disqus javascript dsq createElement getElementsByTagName xml urlset xmlns curr loc RSS elfeed
8a38cc 3
6252df 4 * OS dependencies
JG 5 Windows and Mac have some interesting paths when starting emacs which needs to be fixed.
6 Using mingw64 in windows and general path in mac.
990949 7 #+BEGIN_SRC emacs-lisp
6252df 8   (cond ((eq system-type 'windows-nt)
JG 9          (add-to-list 'exec-path "C:/msys64/usr/bin")
10          (add-to-list 'exec-path "C:/msys64/mingw64/bin")
11          (add-to-list 'exec-path "c:/Program Files/gnuplot")
12          (setenv "PATH" (mapconcat #'identity exec-path path-separator)))
13         ((eq system-type 'darwin)
14          (use-package exec-path-from-shell
15            :ensure t
16            :config
8264c0 17            (exec-path-from-shell-initialize))
JG 18          (setq default-directory "~/")))
990949 19 #+END_SRC
C 20
21 * Aesthetic changes
0fcc09 22 ** Emacs theme
80d515 23 Theme switcher, using a cond allows loading of many preconfigured themes which can be switched between easily.
JG 24 Zenburn theme is my default.
990949 25 #+BEGIN_SRC emacs-lisp
0fcc09 26   (setq emacs-theme 'zenburn)
80d515 27
JG 28   (defun disable-all-themes ()
29       (dolist (i custom-enabled-themes)
30            (disable-theme i)))
412080 31
0fcc09 32   (cond ((eq emacs-theme 'zenburn)
C 33          (use-package zenburn-theme
34            :ensure t
412080 35            :init
C 36            (disable-all-themes)
0fcc09 37            :config
C 38            (load-theme 'zenburn t)))
39         ((eq emacs-theme 'doom-one)
40          (use-package doom-themes
41            :ensure t
412080 42            :init
C 43            (disable-all-themes)
0fcc09 44            :config
C 45            (setq doom-themes-enable-bolt t
46                  doom-themes-enable-italic t)
47            (load-theme 'doom-one t)
48            (doom-themes-visual-bell-config)
412080 49            (doom-themes-org-config)))
a428a2 50         ((eq emacs-theme 'nord)
JG 51          (use-package nord-theme
52            :ensure t
53            :init
54            (disable-all-themes)
55            :config
56            (load-theme 'nord t)))
b0ee5f 57         ((eq emacs-theme 'solarized)
JG 58          (use-package solarized-theme
59            :ensure t
60            :init
61            (disable-all-themes)
62            :config
63            (load-theme 'solarized-dark t)))
995f2c 64         ((eq emacs-theme 'jetbrains-darcula)
JG 65          (use-package jetbrains-darcula-theme
66            :ensure t
67            :init
68            (disable-all-themes)
69            :config
70            (load-theme 'jetbrains-darcula t)))
412080 71         ((eq emacs-theme 'none)
80d515 72          (disable-all-themes)))
990949 73 #+END_SRC
8a38cc 74
990949 75 ** Default font
80d515 76 Set default font and faces.
20e001 77 #+BEGIN_SRC emacs-lisp 
350884 78   (cond ((member "Dank Mono" (font-family-list))
JG 79          (set-frame-font "Dank Mono-11" nil t))
80         ((member "DejaVu Sans Mono" (font-family-list))
81          (set-frame-font "DejaVu Sans Mono" nil t))
82         ((member "Source Code Pro" (font-family-list))
83          (set-frame-font "Source Code Pro-10" nil t)))
84
20e001 85   (set-face-italic 'font-lock-comment-face t)
C 86   (set-face-italic 'font-lock-keyword-face t)
990949 87 #+END_SRC
8a38cc 88
990949 89 ** Remove menu bar, toolbar, but keep scroll bar
80d515 90 Make the emacs interface slightly nicer.
990949 91 #+BEGIN_SRC emacs-lisp
C 92   (menu-bar-mode 0)
93   (tool-bar-mode 0)
94   (scroll-bar-mode 1)
95 #+END_SRC
350884 96 * COMMENT EXWM
JG 97 Emacs window manager.
98 Tiling window manager that runs in emacs.
5a75e4 99 Open external applications with =s-&=
350884 100 #+BEGIN_SRC emacs-lisp
JG 101   (use-package exwm
102     :ensure t
103     :config
104     (require 'exwm-config)
105     (exwm-config-default))
106 #+END_SRC
990949 107
C 108 * Writing requirements
109 ** Spellchecking
80d515 110 Use aspell for spellchecking. 
JG 111 Auto-enable in latex and org as they're the main writing modes.
990949 112 #+BEGIN_SRC emacs-lisp
C 113   (require 'ispell)
114   (setq-default ispell-program-name "aspell")
115   (setq-default ispell-local-dictionary "en_AU")
f0bf38 116   (add-hook 'tex-mode-hook 'flyspell-mode)
990949 117   (add-hook 'latex-mode-hook 'flyspell-mode)
f0bf38 118   (add-hook 'TeX-mode-hook 'flyspell-mode)
JG 119   (add-hook 'LaTeX-mode-hook 'flyspell-mode)
0ba1ff 120   ;; (add-hook 'latex-mode-hook 'flyspell-buffer)
990949 121   (add-hook 'org-mode-hook 'flyspell-mode)
0ba1ff 122   ;; (add-hook 'org-mode-hook 'flyspell-buffer)
f1b53f 123   (diminish 'flyspell-mode)
a428a2 124
990949 125 #+END_SRC
C 126
127 ** Switch-window
80d515 128 Helps to change windows easily when many are open at once.
990949 129 #+BEGIN_SRC emacs-lisp
C 130 (use-package switch-window
131   :ensure t
132   :config
133     (setq switch-window-input-style 'minibuffer)
134     (setq switch-window-increase 4)
135     (setq switch-window-threshold 2)
136     (setq switch-window-shortcut-style 'qwerty)
137     (setq switch-window-qwerty-shortcuts
138         '("a" "s" "d" "f" "j" "k" "l" "i" "o"))
139   :bind
140     ([remap other-window] . switch-window))
141 #+END_SRC
8a38cc 142
990949 143 ** Go to new window when opened
80d515 144 Go to new window when its opened instead of staying with current one.
990949 145 #+BEGIN_SRC emacs-lisp
C 146   (defun split-and-follow-horizontally ()
147     (interactive)
148     (split-window-below)
149     (balance-windows)
150     (other-window 1))
151   (global-set-key (kbd "C-x 2") 'split-and-follow-horizontally)
152
153   (defun split-and-follow-vertically ()
154     (interactive)
155     (split-window-right)
156     (balance-windows)
157     (other-window 1))
158   (global-set-key (kbd "C-x 3") 'split-and-follow-vertically)
159 #+END_SRC
8a38cc 160
990949 161 ** PDF-tools
80d515 162 Helpful pdf viewer.
990949 163 #+BEGIN_SRC emacs-lisp
bf794a 164   (use-package pdf-tools
JG 165     :ensure t
166     :config
167     (pdf-tools-install 1))
990949 168 #+END_SRC
8a38cc 169
be9cff 170 ** COMMENT Writegood-mode
80d515 171 Supposedly should provide insight to writing quality.
49aa9f 172 #+BEGIN_SRC emacs-lisp
JG 173   (use-package writegood-mode
174     :ensure t
175     :hook (text-mode . writegood-mode))
176 #+END_SRC
177
990949 178 * Helm and Projectile
C 179 ** Helm core
80d515 180 Helm aids the user interface for emacs. Adds visual and auto-complete feedback for emacs commands.
990949 181 #+BEGIN_SRC emacs-lisp
C 182   (use-package helm-config
183     :ensure helm
184     :bind (("M-x" . helm-M-x)
185            ("C-x C-f" . helm-find-files)
186            ("M-y" . helm-show-kill-ring)
187            ("C-x b" . helm-mini)
188            ("C-c h o" . helm-occur))
189     :config
190     (setq helm-M-x-fuzzy-match t)
191     (setq helm-buffers-fuzzy-matching t
192           helm-recentf-fuzzy-match    t)
193     (setq helm-split-window-in-side-p           t ; open helm buffer inside current window, not occupy whole other window
194           helm-move-to-line-cycle-in-source     t ; move to end or beginning of source when reaching top or bottom of source.
195           helm-ff-search-library-in-sexp        t ; search for library in `require' and `declare-function' sexp.
196           helm-scroll-amount                    8 ; scroll 8 lines other window using M-<next>/M-<prior>
197           helm-ff-file-name-history-use-recentf t
198           helm-echo-input-in-header-line t)
199     (defun spacemacs//helm-hide-minibuffer-maybe ()
200       "Hide minibuffer in Helm session if we use the header line as input field."
201       (when (with-helm-buffer helm-echo-input-in-header-line)
202         (let ((ov (make-overlay (point-min) (point-max) nil nil t)))
203           (overlay-put ov 'window (selected-window))
204           (overlay-put ov 'face
205                        (let ((bg-color (face-background 'default nil)))
206                          `(:background ,bg-color :foreground ,bg-color)))
207           (setq-local cursor-type nil))))
208     (add-hook 'helm-minibuffer-set-up-hook
209               'spacemacs//helm-hide-minibuffer-maybe)
210     (helm-mode 1))
211 #+END_SRC
8a38cc 212
990949 213 ** Projectile
80d515 214 Projectile is project management framework for emacs.
JG 215 Helps in navigation and management of projects.
216 Identifies project layout from git.
990949 217 *** Enable it
C 218  #+BEGIN_SRC emacs-lisp
219    (use-package projectile
220      :ensure t
221      :bind ("C-c p" . projectile-command-map)
222      :diminish projectile-mode
223      :config
224      (projectile-global-mode)
225      (setq projectile-completion-system 'helm)
226      (when (eq system-type 'windows-nt)
227        (setq projectile-indexing-method 'alien)))
228  #+END_SRC
8a38cc 229
990949 230 *** Let it compile things
80d515 231 Shortcut for compilation.
990949 232  #+BEGIN_SRC emacs-lisp
C 233    (global-set-key (kbd "<f5>") 'projectile-compile-project)
234  #+END_SRC
8a38cc 235
990949 236 *** Enable communication with helm
80d515 237 Use helm to manage project.
990949 238 #+BEGIN_SRC emacs-lisp
baf326 239   (use-package helm-projectile
C 240     :ensure t
241     :config
242     (helm-projectile-on))
990949 243 #+END_SRC
8a38cc 244
be9cff 245 ** COMMENT ggtags
0ba1ff 246 Use GNU Global Tags. Can be useful for large projects.
bf794a 247 #+BEGIN_SRC emacs-lisp
JG 248     (use-package ggtags
249       :ensure t
250       :bind (("C-c g s" . ggtags-find-other-symbol)
251            ("C-c g h" . ggtags-view-tag-history)
252            ("C-c g r" . ggtags-find-reference)
253            ("C-c g f" . ggtags-find-file)
254            ("C-c g c" . ggtags-create-tags)
255            ("C-c g u" . ggtags-update-tags))
256       :config
257       (add-hook 'c-mode-common-hook
258               (lambda ()
259                 (when (derived-mode-p 'c-mode 'c++-mode 'java-mode)
260                   (ggtags-mode 1))))
261       )
262
263     (setq
264      helm-gtags-ignore-case t
265      helm-gtags-auto-update t
266      helm-gtags-use-input-at-cursor t
267      helm-gtags-pulse-at-cursor t
268      helm-gtags-prefix-key "\C-c g"
269      helm-gtags-suggested-key-mapping t
270      )
271
272     (use-package helm-gtags
273       :ensure t
274       :config
275       (add-hook 'dired-mode-hook 'helm-gtags-mode)
276       (add-hook 'eshell-mode-hook 'helm-gtags-mode)
277       (add-hook 'c-mode-hook 'helm-gtags-mode)
278       (add-hook 'c++-mode-hook 'helm-gtags-mode)
279       (add-hook 'asm-mode-hook 'helm-gtags-mode)
280     
281       (define-key helm-gtags-mode-map (kbd "C-c g a") 'helm-gtags-tags-in-this-function)
282       (define-key helm-gtags-mode-map (kbd "C-j") 'helm-gtags-select)
283       (define-key helm-gtags-mode-map (kbd "M-.") 'helm-gtags-dwim)
284       (define-key helm-gtags-mode-map (kbd "M-,") 'helm-gtags-pop-stack)
285       (define-key helm-gtags-mode-map (kbd "C-c <") 'helm-gtags-previous-history)
286       (define-key helm-gtags-mode-map (kbd "C-c >") 'helm-gtags-next-history))
287 #+END_SRC
288
be9cff 289 ** COMMENT Ctags
0ba1ff 290 Ctags is an older tagging program that supports more languages.
JG 291 Currently setup for VHDL as I had to work with a large existing VHDL code-base.
bf794a 292 #+BEGIN_SRC emacs-lisp
JG 293   (defvar ctags-command "ctags -e -R --languages=vhdl")
294
295   (defun ctags ()
296     (call-process-shell-command ctags-command nil "*Ctags*"))
297
298
299   (defun ctags-find-tags-file ()
300     "Recursively searches each parent directory for a file named
301                 TAGS and returns the path to that file or nil if a tags file is
302                 not found or if the buffer is not visiting a file."
303     (progn
304       (defun find-tags-file-r (path)
305         "Find the tags file from current to the parent directories."
306         (let* ((parent-directory (file-name-directory (directory-file-name path)))
307                (tags-file-name (concat (file-name-as-directory path) "TAGS")))
308           (cond
309            ((file-exists-p tags-file-name) (throw 'found tags-file-name))
310            ((string= "/TAGS" tags-file-name) nil)
311            (t (find-tags-file-r parent-directory)))))
312
313       (if (buffer-file-name)
314           (catch 'found
315             (find-tags-file-r (file-name-directory buffer-file-name)))
316         nil)))
317
318   (defun ctags-set-tags-file ()
319     "Uses `ctags-find-tags-file' to find a TAGS file. If found,
320                 set 'tags-file-name' with its path or set as nil."
321     (setq-default tags-file-name (ctags-find-tags-file)))
322
323   (defun ctags-create-tags-table ()
324     (interactive)
325     (let* ((current-directory default-directory)
326            (top-directory (read-directory-name
327                            "Top of source tree: " default-directory))
328            (file-name (concat (file-name-as-directory top-directory) "TAGS")))
329       (cd top-directory)
330       (if (not (= 0 (ctags)))
331           (message "Error creating %s!" file-name)
332         (setq-default tags-file-name file-name)
333         (message "Table %s created and configured." tags-file-name))
334       (cd current-directory)))
335
336   (defun ctags-update-tags-table ()
337     (interactive)
338     (let ((current-directory default-directory))
339       (if (not tags-file-name)
340           (message "Tags table not configured.")
341         (cd (file-name-directory tags-file-name))
342         (if (not (= 0 (ctags)))
343             (message "Error updating %s!" tags-file-name)
344           (message "Table %s updated." tags-file-name))
345         (cd current-directory))))
346
347   (defun ctags-create-or-update-tags-table ()
348     "Create or update a tags table with `ctags-command'."
349     (interactive)
350     (if (not (ctags-set-tags-file))
351         (ctags-create-tags-table)
352       (ctags-update-tags-table)))
353
354
355   (defun ctags-search ()
356     "A wrapper for `tags-search' that provide a default input."
357     (interactive)
358     (let* ((symbol-at-point (symbol-at-point))
359            (default (symbol-name symbol-at-point))
360            (input (read-from-minibuffer
361                    (if (symbol-at-point)
362                        (concat "Tags search (default " default "): ")
363                      "Tags search (regexp): "))))
364       (if (and (symbol-at-point) (string= input ""))
365           (tags-search default)
366         (if (string= input "")
367             (message "You must provide a regexp.")
368           (tags-search input)))))
369 #+END_SRC
370
990949 371 * Small tweaks
C 372 ** Remove startup screen
0ba1ff 373 Start on scratch buffer instead.
990949 374 #+BEGIN_SRC emacs-lisp
C 375 (setq inhibit-startup-message t)
376 #+END_SRC
8a38cc 377
990949 378 ** Disable bell
0ba1ff 379 Bloody bell dings every time you hit a key too much.
990949 380 #+BEGIN_SRC emacs-lisp
C 381 (setq ring-bell-function 'ignore)
382 #+END_SRC
8a38cc 383
990949 384 ** Pretty symbols
0ba1ff 385 Why not? They make it look nice.
990949 386 #+BEGIN_SRC emacs-lisp
C 387   (when window-system
388     (use-package pretty-mode
389       :ensure t
390       :diminish t
391       :config
392       (global-pretty-mode)))
393 #+END_SRC
8a38cc 394
0ba1ff 395 ** COMMENT Find file other window
990949 396 Lets it accept more than one file. Works recursively.
C 397 #+BEGIN_SRC emacs-lisp
398 (defadvice find-file-other-window (around find-files activate)
399   (if (listp filename)
400       (loop for f in filename do (find-file-other-window f wildcards))
401     ad-do-it))
402 #+END_SRC
8a38cc 403
990949 404 ** Which key
0ba1ff 405 Helps to explain keybindings if you get lost.
990949 406 #+BEGIN_SRC emacs-lisp
C 407   (use-package which-key
408     :ensure t
409     :diminish which-key-mode
410     :config
411     (which-key-mode))
412 #+END_SRC
8a38cc 413
bf794a 414 ** Config shortcuts
JG 415 *** Go to this file
990949 416 #+BEGIN_SRC emacs-lisp
C 417 (defun config-visit ()
418   (interactive)
419   (find-file "~/.emacs.d/config.org"))
420 (global-set-key (kbd "C-c e d") 'config-visit)
421 #+END_SRC
8a38cc 422
bf794a 423 *** Go to init.el
990949 424 #+BEGIN_SRC emacs-lisp
C 425   (defun init-visit ()
426     (interactive)
427     (find-file "~/.emacs.d/init.el"))
428   (global-set-key (kbd "C-c e i") 'init-visit)
429 #+END_SRC
8a38cc 430
bf794a 431 *** Reload configuration
990949 432 #+BEGIN_SRC emacs-lisp
C 433 (defun config-reload ()
434   "Reloads ~/.emacs.d/config.org at run time"
435   (interactive)
436   (org-babel-load-file (expand-file-name "~/.emacs.d/config.org")))
437 (global-set-key (kbd "C-c e r") 'config-reload)
438 #+END_SRC
8a38cc 439
990949 440 ** Smartparens
0ba1ff 441 Matches brackets automatically. Added "$" for latex in org mode.
990949 442 #+BEGIN_SRC emacs-lisp
0ba1ff 443   (use-package smartparens
JG 444     :ensure t
445     :diminish smartparens-mode
446     :config
447     (progn
448       (require 'smartparens-config)
449       (smartparens-global-mode 1))
450     (sp-with-modes 'org-mode
451       (sp-local-pair "$" "$")))
990949 452 #+END_SRC
8a38cc 453
0ba1ff 454 ** COMMENT Rainbow
JG 455 Its a little gimmicky but its still cool.
456 Colours according to code after a "#", works with 3 and 6 character hex codes.
990949 457 #+BEGIN_SRC emacs-lisp
C 458   (use-package rainbow-mode
459     :ensure t
460     :diminish rainbow-mode
461     :init
462     (add-hook 'prog-mode-hook 'rainbow-mode))
463 #+END_SRC
8a38cc 464
990949 465 ** Rainbow delimiters
C 466 A bit more useful than above.
467 Colours the brackets so that they stand out more.
468 #+BEGIN_SRC emacs-lisp
469   (use-package rainbow-delimiters
470     :ensure t
471     :init
472       (add-hook 'prog-mode-hook #'rainbow-delimiters-mode))
473 #+END_SRC
8a38cc 474
0ba1ff 475 ** Following whitespace
990949 476 Removes unnecessary white space
C 477 #+BEGIN_SRC emacs-lisp
0ba1ff 478   (use-package clean-aindent-mode
JG 479     :ensure t
480     :hook prog-mode)
990949 481 #+END_SRC
C 482 Shows trailing white space
483 #+BEGIN_SRC emacs-lisp
484 (add-hook 'prog-mode-hook (lambda () (interactive) (setq show-trailing-whitespace 1)))
485 #+END_SRC
8a38cc 486
0ba1ff 487 ** Whitespace mode
990949 488 Reveals whitespace characters
C 489 #+BEGIN_SRC emacs-lisp
490 (global-set-key (kbd "C-c w") 'whitespace-mode)
491 (add-hook 'diff-mode-hook (lambda ()
492                             (setq-local whitespace-style
493                                         '(face
494                                           tabs
495                                           tab-mark
496                                           spaces
497                                           space-mark
498                                           trailing
499                                           indentation::space
500                                           indentation::tab
501                                           newline
502                                           newline-mark))
503                             (whitespace-mode 1)))
504
505 #+END_SRC
8a38cc 506
990949 507 ** eldoc
0ba1ff 508 Shows function arguments in echo area below mode line.
990949 509 #+BEGIN_SRC emacs-lisp
f1b53f 510   (diminish 'eldoc-mode)
990949 511   (add-hook 'emacs-lisp-mode-hook 'eldoc-mode)
C 512   (add-hook 'lisp-interaction-mode-hook 'eldoc-mode)
513   (add-hook 'ielm-mode-hook 'eldoc-mode)
514 #+END_SRC
8a38cc 515
0ba1ff 516 ** Key frequency statistics
JG 517 Collects interesting statistics about key presses.
518 Use M-x keyfreq-show to show in emacs or M-x keyfreq-html to output
990949 519 #+BEGIN_SRC emacs-lisp
C 520 (use-package keyfreq
521   :ensure t
522   :config
523   (keyfreq-mode 1)
524   (keyfreq-autosave-mode 1))
525 #+END_SRC
8a38cc 526
0ba1ff 527 ** Undo tree
JG 528 A more advanced undo mechanism.
529 Supports branched undo history (thus the tree).
530 Pretty neat, if seldom used.
990949 531 #+BEGIN_SRC emacs-lisp
C 532 (use-package undo-tree
533   :ensure t
534   :diminish undo-tree-mode
535   :config
536   (global-undo-tree-mode))
537 #+END_SRC
8a38cc 538
0ba1ff 539 ** Volatile highlights
990949 540 Colour the material just copied
C 541 #+BEGIN_SRC emacs-lisp
542 (use-package volatile-highlights
543   :ensure t
544   :diminish volatile-highlights-mode
545   :config
546   (volatile-highlights-mode t))
547 #+END_SRC
8a38cc 548
990949 549 ** ibuffer
0ba1ff 550 View all open buffers in their own buffer rather in the temporary mini buffer.
990949 551 #+BEGIN_SRC emacs-lisp
C 552 (global-set-key (kbd "C-x C-b") 'ibuffer)
553 (setq ibuffer-use-other-window t)
554 #+END_SRC
8a38cc 555
0ba1ff 556 ** Hippie expand
JG 557 Seems cool, but I don't think I ever use this.
558 Meant to suggest completions to beginning of a word.
990949 559 #+BEGIN_SRC emacs-lisp
C 560 (global-set-key (kbd "M-/") 'hippie-expand) ;; replace dabbrev-expand
561 (setq
562  hippie-expand-try-functions-list
563  '(try-expand-dabbrev ;; Try to expand word "dynamically", searching the current buffer.
564    try-expand-dabbrev-all-buffers ;; Try to expand word "dynamically", searching all other buffers.
565    try-expand-dabbrev-from-kill ;; Try to expand word "dynamically", searching the kill ring.
566    try-complete-file-name-partially ;; Try to complete text as a file name, as many characters as unique.
567    try-complete-file-name ;; Try to complete text as a file name.
568    try-expand-all-abbrevs ;; Try to expand word before point according to all abbrev tables.
569    try-expand-list ;; Try to complete the current line to an entire line in the buffer.
570    try-expand-line ;; Try to complete the current line to an entire line in the buffer.
571    try-complete-lisp-symbol-partially ;; Try to complete as an Emacs Lisp symbol, as many characters as unique.
572    try-complete-lisp-symbol) ;; Try to complete word as an Emacs Lisp symbol.
573  )
574 #+END_SRC
8a38cc 575
990949 576 ** Highlight line
0ba1ff 577 Very useful for finding where you are.
990949 578 #+BEGIN_SRC emacs-lisp
C 579 (global-hl-line-mode)
580 #+END_SRC
8a38cc 581
990949 582 ** Line numbers
0ba1ff 583 Everyone needs line numbers when programming.
990949 584 #+BEGIN_SRC emacs-lisp
C 585 (add-hook 'prog-mode-hook 'linum-mode)
586 #+END_SRC
587
588 ** Garbage collection
0ba1ff 589 Starts garbage collection every 100MB.
990949 590 #+BEGIN_SRC emacs-lisp
C 591 (setq gc-cons-threshold 100000000)
592 #+END_SRC
593
594 ** Kill ring
595 Changes the kill ring size to 5000.
596 #+BEGIN_SRC emacs-lisp
597   (setq global-mark-ring-max 5000
598     mark-ring-max 5000
599     mode-require-final-newline t
600     kill-ring-max 5000
601     kill-whole-line t)
602 #+END_SRC
8a38cc 603
990949 604 ** Coding style
0ba1ff 605 Use java for java, awk for awk and K&R for everything else.
JG 606 K&R uses 4 space tabs.
990949 607 #+BEGIN_SRC emacs-lisp
bf794a 608   (setq c-default-style '((java-mode . "java")
JG 609                          (awk-mode . "awk")
610                          (other . "k&r")))
990949 611 #+END_SRC
C 612
613 ** Coding system
0ba1ff 614 Cause we all love UTF8
990949 615 #+BEGIN_SRC emacs-lisp
bf794a 616   (set-terminal-coding-system 'utf-8)
JG 617   (set-keyboard-coding-system 'utf-8)
618   (set-language-environment "UTF-8")
619   (prefer-coding-system 'utf-8)
620   (setq-default indent-tabs-mode t
621             tab-width 4)
622   (delete-selection-mode)
623   (global-set-key (kbd "RET") 'newline-and-indent)
990949 624 #+END_SRC
8a38cc 625
990949 626 ** Move to beginning of line ignoring whitespace
C 627 Move point back to indentation of beginning of line.
0ba1ff 628 Pretty good for getting to the start of what you actually wanted.
990949 629
C 630 Move point to the first non-whitespace character on this line.
631 If point is already there, move to the beginning of the line.
632 Effectively toggle between the first non-whitespace character and
633 the beginning of the line.
634
635 If ARG is not nil or 1, move forward ARG - 1 lines first. If
636 point reaches the beginning or end of the buffer, stop there.
637 #+BEGIN_SRC emacs-lisp
638 (defun prelude-move-beginning-of-line (arg)
639   (interactive "^p")
640   (setq arg (or arg 1))
641
642   ;; Move lines first
643   (when (/= arg 1)
644     (let ((line-move-visual nil))
645       (forward-line (1- arg))))
646
647   (let ((orig-point (point)))
648     (back-to-indentation)
649     (when (= orig-point (point))
650       (move-beginning-of-line 1))))
651
652 (global-set-key (kbd "C-a") 'prelude-move-beginning-of-line)
653 #+END_SRC
8a38cc 654
990949 655 ** Indent region or buffer
0ba1ff 656 Indent, slightly different to standard tab or C-M-\.
990949 657 #+BEGIN_SRC emacs-lisp
C 658 (defun indent-region-or-buffer ()
659   "Indent a region if selected, otherwise the whole buffer."
660   (interactive)
661   (unless (member major-mode prelude-indent-sensitive-modes)
662     (save-excursion
663       (if (region-active-p)
664           (progn
665             (indent-region (region-beginning) (region-end))
666             (message "Indented selected region."))
667         (progn
668           (indent-buffer)
669           (message "Indented buffer.")))
670       (whitespace-cleanup))))
671
672 (global-set-key (kbd "C-c i") 'indent-region-or-buffer)
673 #+END_SRC
8a38cc 674
990949 675 ** Tramp
0ba1ff 676 Remote editing mode.
JG 677 Hate having to re-input passwords.
990949 678 #+BEGIN_SRC emacs-lisp
C 679   (when (eq system-type 'windows-nt)
680     (setq tramp-default-method "pscp"))
681   (setq password-cache-expiry nil)
682 #+END_SRC
683
0ba1ff 684 ** COMMENT Y or N instead of yes or no
JG 685 Need not type out whole word.
686 #+BEGIN_SRC emacs-lisp
687   (defalias 'yes-or-no-p 'y-or-n-p)
688 #+END_SRC
689
06a72e 690 ** COMMENT Sublime-like minimap
JG 691 Get a minimap preview of the file on the side like sublime text.
692 Want to make work but need to find a good way of doing so.
693 #+BEGIN_SRC emacs-lisp
694   (use-package sublimity
695     :ensure t
696     :config
697     (require 'sublimity-scroll)
698     (setq sublimity-scroll-weight 4
699           sublimity-scroll-drift-length 3)
700     (require 'sublimity-map)
701     (setq sublimity-map-size 20
702           sublimity-map-scale 0.3)
703     (sublimity-map-set-delay nil)
704     (sublimity-mode 1))
705
706   (use-package minimap
707     :ensure t
708     :config
709     (minimap-mode))
710 #+END_SRC
711
990949 712 * Mode line tweaks
C 713 Diminish is used but is included in init.el such that it can be used throughout this document
714 ** Spaceline
0ba1ff 715 A little easier to read than the default emacs mode line.
990949 716 #+BEGIN_SRC emacs-lisp
412080 717     (use-package spaceline
C 718       :ensure t
719       :config
720       (require 'spaceline-config)
721       (setq spaceline-buffer-encoding-abbrev-p t)
722       (setq spaceline-line-column-p t)
723       (setq spaceline-line-p t)
724       (setq powerline-default-separator (quote arrow))
725       (spaceline-spacemacs-theme)
726       (spaceline-helm-mode))
990949 727 #+END_SRC
8a38cc 728
1005e3 729 *** Separator
JG 730 Slightly nicer separator.
731 #+BEGIN_SRC emacs-lisp
732 (setq powerline-default-separator nil)
733 #+END_SRC
734
0c962c 735 ** Nyan mode
JG 736 Use nyan cat as a reference for buffer progression.
737 #+BEGIN_SRC emacs-lisp
738   (use-package nyan-mode
739     :ensure t
740     :config
741     (nyan-mode 1))
742 #+END_SRC
743
990949 744 * Programming tweaks
C 745 ** Yasnippet
0ba1ff 746 Add snippets, pretty useful.
JG 747 Manually added snippets are in ~/.emacs.d/snippets/{mode}.
990949 748 #+BEGIN_SRC emacs-lisp
bf794a 749   (use-package yasnippet
JG 750     :ensure t
751     :diminish yas-minor-mode
752     :config
753     (use-package yasnippet-snippets
754       :ensure t)
755     (yas-reload-all)
756     (yas-global-mode 1))
990949 757 #+END_SRC
8a38cc 758
0ba1ff 759 ** Flycheck
JG 760 Basic linter. Works pretty well.
990949 761 #+BEGIN_SRC emacs-lisp
8a38cc 762   (use-package flycheck
C 763     :ensure t
764     :diminish flycheck-mode
765     :config
766     (global-flycheck-mode))
990949 767 #+END_SRC
0ba1ff 768 *** flycheck-pos-tip
JG 769 Add suggestions at the cursor.
990949 770 #+BEGIN_SRC emacs-lisp
C 771 (use-package flycheck-pos-tip
772   :ensure t
773   :after flycheck
774   :config
775   (flycheck-pos-tip-mode))
776 #+END_SRC
8a38cc 777
990949 778 ** Company
0ba1ff 779 Company is auto-complete for Emacs.
JG 780 Uses various backends, more of which are added later.
990949 781 #+BEGIN_SRC emacs-lisp
C 782   (use-package company
783     :ensure t
784     :diminish company-mode
785     :config
786     (global-company-mode)
787     (setq company-idle-delay 0)
788     (setq company-minimum-prefix-length 3))
789 #+END_SRC
8a38cc 790
c8124c 791 ** LSP Mode
JG 792 Use LSP for completion suggestions
793 #+BEGIN_SRC emacs-lisp
794   (use-package lsp-mode
795     :ensure t
796     :hook ((lsp-mode . lsp-enable-which-key-integration))
797     :init
798     (setq lsp-keymap-prefix "C-c l")
799     :commands lsp
800     :config
801     (setq read-process-output-max (* 1024 1024))
f0bf38 802     (setq lsp-completion-provider :capf)
JG 803     (add-to-list 'exec-path "~/.cargo/bin"))
c8124c 804
JG 805   (use-package lsp-ui
806     :ensure t
807     :commands lsp-ui-mode)
808
809   (use-package helm-lsp
810     :ensure t
811     :commands helm-lsp-workspace-symbol)
812 #+END_SRC
da7a13 813 ** Version control
JG 814 Settings for emacs' own version control system.
815 *** Enable version control on the mode line
816 #+BEGIN_SRC emacs-lisp
817   (vc-mode)
818 #+END_SRC
990949 819 ** Magit
0ba1ff 820 Emacs git client.
JG 821 Pretty good and offers fairly decent features.
990949 822 #+BEGIN_SRC emacs-lisp
C 823   (use-package magit
824     :ensure t
825     :commands magit-get-top-dir
826     :bind ("C-x g" . magit-status)
827     :init
828     (progn
829       ;; make magit status go full-screen but remember previous window
830       ;; settings
831       ;; from: http://whattheemacsd.com/setup-magit.el-01.html
832       (defadvice magit-status (around magit-fullscreen activate)
833         (window-configuration-to-register :magit-fullscreen)
834         ad-do-it
835         (delete-other-windows))
836
837       ;; Close popup when committing - this stops the commit window
838       ;; hanging around
839       ;; From: http://git.io/rPBE0Q
840       (defadvice git-commit-commit (after delete-window activate)
841         (delete-window))
842
843       (defadvice git-commit-abort (after delete-window activate)
844         (delete-window))
845
846       :config
847       (progn
848         ;; restore previously hidden windows
849         (defadvice magit-quit-window (around magit-restore-screen activate)
850           (let ((current-mode major-mode))
851             ad-do-it
852             ;; we only want to jump to register when the last seen buffer
853             ;; was a magit-status buffer.
854             (when (eq 'magit-status-mode current-mode)
855               (jump-to-register :magit-fullscreen)))))
856
857       ;; magit settings
858       (setq
859        ;; don't put "origin-" in front of new branch names by default
860        magit-default-tracking-name-function 'magit-default-tracking-name-branch-only
861        ;; open magit status in same window as current buffer
862        magit-status-buffer-switch-function 'switch-to-buffer
863        ;; highlight word/letter changes in hunk diffs
864        magit-diff-refine-hunk t
865        ;; ask me if I want to include a revision when rewriting
866        magit-rewrite-inclusive 'ask
867        ;; ask me to save buffers
868        magit-save-some-buffers t
869        ;; pop the process buffer if we're taking a while to complete
870        magit-process-popup-time 10
871        ;; ask me if I want a tracking upstream
872        magit-set-upstream-on-push 'askifnotset
873        )))
874 #+END_SRC
8a38cc 875
990949 876 ** CEDET
0ba1ff 877 *** Semantic
JG 878 Parser library for code, supports many other packages.
879 Allows emacs to be mode aware of what is being written.
990949 880 #+BEGIN_SRC emacs-lisp
C 881   (use-package semantic
882     :config
883     (global-semanticdb-minor-mode 1)
884     (global-semantic-idle-scheduler-mode 1)
885     (global-semantic-idle-summary-mode 1)
886     (semantic-mode 1))
887 #+END_SRC
8a38cc 888
a428a2 889 *** COMMENT EDE
0ba1ff 890 Emacs Development Environment.
JG 891 Can be used to manage and create build files for a project.
990949 892 #+BEGIN_SRC emacs-lisp
C 893 (use-package ede
894   :config
895   (global-ede-mode t))
896 #+END_SRC
8a38cc 897
990949 898 *** gdb-many-windows
0ba1ff 899 Enhances the use of GDB in emacs.
JG 900 Shows register contents, variable contents and others in addition to GDB shell.
901 Also shows source code while debugging.
990949 902 #+BEGIN_SRC emacs-lisp
C 903 (setq
904  gdb-many-windows t
905  gdb-show-main t)
906 #+END_SRC
8a38cc 907
0ba1ff 908 *** COMMENT Semantic refactor
JG 909 Trying to get this to work.
910 Should help to refactor file.
990949 911 #+BEGIN_SRC emacs-lisp
0ba1ff 912   (use-package srefactor
JG 913     :ensure t
914     :bind (("M-RET o" . 'srefactor-lisp-one-line)
915        ("M-RET m" . 'srefactor-lisp-format-sexp)
916        ("M-RET d" . 'srefactor-lisp-format-defun)
917        ("M-RET b" . 'srefactor-lisp-format-buffer)
918        :map c-mode-base-map
919             ("M-RET" . 'srefactor-refactor-at-point)
920             :map c++-mode-map
921             ("M-RET" . 'srefactor-refactor-at-point)))
990949 922 #+END_SRC
8a38cc 923
990949 924 ** Language specific configs
C 925 *** C/C++
0ba1ff 926 **** COMMENT yasnippet
JG 927 Enable yasnippet for C/C++.
990949 928 #+BEGIN_SRC emacs-lisp
C 929 (add-hook 'c++-mode-hook 'yas-minor-mode)
930 (add-hook 'c-mode-hook 'yas-minor-mode)
931 #+END_SRC
8a38cc 932
0ba1ff 933 **** Flycheck clang
JG 934 Add the clang backend for linting.
990949 935 #+BEGIN_SRC emacs-lisp
C 936 (use-package flycheck-clang-analyzer
937   :ensure t
938   :config
939   (with-eval-after-load 'flycheck
940     (require 'flycheck-clang-analyzer)
941      (flycheck-clang-analyzer-setup)))
942 #+END_SRC
8a38cc 943
0ba1ff 944 **** Company
JG 945 Add header completion as well as Irony, which uses clang for suggestions.
990949 946 #+BEGIN_SRC emacs-lisp
C 947   (use-package company-c-headers
948       :ensure t
949       :after company
950       :config
951       (add-hook 'c++-mode-hook 'company-mode)
952       (add-hook 'c-mode-hook 'company-mode))
953
954   (use-package irony
955     :ensure t
956     :init
957     (setq w32-pipe-read-delay 0)
958     (setq irony-server-w32-pipe-buffer-size (* 64 1024))
959     (add-hook 'c++-mode-hook 'irony-mode)
960     (add-hook 'c-mode-hook 'irony-mode)
961     (add-hook 'irony-mode-hook 'irony-cdb-autosetup-compile-options)
962     (add-hook 'irony-mode-hook 'irony-cdb-autosetup-compile-options))
0ba1ff 963
JG 964   (use-package company-irony
965     :ensure t
966     :config
967     (add-to-list 'company-backends '(company-c-headers
968                                      company-dabbrev-code
969                                      company-irony)))
990949 970 #+END_SRC
8a38cc 971
c8124c 972 **** LSP
JG 973 Allow completion with LSP.
974 #+BEGIN_SRC emacs-lisp
975 (add-hook 'c-mode-hook 'lsp)
976 (add-hook 'cpp-mode-hook 'lsp)
977 #+END_SRC
990949 978 *** emacs-lisp
0ba1ff 979 **** COMMENT yasnippet
JG 980 Enable yasnippet.
990949 981 #+BEGIN_SRC emacs-lisp
C 982 (add-hook 'emacs-lisp-mode-hook 'yas-minor-mode)
983 #+END_SRC
8a38cc 984
0ba1ff 985 **** COMMENT company
JG 986 Add slime backend.
990949 987 #+BEGIN_SRC emacs-lisp
C 988 (add-hook 'emacs-lisp-mode-hook 'company-mode)
989
990 (use-package slime
991   :ensure t
992   :config
993   (setq inferior-lisp-program "/usr/bin/sbcl")
994   (setq slime-contribs '(slime-fancy)))
995
996 (use-package slime-company
997   :ensure t
998   :init
999     (require 'company)
1000     (slime-setup '(slime-fancy slime-company)))
1001 #+END_SRC
8a38cc 1002
bf794a 1003 *** COMMENT x86
990949 1004 **** x86-lookup
0ba1ff 1005 Look up reference PDF. Use Intel manual.
990949 1006 #+BEGIN_SRC emacs-lisp
C 1007 (use-package x86-lookup
1008   :ensure t
1009   :init
1010   (setq x86-lookup-pdf "D:/Coding/x86-instructions.pdf")
1011   :bind ("C-h x" . x86-lookup))
1012 #+END_SRC
8a38cc 1013
990949 1014 *** Latex
C 1015 **** AucTex
0ba1ff 1016 AucTex contains many additions to make tex editing good.
990949 1017 #+BEGIN_SRC emacs-lisp
20e001 1018   (use-package tex
C 1019     :ensure auctex
1020     :config
1021     (setq TeX-auto-save t)
1022     (setq TeX-parse-self t)
1023     (setq TeX-view-program-selection '((output-pdf "PDF Tools"))
1024           TeX-source-correlate-start-server t)
1025     (add-hook 'TeX-after-compilation-finished-functions #'TeX-revert-document-buffer))
990949 1026 #+END_SRC
8a38cc 1027
990949 1028 **** Company
0ba1ff 1029 Help company complete tex math and references.
990949 1030 #+BEGIN_SRC emacs-lisp
C 1031   (use-package company-math
1032     :ensure t
1033     :after company
1034     :config
1005e3 1035     (add-to-list 'company-backends '(company-math-symbols-unicode company-math-symbols-latex
0a6cd2 1036                                      company-latex-commands))
1005e3 1037     (setq company-math-allow-latex-symbols-in-faces t))
990949 1038
C 1039   (use-package company-reftex
1040     :ensure t
1041     :after company
1042     :config
1005e3 1043     (add-to-list 'company-backends 'company-reftex-citations))
990949 1044
C 1045   (use-package company-auctex
1046     :ensure t
1047     :after company
1048     :config
1049     (company-auctex-init))
1050
1051   (use-package company-bibtex
1052     :ensure t
1053     :after company
1054     (add-to-list 'company-backends 'company-bibtex))
1055 #+END_SRC
8a38cc 1056
bf794a 1057 **** TeXcount
0ba1ff 1058 Word counts in latex.
JG 1059 Uses a Perl script.
1060 #+BEGIN_SRC emacs-lisp
1061   (defun get-texcount-latest()
1062     (if (not(file-directory-p "~/.texcount"))
1063         (make-directory "~/.texcount"))
1064     (url-copy-file "https://app.uio.no/ifi/texcount/download.php?file=texcount_3_1_1.zip" "~/.texcount/texcount.zip" 1)
1065     (shell-command "unzip -o ~/.texcount/texcount.zip -d ~/.texcount")
1066     (add-to-list 'exec-path "~/.texcount/texcount.pl"))
20e001 1067
df1744 1068   (if (not(or (file-exists-p "~/.texcount/texcount.pl") (file-exists-p "/usr/bin/texcount")))
0ba1ff 1069       (get-texcount-latest))
990949 1070
0ba1ff 1071   (defun texcount ()
JG 1072     (interactive)
1073     (let*
1074         ( (this-file (buffer-file-name))
1075           (enc-str (symbol-name buffer-file-coding-system))
1076           (enc-opt
1077            (cond
1078             ((string-match "utf-8" enc-str) "-utf8")
1079             ((string-match "latin" enc-str) "-latin1")
1080             ("-encoding=guess")
1081             ) )
1082           (word-count
1083            (with-output-to-string
1084              (with-current-buffer standard-output
1085                (call-process "texcount" nil t nil "-0" enc-opt this-file)
1086                ) ) ) )
1087       (message word-count)
1088       ) )
1089   (add-hook 'LaTeX-mode-hook (lambda () (define-key LaTeX-mode-map (kbd "C-c c") 'texcount)))
1090   (add-hook 'latex-mode-hook (lambda () (define-key latex-mode-map (kbd "C-c c") 'texcount)))
1091 #+END_SRC
990949 1092
f0bf38 1093 **** LSP
JG 1094 Allow LSP completion
1095 #+BEGIN_SRC emacs-lisp
1096   (add-hook 'tex-mode-hook 'lsp)
1097   (add-hook 'latex-mode-hook 'lsp)
1098   (add-hook 'TeX-mode-hook 'lsp)
1099   (add-hook 'LaTeX-mode-hook 'lsp)
1100 #+END_SRC
990949 1101 *** PlantUML
0ba1ff 1102 Sets the PlantUML path for the mode to generate models.
990949 1103 #+BEGIN_SRC emacs-lisp
bf794a 1104   (use-package plantuml-mode
JG 1105     :ensure t
1106     :init
1107     (cond ((eq system-type 'windows-nt)
1108            (setq plantuml-jar-path "c:/ProgramData/chocolatey/lib/plantuml/tools/plantuml.jar"))
1109           ((eq system-type 'gnu/linux)
4659c3 1110            (setq plantuml-jar-path "/usr/share/java/plantuml/plantuml.jar")))
JG 1111     (setq planuml-default-exec-mode 'jar))
990949 1112 #+END_SRC
C 1113
bf794a 1114 *** COMMENT Racket
990949 1115 **** Major mode
0ba1ff 1116 Set racket path in windows and enable racket mode.
990949 1117 #+BEGIN_SRC emacs-lisp
C 1118   (when (eq system-type 'windows-nt)
1119     (add-to-list 'exec-path "c:/Program Files/Racket")
1120     (setenv "PATH" (mapconcat #'identity exec-path path-separator)))
1121
1122   (use-package racket-mode
1123       :ensure t
1124       :config
1125       (autoload 'racket-mode "Racket" "Racket Editing Mode" t)
1126       (add-to-list
1127        'auto-mode-alist
8a38cc 1128        '("\\.rkt$" . racket-mode))
990949 1129       (setq matlab-indent-function t))
C 1130 #+END_SRC
1131
0ba1ff 1132 *** COMMENT Verilog
baf326 1133 **** Get latest version
0ba1ff 1134 Pull the latest version from the web.
baf326 1135 #+BEGIN_SRC emacs-lisp
C 1136   (defun get-verilog-latest()
0864ff 1137     (if (not(file-directory-p "~/.emacs.d/elpa/verilog-mode"))
C 1138         (make-directory "~/.emacs.d/elpa/verilog-mode"))
1139     (if (file-exists-p "~/.emacs.d/elpa/verilog-mode/verilog-mode.el")
1140         (delete-file "~/.emacs.d/elpa/verilog-mode/verilog-mode.el"))
dc8eb0 1141     (url-copy-file "https://www.veripool.org/ftp/verilog-mode.el" "~/.emacs.d/elpa/verilog-mode/verilog-mode.el" 1))
baf326 1142 #+END_SRC
C 1143
1144 **** Integrate into emacs
0ba1ff 1145 Add updated version (based off auto-package-update) and integrate it with Emacs.
990949 1146 #+BEGIN_SRC emacs-lisp
c8124c 1147   (defun verilog-read-file-as-string (file)
JG 1148     "Read FILE contents."
1149     (when (file-exists-p file)
0864ff 1150       (with-temp-buffer
c8124c 1151         (insert-file-contents file)
JG 1152         (buffer-string))))
0864ff 1153
c8124c 1154   (defun verilog-write-string-to-file (file string)
JG 1155     "Substitute FILE contents with STRING."
1156     (with-temp-buffer
1157       (insert string)
1158       (when (file-writable-p file)
1159         (write-region (point-min)
1160                       (point-max)
1161                       file))))
0864ff 1162
c8124c 1163   (defun verilog-today-day ()
JG 1164     (time-to-days (current-time)))
0864ff 1165
c8124c 1166   (defun should-update-verilog-p ()
JG 1167     "Return non-nil when an update is due."
1168     (and
1169      (or
1170       (not (file-exists-p "~/.emacs.d/.last-verilog-update-day"))
1171       (if (>= (/ (- (verilog-today-day) (verilog-read-last-update-day)) 7) 1)
1172           t
1173         nil))))
0864ff 1174
c8124c 1175   (defun verilog-read-last-update-day ()
JG 1176     "Read last update day."
1177     (string-to-number
1178      (verilog-read-file-as-string "~/.emacs.d/.last-verilog-update-day")))
0864ff 1179
c8124c 1180   (defun verilog-write-current-day ()
JG 1181     "Store current day."
1182     (verilog-write-string-to-file
1183      "~/.emacs.d/.last-verilog-update-day"
1184      (int-to-string (verilog-today-day))))
1185
1186   (use-package verilog-mode
1187     :hook (verilog-mode . lsp)
1188     :init
1189     (when (should-update-verilog-p)
1190         (get-verilog-latest)
1191         (verilog-write-current-day))
1192     (add-to-list 'load-path "~/.emacs.d/elpa/verilog-mode/verilog-mode.el")
1193     :config
1194     (autoload 'verilog-mode "verilog-mode" "Verilog mode" t )
1195     (add-to-list 'auto-mode-alist '("\\.[ds]?vh?\\'" . verilog-mode)))
990949 1196 #+END_SRC
8a38cc 1197
0ba1ff 1198 *** COMMENT MATLAB
49aa9f 1199 Mode for editing MATLAB m-files.
JG 1200 #+BEGIN_SRC emacs-lisp
0ba1ff 1201   (use-package matlab
JG 1202     :ensure matlab-mode
1203     :config
1204     (autoload 'matlab-mode "matlab" "Matlab Editing Mode" t)
1205     (add-to-list
1206      'auto-mode-alist
1207      '("\\.m$" . matlab-mode))
1208     (setq matlab-indent-function t)
1209     (setq matlab-shell-command "matlab")
1210     (matlab-cedet-setup))
49aa9f 1211 #+END_SRC
JG 1212
0ba1ff 1213 *** COMMENT MIPS
JG 1214 For editing MIPS assembly.
49aa9f 1215 #+BEGIN_SRC emacs-lisp
JG 1216   (use-package mips-mode
1217     :ensure t
1218     :mode "\\.mips$")
1219 #+END_SRC
1220
0ba1ff 1221 *** COMMENT IPython notebooks
60454d 1222 Allow emacs to view and use IPython notebooks
JG 1223 #+BEGIN_SRC emacs-lisp
1224   (use-package ein
1225     :ensure t)
1226 #+END_SRC
1227
22b4cd 1228 *** Rust
JG 1229 **** Major mode
1230 Get the major mode for rust files.
1231 #+BEGIN_SRC emacs-lisp
1232   (use-package rust-mode
1233     :ensure t
c8124c 1234     :hook (rust-mode . lsp)
22b4cd 1235     :config
JG 1236     ;; style guide suggests spaces not tabs
1237     (add-hook 'rust-mode-hook (lambda () (setq indent-tabs-mode nil)))
1238     (setq rust-format-on-save t))
1239
1240   (use-package toml-mode
1241     :ensure t)
1242 #+END_SRC
1243 **** Cargo integration
1244 Integrate Cargo, rust's package manager.
1245 #+BEGIN_SRC emacs-lisp
1246   (use-package cargo
1247     :ensure t
1248     :hook
1249     (rust-mode . cargo-minor-mode))
1250 #+END_SRC
1251 **** Flycheck
1252 Linting with flycheck.
1253 #+BEGIN_SRC emacs-lisp
1254   (use-package flycheck-rust
1255     :ensure t
1256     :config
1257     (add-hook 'flyckeck-mode-hook #'flycheck-rust-setup))
1258 #+END_SRC
1259
1260 **** COMMENT Completion
1261 Code completion with racer.
1262 #+BEGIN_SRC emacs-lisp
1263   (use-package racer
1264     :ensure t
1265     :hook ((rust-mode . racer-mode)
1266            (racer-mode . (eldoc-mode company-mode)))
1267     :init
1268     (setq racer-command "~/.cargo/bin/racer"))
1269 #+END_SRC
c8124c 1270 *** Bash
JG 1271 **** LSP
1272 Completion with LSP
1273 #+BEGIN_SRC emacs-lisp
1274 (add-hook 'sh-mode-hook 'lsp)
1275 #+END_SRC
990949 1276 * Org mode
C 1277 ** Up to date org
0ba1ff 1278 Pull the latest org mode from the repository, rather than the org which comes with emacs.
990949 1279 #+BEGIN_SRC emacs-lisp
C 1280     (use-package org
0ba1ff 1281       :ensure org-plus-contrib
990949 1282       :pin org)
C 1283 #+END_SRC
8a38cc 1284
990949 1285 ** Small tweaks
0ba1ff 1286 Small quality of life changes to org-mode.
990949 1287 #+BEGIN_SRC emacs-lisp
C 1288 (setq org-src-fontify-natively t)
1289 (setq org-src-tab-acts-natively t)
1290 (setq org-confirm-babel-evaluate nil)
1291 (setq org-export-with-smart-quotes t)
1292 (setq org-src-window-setup 'current-window)
1293 (add-hook 'org-mode-hook 'org-indent-mode)
1294 (diminish 'org-indent-mode)
1295 (diminish 'visual-line-mode)
1296 #+END_SRC
a428a2 1297 *** Spell checking for code and latex
JG 1298 #+BEGIN_SRC emacs-lisp
1299   (add-to-list 'ispell-skip-region-alist '("#\\+BEGIN_SRC" . "#\\+END_SRC"))
1300   (add-to-list 'ispell-skip-region-alist '("\\$" . "\\$"))
1301   (add-to-list 'ispell-skip-region-alist '("\\$\\$" . "\\$\\$"))
1302 #+END_SRC
8a38cc 1303
990949 1304 ** Line wrapping
0ba1ff 1305 Enable line wrapping for long lines.
990949 1306 #+BEGIN_SRC emacs-lisp
C 1307   (add-hook 'org-mode-hook
bf794a 1308             '(lambda ()
JG 1309                (visual-line-mode 1)))
990949 1310 #+END_SRC
8a38cc 1311
990949 1312 ** org-bullets
0ba1ff 1313 Use bullets of different colours and styles instead of the "\*\*\*" to denote indentation levels.
990949 1314 #+BEGIN_SRC emacs-lisp
bf794a 1315   (use-package org-bullets
JG 1316     :ensure t
1317     :config
990949 1318     (add-hook 'org-mode-hook (lambda () (org-bullets-mode))))
C 1319 #+END_SRC
8a38cc 1320
990949 1321 ** Org Babel
0ba1ff 1322 Allows the execution of code from within an org buffer.
JG 1323 Code output can also be input to the buffer.
990949 1324 *** Languages
0ba1ff 1325 Add a bunch of languages to org babel supported languages
990949 1326 #+BEGIN_SRC emacs-lisp
baf326 1327     (org-babel-do-load-languages 'org-babel-load-languages '((emacs-lisp . t)
C 1328                                                              (C . t)
1329                                                              (python . t)
1330                                                              (latex . t)
1331                                                              (scheme . t)
1332                                                              (gnuplot . t)
1333                                                              (matlab . t)
1334                                                              (plantuml . t)
1335                                                              (fortran . t)
1336                                                              (java . t)
1337                                                              (plantuml . t)))
1338 #+END_SRC
1339
0ba1ff 1340 **** PlantUML path
JG 1341 Org uses its own path for some reason.
baf326 1342 #+BEGIN_SRC emacs-lisp
C 1343   (setq org-plantuml-jar-path plantuml-jar-path)
990949 1344 #+END_SRC
8a38cc 1345
5a75e4 1346 *** Async export
JG 1347 Allow the editing of files while execution of blocks is occurring.
1348 Needs :async tag in src header.
1349 #+BEGIN_SRC emacs-lisp
1350   (use-package ob-async
1351     :ensure t)
1352 #+END_SRC
1353
990949 1354 ** Latex preview fragments match colour
C 1355 Make the previews match theme colour of Emacs.
0ba1ff 1356 Gets very annoying very quickly without it.
990949 1357 #+BEGIN_SRC emacs-lisp
C 1358   (let ((dvipng--plist (alist-get 'dvipng org-preview-latex-process-alist)))
1359     (plist-put dvipng--plist :use-xcolor t)
1360     (plist-put dvipng--plist :image-converter '("dvipng -D %D -T tight -o %O %f")))
1361 #+END_SRC
bf794a 1362
0ba1ff 1363 ** Org export additions
JG 1364 *** Pandoc
1365 Call pandoc on org buffer from org export.
1366 #+BEGIN_SRC emacs-lisp
1367   (use-package ox-pandoc
1368     :ensure t)
1369 #+END_SRC
1370
1371 *** COMMENT Dokuwiki Wiki
1372 Allow export to dokuwiki markup from org.
1373 #+BEGIN_SRC emacs-lisp
1374   (use-package ox-wk
1375     :ensure t)
1376 #+END_SRC
1377
1378 * COMMENT EMMS
be9cff 1379 Emacs media manager.
0ba1ff 1380 I come back to it every now and again as an MPD front-end, but haven't quite gotten the hang of it.
be9cff 1381 #+BEGIN_SRC emacs-lisp
JG 1382   (use-package emms-setup
1383     :ensure emms
1384     :init
1385     (add-to-list 'load-path "~/elisp/emms/")
1386     :config
1387     (emms-all)
1388     (emms-default-players)
1389     (setq emms-source-file-directory "~/Music/"))
1390 #+END_SRC
1391
a428a2 1392 * COMMENT Org Blog
0ba1ff 1393 I use org to write my blog and use org-static-blog to generate the HTML.
be9cff 1394 ** Org static blog config
0ba1ff 1395 Basic configuration for site.
JG 1396 Copied and modified from the example configuration.
be9cff 1397 #+BEGIN_SRC emacs-lisp
1005e3 1398   (use-package org-static-blog
JG 1399     :ensure t
1400     :config
1401     (setq org-static-blog-publish-title "Joel's Site")
1402     (setq org-static-blog-publish-url "https://blog.joelg.cf/")
1403     (setq org-static-blog-publish-directory "/backup/home/joel/Downloads/Chizi123.github.io/")
1404     (setq org-static-blog-posts-directory "/backup/home/joel/Downloads/Chizi123.github.io/posts/")
1405     (setq org-static-blog-drafts-directory "/backup/home/joel/Downloads/Chizi123.github.io/drafts/")
1406     (setq org-static-blog-enable-tags t)
1407     (setq org-export-with-toc nil)
1408     (setq org-export-with-section-numbers nil)
be9cff 1409
1005e3 1410     ;; This header is inserted into the <head> section of every page:
JG 1411     ;;   (you will need to create the style sheet at
1412     ;;    ~/projects/blog/static/style.css
1413     ;;    and the favicon at
1414     ;;    ~/projects/blog/static/favicon.ico)
1415     (setq org-static-blog-page-header
1416           "<meta name=\"author\" content=\"Joel Grunbaum\">
0ba1ff 1417       <meta name=\"referrer\" content=\"no-referrer\">
JG 1418       <link href= \"static/style.css\" rel=\"stylesheet\" type=\"text/css\" />
1419       <link rel=\"icon\" href=\"static/favicon.png\">
1420       <script async src=\"https://www.googletagmanager.com/gtag/js?id=UA-147303155-2\"></script>
1421       <script>
1422         window.dataLayer = window.dataLayer || [];
1423         function gtag(){dataLayer.push(arguments);}
1424         gtag('js', new Date());
1425         gtag('config', 'UA-147303155-2');
1426       </script>
1427       ")
be9cff 1428
1005e3 1429     ;; This preamble is inserted at the beginning of the <body> of every page:
JG 1430     ;;   This particular HTML creates a <div> with a simple linked headline
1431     (setq org-static-blog-page-preamble
1432           "<div class=\"header\">
0ba1ff 1433         <a href=\"https://blog.joelg.cf\">Joel's Site - Personal site and constant work in progress</a>
JG 1434         <div class=\"sitelinks\">
1435           <a href=\"https://blog.joelg.cf/about-me.html\">About Me</a> |
1436           <a href=\"https://github.com/Chizi123\">Github</a> |
1437           <a href=\"https://facebook.com/joel.grun.5\">Facebook</a>
1438         </div>
1439       </div>")
1440
1005e3 1441     ;; This postamble is inserted at the end of the <body> of every page:
JG 1442     ;;   This particular HTML creates a <div> with a link to the archive page
1443     ;;   and a licensing stub.
1444     (setq org-static-blog-page-postamble
1445           "<div id=\"archive\">
0ba1ff 1446         <a href=\"https://blog.joelg.cf/archive.html\">Other posts</a>
be9cff 1447       </div>
0ba1ff 1448       <br>
1005e3 1449       <center><button id=\"disqus_button\" onclick=\"load_disqus()\">Load Disqus Comments</button></center>
JG 1450     <div id=\"disqus_thread\"></div>
1451     <script type=\"text/javascript\">
1452       function load_disqus() {
1453           var dsq = document.createElement('script');
1454           dsq.type = 'text/javascript';
1455           dsq.async = true;
1456           dsq.src = 'https://joelg-cf.disqus.com/embed.js';
1457           (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
1458           document.getElementById('disqus_button').style.visibility = 'hidden';
1459       };
1460     </script>"))
be9cff 1461 #+END_SRC
JG 1462
0ba1ff 1463 ** Sitemap addition
JG 1464 Creates a sitemap.xml for the blog based on the generated HTML files output in the final directory.
1465 #+BEGIN_SRC emacs-lisp
1466   (defun blog-publish()
1467     (interactive)
1468     (org-static-blog-publish)
1469     (setq n 0)
1470     (setq site "https://blog.joelg.cf/")
1471     (setq posts (directory-files org-static-blog-publish-directory))
1472     (generate-new-buffer "sitemap.xml.gen")
1473     (with-current-buffer "sitemap.xml.gen" (insert "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\">\n"))
1474     (while (< n (length (directory-files org-static-blog-publish-directory)))
1475       (setq curr (nth n posts))
1476       (if (string-match "\\(html\\)" curr)
1477           (if (string-match "index.html" curr)
1478               (with-current-buffer "sitemap.xml.gen" (insert (concat "\t<url>\n\t\t<loc>" site "</loc>\n\t</url>\n")))
1479             (with-current-buffer "sitemap.xml.gen" (insert (concat "\t<url>\n\t\t<loc>" site curr "</loc>\n\t</url>\n")))))
1480       (setq n (1+ n)))
1481     (with-current-buffer "sitemap.xml.gen" (insert "</urlset>"))
1482     (with-current-buffer "sitemap.xml.gen" (write-region (point-min) (point-max) (concat org-static-blog-publish-directory "sitemap.xml")) t)
1483     (kill-buffer "sitemap.xml.gen"))
1484 #+END_SRC
1485
be9cff 1486 ** Emacs-htmlize
0ba1ff 1487 Allow org features to be exported to HTML for site.
be9cff 1488 #+BEGIN_SRC emacs-lisp
JG 1489   (use-package htmlize
1490     :ensure t)
1491 #+END_SRC
0ba1ff 1492
a428a2 1493 * Journaling
JG 1494 ** Noteworthy entries
1495 I write weekly journal entries recapping my week.
1496 These files are in org mode.
1497 This is inspired by org-static-blog.
1498 #+BEGIN_SRC emacs-lisp
1499   (defun journal-create-new-post ()
1500       "Create a new entry, prompt for title and insert header"
1501     (interactive)
1502     (let ((title (read-string "Title: ")))
1503       (find-file (concat "~/Documents/Journal/entry/"
1504                          (read-string "Filename: "
1505                                       (concat (format-time-string "%Y-%m-%d-" (current-time))
1506                                               (replace-regexp-in-string "\s" "-" (downcase title))
1507                                               ".org"))))
1508       (insert "#+title: " title "\n"
1509               "#+date: " (format-time-string "<%Y-%m-%d %H:%M>") "\n"
1510               "#+filetags: ")))
1511 #+END_SRC
1512 *** Publish entries
1513 Use org-publish to collate entries into a single unit.
1514 #+BEGIN_SRC emacs-lisp
1515   (setq org-publish-project-alist
1516                '(("Journal"
1517                  :base-directory "~/Documents/Journal/entry/"
1518                  :publishing-directory "~/Documents/Journal/out/"
1519                  :publishing-function org-html-publish-to-html
0a6cd2 1520                  ;;:htmlized-source t
a428a2 1521                  :section-numbers nil
JG 1522                  :html-preamble t
0a6cd2 1523                  :html-validation-link nil
JG 1524
a428a2 1525                  :auto-sitemap t
0a6cd2 1526                  :sitemap-sort-files anti-chronologically
JG 1527                  :sitemap-file-entry-format "%d - %t"
1528                  :sitemap-title "Home"
1529                  :sitemap-filename "index.html"
1530                  :sitemap-function org-publish-sitemap)))
5a75e4 1531 #+END_SRC