core

package

v0.7.0 Latest Latest Go to latest Published: Dec 10, 2023 License: GPL-3.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

git.sr.ht/~nelsam/vidar

Links

Open Source Insights

Documentation ¶

Overview ¶

Package core contains the core logic of vidar itself. Many of the types in this package are intended to be used by external plugins, but should generally not be *imported*. It is better to define an interface type in your local code than to import this package to get access to a type. The exported types and sub-packages provided in core are exported for documentation reasons, not because they should be referenced directly.

Index ¶

func LoadActions(ctx context.Context, c ui.Creator) (all []input.Action, _ error)
func LoadUIs(_ context.Context) ([]ui.NamedConstructor, error)
func Start(ctx context.Context, actions []input.Action) error
type Globber
type InternalSetter

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func LoadActions ¶

func LoadActions(ctx context.Context, c ui.Creator) (all []input.Action, _ error)

LoadActions returns all of the input.Action types that core knows about.

func LoadUIs ¶

func LoadUIs(_ context.Context) ([]ui.NamedConstructor, error)

LoadUIs returns all of the UI libraries that core knows about.

func Start ¶

func Start(ctx context.Context, actions []input.Action) error

Start opens the first window, effectively starting vidar.

Types ¶

type Globber ¶

type Globber interface {
	Glob(context.Context, string) []string
}

Globber is a type which can glob files.

type InternalSetter ¶

type InternalSetter interface {
	SetActions(context.Context, []internal.Action)
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
internal internal contains the core parts of vidar that make it work as a text editor.	internal contains the core parts of vidar that make it work as a text editor.
gxui Package gxui contains wrappers to make the gxui library act like a (git.sr.ht/~nelsam/vidar-lib/ui).Creator.	Package gxui contains wrappers to make the gxui library act like a (git.sr.ht/~nelsam/vidar-lib/ui).Creator.
op Package op has sub-packages that provide core operations that can be used by plugins and built-ins to either to change the editor's state or to trigger hooks from changes to the editor's state.	Package op has sub-packages that provide core operations that can be used by plugins and built-ins to either to change the editor's state or to trigger hooks from changes to the editor's state.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL