Bump version to 0.5.0

This means that "init" session layouts can now be used to start and/or
re-attach to your main session.

Personally I have a "main" session layout with a couple of default
windows. I can now either start that session, or re-attach to it from
outside of Tmux by just running `tmuxifier s main`, instead of manually
creating a session named "main" and then loading my windows into it.

README.md

@@ -33,9 +33,10 @@ looks like:
 ```bash
 window_root "~/Desktop"
 new_window "Example Window"
-tmux split-window -t "$session:$window.0" -v -p 20 "watch -t date"
-tmux split-window -t "$session:$window.1" -h -p 60
-tmux select-pane -t "$session:$window.0"
+split_v 20
+run_cmd "watch -t date"
+split_h 60
+select_pane 0
 ```
 
 You can then load that window layout into a new window in the
@@ -51,21 +52,36 @@ Which will yield a Tmux window looking like this:
 
 ## Installation
 
+Clone the repo to your machine:
+
 ```bash
 git clone https://github.com/jimeh/tmuxifier.git ~/.tmuxifier
 ```
 
-And add the following to your `~/.profile`, `~/.bash_profile` or equivalent:
+### bash & zsh
+
+And add the following to your `~/.profile`, `~/.bash_profile`, `~/.zshrc` or
+equivalent:
 
 ```bash
 [[ -s "$HOME/.tmuxifier/init.sh" ]] && source "$HOME/.tmuxifier/init.sh"
 ```
 
+### tcsh
+
+Add the following to your `~/.cshrc`, `~/.tcshrc` or equivalent:
+
+```tcsh
+if ( -s "$HOME/.tmuxifier/init.sh" ) then
+  source "$HOME/.tmuxifier/init.sh"
+endif
+```
+
 ## Usage
 
 *__Note:__ This section needs expanding upon.*
 
-For a quick reference on available commands, please run:
+For a quick reference on available commands and their aliases, please run:
 
     tmuxifier help
 
@@ -74,6 +90,41 @@ window and session layout files. New layout files are populated with examples
 and comments explaining what things do. Also, having a look at the
 [examples][] directory will also give you a good idea.
 
+### Window Layouts
+
+First off you'll want to define a window layout:
+
+    tmuxifier new-window my-awesome-window
+
+This will create a new layout file called `my-awesome-window.window.sh` in
+your `$TMUXIFIER_LAYOUT_PATH`, and open it with the editor defined in
+`$EDITOR`. Customize it as you wish, and save.
+
+You can now load *my-awesome-window* with the following command:
+
+    tmuxifier load-window my-awesome-window
+
+You should now have a new Tmux window open created from your custom and
+awesome window layout.
+
+### Session Layouts
+
+To create your first session layout, run:
+
+    tmuxifier new-session my-awesome-session
+
+Same deal as with creating a new window, except the filename ends with
+`.session.sh` instead of `.window.sh`, and the file's pre-populated content
+looks different. To have your awesome window loaded, add `load_window
+"my-awesome-window"` to the session layout next to existing examples.
+
+To load the session layout simply run:
+
+    tmuxifier load-session my-awesome-session
+
+You'll now have a new Tmux session with your previously defined awesome window
+in it.
+
 [examples]: https://github.com/jimeh/tmuxifier/tree/master/examples
 
 ## Configure & Customize
@@ -81,8 +132,8 @@ and comments explaining what things do. Also, having a look at the
 ### Custom Installaton Path
 
 To install Tmuxifier to a custom path, clone the repository to your desired
