hooks

type Hook ¶

type Hook[T Hookable] struct {

	// Function to call on a node/bookmark
	Func func(T) error
	// contains filtered or unexported fields
}

A Hook is a function that takes a *Bookmark or *Node and runs an arbitrary process. Hooks are called during the loading or real time detection of bookmarks.

For example the TAG extraction process is handled by the ParseXTags hooks.

Hooks can also be used handle call custom user commands and messages found in the various fields of a bookmark.

func (h Hook[T]) Name() string

type HookMap ¶

type HookMap map[string]NamedHook

type HookRunner ¶

type HookRunner interface {

	// Calls all registered hooks on a node
	CallHooks(any) error
}

Browser who implement this interface will be able to register custom hooks which are called during the main Run() to handle commands and messages found in tags and parsed data from browsers

type Hookable ¶

type Hookable interface {
	*gosuki.Bookmark | *tree.Node
}

type MarkTab ¶

type MarkTab struct {
	Rules []Rule // Rules contains all the parsed rules from the marktab file.
}

MarkTab represents a collection of rules defined in the marktab file as lines.

type NamedHook ¶

type NamedHook interface {
	Name() string
}

type Rule ¶

type Rule struct {
	Trigger string // keyword to detect in the bookmark tags
	Pattern string // regular expression used for matching against the bookmark URL or title.
	Command string // shell command to execute when both the trigger and pattern match the bookmark tags.
	// contains filtered or unexported fields
}