Package 'vscDebugger'

vscDebugger

Description

(Partial) implementation of the Debug Adapter Protocol for R.

Details

Provides support for the vscode extension vscode-R-Debugger.

Author(s)

Maintainer: Manuel Hentschel [email protected]

Other contributors:

• Kun Ren [email protected] [contributor]

• Denes Toth [email protected] (ORCID) [contributor]

See Also

Useful links:

• https://ManuelHentschel.github.io/vscDebugger/

• https://github.com/ManuelHentschel/vscDebugger

• Report bugs at https://github.com/ManuelHentschel/vscDebugger/issues

---

Get info about a variable

Description

Get info about a variable by applying the relevant varInfo entries.

Usage

.vsc.applyVarInfos(
  v,
  infos = character(0),
  stackingInfos = character(0),
  verbose = getOption("vsc.verboseVarInfos", FALSE),
  ind = NULL
)

Arguments

v	The variable, any R value.
infos	Character vector of field names in varInfo. Retrieve first match.
stackingInfos	Character vector of field names in varInfo. Retrieve all matches.
verbose	Whether to print debug info using logCat, logPrint.
ind	The indices to retrieve if child variables are retrieved.

Details

The allowed varInfo entries and their types are:

• childVars: MinimalVariable[]

• nChildVars: number

• customAttributes: MinmalVariable[]

• internalAttributes: MinmalVariable[]

• toString: string

• type: string

• evaluateName: string

• printFunc: function | boolean

Where MinimalVariable[] refers to a list of named lists with entries:

• name: string

• rValue: any R value

• setter: (optional, undocumented)

• setInfo: (optional, undocumented)

Value

A named list, containing the corresponding varInfo results.

See Also

varInfos

---

Modified version of base::source

Description

Modified version of base::source that honors breakpoints set by the debugger.

Usage

.vsc.debugSource(
  file,
  local = FALSE,
  envir = NULL,
  chdir = FALSE,
  print.eval = NULL,
  encoding = "unknown",
  ...
)

Arguments

file	String giving the name of the file to be sourced. Connections etc. are not supported!
local	Same as in base::source(), can be overwritten by specifying an environment in envir.
envir	The environment in which to evaluate the sourced code. Overwrites local, if specified.
chdir	Whether to temporarily change the working directory to the location of file.
encoding	The encoding to be used by base::parse().
...	Further arguments are ignored but allowed for compatibility with base::source().

See Also

Other overwrites: .vsc.load_all(), outputOverwrites

---

Tools to modify/debug varInfos

Description

Tools to check the varInfos computed for variables and modify the list of varInfos used.

Usage

.vsc.getAllVarInfoFields(varInfos = session$varInfos)

.vsc.applyAllVarInfos(v, verbose = TRUE)

.vsc.resetVarInfos()

.vsc.addVarInfo(varInfo, overwrite = FALSE)

.vsc.removeVarInfos(positions)

.vsc.getVarInfos(positions = NULL)

.vsc.checkVarInfos(varInfos = session$varInfos)

Arguments

varInfos	List of varInfos
v	Variable, any R object
verbose	passed to .vsc.applyVarInfos
varInfo	A varInfo, i.e. named list.
overwrite	Boolean, whether to overwrite the entry in that position
positions	Numeric or character vector, the entries to retrieve/remove

See Also

.vsc.applyVarInfos

---

Modified version of pkgload::load_all()

Description

Modified version of pkgload::load_all()

Usage

.vsc.load_all(...)

See Also

Other overwrites: .vsc.debugSource(), outputOverwrites

---

Error handler

Description

Error handler used by vsc. Set with options(error = .vsc.onError)

Usage

.vsc.onError(err = NULL)

Arguments

err	The message to be sent to vsc. Defaults to geterrmessage()

---

Refresh Breakpoints

Description

Refresh breakpoints known to the debugger Can be used if breakpoints were invalidated by e.g. load_all() or source()

Usage

.vsc.refreshBreakpoints(envs = NULL)

---

Modified Output Functions

Description

Modified versions of core R functions that add debugger specific functionality. With the default debug configuration, the normal R functions are overwritten with these (using attach()).

The modified functions are designed to be mostly interchangeable with their counterparts. If the overwrites are not required, they can be toggled using the launch config entries overwriteCat, overwritePrint, overwriteStr, and overwriteMessage.

Usage

.vsc.cat(..., skipCalls = 0, showSource = TRUE)

.vsc.print(x, ..., skipCalls = 0, showSource = TRUE)

.vsc.message(
  ...,
  domain = NULL,
  appendLF = TRUE,
  showSource = TRUE,
  skipCalls = 0
)

.vsc.str(object, ..., skipCalls = 0, showSource = TRUE)

Arguments

...	Further arguments that are passed to the original function
skipCalls	The number of calls to skip when reporting the calling file and line. Can be useful e.g. inside a log function.
showSource	Whether to show the calling source file and line
x	Same as in base::print()
domain	Same as in base::message()
appendLF	Same as in base::message()
object	Same as in utils::str()

Value

These functions return the same value as the overwritten functions themselves.

See Also

base::cat()

base::print()

base::message()

utils::str()

Other overwrites: .vsc.debugSource(), .vsc.load_all()

---