-path and set `$TMUXIFIER` to that path, additionally loading `init.sh` from
-that same path.
+path and set `$TMUXIFIER` to that path, additionally loading `init.sh` or
+`init.tcsh` from that same path.
 
 ```bash
 export TMUXIFIER="$HOME/.dotfiles/tmuxifier"
@@ -168,4 +219,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

bin/tmuxifier

@@ -24,15 +24,7 @@ case "$command" in
     ;;
 
   * )
-    command_path="$(command -v "tmuxifier-$command" || true)"
-
-    # Attempt to resolve aliases
-    if [ -z "$command_path" ]; then
-      resolved="$(tmuxifier-alias "$command")"
-      if [ ! -z "$resolved" ]; then
-        command_path="$(command -v "tmuxifier-$resolved" || true)"
-      fi
-    fi
+    ! command_path="$(tmuxifier-resolve-command-path "$command")"
 
     if [ -z "$command_path" ]; then
       echo "tmuxifier: no such command '$command'" >&2

completion/tmuxifier.tcsh

@@ -0,0 +1,2 @@
+complete tmuxifier 'p@1@`tmuxifier commands`@' \
+                   'p@2@`tmuxifier completions $:-1`@'

examples/example.window.sh

@@ -7,8 +7,9 @@ window_root "~/Desktop"
 new_window "Example Window"
 
 # Split window into panes.
-tmux split-window -t "$session:$window.0" -v -p 20 "watch -t date"
-tmux split-window -t "$session:$window.1" -h -p 60
+split_v 20
+run_cmd "watch -t date"
+split_h 60
 
 # Set active pane.
-tmux select-pane -t "$session:$window.0"
+select_pane 0

init.sh

@@ -10,7 +10,7 @@ export PATH="$TMUXIFIER/bin:$PATH"
 
 # If `tmuxifier` is available, and `$TMUXIFIER_NO_COMPLETE` is not set, then
 # load tmuxifier shell completion.
-if [ ! -z $(command -v "tmuxifier") ] && [ -z "$TMUXIFIER_NO_COMPLETE" ]; then
+if [ -n "$(command -v "tmuxifier")" ] && [ -z "$TMUXIFIER_NO_COMPLETE" ]; then
   if [ -n "$BASH_VERSION" ]; then
     source "$TMUXIFIER/completion/tmuxifier.bash"
   elif [ -n "$ZSH_VERSION" ]; then

init.tcsh

@@ -0,0 +1,13 @@
+# Set tmuxifier root path.
+if ( ! $?TMUXIFIER ) then
+  setenv TMUXIFIER "${HOME}/.tmuxifier"
+endif
+
+# Add `bin` directroy to `$PATH`.
+set path = ( $TMUXIFIER/bin $path )
+
+# If `tmuxifier` is available, and `$TMUXIFIER_NO_COMPLETE` is not set, then
+# load tmuxifier shell completion.
+if ( ! $?TMUXIFIER_NO_COMPLETE ) then
+  which tmuxifier > /dev/null && source "$TMUXIFIER/completion/tmuxifier.tcsh"
+endif

lib/layout-helpers.sh

@@ -13,16 +13,36 @@
 #   - $2: (optional) Shell command to execute when window is created.
 #
 new_window() {
-  if [ ! -z "$1" ]; then
-    window="$1"
-  fi
-  if [ ! -z "$2" ]; then
-    local command="\"$2\""
-  fi
-  if [ ! -z "$window" ]; then
-    local winarg="-n \"$window\""
-  fi
-  eval "tmux new-window -t \"$session:\" $winarg $command"
+  if [ -n "$1" ]; then window="$1"; fi
+  if [ -n "$2" ]; then local command=("$2"); fi
+  if [ -n "$window" ]; then local winarg=(-n "$window"); fi
+
+  tmux new-window -t "$session:" "${winarg[@]}" "${command[@]}"
+  __go_to_window_or_session_path
+}
+
+# Split current window/pane vertically.
+#
+# Arguments:
+#   - $1: (optional) Percentage of frame the new pane will use.
+#   - $2: (optional) Target pane ID to split in current window.
+#
+split_v() {
+  if [ -n "$1" ]; then local percentage=(-p "$1"); fi
+  tmux split-window -t "$session:$window.$2" -v "${percentage[@]}"
+  __go_to_window_or_session_path
+}
+
+# Split current window/pane horizontally.
+#
+# Arguments:
+#   - $1: (optional) Percentage of frame the new pane will use.
+#   - $2: (optional) Target pane ID to split in current window.
+#
+split_h() {
+  if [ -n "$1" ]; then local percentage=(-p "$1"); fi
+  tmux split-window -t "$session:$window.$2" -h "${percentage[@]}"
+  __go_to_window_or_session_path
 }
 
 # Select a specific window.
@@ -34,6 +54,60 @@ select_window() {
   tmux select-window -t "$session:$1"
 }
 
+# Select a specific pane in the current window.
+#
+# Arguments:
+#   - $1: Pane ID to select.
+#
+select_pane() {
+  tmux select-pane -t "$session:$window.$1"
+}
+
+# Send/paste keys to the currently active pane/window.
+#
+# Arguments:
+#   - $1: String to paste.
+#   - $2: (optional) Target pane ID to send input to.
+#
+send_keys() {
+  tmux send-keys -t "$session:$window.$2" "$1"
+}
+
+# Runs a shell command in the currently active pane/window.
+#
+# Arguments:
+#   - $1: Shell command to run.
+#   - $2: (optional) Target pane ID to run command in.
+#
+run_cmd() {
+  send_keys "$1" "$2"
+  send_keys "C-m" "$2"
+}
+
+# Cusomize session root path. Default is `$HOME`.
+#
+# Arguments:
+#   - $1: Directory path to use for session root.
+#
+session_root() {
+  local dir="$(__expand_path $@)"
+  if [ -d "$dir" ]; then
+    session_root="$dir"
+  fi
+}
+
+# Customize window root path. Default is `$session_root`.
+#
+# Arguments:
+#   - $1: Directory path to use for window root.
+#
+window_root() {
+  local dir="$(__expand_path $@)"
+  if [ -d "$dir" ]; then
+    window_root="$dir"
+  fi
+}
+
 # Load specified window layout.
 #
 # Arguments:
@@ -44,7 +118,7 @@ load_window() {
   if [ -f "$file" ]; then
     window="$1"
     source "$file"
-    window=""
+    window=
 
     # Reset `$window_root`.
     if [[ "$window_root" != "$session_root" ]]; then
@@ -76,30 +150,6 @@ load_session() {
   fi
 }
 
-# Cusomize session root path. Default is `$HOME`.
-#
-# Arguments:
-#   - $1: Directory path to use for session root.
-#
-session_root() {
-  local dir="$(__expand_path $@)"
-  if [ -d "$dir" ]; then
-    session_root="$dir"
-  fi
-}
-
-# Customize window root path. Default is `$session_root`.
-#
-# Arguments:
-#   - $1: Directory path to use for window root.
-#
-window_root() {
-  local dir="$(__expand_path $@)"
-  if [ -d "$dir" ]; then
-    cd "$dir"
-  fi
-}
-
 # Create a new session, returning 0 on success, 1 on failure.
 #
 # Arguments:
@@ -113,7 +163,7 @@ window_root() {
 #   fi
 #
 initialize_session() {
-  if [ ! -z "$1" ]; then
+  if [ -n "$1" ]; then
     session="$1"
   fi
 
@@ -121,23 +171,21 @@ initialize_session() {
   tmux start-server
 
   # Check if the named session already exists.
-  if ! tmux has-session -t "$session" 2>/dev/null; then
+  if ! tmux has-session -t "$session:" 2>/dev/null; then
     # Create the new session.
-    env TMUX= tmux new-session -d -s "$session"
+    env TMUX="" tmux new-session -d -s "$session"
 
     # Set default-path for session
-    if [ ! -z "$session_root" ] && [ -d "$session_root" ]; then
+    if [ -n "$session_root" ] && [ -d "$session_root" ]; then
       cd "$session_root"
-      tmux set-option -t "$session" default-path "$session_root" 1>/dev/null
+      tmux set-option -t "$session:" default-path "$session_root" 1>/dev/null
     fi
 
     # In order to ensure only specified windows are created, we move the
-    # default window to position 99, and later remove it with the
-    # `finalize_session` function.
-    tmux move-window -s "$session:0" -t "$session:99"
-
-    # Ensure correct pane splitting.
-    __go_to_session
+    # 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"
 
     # Session created, return ok exit status.
     return 0
@@ -155,9 +203,52 @@ initialize_session() {
 # 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:99" 2>/dev/null || true
+  ! tmux kill-window -t "$session:999" 2>/dev/null
   if [[ "$(tmuxifier-current-session)" != "$session" ]]; then
     __go_to_session
   fi
 }
+
+
+#
+# Internal functions
+#
+
+# Expands given path.
+#
+# Example:
+#
+#   $ __expand_path "~/Projects"
+#   /Users/jimeh/Projects
+#
+__expand_path() {
+  echo $(eval echo "$@")
+}
+
+__get_first_window_index() {
+  local index
+  index=$(tmux list-windows -t "$session:" -F "#{window_index}" 2>/dev/null)
+  if [ -n "$index" ]; then
+    echo "$index" | head -1
+  else
+    echo "0"
+  fi
+}
+
+__go_to_session() {
+  if [ -z "$TMUX" ]; then
+    tmux -u attach-session -t "$session:"
+  else
+    tmux -u switch-client -t "$session:"
+  fi
+}
+
+__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"
+  fi
+}

libexec/tmuxifier-alias

@@ -30,4 +30,6 @@ case "$1" in
   "list-win" | "lsw" )
     echo "list-windows"
     ;;
+  * )
+    exit 1
 esac

libexec/tmuxifier-commands

@@ -7,7 +7,7 @@ shopt -s nullglob
 { for path in ${PATH//:/$'\n'}; do
     for command in "${path}/tmuxifier-"*; do
       command="${command##*tmuxifier-}"
-      echo ${command##sh-}
+      echo "$command"
     done
   done
 } | sort | uniq

libexec/tmuxifier-completions

@@ -18,17 +18,9 @@ if [ -z "$command" ]; then
   exit 1
 fi
 
-command_path="$(command -v "tmuxifier-$command" || true)"
+! command_path="$(tmuxifier-resolve-command-path "$command")"
 
-# Attempt to resolve aliases
-if [ -z "$command_path" ]; then
-  resolved="$(tmuxifier-alias "$command")"
-  if [ ! -z "$resolved" ]; then
-    command_path="$(command -v "tmuxifier-$resolved" || true)"
-  fi
-fi
-
-if [ ! -z "$command_path" ] && has-completions "$command_path"; then
+if [ -n "$command_path" ] && has-completions "$command_path"; then
   shift
   exec "$command_path" --complete "$@"
 fi

libexec/tmuxifier-current-session

@@ -2,12 +2,10 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
-if [ ! -z $TMUX ]; then
-  for item in $(tmux list-sessions -F "#{?session_attached,1,0}:#S"); do
-    if [[ "$item" == "1:"* ]]; then
-      echo ${item/1:/}
-      exit 0
-    fi
+if [ -n "$TMUX" ]; then
+  for item in $(tmux list-pane -F "#{session_name}");do
+    echo $item
+    exit 0
   done
 fi
 

libexec/tmuxifier-edit-session

@@ -22,7 +22,7 @@ if [ ! -f "$layout_file" ]; then
   echo "tmuxifier: session layout '$layout_name' does not exist." >&2
   echo "" >&2
   echo "You can create it with:" >&2
-  echo "  tmuxifier new-session $layout_name" >&2
+  echo "  tmuxifier new-session '$layout_name'" >&2
   exit 1
 fi
 

libexec/tmuxifier-edit-window

@@ -22,7 +22,7 @@ if [ ! -f "$layout_file" ]; then
   echo "tmuxifier: window layout '$layout_name' does not exist." >&2
   echo "" >&2
   echo "You can create it with:" >&2
-  echo "  tmuxifier new-window $layout_name" >&2
+  echo "  tmuxifier new-window '$layout_name'" >&2
   exit 1
 fi
 

libexec/tmuxifier-help

@@ -9,14 +9,12 @@ if [ "$1" == "--complete" ]; then
 fi
 
 command="$1"
-command_path="$(command -v "tmuxifier-$command" || true)"
 
-# Attempt to resolve aliases
-if [ -z "$command_path" ]; then
-  resolved="$(tmuxifier-alias "$command")"
-  if [ ! -z "$resolved" ]; then
+# Ensure we have the correct command name in case an alias was given.
+if [ -n "$command" ]; then
+  ! resolved="$(tmuxifier-alias "$command")"
+  if [ -n "$resolved" ]; then
     command="$resolved"
-    command_path="$(command -v "tmuxifier-$command" || true)"
   fi
 fi
 
@@ -111,14 +109,16 @@ Aliases: list-win, lsw
 List all window layouts."
     ;;
   * )
-    if [ ! -z "$command_path" ]; then
+    ! command_path="$(tmuxifier-resolve-command-path "$command")"
+    if [ -n "$command_path" ]; then
       echo "Sorry, the '$command' command isn't documented yet."
       echo
       echo "You can view the command's source here:"
       echo "$command_path"
       echo
     else
-      echo "tmuxifier: no such command '$command'"
+      echo "tmuxifier: no such command '$command'" >&2
+      exit 1
     fi
     ;;
 esac

libexec/tmuxifier-list-sessions

@@ -2,7 +2,7 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
-list=$(find "$TMUXIFIER_LAYOUT_PATH" -name "*.session.sh")
+list=$(find -L "$TMUXIFIER_LAYOUT_PATH" -name "*.session.sh")
 for file in $list; do
   file=${file/$TMUXIFIER_LAYOUT_PATH\//}
   echo "  ${file/.session.sh/}"

libexec/tmuxifier-list-windows

@@ -2,7 +2,7 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
-list=$(find "$TMUXIFIER_LAYOUT_PATH" -name "*.window.sh")
+list=$(find -L "$TMUXIFIER_LAYOUT_PATH" -name "*.window.sh")
 for file in $list; do
   file=${file/$TMUXIFIER_LAYOUT_PATH\//}
   echo "  ${file/.window.sh/}"

libexec/tmuxifier-load-session

@@ -18,9 +18,5 @@ fi
 # Load runtime functions.
 source "$TMUXIFIER/runtime.sh"
 
-if [ ! -z $TMUX ]; then
-  load_session "$1"
-else
-  echo "tmuxifier: 'load-session' command can only be used from within Tmux."
-  exit 1
-fi
+# Load session file.
+load_session "$1"

libexec/tmuxifier-new-session

@@ -2,6 +2,14 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier completions
+if [ "$1" == "--complete" ]; then
+  for item in $(tmuxifier-list-sessions); do
+    echo "$item"
+  done
+  exit
+fi
+
 if [ -z "$1" ]; then
   echo "$(tmuxifier-help new-session)" >&2
   exit 1

libexec/tmuxifier-new-window

@@ -2,6 +2,14 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier completions
+if [ "$1" == "--complete" ]; then
+  for item in $(tmuxifier-list-windows); do
+    echo "$item"
+  done
+  exit
+fi
+
 if [ -z "$1" ]; then
   echo "$(tmuxifier-help new-window)" >&2
   exit 1

libexec/tmuxifier-resolve-command-path

@@ -0,0 +1,19 @@
+#! /usr/bin/env bash
+set -e
+[ -n "$TMUXIFIER_DEBUG" ] && set -x
+
+if [ -n "$1" ]; then
+  ! command_path="$(command -v "tmuxifier-$1")"
+  if [ -z "$command_path" ]; then
+    resolved="$(tmuxifier-alias "$1")"
+    if [ -n "$resolved" ]; then
+      ! command_path="$(command -v "tmuxifier-$resolved")"
+    fi
+  fi
+fi
+
+if [ -n "$command_path" ]; then
+  echo "$command_path"
+else
+  exit 1
+fi

libexec/tmuxifier-version

@@ -2,4 +2,4 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
-echo "0.1.0"
+echo "0.5.0"

runtime.sh

@@ -10,27 +10,3 @@ session_root="$HOME"
 
 # Load layout helper functions.
 source "$TMUXIFIER/lib/layout-helpers.sh"
-
-
-#
-# Internal functions
-#
-
-# Expands given path.
-#
-# Example:
-#
-#   $ __expand_path "~/Projects"
-#   /Users/jimeh/Projects
-#
-__expand_path() {
-  echo $(eval echo "$@")
-}
-
-__go_to_session() {
-  if [ -z $TMUX ]; then
-    tmux -u attach-session -t "$session"
-  else
-    tmux -u switch-client -t "$session"
-  fi
-}

templates/window.sh

@@ -7,7 +7,16 @@
 new_window "{{WINDOW_NAME}}"
 
 # Split window into panes.
-#tmux split-window -t "$session:$window.0" -h -p 20
+#split_v 20
+#split_h 50
+
+# Run commands.
+#run_cmd "top"     # runs in active pane
+#run_cmd "date" 1  # runs in pane 1
+
+# Paste text
+#send_keys "top"    # paste into active pane
+#send_keys "date" 1 # paste into active pane
 
 # Set active pane.
-#tmux select-pane -t "$session:$window.0"
+#select_pane 0