]> ruderich.org/simon Gitweb - config/dotfiles.git/blob - zsh/rc
c1ee1d4aa2236ec8f3306fd230eb14b55336640f
[config/dotfiles.git] / zsh / rc
1 # Zsh configuration file.
2
3 # Copyright (C) 2011-2014  Simon Ruderich
4 #
5 # This file is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
9 #
10 # This file is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this file.  If not, see <http://www.gnu.org/licenses/>.
17
18
19 # Warn when creating global variables from inside a function. Needs to be set
20 # before declaring a function.
21 setopt warn_create_global
22
23
24 # HELPER FUNCTIONS
25
26 # Return the name of the program which is called in the foreground with `fg`.
27 # $1 is the name of the program (optional). If it's not 'fg' or 'fg *' it's
28 # returned unchanged.
29 zshrc_resolve_fg_to_resumed_job_name() {
30     # $REPLY is used by convention for scalars ($reply for arrays) to return
31     # values from functions. unset it here to prevent problems when REPLY is
32     # bound to an integer or similar. Thanks to Mikachu in #zsh on Freenode
33     # (2012-09-27 17:14 CEST) for this hint.
34     unset REPLY
35
36     # Replace fg with the resumed job name.
37     if [[ $1 == fg ]]; then
38         REPLY=${jobtexts[%+]}
39     elif [[ $1 == fg\ * ]]; then
40         REPLY=${jobtexts[${1#fg }]}
41     # Normal program, return as is.
42     else
43         REPLY=$1
44     fi
45 }
46
47
48 # MISCELLANEOUS SETTINGS
49
50 # Prevent warnings.
51 typeset -g TMOUT
52 # Load general shell setup commands. NOTE: Expand this when publishing the
53 # config.
54 source_config ~/.shell/rc
55
56 # Disable beeps.
57 setopt nobeep
58
59 # Prevent overwriting existing files with '> filename', use '>| filename'
60 # (or >!) instead.
61 setopt noclobber
62
63 # Entering the name of a directory (if it's not a command) will automatically
64 # cd to that directory.
65 setopt autocd
66
67 # When entering a nonexistent command name automatically try to find a similar
68 # one.
69 setopt correct
70
71 # Enable zsh's extended glob abilities.
72 setopt extendedglob
73
74 # Don't exit if <C-D> is pressed. Prevents exiting the shell by accident (e.g.
75 # pressing <C-D> twice).
76 setopt ignoreeof
77
78 # Also display PID when suspending a process.
79 setopt longlistjobs
80
81
82 # KEY BINDINGS
83
84 # Not all bindings are done here, only those not specific to a given section.
85
86 # Use Vi(m) style key bindings.
87 bindkey -v
88
89 # Use jk to exit insert mode (jj is too slow to type).
90 bindkey 'jk' vi-cmd-mode
91
92 # I don't need the arrow keys, I use ^N and ^P for this (see below).
93 bindkey -r '^[OA' '^[OB' '^[OC' '^[OD' '^[[A' '^[[B' '^[[C' '^[[D'
94 # Also not in Vi mode.
95 bindkey -a -r '^[OA' '^[OB' '^[OC' '^[OD' '^[[A' '^[[B' '^[[C' '^[[D'
96
97
98 # FUNCTION SETTINGS
99
100 # Make sure every entry in $fpath is unique.
101 typeset -U fpath
102 # ~/.zsh/functions/completion is a symbolic link to the Completion directory
103 # of a Zsh Git checkout. Use it to get the newest completions if available.
104 if [[ -d ~/.zsh/functions/completion ]]; then
105     fpath=(~/.zsh/functions/completion/*/*(/) $fpath)
106 fi
107 # Set correct fpath to allow loading my functions (including completion
108 # functions).
109 fpath=(~/.zsh/functions $fpath)
110 # Autoload my functions (except completion functions and hidden files). Thanks
111 # to caphuso from the Zsh example files for this idea.
112 if [[ -d ~/.zsh/functions ]]; then
113     autoload -Uz ${fpath[1]}/^_*(^/:t)
114 fi
115
116 # Simulate hooks using _functions arrays for Zsh versions older than 4.3.4. At
117 # the moment only precmd(), preexec() and chpwd() are simulated.
118 if [[ $ZSH_VERSION != (4.3.<4->*|4.<4->*|<5->*) ]]; then
119     # Run all functions defined in the ${precmd,preexec,chpwd}_functions
120     # arrays.
121     function precmd() {
122         for function in $precmd_functions; do
123             $function "$@"
124         done
125     }
126     function preexec() {
127         for function in $preexec_functions; do
128             $function "$@"
129         done
130     }
131     function chpwd() {
132         for function in $chpwd_functions; do
133             $function "$@"
134         done
135     }
136 fi
137
138 # Load zmv (zsh move) which is a powerful file renamer.
139 autoload -Uz zmv
140
141
142 # HISTORY SETTINGS
143
144 # Use history and store it in ~/.zsh/history.
145 HISTSIZE=1000000
146 SAVEHIST=1000000
147 HISTFILE=~/.zsh/history
148 # Append to the history file instead of overwriting it and do it immediately
149 # when a command is executed.
150 setopt appendhistory
151 setopt incappendhistory
152 # If the same command is run multiple times store it only once in the history.
153 setopt histignoredups
154 # Don't add lines starting with a space to the history.
155 setopt histignorespace
156
157 # Vim like completions of previous executed commands (also enter Vi-mode). If
158 # called at the beginning it just recalls old commands (like cursor up), if
159 # called after typing something, only lines starting with the typed text are
160 # returned. Very useful to get old commands quickly - in addition to the
161 # history commands (!..). Thanks to Mikachu in #zsh on Freenode (2010-01-17
162 # 12:47 CET) for the information how to a use function with bindkey.
163 zle -N zshrc-vi-history-beginning-search-backward
164 zshrc-vi-history-beginning-search-backward() {
165     local not_at_beginning_of_line
166     if [[ $CURSOR -ne 0 ]]; then
167         not_at_beginning_of_line=yes
168     fi
169
170     zle history-beginning-search-backward
171
172     # Start Vi-mode and stay at the same position (Vi-mode moves one left,
173     # this counters it).
174     zle vi-cmd-mode
175     if [[ -n $not_at_beginning_of_line ]]; then
176         zle vi-forward-char
177     fi
178 }
179 bindkey '^P' zshrc-vi-history-beginning-search-backward
180 bindkey -a '^P' history-beginning-search-backward # binding for Vi-mode
181 # Here only Vi-mode is necessary as ^P enters Vi-mode and ^N only makes sense
182 # after calling ^P.
183 bindkey -a '^N' history-beginning-search-forward
184
185 # Enable incremental search which is especially useful when the string is an
186 # argument and not the command.
187 bindkey '^R' history-incremental-pattern-search-backward
188 # Also enable my usual use of Ctrl-P/Ctrl-N to get the previous/next matching
189 # history entry.
190 if [[ $ZSH_VERSION == (4.<4->*|<5->*) ]]; then
191     bindkey -M isearch '^P' history-incremental-pattern-search-backward
192     bindkey -M isearch '^N' history-incremental-pattern-search-forward
193 fi
194
195 # Automatically push cd-ed directories on the directory stack.
196 setopt autopushd
197 # Don't push duplicates on the directory stack.
198 setopt pushdignoredups
199 # Exchange the meaning of + and - when specifying a directory on the stack.
200 # This way cd -<Tab> lists the last used directory first, which is more
201 # natural because cd - goes to the last directory.
202 setopt pushdminus
203
204
205 # PROMPT SETTINGS
206
207 # Use colorized output, necessary for prompts and completions.
208 autoload -Uz colors; colors
209
210 # Necessary for $EPOCHSECONDS, the UNIX time.
211 zmodload zsh/datetime
212
213 # Some shortcuts for colors. The %{...%} tells zsh that the data in between
214 # doesn't need any space, necessary for correct prompt drawing. Use %F{color}
215 # in more recent zsh versions (here compatibility is important).
216 local red="%{${fg[red]}%}"
217 local blue="%{${fg[blue]}%}"
218 local green="%{${fg[green]}%}"
219 local yellow="%{${fg[yellow]}%}"
220 local default="%{${fg[default]}%}"
221
222 # vcs_info was added in 4.3.9 but it works in earlier versions too. So load it
223 # if the necessary files are available in ~/.zsh/functions/vcs_info (often a
224 # symbolic link to current checkout of Zsh's sources).
225 if [[ $ZSH_VERSION == (4.3.<9->*|4.<4->*|<5->*) ||
226       -d ~/.zsh/functions/vcs_info ]]; then
227     # Update fpath to allow loading the vcs_info functions.
228     if [[ -d ~/.zsh/functions/vcs_info ]]; then
229        fpath=(~/.zsh/functions/vcs_info/
230               ~/.zsh/functions/vcs_info/Backends
231               $fpath)
232     fi
233
234     # Load vcs_info to display information about version control repositories.
235     autoload -Uz vcs_info
236     # Only look for certain VCS.
237     zstyle ':vcs_info:*' enable git
238     # Check the repository for changes so they can be used in %u/%c (see
239     # below). This comes with a speed penalty for bigger repositories.
240     zstyle ':vcs_info:*' check-for-changes yes
241
242     # Set style of vcs_info display. The current branch (green) and VCS (blue)
243     # is displayed. If there is an special action going on (merge, rebase)
244     # it's also displayed (red). Also display if there are unstaged or staged
245     # (%u/%c) changes.
246     if [[ $ZSH_VERSION == (4.3.<11->*|4.<4->*|<5->*) ||
247           -d ~/.zsh/functions/vcs_info ]]; then
248         zstyle ':vcs_info:*' formats \
249             "(${green}%b%u%c${default}:${blue}%s${default}%m)" \
250             "${green}%u%c${default}"
251         zstyle ':vcs_info:*' actionformats \
252             "(${green}%b%u%c${default}/${red}%a${default}:${blue}%s${default}%m)" \
253             "${green}%u%c${default}"
254     else
255         # In older versions %u and %c are not defined yet and are not
256         # correctly expanded.
257         zstyle ':vcs_info:*' formats \
258             "(${green}%b${default}:${blue}%s${default})"
259         zstyle ':vcs_info:*' actionformats \
260             "(${green}%b${default}/${red}%a${default}:${blue}%s${default})"
261     fi
262     # Set style for formats/actionformats when unstaged (%u) and staged (%c)
263     # changes are detected in the repository; check-for-changes must be set to
264     # true for this to work. Thanks to Bart Trojanowski
265     # (http://jukie.net/~bart/blog/pimping-out-zsh-prompt) for the idea
266     # (2010-03-11 00:20 CET).
267     zstyle ':vcs_info:*' unstagedstr '¹'
268     zstyle ':vcs_info:*' stagedstr   '²'
269
270     # Default to run vcs_info. If possible we prevent running it later for
271     # speed reasons. If set to a non empty value vcs_info is run.
272     zshrc_force_run_vcs_info=1
273
274     # Cache system inspired by Bart Trojanowski
275     # (http://jukie.net/~bart/blog/pimping-out-zsh-prompt).
276     zstyle ':vcs_info:*+pre-get-data:*' hooks pre-get-data
277     +vi-pre-get-data() {
278         # Only Git and Mercurial support and need caching. Abort if any other
279         # VCS is used.
280         [[ $vcs != git && $vcs != hg ]] && return
281
282         # If the shell just started up or we changed directories (or for other
283         # custom reasons) we must run vcs_info.
284         if [[ -n $zshrc_force_run_vcs_info ]]; then
285             zshrc_force_run_vcs_info=
286             return
287         fi
288
289         # Don't run vcs_info by default to speed up the shell.
290         ret=1
291         # If a git/hg command was run then run vcs_info as the status might
292         # need to be updated.
293         case $(fc -ln $(($HISTCMD-1))) in
294             git* | g\ *)
295                 ret=0
296                 ;;
297             hg*)
298                 ret=0
299                 ;;
300         esac
301     }
302
303     # Display number of WIP stashes (this excludes manually named commits
304     # which might be used for something else), thanks to
305     # http://eseth.org/2010/git-in-zsh.html (viewed on 2013-04-27) for the
306     # idea to display the stash count.
307     function +vi-git-stashes() {
308         if [[ -s ${hook_com[base]/.git/refs/stash} ]]; then
309             local -a stashes
310             # Thanks to Valodim in #zsh on Freenode (2013-07-01 14:14 CEST)
311             # for the solution to "grep" the output with (M) and :#(...).
312             stashes=( ${(M)${(f)"$(git stash list 2>/dev/null)"}:#(*WIP*)} )
313
314             if [[ ${#stashes} -gt 0 ]]; then
315                 hook_com[misc]+=" ${yellow}${#stashes}s${default}"
316             fi
317         fi
318     }
319
320     # Apply hooks to Git.
321     zstyle ':vcs_info:git*+set-message:*' hooks git-stashes
322
323     # Must run vcs_info when changing directories.
324     prompt_chpwd() {
325         zshrc_force_run_vcs_info=1
326     }
327     chpwd_functions+=(prompt_chpwd)
328
329     # Used by prompt code below to determine if vcs_info should be run.
330     zshrc_use_vcs_info=1
331 else
332     zshrc_use_vcs_info=
333 fi
334
335 typeset -a zshrc_longrun_data
336 zshrc_longrun_data=()
337 # Display runtime in seconds for long running programs (> 60 seconds) and send
338 # a bell to notify me.
339 zshrc_longrun_preexec() {
340     local program=$3
341
342     # Handle fg.
343     local REPLY
344     zshrc_resolve_fg_to_resumed_job_name $program
345     program=$REPLY
346
347     # Don't track the time for certain (possible) long running processes which
348     # need no automatic notification.
349     for ignore in elinks man mutt vim; do
350         case $program in
351             $ignore | $ignore\ *)
352                 zshrc_longrun_data=()
353                 return
354                 ;;
355         esac
356     done
357
358     zshrc_longrun_data=($program $EPOCHSECONDS)
359 }
360 zshrc_longrun_precmd() {
361     # No previous timestamp available or disabled for this command, ignore.
362     if [[ -z $zshrc_longrun_data ]]; then
363         return
364     fi
365
366     local difference=$(( EPOCHSECONDS - zshrc_longrun_data[2] ))
367     if [[ $difference -gt 60 ]]; then
368         echo
369         echo -n "${fg[yellow]}"
370         echo -n "~> ${(V)zshrc_longrun_data[1]} took $difference seconds."
371         echo -n "${fg[default]}"
372         echo    "\a" # send bell
373     fi
374
375     # Clear status. Prevents displaying old status information when pressing
376     # enter with an empty command line.
377     zshrc_longrun_data=()
378 }
379 preexec_functions+=(zshrc_longrun_preexec)
380 precmd_functions+=(zshrc_longrun_precmd)
381
382 # Set the prompt. A two line prompt is used. On the top left the current
383 # working directory is displayed, on the right vcs_info (if available) and the
384 # current time in hex. On the bottom left current user name and host is shown,
385 # the exit code of the last command if it wasn't 0, the number of running jobs
386 # if not 0.
387 #
388 # The prompt is in green and blue to make easily detectable, the error exit
389 # code in red and bold and the job count in yellow. Designed for dark
390 # terminals.
391 #
392 # Thanks to Adam's prompt for the basic idea of this prompt.
393 zshrc_prompt_precmd() {
394     # Regex to remove elements which take no space. Used to calculate the
395     # width of the top prompt. Thanks to Bart's and Adam's prompt code in
396     # Functions/Prompts/prompt_*_setup.
397     local zero='%([BSUbfksu]|([FB]|){*})'
398
399     # Call vcs_info before every prompt.
400     if [[ -n $zshrc_use_vcs_info ]]; then
401         vcs_info
402     else
403         vcs_info_msg_0_=
404         vcs_info_msg_1_=
405     fi
406
407     # Setup. Create variables holding the formatted content.
408
409     # Current directory in yellow, truncated if necessary (WIDTH is replaced
410     # below).
411     local directory="${yellow}%WIDTH<..<%~%<<${default}"
412     # Minimal information about the VCS, only displayed if there are
413     # unstaged/staged changes.
414     local vcs_staged=${vcs_info_msg_1_}
415
416     # Information about the VCS in this directory.
417     local vcs=${vcs_info_msg_0_}
418     # Current time (seconds since epoch) in Hex in bright blue.
419     local seconds="${blue}%B0x$(([##16] EPOCHSECONDS))%b${default}"
420
421     # User name (%n) in bright green.
422     local user="${green}%B%n%b${default}"
423     # Host name (%m) in bright green; underlined if running on a remote system
424     # through SSH.
425     local host="${green}%B%m%b${default}"
426     if [[ -n $SSH_CONNECTION ]]; then
427         host="%U${host}%u"
428     fi
429
430     # Number of background processes in yellow if not zero.
431     local background="%(1j.${yellow}%j${default}.)"
432     # Exit code in bright red in parentheses if not zero.
433     local exitcode="%(?..(${red}%B%?%b${default}%) )"
434     # Prompt symbol, % for normal users, # in red for root.
435     local symbol="%(!.${red}#${default}.%%)"
436
437     # Prefix characters in first and second line.
438     local top_prefix="${blue}%B.-%b${default}"
439     local bottom_prefix="${blue}%B'%b${default}"
440
441     # Combine them to create the prompt.
442
443     local top_left=${vcs_staged}
444     local top_right="${vcs}(${seconds})"
445
446     local width_top_prefix=${#${(S%%)top_prefix//$~zero/}}
447     local width_top_left=${#${(S%%)top_left//$~zero/}}
448     local width_top_right=${#${(S%%)top_right//$~zero/}}
449
450     # Calculate the maximum width of ${top_left}. -2 are the braces of
451     # ${top_left}, -1 is one separator from ${top_separator} (we want at least
452     # one between left and right parts).
453     local top_left_width_max=$((
454         COLUMNS - $width_top_prefix
455                 - $width_top_left - 2
456                 - 1
457                 - $width_top_right
458     ))
459     # Truncate directory if necessary.
460     top_left="(${directory/WIDTH/${top_left_width_max}})${top_left}"
461     width_top_left=${#${(S%%)top_left//$~zero/}}
462
463     # Calculate the width of the top prompt to fill the middle with "-".
464     local width=$((
465         COLUMNS - width_top_prefix - width_top_left - width_top_right
466     ))
467     local top_separator="%B${blue}${(l:${width}::-:)}%b${default}"
468
469     PROMPT="${top_prefix}${top_left}${top_separator}${top_right}
470 ${bottom_prefix}${user}@${host} ${background}${symbol} ${exitcode}"
471 }
472 precmd_functions+=(zshrc_prompt_precmd)
473
474
475 # When GNU screen, tmux, xterm or rxvt is used set the name of the window to
476 # the currently running program.
477 #
478 # When a program is started preexec() sets the window's name to it; when it
479 # stops precmd() resets the window's name to 'zsh'. 'fg' is supported and sets
480 # the window's name to the resumed job.
481 #
482 # It works with GNU screen, tmux, xterm and rxvt.
483 #
484 # If a command is run with sudo or if the shell is running as root then a ! is
485 # added at the beginning of the command to make this clear. If a command is
486 # running on a different computer with ssh a @ is added at the beginning. If
487 # screen/tmux is running on the remote machine instead of @screen @:hostname
488 # (or @tmux ..; hostname replaced by the machine's hostname) is displayed.
489 # This only works if the .zshrc on the server also uses this command.
490 #
491 # screen* is necessary as `screen` uses screen.linux for example for a linux
492 # console.
493 if [[ $TERM == screen* || $TERM == xterm* || $TERM == rxvt* ]]; then
494     # Is set to a non empty value to reset the window name in the next
495     # precmd() call.
496     zshrc_window_reset=yes
497
498     zshrc_window_preexec() {
499         # Get the program name with its arguments.
500         local program_name=$1
501
502         # When sudo is used, use real program name instead, but with an
503         # exclamation mark at the beginning (handled below).
504         local program_sudo=
505         if [[ $program_name == sudo* ]]; then
506             program_name=${program_name#sudo }
507             program_sudo=yes
508         fi
509
510         # Handle fg.
511         local REPLY
512         zshrc_resolve_fg_to_resumed_job_name $program_name
513         program_name=$REPLY
514
515         # Remove all arguments from the program name.
516         program_name=${program_name%% *}
517
518         # Ignore often used commands which are only running for a very short
519         # time. This prevents a "blinking" name when it's changed to "cd" for
520         # example and then some milliseconds later back to "zsh".
521         [[ $program_name == (cd*|d|ls|l|la|ll|clear|c) ]] && return
522
523         # Change my shortcuts so the real name of the program is displayed.
524         case $program_name in
525             e)
526                 program_name=elinks
527                 ;;
528             g)
529                 program_name=git
530                 ;;
531             m)
532                 program_name=make
533                 ;;
534             p)
535                 program_name=less
536                 ;;
537             v)
538                 program_name=vim
539                 ;;
540             mu)
541                 program_name=mutt
542                 ;;
543         esac
544
545         # Add an exclamation mark at the beginning if running with sudo or if
546         # running zsh as root.
547         if [[ -n $program_sudo || $UID -eq 0 ]]; then
548             program_name=!$program_name
549         fi
550
551         # Add an at mark at the beginning if running through ssh on a
552         # different computer.
553         if [[ -n $SSH_CONNECTION ]]; then
554             program_name="@$program_name"
555
556             # If screen is running in SSH then display "@:hostname" as title
557             # in the term/outer screen.
558             if [[ $program_name == @screen || $program_name == @tmux ]]; then
559                 program_name="@:${HOST//.*/}"
560             # Use "@:!hostname" for root screens.
561             elif [[ $program_name == @!screen || $program_name == @!tmux ]]; then
562                 program_name="@:!${HOST//.*/}"
563             fi
564         fi
565
566         # Set the window name to the currently running program.
567         zshrc_window_title $program_name
568
569         # Tell precmd() to reset the window name when the program stops.
570         zshrc_window_reset=yes
571     }
572
573     zshrc_window_precmd() {
574         # Abort if no window name reset is necessary.
575         [[ -z $zshrc_window_reset ]] && return
576
577         # Reset the window name to 'zsh'.
578         local name=zsh
579         # If the function was called with an argument then reset the window
580         # name to '.zsh' (used by clear alias).
581         if [[ -n $1 ]]; then
582             name=.zsh
583         fi
584
585         # Prepend prefixes like in zshrc_window_preexec().
586         if [[ $UID -eq 0 ]]; then
587             name="!$name"
588         fi
589         if [[ -n $SSH_CONNECTION ]]; then
590             name="@$name"
591         fi
592         zshrc_window_title $name
593
594         # Just reset the name, so no screen reset necessary for the moment.
595         zshrc_window_reset=
596     }
597
598     # Sets the window title. Works with GNU screen, tmux (which uses screen as
599     # TERM), xterm and rxvt. (V) escapes all non-printable characters, thanks
600     # to Mikachu in #zsh on Freenode (2010-08-07 17:09 CEST).
601     if [[ $TERM == screen* ]]; then
602         zshrc_window_title() {
603             print -n "\ek${(V)1}\e\\"
604         }
605     elif [[ $TERM == xterm* || $TERM == rxvt* ]]; then
606         zshrc_window_title() {
607             print -n "\e]2;${(V)1}\e\\"
608         }
609     else
610         # Fallback if another TERM is used.
611         zshrc_window_title() { }
612     fi
613
614     # Add the preexec() and precmd() hooks.
615     preexec_functions+=(zshrc_window_preexec)
616     precmd_functions+=(zshrc_window_precmd)
617 else
618     # Fallback if another TERM is used, necessary to run screen (see below in
619     # "RUN COMMANDS").
620     zshrc_window_preexec() { }
621 fi
622
623
624 # COMPLETION SETTINGS
625
626 # Load the complist module which provides additional features to completion
627 # lists (coloring, scrolling).
628 zmodload zsh/complist
629 # Use new completion system, store dumpfile in ~/.zsh/cache to prevent
630 # cluttering of ~/. $fpath must be set before calling this. Thanks to Adlai in
631 # #zsh on Freenode (2009-08-07 21:05 CEST) for reminding me of the $fpath
632 # problem.
633 autoload -Uz compinit; compinit -d ~/.zsh/cache/zcompdump
634
635 # Use cache to speed up some slow completions (dpkg, perl modules, etc.).
636 zstyle ':completion:*' use-cache yes
637 zstyle ':completion:*' cache-path ~/.zsh/cache
638
639 # List all files in the current directory when pressing tab on an empty input,
640 # behave like complete-word otherwise. Thanks to John Eikenberry [1] for the
641 # code, read on 2014-03-15.
642 #
643 # [1]: http://unix.stackexchange.com/a/32426
644 complete-word-or-complete-list-of-files() {
645     if [[ $#BUFFER == 0 ]]; then
646         BUFFER='ls '
647         CURSOR=3
648         zle list-choices
649         zle backward-kill-word
650     else
651         zle complete-word
652     fi
653 }
654 zle -N complete-word-or-complete-list-of-files
655 # Let the completion system handle all completions, including expanding of
656 # shell wildcards (which is handled by other shell mechanisms if the default
657 # expand-or-complete is used).
658 bindkey '^I' complete-word-or-complete-list-of-files
659 # If there are multiple matches after pressing <Tab> always display them
660 # immediately without requiring another <Tab>. a<Tab> completes to aa and
661 # lists aaa, aab, aac as possible completions if the directory contains aaa,
662 # aab, aac, bbb instead of only completing to aa.
663 setopt nolistambiguous
664 # Support completions in the middle of a word, without this option zsh jumps
665 # to the end of the word before the completion process begins. Is required for
666 # the _prefix completer.
667 setopt completeinword
668
669 # Force a reload of the completion system if nothing matched; this fixes
670 # installing a program and then trying to tab-complete its name. Thanks to
671 # Alex Munroe [1] for the code, read on 2014-03-03.
672 #
673 # [1]: https://github.com/eevee/rc/blob/master/.zshrc
674 _force_rehash() {
675     if (( CURRENT == 1 )); then
676         rehash
677     fi
678     # We didn't really complete anything.
679     return 1
680 }
681
682 zstyle ':completion:::::' completer \
683     _force_rehash _expand _complete _prefix _ignored _approximate
684
685 # Match specification to be tried when completing items. Each group ('...') is
686 # tried after another if no matches were found, once matches are found no
687 # other groups are tried. Thanks to Mikachu in #zsh on Freenode (2012-08-28
688 # 18:48 CEST) for explanations.
689 #
690 # When matching also include the uppercase variant of typed characters
691 # ('m:{a-z}={A-Z}'); using '' before this group would try the unmodified match
692 # first, but I prefer to get all matches immediately (e.g. if Makefile and
693 # makefile exist in the current directory echo m<tab> matches both, with '' it
694 # would only match makefile because it found one match). This allows typing in
695 # lowercase most of the time and completion fixes the case, which is faster.
696 #
697 # Don't perform these fixes in _approximate to prevent it from changing the
698 # input too much. Thanks to the book "From Bash to Z Shell" page 249.
699 zstyle ':completion:*:(^approximate):*' matcher-list 'm:{a-z}={A-Z}'
700
701 # Allow one mistake per three characters. Thanks to the book "From Bash to Z
702 # Shell" page 248.
703 zstyle -e ':completion:*:approximate:*' max-errors \
704     'reply=( $(( ($#PREFIX + $#SUFFIX) / 3 )) )'
705
706 # Expand shell wildcards to all matching files after <Tab>. echo *<Tab>
707 # results in a b c if the directory contains the files a, b, c. Thanks to the
708 # book "From Bash to Z Shell" page 246.
709 zstyle ':completion:*:expand:*' tag-order all-expansions
710 # Keep prefixes unexpanded if possible: $HOME/<Tab> doesn't expand $HOME,
711 # while $HOME<Tab> does.
712 zstyle ':completion:*:expand:*' keep-prefix yes
713
714 # When completing multiple path components display all matching ambiguous
715 # components. For example /u/s/d/r/README<Tab> lists all matching READMEs
716 # instead of just the matching paths up to the r/ component. Can be slow if
717 # there are many matching files.
718 zstyle ':completion:*' list-suffixes yes
719
720 # Use ls-like colors for completions.
721 zstyle ':completion:*' list-colors ${(s.:.)LS_COLORS}
722
723 # Make completion lists scrollable so "do you wish to see all n possibilities"
724 # is no longer displayed. Display current position in percent (%p).
725 zstyle ':completion:*:default' list-prompt '%p'
726 # Display group name (%d) (like 'external command', 'alias', etc.), in bold.
727 # Also display a message if _approximate found errors and no matches were
728 # found.
729 zstyle ':completion:*'             format '    %B%d%b:'
730 zstyle ':completion:*:corrections' format '    %B%d%b (errors: %e)'
731 zstyle ':completion:*:warnings'    format '    %Bno matches for %d%b'
732 # Display different types of matches separately.
733 zstyle ':completion:*' group-name ''
734
735 # Separate man pages by section.
736 zstyle ':completion:*' separate-sections yes
737
738 # Don't draw trailing / in bold (new in zsh 4.3.11). Thanks to Mikachu in #zsh
739 # on Freenode for the fix (2010-12-17 13:46 CET).
740 zle_highlight=(suffix:none)
741
742 # Ignore completion functions.
743 zstyle ':completion:*:functions' ignored-patterns '_*'
744
745 # When offering typo corrections, do not propose anything which starts with an
746 # underscore (such as many of Zsh's shell functions). Thanks to paradigm [1]
747 # for the idea (read on 2013-04-07).
748 #
749 # [1]: https://github.com/paradigm/dotfiles/blob/master/.zshrc
750 CORRECT_IGNORE='_*'
751
752 # Ignore parent directory.
753 zstyle ':completion:*:(cd|mv|cp):*' ignore-parents parent pwd
754 # Always complete file names only once in the current line. This makes it easy
755 # to complete multiple file names because I can just press tab to get all
756 # possible values. Otherwise I would have to skip the first value again and
757 # again. Thanks to Mikachu in #zsh on Freenode (2011-08-11 14:42 CEST) for the
758 # hint to use other. other is necessary so prefix<Tab> lists both prefix and
759 # prefixrest if the directory contains prefix and prefixrest.
760 zstyle ':completion:*:all-files' ignore-line other
761 # Except for mv and cp, because I often want to use to similar names, so I
762 # complete to the same and change it.
763 zstyle ':completion:*:(mv|cp):all-files' ignore-line no
764
765 # Don't complete ./config.* files, this makes running ./configure much
766 # simpler. Thanks to Nomexous in #zsh on Freenode (2010-03-16 01:54 CET)
767 zstyle ':completion:*:*:-command-:*' ignored-patterns './config.*'
768 # Don't complete unwanted files with Vim. Thanks to Nomexous in #zsh on
769 # Freenode (2010-06-06 04:54 CEST). See below for a way to complete them.
770 zstyle ':completion:*:*:vim:*:all-files' ignored-patterns \
771     '*.aux' '*.log' '*.pdf' \
772     '*.class'
773
774 # Provide a fallback completer which always completes files. Useful when Zsh's
775 # completion is too "smart". Thanks to Frank Terbeck <ft@bewatermyfriend.org>
776 # (http://www.zsh.org/mla/users/2009/msg01038.html).
777 zle -C complete-files complete-word _generic
778 zstyle ':completion:complete-files:*' completer _files
779 bindkey '^F' complete-files
780
781 # Completion for my wrapper scripts.
782 compdef slocate=locate
783 compdef srsync=rsync
784 compdef srsync-incremental=rsync
785 compdef svalgrind=valgrind
786
787
788 # CUSTOM ALIASES AND FUNCTIONS
789
790 # If ^C is pressed while typing a command, add it to the history so it can be
791 # easily retrieved later and then abort like ^C normally does. This is useful
792 # when I want to abort an command to do something in between and then finish
793 # typing the command.
794 #
795 # Thanks to Vadim Zeitlin <vz-zsh@zeitlins.org> for a fix (--) so lines
796 # starting with - don't cause errors; and to Nadav Har'El
797 # <nyh@math.technion.ac.il> for a fix (-r) to handle whitespace/quotes
798 # correctly, both on the Zsh mailing list.
799 TRAPINT() {
800     # Don't store this line in history if histignorespace is enabled and the
801     # line starts with a space.
802     if [[ -o histignorespace && ${BUFFER[1]} = ' ' ]]; then
803         return $1
804     fi
805
806     # Store the current buffer in the history.
807     zle && print -s -r -- $BUFFER
808
809     # Return the default exit code so Zsh aborts the current command.
810     return $1
811 }
812
813 # Load aliases and similar functions also used by other shells.
814 if [[ -f ~/.shell/aliases ]]; then
815     . ~/.shell/aliases
816 fi
817
818 # Make sure aliases are expanded when using sudo.
819 alias sudo='sudo '
820
821 # Global aliases for often used redirections.
822 alias -g E='2>&1'
823 alias -g N='>/dev/null'
824 alias -g EN='2>/dev/null'
825 alias -g L='2>&1 | less'
826 alias -g LS='2>&1 | less -S' # -S prevents wrapping of long lines
827 alias -g D='2>&1 | colordiff | less'
828 # Global aliases for often used commands.
829 alias -g A='| awk'
830 alias -g A1="| awk '{ print \$1 }'"
831 alias -g A2="| awk '{ print \$2 }'"
832 alias -g A3="| awk '{ print \$3 }'"
833 alias -g G='| grep'
834 alias -g H='| head'
835 alias -g P='| perl'
836 alias -g S='| sort'
837 alias -g T='| tail'
838 alias -g U='| uniq'
839
840 # Make going up directories simple.
841 alias -g ...='../..'
842 alias -g ....='../../..'
843 alias -g .....='../../../..'
844
845 # If the window naming feature is used (see above) then use ".zsh" (leading
846 # dot) as title name after running clear so it's clear to me that the window
847 # is empty. I open so much windows that I don't know in which I have something
848 # important. This helps me to remember which windows are empty (I run clear
849 # after I finished my work in a window).
850 if [[ -n $zshrc_window_reset ]]; then
851     alias clear='clear; zshrc_window_reset=yes; zshrc_window_precmd reset'
852 fi
853
854
855 # CUSTOM COMMANDS
856
857 # Display all branches (except stash) in gitk but only 200 commits as this is
858 # much faster. Also put in the background and disown. Thanks to drizzd in #git
859 # on Freenode (2010-04-03 17:55 CEST).
860 (( $+commands[gitk] )) && gitk() {
861     command gitk --max-count=200 --branches --remotes --tags "$@" &
862     disown %command
863 }
864 # Same for tig (except the disown part as it's no GUI program).
865 (( $+commands[tig] )) && tig() {
866     command tig --max-count=200 --branches --remotes --tags "$@"
867 }
868
869 # Choose the "best" PDF viewer available. Also setup completion for `pdf`.
870 if (( $+commands[katarakt] )); then
871     pdf() {
872         command katarakt "$@" 2>/dev/null &
873         disown %command
874     }
875     # No completion for katarakt yet.
876     compdef pdf=xpdf
877 elif (( $+commands[xpdf] )); then
878     pdf() {
879         command xpdf "$@" 2>/dev/null &
880         disown %command
881     }
882     compdef pdf=xpdf
883 elif (( $+commands[zathura] )); then
884     pdf() {
885         command zathura "$@" 2>/dev/null &
886         disown %command
887     }
888     # No completion for zathura yet.
889     compdef pdf=xpdf
890 fi
891
892
893 # OS SPECIFIC SETTINGS
894
895 if [[ $OSTYPE == linux* ]]; then
896     # Settings when creating Debian packages.
897     export DEBEMAIL=simon@ruderich.org
898     export DEBFULLNAME='Simon Ruderich'
899 fi
900
901
902 # LOAD ADDITIONAL CONFIGURATION FILES
903
904 # Configuration options for rc.local.
905
906 # Multiplexer to use. By default GNU screen is used. Possible values: screen,
907 # tmux and empty (no multiplexer).
908 zshrc_use_multiplexer=screen
909 # Additional arguments for fortune.
910 zshrc_fortune_arguments=()
911
912 source_config ~/.zsh/rc.local
913
914
915 # RUN COMMANDS
916
917 # Make sure the multiplexer is available. Otherwise the exec terminates our
918 # session.
919 if [[ -n $zshrc_use_multiplexer ]]; then
920     if ! (( $+commands[$zshrc_use_multiplexer] )); then
921         echo "Multiplexer '$zshrc_use_multiplexer' not found." >&2
922         zshrc_use_multiplexer=
923     fi
924 fi
925
926 # If not already in screen or tmux, reattach to a running session or create a
927 # new one. This also starts screen/tmux on a remote server when connecting
928 # through ssh.
929 if [[ $TERM != dumb && $TERM != dialup && $TERM != linux
930         && -z $STY && -z $TMUX ]]; then
931     # Get running detached sessions.
932     if [[ $zshrc_use_multiplexer = screen ]]; then
933         session=$(screen -list | grep 'Detached' | awk '{ print $1; exit }')
934     elif [[ $zshrc_use_multiplexer = tmux ]]; then
935         session=$(tmux list-sessions 2>/dev/null \
936                   | sed '/(attached)$/ d; s/^\([0-9]\{1,\}\).*$/\1/; q')
937     fi
938
939     # As we exec later we have to set the title here.
940     if [[ $zshrc_use_multiplexer = screen ]]; then
941         zshrc_window_preexec screen
942     elif [[ $zshrc_use_multiplexer = tmux ]]; then
943         zshrc_window_preexec tmux
944     fi
945
946     # Create a new session if none is running.
947     if [[ -z $session ]]; then
948         if [[ $zshrc_use_multiplexer = screen ]]; then
949             exec screen
950         elif [[ $zshrc_use_multiplexer = tmux ]]; then
951             exec tmux
952         fi
953     # Reattach to a running session.
954     else
955         if [[ $zshrc_use_multiplexer = screen ]]; then
956             exec screen -r $session
957         elif [[ $zshrc_use_multiplexer = tmux ]]; then
958             exec tmux attach-session -t $session
959         fi
960     fi
961 fi
962
963 # Colorize stderr in bold red. Very useful when looking for errors.
964 if [[ $LD_PRELOAD != *libcoloredstderr.so* ]]; then
965     # coloredstderr found, use it.
966     if [[ -f ~/.zsh/libcoloredstderr.so ]]; then
967         export LD_PRELOAD="$HOME/.zsh/libcoloredstderr.so:$LD_PRELOAD"
968         export COLORED_STDERR_FDS=2,
969         export COLORED_STDERR_PRE=$'\033[91m' # bright red
970         export COLORED_STDERR_IGNORED_BINARIES=/usr/bin/tset
971     # Use the fallback solution.
972     #
973     # Thanks to http://gentoo-wiki.com/wiki/Zsh for the basic script and
974     # Mikachu in #zsh on Freenode (2010-03-07 04:03 CET) for some improvements
975     # (-r, printf). It's not yet perfect and doesn't work with su and git for
976     # example, but it can handle most interactive output quite well (even with
977     # no trailing new line) and in cases it doesn't work, the E alias can be
978     # used as workaround.
979     #
980     # Moved in the "run commands" section to prevent one unnecessary zsh
981     # process when starting GNU screen/tmux (see above).
982     else
983         exec 2>>(while read -r -k -u 0 line; do
984             printf '\e[91m%s\e[0m' $line
985             print -n $'\0'
986         done &)
987     fi
988 fi
989
990 # Display possible log messages from ~/.xinitrc (if `xmessage` wasn't
991 # installed). No race condition as xinitrc has finished before a shell is
992 # executed and only one shell is started on login.
993 if [[ -f ~/.xinitrc.errors ]]; then
994     echo "${fg_bold[red]}xinitrc failed!${fg_bold[default]}"
995     echo
996     cat ~/.xinitrc.errors
997     rm ~/.xinitrc.errors
998     echo
999 fi
1000
1001 # Run the following programs every 4 hours (and when zsh starts).
1002 PERIOD=14400
1003 periodic() {
1004     # Display fortunes.
1005     (( $+commands[fortune] )) && fortune -ac "${zshrc_fortune_arguments[@]}"
1006     # Display reminders.
1007     (( $+commands[rem] )) && [[ -f ~/.reminders ]] && rem -h
1008 }
1009
1010
1011 # RESTART SETTINGS
1012
1013 zmodload -F zsh/stat b:zstat
1014
1015 # Remember startup time. Used to perform automatic restarts when ~/.zshrc is
1016 # modified.
1017 zshrc_startup_time=$EPOCHSECONDS
1018
1019 # Automatically restart Zsh if ~/.zshrc was modified.
1020 zshrc_restart_precmd() {
1021     local stat
1022     if ! zstat -A stat +mtime ~/.zshrc; then
1023         return
1024     fi
1025
1026     # ~/.zshrc wasn't modified, nothing to do.
1027     if [[ $stat -le $zshrc_startup_time ]]; then
1028         return
1029     fi
1030
1031     local startup
1032     strftime -s startup '%Y-%m-%d %H:%M:%S' $zshrc_startup_time
1033
1034     echo -n "${fg[magenta]}"
1035     echo -n "~/.zshrc modified since startup ($startup) ... "
1036     echo -n "${fg[default]}"
1037
1038     if [[ -n $zshrc_disable_restart ]]; then
1039         echo 'automatic restart disabled.'
1040         return
1041     fi
1042
1043     # Don't exec if we have background processes because execing will let us
1044     # lose control over them.
1045     if [[ ${#${(k)jobstates}} -ne 0 ]]; then
1046         echo 'active background jobs!'
1047         return
1048     fi
1049
1050     # Try to start a new interactive shell. If it fails, something is wrong.
1051     # Don't kill our current session by execing it, abort instead.
1052     zsh -i -c 'exit 42'
1053     if [[ $? -ne 42 ]]; then
1054         echo -n ${fg_bold[red]}
1055         echo 'failed to start new zsh!'
1056         echo -n ${fg_bold[default]}
1057         return
1058     fi
1059
1060     echo 'restarting zsh.'
1061     echo
1062
1063     exec zsh
1064 }
1065 precmd_functions+=(zshrc_restart_precmd)
1066
1067 # vim: ft=zsh