src/jdk.jcmd/share/conf/bash-completion/jcmd - master - githubmirror/panama-vector

src/jdk.jcmd/share/conf/bash-completion/jcmd
157 строк5 KB
Ivan Bereziuk
8357439: Add bash autocompletion for jcmd
21 май 2026, 11:42
21 май 2026, 11:428549d18
#
# Copyright (c) 2026, Oracle and/or its affiliates. All rights reserved.
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# This code is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 2 only, as
# published by the Free Software Foundation.
#
# This code is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
# version 2 for more details (a copy is included in the LICENSE file that
# accompanied this code).
#
# You should have received a copy of the GNU General Public License version
# 2 along with this work; if not, write to the Free Software Foundation,
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
# or visit www.oracle.com if you need additional information or have any
# questions.
#

# Bash completion for jcmd tool.
#
# Source this file from an interactive shell:
#   source /path/to/bash-completion/jcmd
#

# 'complete' is a Bash builtin from Programmable Completion framework
if ! builtin complete &>/dev/null; then
  return 0 2>/dev/null || exit 0
fi

function _jcmd__dedupe_words() {
  awk '!seen[$0]++'
}

# list JVM processes on the local machine, except `jcmd` itself.
# Output format: "<pid> <main-class>\n"
function _jcmd__list_processes() {
  jcmd -l 2>/dev/null | awk '
    $1 ~ /^[0-9]+$/ && $2 != "jdk.jcmd/sun.tools.jcmd.JCmd" {
      print $1, $2
    }
  '
}

# query the list of commands known by the target JVM
function _jcmd__list_commands_for_jvm() {
  local -r jvm_identifier=$1 # can also be a main class name

  jcmd "${jvm_identifier}" help 2>/dev/null | awk '
    /^The following commands are available:/ { in_block=1; next }
    /^For more information/ { in_block=0 }
    in_block && $1 != "" { print $1 }
  '
}


function _jcmd__complete_first_arg() {
  local -r cur=$1

  # include generic options as well
  local -a candidates=("-l" "--help")

  local pid main_class _rest
  while read -r pid main_class _rest; do
    candidates+=("${pid}" "${main_class}")
  done < <(_jcmd__list_processes)

  local -r wordlist=$(printf '%s\n' "${candidates[@]}" | _jcmd__dedupe_words | tr '\n' ' ')
  COMPREPLY=( $(compgen -W "${wordlist}" -- "${cur}") )
}


function _jcmd__complete_command() {
  local -r jvm_identifier=$1
  local -r cur=$2

  # include "read commands from file" -f flag
  local -a commands=("-f")

  local cmd
  while read -r cmd; do
    [[ -z $cmd ]] && continue
    commands+=("$cmd")
  done < <(_jcmd__list_commands_for_jvm "${jvm_identifier}")

  printf -v wordlist '%s ' "${commands[@]}"
  COMPREPLY=( $(compgen -W "${wordlist}" -- "${cur}") )
}


function _jcmd__complete_help_command() {
  local -r jvm_identifier=$1
  local -r cur=$2

  local -a commands=()

  local cmd
  while read -r cmd; do
    [[ -z ${cmd} || ${cmd} == help ]] && continue
    commands+=("${cmd}")
  done < <(_jcmd__list_commands_for_jvm "${jvm_identifier}")

  printf -v wordlist '%s ' "${commands[@]}"
  COMPREPLY=( $(compgen -W "${wordlist}" -- "${cur}") )
}


function _jcmd_completion() {
  COMPREPLY=()

  # current word, possibly incomplete
  local -r cur=${COMP_WORDS[COMP_CWORD]}

  #  COMP_WORDS
  #         An array variable consisting of the individual words in the current command line.
  #         The line is split into words as `readline` would split it, using COMP_WORDBREAKS.
  #         A word is considered complete once it is followed by a space.
  #  COMP_CWORD
  #         An index into ${COMP_WORDS} of the word containing the current cursor position.
  #  Examples:
  #         "jcmd "         -> COMP_CWORD = 1, cur = ""
  #         "jcmd MyA"      -> COMP_CWORD = 1, cur = "MyA"
  #         "jcmd MyApp"    -> COMP_CWORD = 1, cur = "MyApp"
  #         "jcmd MyApp "   -> COMP_CWORD = 2, cur = ""

  if [[ ${COMP_CWORD} -eq 1 ]]; then
    _jcmd__complete_first_arg "$cur"
    return 0
  fi

  local -r jvm_identifier=${COMP_WORDS[1]}

  # 2nd argument: diagnostic command.
  if [[ ${COMP_CWORD} -eq 2 ]]; then
    _jcmd__complete_command "${jvm_identifier}" "${cur}"
    return 0
  fi

  if [[ ${COMP_CWORD} -eq 3 ]]; then
    if [[ ${COMP_WORDS[2]} == help ]]; then
      _jcmd__complete_help_command "${jvm_identifier}" "${cur}"
    elif [[ ${COMP_WORDS[2]} == "-f" ]]; then
      # autocomplete filename
      compopt -o filenames 2>/dev/null
      COMPREPLY=( $(compgen -f -- "${cur}") )
    fi
    return 0
  fi
}

# Avoid alphabetical sorting of completion candidates on double-TAB. This
# keeps each JVM identifier (main class or JAR path) next to its PID.
complete -o nosort -F _jcmd_completion jcmd