refactor: rename { => _comp_get}_ncpus and change interface

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>

Author: akinomyoga

bash_completion

@@ -1508,13 +1508,19 @@ _available_interfaces()
 }
 
 # Echo number of CPUs, falling back to 1 on failure.
-# TODO:API: rename per conventions, rework to use vars rather than outputting
-_ncpus()
+# @var[out] ret
+# @return 0 if it successfully obtained the number of CPUs, or otherwise 1
+# @since 2.12
+_comp_get_ncpus()
 {
     local var=NPROCESSORS_ONLN
     [[ $OSTYPE == *@(linux|msys|cygwin)* ]] && var=_$var
-    local n=$(getconf $var 2>/dev/null)
-    printf %s "${n:-1}"
+    if ret=$(getconf $var 2>/dev/null) && ((ret >= 1)); then
+        return 0
+    else
+        ret=1
+        return 1
+    fi
 }
 
 # Perform tilde (~) completion

bash_completion.d/000_bash_completion_compat.bash

@@ -335,4 +335,12 @@ _parse_usage()
     return 0
 }
 
+# @deprecated 2.12 Use `_comp_get_ncpus`.
+_ncpus()
+{
+    local ret
+    _comp_get_ncpus
+    printf %s "$ret"
+}
+
 # ex: filetype=sh

completions/2to3

@@ -15,7 +15,9 @@ _comp_cmd_2to3()
             return
             ;;
         -j | --processes)
-            COMPREPLY=($(compgen -W "{1..$(_ncpus)}" -- "$cur"))
+            local ret
+            _comp_get_ncpus
+            _comp_compgen -- -W "{1..$ret}"
             return
             ;;
         -o | --output-dir)

completions/bzip2

@@ -12,7 +12,9 @@ _comp_cmd_bzip2()
             return
             ;;
         -${noargopts}n)
-            COMPREPLY=($(compgen -W "{1..$(_ncpus)}" -- "$cur"))
+            local ret
+            _comp_get_ncpus
+            _comp_compgen -- -W "{1..$ret}"
             return
             ;;
     esac

completions/cppcheck

@@ -42,7 +42,9 @@ _comp_cmd_cppcheck()
             return
             ;;
         -j)
-            COMPREPLY=($(compgen -W "{2..$(_ncpus)}" -- "$cur"))
+            local ret
+            _comp_get_ncpus
+            _comp_compgen -- -W "{2..$ret}"
             return
             ;;
         --language | -x)

completions/flake8

@@ -16,7 +16,9 @@ _comp_cmd_flake8()
             return
             ;;
         --jobs | -${noargopts}j)
-            COMPREPLY=($(compgen -W "auto {1..$(_ncpus)}" -- "$cur"))
+            local ret
+            _comp_get_ncpus
+            _comp_compgen -- -W "auto {1..$ret}"
             return
             ;;
         --output-file | --append-config | --config)

completions/gzip

@@ -13,7 +13,9 @@ _comp_cmd_gzip()
             return
             ;;
         --processes | -${noargopts}p)
-            COMPREPLY=($(compgen -W "{1..$(_ncpus)}" -- "$cur"))
+            local ret
+            _comp_get_ncpus
+            _comp_comgpen -- -W "{1..$ret}"
             return
             ;;
     esac

completions/isort

@@ -15,7 +15,9 @@ _comp_cmd_isort()
             return
             ;;
         --jobs | -j)
-            COMPREPLY=($(compgen -W "{1..$(_ncpus)}" -- "$cur"))
+            local ret
+            _comp_get_ncpus
+            _comp_comgpen -- -W "{1..$ret}"
             return
             ;;
         --multi-line | -m)

completions/lrzip

@@ -34,7 +34,9 @@ _comp_cmd_lrzip()
             return
             ;;
         --threads | -${noargopts}p)
-            COMPREPLY=($(compgen -W "{1..$(_ncpus)}" -- "$cur"))
+            local ret
+            _comp_get_ncpus
+            _comp_compgen -- -W "{1..$ret}"
             return
             ;;
     esac

completions/lzip

@@ -18,7 +18,9 @@ _comp_cmd_lzip()
             decompress=set
             ;;
         --threads | -${noargopts}n)
-            COMPREPLY=($(compgen -W "{1..$(_ncpus)}" -- "$cur"))
+            local ret
+            _comp_get_ncpus
+            _comp_compgen -- -W "{1..$ret}"
             return
             ;;
         --output | -${noargopts}o)