Bump version to 0.11.3

Source missing utility functions in tmuxifier-tmux

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Jim Myhrberg.
+Copyright (c) 2014 Jim Myhrberg.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -5,7 +5,7 @@ and pane configurations with ease.
 
 In short, Tmuxifier allows you to easily create, edit, and load "layout"
 files, which are simple shell scripts where you use the `tmux` command and
-helper commands provided by tmuxifier to manage Tmux sessions and windows
+helper commands provided by `tmuxifier` to manage Tmux sessions and windows
 
 ### Window Layouts
 
@@ -54,13 +54,13 @@ Clone the repo to your machine:
 
     git clone https://github.com/jimeh/tmuxifier.git ~/.tmuxifier
 
-Then add `~/.tmuxifier/bin` to your PATH to make the `tmuxifier` executable
+Then add `$HOME/.tmuxifier/bin` to your PATH to make the `tmuxifier` executable
 available to you:
 
 __In bash & zsh:__
 
 ```bash
-export PATH="~/.tmuxifier/bin:$PATH"
+export PATH="$HOME/.tmuxifier/bin:$PATH"
 ```
 
 __In tcsh:__
@@ -69,6 +69,12 @@ __In tcsh:__
 set path = ( "~/.tmuxifier/bin" $path )
 ```
 
+__In fish:__
+
+```bash
+set -gx PATH "~/.tmuxifier/bin" $PATH
+```
+
 ### Custom Installation Path
 
 To install Tmuxifier somewhere else than the suggested `~/.tmuxifier`, simply
@@ -94,10 +100,37 @@ Add the following to your `~/.cshrc`, `~/.tcshrc` or equivalent:
 eval `tmuxifier init -`
 ```
 
+__In fish:__
+
+And add the following to your `~/.config/fish/config.fish` or equivalent:
+
+```bash
+eval (tmuxifier init -)
+```
+
+### Custom Tmux Arguments
+
+If you need to pass custom arguments to `tmux` itself, you can do so by
+setting the `TMUXIFIER_TMUX_OPTS` environment variable. For example to set
+custom arguments globally:
+
+```bash
+export TMUXIFIER_TMUX_OPTS="-L my-awesome-socket-name"
+eval "$(tmuxifier init -)"
+```
+
+And/or specify dynamically when calling `tmuxifier`:
+
+```bash
+TMUXIFIER_TMUX_OPTS="-L other-socket" tmuxifier load-session welcome
+```
+
 ## Updating
 
-    cd ~/.tmuxifier
-    git pull
+```bash
+cd ~/.tmuxifier # or where you've cloned tmuxifier to
+git pull
+```
 
 ## Usage
 
@@ -162,8 +195,8 @@ export TMUXIFIER_LAYOUT_PATH="$HOME/.tmux-layouts"
 
 ### Disable Shell-Completion
 
