Documentation
¶
Index ¶
- Constants
- Variables
- func ConfigureFindFieldByName(conf any, name, tag string) reflect.Value
- func ConfigureList(w io.Writer, config any, tag string)
- func ConfigureListByName(conf any, name, tag string) string
- func ConfigureSetSimple(rest string, cfgname string, field reflect.Value) error
- func GetConfigFilePath(file string) (string, error)
- func IterateConfiguration(conf any, tag string) *configureIterator
- func SaveConfig(conf *Config) error
- func Split2PartsBySpace(s string) []string
- func SplitQuotedFields(in string, quote rune) []string
- func WriteConfigDocumentation(w io.Writer)
- type Config
- type SubstitutePathRule
- type SubstitutePathRules
Constants ¶
View Source
const ( PositionSource = "source" PositionDisassembly = "disassembly" PositionDefault = "default" )
Variables ¶
View Source
var Documentation = map[string]string{
"aliases": `Configures command aliases.
config alias <command> <alias>
config alias <alias>
Defines <alias> as an alias to <command> or removes an alias.
`,
"substitute-path": ` config substitute-path <from> <to>
config substitute-path <from>
config substitute-path -clear
config substitute-path -guess
Adds or removes a path substitution rule, if -clear is used all
substitute-path rules are removed. Without arguments shows the current list
of substitute-path rules.
The -guess option causes Delve to try to guess your substitute-path
configuration automatically.
See also Documentation/cli/substitutepath.md for how the rules are applied.
`,
"max-string-len": "Maximum string length used when printing variables.\n",
"max-array-values": "Maximum number of array values when printing variables.\n",
"max-variable-recurse": "Maximum number of nested struct members when printing variables.\n",
"disassemble-flavor": "Disassembler syntax. Can be 'intel', 'gun' or 'go'.\n",
"show-location-expr": "If true the 'whatis' command will print the DWARF location expression of its argument.\n",
"source-list-line-color": "Source list line-number color, as a terminal escape sequence.\n",
"source-list-arrow-color": "Source list arrow color, as a terminal escape sequence.\n",
"source-list-keyword-color": "Source list keyword color, as a terminal escape sequence.\n",
"source-list-string-color": "Source list string color, as a terminal escape sequence.\n",
"source-list-number-color": "Source list number color, as a terminal escape sequence.\n",
"source-list-comment-color": "Source list comment color, as a terminal escape sequence.\n",
"prompt-color": "Prompt color, as a terminal escape sequence.\n",
"source-list-tab-color": "Source list tab color, as a terminal escape sequence.\n",
"stacktrace-function-color": "Color for function names in the stack trace, as a terminal escape sequence.\n",
"stacktrace-basename-color": "Color for the base name in paths in the stack trace, as a terminal escape sequence.\n",
"source-list-line-count": "Number of lines to list above and below the cursor when printing source code.\n",
"tab": "Changes what is printed when a tab character is encountered in source code.\n",
"trace-show-timestamp": "If true timestamps are shown in the trace output.\n",
"debug-info-directories": ` config debug-info-directories -add <path>
config debug-info-directories -rm <path>
config debug-info-directories -clear
Adds, removes or clears debug-info-directories.
`,
"position": `Controls how the current position in the program is displayed. The possible values are:
- 'source': always show the current position in the source code.
- 'disassembly': always show the current position in the program disassembly.
- 'default': show the current position in the disassembly after 'step-instruction', otherwise in source code.
`,
"prompt": `Changes Delve's prompt. This string can contain various escape codes:
$d inserts the current time in RFC3339 format
$d{fmt} inserts the current time formatted with fmt (using the time package syntax)
$f inserts the current frame number
$g inserts the current goroutine ID
$t inserts the current thread ID
$p inserts the current PID
`,
}
Functions ¶
func ConfigureFindFieldByName ¶ added in v1.7.3
func ConfigureListByName ¶ added in v1.7.3
func ConfigureSetSimple ¶ added in v1.7.3
func GetConfigFilePath ¶
GetConfigFilePath gets the full path to the given config file name.
func IterateConfiguration ¶ added in v1.7.3
func SaveConfig ¶ added in v1.0.0
SaveConfig will marshal and save the config struct to disk.
func Split2PartsBySpace ¶ added in v1.7.3
func SplitQuotedFields ¶ added in v1.0.0
SplitQuotedFields is like strings.Fields but ignores spaces inside areas surrounded by the specified quote character. To specify a single quote use backslash to escape it: \'
func WriteConfigDocumentation ¶ added in v1.26.2
Types ¶
type Config ¶
type Config struct {
// Commands aliases.
Aliases map[string][]string `yaml:"aliases"`
// Source code path substitution rules.
SubstitutePath SubstitutePathRules `yaml:"substitute-path"`
// MaxStringLen is the maximum string length that the commands print,
// locals, args and vars should read (in verbose mode).
MaxStringLen *int `yaml:"max-string-len,omitempty"`
// MaxArrayValues is the maximum number of array items that the commands
// print, locals, args and vars should read (in verbose mode).
MaxArrayValues *int `yaml:"max-array-values,omitempty"`
// MaxVariableRecurse is output evaluation depth of nested struct members, array and
// slice items and dereference pointers
MaxVariableRecurse *int `yaml:"max-variable-recurse,omitempty"`
// DisassembleFlavor allow user to specify output syntax flavor of assembly, one of
// this list "intel"(default), "gnu", "go"
DisassembleFlavor *string `yaml:"disassemble-flavor,omitempty"`
// If ShowLocationExpr is true whatis will print the DWARF location
// expression for its argument.
ShowLocationExpr bool `yaml:"show-location-expr"`
// Source list line-number color, as a terminal escape sequence.
// For historic reasons, this can also be an integer color code.
SourceListLineColor any `yaml:"source-list-line-color"`
// Source list arrow color, as a terminal escape sequence.
SourceListArrowColor string `yaml:"source-list-arrow-color"`
// Source list keyword color, as a terminal escape sequence.
SourceListKeywordColor string `yaml:"source-list-keyword-color"`
// Source list string color, as a terminal escape sequence.
SourceListStringColor string `yaml:"source-list-string-color"`
// Source list number color, as a terminal escape sequence.
SourceListNumberColor string `yaml:"source-list-number-color"`
// Source list comment color, as a terminal escape sequence.
SourceListCommentColor string `yaml:"source-list-comment-color"`
// Color for the prompt line.
PromptColor string `yaml:"prompt-color"`
// Source list tab color, as a terminal escape sequence.
SourceListTabColor string `yaml:"source-list-tab-color"`
// Color for function names in the stack trace.
StackTraceFunctionColor string `yaml:"stacktrace-function-color"`
// Color for the base name in paths in the stack trace.
StackTraceBasenameColor string `yaml:"stacktrace-basename-color"`
// number of lines to list above and below cursor when printfile() is
// called (i.e. when execution stops, listCommand is used, etc)
SourceListLineCount *int `yaml:"source-list-line-count,omitempty"`
// DebugInfoDirectories is the list of directories Delve will use
// in order to resolve external debug info files.
DebugInfoDirectories []string `yaml:"debug-info-directories"`
// Position controls how the current position in the program is displayed.
// There are three possible values:
// - source: always show the current position in the program's source
// code.
// - disassembly: always should the current position by disassembling the
// current function.
// - default (or the empty string): use disassembly for step-instruction,
// source for everything else.
Position string `yaml:"position"`
// Tab changes what is printed when a '\t' is encountered in source code.
// This can be used to shorten the tabstop (e.g. " ") or to print a more
// visual indent (e.g. ">__ ").
Tab string `yaml:"tab"`
// TraceShowTimestamp controls whether to show timestamp in the trace
// output.
TraceShowTimestamp bool `yaml:"trace-show-timestamp"`
// Prompt is the string printed before each command. If empty, the
// default prompt "(dlv) " is used.
Prompt string `yaml:"prompt,omitempty"`
}
Config defines all configuration options available to be set through the config file.
func LoadConfig ¶
LoadConfig attempts to populate a Config object from the config.yml file.
func (*Config) GetDisassembleFlavour ¶ added in v1.9.1
func (c *Config) GetDisassembleFlavour() api.AssemblyFlavour
func (*Config) GetSourceListLineCount ¶ added in v1.4.1
type SubstitutePathRule ¶
type SubstitutePathRule struct {
// Directory path will be substituted if it matches `From`.
From string
// Path to which substitution is performed.
To string
}
SubstitutePathRule describes a rule for substitution of path to source code file.
type SubstitutePathRules ¶
type SubstitutePathRules []SubstitutePathRule
SubstitutePathRules is a slice of source code path substitution rules.
Click to show internal directories.
Click to hide internal directories.