Provisional API: This reference documents current compiler behavior. Compatibility is not yet promised.

src/sourceview.x

Request-owned source overlays.

Functions

SourceView

SourceView.cleanup

void SourceView.cleanup(SourceView)

Provides the class default for SourceView.cleanup.

See Classes and system macros for the default behavior.

Source: src/sourceview.x:17

SourceView.equal

int SourceView.equal(SourceView, SourceView)

Provides the class default for SourceView.equal.

See Classes and system macros for the default behavior.

Source: src/sourceview.x:17

SourceView.exists

int SourceView.exists(SourceView sources, String path)

Returns readable-file presence, including unsaved new files.

Source: src/sourceview.x:48

SourceView.free

void SourceView.free(SourceView)

Provides the class default for SourceView.free.

See Classes and system macros for the default behavior.

Source: src/sourceview.x:17

SourceView.hash

unsigned SourceView.hash(SourceView)

Provides the class default for SourceView.hash.

See Classes and system macros for the default behavior.

Source: src/sourceview.x:17

SourceView.init

void SourceView.init(SourceView sources)

Initializes empty overlays in the current request lifetime.

Source: src/sourceview.x:30

SourceView.is_changed

int SourceView.is_changed(SourceView sources, String path)

Returns whether this logical file has an unsaved overlay.

Source: src/sourceview.x:44

SourceView.new

SourceView SourceView.new(void)

Provides the class default for SourceView.new.

See Classes and system macros for the default behavior.

Source: src/sourceview.x:17

SourceView.read

int SourceView.read( SourceView sources, String path, String volatile *text)

Reads through the request overlay, falling back to a regular disk file. The return value distinguishes an empty file from a failed read. Disk text belongs to the calling unit; configured snapshots remain borrowed.

Source: src/sourceview.x:59

SourceView.repr

String SourceView.repr(SourceView)

Provides the class default for SourceView.repr.

See Classes and system macros for the default behavior.

Source: src/sourceview.x:17

SourceView.set

void SourceView.set(SourceView s, String path, String text, int changed)

Stores an immutable snapshot under its logical source path. Empty text is a present snapshot, not a request to fall back to the disk file.

Source: src/sourceview.x:38

SourceView.str

String SourceView.str(SourceView)

Provides the class default for SourceView.str.

See Classes and system macros for the default behavior.

Source: src/sourceview.x:17

SourceView.var

Var SourceView.var(SourceView)

Provides the class default for SourceView.var.

See Classes and system macros for the default behavior.

Source: src/sourceview.x:17

SourceView.write_repr

Buffer SourceView.write_repr(SourceView, Buffer)

Provides the class default for SourceView.write_repr.

See Classes and system macros for the default behavior.

Source: src/sourceview.x:17

SourceView.write_str

Buffer SourceView.write_str(SourceView, Buffer)

Provides the class default for SourceView.write_str.

See Classes and system macros for the default behavior.

Source: src/sourceview.x:17

Var

Var.sourceview

SourceView Var.sourceview(Var)

Provides the class default for Var.sourceview.

See Classes and system macros for the default behavior.

Source: src/sourceview.x:17

Public types

SourceView

class SourceView struct { Map overlays, dirty_paths; } *

Owns configured immutable overlays in the request’s active Context. A frontend and its units borrow this view. Text read from disk belongs to the reading unit, so the view never caches that shorter-lived text.

Source: src/sourceview.x:17

Design notes

Logical paths keep their identity when an editor supplies unsaved text. Configure this view before opening a frontend unit; its immutable values and Map must outlive every compiler borrowing it.