]> ruderich.org/simon Gitweb - config/dotfiles.git/blob - shell/zsh/rc
Merge branch 'vcs'
[config/dotfiles.git] / shell / 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     # No background process found.
348     if [[ -z $program ]]; then
349         return
350     fi
351
352     # Don't track the time for certain (possible) long running processes which
353     # need no automatic notification.
354     local ignore
355     for ignore in elinks man mutt vim; do
356         case $program in
357             $ignore | $ignore\ *)
358                 zshrc_longrun_data=()
359                 return
360                 ;;
361         esac
362     done
363
364     zshrc_longrun_data=($program $EPOCHSECONDS)
365 }
366 zshrc_longrun_precmd() {
367     # No previous timestamp available or disabled for this command, ignore.
368     if [[ -z $zshrc_longrun_data ]]; then
369         return
370     fi
371
372     local difference=$(( EPOCHSECONDS - zshrc_longrun_data[2] ))
373     if [[ $difference -gt 60 ]]; then
374         echo
375         echo -n "${fg[yellow]}"
376         echo -n "~> ${(V)zshrc_longrun_data[1]} took $difference seconds."
377         echo -n "${fg[default]}"
378         echo    "\a" # send bell
379     fi
380
381     # Clear status. Prevents displaying old status information when pressing
382     # enter with an empty command line.
383     zshrc_longrun_data=()
384 }
385 preexec_functions+=(zshrc_longrun_preexec)
386 precmd_functions+=(zshrc_longrun_precmd)
387
388 # Set the prompt. A two line prompt is used. On the top left the current
389 # working directory is displayed, on the right vcs_info (if available) and the
390 # current time in hex. On the bottom left current user name and host is shown,
391 # the exit code of the last command if it wasn't 0, the number of running jobs
392 # if not 0.
393 #
394 # The prompt is in green and blue to make easily detectable, the error exit
395 # code in red and bold and the job count in yellow. Designed for dark
396 # terminals.
397 #
398 # Thanks to Adam's prompt for the basic idea of this prompt.
399 zshrc_prompt_precmd() {
400     # Regex to remove elements which take no space. Used to calculate the
401     # width of the top prompt. Thanks to Bart's and Adam's prompt code in
402     # Functions/Prompts/prompt_*_setup.
403     local zero='%([BSUbfksu]|([FB]|){*})'
404
405     # Call vcs_info before every prompt.
406     if [[ -n $zshrc_use_vcs_info ]]; then
407         vcs_info
408     else
409         vcs_info_msg_0_=
410         vcs_info_msg_1_=
411     fi
412
413     # Setup. Create variables holding the formatted content.
414
415     # Current directory in yellow, truncated if necessary (WIDTH is replaced
416     # below).
417     local directory="${yellow}%WIDTH<..<%~%<<${default}"
418     # Minimal information about the VCS, only displayed if there are
419     # unstaged/staged changes.
420     local vcs_staged=${vcs_info_msg_1_}
421
422     # Information about the VCS in this directory.
423     local vcs=${vcs_info_msg_0_}
424     # Current time (seconds since epoch) in Hex in bright blue.
425     local seconds="${blue}%B0x$(([##16] EPOCHSECONDS))%b${default}"
426
427     # User name (%n) in bright green.
428     local user="${green}%B%n%b${default}"
429     # Host name (%m) in bright green; underlined if running on a remote system
430     # through SSH.
431     local host="${green}%B%m%b${default}"
432     if [[ -n $SSH_CONNECTION ]]; then
433         host="%U${host}%u"
434     fi
435
436     # Number of background processes in yellow if not zero.
437     local background="%(1j.${yellow}%j${default}.)"
438     # Exit code in bright red in parentheses if not zero.
439     local exitcode="%(?..(${red}%B%?%b${default}%) )"
440     # Prompt symbol, % for normal users, # in red for root.
441     local symbol="%(!.${red}#${default}.%%)"
442
443     # Prefix characters in first and second line.
444     local top_prefix="${blue}%B.-%b${default}"
445     local bottom_prefix="${blue}%B'%b${default}"
446
447     # Combine them to create the prompt.
448
449     local top_left=${vcs_staged}
450     local top_right="${vcs}(${seconds})"
451
452     local width_top_prefix=${#${(S%%)top_prefix//$~zero/}}
453     local width_top_left=${#${(S%%)top_left//$~zero/}}
454     local width_top_right=${#${(S%%)top_right//$~zero/}}
455
456     # Calculate the maximum width of ${top_left}. -2 are the braces of
457     # ${top_left}, -1 is one separator from ${top_separator} (we want at least
458     # one between left and right parts).
459     local top_left_width_max=$((
460         COLUMNS - $width_top_prefix
461                 - $width_top_left - 2
462                 - 1
463                 - $width_top_right
464     ))
465     # Truncate directory if necessary.
466     top_left="(${directory/WIDTH/${top_left_width_max}})${top_left}"
467     width_top_left=${#${(S%%)top_left//$~zero/}}
468
469     # Calculate the width of the top prompt to fill the middle with "-".
470     local width=$((
471         COLUMNS - width_top_prefix - width_top_left - width_top_right
472     ))
473     local top_separator="%B${blue}${(l:${width}::-:)}%b${default}"
474
475     PROMPT="${top_prefix}${top_left}${top_separator}${top_right}
476 ${bottom_prefix}${user}@${host} ${background}${symbol} ${exitcode}"
477 }
478 precmd_functions+=(zshrc_prompt_precmd)
479
480
481 # When GNU screen, tmux, xterm or rxvt is used set the name of the window to
482 # the currently running program.
483 #
484 # When a program is started preexec() sets the window's name to it; when it
485 # stops precmd() resets the window's name to 'zsh'. 'fg' is supported and sets
486 # the window's name to the resumed job.
487 #
488 # It works with GNU screen, tmux, xterm and rxvt.
489 #
490 # If a command is run with sudo or if the shell is running as root then a ! is
491 # added at the beginning of the command to make this clear. If a command is
492 # running on a different computer with ssh a @ is added at the beginning. If
493 # screen/tmux is running on the remote machine instead of @screen @:hostname
494 # (or @tmux ..; hostname replaced by the machine's hostname) is displayed.
495 # This only works if the .zshrc on the server also uses this command.
496 #
497 # screen* is necessary as `screen` uses screen.linux for example for a linux
498 # console.
499 if [[ $TERM == screen* || $TERM == xterm* || $TERM == rxvt* ]]; then
500     # Is set to a non empty value to reset the window name in the next
501     # precmd() call.
502     zshrc_window_reset=yes
503
504     zshrc_window_preexec() {
505         # Get the program name with its arguments.
506         local program_name=$1
507
508         # When sudo is used, use real program name instead, but with an
509         # exclamation mark at the beginning (handled below).
510         local program_sudo=
511         if [[ $program_name == sudo* ]]; then
512             program_name=${program_name#sudo }
513             program_sudo=yes
514         fi
515
516         # Handle fg.
517         local REPLY
518         zshrc_resolve_fg_to_resumed_job_name $program_name
519         program_name=$REPLY
520
521         # Remove all arguments from the program name.
522         program_name=${program_name%% *}
523
524         # Ignore often used commands which are only running for a very short
525         # time. This prevents a "blinking" name when it's changed to "cd" for
526         # example and then some milliseconds later back to "zsh".
527         [[ $program_name == (cd*|d|ls|l|la|ll|clear|c) ]] && return
528
529         # Change my shortcuts so the real name of the program is displayed.
530         case $program_name in
531             e)
532                 program_name=elinks
533                 ;;
534             g)
535                 program_name=git
536                 ;;
537             m)
538                 program_name=make
539                 ;;
540             p)
541                 program_name=less
542                 ;;
543             v)
544                 program_name=vim
545                 ;;
546             mu)
547                 program_name=mutt
548                 ;;
549         esac
550
551         # Add an exclamation mark at the beginning if running with sudo or if
552         # running zsh as root.
553         if [[ -n $program_sudo || $UID -eq 0 ]]; then
554             program_name=!$program_name
555         fi
556
557         # Add an at mark at the beginning if running through ssh on a
558         # different computer.
559         if [[ -n $SSH_CONNECTION ]]; then
560             program_name="@$program_name"
561
562             # If screen is running in SSH then display "@:hostname" as title
563             # in the term/outer screen.
564             if [[ $program_name == @screen || $program_name == @tmux ]]; then
565                 program_name="@:${HOST//.*/}"
566             # Use "@:!hostname" for root screens.
567             elif [[ $program_name == @!screen || $program_name == @!tmux ]]; then
568                 program_name="@:!${HOST//.*/}"
569             fi
570         fi
571
572         # Set the window name to the currently running program.
573         zshrc_window_title $program_name
574
575         # Tell precmd() to reset the window name when the program stops.
576         zshrc_window_reset=yes
577     }
578
579     zshrc_window_precmd() {
580         # Abort if no window name reset is necessary.
581         [[ -z $zshrc_window_reset ]] && return
582
583         # Reset the window name to 'zsh'.
584         local name=zsh
585         # If the function was called with an argument then reset the window
586         # name to '.zsh' (used by clear alias).
587         if [[ -n $1 ]]; then
588             name=.zsh
589         fi
590
591         # Prepend prefixes like in zshrc_window_preexec().
592         if [[ $UID -eq 0 ]]; then
593             name="!$name"
594         fi
595         if [[ -n $SSH_CONNECTION ]]; then
596             name="@$name"
597         fi
598         zshrc_window_title $name
599
600         # Just reset the name, so no screen reset necessary for the moment.
601         zshrc_window_reset=
602     }
603
604     # Sets the window title. Works with GNU screen, tmux (which uses screen as
605     # TERM), xterm and rxvt. (V) escapes all non-printable characters, thanks
606     # to Mikachu in #zsh on Freenode (2010-08-07 17:09 CEST).
607     if [[ $TERM == screen* ]]; then
608         zshrc_window_title() {
609             print -n "\ek${(V)1}\e\\"
610         }
611     elif [[ $TERM == xterm* || $TERM == rxvt* ]]; then
612         zshrc_window_title() {
613             print -n "\e]2;${(V)1}\e\\"
614         }
615     else
616         # Fallback if another TERM is used.
617         zshrc_window_title() { }
618     fi
619
620     # Add the preexec() and precmd() hooks.
621     preexec_functions+=(zshrc_window_preexec)
622     precmd_functions+=(zshrc_window_precmd)
623 else
624     # Fallback if another TERM is used, necessary to run screen (see below in
625     # "RUN COMMANDS").
626     zshrc_window_preexec() { }
627 fi
628
629
630 # COMPLETION SETTINGS
631
632 # Load the complist module which provides additional features to completion
633 # lists (coloring, scrolling).
634 zmodload zsh/complist
635 # Use new completion system, store dumpfile in ~/.zsh/cache to prevent
636 # cluttering of ~/. $fpath must be set before calling this. Thanks to Adlai in
637 # #zsh on Freenode (2009-08-07 21:05 CEST) for reminding me of the $fpath
638 # problem.
639 autoload -Uz compinit; compinit -d ~/.zsh/cache/zcompdump
640
641 # Use cache to speed up some slow completions (dpkg, perl modules, etc.).
642 zstyle ':completion:*' use-cache yes
643 zstyle ':completion:*' cache-path ~/.zsh/cache
644
645 # List all files in the current directory when pressing tab on an empty input,
646 # behave like complete-word otherwise. Thanks to John Eikenberry [1] for the
647 # code, read on 2014-03-15.
648 #
649 # [1]: http://unix.stackexchange.com/a/32426
650 complete-word-or-complete-list-of-files() {
651     if [[ $#BUFFER == 0 ]]; then
652         BUFFER='ls '
653         CURSOR=3
654         zle list-choices
655         zle backward-kill-word
656     else
657         zle complete-word
658     fi
659 }
660 zle -N complete-word-or-complete-list-of-files
661 # Let the completion system handle all completions, including expanding of
662 # shell wildcards (which is handled by other shell mechanisms if the default
663 # expand-or-complete is used).
664 bindkey '^I' complete-word-or-complete-list-of-files
665 # If there are multiple matches after pressing <Tab> always display them
666 # immediately without requiring another <Tab>. a<Tab> completes to aa and
667 # lists aaa, aab, aac as possible completions if the directory contains aaa,
668 # aab, aac, bbb instead of only completing to aa.
669 setopt nolistambiguous
670 # Support completions in the middle of a word, without this option zsh jumps
671 # to the end of the word before the completion process begins. Is required for
672 # the _prefix completer.
673 setopt completeinword
674
675 # Force a reload of the completion system if nothing matched; this fixes
676 # installing a program and then trying to tab-complete its name. Thanks to
677 # Alex Munroe [1] for the code, read on 2014-03-03.
678 #
679 # [1]: https://github.com/eevee/rc/blob/master/.zshrc
680 _force_rehash() {
681     if (( CURRENT == 1 )); then
682         rehash
683     fi
684     # We didn't really complete anything.
685     return 1
686 }
687
688 zstyle ':completion:::::' completer \
689     _force_rehash _expand _complete _prefix _ignored _approximate
690
691 # Match specification to be tried when completing items. Each group ('...') is
692 # tried after another if no matches were found, once matches are found no
693 # other groups are tried. Thanks to Mikachu in #zsh on Freenode (2012-08-28
694 # 18:48 CEST) for explanations.
695 #
696 # When matching also include the uppercase variant of typed characters
697 # ('m:{a-z}={A-Z}'); using '' before this group would try the unmodified match
698 # first, but I prefer to get all matches immediately (e.g. if Makefile and
699 # makefile exist in the current directory echo m<tab> matches both, with '' it
700 # would only match makefile because it found one match). This allows typing in
701 # lowercase most of the time and completion fixes the case, which is faster.
702 #
703 # Don't perform these fixes in _approximate to prevent it from changing the
704 # input too much. Thanks to the book "From Bash to Z Shell" page 249.
705 zstyle ':completion:*:(^approximate):*' matcher-list 'm:{a-z}={A-Z}'
706
707 # Allow one mistake per three characters. Thanks to the book "From Bash to Z
708 # Shell" page 248.
709 zstyle -e ':completion:*:approximate:*' max-errors \
710     'reply=( $(( ($#PREFIX + $#SUFFIX) / 3 )) )'
711
712 # Expand shell wildcards to all matching files after <Tab>. echo *<Tab>
713 # results in a b c if the directory contains the files a, b, c. Thanks to the
714 # book "From Bash to Z Shell" page 246.
715 zstyle ':completion:*:expand:*' tag-order all-expansions
716 # Keep prefixes unexpanded if possible: $HOME/<Tab> doesn't expand $HOME,
717 # while $HOME<Tab> does.
718 zstyle ':completion:*:expand:*' keep-prefix yes
719
720 # When completing multiple path components display all matching ambiguous
721 # components. For example /u/s/d/r/README<Tab> lists all matching READMEs
722 # instead of just the matching paths up to the r/ component. Can be slow if
723 # there are many matching files.
724 zstyle ':completion:*' list-suffixes yes
725
726 # Use ls-like colors for completions.
727 zstyle ':completion:*' list-colors ${(s.:.)LS_COLORS}
728
729 # Make completion lists scrollable so "do you wish to see all n possibilities"
730 # is no longer displayed. Display current position in percent (%p).
731 zstyle ':completion:*:default' list-prompt '%p'
732 # Display group name (%d) (like 'external command', 'alias', etc.), in bold.
733 # Also display a message if _approximate found errors and no matches were
734 # found.
735 zstyle ':completion:*'             format '    %B%d%b:'
736 zstyle ':completion:*:corrections' format '    %B%d%b (errors: %e)'
737 zstyle ':completion:*:warnings'    format '    %Bno matches for %d%b'
738 # Display different types of matches separately.
739 zstyle ':completion:*' group-name ''
740
741 # Separate man pages by section.
742 zstyle ':completion:*' separate-sections yes
743
744 # Don't draw trailing / in bold (new in zsh 4.3.11). Thanks to Mikachu in #zsh
745 # on Freenode for the fix (2010-12-17 13:46 CET).
746 zle_highlight=(suffix:none)
747
748 # Ignore completion functions.
749 zstyle ':completion:*:functions' ignored-patterns '_*'
750
751 # When offering typo corrections, do not propose anything which starts with an
752 # underscore (such as many of Zsh's shell functions). Thanks to paradigm [1]
753 # for the idea (read on 2013-04-07).
754 #
755 # [1]: https://github.com/paradigm/dotfiles/blob/master/.zshrc
756 CORRECT_IGNORE='_*'
757
758 # Ignore parent directory.
759 zstyle ':completion:*:(cd|mv|cp):*' ignore-parents parent pwd
760 # Always complete file names only once in the current line. This makes it easy
761 # to complete multiple file names because I can just press tab to get all
762 # possible values. Otherwise I would have to skip the first value again and
763 # again. Thanks to Mikachu in #zsh on Freenode (2011-08-11 14:42 CEST) for the
764 # hint to use other. other is necessary so prefix<Tab> lists both prefix and
765 # prefixrest if the directory contains prefix and prefixrest.
766 zstyle ':completion:*:all-files' ignore-line other
767 # Except for mv and cp, because I often want to use to similar names, so I
768 # complete to the same and change it.
769 zstyle ':completion:*:(mv|cp):all-files' ignore-line no
770
771 # Don't complete ./config.* files, this makes running ./configure much
772 # simpler. Thanks to Nomexous in #zsh on Freenode (2010-03-16 01:54 CET)
773 zstyle ':completion:*:*:-command-:*' ignored-patterns './config.*'
774 # Don't complete unwanted files with Vim. Thanks to Nomexous in #zsh on
775 # Freenode (2010-06-06 04:54 CEST). See below for a way to complete them.
776 zstyle ':completion:*:*:vim:*:all-files' ignored-patterns \
777     '*.aux' '*.log' '*.pdf' '*.bbl' '*.blg' '*.out' '*-blx.bib' '*.run.xml' \
778     '*.o' \
779     '*.pyc' \
780     '*.class'
781
782 # Provide a fallback completer which always completes files. Useful when Zsh's
783 # completion is too "smart". Thanks to Frank Terbeck <ft@bewatermyfriend.org>
784 # (http://www.zsh.org/mla/users/2009/msg01038.html).
785 zle -C complete-files complete-word _generic
786 zstyle ':completion:complete-files:*' completer _files
787 bindkey '^F' complete-files
788
789 # Completion for my wrapper scripts.
790 compdef slocate=locate
791 compdef srsync=rsync
792 compdef srsync-incremental=rsync
793 compdef svalgrind=valgrind
794 compdef sc=systemctl
795
796
797 # CUSTOM ALIASES AND FUNCTIONS
798
799 # If ^C is pressed while typing a command, add it to the history so it can be
800 # easily retrieved later and then abort like ^C normally does. This is useful
801 # when I want to abort an command to do something in between and then finish
802 # typing the command.
803 #
804 # Thanks to Vadim Zeitlin <vz-zsh@zeitlins.org> for a fix (--) so lines
805 # starting with - don't cause errors; and to Nadav Har'El
806 # <nyh@math.technion.ac.il> for a fix (-r) to handle whitespace/quotes
807 # correctly, both on the Zsh mailing list.
808 TRAPINT() {
809     # Don't store this line in history if histignorespace is enabled and the
810     # line starts with a space.
811     if [[ -o histignorespace && ${BUFFER[1]} = ' ' ]]; then
812         return $1
813     fi
814
815     # Store the current buffer in the history.
816     zle && print -s -r -- $BUFFER
817
818     # Return the default exit code so Zsh aborts the current command.
819     return $1
820 }
821
822 # Load aliases and similar functions also used by other shells.
823 if [[ -f ~/.shell/aliases ]]; then
824     . ~/.shell/aliases
825 fi
826
827 # Make sure aliases are expanded when using sudo.
828 alias sudo='sudo '
829
830 # Global aliases for often used redirections.
831 alias -g E='2>&1'
832 alias -g N='>/dev/null'
833 alias -g EN='2>/dev/null'
834 alias -g L='2>&1 | less'
835 alias -g LS='2>&1 | less -S' # -S prevents wrapping of long lines
836 alias -g D='2>&1 | colordiff | less'
837 # Global aliases for often used commands.
838 alias -g A='| awk'
839 alias -g A1="| awk '{ print \$1 }'"
840 alias -g A2="| awk '{ print \$2 }'"
841 alias -g A3="| awk '{ print \$3 }'"
842 alias -g G='| grep'
843 alias -g GB='| grep -vE "^Binary file .+ matches\$"'
844 alias -g H='| head'
845 alias -g P='| perl'
846 alias -g S='| sort'
847 alias -g SL='| sort | less'
848 alias -g T='| tail'
849 alias -g U='| uniq'
850 alias -g X='`xsel -p || xclip -o`' # X selection
851
852 # Make going up directories simple.
853 alias -g ...='../..'
854 alias -g ....='../../..'
855 alias -g .....='../../../..'
856
857 # If the window naming feature is used (see above) then use ".zsh" (leading
858 # dot) as title name after running clear so it's clear to me that the window
859 # is empty. I open so much windows that I don't know in which I have something
860 # important. This helps me to remember which windows are empty (I run clear
861 # after I finished my work in a window).
862 if [[ -n $zshrc_window_reset ]]; then
863     alias clear='clear; zshrc_window_reset=yes; zshrc_window_precmd reset'
864 fi
865
866
867 # CUSTOM COMMANDS
868
869 # Display all branches (except stash) in gitk but only 200 commits as this is
870 # much faster. Also put in the background and disown. Thanks to drizzd in #git
871 # on Freenode (2010-04-03 17:55 CEST).
872 (( $+commands[gitk] )) && gitk() {
873     command gitk --max-count=200 --branches --remotes --tags "$@" &
874     disown %command
875 }
876 # Same for tig (except the disown part as it's no GUI program).
877 (( $+commands[tig] )) && tig() {
878     command tig --max-count=200 --branches --remotes --tags "$@"
879 }
880
881 # Choose the "best" PDF viewer available. Also setup completion for `pdf`.
882 if (( $+commands[katarakt] )); then
883     pdf() {
884         command katarakt "$@" 2>/dev/null &
885         disown %command
886     }
887     # No completion for katarakt yet.
888     compdef pdf=xpdf
889 elif (( $+commands[xpdf] )); then
890     pdf() {
891         command xpdf "$@" 2>/dev/null &
892         disown %command
893     }
894     compdef pdf=xpdf
895 elif (( $+commands[zathura] )); then
896     pdf() {
897         command zathura "$@" 2>/dev/null &
898         disown %command
899     }
900     # No completion for zathura yet.
901     compdef pdf=xpdf
902 fi
903
904
905 # OS SPECIFIC SETTINGS
906
907 if [[ $OSTYPE == linux* ]]; then
908     # Settings when creating Debian packages.
909     export DEBEMAIL=simon@ruderich.org
910     export DEBFULLNAME='Simon Ruderich'
911 fi
912
913
914 # LOAD ADDITIONAL CONFIGURATION FILES
915
916 # Configuration options for rc.local.
917
918 # Multiplexer to use. By default GNU screen is used. Possible values: screen,
919 # tmux and empty (no multiplexer).
920 zshrc_use_multiplexer=screen
921 # Additional arguments for fortune.
922 zshrc_fortune_arguments=()
923
924 source_config ~/.zsh/rc.local
925
926
927 # RUN COMMANDS
928
929 # Make sure the multiplexer is available. Otherwise the exec terminates our
930 # session.
931 if [[ -n $zshrc_use_multiplexer ]]; then
932     if ! (( $+commands[$zshrc_use_multiplexer] )); then
933         echo "Multiplexer '$zshrc_use_multiplexer' not found." >&2
934         zshrc_use_multiplexer=
935     fi
936 fi
937
938 # If not already in screen or tmux, reattach to a running session or create a
939 # new one. This also starts screen/tmux on a remote server when connecting
940 # through ssh.
941 if [[ $TERM != dumb && $TERM != dialup && $TERM != linux
942         && -z $STY && -z $TMUX ]]; then
943     # Get running detached sessions.
944     if [[ $zshrc_use_multiplexer = screen ]]; then
945         session=$(screen -list | grep 'Detached' | awk '{ print $1; exit }')
946     elif [[ $zshrc_use_multiplexer = tmux ]]; then
947         session=$(tmux list-sessions 2>/dev/null \
948                   | sed '/(attached)$/ d; s/^\([0-9]\{1,\}\).*$/\1/; q')
949     fi
950
951     # As we exec later we have to set the title here.
952     if [[ $zshrc_use_multiplexer = screen ]]; then
953         zshrc_window_preexec screen
954     elif [[ $zshrc_use_multiplexer = tmux ]]; then
955         zshrc_window_preexec tmux
956     fi
957
958     # Create a new session if none is running.
959     if [[ -z $session ]]; then
960         if [[ $zshrc_use_multiplexer = screen ]]; then
961             exec screen
962         elif [[ $zshrc_use_multiplexer = tmux ]]; then
963             exec tmux
964         fi
965     # Reattach to a running session.
966     else
967         if [[ $zshrc_use_multiplexer = screen ]]; then
968             exec screen -r $session
969         elif [[ $zshrc_use_multiplexer = tmux ]]; then
970             exec tmux attach-session -t $session
971         fi
972     fi
973 fi
974
975 # Colorize stderr in bold red. Very useful when looking for errors.
976 if [[ $LD_PRELOAD != *libcoloredstderr.so* ]]; then
977     # coloredstderr found, use it.
978     if [[ -f ~/.zsh/libcoloredstderr.so ]]; then
979         export LD_PRELOAD="$HOME/.zsh/libcoloredstderr.so:$LD_PRELOAD"
980         export COLORED_STDERR_FDS=2,
981         export COLORED_STDERR_PRE=$'\033[91m' # bright red
982         export COLORED_STDERR_IGNORED_BINARIES=/usr/bin/tset
983     # Use the fallback solution.
984     #
985     # Thanks to http://gentoo-wiki.com/wiki/Zsh for the basic script and
986     # Mikachu in #zsh on Freenode (2010-03-07 04:03 CET) for some improvements
987     # (-r, printf). It's not yet perfect and doesn't work with su and git for
988     # example, but it can handle most interactive output quite well (even with
989     # no trailing new line) and in cases it doesn't work, the E alias can be
990     # used as workaround.
991     #
992     # Moved in the "run commands" section to prevent one unnecessary zsh
993     # process when starting GNU screen/tmux (see above).
994     else
995         exec 2>>(while read -r -k -u 0 line; do
996             printf '\e[91m%s\e[0m' $line
997             print -n $'\0'
998         done &)
999
1000         # Reset doesn't work with this hack.
1001         reset() {
1002             command reset "$@" 2>&1
1003         }
1004     fi
1005 fi
1006
1007 # Display possible log messages from ~/.xinitrc (if `xmessage` wasn't
1008 # installed). No race condition as xinitrc has finished before a shell is
1009 # executed and only one shell is started on login.
1010 if [[ -f ~/.xinitrc.errors ]]; then
1011     echo "${fg_bold[red]}xinitrc failed!${fg_bold[default]}"
1012     echo
1013     cat ~/.xinitrc.errors
1014     rm ~/.xinitrc.errors
1015     echo
1016 fi
1017
1018 # Run the following programs every 4 hours (and when zsh starts).
1019 PERIOD=14400
1020 periodic() {
1021     # Display fortunes.
1022     (( $+commands[fortune] )) && fortune -ac "${zshrc_fortune_arguments[@]}"
1023     # Display reminders.
1024     (( $+commands[rem] )) && [[ -f ~/.reminders ]] && rem -h
1025 }
1026
1027
1028 # RESTART SETTINGS
1029
1030 zmodload -F zsh/stat b:zstat
1031
1032 # Remember startup time. Used to perform automatic restarts when ~/.zshrc is
1033 # modified.
1034 zshrc_startup_time=$EPOCHSECONDS
1035
1036 # Automatically restart Zsh if ~/.zshrc was modified.
1037 zshrc_restart_precmd() {
1038     local stat
1039     if ! zstat -A stat +mtime ~/.zshrc; then
1040         return
1041     fi
1042
1043     # ~/.zshrc wasn't modified, nothing to do.
1044     if [[ $stat -le $zshrc_startup_time ]]; then
1045         return
1046     fi
1047
1048     local startup
1049     strftime -s startup '%Y-%m-%d %H:%M:%S' $zshrc_startup_time
1050
1051     echo -n "${fg[magenta]}"
1052     echo -n "~/.zshrc modified since startup ($startup) ... "
1053     echo -n "${fg[default]}"
1054
1055     if [[ -n $zshrc_disable_restart ]]; then
1056         echo 'automatic restart disabled.'
1057         return
1058     fi
1059
1060     # Don't exec if we have background processes because execing will let us
1061     # lose control over them.
1062     if [[ ${#${(k)jobstates}} -ne 0 ]]; then
1063         echo 'active background jobs!'
1064         return
1065     fi
1066
1067     # Try to start a new interactive shell. If it fails, something is wrong.
1068     # Don't kill our current session by execing it, abort instead.
1069     zsh -i -c 'exit 42'
1070     if [[ $? -ne 42 ]]; then
1071         echo -n ${fg_bold[red]}
1072         echo 'failed to start new zsh!'
1073         echo -n ${fg_bold[default]}
1074         return
1075     fi
1076
1077     echo 'restarting zsh.'
1078     echo
1079
1080     exec zsh
1081 }
1082 precmd_functions+=(zshrc_restart_precmd)
1083
1084
1085 # RELOAD SETTINGS
1086
1087 zshenv_reload_time=0 # load before first command
1088 zshenv_boot_time=$(date -d "$(uptime -s)" '+%s') # uptime in epoch seconds
1089
1090 # Automatically source ~/.zsh/env.update when the file changes (and exists).
1091 # Can be used e.g. to update SSH_AGENT_PID and GPG_AGENT_INFO variables in
1092 # running zsh processes. Sourced immediately before executing shell commands
1093 # (preexec) to ensure the environment is always up to date.
1094 zshenv_reload_preexec() {
1095     local file
1096     file=~/.zsh/env.update
1097
1098     local stat
1099     if ! zstat -A stat +mtime $file 2>/dev/null; then
1100         return
1101     fi
1102     # File was modified before reboot. Skip it to prevent loading of old
1103     # values.
1104     if [[ $stat -lt $zshenv_boot_time ]]; then
1105         return
1106     fi
1107     # File wasn't modified, nothing to do.
1108     if [[ $stat -le $zshenv_reload_time ]]; then
1109         return
1110     fi
1111     zshenv_reload_time=$EPOCHSECONDS
1112
1113     unsetopt warn_create_global
1114     . $file
1115     setopt warn_create_global
1116 }
1117 preexec_functions+=(zshenv_reload_preexec)
1118
1119 # vim: ft=zsh