Improvements to embedding api to allow making your own 'screen'

pkg/moor/embed-api.go

@@ -75,6 +75,36 @@ func PageFromStream(reader io.Reader, options Options) error {
 	return pageFromReader(pagerReader, options)
 }
 
+// PageFromStreamWithScreen is like PageFromStream but lets the caller provide
+// a custom twin.Screen implementation instead of allocating one from the real
+// terminal. This enables embedding moor inside another TUI (e.g. a bubbletea
+// app): the caller implements twin.Screen to render moor's output into a pane
+// and feed keyboard/mouse events from the host TUI's event loop.
+//
+// Unlike PageFromStream, this function does not require stdout to be a
+// terminal - the caller's custom screen decides where output goes.
+//
+// PageFromStreamWithScreen blocks until the pager exits (the screen sends an EventExit).
+// Feed events to screen.Events() from another goroutine and run this in
+// its own goroutine if you need concurrent rendering.
+func PageFromStreamWithScreen(reader io.Reader, screen twin.Screen, options Options) error {
+	logs := startLogCollection()
+	defer collectLogs(logs)
+
+	pagerReader, err := internalReader.NewFromStream(
+		options.Title,
+		reader,
+		getColorFormatter(),
+		internalReader.ReaderOptions{
+			ShouldFormat: !options.NoAutoFormat,
+		})
+	if err != nil {
+		return err
+	}
+
+	return pageFromReaderWithScreen(pagerReader, screen, options)
+}
+
 // If stdout is not a terminal, the file contents will just be printed to
 // stdout.
 func PageFromFile(name string, options Options) error {
@@ -156,6 +186,15 @@ func getColorFormatter() chroma.Formatter {
 }
 
 func pageFromReader(reader *internalReader.ReaderImpl, options Options) error {
+	screen, e := twin.NewScreen()
+	if e != nil {
+		// Screen setup failed
+		return e
+	}
+	return pageFromReaderWithScreen(reader, screen, options)
+}
+
+func pageFromReaderWithScreen(reader *internalReader.ReaderImpl, screen twin.Screen, options Options) error {
 	// Closing the reader closes the stream it came from, which is what our
 	// callers promise their callers
 	defer reader.Close()
@@ -165,12 +204,6 @@ func pageFromReader(reader *internalReader.ReaderImpl, options Options) error {
 	pager.ShowLineNumbers = !options.NoLineNumbers
 	pager.QuitIfOneScreen = options.QuitIfOneScreen
 
-	screen, e := twin.NewScreen()
-	if e != nil {
-		// Screen setup failed
-		return e
-	}
-
 	style := internal.GetStyleForScreen(screen)
 	reader.SetStyleForHighlighting(style)
 

twin/events.go

@@ -47,3 +47,18 @@ func (eventKeyCode *EventKeyCode) KeyCode() KeyCode {
 func (eventMouse *EventMouse) Buttons() MouseButtonMask {
 	return eventMouse.buttons
 }
+
+// The following NewEvent* functions are meant to be used by embedding applications
+// to feed input into the pager.
+
+func NewEventRune(r rune) EventRune {
+	return EventRune{rune: r}
+}
+
+func NewEventKeyCode(keyCode KeyCode) EventKeyCode {
+	return EventKeyCode{keyCode: keyCode}
+}
+
+func NewEventMouse(buttons MouseButtonMask) EventMouse {
+	return EventMouse{buttons: buttons}
+}