mirror of
https://github.com/go-sylixos/elvish.git
synced 2024-12-05 03:17:50 +08:00
28798ac053
I stumbled across a comment that began with "XXX". It was clearly meant as a "TODO" comment. This changes all such occurrences. However, a few "XXX" comments are ambiguous and a better prefix might be "WARNING". The "TODO" prefix at least ensures someone, eventually, looks into the situation and either rewords the comment or fixes the problem. This change means everyone can assume searching for "// TODO" will find all such comments rather than requiring they also know to search for "// XXX".
109 lines
2.0 KiB
Go
109 lines
2.0 KiB
Go
package eval
|
|
|
|
import (
|
|
"runtime"
|
|
|
|
"github.com/elves/elvish/pkg/parse"
|
|
"github.com/elves/elvish/pkg/util"
|
|
)
|
|
|
|
//elvdoc:fn src
|
|
//
|
|
// ```elvish
|
|
// src
|
|
// ```
|
|
//
|
|
// Output a map-like value describing the current source being evaluated. The value
|
|
// contains the following fields:
|
|
//
|
|
// - `name`, a unique name of the current source. If the source originates from a
|
|
// file, it is the full path of the file.
|
|
//
|
|
// - `code`, the full body of the current source.
|
|
//
|
|
// - `is-file`, whether the source originates from a file.
|
|
//
|
|
// Examples:
|
|
//
|
|
// ```elvish-transcript
|
|
// ~> put (src)[name code is-file]
|
|
// ▶ '[tty]'
|
|
// ▶ 'put (src)[name code is-file]'
|
|
// ▶ $false
|
|
// ~> echo 'put (src)[name code is-file]' > show-src.elv
|
|
// ~> elvish show-src.elv
|
|
// ▶ /home/elf/show-src.elv
|
|
// ▶ "put (src)[name code is-file]\n"
|
|
// ▶ $true
|
|
//
|
|
// Note: this builtin always returns information of the source of the function
|
|
// calling `src`. Consider the following example:
|
|
//
|
|
// ```elvish-transcript
|
|
// ~> echo 'fn show { put (src)[name] }' > ~/.elvish/lib/src-util.elv
|
|
// ~> use src-util
|
|
// ~> src-util:show
|
|
// ▶ /home/elf/.elvish/lib/src-util.elv
|
|
// ```
|
|
|
|
//elvdoc:fn -gc
|
|
//
|
|
// ```elvish
|
|
// -gc
|
|
// ```
|
|
//
|
|
// Force the Go garbage collector to run.
|
|
//
|
|
// This is only useful for debug purposes.
|
|
|
|
//elvdoc:fn -stack
|
|
//
|
|
// ```elvish
|
|
// -stack
|
|
// ```
|
|
//
|
|
// Print a stack trace.
|
|
//
|
|
// This is only useful for debug purposes.
|
|
|
|
//elvdoc:fn -log
|
|
//
|
|
// ```elvish
|
|
// -log $filename
|
|
// ```
|
|
//
|
|
// Direct internal debug logs to the named file.
|
|
//
|
|
// This is only useful for debug purposes.
|
|
|
|
func init() {
|
|
addBuiltinFns(map[string]interface{}{
|
|
"src": src,
|
|
"-gc": _gc,
|
|
"-stack": _stack,
|
|
"-log": _log,
|
|
})
|
|
}
|
|
|
|
func src(fm *Frame) parse.Source {
|
|
return fm.srcMeta
|
|
}
|
|
|
|
func _gc() {
|
|
runtime.GC()
|
|
}
|
|
|
|
func _stack(fm *Frame) {
|
|
out := fm.ports[1].File
|
|
// TODO(xiaq): Dup with main.go.
|
|
buf := make([]byte, 1024)
|
|
for runtime.Stack(buf, true) == cap(buf) {
|
|
buf = make([]byte, cap(buf)*2)
|
|
}
|
|
out.Write(buf)
|
|
}
|
|
|
|
func _log(fname string) error {
|
|
return util.SetOutputFile(fname)
|
|
}
|