8 "github.com/mattn/go-runewidth"
9 "github.com/zyedidia/tcell"
12 // The View struct stores information about a view into a buffer.
13 // It stores information about the cursor, and the viewport
14 // that the user sees the buffer from.
16 // A pointer to the buffer's cursor for ease of access
19 // The topmost line, used for vertical scrolling
21 // The leftmost column, used for horizontal scrolling
24 // Percentage of the terminal window that this view takes up (from 0 to 100)
28 // Specifies whether or not this view holds a help buffer
31 // Actual with and height
35 // Where this view is located
38 // How much to offset because of line numbers
41 // Holds the list of gutter messages
42 messages map[string][]GutterMessage
44 // This is the index of this view in the views array
46 // What tab is this view stored in
54 // Since tcell doesn't differentiate between a mouse release event
55 // and a mouse move event with no keys pressed, we need to keep
56 // track of whether or not the mouse was pressed (or not released) last event to determine
57 // mouse release events
60 // This stores when the last click was
61 // This is useful for detecting double and triple clicks
62 lastClickTime time.Time
64 // lastCutTime stores when the last ctrl+k was issued.
65 // It is used for clearing the clipboard to replace it with fresh cut lines.
68 // freshClip returns true if the clipboard has never been pasted.
71 // Was the last mouse event actually a double click?
72 // Useful for detecting triple clicks -- if a double click is detected
73 // but the last mouse event was actually a double click, it's a triple click
75 // Same here, just to keep track for mouse move events
78 // Syntax highlighting matches
84 // NewView returns a new fullscreen view
85 func NewView(buf *Buffer) *View {
86 screenW, screenH := screen.Size()
87 return NewViewWidthHeight(buf, screenW, screenH)
90 // NewViewWidthHeight returns a new view with the specified width and height
91 // Note that w and h are raw column and row values
92 func NewViewWidthHeight(buf *Buffer, w, h int) *View {
104 v.messages = make(map[string][]GutterMessage)
106 v.sline = Statusline{
110 if v.Buf.Settings["statusline"].(bool) {
114 for _, pl := range loadedPlugins {
115 _, err := Call(pl+".onViewOpen", v)
116 if err != nil && !strings.HasPrefix(err.Error(), "function does not exist") {
125 func (v *View) ToggleStatusLine() {
126 if v.Buf.Settings["statusline"].(bool) {
133 func (v *View) ToggleTabbar() {
136 // Include one line for the tab bar at the top
148 func (v *View) paste(clip string) {
149 leadingWS := GetLeadingWhitespace(v.Buf.Line(v.Cursor.Y))
151 if v.Cursor.HasSelection() {
152 v.Cursor.DeleteSelection()
153 v.Cursor.ResetSelection()
155 clip = strings.Replace(clip, "\n", "\n"+leadingWS, -1)
156 v.Buf.Insert(v.Cursor.Loc, clip)
157 v.Cursor.Loc = v.Cursor.Loc.Move(Count(clip), v.Buf)
159 messenger.Message("Pasted clipboard")
162 // ScrollUp scrolls the view up n lines (if possible)
163 func (v *View) ScrollUp(n int) {
164 // Try to scroll by n but if it would overflow, scroll by 1
165 if v.Topline-n >= 0 {
167 } else if v.Topline > 0 {
172 // ScrollDown scrolls the view down n lines (if possible)
173 func (v *View) ScrollDown(n int) {
174 // Try to scroll by n but if it would overflow, scroll by 1
175 if v.Topline+n <= v.Buf.NumLines-v.height {
177 } else if v.Topline < v.Buf.NumLines-v.height {
182 // CanClose returns whether or not the view can be closed
183 // If there are unsaved changes, the user will be asked if the view can be closed
184 // causing them to lose the unsaved changes
185 func (v *View) CanClose() bool {
186 if v.Buf.IsModified {
187 char, canceled := messenger.LetterPrompt("Save changes to "+v.Buf.Name+" before closing? (y,n,esc) ", 'y', 'n')
192 } else if char == 'n' {
202 // OpenBuffer opens a new buffer in this view.
203 // This resets the topline, event handler and cursor.
204 func (v *View) OpenBuffer(buf *Buffer) {
208 v.Cursor = &buf.Cursor
211 v.Cursor.ResetSelection()
214 v.messages = make(map[string][]GutterMessage)
218 // Set mouseReleased to true because we assume the mouse is not being pressed when
219 // the editor is opened
220 v.mouseReleased = true
221 v.lastClickTime = time.Time{}
224 // CloseBuffer performs any closing functions on the buffer
225 func (v *View) CloseBuffer() {
231 // ReOpen reloads the current buffer
232 func (v *View) ReOpen() {
241 // HSplit opens a horizontal split with the given buffer
242 func (v *View) HSplit(buf *Buffer) bool {
243 v.splitNode.HSplit(buf)
244 tabs[v.TabNum].Resize()
248 // VSplit opens a vertical split with the given buffer
249 func (v *View) VSplit(buf *Buffer) bool {
250 v.splitNode.VSplit(buf)
251 tabs[v.TabNum].Resize()
255 // Relocate moves the view window so that the cursor is in view
256 // This is useful if the user has scrolled far away, and then starts typing
257 func (v *View) Relocate() bool {
260 scrollmargin := int(v.Buf.Settings["scrollmargin"].(float64))
261 if cy < v.Topline+scrollmargin && cy > scrollmargin-1 {
262 v.Topline = cy - scrollmargin
264 } else if cy < v.Topline {
268 if cy > v.Topline+v.height-1-scrollmargin && cy < v.Buf.NumLines-scrollmargin {
269 v.Topline = cy - v.height + 1 + scrollmargin
271 } else if cy >= v.Buf.NumLines-scrollmargin && cy > v.height {
272 v.Topline = v.Buf.NumLines - v.height
276 cx := v.Cursor.GetVisualX()
281 if cx+v.lineNumOffset+1 > v.leftCol+v.width {
282 v.leftCol = cx - v.width + v.lineNumOffset + 1
288 // MoveToMouseClick moves the cursor to location x, y assuming x, y were given
290 func (v *View) MoveToMouseClick(x, y int) {
291 if y-v.Topline > v.height-1 {
293 y = v.height + v.Topline - 1
295 if y >= v.Buf.NumLines {
296 y = v.Buf.NumLines - 1
305 x = v.Cursor.GetCharPosInLine(y, x)
306 if x > Count(v.Buf.Line(y)) {
307 x = Count(v.Buf.Line(y))
311 v.Cursor.LastVisualX = v.Cursor.GetVisualX()
314 // HandleEvent handles an event passed by the main loop
315 func (v *View) HandleEvent(event tcell.Event) {
316 // This bool determines whether the view is relocated at the end of the function
317 // By default it's true because most events should cause a relocate
322 switch e := event.(type) {
323 case *tcell.EventResize:
325 tabs[v.TabNum].Resize()
326 case *tcell.EventKey:
327 if e.Key() == tcell.KeyRune && (e.Modifiers() == 0 || e.Modifiers() == tcell.ModShift) {
328 // Insert a character
329 if v.Cursor.HasSelection() {
330 v.Cursor.DeleteSelection()
331 v.Cursor.ResetSelection()
333 v.Buf.Insert(v.Cursor.Loc, string(e.Rune()))
336 for _, pl := range loadedPlugins {
337 _, err := Call(pl+".onRune", string(e.Rune()), v)
338 if err != nil && !strings.HasPrefix(err.Error(), "function does not exist") {
344 curMacro = append(curMacro, e.Rune())
347 for key, actions := range bindings {
348 if e.Key() == key.keyCode {
349 if e.Key() == tcell.KeyRune {
350 if e.Rune() != key.r {
354 if e.Modifiers() == key.modifiers {
356 for _, action := range actions {
357 relocate = action(v, true) || relocate
358 funcName := FuncName(action)
359 if funcName != "main.(*View).ToggleMacro" && funcName != "main.(*View).PlayMacro" {
361 curMacro = append(curMacro, action)
369 case *tcell.EventPaste:
370 if !PreActionCall("Paste", v) {
374 leadingWS := GetLeadingWhitespace(v.Buf.Line(v.Cursor.Y))
376 if v.Cursor.HasSelection() {
377 v.Cursor.DeleteSelection()
378 v.Cursor.ResetSelection()
381 clip = strings.Replace(clip, "\n", "\n"+leadingWS, -1)
382 v.Buf.Insert(v.Cursor.Loc, clip)
383 v.Cursor.Loc = v.Cursor.Loc.Move(Count(clip), v.Buf)
385 messenger.Message("Pasted clipboard")
387 PostActionCall("Paste", v)
388 case *tcell.EventMouse:
390 x -= v.lineNumOffset - v.leftCol + v.x
392 // Don't relocate for mouse events
395 button := e.Buttons()
401 v.MoveToMouseClick(x, y)
402 if time.Since(v.lastClickTime)/time.Millisecond < doubleClickThreshold {
405 v.lastClickTime = time.Now()
408 v.doubleClick = false
410 v.Cursor.SelectLine()
413 v.lastClickTime = time.Now()
416 v.tripleClick = false
418 v.Cursor.SelectWord()
421 v.doubleClick = false
422 v.tripleClick = false
423 v.lastClickTime = time.Now()
425 v.Cursor.OrigSelection[0] = v.Cursor.Loc
426 v.Cursor.CurSelection[0] = v.Cursor.Loc
427 v.Cursor.CurSelection[1] = v.Cursor.Loc
429 v.mouseReleased = false
430 } else if !v.mouseReleased {
431 v.MoveToMouseClick(x, y)
433 v.Cursor.AddLineToSelection()
434 } else if v.doubleClick {
435 v.Cursor.AddWordToSelection()
437 v.Cursor.SetSelectionEnd(v.Cursor.Loc)
441 // Middle mouse button was clicked,
442 // We should paste primary
444 case tcell.ButtonNone:
445 // Mouse event with no click
446 if !v.mouseReleased {
447 // Mouse was just released
449 // Relocating here isn't really necessary because the cursor will
450 // be in the right place from the last mouse event
451 // However, if we are running in a terminal that doesn't support mouse motion
452 // events, this still allows the user to make selections, except only after they
455 if !v.doubleClick && !v.tripleClick {
456 v.MoveToMouseClick(x, y)
457 v.Cursor.SetSelectionEnd(v.Cursor.Loc)
459 v.mouseReleased = true
463 scrollspeed := int(v.Buf.Settings["scrollspeed"].(float64))
464 v.ScrollUp(scrollspeed)
465 case tcell.WheelDown:
467 scrollspeed := int(v.Buf.Settings["scrollspeed"].(float64))
468 v.ScrollDown(scrollspeed)
475 if v.Buf.Settings["syntax"].(bool) {
480 // GutterMessage creates a message in this view's gutter
481 func (v *View) GutterMessage(section string, lineN int, msg string, kind int) {
483 gutterMsg := GutterMessage{
488 for _, v := range v.messages {
489 for _, gmsg := range v {
490 if gmsg.lineNum == lineN {
495 messages := v.messages[section]
496 v.messages[section] = append(messages, gutterMsg)
499 // ClearGutterMessages clears all gutter messages from a given section
500 func (v *View) ClearGutterMessages(section string) {
501 v.messages[section] = []GutterMessage{}
504 // ClearAllGutterMessages clears all the gutter messages
505 func (v *View) ClearAllGutterMessages() {
506 for k := range v.messages {
507 v.messages[k] = []GutterMessage{}
511 // Opens the given help page in a new horizontal split
512 func (v *View) openHelp(helpPage string) {
514 helpBuffer := NewBuffer([]byte(helpPages[helpPage]), helpPage+".md")
515 helpBuffer.Name = "Help"
516 v.OpenBuffer(helpBuffer)
518 helpBuffer := NewBuffer([]byte(helpPages[helpPage]), helpPage+".md")
519 helpBuffer.Name = "Help"
521 CurView().Help = true
525 func (v *View) drawCell(x, y int, ch rune, combc []rune, style tcell.Style) {
526 if x >= v.x && x < v.x+v.width && y >= v.y && y < v.y+v.height {
527 screen.SetContent(x, y, ch, combc, style)
531 // DisplayView renders the view to the screen
532 func (v *View) DisplayView() {
533 // The charNum we are currently displaying
534 // starts at the start of the viewport
535 charNum := Loc{0, v.Topline}
537 // Convert the length of buffer to a string, and get the length of the string
538 // We are going to have to offset by that amount
539 maxLineLength := len(strconv.Itoa(v.Buf.NumLines))
541 if v.Buf.Settings["ruler"] == true {
542 // + 1 for the little space after the line number
543 v.lineNumOffset = maxLineLength + 1
548 // We need to add to the line offset if there are gutter messages
549 var hasGutterMessages bool
550 for _, v := range v.messages {
552 hasGutterMessages = true
555 if hasGutterMessages {
560 // One space for the extra split divider
564 // These represent the current screen coordinates
565 screenX, screenY := 0, 0
567 highlightStyle := defStyle
569 // ViewLine is the current line from the top of the viewport
570 for viewLine := 0; viewLine < v.height; viewLine++ {
571 screenY = v.y + viewLine
574 // This is the current line number of the buffer that we are drawing
575 curLineN := viewLine + v.Topline
578 // Draw the split divider
579 v.drawCell(screenX, screenY, '|', nil, defStyle.Reverse(true))
583 // If the buffer is smaller than the view height we have to clear all this space
584 if curLineN >= v.Buf.NumLines {
585 for i := screenX; i < v.x+v.width; i++ {
586 v.drawCell(i, screenY, ' ', nil, defStyle)
591 line := v.Buf.Line(curLineN)
593 // If there are gutter messages we need to display the '>>' symbol here
594 if hasGutterMessages {
595 // msgOnLine stores whether or not there is a gutter message on this line in particular
597 for k := range v.messages {
598 for _, msg := range v.messages[k] {
599 if msg.lineNum == curLineN {
601 gutterStyle := defStyle
604 if style, ok := colorscheme["gutter-info"]; ok {
608 if style, ok := colorscheme["gutter-warning"]; ok {
612 if style, ok := colorscheme["gutter-error"]; ok {
616 v.drawCell(screenX, screenY, '>', nil, gutterStyle)
618 v.drawCell(screenX, screenY, '>', nil, gutterStyle)
620 if v.Cursor.Y == curLineN && !messenger.hasPrompt {
621 messenger.Message(msg.msg)
622 messenger.gutterMessage = true
627 // If there is no message on this line we just display an empty offset
629 v.drawCell(screenX, screenY, ' ', nil, defStyle)
631 v.drawCell(screenX, screenY, ' ', nil, defStyle)
633 if v.Cursor.Y == curLineN && messenger.gutterMessage {
635 messenger.gutterMessage = false
640 if v.Buf.Settings["ruler"] == true {
641 // Write the line number
642 lineNumStyle := defStyle
643 if style, ok := colorscheme["line-number"]; ok {
646 if style, ok := colorscheme["current-line-number"]; ok {
647 if curLineN == v.Cursor.Y && tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() {
652 lineNum := strconv.Itoa(curLineN + 1)
654 // Write the spaces before the line number if necessary
655 for i := 0; i < maxLineLength-len(lineNum); i++ {
656 v.drawCell(screenX, screenY, ' ', nil, lineNumStyle)
659 // Write the actual line number
660 for _, ch := range lineNum {
661 v.drawCell(screenX, screenY, ch, nil, lineNumStyle)
665 // Write the extra space
666 v.drawCell(screenX, screenY, ' ', nil, lineNumStyle)
670 // Now we actually draw the line
672 for _, ch := range line {
673 lineStyle := defStyle
675 if v.Buf.Settings["syntax"].(bool) {
676 // Syntax highlighting is enabled
677 highlightStyle = v.matches[viewLine][colN]
680 if v.Cursor.HasSelection() &&
681 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
682 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
683 // The current character is selected
684 lineStyle = defStyle.Reverse(true)
686 if style, ok := colorscheme["selection"]; ok {
690 lineStyle = highlightStyle
693 // We need to display the background of the linestyle with the correct color if cursorline is enabled
694 // and this is the current view and there is no selection on this line and the cursor is on this line
695 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
696 if style, ok := colorscheme["cursor-line"]; ok {
697 fg, _, _ := style.Decompose()
698 lineStyle = lineStyle.Background(fg)
703 // If the character we are displaying is a tab, we need to do a bunch of special things
705 // First the user may have configured an `indent-char` to be displayed to show that this
706 // is a tab character
707 lineIndentStyle := defStyle
708 if style, ok := colorscheme["indent-char"]; ok {
709 lineIndentStyle = style
711 if v.Cursor.HasSelection() &&
712 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
713 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
715 lineIndentStyle = defStyle.Reverse(true)
717 if style, ok := colorscheme["selection"]; ok {
718 lineIndentStyle = style
721 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
722 if style, ok := colorscheme["cursor-line"]; ok {
723 fg, _, _ := style.Decompose()
724 lineIndentStyle = lineIndentStyle.Background(fg)
727 // Here we get the indent char
728 indentChar := []rune(v.Buf.Settings["indentchar"].(string))
729 if screenX-v.x-v.leftCol >= v.lineNumOffset {
730 v.drawCell(screenX-v.leftCol, screenY, indentChar[0], nil, lineIndentStyle)
732 // Now the tab has to be displayed as a bunch of spaces
733 tabSize := int(v.Buf.Settings["tabsize"].(float64))
734 for i := 0; i < tabSize-1; i++ {
736 if screenX-v.x-v.leftCol >= v.lineNumOffset {
737 v.drawCell(screenX-v.leftCol, screenY, ' ', nil, lineStyle)
740 } else if runewidth.RuneWidth(ch) > 1 {
741 if screenX-v.x-v.leftCol >= v.lineNumOffset {
742 v.drawCell(screenX, screenY, ch, nil, lineStyle)
744 for i := 0; i < runewidth.RuneWidth(ch)-1; i++ {
746 if screenX-v.x-v.leftCol >= v.lineNumOffset {
747 v.drawCell(screenX-v.leftCol, screenY, '<', nil, lineStyle)
751 if screenX-v.x-v.leftCol >= v.lineNumOffset {
752 v.drawCell(screenX-v.leftCol, screenY, ch, nil, lineStyle)
755 charNum = charNum.Move(1, v.Buf)
759 // Here we are at a newline
761 // The newline may be selected, in which case we should draw the selection style
762 // with a space to represent it
763 if v.Cursor.HasSelection() &&
764 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
765 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
767 selectStyle := defStyle.Reverse(true)
769 if style, ok := colorscheme["selection"]; ok {
772 v.drawCell(screenX, screenY, ' ', nil, selectStyle)
776 charNum = charNum.Move(1, v.Buf)
778 for i := 0; i < v.width; i++ {
779 lineStyle := defStyle
780 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
781 if style, ok := colorscheme["cursor-line"]; ok {
782 fg, _, _ := style.Decompose()
783 lineStyle = lineStyle.Background(fg)
786 if screenX-v.x-v.leftCol+i >= v.lineNumOffset {
787 v.drawCell(screenX-v.leftCol+i, screenY, ' ', nil, lineStyle)
793 // DisplayCursor draws the current buffer's cursor to the screen
794 func (v *View) DisplayCursor() {
795 // Don't draw the cursor if it is out of the viewport or if it has a selection
796 if (v.Cursor.Y-v.Topline < 0 || v.Cursor.Y-v.Topline > v.height-1) || v.Cursor.HasSelection() {
799 screen.ShowCursor(v.x+v.Cursor.GetVisualX()+v.lineNumOffset-v.leftCol, v.Cursor.Y-v.Topline+v.y)
803 // Display renders the view, the cursor, and statusline
804 func (v *View) Display() {
806 if v.Num == tabs[curTab].curView {
809 _, screenH := screen.Size()
810 if v.Buf.Settings["statusline"].(bool) {
812 } else if (v.y + v.height) != screenH-1 {
813 for x := 0; x < v.width; x++ {
814 screen.SetContent(v.x+x, v.y+v.height, '-', nil, defStyle.Reverse(true))