package m import ( "fmt" "os" "regexp" "strconv" "time" "unicode" "unicode/utf8" log "github.com/sirupsen/logrus" "github.com/gdamore/tcell/v2" ) // FIXME: Profile the pager while searching through a large file type _PagerMode int const ( _Viewing _PagerMode = 0 _Searching _PagerMode = 1 _NotFound _PagerMode = 2 ) // Styling of line numbers var _NumberStyle = tcell.StyleDefault.Dim(true) // Pager is the main on-screen pager type Pager struct { reader *Reader screen tcell.Screen quit bool firstLineOneBased int leftColumnZeroBased int mode _PagerMode searchString string searchPattern *regexp.Regexp isShowingHelp bool preHelpState *_PreHelpState showLineNumbers bool } type _PreHelpState struct { reader *Reader firstLineOneBased int leftColumnZeroBased int } const _EofMarkerFormat = "\x1b[7m" // Reverse video var _HelpReader = NewReaderFromText("Help", ` Welcome to Moar, the nice pager! Quitting -------- * Press 'q' or ESC to quit Miscellaneous ------------- * Press CTRL-l to refresh screen if it has become garbled Moving around ------------- * Arrow keys * 'h', 'l' for left and right (as in vim) * Left / right can be used to hide / show line numbers * PageUp / 'b' and PageDown / 'f' * Half page 'u'p / 'd'own * Home and End for start / end of the document * < to go to the start of the document * > to go to the end of the document * RETURN moves down one line * SPACE moves down a page Searching --------- * Type / to start searching, then type what you want to find * Type RETURN to stop searching * Find next by typing 'n' (for "next") * Find previous by typing SHIFT-N or 'p' (for "previous") * Search is case sensitive if it contains any UPPER CASE CHARACTERS * Search is interpreted as a regexp if it is a valid one Reporting bugs -------------- File issues at https://github.com/walles/moar/issues, or post questions to johan.walles@gmail.com. Installing Moar as your default pager ------------------------------------- Put the following line in your .bashrc or .bash_profile: export PAGER=/usr/local/bin/moar.rb Source Code ----------- Available at https://github.com/walles/moar/. `) // NewPager creates a new Pager func NewPager(r *Reader) *Pager { return &Pager{ reader: r, quit: false, firstLineOneBased: 1, showLineNumbers: true, } } func (p *Pager) _AddLine(fileLineNumber *int, maxPrefixLength int, screenLineNumber int, line string) { screenWidth, _ := p.screen.Size() prefixLength := 0 lineNumberString := "" if maxPrefixLength > 0 && fileLineNumber != nil { prefixLength = maxPrefixLength lineNumberString = fmt.Sprintf("%*d ", prefixLength-1, *fileLineNumber) } for column, digit := range lineNumberString { if column >= prefixLength { break } p.screen.SetContent(column, screenLineNumber, digit, nil, _NumberStyle) } tokens := _CreateScreenLine(p.leftColumnZeroBased, screenWidth-prefixLength, line, p.searchPattern) for column, token := range tokens { p.screen.SetContent(column+prefixLength, screenLineNumber, token.Rune, nil, token.Style) } } func _CreateScreenLine( stringIndexAtColumnZero int, screenColumnsCount int, line string, search *regexp.Regexp, ) []Token { var returnMe []Token searchHitDelta := 0 if stringIndexAtColumnZero > 0 { // Indicate that it's possible to scroll left returnMe = append(returnMe, Token{ Rune: '<', Style: tcell.StyleDefault.Reverse(true), }) searchHitDelta = -1 } tokens, plainString := TokensFromString(line) if stringIndexAtColumnZero >= len(tokens) { // Nothing (more) to display, never mind return returnMe } matchRanges := GetMatchRanges(plainString, search) for _, token := range tokens[stringIndexAtColumnZero:] { if len(returnMe) >= screenColumnsCount { // We are trying to add a character to the right of the screen. // Indicate that this line continues to the right. returnMe[len(returnMe)-1] = Token{ Rune: '>', Style: tcell.StyleDefault.Reverse(true), } break } style := token.Style if matchRanges.InRange(len(returnMe) + stringIndexAtColumnZero + searchHitDelta) { // Search hits in reverse video style = style.Reverse(true) } returnMe = append(returnMe, Token{ Rune: token.Rune, Style: style, }) } return returnMe } func (p *Pager) _AddSearchFooter() { _, height := p.screen.Size() pos := 0 for _, token := range "Search: " + p.searchString { p.screen.SetContent(pos, height-1, token, nil, tcell.StyleDefault) pos++ } // Add a cursor p.screen.SetContent(pos, height-1, ' ', nil, tcell.StyleDefault.Reverse(true)) } func (p *Pager) _AddLines(spinner string) { _, height := p.screen.Size() wantedLineCount := height - 1 lines := p.reader.GetLines(p.firstLineOneBased, wantedLineCount) // If we're asking for past-the-end lines, the Reader will clip for us, // and we should adapt to that. Otherwise if you scroll 100 lines past // the end, you'll then have to scroll 100 lines up again before the // display starts scrolling visibly. p.firstLineOneBased = lines.firstLineOneBased // Count the length of the last line number // // Offsets figured out through trial-and-error... lastLineOneBased := lines.firstLineOneBased + len(lines.lines) - 1 maxPrefixLength := len(strconv.Itoa(lastLineOneBased)) + 1 if !p.showLineNumbers { maxPrefixLength = 0 } screenLineNumber := 0 for i, line := range lines.lines { lineNumber := p.firstLineOneBased + i p._AddLine(&lineNumber, maxPrefixLength, screenLineNumber, line) screenLineNumber++ } eofSpinner := spinner if eofSpinner == "" { // This happens when we're done eofSpinner = "---" } p._AddLine(nil, 0, screenLineNumber, _EofMarkerFormat+eofSpinner) switch p.mode { case _Searching: p._AddSearchFooter() case _NotFound: p._SetFooter("Not found: " + p.searchString) case _Viewing: helpText := "Press ESC / q to exit, '/' to search, '?' for help" if p.isShowingHelp { helpText = "Press ESC / q to exit help, '/' to search" } p._SetFooter(lines.statusText + spinner + " " + helpText) default: panic(fmt.Sprint("Unsupported pager mode: ", p.mode)) } } func (p *Pager) _SetFooter(footer string) { width, height := p.screen.Size() pos := 0 footerStyle := tcell.StyleDefault.Reverse(true) for _, token := range footer { p.screen.SetContent(pos, height-1, token, nil, footerStyle) pos++ } for ; pos < width; pos++ { p.screen.SetContent(pos, height-1, ' ', nil, footerStyle) } } func (p *Pager) _Redraw(spinner string) { p.screen.Clear() p._AddLines(spinner) p.screen.Show() } // Quit leaves the help screen or quits the pager func (p *Pager) Quit() { if !p.isShowingHelp { p.quit = true return } // Reset help p.isShowingHelp = false p.reader = p.preHelpState.reader p.firstLineOneBased = p.preHelpState.firstLineOneBased p.leftColumnZeroBased = p.preHelpState.leftColumnZeroBased p.preHelpState = nil } func (p *Pager) _ScrollToSearchHits() { if p.searchPattern == nil { // This is not a search return } firstHitLine := p._FindFirstHitLineOneBased(p.firstLineOneBased, false) if firstHitLine == nil { // No match, give up return } if *firstHitLine <= p._GetLastVisibleLineOneBased() { // Already on-screen, never mind return } p.firstLineOneBased = *firstHitLine } func (p *Pager) _GetLastVisibleLineOneBased() int { firstVisibleLineOneBased := p.firstLineOneBased _, windowHeight := p.screen.Size() // If first line is 1 and window is 2 high, and one line is the status // line, the last line will be 1 + 2 - 2 = 1 return firstVisibleLineOneBased + windowHeight - 2 } func (p *Pager) _FindFirstHitLineOneBased(firstLineOneBased int, backwards bool) *int { lineNumber := firstLineOneBased for { line := p.reader.GetLine(lineNumber) if line == nil { // No match, give up return nil } _, lineText := TokensFromString(*line) if p.searchPattern.MatchString(*lineText) { return &lineNumber } if backwards { lineNumber-- } else { lineNumber++ } } } func (p *Pager) _ScrollToNextSearchHit() { if p.searchPattern == nil { // Nothing to search for, never mind return } if p.reader.GetLineCount() == 0 { // Nothing to search in, never mind return } var firstSearchLineOneBased int switch p.mode { case _Viewing: // Start searching on the first line below the bottom of the screen firstSearchLineOneBased = p._GetLastVisibleLineOneBased() + 1 case _NotFound: // Restart searching from the top p.mode = _Viewing firstSearchLineOneBased = 1 default: panic(fmt.Sprint("Unknown search mode when finding next: ", p.mode)) } firstHitLine := p._FindFirstHitLineOneBased(firstSearchLineOneBased, false) if firstHitLine == nil { p.mode = _NotFound return } p.firstLineOneBased = *firstHitLine } func (p *Pager) _ScrollToPreviousSearchHit() { if p.searchPattern == nil { // Nothing to search for, never mind return } if p.reader.GetLineCount() == 0 { // Nothing to search in, never mind return } var firstSearchLineOneBased int switch p.mode { case _Viewing: // Start searching on the first line above the top of the screen firstSearchLineOneBased = p.firstLineOneBased - 1 case _NotFound: // Restart searching from the bottom p.mode = _Viewing firstSearchLineOneBased = p.reader.GetLineCount() default: panic(fmt.Sprint("Unknown search mode when finding previous: ", p.mode)) } firstHitLine := p._FindFirstHitLineOneBased(firstSearchLineOneBased, true) if firstHitLine == nil { p.mode = _NotFound return } p.firstLineOneBased = *firstHitLine } func (p *Pager) _UpdateSearchPattern() { p.searchPattern = ToPattern(p.searchString) p._ScrollToSearchHits() // FIXME: If the user is typing, indicate to user if we didn't find anything } // ToPattern compiles a search string into a pattern. // // If the string contains only lower-case letter the pattern will be case insensitive. // // If the string is empty the pattern will be nil. // // If the string does not compile into a regexp the pattern will match the string verbatim func ToPattern(compileMe string) *regexp.Regexp { if len(compileMe) == 0 { return nil } hasUppercase := false for _, char := range compileMe { if unicode.IsUpper(char) { hasUppercase = true } } // Smart case; be case insensitive unless there are upper case chars // in the search string prefix := "(?i)" if hasUppercase { prefix = "" } pattern, err := regexp.Compile(prefix + compileMe) if err == nil { // Search string is a regexp return pattern } pattern, err = regexp.Compile(prefix + regexp.QuoteMeta(compileMe)) if err == nil { // Pattern matching the string exactly return pattern } // Unable to create a match-string-verbatim pattern panic(err) } // From: https://stackoverflow.com/a/57005674/473672 func removeLastChar(s string) string { r, size := utf8.DecodeLastRuneInString(s) if r == utf8.RuneError && (size == 0 || size == 1) { size = 0 } return s[:len(s)-size] } func (p *Pager) _OnSearchKey(key tcell.Key) { switch key { case tcell.KeyEscape, tcell.KeyEnter: p.mode = _Viewing case tcell.KeyBackspace, tcell.KeyDEL: if len(p.searchString) == 0 { return } p.searchString = removeLastChar(p.searchString) p._UpdateSearchPattern() case tcell.KeyUp: // Clipping is done in _AddLines() p.firstLineOneBased-- p.mode = _Viewing case tcell.KeyDown: // Clipping is done in _AddLines() p.firstLineOneBased++ p.mode = _Viewing case tcell.KeyPgUp: _, height := p.screen.Size() p.firstLineOneBased -= (height - 1) p.mode = _Viewing case tcell.KeyPgDn: _, height := p.screen.Size() p.firstLineOneBased += (height - 1) p.mode = _Viewing default: log.Debugf("Unhandled search key event %v", key) } } func (p *Pager) _MoveRight(delta int) { if p.showLineNumbers && delta > 0 { p.showLineNumbers = false return } if p.leftColumnZeroBased == 0 && delta < 0 { p.showLineNumbers = true return } result := p.leftColumnZeroBased + delta if result < 0 { p.leftColumnZeroBased = 0 } else { p.leftColumnZeroBased = result } } func (p *Pager) _OnKey(key tcell.Key) { if key == tcell.KeyCtrlL { // This is useful when we're piping in from something writing to both // stdout and stderr. p.screen.Sync() return } if p.mode == _Searching { p._OnSearchKey(key) return } if p.mode != _Viewing && p.mode != _NotFound { panic(fmt.Sprint("Unhandled mode: ", p.mode)) } // Reset the not-found marker on non-search keypresses p.mode = _Viewing switch key { case tcell.KeyEscape: p.Quit() case tcell.KeyUp: // Clipping is done in _AddLines() p.firstLineOneBased-- case tcell.KeyDown, tcell.KeyEnter: // Clipping is done in _AddLines() p.firstLineOneBased++ case tcell.KeyRight: p._MoveRight(16) case tcell.KeyLeft: p._MoveRight(-16) case tcell.KeyHome: p.firstLineOneBased = 1 case tcell.KeyEnd: p.firstLineOneBased = p.reader.GetLineCount() case tcell.KeyPgDn: _, height := p.screen.Size() p.firstLineOneBased += (height - 1) case tcell.KeyPgUp: _, height := p.screen.Size() p.firstLineOneBased -= (height - 1) default: log.Debugf("Unhandled key event %v", key) } } func (p *Pager) _OnSearchRune(char rune) { p.searchString = p.searchString + string(char) p._UpdateSearchPattern() } func (p *Pager) _OnRune(char rune) { if p.mode == _Searching { p._OnSearchRune(char) return } if p.mode != _Viewing && p.mode != _NotFound { panic(fmt.Sprint("Unhandled mode: ", p.mode)) } switch char { case 'q': p.Quit() case '?': if !p.isShowingHelp { p.preHelpState = &_PreHelpState{ reader: p.reader, firstLineOneBased: p.firstLineOneBased, leftColumnZeroBased: p.leftColumnZeroBased, } p.reader = _HelpReader p.firstLineOneBased = 1 p.leftColumnZeroBased = 0 p.isShowingHelp = true } case 'k', 'y': // Clipping is done in _AddLines() p.firstLineOneBased-- case 'j', 'e': // Clipping is done in _AddLines() p.firstLineOneBased++ case 'l': // vim right p._MoveRight(16) case 'h': // vim left p._MoveRight(-16) case '<', 'g': p.firstLineOneBased = 1 case '>', 'G': p.firstLineOneBased = p.reader.GetLineCount() case 'f', ' ': _, height := p.screen.Size() p.firstLineOneBased += (height - 1) case 'b': _, height := p.screen.Size() p.firstLineOneBased -= (height - 1) case 'u': _, height := p.screen.Size() p.firstLineOneBased -= (height / 2) case 'd': _, height := p.screen.Size() p.firstLineOneBased += (height / 2) case '/': p.mode = _Searching p.searchString = "" p.searchPattern = nil case 'n': p._ScrollToNextSearchHit() case 'p', 'N': p._ScrollToPreviousSearchHit() default: log.Debugf("Unhandled rune keypress '%s'", string(char)) } } // StartPaging brings up the pager on screen func (p *Pager) StartPaging(screen tcell.Screen) { // We want to match the terminal theme, see screen.Init() source code os.Setenv("TCELL_TRUECOLOR", "disable") SetManPageFormatFromEnv() if e := screen.Init(); e != nil { fmt.Fprintf(os.Stderr, "%v\n", e) os.Exit(1) } p.screen = screen screen.EnableMouse() screen.Show() p._Redraw("") go func() { for { // Wait for new lines to appear <-p.reader.moreLinesAdded screen.PostEvent(tcell.NewEventInterrupt(nil)) // Delay updates a bit so that we don't waste time refreshing // the screen too often. // // Note that the delay is *after* reacting, this way single-line // updates are reacted to immediately, and the first output line // read will appear on screen without delay. time.Sleep(200 * time.Millisecond) } }() go func() { done := false spinnerFrames := [...]string{"/.\\", "-o-", "\\O/", "| |"} spinnerIndex := 0 for { // Break this loop on the reader.done signal... select { case <-p.reader.done: done = true default: // This default case makes this an async read } if done { break } screen.PostEvent(tcell.NewEventInterrupt(spinnerFrames[spinnerIndex])) spinnerIndex++ if spinnerIndex >= len(spinnerFrames) { spinnerIndex = 0 } time.Sleep(200 * time.Millisecond) } // Empty our spinner, loading done! screen.PostEvent(tcell.NewEventInterrupt("")) }() // Main loop spinner := "" for !p.quit { ev := screen.PollEvent() switch ev := ev.(type) { case *tcell.EventKey: if ev.Key() == tcell.KeyRune { p._OnRune(ev.Rune()) } else { p._OnKey(ev.Key()) } case *tcell.EventMouse: switch ev.Buttons() { case tcell.WheelUp: // Clipping is done in _AddLines() p.firstLineOneBased-- case tcell.WheelDown: // Clipping is done in _AddLines() p.firstLineOneBased++ case tcell.WheelRight: p._MoveRight(16) case tcell.WheelLeft: p._MoveRight(-16) } case *tcell.EventResize: // We'll be implicitly redrawn just by taking another lap in the loop case *tcell.EventInterrupt: // This means we got more lines, look for NewEventInterrupt higher up // in this file. Doing nothing here is fine, the refresh happens after // this switch statement. data := ev.Data() if data != nil { // From: https://yourbasic.org/golang/interface-to-string/ spinner = fmt.Sprintf("%v", data) } default: log.Warnf("Unhandled event type: %v", ev) } // FIXME: If more events are ready, skip this redraw, that // should speed up mouse wheel scrolling p._Redraw(spinner) } if p.reader.err != nil { log.Warnf("Reader reported an error: %s", p.reader.err.Error()) } }