//go:build darwin || freebsd || netbsd || openbsd // +build darwin freebsd netbsd openbsd // nolint:revive package tea import ( "errors" "fmt" "io" "os" "strings" "golang.org/x/sys/unix" ) // newkqueueCancelReader returns a reader and a cancel function. If the input reader // is an *os.File, the cancel function can be used to interrupt a blocking call // read call. In this case, the cancel function returns true if the call was // cancelled successfully. If the input reader is not a *os.File, the cancel // function does nothing and always returns false. The BSD and macOS // implementation is based on the kqueue mechanism. func newCancelReader(reader io.Reader) (cancelReader, error) { file, ok := reader.(*os.File) if !ok { return newFallbackCancelReader(reader) } // kqueue returns instantly when polling /dev/tty so fallback to select if file.Name() == "/dev/tty" { return newSelectCancelReader(reader) } kQueue, err := unix.Kqueue() if err != nil { return nil, fmt.Errorf("create kqueue: %w", err) } r := &kqueueCancelReader{ file: file, kQueue: kQueue, } r.cancelSignalReader, r.cancelSignalWriter, err = os.Pipe() if err != nil { return nil, err } unix.SetKevent(&r.kQueueEvents[0], int(file.Fd()), unix.EVFILT_READ, unix.EV_ADD) unix.SetKevent(&r.kQueueEvents[1], int(r.cancelSignalReader.Fd()), unix.EVFILT_READ, unix.EV_ADD) return r, nil } type kqueueCancelReader struct { file *os.File cancelSignalReader *os.File cancelSignalWriter *os.File cancelMixin kQueue int kQueueEvents [2]unix.Kevent_t } func (r *kqueueCancelReader) Read(data []byte) (int, error) { if r.isCancelled() { return 0, errCanceled } err := r.wait() if err != nil { if errors.Is(err, errCanceled) { // remove signal from pipe var b [1]byte _, errRead := r.cancelSignalReader.Read(b[:]) if errRead != nil { return 0, fmt.Errorf("reading cancel signal: %w", errRead) } } return 0, err } return r.file.Read(data) } func (r *kqueueCancelReader) Cancel() bool { r.setCancelled() // send cancel signal _, err := r.cancelSignalWriter.Write([]byte{'c'}) return err == nil } func (r *kqueueCancelReader) Close() error { var errMsgs []string // close kqueue err := unix.Close(r.kQueue) if err != nil { errMsgs = append(errMsgs, fmt.Sprintf("closing kqueue: %v", err)) } // close pipe err = r.cancelSignalWriter.Close() if err != nil { errMsgs = append(errMsgs, fmt.Sprintf("closing cancel signal writer: %v", err)) } err = r.cancelSignalReader.Close() if err != nil { errMsgs = append(errMsgs, fmt.Sprintf("closing cancel signal reader: %v", err)) } if len(errMsgs) > 0 { return fmt.Errorf(strings.Join(errMsgs, ", ")) } return nil } func (r *kqueueCancelReader) wait() error { events := make([]unix.Kevent_t, 1) for { _, err := unix.Kevent(r.kQueue, r.kQueueEvents[:], events, nil) if errors.Is(err, unix.EINTR) { continue // try again if the syscall was interrupted } if err != nil { return fmt.Errorf("kevent: %w", err) } break } ident := uint64(events[0].Ident) switch ident { case uint64(r.file.Fd()): return nil case uint64(r.cancelSignalReader.Fd()): return errCanceled } return fmt.Errorf("unknown error") }