mirror of https://github.com/containers/podman.git
Vendor in some cobra PRs to improve the completion experience.
This is only temporary until the cobra following PRs are merged: - PR#1258 Custom completion handle multiple shorhand flags together - PR#1249 Fix fish handling of "ShellCompDirectiveNoSpace" and file completion - PR#1213 Fix zsh completion handling of nospace and file completion - PR#1146 Bash completion V2 with completion descriptions Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
This commit is contained in:
Paul Holzinger
parent
ea75312895
commit
df4bf5c584
3
go.mod
3
go.mod
|
|
@ -60,6 +60,7 @@ require (
|
||||||
github.com/varlink/go v0.0.0-20190502142041-0f1d566d194b
|
github.com/varlink/go v0.0.0-20190502142041-0f1d566d194b
|
||||||
github.com/vishvananda/netlink v1.1.0
|
github.com/vishvananda/netlink v1.1.0
|
||||||
go.etcd.io/bbolt v1.3.5
|
go.etcd.io/bbolt v1.3.5
|
||||||
|
go.uber.org/atomic v1.7.0 // indirect
|
||||||
golang.org/x/crypto v0.0.0-20200709230013-948cd5f35899
|
golang.org/x/crypto v0.0.0-20200709230013-948cd5f35899
|
||||||
golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d // indirect
|
golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d // indirect
|
||||||
golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208
|
golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208
|
||||||
|
|
@ -74,3 +75,5 @@ require (
|
||||||
)
|
)
|
||||||
|
|
||||||
replace github.com/cri-o/ocicni => github.com/cri-o/ocicni v0.2.1-0.20201109200316-afdc16ba66df
|
replace github.com/cri-o/ocicni => github.com/cri-o/ocicni v0.2.1-0.20201109200316-afdc16ba66df
|
||||||
|
|
||||||
|
replace github.com/spf13/cobra => github.com/Luap99/cobra v1.0.1-0.20201110155035-83a59186c706
|
||||||
|
|
|
||||||
8
go.sum
8
go.sum
|
|
@ -20,6 +20,8 @@ github.com/Azure/go-autorest v11.1.2+incompatible/go.mod h1:r+4oMnoxhatjLLJ6zxSW
|
||||||
github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
|
github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
|
||||||
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
|
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
|
||||||
github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
|
github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
|
||||||
|
github.com/Luap99/cobra v1.0.1-0.20201110155035-83a59186c706 h1:KcMtguD/NlxB4c08lzc91o5by51Sf+Ec5+1Yv9Wqvbk=
|
||||||
|
github.com/Luap99/cobra v1.0.1-0.20201110155035-83a59186c706/go.mod h1:WnodtKOvamDL/PwE2M4iKs8aMDBZ5Q5klgD3qfVJQMI=
|
||||||
github.com/Microsoft/go-winio v0.4.11/go.mod h1:VhR8bwka0BXejwEJY73c50VrPtXAaKcyvVC4A4RozmA=
|
github.com/Microsoft/go-winio v0.4.11/go.mod h1:VhR8bwka0BXejwEJY73c50VrPtXAaKcyvVC4A4RozmA=
|
||||||
github.com/Microsoft/go-winio v0.4.15-0.20190919025122-fc70bd9a86b5/go.mod h1:tTuCMEN+UleMWgg9dVx4Hu52b1bJo+59jBh3ajtinzw=
|
github.com/Microsoft/go-winio v0.4.15-0.20190919025122-fc70bd9a86b5/go.mod h1:tTuCMEN+UleMWgg9dVx4Hu52b1bJo+59jBh3ajtinzw=
|
||||||
github.com/Microsoft/go-winio v0.4.15-0.20200113171025-3fe6c5262873 h1:93nQ7k53GjoMQ07HVP8g6Zj1fQZDDj7Xy2VkNNtvX8o=
|
github.com/Microsoft/go-winio v0.4.15-0.20200113171025-3fe6c5262873 h1:93nQ7k53GjoMQ07HVP8g6Zj1fQZDDj7Xy2VkNNtvX8o=
|
||||||
|
|
@ -485,9 +487,6 @@ github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4k
|
||||||
github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
|
github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
|
||||||
github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=
|
github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=
|
||||||
github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
|
github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
|
||||||
github.com/spf13/cobra v0.0.2-0.20171109065643-2da4a54c5cee/go.mod h1:1l0Ry5zgKvJasoi3XT1TypsSe7PqH0Sj9dhYf7v3XqQ=
|
|
||||||
github.com/spf13/cobra v1.1.1 h1:KfztREH0tPxJJ+geloSLaAkaPkr4ki2Er5quFV1TDo4=
|
|
||||||
github.com/spf13/cobra v1.1.1/go.mod h1:WnodtKOvamDL/PwE2M4iKs8aMDBZ5Q5klgD3qfVJQMI=
|
|
||||||
github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo=
|
github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo=
|
||||||
github.com/spf13/pflag v0.0.0-20170130214245-9ff6c6923cff/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
|
github.com/spf13/pflag v0.0.0-20170130214245-9ff6c6923cff/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
|
||||||
github.com/spf13/pflag v1.0.1-0.20171106142849-4c012f6dcd95/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
|
github.com/spf13/pflag v1.0.1-0.20171106142849-4c012f6dcd95/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
|
||||||
|
|
@ -552,8 +551,9 @@ go.mozilla.org/pkcs7 v0.0.0-20200128120323-432b2356ecb1/go.mod h1:SNgMg+EgDFwmvS
|
||||||
go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU=
|
go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU=
|
||||||
go.opencensus.io v0.22.0 h1:C9hSCOW830chIVkdja34wa6Ky+IzWllkUinR+BtRZd4=
|
go.opencensus.io v0.22.0 h1:C9hSCOW830chIVkdja34wa6Ky+IzWllkUinR+BtRZd4=
|
||||||
go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8=
|
go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8=
|
||||||
go.uber.org/atomic v1.4.0 h1:cxzIVoETapQEqDhQu3QfnvXAV4AlzcvUCxkVUFw3+EU=
|
|
||||||
go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE=
|
go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE=
|
||||||
|
go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw=
|
||||||
|
go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc=
|
||||||
go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0=
|
go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0=
|
||||||
go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q=
|
go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q=
|
||||||
golang.org/x/crypto v0.0.0-20171113213409-9f005a07e0d3/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
|
golang.org/x/crypto v0.0.0-20171113213409-9f005a07e0d3/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
|
||||||
|
|
|
||||||
|
|
@ -5,23 +5,67 @@ import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"sort"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/spf13/pflag"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Annotations for Bash completion.
|
// Annotations for Bash completion.
|
||||||
const (
|
const (
|
||||||
BashCompFilenameExt = "cobra_annotation_bash_completion_filename_extensions"
|
BashCompFilenameExt = "cobra_annotation_bash_completion_filename_extensions"
|
||||||
|
// BashCompCustom should be avoided as it only works for bash.
|
||||||
|
// Function RegisterFlagCompletionFunc() should be used instead.
|
||||||
BashCompCustom = "cobra_annotation_bash_completion_custom"
|
BashCompCustom = "cobra_annotation_bash_completion_custom"
|
||||||
BashCompOneRequiredFlag = "cobra_annotation_bash_completion_one_required_flag"
|
BashCompOneRequiredFlag = "cobra_annotation_bash_completion_one_required_flag"
|
||||||
BashCompSubdirsInDir = "cobra_annotation_bash_completion_subdirs_in_dir"
|
BashCompSubdirsInDir = "cobra_annotation_bash_completion_subdirs_in_dir"
|
||||||
)
|
)
|
||||||
|
|
||||||
func writePreamble(buf *bytes.Buffer, name string) {
|
// GenBashCompletion generates bash completion file and writes to the passed writer.
|
||||||
buf.WriteString(fmt.Sprintf("# bash completion for %-36s -*- shell-script -*-\n", name))
|
func (c *Command) GenBashCompletion(w io.Writer) error {
|
||||||
buf.WriteString(fmt.Sprintf(`
|
return c.genBashCompletion(w, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenBashCompletionWithDesc generates bash completion file with descriptions and writes to the passed writer.
|
||||||
|
func (c *Command) GenBashCompletionWithDesc(w io.Writer) error {
|
||||||
|
return c.genBashCompletion(w, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenBashCompletionFile generates bash completion file.
|
||||||
|
func (c *Command) GenBashCompletionFile(filename string) error {
|
||||||
|
return c.genBashCompletionFile(filename, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenBashCompletionFileWithDesc generates bash completion file with descriptions.
|
||||||
|
func (c *Command) GenBashCompletionFileWithDesc(filename string) error {
|
||||||
|
return c.genBashCompletionFile(filename, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Command) genBashCompletionFile(filename string, includeDesc bool) error {
|
||||||
|
outFile, err := os.Create(filename)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer outFile.Close()
|
||||||
|
|
||||||
|
return c.genBashCompletion(outFile, includeDesc)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Command) genBashCompletion(w io.Writer, includeDesc bool) error {
|
||||||
|
buf := new(bytes.Buffer)
|
||||||
|
if len(c.BashCompletionFunction) > 0 {
|
||||||
|
buf.WriteString(c.BashCompletionFunction + "\n")
|
||||||
|
}
|
||||||
|
genBashComp(buf, c.Name(), includeDesc)
|
||||||
|
|
||||||
|
_, err := buf.WriteTo(w)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func genBashComp(buf *bytes.Buffer, name string, includeDesc bool) {
|
||||||
|
compCmd := ShellCompRequestCmd
|
||||||
|
if !includeDesc {
|
||||||
|
compCmd = ShellCompNoDescRequestCmd
|
||||||
|
}
|
||||||
|
|
||||||
|
buf.WriteString(fmt.Sprintf(`# bash completion for %-36[1]s -*- shell-script -*-
|
||||||
|
|
||||||
__%[1]s_debug()
|
__%[1]s_debug()
|
||||||
{
|
{
|
||||||
if [[ -n ${BASH_COMP_DEBUG_FILE} ]]; then
|
if [[ -n ${BASH_COMP_DEBUG_FILE} ]]; then
|
||||||
|
|
@ -29,46 +73,27 @@ __%[1]s_debug()
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# Homebrew on Macs have version 1.3 of bash-completion which doesn't include
|
__%[1]s_perform_completion()
|
||||||
# _init_completion. This is a very minimal version of that function.
|
|
||||||
__%[1]s_init_completion()
|
|
||||||
{
|
{
|
||||||
COMPREPLY=()
|
__%[1]s_debug
|
||||||
_get_comp_words_by_ref "$@" cur prev words cword
|
__%[1]s_debug "========= starting completion logic =========="
|
||||||
}
|
__%[1]s_debug "cur is ${cur}, words[*] is ${words[*]}, #words[@] is ${#words[@]}, cword is $cword"
|
||||||
|
|
||||||
__%[1]s_index_of_word()
|
# The user could have moved the cursor backwards on the command-line.
|
||||||
{
|
# We need to trigger completion from the $cword location, so we need
|
||||||
local w word=$1
|
# to truncate the command-line ($words) up to the $cword location.
|
||||||
shift
|
words=("${words[@]:0:$cword+1}")
|
||||||
index=0
|
__%[1]s_debug "Truncated words[*]: ${words[*]},"
|
||||||
for w in "$@"; do
|
|
||||||
[[ $w = "$word" ]] && return
|
|
||||||
index=$((index+1))
|
|
||||||
done
|
|
||||||
index=-1
|
|
||||||
}
|
|
||||||
|
|
||||||
__%[1]s_contains_word()
|
|
||||||
{
|
|
||||||
local w word=$1; shift
|
|
||||||
for w in "$@"; do
|
|
||||||
[[ $w = "$word" ]] && return
|
|
||||||
done
|
|
||||||
return 1
|
|
||||||
}
|
|
||||||
|
|
||||||
__%[1]s_handle_go_custom_completion()
|
|
||||||
{
|
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: cur is ${cur}, words[*] is ${words[*]}, #words[@] is ${#words[@]}"
|
|
||||||
|
|
||||||
local shellCompDirectiveError=%[3]d
|
local shellCompDirectiveError=%[3]d
|
||||||
local shellCompDirectiveNoSpace=%[4]d
|
local shellCompDirectiveNoSpace=%[4]d
|
||||||
local shellCompDirectiveNoFileComp=%[5]d
|
local shellCompDirectiveNoFileComp=%[5]d
|
||||||
local shellCompDirectiveFilterFileExt=%[6]d
|
local shellCompDirectiveFilterFileExt=%[6]d
|
||||||
local shellCompDirectiveFilterDirs=%[7]d
|
local shellCompDirectiveFilterDirs=%[7]d
|
||||||
|
local shellCompDirectiveLegacyCustomComp=%[8]d
|
||||||
|
local shellCompDirectiveLegacyCustomArgsComp=%[9]d
|
||||||
|
|
||||||
local out requestComp lastParam lastChar comp directive args
|
local out requestComp lastParam lastChar comp directive args flagPrefix
|
||||||
|
|
||||||
# Prepare the command to request completions for the program.
|
# Prepare the command to request completions for the program.
|
||||||
# Calling ${words[0]} instead of directly %[1]s allows to handle aliases
|
# Calling ${words[0]} instead of directly %[1]s allows to handle aliases
|
||||||
|
|
@ -77,16 +102,24 @@ __%[1]s_handle_go_custom_completion()
|
||||||
|
|
||||||
lastParam=${words[$((${#words[@]}-1))]}
|
lastParam=${words[$((${#words[@]}-1))]}
|
||||||
lastChar=${lastParam:$((${#lastParam}-1)):1}
|
lastChar=${lastParam:$((${#lastParam}-1)):1}
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: lastParam ${lastParam}, lastChar ${lastChar}"
|
__%[1]s_debug "lastParam ${lastParam}, lastChar ${lastChar}"
|
||||||
|
|
||||||
if [ -z "${cur}" ] && [ "${lastChar}" != "=" ]; then
|
if [ -z "${cur}" ] && [ "${lastChar}" != "=" ]; then
|
||||||
# If the last parameter is complete (there is a space following it)
|
# If the last parameter is complete (there is a space following it)
|
||||||
# We add an extra empty parameter so we can indicate this to the go method.
|
# We add an extra empty parameter so we can indicate this to the go method.
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: Adding extra empty parameter"
|
__%[1]s_debug "Adding extra empty parameter"
|
||||||
requestComp="${requestComp} \"\""
|
requestComp="${requestComp} \"\""
|
||||||
fi
|
fi
|
||||||
|
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: calling ${requestComp}"
|
# When completing a flag with an = (e.g., %[1]s -n=<TAB>)
|
||||||
|
# bash focuses on the part after the =, so we need to remove
|
||||||
|
# the flag part from $cur
|
||||||
|
if [[ "${cur}" == -*=* ]]; then
|
||||||
|
flagPrefix="${cur%%%%=*}="
|
||||||
|
cur="${cur#*=}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
__%[1]s_debug "Calling ${requestComp}"
|
||||||
# Use eval to handle any environment variables and such
|
# Use eval to handle any environment variables and such
|
||||||
out=$(eval "${requestComp}" 2>/dev/null)
|
out=$(eval "${requestComp}" 2>/dev/null)
|
||||||
|
|
||||||
|
|
@ -98,23 +131,23 @@ __%[1]s_handle_go_custom_completion()
|
||||||
# There is not directive specified
|
# There is not directive specified
|
||||||
directive=0
|
directive=0
|
||||||
fi
|
fi
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: the completion directive is: ${directive}"
|
__%[1]s_debug "The completion directive is: ${directive}"
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: the completions are: ${out[*]}"
|
__%[1]s_debug "The completions are: ${out[*]}"
|
||||||
|
|
||||||
if [ $((directive & shellCompDirectiveError)) -ne 0 ]; then
|
if [ $((directive & shellCompDirectiveError)) -ne 0 ]; then
|
||||||
# Error code. No completion.
|
# Error code. No completion.
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: received error from custom completion go code"
|
__%[1]s_debug "Received error from custom completion go code"
|
||||||
return
|
return
|
||||||
else
|
else
|
||||||
if [ $((directive & shellCompDirectiveNoSpace)) -ne 0 ]; then
|
if [ $((directive & shellCompDirectiveNoSpace)) -ne 0 ]; then
|
||||||
if [[ $(type -t compopt) = "builtin" ]]; then
|
if [[ $(type -t compopt) = "builtin" ]]; then
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: activating no space"
|
__%[1]s_debug "Activating no space"
|
||||||
compopt -o nospace
|
compopt -o nospace
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
if [ $((directive & shellCompDirectiveNoFileComp)) -ne 0 ]; then
|
if [ $((directive & shellCompDirectiveNoFileComp)) -ne 0 ]; then
|
||||||
if [[ $(type -t compopt) = "builtin" ]]; then
|
if [[ $(type -t compopt) = "builtin" ]]; then
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: activating no file completion"
|
__%[1]s_debug "Activating no file completion"
|
||||||
compopt +o default
|
compopt +o default
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
@ -123,6 +156,7 @@ __%[1]s_handle_go_custom_completion()
|
||||||
if [ $((directive & shellCompDirectiveFilterFileExt)) -ne 0 ]; then
|
if [ $((directive & shellCompDirectiveFilterFileExt)) -ne 0 ]; then
|
||||||
# File extension filtering
|
# File extension filtering
|
||||||
local fullFilter filter filteringCmd
|
local fullFilter filter filteringCmd
|
||||||
|
|
||||||
# Do not use quotes around the $out variable or else newline
|
# Do not use quotes around the $out variable or else newline
|
||||||
# characters will be kept.
|
# characters will be kept.
|
||||||
for filter in ${out[*]}; do
|
for filter in ${out[*]}; do
|
||||||
|
|
@ -134,545 +168,173 @@ __%[1]s_handle_go_custom_completion()
|
||||||
$filteringCmd
|
$filteringCmd
|
||||||
elif [ $((directive & shellCompDirectiveFilterDirs)) -ne 0 ]; then
|
elif [ $((directive & shellCompDirectiveFilterDirs)) -ne 0 ]; then
|
||||||
# File completion for directories only
|
# File completion for directories only
|
||||||
local subDir
|
|
||||||
# Use printf to strip any trailing newline
|
# Use printf to strip any trailing newline
|
||||||
|
local subdir
|
||||||
subdir=$(printf "%%s" "${out[0]}")
|
subdir=$(printf "%%s" "${out[0]}")
|
||||||
if [ -n "$subdir" ]; then
|
if [ -n "$subdir" ]; then
|
||||||
__%[1]s_debug "Listing directories in $subdir"
|
__%[1]s_debug "Listing directories in $subdir"
|
||||||
__%[1]s_handle_subdirs_in_dir_flag "$subdir"
|
pushd "$subdir" >/dev/null 2>&1 && _filedir -d && popd >/dev/null 2>&1 || return
|
||||||
else
|
else
|
||||||
__%[1]s_debug "Listing directories in ."
|
__%[1]s_debug "Listing directories in ."
|
||||||
_filedir -d
|
_filedir -d
|
||||||
fi
|
fi
|
||||||
|
elif [ $((directive & shellCompDirectiveLegacyCustomComp)) -ne 0 ]; then
|
||||||
|
local cmd
|
||||||
|
__%[1]s_debug "Legacy custom completion. Directive: $directive, cmds: ${out[*]}"
|
||||||
|
|
||||||
|
# The following variables should get their value through the commands
|
||||||
|
# we have received as completions and are parsing below.
|
||||||
|
local last_command
|
||||||
|
local nouns
|
||||||
|
|
||||||
|
# Execute every command received
|
||||||
|
while IFS='' read -r cmd; do
|
||||||
|
__%[1]s_debug "About to execute: $cmd"
|
||||||
|
eval "$cmd"
|
||||||
|
done < <(printf "%%s\n" "${out[@]}")
|
||||||
|
|
||||||
|
__%[1]s_debug "last_command: $last_command"
|
||||||
|
__%[1]s_debug "nouns[0]: ${nouns[0]}, nouns[1]: ${nouns[1]}"
|
||||||
|
|
||||||
|
if [ $((directive & shellCompDirectiveLegacyCustomArgsComp)) -ne 0 ]; then
|
||||||
|
# We should call the global legacy custom completion function, if it is defined
|
||||||
|
if declare -F __%[1]s_custom_func >/dev/null; then
|
||||||
|
# Use command name qualified legacy custom func
|
||||||
|
__%[1]s_debug "About to call: __%[1]s_custom_func"
|
||||||
|
__%[1]s_custom_func
|
||||||
|
elif declare -F __custom_func >/dev/null; then
|
||||||
|
# Otherwise fall back to unqualified legacy custom func for compatibility
|
||||||
|
__%[1]s_debug "About to call: __custom_func"
|
||||||
|
__custom_func
|
||||||
|
fi
|
||||||
|
fi
|
||||||
else
|
else
|
||||||
|
local tab
|
||||||
|
tab=$(printf '\t')
|
||||||
|
local longest=0
|
||||||
|
# Look for the longest completion so that we can format things nicely
|
||||||
while IFS='' read -r comp; do
|
while IFS='' read -r comp; do
|
||||||
COMPREPLY+=("$comp")
|
comp=${comp%%%%$tab*}
|
||||||
done < <(compgen -W "${out[*]}" -- "$cur")
|
if ((${#comp}>longest)); then
|
||||||
|
longest=${#comp}
|
||||||
fi
|
fi
|
||||||
}
|
done < <(printf "%%s\n" "${out[@]}")
|
||||||
|
|
||||||
__%[1]s_handle_reply()
|
local completions=()
|
||||||
{
|
|
||||||
__%[1]s_debug "${FUNCNAME[0]}"
|
|
||||||
local comp
|
|
||||||
case $cur in
|
|
||||||
-*)
|
|
||||||
if [[ $(type -t compopt) = "builtin" ]]; then
|
|
||||||
compopt -o nospace
|
|
||||||
fi
|
|
||||||
local allflags
|
|
||||||
if [ ${#must_have_one_flag[@]} -ne 0 ]; then
|
|
||||||
allflags=("${must_have_one_flag[@]}")
|
|
||||||
else
|
|
||||||
allflags=("${flags[*]} ${two_word_flags[*]}")
|
|
||||||
fi
|
|
||||||
while IFS='' read -r comp; do
|
while IFS='' read -r comp; do
|
||||||
COMPREPLY+=("$comp")
|
if [ -z "$comp" ]; then
|
||||||
done < <(compgen -W "${allflags[*]}" -- "$cur")
|
continue
|
||||||
if [[ $(type -t compopt) = "builtin" ]]; then
|
|
||||||
[[ "${COMPREPLY[0]}" == *= ]] || compopt +o nospace
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# complete after --flag=abc
|
__%[1]s_debug "Original comp: $comp"
|
||||||
if [[ $cur == *=* ]]; then
|
comp="$(__%[1]s_format_comp_descriptions "$comp" "$longest")"
|
||||||
if [[ $(type -t compopt) = "builtin" ]]; then
|
__%[1]s_debug "Final comp: $comp"
|
||||||
compopt +o nospace
|
completions+=("$comp")
|
||||||
fi
|
done < <(printf "%%s\n" "${out[@]}")
|
||||||
|
|
||||||
local index flag
|
while IFS='' read -r comp; do
|
||||||
flag="${cur%%=*}"
|
# Although this script should only be used for bash
|
||||||
__%[1]s_index_of_word "${flag}" "${flags_with_completion[@]}"
|
# there may be programs that still convert the bash
|
||||||
COMPREPLY=()
|
# script into a zsh one. To continue supporting those
|
||||||
if [[ ${index} -ge 0 ]]; then
|
# programs, we do this single adaptation for zsh
|
||||||
PREFIX=""
|
|
||||||
cur="${cur#*=}"
|
|
||||||
${flags_completion[${index}]}
|
|
||||||
if [ -n "${ZSH_VERSION}" ]; then
|
if [ -n "${ZSH_VERSION}" ]; then
|
||||||
# zsh completion needs --flag= prefix
|
# zsh completion needs --flag= prefix
|
||||||
eval "COMPREPLY=( \"\${COMPREPLY[@]/#/${flag}=}\" )"
|
COMPREPLY+=("$flagPrefix$comp")
|
||||||
fi
|
else
|
||||||
fi
|
|
||||||
fi
|
|
||||||
return 0;
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
# check if we are handling a flag with special work handling
|
|
||||||
local index
|
|
||||||
__%[1]s_index_of_word "${prev}" "${flags_with_completion[@]}"
|
|
||||||
if [[ ${index} -ge 0 ]]; then
|
|
||||||
${flags_completion[${index}]}
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
# we are parsing a flag and don't have a special handler, no completion
|
|
||||||
if [[ ${cur} != "${words[cword]}" ]]; then
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
local completions
|
|
||||||
completions=("${commands[@]}")
|
|
||||||
if [[ ${#must_have_one_noun[@]} -ne 0 ]]; then
|
|
||||||
completions+=("${must_have_one_noun[@]}")
|
|
||||||
elif [[ -n "${has_completion_function}" ]]; then
|
|
||||||
# if a go completion function is provided, defer to that function
|
|
||||||
__%[1]s_handle_go_custom_completion
|
|
||||||
fi
|
|
||||||
if [[ ${#must_have_one_flag[@]} -ne 0 ]]; then
|
|
||||||
completions+=("${must_have_one_flag[@]}")
|
|
||||||
fi
|
|
||||||
while IFS='' read -r comp; do
|
|
||||||
COMPREPLY+=("$comp")
|
COMPREPLY+=("$comp")
|
||||||
|
fi
|
||||||
done < <(compgen -W "${completions[*]}" -- "$cur")
|
done < <(compgen -W "${completions[*]}" -- "$cur")
|
||||||
|
|
||||||
if [[ ${#COMPREPLY[@]} -eq 0 && ${#noun_aliases[@]} -gt 0 && ${#must_have_one_noun[@]} -ne 0 ]]; then
|
# If there is a single completion left, remove the description text
|
||||||
while IFS='' read -r comp; do
|
if [ ${#COMPREPLY[*]} -eq 1 ]; then
|
||||||
|
__%[1]s_debug "COMPREPLY[0]: ${COMPREPLY[0]}"
|
||||||
|
comp="${COMPREPLY[0]%%%% *}"
|
||||||
|
__%[1]s_debug "Removed description from single completion, which is now: ${comp}"
|
||||||
|
COMPREPLY=()
|
||||||
COMPREPLY+=("$comp")
|
COMPREPLY+=("$comp")
|
||||||
done < <(compgen -W "${noun_aliases[*]}" -- "$cur")
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ ${#COMPREPLY[@]} -eq 0 ]]; then
|
|
||||||
if declare -F __%[1]s_custom_func >/dev/null; then
|
|
||||||
# try command name qualified custom func
|
|
||||||
__%[1]s_custom_func
|
|
||||||
else
|
|
||||||
# otherwise fall back to unqualified for compatibility
|
|
||||||
declare -F __custom_func >/dev/null && __custom_func
|
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# available in bash-completion >= 2, not always present on macOS
|
__%[1]s_handle_special_char "$cur" :
|
||||||
if declare -F __ltrim_colon_completions >/dev/null; then
|
__%[1]s_handle_special_char "$cur" =
|
||||||
__ltrim_colon_completions "$cur"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# If there is only 1 completion and it is a flag with an = it will be completed
|
|
||||||
# but we don't want a space after the =
|
|
||||||
if [[ "${#COMPREPLY[@]}" -eq "1" ]] && [[ $(type -t compopt) = "builtin" ]] && [[ "${COMPREPLY[0]}" == --*= ]]; then
|
|
||||||
compopt -o nospace
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# The arguments should be in the form "ext1|ext2|extn"
|
__%[1]s_handle_special_char()
|
||||||
__%[1]s_handle_filename_extension_flag()
|
|
||||||
{
|
{
|
||||||
local ext="$1"
|
local comp="$1"
|
||||||
_filedir "@(${ext})"
|
local char=$2
|
||||||
|
if [[ "$comp" == *${char}* && "$COMP_WORDBREAKS" == *${char}* ]]; then
|
||||||
|
local word=${comp%%"${comp##*${char}}"}
|
||||||
|
local idx=${#COMPREPLY[*]}
|
||||||
|
while [[ $((--idx)) -ge 0 ]]; do
|
||||||
|
COMPREPLY[$idx]=${COMPREPLY[$idx]#"$word"}
|
||||||
|
done
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
__%[1]s_handle_subdirs_in_dir_flag()
|
__%[1]s_format_comp_descriptions()
|
||||||
{
|
{
|
||||||
local dir="$1"
|
local tab
|
||||||
pushd "${dir}" >/dev/null 2>&1 && _filedir -d && popd >/dev/null 2>&1 || return
|
tab=$(printf '\t')
|
||||||
|
local comp="$1"
|
||||||
|
local longest=$2
|
||||||
|
|
||||||
|
# Properly format the description string which follows a tab character if there is one
|
||||||
|
if [[ "$comp" == *$tab* ]]; then
|
||||||
|
desc=${comp#*$tab}
|
||||||
|
comp=${comp%%%%$tab*}
|
||||||
|
|
||||||
|
# $COLUMNS stores the current shell width.
|
||||||
|
# Remove an extra 4 because we add 2 spaces and 2 parentheses.
|
||||||
|
maxdesclength=$(( COLUMNS - longest - 4 ))
|
||||||
|
|
||||||
|
# Make sure we can fit a description of at least 8 characters
|
||||||
|
# if we are to align the descriptions.
|
||||||
|
if [[ $maxdesclength -gt 8 ]]; then
|
||||||
|
# Add the proper number of spaces to align the descriptions
|
||||||
|
for ((i = ${#comp} ; i < longest ; i++)); do
|
||||||
|
comp+=" "
|
||||||
|
done
|
||||||
|
else
|
||||||
|
# Don't pad the descriptions so we can fit more text after the completion
|
||||||
|
maxdesclength=$(( COLUMNS - ${#comp} - 4 ))
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If there is enough space for any description text,
|
||||||
|
# truncate the descriptions that are too long for the shell width
|
||||||
|
if [ $maxdesclength -gt 0 ]; then
|
||||||
|
if [ ${#desc} -gt $maxdesclength ]; then
|
||||||
|
desc=${desc:0:$(( maxdesclength - 1 ))}
|
||||||
|
desc+="…"
|
||||||
|
fi
|
||||||
|
comp+=" ($desc)"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Must use printf to escape all special characters
|
||||||
|
printf "%%q" "${comp}"
|
||||||
}
|
}
|
||||||
|
|
||||||
__%[1]s_handle_flag()
|
__start_%[1]s()
|
||||||
{
|
{
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
|
|
||||||
|
|
||||||
# if a command required a flag, and we found it, unset must_have_one_flag()
|
|
||||||
local flagname=${words[c]}
|
|
||||||
local flagvalue
|
|
||||||
# if the word contained an =
|
|
||||||
if [[ ${words[c]} == *"="* ]]; then
|
|
||||||
flagvalue=${flagname#*=} # take in as flagvalue after the =
|
|
||||||
flagname=${flagname%%=*} # strip everything after the =
|
|
||||||
flagname="${flagname}=" # but put the = back
|
|
||||||
fi
|
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: looking for ${flagname}"
|
|
||||||
if __%[1]s_contains_word "${flagname}" "${must_have_one_flag[@]}"; then
|
|
||||||
must_have_one_flag=()
|
|
||||||
fi
|
|
||||||
|
|
||||||
# if you set a flag which only applies to this command, don't show subcommands
|
|
||||||
if __%[1]s_contains_word "${flagname}" "${local_nonpersistent_flags[@]}"; then
|
|
||||||
commands=()
|
|
||||||
fi
|
|
||||||
|
|
||||||
# keep flag value with flagname as flaghash
|
|
||||||
# flaghash variable is an associative array which is only supported in bash > 3.
|
|
||||||
if [[ -z "${BASH_VERSION}" || "${BASH_VERSINFO[0]}" -gt 3 ]]; then
|
|
||||||
if [ -n "${flagvalue}" ] ; then
|
|
||||||
flaghash[${flagname}]=${flagvalue}
|
|
||||||
elif [ -n "${words[ $((c+1)) ]}" ] ; then
|
|
||||||
flaghash[${flagname}]=${words[ $((c+1)) ]}
|
|
||||||
else
|
|
||||||
flaghash[${flagname}]="true" # pad "true" for bool flag
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
# skip the argument to a two word flag
|
|
||||||
if [[ ${words[c]} != *"="* ]] && __%[1]s_contains_word "${words[c]}" "${two_word_flags[@]}"; then
|
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: found a flag ${words[c]}, skip the next argument"
|
|
||||||
c=$((c+1))
|
|
||||||
# if we are looking for a flags value, don't show commands
|
|
||||||
if [[ $c -eq $cword ]]; then
|
|
||||||
commands=()
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
c=$((c+1))
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
__%[1]s_handle_noun()
|
|
||||||
{
|
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
|
|
||||||
|
|
||||||
if __%[1]s_contains_word "${words[c]}" "${must_have_one_noun[@]}"; then
|
|
||||||
must_have_one_noun=()
|
|
||||||
elif __%[1]s_contains_word "${words[c]}" "${noun_aliases[@]}"; then
|
|
||||||
must_have_one_noun=()
|
|
||||||
fi
|
|
||||||
|
|
||||||
nouns+=("${words[c]}")
|
|
||||||
c=$((c+1))
|
|
||||||
}
|
|
||||||
|
|
||||||
__%[1]s_handle_command()
|
|
||||||
{
|
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
|
|
||||||
|
|
||||||
local next_command
|
|
||||||
if [[ -n ${last_command} ]]; then
|
|
||||||
next_command="_${last_command}_${words[c]//:/__}"
|
|
||||||
else
|
|
||||||
if [[ $c -eq 0 ]]; then
|
|
||||||
next_command="_%[1]s_root_command"
|
|
||||||
else
|
|
||||||
next_command="_${words[c]//:/__}"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
c=$((c+1))
|
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: looking for ${next_command}"
|
|
||||||
declare -F "$next_command" >/dev/null && $next_command
|
|
||||||
}
|
|
||||||
|
|
||||||
__%[1]s_handle_word()
|
|
||||||
{
|
|
||||||
if [[ $c -ge $cword ]]; then
|
|
||||||
__%[1]s_handle_reply
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
__%[1]s_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
|
|
||||||
if [[ "${words[c]}" == -* ]]; then
|
|
||||||
__%[1]s_handle_flag
|
|
||||||
elif __%[1]s_contains_word "${words[c]}" "${commands[@]}"; then
|
|
||||||
__%[1]s_handle_command
|
|
||||||
elif [[ $c -eq 0 ]]; then
|
|
||||||
__%[1]s_handle_command
|
|
||||||
elif __%[1]s_contains_word "${words[c]}" "${command_aliases[@]}"; then
|
|
||||||
# aliashash variable is an associative array which is only supported in bash > 3.
|
|
||||||
if [[ -z "${BASH_VERSION}" || "${BASH_VERSINFO[0]}" -gt 3 ]]; then
|
|
||||||
words[c]=${aliashash[${words[c]}]}
|
|
||||||
__%[1]s_handle_command
|
|
||||||
else
|
|
||||||
__%[1]s_handle_noun
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
__%[1]s_handle_noun
|
|
||||||
fi
|
|
||||||
__%[1]s_handle_word
|
|
||||||
}
|
|
||||||
|
|
||||||
`, name, ShellCompNoDescRequestCmd,
|
|
||||||
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
|
||||||
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs))
|
|
||||||
}
|
|
||||||
|
|
||||||
func writePostscript(buf *bytes.Buffer, name string) {
|
|
||||||
name = strings.Replace(name, ":", "__", -1)
|
|
||||||
buf.WriteString(fmt.Sprintf("__start_%s()\n", name))
|
|
||||||
buf.WriteString(fmt.Sprintf(`{
|
|
||||||
local cur prev words cword
|
local cur prev words cword
|
||||||
declare -A flaghash 2>/dev/null || :
|
|
||||||
declare -A aliashash 2>/dev/null || :
|
COMPREPLY=()
|
||||||
if declare -F _init_completion >/dev/null 2>&1; then
|
_get_comp_words_by_ref -n "=:" cur prev words cword
|
||||||
_init_completion -s || return
|
|
||||||
|
__%[1]s_perform_completion
|
||||||
|
}
|
||||||
|
|
||||||
|
if [[ $(type -t compopt) = "builtin" ]]; then
|
||||||
|
complete -o default -F __start_%[1]s %[1]s
|
||||||
else
|
else
|
||||||
__%[1]s_init_completion -n "=" || return
|
complete -o default -o nospace -F __start_%[1]s %[1]s
|
||||||
fi
|
fi
|
||||||
|
|
||||||
local c=0
|
# ex: ts=4 sw=4 et filetype=sh
|
||||||
local flags=()
|
`, name, compCmd,
|
||||||
local two_word_flags=()
|
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
||||||
local local_nonpersistent_flags=()
|
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs,
|
||||||
local flags_with_completion=()
|
shellCompDirectiveLegacyCustomComp, shellCompDirectiveLegacyCustomArgsComp))
|
||||||
local flags_completion=()
|
|
||||||
local commands=("%[1]s")
|
|
||||||
local must_have_one_flag=()
|
|
||||||
local must_have_one_noun=()
|
|
||||||
local has_completion_function
|
|
||||||
local last_command
|
|
||||||
local nouns=()
|
|
||||||
|
|
||||||
__%[1]s_handle_word
|
|
||||||
}
|
|
||||||
|
|
||||||
`, name))
|
|
||||||
buf.WriteString(fmt.Sprintf(`if [[ $(type -t compopt) = "builtin" ]]; then
|
|
||||||
complete -o default -F __start_%s %s
|
|
||||||
else
|
|
||||||
complete -o default -o nospace -F __start_%s %s
|
|
||||||
fi
|
|
||||||
|
|
||||||
`, name, name, name, name))
|
|
||||||
buf.WriteString("# ex: ts=4 sw=4 et filetype=sh\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeCommands(buf *bytes.Buffer, cmd *Command) {
|
|
||||||
buf.WriteString(" commands=()\n")
|
|
||||||
for _, c := range cmd.Commands() {
|
|
||||||
if !c.IsAvailableCommand() && c != cmd.helpCommand {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
buf.WriteString(fmt.Sprintf(" commands+=(%q)\n", c.Name()))
|
|
||||||
writeCmdAliases(buf, c)
|
|
||||||
}
|
|
||||||
buf.WriteString("\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeFlagHandler(buf *bytes.Buffer, name string, annotations map[string][]string, cmd *Command) {
|
|
||||||
for key, value := range annotations {
|
|
||||||
switch key {
|
|
||||||
case BashCompFilenameExt:
|
|
||||||
buf.WriteString(fmt.Sprintf(" flags_with_completion+=(%q)\n", name))
|
|
||||||
|
|
||||||
var ext string
|
|
||||||
if len(value) > 0 {
|
|
||||||
ext = fmt.Sprintf("__%s_handle_filename_extension_flag ", cmd.Root().Name()) + strings.Join(value, "|")
|
|
||||||
} else {
|
|
||||||
ext = "_filedir"
|
|
||||||
}
|
|
||||||
buf.WriteString(fmt.Sprintf(" flags_completion+=(%q)\n", ext))
|
|
||||||
case BashCompCustom:
|
|
||||||
buf.WriteString(fmt.Sprintf(" flags_with_completion+=(%q)\n", name))
|
|
||||||
if len(value) > 0 {
|
|
||||||
handlers := strings.Join(value, "; ")
|
|
||||||
buf.WriteString(fmt.Sprintf(" flags_completion+=(%q)\n", handlers))
|
|
||||||
} else {
|
|
||||||
buf.WriteString(" flags_completion+=(:)\n")
|
|
||||||
}
|
|
||||||
case BashCompSubdirsInDir:
|
|
||||||
buf.WriteString(fmt.Sprintf(" flags_with_completion+=(%q)\n", name))
|
|
||||||
|
|
||||||
var ext string
|
|
||||||
if len(value) == 1 {
|
|
||||||
ext = fmt.Sprintf("__%s_handle_subdirs_in_dir_flag ", cmd.Root().Name()) + value[0]
|
|
||||||
} else {
|
|
||||||
ext = "_filedir -d"
|
|
||||||
}
|
|
||||||
buf.WriteString(fmt.Sprintf(" flags_completion+=(%q)\n", ext))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeShortFlag(buf *bytes.Buffer, flag *pflag.Flag, cmd *Command) {
|
|
||||||
name := flag.Shorthand
|
|
||||||
format := " "
|
|
||||||
if len(flag.NoOptDefVal) == 0 {
|
|
||||||
format += "two_word_"
|
|
||||||
}
|
|
||||||
format += "flags+=(\"-%s\")\n"
|
|
||||||
buf.WriteString(fmt.Sprintf(format, name))
|
|
||||||
writeFlagHandler(buf, "-"+name, flag.Annotations, cmd)
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeFlag(buf *bytes.Buffer, flag *pflag.Flag, cmd *Command) {
|
|
||||||
name := flag.Name
|
|
||||||
format := " flags+=(\"--%s"
|
|
||||||
if len(flag.NoOptDefVal) == 0 {
|
|
||||||
format += "="
|
|
||||||
}
|
|
||||||
format += "\")\n"
|
|
||||||
buf.WriteString(fmt.Sprintf(format, name))
|
|
||||||
if len(flag.NoOptDefVal) == 0 {
|
|
||||||
format = " two_word_flags+=(\"--%s\")\n"
|
|
||||||
buf.WriteString(fmt.Sprintf(format, name))
|
|
||||||
}
|
|
||||||
writeFlagHandler(buf, "--"+name, flag.Annotations, cmd)
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeLocalNonPersistentFlag(buf *bytes.Buffer, flag *pflag.Flag) {
|
|
||||||
name := flag.Name
|
|
||||||
format := " local_nonpersistent_flags+=(\"--%[1]s\")\n"
|
|
||||||
if len(flag.NoOptDefVal) == 0 {
|
|
||||||
format += " local_nonpersistent_flags+=(\"--%[1]s=\")\n"
|
|
||||||
}
|
|
||||||
buf.WriteString(fmt.Sprintf(format, name))
|
|
||||||
if len(flag.Shorthand) > 0 {
|
|
||||||
buf.WriteString(fmt.Sprintf(" local_nonpersistent_flags+=(\"-%s\")\n", flag.Shorthand))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Setup annotations for go completions for registered flags
|
|
||||||
func prepareCustomAnnotationsForFlags(cmd *Command) {
|
|
||||||
for flag := range flagCompletionFunctions {
|
|
||||||
// Make sure the completion script calls the __*_go_custom_completion function for
|
|
||||||
// every registered flag. We need to do this here (and not when the flag was registered
|
|
||||||
// for completion) so that we can know the root command name for the prefix
|
|
||||||
// of __<prefix>_go_custom_completion
|
|
||||||
if flag.Annotations == nil {
|
|
||||||
flag.Annotations = map[string][]string{}
|
|
||||||
}
|
|
||||||
flag.Annotations[BashCompCustom] = []string{fmt.Sprintf("__%[1]s_handle_go_custom_completion", cmd.Root().Name())}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeFlags(buf *bytes.Buffer, cmd *Command) {
|
|
||||||
prepareCustomAnnotationsForFlags(cmd)
|
|
||||||
buf.WriteString(` flags=()
|
|
||||||
two_word_flags=()
|
|
||||||
local_nonpersistent_flags=()
|
|
||||||
flags_with_completion=()
|
|
||||||
flags_completion=()
|
|
||||||
|
|
||||||
`)
|
|
||||||
localNonPersistentFlags := cmd.LocalNonPersistentFlags()
|
|
||||||
cmd.NonInheritedFlags().VisitAll(func(flag *pflag.Flag) {
|
|
||||||
if nonCompletableFlag(flag) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
writeFlag(buf, flag, cmd)
|
|
||||||
if len(flag.Shorthand) > 0 {
|
|
||||||
writeShortFlag(buf, flag, cmd)
|
|
||||||
}
|
|
||||||
// localNonPersistentFlags are used to stop the completion of subcommands when one is set
|
|
||||||
// if TraverseChildren is true we should allow to complete subcommands
|
|
||||||
if localNonPersistentFlags.Lookup(flag.Name) != nil && !cmd.Root().TraverseChildren {
|
|
||||||
writeLocalNonPersistentFlag(buf, flag)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
cmd.InheritedFlags().VisitAll(func(flag *pflag.Flag) {
|
|
||||||
if nonCompletableFlag(flag) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
writeFlag(buf, flag, cmd)
|
|
||||||
if len(flag.Shorthand) > 0 {
|
|
||||||
writeShortFlag(buf, flag, cmd)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
buf.WriteString("\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeRequiredFlag(buf *bytes.Buffer, cmd *Command) {
|
|
||||||
buf.WriteString(" must_have_one_flag=()\n")
|
|
||||||
flags := cmd.NonInheritedFlags()
|
|
||||||
flags.VisitAll(func(flag *pflag.Flag) {
|
|
||||||
if nonCompletableFlag(flag) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
for key := range flag.Annotations {
|
|
||||||
switch key {
|
|
||||||
case BashCompOneRequiredFlag:
|
|
||||||
format := " must_have_one_flag+=(\"--%s"
|
|
||||||
if flag.Value.Type() != "bool" {
|
|
||||||
format += "="
|
|
||||||
}
|
|
||||||
format += "\")\n"
|
|
||||||
buf.WriteString(fmt.Sprintf(format, flag.Name))
|
|
||||||
|
|
||||||
if len(flag.Shorthand) > 0 {
|
|
||||||
buf.WriteString(fmt.Sprintf(" must_have_one_flag+=(\"-%s\")\n", flag.Shorthand))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeRequiredNouns(buf *bytes.Buffer, cmd *Command) {
|
|
||||||
buf.WriteString(" must_have_one_noun=()\n")
|
|
||||||
sort.Sort(sort.StringSlice(cmd.ValidArgs))
|
|
||||||
for _, value := range cmd.ValidArgs {
|
|
||||||
// Remove any description that may be included following a tab character.
|
|
||||||
// Descriptions are not supported by bash completion.
|
|
||||||
value = strings.Split(value, "\t")[0]
|
|
||||||
buf.WriteString(fmt.Sprintf(" must_have_one_noun+=(%q)\n", value))
|
|
||||||
}
|
|
||||||
if cmd.ValidArgsFunction != nil {
|
|
||||||
buf.WriteString(" has_completion_function=1\n")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeCmdAliases(buf *bytes.Buffer, cmd *Command) {
|
|
||||||
if len(cmd.Aliases) == 0 {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
sort.Sort(sort.StringSlice(cmd.Aliases))
|
|
||||||
|
|
||||||
buf.WriteString(fmt.Sprint(` if [[ -z "${BASH_VERSION}" || "${BASH_VERSINFO[0]}" -gt 3 ]]; then`, "\n"))
|
|
||||||
for _, value := range cmd.Aliases {
|
|
||||||
buf.WriteString(fmt.Sprintf(" command_aliases+=(%q)\n", value))
|
|
||||||
buf.WriteString(fmt.Sprintf(" aliashash[%q]=%q\n", value, cmd.Name()))
|
|
||||||
}
|
|
||||||
buf.WriteString(` fi`)
|
|
||||||
buf.WriteString("\n")
|
|
||||||
}
|
|
||||||
func writeArgAliases(buf *bytes.Buffer, cmd *Command) {
|
|
||||||
buf.WriteString(" noun_aliases=()\n")
|
|
||||||
sort.Sort(sort.StringSlice(cmd.ArgAliases))
|
|
||||||
for _, value := range cmd.ArgAliases {
|
|
||||||
buf.WriteString(fmt.Sprintf(" noun_aliases+=(%q)\n", value))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func gen(buf *bytes.Buffer, cmd *Command) {
|
|
||||||
for _, c := range cmd.Commands() {
|
|
||||||
if !c.IsAvailableCommand() && c != cmd.helpCommand {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
gen(buf, c)
|
|
||||||
}
|
|
||||||
commandName := cmd.CommandPath()
|
|
||||||
commandName = strings.Replace(commandName, " ", "_", -1)
|
|
||||||
commandName = strings.Replace(commandName, ":", "__", -1)
|
|
||||||
|
|
||||||
if cmd.Root() == cmd {
|
|
||||||
buf.WriteString(fmt.Sprintf("_%s_root_command()\n{\n", commandName))
|
|
||||||
} else {
|
|
||||||
buf.WriteString(fmt.Sprintf("_%s()\n{\n", commandName))
|
|
||||||
}
|
|
||||||
|
|
||||||
buf.WriteString(fmt.Sprintf(" last_command=%q\n", commandName))
|
|
||||||
buf.WriteString("\n")
|
|
||||||
buf.WriteString(" command_aliases=()\n")
|
|
||||||
buf.WriteString("\n")
|
|
||||||
|
|
||||||
writeCommands(buf, cmd)
|
|
||||||
writeFlags(buf, cmd)
|
|
||||||
writeRequiredFlag(buf, cmd)
|
|
||||||
writeRequiredNouns(buf, cmd)
|
|
||||||
writeArgAliases(buf, cmd)
|
|
||||||
buf.WriteString("}\n\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
// GenBashCompletion generates bash completion file and writes to the passed writer.
|
|
||||||
func (c *Command) GenBashCompletion(w io.Writer) error {
|
|
||||||
buf := new(bytes.Buffer)
|
|
||||||
writePreamble(buf, c.Name())
|
|
||||||
if len(c.BashCompletionFunction) > 0 {
|
|
||||||
buf.WriteString(c.BashCompletionFunction + "\n")
|
|
||||||
}
|
|
||||||
gen(buf, c)
|
|
||||||
writePostscript(buf, c.Name())
|
|
||||||
|
|
||||||
_, err := buf.WriteTo(w)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
func nonCompletableFlag(flag *pflag.Flag) bool {
|
|
||||||
return flag.Hidden || len(flag.Deprecated) > 0
|
|
||||||
}
|
|
||||||
|
|
||||||
// GenBashCompletionFile generates bash completion file.
|
|
||||||
func (c *Command) GenBashCompletionFile(filename string) error {
|
|
||||||
outFile, err := os.Create(filename)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
defer outFile.Close()
|
|
||||||
|
|
||||||
return c.GenBashCompletion(outFile)
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -51,6 +51,11 @@ const (
|
||||||
// obtain the same behavior but only for flags.
|
// obtain the same behavior but only for flags.
|
||||||
ShellCompDirectiveFilterDirs
|
ShellCompDirectiveFilterDirs
|
||||||
|
|
||||||
|
// For internal use only.
|
||||||
|
// Used to maintain backwards-compatibility with the legacy bash custom completions.
|
||||||
|
shellCompDirectiveLegacyCustomComp
|
||||||
|
shellCompDirectiveLegacyCustomArgsComp
|
||||||
|
|
||||||
// ===========================================================================
|
// ===========================================================================
|
||||||
|
|
||||||
// All directives using iota should be above this one.
|
// All directives using iota should be above this one.
|
||||||
|
|
@ -94,6 +99,12 @@ func (d ShellCompDirective) string() string {
|
||||||
if d&ShellCompDirectiveFilterDirs != 0 {
|
if d&ShellCompDirectiveFilterDirs != 0 {
|
||||||
directives = append(directives, "ShellCompDirectiveFilterDirs")
|
directives = append(directives, "ShellCompDirectiveFilterDirs")
|
||||||
}
|
}
|
||||||
|
if d&shellCompDirectiveLegacyCustomComp != 0 {
|
||||||
|
directives = append(directives, "shellCompDirectiveLegacyCustomComp")
|
||||||
|
}
|
||||||
|
if d&shellCompDirectiveLegacyCustomArgsComp != 0 {
|
||||||
|
directives = append(directives, "shellCompDirectiveLegacyCustomArgsComp")
|
||||||
|
}
|
||||||
if len(directives) == 0 {
|
if len(directives) == 0 {
|
||||||
directives = append(directives, "ShellCompDirectiveDefault")
|
directives = append(directives, "ShellCompDirectiveDefault")
|
||||||
}
|
}
|
||||||
|
|
@ -149,10 +160,6 @@ func (c *Command) initCompleteCmd(args []string) {
|
||||||
fmt.Fprintln(finalCmd.OutOrStdout(), comp)
|
fmt.Fprintln(finalCmd.OutOrStdout(), comp)
|
||||||
}
|
}
|
||||||
|
|
||||||
if directive >= shellCompDirectiveMaxValue {
|
|
||||||
directive = ShellCompDirectiveDefault
|
|
||||||
}
|
|
||||||
|
|
||||||
// As the last printout, print the completion directive for the completion script to parse.
|
// As the last printout, print the completion directive for the completion script to parse.
|
||||||
// The directive integer must be that last character following a single colon (:).
|
// The directive integer must be that last character following a single colon (:).
|
||||||
// The completion script expects :<directive>
|
// The completion script expects :<directive>
|
||||||
|
|
@ -362,6 +369,10 @@ func (c *Command) getCompletions(args []string) (*Command, []string, ShellCompDi
|
||||||
var comps []string
|
var comps []string
|
||||||
comps, directive = completionFn(finalCmd, finalArgs, toComplete)
|
comps, directive = completionFn(finalCmd, finalArgs, toComplete)
|
||||||
completions = append(completions, comps...)
|
completions = append(completions, comps...)
|
||||||
|
} else {
|
||||||
|
// If there is no Go custom completion defined, check for legacy bash
|
||||||
|
// custom completion to preserve backwards-compatibility
|
||||||
|
completions, directive = checkLegacyCustomCompletion(finalCmd, finalArgs, flag, completions, directive)
|
||||||
}
|
}
|
||||||
|
|
||||||
return finalCmd, completions, directive, nil
|
return finalCmd, completions, directive, nil
|
||||||
|
|
@ -442,7 +453,16 @@ func checkIfFlagCompletion(finalCmd *Command, args []string, lastArg string) (*p
|
||||||
if len(lastArg) > 0 && lastArg[0] == '-' {
|
if len(lastArg) > 0 && lastArg[0] == '-' {
|
||||||
if index := strings.Index(lastArg, "="); index >= 0 {
|
if index := strings.Index(lastArg, "="); index >= 0 {
|
||||||
// Flag with an =
|
// Flag with an =
|
||||||
flagName = strings.TrimLeft(lastArg[:index], "-")
|
if strings.HasPrefix(lastArg[:index], "--") {
|
||||||
|
// Flag has full name
|
||||||
|
flagName = lastArg[2:index]
|
||||||
|
} else {
|
||||||
|
// Flag is shorthand
|
||||||
|
// We have to get the last shorthand flag name
|
||||||
|
// e.g. `-asd` => d to provide the correct completion
|
||||||
|
// https://github.com/spf13/cobra/issues/1257
|
||||||
|
flagName = lastArg[index-1 : index]
|
||||||
|
}
|
||||||
lastArg = lastArg[index+1:]
|
lastArg = lastArg[index+1:]
|
||||||
flagWithEqual = true
|
flagWithEqual = true
|
||||||
} else {
|
} else {
|
||||||
|
|
@ -459,8 +479,16 @@ func checkIfFlagCompletion(finalCmd *Command, args []string, lastArg string) (*p
|
||||||
// If the flag contains an = it means it has already been fully processed,
|
// If the flag contains an = it means it has already been fully processed,
|
||||||
// so we don't need to deal with it here.
|
// so we don't need to deal with it here.
|
||||||
if index := strings.Index(prevArg, "="); index < 0 {
|
if index := strings.Index(prevArg, "="); index < 0 {
|
||||||
flagName = strings.TrimLeft(prevArg, "-")
|
if strings.HasPrefix(prevArg, "--") {
|
||||||
|
// Flag has full name
|
||||||
|
flagName = prevArg[2:]
|
||||||
|
} else {
|
||||||
|
// Flag is shorthand
|
||||||
|
// We have to get the last shorthand flag name
|
||||||
|
// e.g. `-asd` => d to provide the correct completion
|
||||||
|
// https://github.com/spf13/cobra/issues/1257
|
||||||
|
flagName = prevArg[len(prevArg)-1:]
|
||||||
|
}
|
||||||
// Remove the uncompleted flag or else there could be an error created
|
// Remove the uncompleted flag or else there could be an error created
|
||||||
// for an invalid value for that flag
|
// for an invalid value for that flag
|
||||||
trimmedArgs = args[:len(args)-1]
|
trimmedArgs = args[:len(args)-1]
|
||||||
|
|
@ -513,6 +541,65 @@ func findFlag(cmd *Command, name string) *pflag.Flag {
|
||||||
return cmd.Flag(name)
|
return cmd.Flag(name)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func nonCompletableFlag(flag *pflag.Flag) bool {
|
||||||
|
return flag.Hidden || len(flag.Deprecated) > 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// This function checks if legacy bash custom completion should be performed and if so,
|
||||||
|
// it provides the shell script with the necessary information.
|
||||||
|
func checkLegacyCustomCompletion(cmd *Command, args []string, flag *pflag.Flag, completions []string, directive ShellCompDirective) ([]string, ShellCompDirective) {
|
||||||
|
// Check if any legacy custom completion is defined for the program
|
||||||
|
if len(cmd.Root().BashCompletionFunction) > 0 {
|
||||||
|
// Legacy custom completion is only triggered if no other completions were found.
|
||||||
|
if len(completions) == 0 {
|
||||||
|
if flag != nil {
|
||||||
|
// For legacy custom flag completion, we must let the script know the bash
|
||||||
|
// functions it should call based on the content of the annotation BashCompCustom.
|
||||||
|
if values, present := flag.Annotations[BashCompCustom]; present {
|
||||||
|
if len(values) > 0 {
|
||||||
|
handlers := strings.Join(values, "; ")
|
||||||
|
// We send the commands to set the shell variables that are needed
|
||||||
|
// for legacy custom completions followed by the functions to call
|
||||||
|
// to perform the actual flag completion
|
||||||
|
completions = append(prepareLegacyCustomCompletionVars(cmd, args), handlers)
|
||||||
|
directive = directive | shellCompDirectiveLegacyCustomComp
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Check if the legacy custom_func is defined.
|
||||||
|
// This check will work for both "__custom_func" and "__<program>_custom_func".
|
||||||
|
// This could happen if the program defined some functions for legacy flag completion
|
||||||
|
// but not the legacy custom_func.
|
||||||
|
if strings.Contains(cmd.Root().BashCompletionFunction, "_custom_func") {
|
||||||
|
// For legacy args completion, the script already knows what to call
|
||||||
|
// so we only need to tell it the commands to set the shell variables needed
|
||||||
|
completions = prepareLegacyCustomCompletionVars(cmd, args)
|
||||||
|
directive = directive | shellCompDirectiveLegacyCustomComp | shellCompDirectiveLegacyCustomArgsComp
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return completions, directive
|
||||||
|
}
|
||||||
|
|
||||||
|
// The original bash completion script had some shell variables that are used by legacy bash
|
||||||
|
// custom completions. Let's set those variables to allow those legacy custom completions
|
||||||
|
// to continue working.
|
||||||
|
func prepareLegacyCustomCompletionVars(cmd *Command, args []string) []string {
|
||||||
|
var compVarCmds []string
|
||||||
|
|
||||||
|
// "last_command" variable
|
||||||
|
commandName := cmd.CommandPath()
|
||||||
|
commandName = strings.Replace(commandName, " ", "_", -1)
|
||||||
|
commandName = strings.Replace(commandName, ":", "__", -1)
|
||||||
|
compVarCmds = append(compVarCmds, fmt.Sprintf("last_command=%s", commandName))
|
||||||
|
|
||||||
|
// "nouns" array variable
|
||||||
|
compVarCmds = append(compVarCmds, fmt.Sprintf("nouns=(%s)", strings.Join(args, " ")))
|
||||||
|
|
||||||
|
return compVarCmds
|
||||||
|
}
|
||||||
|
|
||||||
// CompDebug prints the specified string to the same file as where the
|
// CompDebug prints the specified string to the same file as where the
|
||||||
// completion script prints its logs.
|
// completion script prints its logs.
|
||||||
// Note that completion printouts should never be on stdout as they would
|
// Note that completion printouts should never be on stdout as they would
|
||||||
|
|
|
||||||
|
|
@ -28,9 +28,9 @@ function __%[1]s_debug
|
||||||
end
|
end
|
||||||
|
|
||||||
function __%[1]s_perform_completion
|
function __%[1]s_perform_completion
|
||||||
__%[1]s_debug "Starting __%[1]s_perform_completion with: $argv"
|
__%[1]s_debug "Starting __%[1]s_perform_completion"
|
||||||
|
|
||||||
set args (string split -- " " "$argv")
|
set args (string split -- " " (commandline -c))
|
||||||
set lastArg "$args[-1]"
|
set lastArg "$args[-1]"
|
||||||
|
|
||||||
__%[1]s_debug "args: $args"
|
__%[1]s_debug "args: $args"
|
||||||
|
|
@ -71,31 +71,22 @@ function __%[1]s_perform_completion
|
||||||
printf "%%s\n" "$directiveLine"
|
printf "%%s\n" "$directiveLine"
|
||||||
end
|
end
|
||||||
|
|
||||||
# This function does three things:
|
# This function does two things:
|
||||||
# 1- Obtain the completions and store them in the global __%[1]s_comp_results
|
# - Obtain the completions and store them in the global __%[1]s_comp_results
|
||||||
# 2- Set the __%[1]s_comp_do_file_comp flag if file completion should be performed
|
# - Return false if file completion should be performed
|
||||||
# and unset it otherwise
|
|
||||||
# 3- Return true if the completion results are not empty
|
|
||||||
function __%[1]s_prepare_completions
|
function __%[1]s_prepare_completions
|
||||||
|
__%[1]s_debug ""
|
||||||
|
__%[1]s_debug "========= starting completion logic =========="
|
||||||
|
|
||||||
# Start fresh
|
# Start fresh
|
||||||
set --erase __%[1]s_comp_do_file_comp
|
|
||||||
set --erase __%[1]s_comp_results
|
set --erase __%[1]s_comp_results
|
||||||
|
|
||||||
# Check if the command-line is already provided. This is useful for testing.
|
set results (__%[1]s_perform_completion)
|
||||||
if not set --query __%[1]s_comp_commandLine
|
|
||||||
# Use the -c flag to allow for completion in the middle of the line
|
|
||||||
set __%[1]s_comp_commandLine (commandline -c)
|
|
||||||
end
|
|
||||||
__%[1]s_debug "commandLine is: $__%[1]s_comp_commandLine"
|
|
||||||
|
|
||||||
set results (__%[1]s_perform_completion "$__%[1]s_comp_commandLine")
|
|
||||||
set --erase __%[1]s_comp_commandLine
|
|
||||||
__%[1]s_debug "Completion results: $results"
|
__%[1]s_debug "Completion results: $results"
|
||||||
|
|
||||||
if test -z "$results"
|
if test -z "$results"
|
||||||
__%[1]s_debug "No completion, probably due to a failure"
|
__%[1]s_debug "No completion, probably due to a failure"
|
||||||
# Might as well do file completion, in case it helps
|
# Might as well do file completion, in case it helps
|
||||||
set --global __%[1]s_comp_do_file_comp 1
|
|
||||||
return 1
|
return 1
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
@ -110,6 +101,8 @@ function __%[1]s_prepare_completions
|
||||||
set shellCompDirectiveNoFileComp %[6]d
|
set shellCompDirectiveNoFileComp %[6]d
|
||||||
set shellCompDirectiveFilterFileExt %[7]d
|
set shellCompDirectiveFilterFileExt %[7]d
|
||||||
set shellCompDirectiveFilterDirs %[8]d
|
set shellCompDirectiveFilterDirs %[8]d
|
||||||
|
set shellCompDirectiveLegacyCustomComp %[9]d
|
||||||
|
set shellCompDirectiveLegacyCustomArgsComp %[10]d
|
||||||
|
|
||||||
if test -z "$directive"
|
if test -z "$directive"
|
||||||
set directive 0
|
set directive 0
|
||||||
|
|
@ -119,6 +112,14 @@ function __%[1]s_prepare_completions
|
||||||
if test $compErr -eq 1
|
if test $compErr -eq 1
|
||||||
__%[1]s_debug "Received error directive: aborting."
|
__%[1]s_debug "Received error directive: aborting."
|
||||||
# Might as well do file completion, in case it helps
|
# Might as well do file completion, in case it helps
|
||||||
|
return 1
|
||||||
|
end
|
||||||
|
|
||||||
|
set legacyCustom (math (math --scale 0 $directive / $shellCompDirectiveLegacyCustomComp) %% 2)
|
||||||
|
set legacyCustomArgs (math (math --scale 0 $directive / $shellCompDirectiveLegacyCustomArgsComp) %% 2)
|
||||||
|
if test $legacyCustom -eq 1; or test $legacyCustomArgs -eq 1
|
||||||
|
__%[1]s_debug "Legacy bash custom completion not applicable to fish"
|
||||||
|
# Do full file completion instead
|
||||||
set --global __%[1]s_comp_do_file_comp 1
|
set --global __%[1]s_comp_do_file_comp 1
|
||||||
return 1
|
return 1
|
||||||
end
|
end
|
||||||
|
|
@ -128,7 +129,6 @@ function __%[1]s_prepare_completions
|
||||||
if test $filefilter -eq 1; or test $dirfilter -eq 1
|
if test $filefilter -eq 1; or test $dirfilter -eq 1
|
||||||
__%[1]s_debug "File extension filtering or directory filtering not supported"
|
__%[1]s_debug "File extension filtering or directory filtering not supported"
|
||||||
# Do full file completion instead
|
# Do full file completion instead
|
||||||
set --global __%[1]s_comp_do_file_comp 1
|
|
||||||
return 1
|
return 1
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
@ -137,6 +137,24 @@ function __%[1]s_prepare_completions
|
||||||
|
|
||||||
__%[1]s_debug "nospace: $nospace, nofiles: $nofiles"
|
__%[1]s_debug "nospace: $nospace, nofiles: $nofiles"
|
||||||
|
|
||||||
|
# If we want to prevent a space, or if file completion is NOT disabled,
|
||||||
|
# we need to count the number of valid completions.
|
||||||
|
# To do so, we will filter on prefix as the completions we have received
|
||||||
|
# may not already be filtered so as to allow fish to match on different
|
||||||
|
# criteria than prefix.
|
||||||
|
if test $nospace -ne 0; or test $nofiles -eq 0
|
||||||
|
set prefix (commandline -t)
|
||||||
|
__%[1]s_debug "prefix: $prefix"
|
||||||
|
|
||||||
|
set completions
|
||||||
|
for comp in $__%[1]s_comp_results
|
||||||
|
if test (string match -e -r "^$prefix" "$comp")
|
||||||
|
set -a completions $comp
|
||||||
|
end
|
||||||
|
end
|
||||||
|
set --global __%[1]s_comp_results $completions
|
||||||
|
__%[1]s_debug "Filtered completions are: $__%[1]s_comp_results"
|
||||||
|
|
||||||
# Important not to quote the variable for count to work
|
# Important not to quote the variable for count to work
|
||||||
set numComps (count $__%[1]s_comp_results)
|
set numComps (count $__%[1]s_comp_results)
|
||||||
__%[1]s_debug "numComps: $numComps"
|
__%[1]s_debug "numComps: $numComps"
|
||||||
|
|
@ -144,20 +162,26 @@ function __%[1]s_prepare_completions
|
||||||
if test $numComps -eq 1; and test $nospace -ne 0
|
if test $numComps -eq 1; and test $nospace -ne 0
|
||||||
# To support the "nospace" directive we trick the shell
|
# To support the "nospace" directive we trick the shell
|
||||||
# by outputting an extra, longer completion.
|
# by outputting an extra, longer completion.
|
||||||
|
# We must first split on \t to get rid of the descriptions because
|
||||||
|
# the extra character we add to the fake second completion must be
|
||||||
|
# before the description. We don't need descriptions anyway since
|
||||||
|
# there is only a single real completion which the shell will expand
|
||||||
|
# immediately.
|
||||||
__%[1]s_debug "Adding second completion to perform nospace directive"
|
__%[1]s_debug "Adding second completion to perform nospace directive"
|
||||||
set --append __%[1]s_comp_results $__%[1]s_comp_results[1].
|
set split (string split --max 1 \t $__%[1]s_comp_results[1])
|
||||||
|
set --global __%[1]s_comp_results $split[1] $split[1].
|
||||||
|
__%[1]s_debug "Completions are now: $__%[1]s_comp_results"
|
||||||
end
|
end
|
||||||
|
|
||||||
if test $numComps -eq 0; and test $nofiles -eq 0
|
if test $numComps -eq 0; and test $nofiles -eq 0
|
||||||
|
# To be consistent with bash and zsh, we only trigger file
|
||||||
|
# completion when there are no other completions
|
||||||
__%[1]s_debug "Requesting file completion"
|
__%[1]s_debug "Requesting file completion"
|
||||||
set --global __%[1]s_comp_do_file_comp 1
|
return 1
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# If we don't want file completion, we must return true even if there
|
return 0
|
||||||
# are no completions found. This is because fish will perform the last
|
|
||||||
# completion command, even if its condition is false, if no other
|
|
||||||
# completion command was triggered
|
|
||||||
return (not set --query __%[1]s_comp_do_file_comp)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Since Fish completions are only loaded once the user triggers them, we trigger them ourselves
|
# Since Fish completions are only loaded once the user triggers them, we trigger them ourselves
|
||||||
|
|
@ -170,21 +194,14 @@ complete --do-complete "%[2]s " > /dev/null 2>&1
|
||||||
# Remove any pre-existing completions for the program since we will be handling all of them.
|
# Remove any pre-existing completions for the program since we will be handling all of them.
|
||||||
complete -c %[2]s -e
|
complete -c %[2]s -e
|
||||||
|
|
||||||
# The order in which the below two lines are defined is very important so that __%[1]s_prepare_completions
|
# The call to __%[1]s_prepare_completions will setup __%[1]s_comp_results
|
||||||
# is called first. It is __%[1]s_prepare_completions that sets up the __%[1]s_comp_do_file_comp variable.
|
# which provides the program's completion choices.
|
||||||
#
|
|
||||||
# This completion will be run second as complete commands are added FILO.
|
|
||||||
# It triggers file completion choices when __%[1]s_comp_do_file_comp is set.
|
|
||||||
complete -c %[2]s -n 'set --query __%[1]s_comp_do_file_comp'
|
|
||||||
|
|
||||||
# This completion will be run first as complete commands are added FILO.
|
|
||||||
# The call to __%[1]s_prepare_completions will setup both __%[1]s_comp_results and __%[1]s_comp_do_file_comp.
|
|
||||||
# It provides the program's completion choices.
|
|
||||||
complete -c %[2]s -n '__%[1]s_prepare_completions' -f -a '$__%[1]s_comp_results'
|
complete -c %[2]s -n '__%[1]s_prepare_completions' -f -a '$__%[1]s_comp_results'
|
||||||
|
|
||||||
`, nameForVar, name, compCmd,
|
`, nameForVar, name, compCmd,
|
||||||
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
||||||
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs))
|
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs,
|
||||||
|
shellCompDirectiveLegacyCustomComp, shellCompDirectiveLegacyCustomArgsComp))
|
||||||
}
|
}
|
||||||
|
|
||||||
// GenFishCompletion generates fish completion file and writes to the passed writer.
|
// GenFishCompletion generates fish completion file and writes to the passed writer.
|
||||||
|
|
|
||||||
|
|
@ -94,8 +94,10 @@ _%[1]s()
|
||||||
local shellCompDirectiveNoFileComp=%[5]d
|
local shellCompDirectiveNoFileComp=%[5]d
|
||||||
local shellCompDirectiveFilterFileExt=%[6]d
|
local shellCompDirectiveFilterFileExt=%[6]d
|
||||||
local shellCompDirectiveFilterDirs=%[7]d
|
local shellCompDirectiveFilterDirs=%[7]d
|
||||||
|
local shellCompDirectiveLegacyCustomComp=%[8]d
|
||||||
|
local shellCompDirectiveLegacyCustomArgsComp=%[9]d
|
||||||
|
|
||||||
local lastParam lastChar flagPrefix requestComp out directive compCount comp lastComp
|
local lastParam lastChar flagPrefix requestComp out directive comp lastComp noSpace
|
||||||
local -a completions
|
local -a completions
|
||||||
|
|
||||||
__%[1]s_debug "\n========= starting completion logic =========="
|
__%[1]s_debug "\n========= starting completion logic =========="
|
||||||
|
|
@ -163,7 +165,6 @@ _%[1]s()
|
||||||
return
|
return
|
||||||
fi
|
fi
|
||||||
|
|
||||||
compCount=0
|
|
||||||
while IFS='\n' read -r comp; do
|
while IFS='\n' read -r comp; do
|
||||||
if [ -n "$comp" ]; then
|
if [ -n "$comp" ]; then
|
||||||
# If requested, completions are returned with a description.
|
# If requested, completions are returned with a description.
|
||||||
|
|
@ -175,13 +176,17 @@ _%[1]s()
|
||||||
local tab=$(printf '\t')
|
local tab=$(printf '\t')
|
||||||
comp=${comp//$tab/:}
|
comp=${comp//$tab/:}
|
||||||
|
|
||||||
((compCount++))
|
|
||||||
__%[1]s_debug "Adding completion: ${comp}"
|
__%[1]s_debug "Adding completion: ${comp}"
|
||||||
completions+=${comp}
|
completions+=${comp}
|
||||||
lastComp=$comp
|
lastComp=$comp
|
||||||
fi
|
fi
|
||||||
done < <(printf "%%s\n" "${out[@]}")
|
done < <(printf "%%s\n" "${out[@]}")
|
||||||
|
|
||||||
|
if [ $((directive & shellCompDirectiveNoSpace)) -ne 0 ]; then
|
||||||
|
__%[1]s_debug "Activating nospace."
|
||||||
|
noSpace="-S ''"
|
||||||
|
fi
|
||||||
|
|
||||||
if [ $((directive & shellCompDirectiveFilterFileExt)) -ne 0 ]; then
|
if [ $((directive & shellCompDirectiveFilterFileExt)) -ne 0 ]; then
|
||||||
# File extension filtering
|
# File extension filtering
|
||||||
local filteringCmd
|
local filteringCmd
|
||||||
|
|
@ -208,25 +213,40 @@ _%[1]s()
|
||||||
__%[1]s_debug "Listing directories in ."
|
__%[1]s_debug "Listing directories in ."
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
local result
|
||||||
_arguments '*:dirname:_files -/'" ${flagPrefix}"
|
_arguments '*:dirname:_files -/'" ${flagPrefix}"
|
||||||
|
result=$?
|
||||||
if [ -n "$subdir" ]; then
|
if [ -n "$subdir" ]; then
|
||||||
popd >/dev/null 2>&1
|
popd >/dev/null 2>&1
|
||||||
fi
|
fi
|
||||||
elif [ $((directive & shellCompDirectiveNoSpace)) -ne 0 ] && [ ${compCount} -eq 1 ]; then
|
return $result
|
||||||
__%[1]s_debug "Activating nospace."
|
else
|
||||||
# We can use compadd here as there is no description when
|
__%[1]s_debug "Calling _describe"
|
||||||
# there is only one completion.
|
if eval _describe "completions" completions $flagPrefix $noSpace; then
|
||||||
compadd -S '' "${lastComp}"
|
__%[1]s_debug "_describe found some completions"
|
||||||
elif [ ${compCount} -eq 0 ]; then
|
|
||||||
|
# Return the success of having called _describe
|
||||||
|
return 0
|
||||||
|
else
|
||||||
|
__%[1]s_debug "_describe did not find completions."
|
||||||
|
__%[1]s_debug "Checking if we should do file completion."
|
||||||
if [ $((directive & shellCompDirectiveNoFileComp)) -ne 0 ]; then
|
if [ $((directive & shellCompDirectiveNoFileComp)) -ne 0 ]; then
|
||||||
__%[1]s_debug "deactivating file completion"
|
__%[1]s_debug "deactivating file completion"
|
||||||
|
|
||||||
|
# We must return an error code here to let zsh know that there were no
|
||||||
|
# completions found by _describe; this is what will trigger other
|
||||||
|
# matching algorithms to attempt to find completions.
|
||||||
|
# For example zsh can match letters in the middle of words.
|
||||||
|
return 1
|
||||||
else
|
else
|
||||||
# Perform file completion
|
# Perform file completion
|
||||||
__%[1]s_debug "activating file completion"
|
__%[1]s_debug "Activating file completion"
|
||||||
|
|
||||||
|
# We must return the result of this command, so it must be the
|
||||||
|
# last command, or else we must store its result to return it.
|
||||||
_arguments '*:filename:_files'" ${flagPrefix}"
|
_arguments '*:filename:_files'" ${flagPrefix}"
|
||||||
fi
|
fi
|
||||||
else
|
fi
|
||||||
_describe "completions" completions $(echo $flagPrefix)
|
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -236,5 +256,6 @@ if [ "$funcstack[1]" = "_%[1]s" ]; then
|
||||||
fi
|
fi
|
||||||
`, name, compCmd,
|
`, name, compCmd,
|
||||||
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
||||||
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs))
|
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs,
|
||||||
|
shellCompDirectiveLegacyCustomComp, shellCompDirectiveLegacyCustomArgsComp))
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -13,3 +13,7 @@ coverage:
|
||||||
if_not_found: success # if parent is not found report status as success, error, or failure
|
if_not_found: success # if parent is not found report status as success, error, or failure
|
||||||
if_ci_failed: error # if ci fails report status as success, error, or failure
|
if_ci_failed: error # if ci fails report status as success, error, or failure
|
||||||
|
|
||||||
|
# Also update COVER_IGNORE_PKGS in the Makefile.
|
||||||
|
ignore:
|
||||||
|
- /internal/gen-atomicint/
|
||||||
|
- /internal/gen-valuewrapper/
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
|
/bin
|
||||||
.DS_Store
|
.DS_Store
|
||||||
/vendor
|
/vendor
|
||||||
/cover
|
cover.html
|
||||||
cover.out
|
cover.out
|
||||||
lint.log
|
lint.log
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,26 +2,26 @@ sudo: false
|
||||||
language: go
|
language: go
|
||||||
go_import_path: go.uber.org/atomic
|
go_import_path: go.uber.org/atomic
|
||||||
|
|
||||||
go:
|
env:
|
||||||
- 1.11.x
|
global:
|
||||||
- 1.12.x
|
- GO111MODULE=on
|
||||||
|
|
||||||
matrix:
|
matrix:
|
||||||
include:
|
include:
|
||||||
- go: 1.12.x
|
- go: oldstable
|
||||||
env: NO_TEST=yes LINT=yes
|
- go: stable
|
||||||
|
env: LINT=1
|
||||||
|
|
||||||
cache:
|
cache:
|
||||||
directories:
|
directories:
|
||||||
- vendor
|
- vendor
|
||||||
|
|
||||||
install:
|
before_install:
|
||||||
- make install_ci
|
- go version
|
||||||
|
|
||||||
script:
|
script:
|
||||||
- test -n "$NO_TEST" || make test_ci
|
- test -z "$LINT" || make lint
|
||||||
- test -n "$NO_TEST" || scripts/test-ubergo.sh
|
- make cover
|
||||||
- test -z "$LINT" || make install_lint lint
|
|
||||||
|
|
||||||
after_success:
|
after_success:
|
||||||
- bash <(curl -s https://codecov.io/bash)
|
- bash <(curl -s https://codecov.io/bash)
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,76 @@
|
||||||
|
# Changelog
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [1.7.0] - 2020-09-14
|
||||||
|
### Added
|
||||||
|
- Support JSON serialization and deserialization of primitive atomic types.
|
||||||
|
- Support Text marshalling and unmarshalling for string atomics.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Disallow incorrect comparison of atomic values in a non-atomic way.
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
- Remove dependency on `golang.org/x/{lint, tools}`.
|
||||||
|
|
||||||
|
## [1.6.0] - 2020-02-24
|
||||||
|
### Changed
|
||||||
|
- Drop library dependency on `golang.org/x/{lint, tools}`.
|
||||||
|
|
||||||
|
## [1.5.1] - 2019-11-19
|
||||||
|
- Fix bug where `Bool.CAS` and `Bool.Toggle` do work correctly together
|
||||||
|
causing `CAS` to fail even though the old value matches.
|
||||||
|
|
||||||
|
## [1.5.0] - 2019-10-29
|
||||||
|
### Changed
|
||||||
|
- With Go modules, only the `go.uber.org/atomic` import path is supported now.
|
||||||
|
If you need to use the old import path, please add a `replace` directive to
|
||||||
|
your `go.mod`.
|
||||||
|
|
||||||
|
## [1.4.0] - 2019-05-01
|
||||||
|
### Added
|
||||||
|
- Add `atomic.Error` type for atomic operations on `error` values.
|
||||||
|
|
||||||
|
## [1.3.2] - 2018-05-02
|
||||||
|
### Added
|
||||||
|
- Add `atomic.Duration` type for atomic operations on `time.Duration` values.
|
||||||
|
|
||||||
|
## [1.3.1] - 2017-11-14
|
||||||
|
### Fixed
|
||||||
|
- Revert optimization for `atomic.String.Store("")` which caused data races.
|
||||||
|
|
||||||
|
## [1.3.0] - 2017-11-13
|
||||||
|
### Added
|
||||||
|
- Add `atomic.Bool.CAS` for compare-and-swap semantics on bools.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Optimize `atomic.String.Store("")` by avoiding an allocation.
|
||||||
|
|
||||||
|
## [1.2.0] - 2017-04-12
|
||||||
|
### Added
|
||||||
|
- Shadow `atomic.Value` from `sync/atomic`.
|
||||||
|
|
||||||
|
## [1.1.0] - 2017-03-10
|
||||||
|
### Added
|
||||||
|
- Add atomic `Float64` type.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Support new `go.uber.org/atomic` import path.
|
||||||
|
|
||||||
|
## [1.0.0] - 2016-07-18
|
||||||
|
|
||||||
|
- Initial release.
|
||||||
|
|
||||||
|
[1.7.0]: https://github.com/uber-go/atomic/compare/v1.6.0...v1.7.0
|
||||||
|
[1.6.0]: https://github.com/uber-go/atomic/compare/v1.5.1...v1.6.0
|
||||||
|
[1.5.1]: https://github.com/uber-go/atomic/compare/v1.5.0...v1.5.1
|
||||||
|
[1.5.0]: https://github.com/uber-go/atomic/compare/v1.4.0...v1.5.0
|
||||||
|
[1.4.0]: https://github.com/uber-go/atomic/compare/v1.3.2...v1.4.0
|
||||||
|
[1.3.2]: https://github.com/uber-go/atomic/compare/v1.3.1...v1.3.2
|
||||||
|
[1.3.1]: https://github.com/uber-go/atomic/compare/v1.3.0...v1.3.1
|
||||||
|
[1.3.0]: https://github.com/uber-go/atomic/compare/v1.2.0...v1.3.0
|
||||||
|
[1.2.0]: https://github.com/uber-go/atomic/compare/v1.1.0...v1.2.0
|
||||||
|
[1.1.0]: https://github.com/uber-go/atomic/compare/v1.0.0...v1.1.0
|
||||||
|
[1.0.0]: https://github.com/uber-go/atomic/releases/tag/v1.0.0
|
||||||
|
|
@ -1,51 +1,78 @@
|
||||||
# Many Go tools take file globs or directories as arguments instead of packages.
|
# Directory to place `go install`ed binaries into.
|
||||||
PACKAGE_FILES ?= *.go
|
export GOBIN ?= $(shell pwd)/bin
|
||||||
|
|
||||||
# For pre go1.6
|
GOLINT = $(GOBIN)/golint
|
||||||
export GO15VENDOREXPERIMENT=1
|
GEN_ATOMICINT = $(GOBIN)/gen-atomicint
|
||||||
|
GEN_ATOMICWRAPPER = $(GOBIN)/gen-atomicwrapper
|
||||||
|
STATICCHECK = $(GOBIN)/staticcheck
|
||||||
|
|
||||||
|
GO_FILES ?= $(shell find . '(' -path .git -o -path vendor ')' -prune -o -name '*.go' -print)
|
||||||
|
|
||||||
|
# Also update ignore section in .codecov.yml.
|
||||||
|
COVER_IGNORE_PKGS = \
|
||||||
|
go.uber.org/atomic/internal/gen-atomicint \
|
||||||
|
go.uber.org/atomic/internal/gen-atomicwrapper
|
||||||
|
|
||||||
.PHONY: build
|
.PHONY: build
|
||||||
build:
|
build:
|
||||||
go build -i ./...
|
go build ./...
|
||||||
|
|
||||||
|
|
||||||
.PHONY: install
|
|
||||||
install:
|
|
||||||
glide --version || go get github.com/Masterminds/glide
|
|
||||||
glide install
|
|
||||||
|
|
||||||
|
|
||||||
.PHONY: test
|
.PHONY: test
|
||||||
test:
|
test:
|
||||||
go test -cover -race ./...
|
go test -race ./...
|
||||||
|
|
||||||
|
.PHONY: gofmt
|
||||||
|
gofmt:
|
||||||
|
$(eval FMT_LOG := $(shell mktemp -t gofmt.XXXXX))
|
||||||
|
gofmt -e -s -l $(GO_FILES) > $(FMT_LOG) || true
|
||||||
|
@[ ! -s "$(FMT_LOG)" ] || (echo "gofmt failed:" && cat $(FMT_LOG) && false)
|
||||||
|
|
||||||
.PHONY: install_ci
|
$(GOLINT):
|
||||||
install_ci: install
|
cd tools && go install golang.org/x/lint/golint
|
||||||
go get github.com/wadey/gocovmerge
|
|
||||||
go get github.com/mattn/goveralls
|
|
||||||
go get golang.org/x/tools/cmd/cover
|
|
||||||
|
|
||||||
.PHONY: install_lint
|
$(STATICCHECK):
|
||||||
install_lint:
|
cd tools && go install honnef.co/go/tools/cmd/staticcheck
|
||||||
go get golang.org/x/lint/golint
|
|
||||||
|
|
||||||
|
$(GEN_ATOMICWRAPPER): $(wildcard ./internal/gen-atomicwrapper/*)
|
||||||
|
go build -o $@ ./internal/gen-atomicwrapper
|
||||||
|
|
||||||
|
$(GEN_ATOMICINT): $(wildcard ./internal/gen-atomicint/*)
|
||||||
|
go build -o $@ ./internal/gen-atomicint
|
||||||
|
|
||||||
|
.PHONY: golint
|
||||||
|
golint: $(GOLINT)
|
||||||
|
$(GOLINT) ./...
|
||||||
|
|
||||||
|
.PHONY: staticcheck
|
||||||
|
staticcheck: $(STATICCHECK)
|
||||||
|
$(STATICCHECK) ./...
|
||||||
|
|
||||||
.PHONY: lint
|
.PHONY: lint
|
||||||
lint:
|
lint: gofmt golint staticcheck generatenodirty
|
||||||
@rm -rf lint.log
|
|
||||||
@echo "Checking formatting..."
|
|
||||||
@gofmt -d -s $(PACKAGE_FILES) 2>&1 | tee lint.log
|
|
||||||
@echo "Checking vet..."
|
|
||||||
@go vet ./... 2>&1 | tee -a lint.log;)
|
|
||||||
@echo "Checking lint..."
|
|
||||||
@golint $$(go list ./...) 2>&1 | tee -a lint.log
|
|
||||||
@echo "Checking for unresolved FIXMEs..."
|
|
||||||
@git grep -i fixme | grep -v -e vendor -e Makefile | tee -a lint.log
|
|
||||||
@[ ! -s lint.log ]
|
|
||||||
|
|
||||||
|
# comma separated list of packages to consider for code coverage.
|
||||||
|
COVER_PKG = $(shell \
|
||||||
|
go list -find ./... | \
|
||||||
|
grep -v $(foreach pkg,$(COVER_IGNORE_PKGS),-e "^$(pkg)$$") | \
|
||||||
|
paste -sd, -)
|
||||||
|
|
||||||
.PHONY: test_ci
|
.PHONY: cover
|
||||||
test_ci: install_ci build
|
cover:
|
||||||
./scripts/cover.sh $(shell go list $(PACKAGES))
|
go test -coverprofile=cover.out -coverpkg $(COVER_PKG) -v ./...
|
||||||
|
go tool cover -html=cover.out -o cover.html
|
||||||
|
|
||||||
|
.PHONY: generate
|
||||||
|
generate: $(GEN_ATOMICINT) $(GEN_ATOMICWRAPPER)
|
||||||
|
go generate ./...
|
||||||
|
|
||||||
|
.PHONY: generatenodirty
|
||||||
|
generatenodirty:
|
||||||
|
@[ -z "$$(git status --porcelain)" ] || ( \
|
||||||
|
echo "Working tree is dirty. Commit your changes first."; \
|
||||||
|
exit 1 )
|
||||||
|
@make generate
|
||||||
|
@status=$$(git status --porcelain); \
|
||||||
|
[ -z "$$status" ] || ( \
|
||||||
|
echo "Working tree is dirty after `make generate`:"; \
|
||||||
|
echo "$$status"; \
|
||||||
|
echo "Please ensure that the generated code is up-to-date." )
|
||||||
|
|
|
||||||
|
|
@ -3,9 +3,34 @@
|
||||||
Simple wrappers for primitive types to enforce atomic access.
|
Simple wrappers for primitive types to enforce atomic access.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
`go get -u go.uber.org/atomic`
|
|
||||||
|
```shell
|
||||||
|
$ go get -u go.uber.org/atomic@v1
|
||||||
|
```
|
||||||
|
|
||||||
|
### Legacy Import Path
|
||||||
|
|
||||||
|
As of v1.5.0, the import path `go.uber.org/atomic` is the only supported way
|
||||||
|
of using this package. If you are using Go modules, this package will fail to
|
||||||
|
compile with the legacy import path path `github.com/uber-go/atomic`.
|
||||||
|
|
||||||
|
We recommend migrating your code to the new import path but if you're unable
|
||||||
|
to do so, or if your dependencies are still using the old import path, you
|
||||||
|
will have to add a `replace` directive to your `go.mod` file downgrading the
|
||||||
|
legacy import path to an older version.
|
||||||
|
|
||||||
|
```
|
||||||
|
replace github.com/uber-go/atomic => github.com/uber-go/atomic v1.4.0
|
||||||
|
```
|
||||||
|
|
||||||
|
You can do so automatically by running the following command.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
$ go mod edit -replace github.com/uber-go/atomic=github.com/uber-go/atomic@v1.4.0
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
The standard library's `sync/atomic` is powerful, but it's easy to forget which
|
The standard library's `sync/atomic` is powerful, but it's easy to forget which
|
||||||
variables must be accessed atomically. `go.uber.org/atomic` preserves all the
|
variables must be accessed atomically. `go.uber.org/atomic` preserves all the
|
||||||
functionality of the standard library, but wraps the primitive types to
|
functionality of the standard library, but wraps the primitive types to
|
||||||
|
|
@ -21,9 +46,11 @@ atom.CAS(40, 11)
|
||||||
See the [documentation][doc] for a complete API specification.
|
See the [documentation][doc] for a complete API specification.
|
||||||
|
|
||||||
## Development Status
|
## Development Status
|
||||||
|
|
||||||
Stable.
|
Stable.
|
||||||
|
|
||||||
___
|
---
|
||||||
|
|
||||||
Released under the [MIT License](LICENSE.txt).
|
Released under the [MIT License](LICENSE.txt).
|
||||||
|
|
||||||
[doc-img]: https://godoc.org/github.com/uber-go/atomic?status.svg
|
[doc-img]: https://godoc.org/github.com/uber-go/atomic?status.svg
|
||||||
|
|
|
||||||
|
|
@ -1,351 +0,0 @@
|
||||||
// Copyright (c) 2016 Uber Technologies, Inc.
|
|
||||||
//
|
|
||||||
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
// of this software and associated documentation files (the "Software"), to deal
|
|
||||||
// in the Software without restriction, including without limitation the rights
|
|
||||||
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
// copies of the Software, and to permit persons to whom the Software is
|
|
||||||
// furnished to do so, subject to the following conditions:
|
|
||||||
//
|
|
||||||
// The above copyright notice and this permission notice shall be included in
|
|
||||||
// all copies or substantial portions of the Software.
|
|
||||||
//
|
|
||||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
// 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.
|
|
||||||
|
|
||||||
// Package atomic provides simple wrappers around numerics to enforce atomic
|
|
||||||
// access.
|
|
||||||
package atomic
|
|
||||||
|
|
||||||
import (
|
|
||||||
"math"
|
|
||||||
"sync/atomic"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Int32 is an atomic wrapper around an int32.
|
|
||||||
type Int32 struct{ v int32 }
|
|
||||||
|
|
||||||
// NewInt32 creates an Int32.
|
|
||||||
func NewInt32(i int32) *Int32 {
|
|
||||||
return &Int32{i}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Load atomically loads the wrapped value.
|
|
||||||
func (i *Int32) Load() int32 {
|
|
||||||
return atomic.LoadInt32(&i.v)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add atomically adds to the wrapped int32 and returns the new value.
|
|
||||||
func (i *Int32) Add(n int32) int32 {
|
|
||||||
return atomic.AddInt32(&i.v, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sub atomically subtracts from the wrapped int32 and returns the new value.
|
|
||||||
func (i *Int32) Sub(n int32) int32 {
|
|
||||||
return atomic.AddInt32(&i.v, -n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Inc atomically increments the wrapped int32 and returns the new value.
|
|
||||||
func (i *Int32) Inc() int32 {
|
|
||||||
return i.Add(1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Dec atomically decrements the wrapped int32 and returns the new value.
|
|
||||||
func (i *Int32) Dec() int32 {
|
|
||||||
return i.Sub(1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// CAS is an atomic compare-and-swap.
|
|
||||||
func (i *Int32) CAS(old, new int32) bool {
|
|
||||||
return atomic.CompareAndSwapInt32(&i.v, old, new)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store atomically stores the passed value.
|
|
||||||
func (i *Int32) Store(n int32) {
|
|
||||||
atomic.StoreInt32(&i.v, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Swap atomically swaps the wrapped int32 and returns the old value.
|
|
||||||
func (i *Int32) Swap(n int32) int32 {
|
|
||||||
return atomic.SwapInt32(&i.v, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Int64 is an atomic wrapper around an int64.
|
|
||||||
type Int64 struct{ v int64 }
|
|
||||||
|
|
||||||
// NewInt64 creates an Int64.
|
|
||||||
func NewInt64(i int64) *Int64 {
|
|
||||||
return &Int64{i}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Load atomically loads the wrapped value.
|
|
||||||
func (i *Int64) Load() int64 {
|
|
||||||
return atomic.LoadInt64(&i.v)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add atomically adds to the wrapped int64 and returns the new value.
|
|
||||||
func (i *Int64) Add(n int64) int64 {
|
|
||||||
return atomic.AddInt64(&i.v, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sub atomically subtracts from the wrapped int64 and returns the new value.
|
|
||||||
func (i *Int64) Sub(n int64) int64 {
|
|
||||||
return atomic.AddInt64(&i.v, -n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Inc atomically increments the wrapped int64 and returns the new value.
|
|
||||||
func (i *Int64) Inc() int64 {
|
|
||||||
return i.Add(1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Dec atomically decrements the wrapped int64 and returns the new value.
|
|
||||||
func (i *Int64) Dec() int64 {
|
|
||||||
return i.Sub(1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// CAS is an atomic compare-and-swap.
|
|
||||||
func (i *Int64) CAS(old, new int64) bool {
|
|
||||||
return atomic.CompareAndSwapInt64(&i.v, old, new)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store atomically stores the passed value.
|
|
||||||
func (i *Int64) Store(n int64) {
|
|
||||||
atomic.StoreInt64(&i.v, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Swap atomically swaps the wrapped int64 and returns the old value.
|
|
||||||
func (i *Int64) Swap(n int64) int64 {
|
|
||||||
return atomic.SwapInt64(&i.v, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Uint32 is an atomic wrapper around an uint32.
|
|
||||||
type Uint32 struct{ v uint32 }
|
|
||||||
|
|
||||||
// NewUint32 creates a Uint32.
|
|
||||||
func NewUint32(i uint32) *Uint32 {
|
|
||||||
return &Uint32{i}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Load atomically loads the wrapped value.
|
|
||||||
func (i *Uint32) Load() uint32 {
|
|
||||||
return atomic.LoadUint32(&i.v)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add atomically adds to the wrapped uint32 and returns the new value.
|
|
||||||
func (i *Uint32) Add(n uint32) uint32 {
|
|
||||||
return atomic.AddUint32(&i.v, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sub atomically subtracts from the wrapped uint32 and returns the new value.
|
|
||||||
func (i *Uint32) Sub(n uint32) uint32 {
|
|
||||||
return atomic.AddUint32(&i.v, ^(n - 1))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Inc atomically increments the wrapped uint32 and returns the new value.
|
|
||||||
func (i *Uint32) Inc() uint32 {
|
|
||||||
return i.Add(1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Dec atomically decrements the wrapped int32 and returns the new value.
|
|
||||||
func (i *Uint32) Dec() uint32 {
|
|
||||||
return i.Sub(1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// CAS is an atomic compare-and-swap.
|
|
||||||
func (i *Uint32) CAS(old, new uint32) bool {
|
|
||||||
return atomic.CompareAndSwapUint32(&i.v, old, new)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store atomically stores the passed value.
|
|
||||||
func (i *Uint32) Store(n uint32) {
|
|
||||||
atomic.StoreUint32(&i.v, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Swap atomically swaps the wrapped uint32 and returns the old value.
|
|
||||||
func (i *Uint32) Swap(n uint32) uint32 {
|
|
||||||
return atomic.SwapUint32(&i.v, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Uint64 is an atomic wrapper around a uint64.
|
|
||||||
type Uint64 struct{ v uint64 }
|
|
||||||
|
|
||||||
// NewUint64 creates a Uint64.
|
|
||||||
func NewUint64(i uint64) *Uint64 {
|
|
||||||
return &Uint64{i}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Load atomically loads the wrapped value.
|
|
||||||
func (i *Uint64) Load() uint64 {
|
|
||||||
return atomic.LoadUint64(&i.v)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add atomically adds to the wrapped uint64 and returns the new value.
|
|
||||||
func (i *Uint64) Add(n uint64) uint64 {
|
|
||||||
return atomic.AddUint64(&i.v, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sub atomically subtracts from the wrapped uint64 and returns the new value.
|
|
||||||
func (i *Uint64) Sub(n uint64) uint64 {
|
|
||||||
return atomic.AddUint64(&i.v, ^(n - 1))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Inc atomically increments the wrapped uint64 and returns the new value.
|
|
||||||
func (i *Uint64) Inc() uint64 {
|
|
||||||
return i.Add(1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Dec atomically decrements the wrapped uint64 and returns the new value.
|
|
||||||
func (i *Uint64) Dec() uint64 {
|
|
||||||
return i.Sub(1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// CAS is an atomic compare-and-swap.
|
|
||||||
func (i *Uint64) CAS(old, new uint64) bool {
|
|
||||||
return atomic.CompareAndSwapUint64(&i.v, old, new)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store atomically stores the passed value.
|
|
||||||
func (i *Uint64) Store(n uint64) {
|
|
||||||
atomic.StoreUint64(&i.v, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Swap atomically swaps the wrapped uint64 and returns the old value.
|
|
||||||
func (i *Uint64) Swap(n uint64) uint64 {
|
|
||||||
return atomic.SwapUint64(&i.v, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Bool is an atomic Boolean.
|
|
||||||
type Bool struct{ v uint32 }
|
|
||||||
|
|
||||||
// NewBool creates a Bool.
|
|
||||||
func NewBool(initial bool) *Bool {
|
|
||||||
return &Bool{boolToInt(initial)}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Load atomically loads the Boolean.
|
|
||||||
func (b *Bool) Load() bool {
|
|
||||||
return truthy(atomic.LoadUint32(&b.v))
|
|
||||||
}
|
|
||||||
|
|
||||||
// CAS is an atomic compare-and-swap.
|
|
||||||
func (b *Bool) CAS(old, new bool) bool {
|
|
||||||
return atomic.CompareAndSwapUint32(&b.v, boolToInt(old), boolToInt(new))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store atomically stores the passed value.
|
|
||||||
func (b *Bool) Store(new bool) {
|
|
||||||
atomic.StoreUint32(&b.v, boolToInt(new))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Swap sets the given value and returns the previous value.
|
|
||||||
func (b *Bool) Swap(new bool) bool {
|
|
||||||
return truthy(atomic.SwapUint32(&b.v, boolToInt(new)))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Toggle atomically negates the Boolean and returns the previous value.
|
|
||||||
func (b *Bool) Toggle() bool {
|
|
||||||
return truthy(atomic.AddUint32(&b.v, 1) - 1)
|
|
||||||
}
|
|
||||||
|
|
||||||
func truthy(n uint32) bool {
|
|
||||||
return n&1 == 1
|
|
||||||
}
|
|
||||||
|
|
||||||
func boolToInt(b bool) uint32 {
|
|
||||||
if b {
|
|
||||||
return 1
|
|
||||||
}
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
// Float64 is an atomic wrapper around float64.
|
|
||||||
type Float64 struct {
|
|
||||||
v uint64
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewFloat64 creates a Float64.
|
|
||||||
func NewFloat64(f float64) *Float64 {
|
|
||||||
return &Float64{math.Float64bits(f)}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Load atomically loads the wrapped value.
|
|
||||||
func (f *Float64) Load() float64 {
|
|
||||||
return math.Float64frombits(atomic.LoadUint64(&f.v))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store atomically stores the passed value.
|
|
||||||
func (f *Float64) Store(s float64) {
|
|
||||||
atomic.StoreUint64(&f.v, math.Float64bits(s))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add atomically adds to the wrapped float64 and returns the new value.
|
|
||||||
func (f *Float64) Add(s float64) float64 {
|
|
||||||
for {
|
|
||||||
old := f.Load()
|
|
||||||
new := old + s
|
|
||||||
if f.CAS(old, new) {
|
|
||||||
return new
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sub atomically subtracts from the wrapped float64 and returns the new value.
|
|
||||||
func (f *Float64) Sub(s float64) float64 {
|
|
||||||
return f.Add(-s)
|
|
||||||
}
|
|
||||||
|
|
||||||
// CAS is an atomic compare-and-swap.
|
|
||||||
func (f *Float64) CAS(old, new float64) bool {
|
|
||||||
return atomic.CompareAndSwapUint64(&f.v, math.Float64bits(old), math.Float64bits(new))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Duration is an atomic wrapper around time.Duration
|
|
||||||
// https://godoc.org/time#Duration
|
|
||||||
type Duration struct {
|
|
||||||
v Int64
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewDuration creates a Duration.
|
|
||||||
func NewDuration(d time.Duration) *Duration {
|
|
||||||
return &Duration{v: *NewInt64(int64(d))}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Load atomically loads the wrapped value.
|
|
||||||
func (d *Duration) Load() time.Duration {
|
|
||||||
return time.Duration(d.v.Load())
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store atomically stores the passed value.
|
|
||||||
func (d *Duration) Store(n time.Duration) {
|
|
||||||
d.v.Store(int64(n))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add atomically adds to the wrapped time.Duration and returns the new value.
|
|
||||||
func (d *Duration) Add(n time.Duration) time.Duration {
|
|
||||||
return time.Duration(d.v.Add(int64(n)))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sub atomically subtracts from the wrapped time.Duration and returns the new value.
|
|
||||||
func (d *Duration) Sub(n time.Duration) time.Duration {
|
|
||||||
return time.Duration(d.v.Sub(int64(n)))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Swap atomically swaps the wrapped time.Duration and returns the old value.
|
|
||||||
func (d *Duration) Swap(n time.Duration) time.Duration {
|
|
||||||
return time.Duration(d.v.Swap(int64(n)))
|
|
||||||
}
|
|
||||||
|
|
||||||
// CAS is an atomic compare-and-swap.
|
|
||||||
func (d *Duration) CAS(old, new time.Duration) bool {
|
|
||||||
return d.v.CAS(int64(old), int64(new))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Value shadows the type of the same name from sync/atomic
|
|
||||||
// https://godoc.org/sync/atomic#Value
|
|
||||||
type Value struct{ atomic.Value }
|
|
||||||
|
|
@ -0,0 +1,81 @@
|
||||||
|
// @generated Code generated by gen-atomicwrapper.
|
||||||
|
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Bool is an atomic type-safe wrapper for bool values.
|
||||||
|
type Bool struct {
|
||||||
|
_ nocmp // disallow non-atomic comparison
|
||||||
|
|
||||||
|
v Uint32
|
||||||
|
}
|
||||||
|
|
||||||
|
var _zeroBool bool
|
||||||
|
|
||||||
|
// NewBool creates a new Bool.
|
||||||
|
func NewBool(v bool) *Bool {
|
||||||
|
x := &Bool{}
|
||||||
|
if v != _zeroBool {
|
||||||
|
x.Store(v)
|
||||||
|
}
|
||||||
|
return x
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load atomically loads the wrapped bool.
|
||||||
|
func (x *Bool) Load() bool {
|
||||||
|
return truthy(x.v.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Store atomically stores the passed bool.
|
||||||
|
func (x *Bool) Store(v bool) {
|
||||||
|
x.v.Store(boolToInt(v))
|
||||||
|
}
|
||||||
|
|
||||||
|
// CAS is an atomic compare-and-swap for bool values.
|
||||||
|
func (x *Bool) CAS(o, n bool) bool {
|
||||||
|
return x.v.CAS(boolToInt(o), boolToInt(n))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Swap atomically stores the given bool and returns the old
|
||||||
|
// value.
|
||||||
|
func (x *Bool) Swap(o bool) bool {
|
||||||
|
return truthy(x.v.Swap(boolToInt(o)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalJSON encodes the wrapped bool into JSON.
|
||||||
|
func (x *Bool) MarshalJSON() ([]byte, error) {
|
||||||
|
return json.Marshal(x.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON decodes a bool from JSON.
|
||||||
|
func (x *Bool) UnmarshalJSON(b []byte) error {
|
||||||
|
var v bool
|
||||||
|
if err := json.Unmarshal(b, &v); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
x.Store(v)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strconv"
|
||||||
|
)
|
||||||
|
|
||||||
|
//go:generate bin/gen-atomicwrapper -name=Bool -type=bool -wrapped=Uint32 -pack=boolToInt -unpack=truthy -cas -swap -json -file=bool.go
|
||||||
|
|
||||||
|
func truthy(n uint32) bool {
|
||||||
|
return n == 1
|
||||||
|
}
|
||||||
|
|
||||||
|
func boolToInt(b bool) uint32 {
|
||||||
|
if b {
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// Toggle atomically negates the Boolean and returns the previous value.
|
||||||
|
func (b *Bool) Toggle() bool {
|
||||||
|
for {
|
||||||
|
old := b.Load()
|
||||||
|
if b.CAS(old, !old) {
|
||||||
|
return old
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// String encodes the wrapped value as a string.
|
||||||
|
func (b *Bool) String() string {
|
||||||
|
return strconv.FormatBool(b.Load())
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,23 @@
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
// Package atomic provides simple wrappers around numerics to enforce atomic
|
||||||
|
// access.
|
||||||
|
package atomic
|
||||||
|
|
@ -0,0 +1,82 @@
|
||||||
|
// @generated Code generated by gen-atomicwrapper.
|
||||||
|
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Duration is an atomic type-safe wrapper for time.Duration values.
|
||||||
|
type Duration struct {
|
||||||
|
_ nocmp // disallow non-atomic comparison
|
||||||
|
|
||||||
|
v Int64
|
||||||
|
}
|
||||||
|
|
||||||
|
var _zeroDuration time.Duration
|
||||||
|
|
||||||
|
// NewDuration creates a new Duration.
|
||||||
|
func NewDuration(v time.Duration) *Duration {
|
||||||
|
x := &Duration{}
|
||||||
|
if v != _zeroDuration {
|
||||||
|
x.Store(v)
|
||||||
|
}
|
||||||
|
return x
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load atomically loads the wrapped time.Duration.
|
||||||
|
func (x *Duration) Load() time.Duration {
|
||||||
|
return time.Duration(x.v.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Store atomically stores the passed time.Duration.
|
||||||
|
func (x *Duration) Store(v time.Duration) {
|
||||||
|
x.v.Store(int64(v))
|
||||||
|
}
|
||||||
|
|
||||||
|
// CAS is an atomic compare-and-swap for time.Duration values.
|
||||||
|
func (x *Duration) CAS(o, n time.Duration) bool {
|
||||||
|
return x.v.CAS(int64(o), int64(n))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Swap atomically stores the given time.Duration and returns the old
|
||||||
|
// value.
|
||||||
|
func (x *Duration) Swap(o time.Duration) time.Duration {
|
||||||
|
return time.Duration(x.v.Swap(int64(o)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalJSON encodes the wrapped time.Duration into JSON.
|
||||||
|
func (x *Duration) MarshalJSON() ([]byte, error) {
|
||||||
|
return json.Marshal(x.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON decodes a time.Duration from JSON.
|
||||||
|
func (x *Duration) UnmarshalJSON(b []byte) error {
|
||||||
|
var v time.Duration
|
||||||
|
if err := json.Unmarshal(b, &v); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
x.Store(v)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,40 @@
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
import "time"
|
||||||
|
|
||||||
|
//go:generate bin/gen-atomicwrapper -name=Duration -type=time.Duration -wrapped=Int64 -pack=int64 -unpack=time.Duration -cas -swap -json -imports time -file=duration.go
|
||||||
|
|
||||||
|
// Add atomically adds to the wrapped time.Duration and returns the new value.
|
||||||
|
func (d *Duration) Add(n time.Duration) time.Duration {
|
||||||
|
return time.Duration(d.v.Add(int64(n)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sub atomically subtracts from the wrapped time.Duration and returns the new value.
|
||||||
|
func (d *Duration) Sub(n time.Duration) time.Duration {
|
||||||
|
return time.Duration(d.v.Sub(int64(n)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// String encodes the wrapped value as a string.
|
||||||
|
func (d *Duration) String() string {
|
||||||
|
return d.Load().String()
|
||||||
|
}
|
||||||
|
|
@ -1,4 +1,6 @@
|
||||||
// Copyright (c) 2016 Uber Technologies, Inc.
|
// @generated Code generated by gen-atomicwrapper.
|
||||||
|
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
//
|
//
|
||||||
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
// of this software and associated documentation files (the "Software"), to deal
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|
@ -20,36 +22,30 @@
|
||||||
|
|
||||||
package atomic
|
package atomic
|
||||||
|
|
||||||
// Error is an atomic type-safe wrapper around Value for errors
|
// Error is an atomic type-safe wrapper for error values.
|
||||||
type Error struct{ v Value }
|
type Error struct {
|
||||||
|
_ nocmp // disallow non-atomic comparison
|
||||||
|
|
||||||
// errorHolder is non-nil holder for error object.
|
v Value
|
||||||
// atomic.Value panics on saving nil object, so err object needs to be
|
|
||||||
// wrapped with valid object first.
|
|
||||||
type errorHolder struct{ err error }
|
|
||||||
|
|
||||||
// NewError creates new atomic error object
|
|
||||||
func NewError(err error) *Error {
|
|
||||||
e := &Error{}
|
|
||||||
if err != nil {
|
|
||||||
e.Store(err)
|
|
||||||
}
|
|
||||||
return e
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Load atomically loads the wrapped error
|
var _zeroError error
|
||||||
func (e *Error) Load() error {
|
|
||||||
v := e.v.Load()
|
// NewError creates a new Error.
|
||||||
if v == nil {
|
func NewError(v error) *Error {
|
||||||
return nil
|
x := &Error{}
|
||||||
|
if v != _zeroError {
|
||||||
|
x.Store(v)
|
||||||
|
}
|
||||||
|
return x
|
||||||
}
|
}
|
||||||
|
|
||||||
eh := v.(errorHolder)
|
// Load atomically loads the wrapped error.
|
||||||
return eh.err
|
func (x *Error) Load() error {
|
||||||
|
return unpackError(x.v.Load())
|
||||||
}
|
}
|
||||||
|
|
||||||
// Store atomically stores error.
|
// Store atomically stores the passed error.
|
||||||
// NOTE: a holder object is allocated on each Store call.
|
func (x *Error) Store(v error) {
|
||||||
func (e *Error) Store(err error) {
|
x.v.Store(packError(v))
|
||||||
e.v.Store(errorHolder{err: err})
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,39 @@
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
// atomic.Value panics on nil inputs, or if the underlying type changes.
|
||||||
|
// Stabilize by always storing a custom struct that we control.
|
||||||
|
|
||||||
|
//go:generate bin/gen-atomicwrapper -name=Error -type=error -wrapped=Value -pack=packError -unpack=unpackError -file=error.go
|
||||||
|
|
||||||
|
type packedError struct{ Value error }
|
||||||
|
|
||||||
|
func packError(v error) interface{} {
|
||||||
|
return packedError{v}
|
||||||
|
}
|
||||||
|
|
||||||
|
func unpackError(v interface{}) error {
|
||||||
|
if err, ok := v.(packedError); ok {
|
||||||
|
return err.Value
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,76 @@
|
||||||
|
// @generated Code generated by gen-atomicwrapper.
|
||||||
|
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"math"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Float64 is an atomic type-safe wrapper for float64 values.
|
||||||
|
type Float64 struct {
|
||||||
|
_ nocmp // disallow non-atomic comparison
|
||||||
|
|
||||||
|
v Uint64
|
||||||
|
}
|
||||||
|
|
||||||
|
var _zeroFloat64 float64
|
||||||
|
|
||||||
|
// NewFloat64 creates a new Float64.
|
||||||
|
func NewFloat64(v float64) *Float64 {
|
||||||
|
x := &Float64{}
|
||||||
|
if v != _zeroFloat64 {
|
||||||
|
x.Store(v)
|
||||||
|
}
|
||||||
|
return x
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load atomically loads the wrapped float64.
|
||||||
|
func (x *Float64) Load() float64 {
|
||||||
|
return math.Float64frombits(x.v.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Store atomically stores the passed float64.
|
||||||
|
func (x *Float64) Store(v float64) {
|
||||||
|
x.v.Store(math.Float64bits(v))
|
||||||
|
}
|
||||||
|
|
||||||
|
// CAS is an atomic compare-and-swap for float64 values.
|
||||||
|
func (x *Float64) CAS(o, n float64) bool {
|
||||||
|
return x.v.CAS(math.Float64bits(o), math.Float64bits(n))
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalJSON encodes the wrapped float64 into JSON.
|
||||||
|
func (x *Float64) MarshalJSON() ([]byte, error) {
|
||||||
|
return json.Marshal(x.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON decodes a float64 from JSON.
|
||||||
|
func (x *Float64) UnmarshalJSON(b []byte) error {
|
||||||
|
var v float64
|
||||||
|
if err := json.Unmarshal(b, &v); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
x.Store(v)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,47 @@
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
import "strconv"
|
||||||
|
|
||||||
|
//go:generate bin/gen-atomicwrapper -name=Float64 -type=float64 -wrapped=Uint64 -pack=math.Float64bits -unpack=math.Float64frombits -cas -json -imports math -file=float64.go
|
||||||
|
|
||||||
|
// Add atomically adds to the wrapped float64 and returns the new value.
|
||||||
|
func (f *Float64) Add(s float64) float64 {
|
||||||
|
for {
|
||||||
|
old := f.Load()
|
||||||
|
new := old + s
|
||||||
|
if f.CAS(old, new) {
|
||||||
|
return new
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sub atomically subtracts from the wrapped float64 and returns the new value.
|
||||||
|
func (f *Float64) Sub(s float64) float64 {
|
||||||
|
return f.Add(-s)
|
||||||
|
}
|
||||||
|
|
||||||
|
// String encodes the wrapped value as a string.
|
||||||
|
func (f *Float64) String() string {
|
||||||
|
// 'g' is the behavior for floats with %v.
|
||||||
|
return strconv.FormatFloat(f.Load(), 'g', -1, 64)
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
//go:generate bin/gen-atomicint -name=Int32 -wrapped=int32 -file=int32.go
|
||||||
|
//go:generate bin/gen-atomicint -name=Int64 -wrapped=int64 -file=int64.go
|
||||||
|
//go:generate bin/gen-atomicint -name=Uint32 -wrapped=uint32 -unsigned -file=uint32.go
|
||||||
|
//go:generate bin/gen-atomicint -name=Uint64 -wrapped=uint64 -unsigned -file=uint64.go
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
hash: f14d51408e3e0e4f73b34e4039484c78059cd7fc5f4996fdd73db20dc8d24f53
|
|
||||||
updated: 2016-10-27T00:10:51.16960137-07:00
|
|
||||||
imports: []
|
|
||||||
testImports:
|
|
||||||
- name: github.com/davecgh/go-spew
|
|
||||||
version: 5215b55f46b2b919f50a1df0eaa5886afe4e3b3d
|
|
||||||
subpackages:
|
|
||||||
- spew
|
|
||||||
- name: github.com/pmezard/go-difflib
|
|
||||||
version: d8ed2627bdf02c080bf22230dbb337003b7aba2d
|
|
||||||
subpackages:
|
|
||||||
- difflib
|
|
||||||
- name: github.com/stretchr/testify
|
|
||||||
version: d77da356e56a7428ad25149ca77381849a6a5232
|
|
||||||
subpackages:
|
|
||||||
- assert
|
|
||||||
- require
|
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
package: go.uber.org/atomic
|
|
||||||
testImport:
|
|
||||||
- package: github.com/stretchr/testify
|
|
||||||
subpackages:
|
|
||||||
- assert
|
|
||||||
- require
|
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
module go.uber.org/atomic
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/davecgh/go-spew v1.1.1 // indirect
|
||||||
|
github.com/stretchr/testify v1.3.0
|
||||||
|
)
|
||||||
|
|
||||||
|
go 1.13
|
||||||
|
|
@ -0,0 +1,9 @@
|
||||||
|
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
|
||||||
|
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
|
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||||
|
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||||
|
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||||
|
github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
|
||||||
|
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
|
||||||
|
|
@ -0,0 +1,102 @@
|
||||||
|
// @generated Code generated by gen-atomicint.
|
||||||
|
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"strconv"
|
||||||
|
"sync/atomic"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Int32 is an atomic wrapper around int32.
|
||||||
|
type Int32 struct {
|
||||||
|
_ nocmp // disallow non-atomic comparison
|
||||||
|
|
||||||
|
v int32
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewInt32 creates a new Int32.
|
||||||
|
func NewInt32(i int32) *Int32 {
|
||||||
|
return &Int32{v: i}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load atomically loads the wrapped value.
|
||||||
|
func (i *Int32) Load() int32 {
|
||||||
|
return atomic.LoadInt32(&i.v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add atomically adds to the wrapped int32 and returns the new value.
|
||||||
|
func (i *Int32) Add(n int32) int32 {
|
||||||
|
return atomic.AddInt32(&i.v, n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sub atomically subtracts from the wrapped int32 and returns the new value.
|
||||||
|
func (i *Int32) Sub(n int32) int32 {
|
||||||
|
return atomic.AddInt32(&i.v, -n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Inc atomically increments the wrapped int32 and returns the new value.
|
||||||
|
func (i *Int32) Inc() int32 {
|
||||||
|
return i.Add(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Dec atomically decrements the wrapped int32 and returns the new value.
|
||||||
|
func (i *Int32) Dec() int32 {
|
||||||
|
return i.Sub(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CAS is an atomic compare-and-swap.
|
||||||
|
func (i *Int32) CAS(old, new int32) bool {
|
||||||
|
return atomic.CompareAndSwapInt32(&i.v, old, new)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Store atomically stores the passed value.
|
||||||
|
func (i *Int32) Store(n int32) {
|
||||||
|
atomic.StoreInt32(&i.v, n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Swap atomically swaps the wrapped int32 and returns the old value.
|
||||||
|
func (i *Int32) Swap(n int32) int32 {
|
||||||
|
return atomic.SwapInt32(&i.v, n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalJSON encodes the wrapped int32 into JSON.
|
||||||
|
func (i *Int32) MarshalJSON() ([]byte, error) {
|
||||||
|
return json.Marshal(i.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON decodes JSON into the wrapped int32.
|
||||||
|
func (i *Int32) UnmarshalJSON(b []byte) error {
|
||||||
|
var v int32
|
||||||
|
if err := json.Unmarshal(b, &v); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
i.Store(v)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// String encodes the wrapped value as a string.
|
||||||
|
func (i *Int32) String() string {
|
||||||
|
v := i.Load()
|
||||||
|
return strconv.FormatInt(int64(v), 10)
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,102 @@
|
||||||
|
// @generated Code generated by gen-atomicint.
|
||||||
|
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"strconv"
|
||||||
|
"sync/atomic"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Int64 is an atomic wrapper around int64.
|
||||||
|
type Int64 struct {
|
||||||
|
_ nocmp // disallow non-atomic comparison
|
||||||
|
|
||||||
|
v int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewInt64 creates a new Int64.
|
||||||
|
func NewInt64(i int64) *Int64 {
|
||||||
|
return &Int64{v: i}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load atomically loads the wrapped value.
|
||||||
|
func (i *Int64) Load() int64 {
|
||||||
|
return atomic.LoadInt64(&i.v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add atomically adds to the wrapped int64 and returns the new value.
|
||||||
|
func (i *Int64) Add(n int64) int64 {
|
||||||
|
return atomic.AddInt64(&i.v, n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sub atomically subtracts from the wrapped int64 and returns the new value.
|
||||||
|
func (i *Int64) Sub(n int64) int64 {
|
||||||
|
return atomic.AddInt64(&i.v, -n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Inc atomically increments the wrapped int64 and returns the new value.
|
||||||
|
func (i *Int64) Inc() int64 {
|
||||||
|
return i.Add(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Dec atomically decrements the wrapped int64 and returns the new value.
|
||||||
|
func (i *Int64) Dec() int64 {
|
||||||
|
return i.Sub(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CAS is an atomic compare-and-swap.
|
||||||
|
func (i *Int64) CAS(old, new int64) bool {
|
||||||
|
return atomic.CompareAndSwapInt64(&i.v, old, new)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Store atomically stores the passed value.
|
||||||
|
func (i *Int64) Store(n int64) {
|
||||||
|
atomic.StoreInt64(&i.v, n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Swap atomically swaps the wrapped int64 and returns the old value.
|
||||||
|
func (i *Int64) Swap(n int64) int64 {
|
||||||
|
return atomic.SwapInt64(&i.v, n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalJSON encodes the wrapped int64 into JSON.
|
||||||
|
func (i *Int64) MarshalJSON() ([]byte, error) {
|
||||||
|
return json.Marshal(i.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON decodes JSON into the wrapped int64.
|
||||||
|
func (i *Int64) UnmarshalJSON(b []byte) error {
|
||||||
|
var v int64
|
||||||
|
if err := json.Unmarshal(b, &v); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
i.Store(v)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// String encodes the wrapped value as a string.
|
||||||
|
func (i *Int64) String() string {
|
||||||
|
v := i.Load()
|
||||||
|
return strconv.FormatInt(int64(v), 10)
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,35 @@
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
// nocmp is an uncomparable struct. Embed this inside another struct to make
|
||||||
|
// it uncomparable.
|
||||||
|
//
|
||||||
|
// type Foo struct {
|
||||||
|
// nocmp
|
||||||
|
// // ...
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// This DOES NOT:
|
||||||
|
//
|
||||||
|
// - Disallow shallow copies of structs
|
||||||
|
// - Disallow comparison of pointers to uncomparable structs
|
||||||
|
type nocmp [0]func()
|
||||||
|
|
@ -1,4 +1,6 @@
|
||||||
// Copyright (c) 2016 Uber Technologies, Inc.
|
// @generated Code generated by gen-atomicwrapper.
|
||||||
|
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
//
|
//
|
||||||
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
// of this software and associated documentation files (the "Software"), to deal
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|
@ -20,30 +22,33 @@
|
||||||
|
|
||||||
package atomic
|
package atomic
|
||||||
|
|
||||||
// String is an atomic type-safe wrapper around Value for strings.
|
// String is an atomic type-safe wrapper for string values.
|
||||||
type String struct{ v Value }
|
type String struct {
|
||||||
|
_ nocmp // disallow non-atomic comparison
|
||||||
|
|
||||||
// NewString creates a String.
|
v Value
|
||||||
func NewString(str string) *String {
|
|
||||||
s := &String{}
|
|
||||||
if str != "" {
|
|
||||||
s.Store(str)
|
|
||||||
}
|
}
|
||||||
return s
|
|
||||||
|
var _zeroString string
|
||||||
|
|
||||||
|
// NewString creates a new String.
|
||||||
|
func NewString(v string) *String {
|
||||||
|
x := &String{}
|
||||||
|
if v != _zeroString {
|
||||||
|
x.Store(v)
|
||||||
|
}
|
||||||
|
return x
|
||||||
}
|
}
|
||||||
|
|
||||||
// Load atomically loads the wrapped string.
|
// Load atomically loads the wrapped string.
|
||||||
func (s *String) Load() string {
|
func (x *String) Load() string {
|
||||||
v := s.v.Load()
|
if v := x.v.Load(); v != nil {
|
||||||
if v == nil {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
return v.(string)
|
return v.(string)
|
||||||
}
|
}
|
||||||
|
return _zeroString
|
||||||
|
}
|
||||||
|
|
||||||
// Store atomically stores the passed string.
|
// Store atomically stores the passed string.
|
||||||
// Note: Converting the string to an interface{} to store in the Value
|
func (x *String) Store(v string) {
|
||||||
// requires an allocation.
|
x.v.Store(v)
|
||||||
func (s *String) Store(str string) {
|
|
||||||
s.v.Store(str)
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,43 @@
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
//go:generate bin/gen-atomicwrapper -name=String -type=string -wrapped=Value -file=string.go
|
||||||
|
|
||||||
|
// String returns the wrapped value.
|
||||||
|
func (s *String) String() string {
|
||||||
|
return s.Load()
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalText encodes the wrapped string into a textual form.
|
||||||
|
//
|
||||||
|
// This makes it encodable as JSON, YAML, XML, and more.
|
||||||
|
func (s *String) MarshalText() ([]byte, error) {
|
||||||
|
return []byte(s.Load()), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalText decodes text and replaces the wrapped string with it.
|
||||||
|
//
|
||||||
|
// This makes it decodable from JSON, YAML, XML, and more.
|
||||||
|
func (s *String) UnmarshalText(b []byte) error {
|
||||||
|
s.Store(string(b))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,102 @@
|
||||||
|
// @generated Code generated by gen-atomicint.
|
||||||
|
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"strconv"
|
||||||
|
"sync/atomic"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Uint32 is an atomic wrapper around uint32.
|
||||||
|
type Uint32 struct {
|
||||||
|
_ nocmp // disallow non-atomic comparison
|
||||||
|
|
||||||
|
v uint32
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewUint32 creates a new Uint32.
|
||||||
|
func NewUint32(i uint32) *Uint32 {
|
||||||
|
return &Uint32{v: i}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load atomically loads the wrapped value.
|
||||||
|
func (i *Uint32) Load() uint32 {
|
||||||
|
return atomic.LoadUint32(&i.v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add atomically adds to the wrapped uint32 and returns the new value.
|
||||||
|
func (i *Uint32) Add(n uint32) uint32 {
|
||||||
|
return atomic.AddUint32(&i.v, n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sub atomically subtracts from the wrapped uint32 and returns the new value.
|
||||||
|
func (i *Uint32) Sub(n uint32) uint32 {
|
||||||
|
return atomic.AddUint32(&i.v, ^(n - 1))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Inc atomically increments the wrapped uint32 and returns the new value.
|
||||||
|
func (i *Uint32) Inc() uint32 {
|
||||||
|
return i.Add(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Dec atomically decrements the wrapped uint32 and returns the new value.
|
||||||
|
func (i *Uint32) Dec() uint32 {
|
||||||
|
return i.Sub(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CAS is an atomic compare-and-swap.
|
||||||
|
func (i *Uint32) CAS(old, new uint32) bool {
|
||||||
|
return atomic.CompareAndSwapUint32(&i.v, old, new)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Store atomically stores the passed value.
|
||||||
|
func (i *Uint32) Store(n uint32) {
|
||||||
|
atomic.StoreUint32(&i.v, n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Swap atomically swaps the wrapped uint32 and returns the old value.
|
||||||
|
func (i *Uint32) Swap(n uint32) uint32 {
|
||||||
|
return atomic.SwapUint32(&i.v, n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalJSON encodes the wrapped uint32 into JSON.
|
||||||
|
func (i *Uint32) MarshalJSON() ([]byte, error) {
|
||||||
|
return json.Marshal(i.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON decodes JSON into the wrapped uint32.
|
||||||
|
func (i *Uint32) UnmarshalJSON(b []byte) error {
|
||||||
|
var v uint32
|
||||||
|
if err := json.Unmarshal(b, &v); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
i.Store(v)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// String encodes the wrapped value as a string.
|
||||||
|
func (i *Uint32) String() string {
|
||||||
|
v := i.Load()
|
||||||
|
return strconv.FormatUint(uint64(v), 10)
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,102 @@
|
||||||
|
// @generated Code generated by gen-atomicint.
|
||||||
|
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"strconv"
|
||||||
|
"sync/atomic"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Uint64 is an atomic wrapper around uint64.
|
||||||
|
type Uint64 struct {
|
||||||
|
_ nocmp // disallow non-atomic comparison
|
||||||
|
|
||||||
|
v uint64
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewUint64 creates a new Uint64.
|
||||||
|
func NewUint64(i uint64) *Uint64 {
|
||||||
|
return &Uint64{v: i}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load atomically loads the wrapped value.
|
||||||
|
func (i *Uint64) Load() uint64 {
|
||||||
|
return atomic.LoadUint64(&i.v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add atomically adds to the wrapped uint64 and returns the new value.
|
||||||
|
func (i *Uint64) Add(n uint64) uint64 {
|
||||||
|
return atomic.AddUint64(&i.v, n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sub atomically subtracts from the wrapped uint64 and returns the new value.
|
||||||
|
func (i *Uint64) Sub(n uint64) uint64 {
|
||||||
|
return atomic.AddUint64(&i.v, ^(n - 1))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Inc atomically increments the wrapped uint64 and returns the new value.
|
||||||
|
func (i *Uint64) Inc() uint64 {
|
||||||
|
return i.Add(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Dec atomically decrements the wrapped uint64 and returns the new value.
|
||||||
|
func (i *Uint64) Dec() uint64 {
|
||||||
|
return i.Sub(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CAS is an atomic compare-and-swap.
|
||||||
|
func (i *Uint64) CAS(old, new uint64) bool {
|
||||||
|
return atomic.CompareAndSwapUint64(&i.v, old, new)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Store atomically stores the passed value.
|
||||||
|
func (i *Uint64) Store(n uint64) {
|
||||||
|
atomic.StoreUint64(&i.v, n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Swap atomically swaps the wrapped uint64 and returns the old value.
|
||||||
|
func (i *Uint64) Swap(n uint64) uint64 {
|
||||||
|
return atomic.SwapUint64(&i.v, n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalJSON encodes the wrapped uint64 into JSON.
|
||||||
|
func (i *Uint64) MarshalJSON() ([]byte, error) {
|
||||||
|
return json.Marshal(i.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON decodes JSON into the wrapped uint64.
|
||||||
|
func (i *Uint64) UnmarshalJSON(b []byte) error {
|
||||||
|
var v uint64
|
||||||
|
if err := json.Unmarshal(b, &v); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
i.Store(v)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// String encodes the wrapped value as a string.
|
||||||
|
func (i *Uint64) String() string {
|
||||||
|
v := i.Load()
|
||||||
|
return strconv.FormatUint(uint64(v), 10)
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,31 @@
|
||||||
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
||||||
|
//
|
||||||
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
// of this software and associated documentation files (the "Software"), to deal
|
||||||
|
// in the Software without restriction, including without limitation the rights
|
||||||
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
// copies of the Software, and to permit persons to whom the Software is
|
||||||
|
// furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
// The above copyright notice and this permission notice shall be included in
|
||||||
|
// all copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
package atomic
|
||||||
|
|
||||||
|
import "sync/atomic"
|
||||||
|
|
||||||
|
// Value shadows the type of the same name from sync/atomic
|
||||||
|
// https://godoc.org/sync/atomic#Value
|
||||||
|
type Value struct {
|
||||||
|
atomic.Value
|
||||||
|
|
||||||
|
_ nocmp // disallow non-atomic comparison
|
||||||
|
}
|
||||||
|
|
@ -497,7 +497,7 @@ github.com/seccomp/libseccomp-golang
|
||||||
# github.com/sirupsen/logrus v1.7.0
|
# github.com/sirupsen/logrus v1.7.0
|
||||||
github.com/sirupsen/logrus
|
github.com/sirupsen/logrus
|
||||||
github.com/sirupsen/logrus/hooks/syslog
|
github.com/sirupsen/logrus/hooks/syslog
|
||||||
# github.com/spf13/cobra v1.1.1
|
# github.com/spf13/cobra v1.1.1 => github.com/Luap99/cobra v1.0.1-0.20201110155035-83a59186c706
|
||||||
github.com/spf13/cobra
|
github.com/spf13/cobra
|
||||||
# github.com/spf13/pflag v1.0.5
|
# github.com/spf13/pflag v1.0.5
|
||||||
github.com/spf13/pflag
|
github.com/spf13/pflag
|
||||||
|
|
@ -570,7 +570,7 @@ go.opencensus.io/internal
|
||||||
go.opencensus.io/trace
|
go.opencensus.io/trace
|
||||||
go.opencensus.io/trace/internal
|
go.opencensus.io/trace/internal
|
||||||
go.opencensus.io/trace/tracestate
|
go.opencensus.io/trace/tracestate
|
||||||
# go.uber.org/atomic v1.4.0
|
# go.uber.org/atomic v1.7.0
|
||||||
go.uber.org/atomic
|
go.uber.org/atomic
|
||||||
# golang.org/x/crypto v0.0.0-20200709230013-948cd5f35899
|
# golang.org/x/crypto v0.0.0-20200709230013-948cd5f35899
|
||||||
golang.org/x/crypto/blowfish
|
golang.org/x/crypto/blowfish
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue