dart-sdk/runtime/docs/pragmas.md
Vyacheslav Egorov a1a38da58e [vm] Report an error when illegally accessing class through API in AOT mode.
Move all pragma documentation into runtime/docs and reformat it a bit.

Fixes https://github.com/dart-lang/sdk/issues/35170

Change-Id: I2ab4d6d598f115efaa3192135cb838fb85cbbb01
Reviewed-on: https://dart-review.googlesource.com/c/84435
Commit-Queue: Vyacheslav Egorov <vegorov@google.com>
Auto-Submit: Vyacheslav Egorov <vegorov@google.com>
Reviewed-by: Samir Jindel <sjindel@google.com>
2018-11-15 12:00:57 +00:00

1.3 KiB

VM-Specific Pragma Annotations

Pragmas for general use

These pragmas are part of the VM's API and are safe for use in external code.

Pragma Meaning
vm:entry-point Defining entry-points into Dart code for an embedder or native methods

Pragmas for internal use

These pragmas can cause unsound behavior if used incorrectly and therefore are only allowed within the core SDK libraries.

Pragma Meaning
vm:exact-result-type Declaring an exact result type of a method

Pragmas for internal testing

These pragmas are used for inspecting or modifying internal VM state and should be used exclusively by SDK tests. They must be enabled with the --enable-testing-pragmas flag. The names of these pragmas are prefixed with "testing". Additionally, they are categorized into "safe" and "unsafe" forms: "safe" pragmas should not affect the behavior of the program and can be safely added anywhere, whereas "unsafe" pragmas may change the code's behavior or may cause the VM to crash if used improperly.

Pragma Meaning
vm:testing.unsafe.trace-entrypoints-fn Observing which flow-graph-level entry-point was used when a function was called