Documentation
¶
Overview ¶
Package acme is a simple interface for interacting with acme windows.
Many of the functions in this package take a format string and optional parameters. In the documentation, the notation format, ... denotes the result of formatting the string and arguments using fmt.Sprintf.
Index ¶
- Variables
- func AutoExit(exit bool)
- func DeleteAll()
- func Err(src, msg string)
- func Errf(src, format string, args ...interface{})
- type Event
- type EventHandler
- type LogEvent
- type LogReader
- type Win
- func (w *Win) Addr(format string, args ...interface{}) error
- func (w *Win) Blink() (stop func())
- func (w *Win) Clear()
- func (w *Win) CloseFiles()
- func (w *Win) Ctl(format string, args ...interface{}) error
- func (w *Win) Del(sure bool) error
- func (w *Win) Err(msg string)
- func (w *Win) Errf(format string, args ...interface{})
- func (w *Win) EventChan() <-chan *Event
- func (w *Win) EventLoop(h EventHandler)
- func (w *Win) Font() (tab int, font *draw.Font, err error)
- func (w *Win) Fprintf(file, format string, args ...interface{}) error
- func (w *Win) ID() int
- func (w *Win) Name(format string, args ...interface{}) error
- func (w *Win) OpenEvent() error
- func (w *Win) PrintTabbed(text string)
- func (w *Win) Read(file string, b []byte) (n int, err error)
- func (w *Win) ReadAddr() (q0, q1 int, err error)
- func (w *Win) ReadAll(file string) ([]byte, error)
- func (w *Win) ReadEvent() (e *Event, err error)
- func (w *Win) Seek(file string, offset int64, whence int) (int64, error)
- func (w *Win) Selection() string
- func (w *Win) SetErrorPrefix(p string)
- func (w *Win) Sort(less func(x, y string) bool) error
- func (w *Win) Write(file string, b []byte) (n int, err error)
- func (w *Win) WriteEvent(e *Event) error
- type WinInfo
Constants ¶
This section is empty.
Variables ¶
var Address string
var Network string
Functions ¶
func AutoExit ¶
func AutoExit(exit bool)
AutoExit sets whether to call os.Exit the next time the last managed acme window is deleted. If there are no acme windows at the time of the call, the exit does not happen until one is created and then deleted.
Types ¶
type Event ¶
type Event struct {
// The two event characters, indicating origin and type of action
C1, C2 rune
// The character addresses of the action.
// If the original event had an empty selection (OrigQ0=OrigQ1)
// and was accompanied by an expansion (the 2 bit is set in Flag),
// then Q0 and Q1 will indicate the expansion rather than the
// original event.
Q0, Q1 int
// The Q0 and Q1 of the original event, even if it was expanded.
// If there was no expansion, OrigQ0=Q0 and OrigQ1=Q1.
OrigQ0, OrigQ1 int
// The flag bits.
Flag int
// The number of bytes in the optional text.
Nb int
// The number of characters (UTF-8 sequences) in the optional text.
Nr int
// The optional text itself, encoded in UTF-8.
Text []byte
// The chorded argument, if present (the 8 bit is set in the flag).
Arg []byte
// The chorded location, if present (the 8 bit is set in the flag).
Loc []byte
}
An Event represents an event originating in a particular window. The fields correspond to the fields in acme's event messages. See http://swtch.com/plan9port/man/man4/acme.html for details.
type LogReader ¶
type LogReader struct {
// contains filtered or unexported fields
}
A LogReader provides read access to the acme log file.
type Win ¶
type Win struct {
// contains filtered or unexported fields
}
A Win represents a single acme window and its control files.
func Open ¶
Open connects to the existing window with the given id. If ctl is non-nil, Open uses it as the window's control file and takes ownership of it.
func Show ¶
Show looks and causes acme to show the window with the given name, returning that window. If this process has not created a window with the given name (or if any such window has since been deleted), Show returns nil.
func (*Win) Blink ¶
func (w *Win) Blink() (stop func())
Blink starts the window tag blinking and returns a function that stops it. When stop returns, the blinking is over and the window state is clean.
func (*Win) CloseFiles ¶
func (w *Win) CloseFiles()
CloseFiles closes all the open files associated with the window w. (These file descriptors are cached across calls to Ctl, etc.)
func (*Win) Del ¶
Winctl deletes the window, writing `del' (or, if sure is true, `delete') to the ctl file.
func (*Win) Err ¶
Err finds or creates a window appropriate for showing errors related to w and then prints msg to that window. It adds a final newline to msg if needed.
func (*Win) EventChan ¶
EventChan returns a channel on which events can be read. The first call to EventChan allocates a channel and starts a new goroutine that loops calling ReadEvent and sending the result into the channel. Subsequent calls return the same channel. Clients should not call ReadEvent after calling EventChan.
func (*Win) EventLoop ¶
func (w *Win) EventLoop(h EventHandler)
func (*Win) PrintTabbed ¶
PrintTabbed prints tab-separated columnated text to body, replacing single tabs with runs of tabs as needed to align columns.
func (*Win) SetErrorPrefix ¶
func (*Win) Sort ¶
Sort sorts the lines in the current address range according to the comparison function.
func (*Win) WriteEvent ¶
WriteEvent writes an event back to the window's event file, indicating to acme that the event should be handled internally.
Source Files