go-sylixos/elvish
3
0
Fork 0
mirror of https://github.com/go-sylixos/elvish.git synced 2024-12-04 10:57:50 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
7e0b6ee8e6
elvish/pkg/eval/builtin_fn_debug.d.elv

42 lines
1.1 KiB
Plaintext
Raw Normal View History

Make struct maps indistinguishable from maps to Elvish code. Struct map is a mechanism to let Go code expose simple structs to Elvish code. The difference between struct maps and maps is convenience for Go code; they also have different performance characteristics, but since struct maps are always quite small, the difference is not meaningful for Elvish's use cases. As a result, there is no good reason that Elvish code needs to be aware of the difference between struct maps and normal maps. Making them indistinguishable to Elvish code simplifies the language. This commit does the following: - Change Equal, Hash, Kind and Repr to treat struct maps like maps. - Change Assoc and Dissoc to "promote" struct maps to maps. - Remove the custom Repr method of parse.Source. - Update documentation to reflect this change.
2023-07-15 06:45:25 +08:00
# Output a map describing the current source, which is the source file or
# interactive command that contains the call to `src`. The value contains the
# following fields:
Move all elvdocs into .d.elv files. The elvdocs still use the old format (#elvdoc:fn or #elvdoc:var) for now, but will be changed to "fn" and "var" forms soon. Also remove the accidentally committed cmd/mvelvdoc. It has been used to perform the conversion automatically but is not supposed to be committed.
2022-11-21 05:52:11 +08:00
#
# - `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
Make struct maps indistinguishable from maps to Elvish code. Struct map is a mechanism to let Go code expose simple structs to Elvish code. The difference between struct maps and maps is convenience for Go code; they also have different performance characteristics, but since struct maps are always quite small, the difference is not meaningful for Elvish's use cases. As a result, there is no good reason that Elvish code needs to be aware of the difference between struct maps and normal maps. Making them indistinguishable to Elvish code simplifies the language. This commit does the following: - Change Equal, Hash, Kind and Repr to treat struct maps like maps. - Change Assoc and Dissoc to "promote" struct maps to maps. - Remove the custom Repr method of parse.Source. - Update documentation to reflect this change.
2023-07-15 06:45:25 +08:00
# ~> src
# ▶ [&code=src &is-file=$false &name='[tty 1]']
Move all elvdocs into .d.elv files. The elvdocs still use the old format (#elvdoc:fn or #elvdoc:var) for now, but will be changed to "fn" and "var" forms soon. Also remove the accidentally committed cmd/mvelvdoc. It has been used to perform the conversion automatically but is not supposed to be committed.
2022-11-21 05:52:11 +08:00
# ~> elvish show-src.elv
Make struct maps indistinguishable from maps to Elvish code. Struct map is a mechanism to let Go code expose simple structs to Elvish code. The difference between struct maps and maps is convenience for Go code; they also have different performance characteristics, but since struct maps are always quite small, the difference is not meaningful for Elvish's use cases. As a result, there is no good reason that Elvish code needs to be aware of the difference between struct maps and normal maps. Making them indistinguishable to Elvish code simplifies the language. This commit does the following: - Change Equal, Hash, Kind and Repr to treat struct maps like maps. - Change Assoc and Dissoc to "promote" struct maps to maps. - Remove the custom Repr method of parse.Source. - Update documentation to reflect this change.
2023-07-15 06:45:25 +08:00
# ▶ [&code="src\n" &is-file=$true &name=/home/elf/show-src.elv]
# ~> echo src > .config/elvish/lib/show-src.elv
# ~> use show-src
# ▶ [&code="src\n" &is-file=$true &name=/home/elf/.config/elvish/lib/show-src.elv]
Move all elvdocs into .d.elv files. The elvdocs still use the old format (#elvdoc:fn or #elvdoc:var) for now, but will be changed to "fn" and "var" forms soon. Also remove the accidentally committed cmd/mvelvdoc. It has been used to perform the conversion automatically but is not supposed to be committed.
2022-11-21 05:52:11 +08:00
# ```
Parse comment blocks preceding var and fn declarations as doc comments. Convert all .elv files (including .d.elv files) to use this new format.
2022-11-22 22:13:25 +08:00
fn src { }
Move all elvdocs into .d.elv files. The elvdocs still use the old format (#elvdoc:fn or #elvdoc:var) for now, but will be changed to "fn" and "var" forms soon. Also remove the accidentally committed cmd/mvelvdoc. It has been used to perform the conversion automatically but is not supposed to be committed.
2022-11-21 05:52:11 +08:00
# Force the Go garbage collector to run.
#
# This is only useful for debug purposes.
Parse comment blocks preceding var and fn declarations as doc comments. Convert all .elv files (including .d.elv files) to use this new format.
2022-11-22 22:13:25 +08:00
#doc:show-unstable
fn -gc { }
Move all elvdocs into .d.elv files. The elvdocs still use the old format (#elvdoc:fn or #elvdoc:var) for now, but will be changed to "fn" and "var" forms soon. Also remove the accidentally committed cmd/mvelvdoc. It has been used to perform the conversion automatically but is not supposed to be committed.
2022-11-21 05:52:11 +08:00
# Print a stack trace.
#
# This is only useful for debug purposes.
Parse comment blocks preceding var and fn declarations as doc comments. Convert all .elv files (including .d.elv files) to use this new format.
2022-11-22 22:13:25 +08:00
#doc:show-unstable
fn -stack { }
Move all elvdocs into .d.elv files. The elvdocs still use the old format (#elvdoc:fn or #elvdoc:var) for now, but will be changed to "fn" and "var" forms soon. Also remove the accidentally committed cmd/mvelvdoc. It has been used to perform the conversion automatically but is not supposed to be committed.
2022-11-21 05:52:11 +08:00
# Direct internal debug logs to the named file.
#
# This is only useful for debug purposes.
Parse comment blocks preceding var and fn declarations as doc comments. Convert all .elv files (including .d.elv files) to use this new format.
2022-11-22 22:13:25 +08:00
#doc:show-unstable
fn -log {|filename| }
Reference in New Issue Copy Permalink