#compdef adb # ------------------------------------------------------------------------------ # Copyright (c) 2011 zsh-users # All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met: # * Redistributions of source code must retain the above copyright # notice, this list of conditions and the following disclaimer. # * Redistributions in binary form must reproduce the above copyright # notice, this list of conditions and the following disclaimer in the # documentation and/or other materials provided with the distribution. # * Neither the name of the zsh-users nor the # names of its contributors may be used to endorse or promote products # derived from this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE # DISCLAIMED. IN NO EVENT SHALL ZSH-USERS BE LIABLE FOR ANY # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # ------------------------------------------------------------------------------ # Description # ----------- # # Completion script for adb # (http://developer.android.com/guide/developing/tools/adb.html). # # Status: Incomplete, see FIXMEs and TODOs. # # ------------------------------------------------------------------------------ # Authors # ------- # # * Julien Nicoulaud # # ------------------------------------------------------------------------------ # -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*- # vim: ft=zsh sw=2 ts=2 et # ------------------------------------------------------------------------------ typeset -A opt_args local context state line curcontext="$curcontext" _adb() { local ret=1 _arguments -C \ '(-e -s)-d[directs command to the only connected USB device, returns an error if more than one USB device is present]' \ '(-d -s)-e[directs command to the only running emulator, returns an error if more than one emulator is running]' \ '(-d -e)-s[directs command to the USB device or emulator with the given serial number. Overrides ANDROID_SERIAL environment variable]:serial number' \ '-p[simple product name or a relative/absolute path to a product out directory. Overrides ANDROID_PRODUCT_OUT environment variable]:product name or path' \ '1: :_adb_cmds' \ '*::arg:->args' \ && ret=0 case $state in (args) curcontext="${curcontext%:*:*}:adb-cmd-$words[1]:" case $words[1] in (help|version|devices|jdwp|bugreport|wait-for-device|start-server|kill-server|get-state|get-serialno|status-window|remount|reboot-bootloader|root|usb) _message 'no more arguments' && ret=0 ;; (connect|disconnect) _arguments \ '1: :_adb_host_colon_ports' \ && ret=0 ;; (push) _arguments \ '1:local directory:_files -/' \ '2: :_adb_remote_directories' \ && ret=0 ;; (pull) _arguments \ '1: :_adb_remote_directories' \ '2:local directory:_files -/' \ && ret=0 ;; (sync) _arguments \ '-l[list but do not copy]' \ '1: :_adb_sync_directories' \ && ret=0 ;; (shell|emu) _arguments \ '1: :_adb_remote_commands' \ && ret=0 ;; (logcat) local -a rotation_opts [[ -n ${(M)words:#"-f"} ]] && rotation_opts+=('-r[rotates the log file every kbytes of output. The default value is 16]:value (in kb)') [[ -n ${(M)words:#"-r"} ]] && rotation_opts+=('-n[sets the maximum number of rotated logs. The default value is 4]:count') _arguments \ '-b[loads an alternate log buffer for viewing, such as event or radio. The main buffer is used by default]: :_adb_logcat_buffers' \ '-c[clears (flushes) the entire log and exits]' \ '-d[dumps the log to the screen and exits]' \ '-f[writes log message output to file. The default is stdout]: :_files' \ '-g[prints the size of the specified log buffer and exits]' \ '-s[sets the default filter spec to silent]' \ '-v[sets the output format for log messages]: :_adb_logcat_output_formats' \ "${rotation_opts[@]}" \ '*: :_adb_logcat_filter_specs' \ && ret=0 ;; (forward) _arguments \ '1: :_adb_local_forward_specs' \ '2: :_adb_remote_forward_specs' \ && ret=0 ;; (install) _arguments \ '-l[forward-lock the app]' \ '-r[reinstall the app, keeping its data]' \ '-s[install on SD card instead of internal storage]' \ '1: :_files' \ && ret=0 ;; (uninstall) # TODO Somehow complete package names ? _arguments \ '-k[keep the data and cache directories]' \ '1::package' \ && ret=0 ;; (reboot) _arguments \ '1:program:((bootloader:reboot\ into\ the\ bootloader\ program recovery:reboot\ into\ the\ recovery\ program))' \ && ret=0 ;; (tcpip) _arguments \ '1::port' \ && ret=0 ;; (ppp) # TODO Complete tty ? # TODO Complete parameters ? _arguments \ '1::tty' \ '*::parameters' \ && ret=0 ;; esac ;; esac return ret } (( $+functions[_adb_cmds] )) || _adb_cmds() { _alternative \ 'general-commands:general command:_adb_general_cmds' \ 'device-commands:device command:_adb_device_cmds' \ 'scripting-commands:scripting command:_adb_scripting_cmds' } (( $+functions[_adb_general_cmds] )) || _adb_general_cmds() { local commands; commands=( 'help:show help message' 'version:show version number' 'devices:list all connected devices' 'connect:connect to a device via TCP/IP' 'disconnect:disconnect from a TCP/IP device' ) _describe -t general-commands 'general command' commands "$@" } (( $+functions[_adb_device_cmds] )) || _adb_device_cmds() { local commands; commands=( 'push:copy file/dir to device' 'pull:copy file/dir from device' 'sync:copy host->device only if changed' 'shell:run remote shell interactively or command' 'shell:run remote shell command' 'emu:run emulator console command' 'logcat:view device log' 'forward:forward socket connections' 'jdwp:list PIDs of processes hosting a JDWP transport' 'install:push this padbage file to the device and install it' 'uninstall:remove this app padbage from the device' 'bugreport:return all information from the device' ) _describe -t device-commands 'device command' commands "$@" } (( $+functions[_adb_scripting_cmds] )) || _adb_scripting_cmds() { local commands; commands=( 'wait-for-device:block until device is online' 'start-server:ensure that there is a server running' 'kill-server:kill the server if it is running' 'get-state:prints\: offline | bootloader | device' 'get-serialno:prints\: ' 'status-window:continuously print device status for a specified device' 'remount:remounts the /system partition on the device read-write' 'reboot:reboots the device, optionally into the bootloader or recovery program' 'reboot-bootloader:reboots the device into the bootloader' 'root:restarts the adbd daemon with root permissions' 'usb:restarts the adbd daemon listening on USB' 'tcpip:restarts the adbd daemon listening on TCP on the specified port' 'ppp:run PPP over USB' ) _describe -t scripting-commands 'scripting command' commands "$@" } (( $+functions[_adb_host_colon_ports] )) || _adb_host_colon_ports() { local ret=1 if compset -P '*:'; then _message -e ports 'port' && ret=0 else _wanted hosts expl 'host' _hosts -qS: && ret=0 fi return ret } (( $+functions[_adb_remote_directories] )) || _adb_remote_directories() { # TODO Not implemented _message 'remote directory' } (( $+functions[_adb_remote_commands] )) || _adb_remote_commands() { # TODO Not implemented # Doc here: http://developer.android.com/guide/developing/tools/adb.html#shellcommands _message 'remote command' } (( $+functions[_adb_local_forward_specs] )) || _adb_local_forward_specs() { # TODO Not implemented # Doc here: http://developer.android.com/guide/developing/tools/adb.html#forwardports + adb help _message 'local forward spec' } (( $+functions[_adb_remote_forward_specs] )) || _adb_remote_forward_specs() { # TODO Not implemented # Doc here: http://developer.android.com/guide/developing/tools/adb.html#forwardports + adb help _message 'remote forward spec' } (( $+functions[_adb_sync_directories] )) || _adb_sync_directories() { _alternative \ 'partitions:partition:((system:the\ /system\ partition data:the\ /data\ partition))' \ 'directories:directory:_adb_remote_directories' } (( $+functions[_adb_logcat_filter_specs] )) || _adb_logcat_filter_specs() { local ret=1 if compset -P '*:'; then local priorities; priorities=( 'V:verbose (lowest priority)' 'D:debug' 'I:info' 'W:warning' 'E:error' 'F:fatal' 'S:silent (highest priority, on which nothing is ever printed)' ) _describe -t log-priorities 'log priority' priorities "$@" && ret=0 else _message -e log-tags 'log tag' && ret=0 fi return ret } (( $+functions[_adb_logcat_output_formats] )) || _adb_logcat_output_formats() { local formats; formats=( 'brief:display priority/tag and PID of originating process (the default format)' 'process:display PID only' 'tag:display the priority/tag only' 'thread:display process:thread and priority/tag only' 'raw:display the raw log message, with no other metadata fields' 'time:display the date, invocation time, priority/tag, and PID of the originating process' 'long:display all metadata fields and separate messages with a blank lines' ) _describe -t log-formats 'log format' formats "$@" && ret=0 } (( $+functions[_adb_logcat_buffers] )) || _adb_logcat_buffers() { local buffers; buffers=( 'main:view the main log buffer (default)' 'radio:view the buffer that contains radio/telephony related messages' 'events:view the buffer containing events-related messages' ) _describe -t log-buffers 'log buffer' buffers "$@" && ret=0 } _adb "$@"