-Tmuxifier comes with shell-completion for bash, zsh and tcsh. If for any
-reason you need to disable it, just set `$TMUXIFIER_NO_COMPLETE`.
+Tmuxifier comes with shell-completion for bash, zsh, tcsh, and fish. If for
+any reason you need to disable it, just set `$TMUXIFIER_NO_COMPLETE`.
 
 ```bash
 export TMUXIFIER_NO_COMPLETE=1
@@ -202,7 +235,7 @@ it does set itself apart in a number of ways:
 
 (The MIT license)
 
-Copyright (c) 2013 Jim Myhrberg.
+Copyright (c) 2014 Jim Myhrberg.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

bin/tmuxifier

@@ -21,16 +21,28 @@ abs_dirname() {
 }
 
 if [ -z "${TMUXIFIER}" ]; then
+  # Set TMUXIFIER relative to the "tmuxifier" executable.
   export TMUXIFIER="$(dirname "$(abs_dirname "$0")")"
 else
+  # Strip any trailing slash (/) characters from TMUXIFIER variable.
   export TMUXIFIER="${TMUXIFIER%/}"
 fi
 
 # Load tmuxifier environment variables.
 source "$TMUXIFIER/lib/env.sh"
 
+# Add tmuxifier's internal commands to PATH.
 export PATH="$TMUXIFIER/libexec:$PATH"
 
+# Check Tmux version.
+export TMUXIFIER_MIN_TMUX_VERSION="1.6"
+if [ "$(tmuxifier-tmux-version "$TMUXIFIER_MIN_TMUX_VERSION")" == "<" ]; then
+  echo -e "ERROR: Tmuxifier requires Tmux v${TMUXIFIER_MIN_TMUX_VERSION}" \
+       "or newer. You have v$(tmuxifier-tmux-version)." >&2
+  exit 1
+fi
+
+# Parse given command
 command="$1"
 case "$command" in
   "" | "-h" | "--help" )

completion/tmuxifier.fish

@@ -0,0 +1,36 @@
+
+set -l cmd_load_session  'load-session s'
+set -l cmd_load_window   'load-window w'
+set -l cmd_list          'list l'
+set -l cmd_list_sessions 'list-sessions ls'
+set -l cmd_list_windows  'list-windows lw'
+set -l cmd_new_session   'new-session ns'
+set -l cmd_new_window    'new-window nw'
+set -l cmd_edit_session  'edit-session es'
+set -l cmd_edit_window   'edit-window ew'
+set -l cmd_commands      'commands'
+set -l cmd_version       'version'
+set -l cmd_help          'help'
+
+complete -c tmuxifier -x
+
+# Commands
+complete -c tmuxifier -n '__fish_use_subcommand' -a $cmd_load_session  -d 'Load the specified session layout.'
+complete -c tmuxifier -n '__fish_use_subcommand' -a $cmd_load_window   -d 'Load the specified window layout into current session.'
+complete -c tmuxifier -n '__fish_use_subcommand' -a $cmd_list          -d 'List all session and window layouts.'
+complete -c tmuxifier -n '__fish_use_subcommand' -a $cmd_list_sessions -d 'List session layouts.'
+complete -c tmuxifier -n '__fish_use_subcommand' -a $cmd_list_windows  -d 'List window layouts.'
+complete -c tmuxifier -n '__fish_use_subcommand' -a $cmd_new_session   -d 'Create new session layout and open it with $EDITOR.'
+complete -c tmuxifier -n '__fish_use_subcommand' -a $cmd_new_window    -d 'Create new window layout and open it with $EDITOR.'
+complete -c tmuxifier -n '__fish_use_subcommand' -a $cmd_edit_session  -d 'Edit specified session layout with $EDITOR.'
+complete -c tmuxifier -n '__fish_use_subcommand' -a $cmd_edit_window   -d 'Edit specified window layout with $EDITOR.'
+complete -c tmuxifier -n '__fish_use_subcommand' -a $cmd_commands      -d 'List all tmuxifier commands.'
+complete -c tmuxifier -n '__fish_use_subcommand' -a $cmd_version       -d 'Print Tmuxifier version.'
+complete -c tmuxifier -n '__fish_use_subcommand' -a $cmd_help          -d 'Show this message.'
+
+# Complete subcommands
+complete -c tmuxifier -x -n "__fish_seen_subcommand_from $cmd_load_session" -a '(tmuxifier list-sessions)' -d 'session-template'
+complete -c tmuxifier -x -n "__fish_seen_subcommand_from $cmd_load_window"  -a '(tmuxifier list-windows)'  -d 'window-template'
+complete -c tmuxifier -x -n "__fish_seen_subcommand_from $cmd_edit_session" -a '(tmuxifier list-sessions)' -d 'session-template'
+complete -c tmuxifier -x -n "__fish_seen_subcommand_from $cmd_edit_window"  -a '(tmuxifier list-windows)'  -d 'window-template'
+

init.fish

@@ -0,0 +1,17 @@
+# Set/fix Tmuxifier root path if needed.
+if test -z $TMUXIFIER
+  set -gx TMUXIFIER "$HOME/.tmuxifier"
+end
+
+# Add `bin` directroy to `$PATH`.
+if not contains "$TMUXIFIER/bin" $PATH
+  set -gx PATH "$TMUXIFIER/bin" $PATH
+end
+
+# If `tmuxifier` is available, and `$TMUXIFIER_NO_COMPLETE` is not set, then
+# load Tmuxifier shell completion.
+if test -n (which tmuxifier); and test -z $TMUXIFIER_NO_COMPLETE
+  source "$TMUXIFIER/completion/tmuxifier.fish"
+end
+
+

lib/layout-helpers.sh

@@ -6,6 +6,11 @@
 # otherwise more complex means.
 #
 
+# Alias tmux to tmuxifier-tmux wrapper.
+tmux() {
+  tmuxifier-tmux "$@"
+}
+
 # Create a new window.
 #
 # Arguments:
@@ -17,7 +22,7 @@ new_window() {
   if [ -n "$2" ]; then local command=("$2"); fi
   if [ -n "$window" ]; then local winarg=(-n "$window"); fi
 
-  tmux new-window -t "$session:" "${winarg[@]}" "${command[@]}"
+  tmuxifier-tmux new-window -t "$session:" "${winarg[@]}" "${command[@]}"
   __go_to_window_or_session_path
 }
 
@@ -29,7 +34,7 @@ new_window() {
 #
 split_v() {
   if [ -n "$1" ]; then local percentage=(-p "$1"); fi
-  tmux split-window -t "$session:$window.$2" -v "${percentage[@]}"
+  tmuxifier-tmux split-window -t "$session:$window.$2" -v "${percentage[@]}"
   __go_to_window_or_session_path
 }
 
@@ -41,17 +46,49 @@ split_v() {
 #
 split_h() {
   if [ -n "$1" ]; then local percentage=(-p "$1"); fi
-  tmux split-window -t "$session:$window.$2" -h "${percentage[@]}"
+  tmuxifier-tmux split-window -t "$session:$window.$2" -h "${percentage[@]}"
   __go_to_window_or_session_path
 }
 
+# Split current window/pane vertically by line count.
+#
+# Arguments:
+#   - $1: (optional) Number of lines the new pane will use.
+#   - $2: (optional) Target pane ID to split in current window.
+#
+split_vl() {
+  if [ -n "$1" ]; then local count=(-l "$1"); fi
+  tmuxifier-tmux split-window -t "$session:$window.$2" -v "${count[@]}"
+  __go_to_window_or_session_path
+}
+
+# Split current window/pane horizontally by column count.
+#
+# Arguments:
+#   - $1: (optional) Number of columns the new pane will use.
+#   - $2: (optional) Target pane ID to split in current window.
+#
+split_hl() {
+  if [ -n "$1" ]; then local count=(-l "$1"); fi
+  tmuxifier-tmux split-window -t "$session:$window.$2" -h "${count[@]}"
+  __go_to_window_or_session_path
+}
+
+# Run clock mode.
+#
+# Arguments:
+#   - $1: (optional) Target pane ID in which to run
+clock() {
+  tmuxifier-tmux clock-mode -t "$session:$window.$1"
+}
+
 # Select a specific window.
 #
 # Arguments:
 #   - $1: Window ID or name to select.
 #
 select_window() {
-  tmux select-window -t "$session:$1"
+  tmuxifier-tmux select-window -t "$session:$1"
 }
 
 # Select a specific pane in the current window.
@@ -60,7 +97,7 @@ select_window() {
 #   - $1: Pane ID to select.
 #
 select_pane() {
-  tmux select-pane -t "$session:$window.$1"
+  tmuxifier-tmux select-pane -t "$session:$window.$1"
 }
 
 # Send/paste keys to the currently active pane/window.
@@ -70,7 +107,7 @@ select_pane() {
 #   - $2: (optional) Target pane ID to send input to.
 #
 send_keys() {
-  tmux send-keys -t "$session:$window.$2" "$1"
+  tmuxifier-tmux send-keys -t "$session:$window.$2" "$1"
 }
 
 # Runs a shell command in the currently active pane/window.
@@ -111,12 +148,22 @@ window_root() {
 # Load specified window layout.
 #
 # Arguments:
-#   - $1: Name of window layout to load.
+#   - $1: Name of or file path to window layout to load.
+#   - $2: (optional) Override default window name.
 #
 load_window() {
-  local file="$TMUXIFIER_LAYOUT_PATH/$1.window.sh"
+  local file="$1"
+  if [ ! -f "$file" ]; then
+    file="$TMUXIFIER_LAYOUT_PATH/$1.window.sh"
+  fi
+
   if [ -f "$file" ]; then
-    window="$1"
+    if [ $# -gt 1 ]; then
+      window="$2"
+    else
+      window="${1/%.window.sh}"
+      window="${window/%.sh}"
+    fi
     source "$file"
     window=
 
@@ -125,19 +172,31 @@ load_window() {
       window_root "$session_root"
     fi
   else
-    echo "No such window layout found '$1' in '$TMUXIFIER_LAYOUT_PATH'."
+    echo "\"$1\" window layout not found." >&2
+    return 1
   fi
 }
 
 # Load specified session layout.
 #
 # Arguments:
-#   - $1: Name of session layout to load.
+#   - $1: Name of or file path to session layout to load.
+#   - $2: (optional) Override default window name.
 #
 load_session() {
-  local file="$TMUXIFIER_LAYOUT_PATH/$1.session.sh"
+  local file="$1"
+  if [ ! -f "$file" ]; then
+    file="$TMUXIFIER_LAYOUT_PATH/$1.session.sh"
+  fi
+
   if [ -f "$file" ]; then
-    session="$1"
+    if [ $# -gt 1 ]; then
+      session="$2"
+    else
+      session="${1/%.session.sh}"
+      session="${session/%.sh}"
+    fi
+
     set_default_path=true
     source "$file"
     session=
@@ -147,7 +206,8 @@ load_session() {
       session_root="$HOME"
     fi
   else
-    echo "No such session layout found '$1' in '$TMUXIFIER_LAYOUT_PATH'."
+    echo "\"$1\" session layout not found." >&2
+    return 1
   fi
 }
 
@@ -169,25 +229,37 @@ initialize_session() {
   fi
 
   # Ensure tmux server is running for has-session check.
-  tmux start-server
+  tmuxifier-tmux start-server
 
   # Check if the named session already exists.
-  if ! tmux has-session -t "$session:" 2>/dev/null; then
-    # Create the new session.
-    env TMUX="" tmux new-session -d -s "$session"
+  if ! tmuxifier-tmux has-session -t "$session:" 2>/dev/null; then
+    if [ "$(tmuxifier-tmux-version "1.9")" == "<" ]; then
+      # Tmux 1.8 and earlier.
 
-    # Set default-path for session
-    if [ -n "$session_root" ] && [ -d "$session_root" ]; then
-      cd "$session_root"
+      # Create the new session.
+      env TMUX="" tmuxifier-tmux new-session -d -s "$session"
 
-      $set_default_path && tmux set-option -t "$session:" default-path "$session_root" 1>/dev/null
+      # Set default-path for session
+      if [ -n "$session_root" ] && [ -d "$session_root" ]; then
+        cd "$session_root"
+
+        $set_default_path && tmuxifier-tmux \
+          set-option -t "$session:" \
+          default-path "$session_root" 1>/dev/null
+      fi
+    else
+      # Tmux 1.9 and later.
+      if $set_default_path; then local session_args=(-c "$session_root"); fi
+      env TMUX="" tmuxifier-tmux new-session \
+        -d -s "$session" "${session_args[@]}"
     fi
 
     # In order to ensure only specified windows are created, we move the
     # default window to position 999, and later remove it with the
     # `finalize_and_go_to_session` function.
     local first_window_index=$(__get_first_window_index)
-    tmux move-window -s "$session:$first_window_index" -t "$session:999"
+    tmuxifier-tmux move-window \
+      -s "$session:$first_window_index" -t "$session:999"
 
     # Session created, return ok exit status.
     return 0
@@ -198,16 +270,16 @@ initialize_session() {
 
 # Finalize session creation and then switch to it if needed.
 #
-# When the session is created, it leaves a unused window in position #99, this
-# is the default window which was created with the session, but it's also a
-# window that was not explicitly created. Hence we kill it.
+# When the session is created, it leaves a unused window in position #999,
+# this is the default window which was created with the session, but it's also
+# a window that was not explicitly created. Hence we kill it.
 #
 # If the session was created, we've already been switched to it. If it was not
 # created, the session already exists, and we'll need to specifically switch
 # to it here.
 #
 finalize_and_go_to_session() {
-  ! tmux kill-window -t "$session:999" 2>/dev/null
+  ! tmuxifier-tmux kill-window -t "$session:999" 2>/dev/null
   if [[ "$(tmuxifier-current-session)" != "$session" ]]; then
     __go_to_session
   fi
@@ -230,8 +302,9 @@ __expand_path() {
 }
 
 __get_first_window_index() {
-  local index
-  index=$(tmux list-windows -t "$session:" -F "#{window_index}" 2>/dev/null)
+  local index=$(tmuxifier-tmux list-windows -t "$session:" \
+    -F "#{window_index}" 2>/dev/null)
+
   if [ -n "$index" ]; then
     echo "$index" | head -1
   else
@@ -241,9 +314,9 @@ __get_first_window_index() {
 
 __go_to_session() {
   if [ -z "$TMUX" ]; then
-    tmux -u attach-session -t "$session:"
+    tmuxifier-tmux -u attach-session -t "$session:"
   else
-    tmux -u switch-client -t "$session:"
+    tmuxifier-tmux -u switch-client -t "$session:"
   fi
 }
 
@@ -251,6 +324,6 @@ __go_to_window_or_session_path() {
   local window_or_session_root=${window_root-$session_root}
   if [ -n "$window_or_session_root" ]; then
     run_cmd "cd \"$window_or_session_root\""
-    send_keys "C-l"
+    run_cmd "clear"
   fi
 }

libexec/tmuxifier-current-session

@@ -14,7 +14,7 @@ Outputs the name of the current Tmux session."
 fi
 
 if [ -n "$TMUX" ]; then
-  for item in $(tmux list-pane -F "#{session_name}");do
+  for item in $(tmuxifier-tmux list-pane -F "#{session_name}");do
     echo $item
     exit 0
   done

libexec/tmuxifier-help

@@ -35,7 +35,7 @@ Some useful tmuxifier commands are:
    new-window     nw       Create new window layout and open it with \$EDITOR.
    edit-session   es       Edit specified session layout with \$EDITOR.
    edit-window    ew       Edit specified window layout with \$EDITOR.
-   commands                List all tmuxifier commands.
+   commands                List all tmuxifier commands (including internal).
    version                 Print Tmuxifier version.
    help                    Show this message.
 

libexec/tmuxifier-init

@@ -4,7 +4,7 @@ set -e
 
 # Set shell to first argument that is not "-", "-h" or "--help".
 for arg in "$@"; do
-  if [ "$arg" != "-" ] &&[ "$arg" != "-h" ] && [ "$arg" != "--help" ]; then
+  if [ "$arg" != "-" ] && [ "$arg" != "-h" ] && [ "$arg" != "--help" ]; then
     shell="$arg"
   fi
 done
@@ -29,6 +29,9 @@ case "$shell" in
   tcsh )
     profile='~/.tcshrc'
     ;;
+  fish )
+    profile='~/.config/fish/config.fish'
+    ;;
   * )
     profile='shell init file'
     ;;
@@ -44,6 +47,10 @@ Load Tmuxifier by adding the following to your ${profile}:
   case "$shell" in
     csh | tcsh )
       echo "    eval \`tmuxifier init -\`
+"
+      ;;
+    fish )
+      echo "    eval (tmuxifier init -)
 "
       ;;
     * )
@@ -67,6 +74,10 @@ case "$shell" in
     echo "setenv TMUXIFIER \"$TMUXIFIER\";"
     echo "source \"\$TMUXIFIER/init.tcsh\";"
     ;;
+  fish )
+    echo "set -gx TMUXIFIER \"$TMUXIFIER\";"
+    echo "source \"\$TMUXIFIER/init.fish\";"
+    ;;
   * )
     echo "export TMUXIFIER=\"$TMUXIFIER\";"
     echo "source \"\$TMUXIFIER/init.sh\";"

libexec/tmuxifier-load-session

@@ -7,7 +7,7 @@ source "$TMUXIFIER/lib/util.sh"
 
 # Provide tmuxifier help
 if calling-help "$@"; then
-  echo "usage: tmuxifier load-session <layout_name>
+  echo "usage: tmuxifier load-session <layout_name | file_path>
 
 Aliases: session, ses, s
 

libexec/tmuxifier-load-window

@@ -7,7 +7,7 @@ source "$TMUXIFIER/lib/util.sh"
 
 # Provide tmuxifier help
 if calling-help "$@"; then
-  echo "usage: tmuxifier load-window <layout_name>
+  echo "usage: tmuxifier load-window <layout_name | file_path>
 
 Aliases: window, win, w
 

libexec/tmuxifier-tmux

@@ -0,0 +1,17 @@
+#! /usr/bin/env bash
+set -e
+[ -n "$TMUXIFIER_DEBUG" ] && set -x
+
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
+# Provide tmuxifier help
+if [[ " $@ " == *" --help "* ]]; then
+  echo "usage: tmuxifier tmux [...]
+
+Wrapper command for Tmux executable allowing Tmuxifier to pass in any custom
+arguments specified in the TMUXIFIER_TMUX_OPTS environment variable."
+  exit
+fi
+
+tmux $TMUXIFIER_TMUX_OPTS "$@"

libexec/tmuxifier-tmux-version

@@ -0,0 +1,60 @@
+#! /usr/bin/env bash
+shopt -s extglob
+[ -n "$TMUXIFIER_DEBUG" ] && set -x
+
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
+# Provide tmuxifier help
+if calling-help "$@"; then
+  echo "usage: tmuxifier tmux-version [target-version]
+
+Outputs current Tmux version. If given optional target-version it outputs one
+of three possible characters indicating if the current Tmux version number is
+equal to, less than, or greater than the [target-version].
+
+The three possible outputs are \"=\", \"<\", and \">\"."
+  exit
+fi
+
+# The vercomp() function is shamelessly ripped/borrowed from the following
+# StackOverflow answer: http://stackoverflow.com/a/4025065/42146
+vercomp () {
+  if [[ $1 == $2 ]]; then return 0; fi
+
+  local IFS=.
+  local i ver1=($1) ver2=($2)
+
+  # fill empty fields in ver1 with zeros
+  for ((i=${#ver1[@]}; i<${#ver2[@]}; i++)); do ver1[i]=0; done
+
+  for ((i=0; i<${#ver1[@]}; i++)); do
+    # fill empty fields in ver2 with zeros
+    if [[ -z ${ver2[i]} ]]; then ver2[i]=0; fi
+
+    if ((10#${ver1[i]} > 10#${ver2[i]})); then
+      return 1
+    elif ((10#${ver1[i]} < 10#${ver2[i]})); then
+      return 2
+    fi
+  done
+  return 0
+}
+
+version=$(tmux -V)
+version=${version/tmux /}
+
+if [ -n "$1" ]; then
+  # Fix for "1.9a" version comparison, as vercomp() can only deal with
+  # purely numeric version numbers.
+  version=${version//+([a-zA-Z])/}
+
+  vercomp "$version" "$1"
+  case $? in
+    0) echo '=';;
+    1) echo '>';;
+    2) echo '<';;
+  esac
+else
+  echo "$version"
+fi

libexec/tmuxifier-version

@@ -13,4 +13,4 @@ Outputs Tmuxifier version."
   exit
 fi
 
-echo "0.7.1"
+echo "0.11.3"

templates/window.sh

@@ -16,7 +16,7 @@ new_window "{{WINDOW_NAME}}"
 
 # Paste text
 #send_keys "top"    # paste into active pane
-#send_keys "date" 1 # paste into active pane
+#send_keys "date" 1 # paste into pane 1
 
 # Set active pane.
 #select_pane 0