9 "github.com/mattn/go-runewidth"
10 "github.com/mitchellh/go-homedir"
11 "github.com/zyedidia/tcell"
17 vtDefault ViewType = iota
22 // The View struct stores information about a view into a buffer.
23 // It stores information about the cursor, and the viewport
24 // that the user sees the buffer from.
26 // A pointer to the buffer's cursor for ease of access
29 // The topmost line, used for vertical scrolling
31 // The leftmost column, used for horizontal scrolling
34 // Specifies whether or not this view holds a help buffer
37 // Actual width and height
44 // Where this view is located
47 // How much to offset because of line numbers
50 // Holds the list of gutter messages
51 messages map[string][]GutterMessage
53 // This is the index of this view in the views array
55 // What tab is this view stored in
63 // Since tcell doesn't differentiate between a mouse release event
64 // and a mouse move event with no keys pressed, we need to keep
65 // track of whether or not the mouse was pressed (or not released) last event to determine
66 // mouse release events
69 // This stores when the last click was
70 // This is useful for detecting double and triple clicks
71 lastClickTime time.Time
73 // lastCutTime stores when the last ctrl+k was issued.
74 // It is used for clearing the clipboard to replace it with fresh cut lines.
77 // freshClip returns true if the clipboard has never been pasted.
80 // Was the last mouse event actually a double click?
81 // Useful for detecting triple clicks -- if a double click is detected
82 // but the last mouse event was actually a double click, it's a triple click
84 // Same here, just to keep track for mouse move events
87 // Syntax highlighting matches
93 // NewView returns a new fullscreen view
94 func NewView(buf *Buffer) *View {
95 screenW, screenH := screen.Size()
96 return NewViewWidthHeight(buf, screenW, screenH)
99 // NewViewWidthHeight returns a new view with the specified width and height
100 // Note that w and h are raw column and row values
101 func NewViewWidthHeight(buf *Buffer, w, h int) *View {
113 v.messages = make(map[string][]GutterMessage)
115 v.sline = Statusline{
119 if v.Buf.Settings["statusline"].(bool) {
123 for pl := range loadedPlugins {
124 _, err := Call(pl+".onViewOpen", v)
125 if err != nil && !strings.HasPrefix(err.Error(), "function does not exist") {
134 // ToggleStatusLine creates an extra row for the statusline if necessary
135 func (v *View) ToggleStatusLine() {
136 if v.Buf.Settings["statusline"].(bool) {
143 // ToggleTabbar creates an extra row for the tabbar if necessary
144 func (v *View) ToggleTabbar() {
147 // Include one line for the tab bar at the top
159 func (v *View) paste(clip string) {
160 leadingWS := GetLeadingWhitespace(v.Buf.Line(v.Cursor.Y))
162 if v.Cursor.HasSelection() {
163 v.Cursor.DeleteSelection()
164 v.Cursor.ResetSelection()
166 clip = strings.Replace(clip, "\n", "\n"+leadingWS, -1)
167 v.Buf.Insert(v.Cursor.Loc, clip)
168 v.Cursor.Loc = v.Cursor.Loc.Move(Count(clip), v.Buf)
170 messenger.Message("Pasted clipboard")
173 // ScrollUp scrolls the view up n lines (if possible)
174 func (v *View) ScrollUp(n int) {
175 // Try to scroll by n but if it would overflow, scroll by 1
176 if v.Topline-n >= 0 {
178 } else if v.Topline > 0 {
183 // ScrollDown scrolls the view down n lines (if possible)
184 func (v *View) ScrollDown(n int) {
185 // Try to scroll by n but if it would overflow, scroll by 1
186 if v.Topline+n <= v.Buf.NumLines-v.Height {
188 } else if v.Topline < v.Buf.NumLines-v.Height {
193 // CanClose returns whether or not the view can be closed
194 // If there are unsaved changes, the user will be asked if the view can be closed
195 // causing them to lose the unsaved changes
196 func (v *View) CanClose() bool {
197 if v.Type == vtDefault && v.Buf.IsModified {
200 if v.Buf.Settings["autosave"].(bool) {
203 char, canceled = messenger.LetterPrompt("Save changes to "+v.Buf.GetName()+" before closing? (y,n,esc) ", 'y', 'n')
209 } else if char == 'n' {
219 // OpenBuffer opens a new buffer in this view.
220 // This resets the topline, event handler and cursor.
221 func (v *View) OpenBuffer(buf *Buffer) {
225 v.Cursor = &buf.Cursor
228 v.Cursor.ResetSelection()
231 v.messages = make(map[string][]GutterMessage)
235 // Set mouseReleased to true because we assume the mouse is not being pressed when
236 // the editor is opened
237 v.mouseReleased = true
238 v.lastClickTime = time.Time{}
241 // Open opens the given file in the view
242 func (v *View) Open(filename string) {
243 home, _ := homedir.Dir()
244 filename = strings.Replace(filename, "~", home, 1)
245 file, err := os.Open(filename)
250 messenger.Message(err.Error())
251 // File does not exist -- create an empty buffer with that name
252 buf = NewBuffer(strings.NewReader(""), filename)
254 buf = NewBuffer(file, filename)
259 // CloseBuffer performs any closing functions on the buffer
260 func (v *View) CloseBuffer() {
266 // ReOpen reloads the current buffer
267 func (v *View) ReOpen() {
276 // HSplit opens a horizontal split with the given buffer
277 func (v *View) HSplit(buf *Buffer) {
279 if v.Buf.Settings["splitBottom"].(bool) {
282 v.splitNode.HSplit(buf, v.Num+i)
285 // VSplit opens a vertical split with the given buffer
286 func (v *View) VSplit(buf *Buffer) {
288 if v.Buf.Settings["splitRight"].(bool) {
291 v.splitNode.VSplit(buf, v.Num+i)
294 // HSplitIndex opens a horizontal split with the given buffer at the given index
295 func (v *View) HSplitIndex(buf *Buffer, splitIndex int) {
296 v.splitNode.HSplit(buf, splitIndex)
299 // VSplitIndex opens a vertical split with the given buffer at the given index
300 func (v *View) VSplitIndex(buf *Buffer, splitIndex int) {
301 v.splitNode.VSplit(buf, splitIndex)
304 // GetSoftWrapLocation gets the location of a visual click on the screen and converts it to col,line
305 func (v *View) GetSoftWrapLocation(vx, vy int) (int, int) {
306 if !v.Buf.Settings["softwrap"].(bool) {
307 vx = v.Cursor.GetCharPosInLine(vy, vx)
311 screenX, screenY := 0, v.Topline
312 for lineN := v.Topline; lineN < v.Bottomline(); lineN++ {
313 line := v.Buf.Line(lineN)
316 for _, ch := range line {
317 if screenX >= v.Width-v.lineNumOffset {
322 if screenX == vx && screenY == vy {
327 screenX += int(v.Buf.Settings["tabsize"].(float64)) - 1
343 func (v *View) Bottomline() int {
344 if !v.Buf.Settings["softwrap"].(bool) {
345 return v.Topline + v.Height
348 screenX, screenY := 0, 0
350 for lineN := v.Topline; lineN < v.Topline+v.Height; lineN++ {
351 line := v.Buf.Line(lineN)
354 for _, ch := range line {
355 if screenX >= v.Width-v.lineNumOffset {
361 screenX += int(v.Buf.Settings["tabsize"].(float64)) - 1
371 if screenY >= v.Height {
375 return numLines + v.Topline
378 // Relocate moves the view window so that the cursor is in view
379 // This is useful if the user has scrolled far away, and then starts typing
380 func (v *View) Relocate() bool {
381 height := v.Bottomline() - v.Topline
384 scrollmargin := int(v.Buf.Settings["scrollmargin"].(float64))
385 if cy < v.Topline+scrollmargin && cy > scrollmargin-1 {
386 v.Topline = cy - scrollmargin
388 } else if cy < v.Topline {
392 if cy > v.Topline+height-1-scrollmargin && cy < v.Buf.NumLines-scrollmargin {
393 v.Topline = cy - height + 1 + scrollmargin
395 } else if cy >= v.Buf.NumLines-scrollmargin && cy > height {
396 v.Topline = v.Buf.NumLines - height
400 if !v.Buf.Settings["softwrap"].(bool) {
401 cx := v.Cursor.GetVisualX()
406 if cx+v.lineNumOffset+1 > v.leftCol+v.Width {
407 v.leftCol = cx - v.Width + v.lineNumOffset + 1
414 // MoveToMouseClick moves the cursor to location x, y assuming x, y were given
416 func (v *View) MoveToMouseClick(x, y int) {
417 if y-v.Topline > v.Height-1 {
419 y = v.Height + v.Topline - 1
428 x, y = v.GetSoftWrapLocation(x, y)
429 // x = v.Cursor.GetCharPosInLine(y, x)
430 if x > Count(v.Buf.Line(y)) {
431 x = Count(v.Buf.Line(y))
435 v.Cursor.LastVisualX = v.Cursor.GetVisualX()
438 // HandleEvent handles an event passed by the main loop
439 func (v *View) HandleEvent(event tcell.Event) {
440 // This bool determines whether the view is relocated at the end of the function
441 // By default it's true because most events should cause a relocate
446 switch e := event.(type) {
447 case *tcell.EventResize:
449 tabs[v.TabNum].Resize()
450 case *tcell.EventKey:
451 // Check first if input is a key binding, if it is we 'eat' the input and don't insert a rune
453 if e.Key() != tcell.KeyRune || e.Modifiers() != 0 {
454 for key, actions := range bindings {
455 if e.Key() == key.keyCode {
456 if e.Key() == tcell.KeyRune {
457 if e.Rune() != key.r {
461 if e.Modifiers() == key.modifiers {
464 for _, action := range actions {
465 relocate = action(v, true) || relocate
466 funcName := FuncName(action)
467 if funcName != "main.(*View).ToggleMacro" && funcName != "main.(*View).PlayMacro" {
469 curMacro = append(curMacro, action)
478 if !isBinding && e.Key() == tcell.KeyRune {
479 // Insert a character
480 if v.Cursor.HasSelection() {
481 v.Cursor.DeleteSelection()
482 v.Cursor.ResetSelection()
484 v.Buf.Insert(v.Cursor.Loc, string(e.Rune()))
487 for pl := range loadedPlugins {
488 _, err := Call(pl+".onRune", string(e.Rune()), v)
489 if err != nil && !strings.HasPrefix(err.Error(), "function does not exist") {
495 curMacro = append(curMacro, e.Rune())
498 case *tcell.EventPaste:
499 if !PreActionCall("Paste", v) {
505 PostActionCall("Paste", v)
506 case *tcell.EventMouse:
508 x -= v.lineNumOffset - v.leftCol + v.x
510 // Don't relocate for mouse events
513 button := e.Buttons()
519 v.MoveToMouseClick(x, y)
520 if time.Since(v.lastClickTime)/time.Millisecond < doubleClickThreshold {
523 v.lastClickTime = time.Now()
526 v.doubleClick = false
528 v.Cursor.SelectLine()
531 v.lastClickTime = time.Now()
534 v.tripleClick = false
536 v.Cursor.SelectWord()
539 v.doubleClick = false
540 v.tripleClick = false
541 v.lastClickTime = time.Now()
543 v.Cursor.OrigSelection[0] = v.Cursor.Loc
544 v.Cursor.CurSelection[0] = v.Cursor.Loc
545 v.Cursor.CurSelection[1] = v.Cursor.Loc
547 v.mouseReleased = false
548 } else if !v.mouseReleased {
549 v.MoveToMouseClick(x, y)
551 v.Cursor.AddLineToSelection()
552 } else if v.doubleClick {
553 v.Cursor.AddWordToSelection()
555 v.Cursor.SetSelectionEnd(v.Cursor.Loc)
559 // Middle mouse button was clicked,
560 // We should paste primary
562 case tcell.ButtonNone:
563 // Mouse event with no click
564 if !v.mouseReleased {
565 // Mouse was just released
567 // Relocating here isn't really necessary because the cursor will
568 // be in the right place from the last mouse event
569 // However, if we are running in a terminal that doesn't support mouse motion
570 // events, this still allows the user to make selections, except only after they
573 if !v.doubleClick && !v.tripleClick {
574 v.MoveToMouseClick(x, y)
575 v.Cursor.SetSelectionEnd(v.Cursor.Loc)
577 v.mouseReleased = true
581 scrollspeed := int(v.Buf.Settings["scrollspeed"].(float64))
582 v.ScrollUp(scrollspeed)
583 case tcell.WheelDown:
585 scrollspeed := int(v.Buf.Settings["scrollspeed"].(float64))
586 v.ScrollDown(scrollspeed)
595 // GutterMessage creates a message in this view's gutter
596 func (v *View) GutterMessage(section string, lineN int, msg string, kind int) {
598 gutterMsg := GutterMessage{
603 for _, v := range v.messages {
604 for _, gmsg := range v {
605 if gmsg.lineNum == lineN {
610 messages := v.messages[section]
611 v.messages[section] = append(messages, gutterMsg)
614 // ClearGutterMessages clears all gutter messages from a given section
615 func (v *View) ClearGutterMessages(section string) {
616 v.messages[section] = []GutterMessage{}
619 // ClearAllGutterMessages clears all the gutter messages
620 func (v *View) ClearAllGutterMessages() {
621 for k := range v.messages {
622 v.messages[k] = []GutterMessage{}
626 // Opens the given help page in a new horizontal split
627 func (v *View) openHelp(helpPage string) {
628 if data, err := FindRuntimeFile(RTHelp, helpPage).Data(); err != nil {
629 TermMessage("Unable to load help text", helpPage, "\n", err)
631 helpBuffer := NewBuffer(strings.NewReader(string(data)), helpPage+".md")
632 helpBuffer.name = "Help"
634 if v.Type == vtHelp {
635 v.OpenBuffer(helpBuffer)
638 CurView().Type = vtHelp
643 func (v *View) drawCell(x, y int, ch rune, combc []rune, style tcell.Style) {
644 if x >= v.x && x < v.x+v.Width && y >= v.y && y < v.y+v.Height {
645 screen.SetContent(x, y, ch, combc, style)
649 // DisplayView renders the view to the screen
650 func (v *View) DisplayView() {
652 // Log views should always follow the cursor...
656 if v.Buf.Settings["syntax"].(bool) {
660 // The charNum we are currently displaying
661 // starts at the start of the viewport
662 charNum := Loc{0, v.Topline}
664 // Convert the length of buffer to a string, and get the length of the string
665 // We are going to have to offset by that amount
666 maxLineLength := len(strconv.Itoa(v.Buf.NumLines))
668 if v.Buf.Settings["ruler"] == true {
669 // + 1 for the little space after the line number
670 v.lineNumOffset = maxLineLength + 1
675 // We need to add to the line offset if there are gutter messages
676 var hasGutterMessages bool
677 for _, v := range v.messages {
679 hasGutterMessages = true
682 if hasGutterMessages {
687 // One space for the extra split divider
691 // These represent the current screen coordinates
692 screenX, screenY := v.x, v.y-1
694 highlightStyle := defStyle
697 // ViewLine is the current line from the top of the viewport
698 for viewLine := 0; viewLine < v.Height; viewLine++ {
702 // This is the current line number of the buffer that we are drawing
703 curLineN = viewLine + v.Topline
705 if screenY-v.y >= v.Height {
710 // Draw the split divider
711 v.drawCell(screenX, screenY, '|', nil, defStyle.Reverse(true))
715 // If the buffer is smaller than the view height we have to clear all this space
716 if curLineN >= v.Buf.NumLines {
717 for i := screenX; i < v.x+v.Width; i++ {
718 v.drawCell(i, screenY, ' ', nil, defStyle)
723 line := v.Buf.Line(curLineN)
725 // If there are gutter messages we need to display the '>>' symbol here
726 if hasGutterMessages {
727 // msgOnLine stores whether or not there is a gutter message on this line in particular
729 for k := range v.messages {
730 for _, msg := range v.messages[k] {
731 if msg.lineNum == curLineN {
733 gutterStyle := defStyle
736 if style, ok := colorscheme["gutter-info"]; ok {
740 if style, ok := colorscheme["gutter-warning"]; ok {
744 if style, ok := colorscheme["gutter-error"]; ok {
748 v.drawCell(screenX, screenY, '>', nil, gutterStyle)
750 v.drawCell(screenX, screenY, '>', nil, gutterStyle)
752 if v.Cursor.Y == curLineN && !messenger.hasPrompt {
753 messenger.Message(msg.msg)
754 messenger.gutterMessage = true
759 // If there is no message on this line we just display an empty offset
761 v.drawCell(screenX, screenY, ' ', nil, defStyle)
763 v.drawCell(screenX, screenY, ' ', nil, defStyle)
765 if v.Cursor.Y == curLineN && messenger.gutterMessage {
767 messenger.gutterMessage = false
772 lineNumStyle := defStyle
773 if v.Buf.Settings["ruler"] == true {
774 // Write the line number
775 if style, ok := colorscheme["line-number"]; ok {
778 if style, ok := colorscheme["current-line-number"]; ok {
779 if curLineN == v.Cursor.Y && tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() {
784 lineNum := strconv.Itoa(curLineN + 1)
786 // Write the spaces before the line number if necessary
787 for i := 0; i < maxLineLength-len(lineNum); i++ {
788 v.drawCell(screenX, screenY, ' ', nil, lineNumStyle)
791 // Write the actual line number
792 for _, ch := range lineNum {
793 v.drawCell(screenX, screenY, ch, nil, lineNumStyle)
797 // Write the extra space
798 v.drawCell(screenX, screenY, ' ', nil, lineNumStyle)
802 // Now we actually draw the line
805 tabSize := int(v.Buf.Settings["tabsize"].(float64))
806 for _, ch := range line {
807 if v.Buf.Settings["softwrap"].(bool) {
808 if screenX-v.x >= v.Width {
810 for i := 0; i < v.lineNumOffset; i++ {
811 screen.SetContent(v.x+i, screenY, ' ', nil, lineNumStyle)
813 screenX = v.x + v.lineNumOffset
817 if tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN && colN == v.Cursor.X {
818 v.DisplayCursor(screenX-v.leftCol, screenY)
821 lineStyle := defStyle
823 if v.Buf.Settings["syntax"].(bool) {
824 // Syntax highlighting is enabled
825 highlightStyle = v.matches[viewLine][colN]
828 if v.Cursor.HasSelection() &&
829 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
830 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
831 // The current character is selected
832 lineStyle = defStyle.Reverse(true)
834 if style, ok := colorscheme["selection"]; ok {
838 lineStyle = highlightStyle
841 // We need to display the background of the linestyle with the correct color if cursorline is enabled
842 // and this is the current view and there is no selection on this line and the cursor is on this line
843 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
844 if style, ok := colorscheme["cursor-line"]; ok {
845 fg, _, _ := style.Decompose()
846 lineStyle = lineStyle.Background(fg)
851 // If the character we are displaying is a tab, we need to do a bunch of special things
853 // First the user may have configured an `indent-char` to be displayed to show that this
854 // is a tab character
855 lineIndentStyle := defStyle
856 if style, ok := colorscheme["indent-char"]; ok && v.Buf.Settings["indentchar"].(string) != " " {
857 lineIndentStyle = style
859 if v.Cursor.HasSelection() &&
860 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
861 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
863 lineIndentStyle = defStyle.Reverse(true)
865 if style, ok := colorscheme["selection"]; ok {
866 lineIndentStyle = style
869 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
870 if style, ok := colorscheme["cursor-line"]; ok {
871 fg, _, _ := style.Decompose()
872 lineIndentStyle = lineIndentStyle.Background(fg)
875 // Here we get the indent char
876 indentChar := []rune(v.Buf.Settings["indentchar"].(string))
877 if screenX-v.x-v.leftCol >= v.lineNumOffset {
878 v.drawCell(screenX-v.leftCol, screenY, indentChar[0], nil, lineIndentStyle)
880 // Now the tab has to be displayed as a bunch of spaces
882 remainder := tabSize - (visLoc % tabSize)
883 for i := 0; i < remainder-1; i++ {
885 if screenX-v.x-v.leftCol >= v.lineNumOffset {
886 v.drawCell(screenX-v.leftCol, screenY, ' ', nil, lineStyle)
889 strWidth += remainder
890 } else if runewidth.RuneWidth(ch) > 1 {
891 if screenX-v.x-v.leftCol >= v.lineNumOffset {
892 v.drawCell(screenX, screenY, ch, nil, lineStyle)
894 for i := 0; i < runewidth.RuneWidth(ch)-1; i++ {
896 if screenX-v.x-v.leftCol >= v.lineNumOffset {
897 v.drawCell(screenX-v.leftCol, screenY, '<', nil, lineStyle)
900 strWidth += StringWidth(string(ch), tabSize)
902 if screenX-v.x-v.leftCol >= v.lineNumOffset {
903 v.drawCell(screenX-v.leftCol, screenY, ch, nil, lineStyle)
905 strWidth += StringWidth(string(ch), tabSize)
907 charNum = charNum.Move(1, v.Buf)
911 // Here we are at a newline
913 if tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN && colN == v.Cursor.X {
914 v.DisplayCursor(screenX-v.leftCol, screenY)
917 // The newline may be selected, in which case we should draw the selection style
918 // with a space to represent it
919 if v.Cursor.HasSelection() &&
920 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
921 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
923 selectStyle := defStyle.Reverse(true)
925 if style, ok := colorscheme["selection"]; ok {
928 v.drawCell(screenX, screenY, ' ', nil, selectStyle)
932 charNum = charNum.Move(1, v.Buf)
934 for i := 0; i < v.Width; i++ {
935 lineStyle := defStyle
936 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
937 if style, ok := colorscheme["cursor-line"]; ok {
938 fg, _, _ := style.Decompose()
939 lineStyle = lineStyle.Background(fg)
942 if screenX-v.x-v.leftCol+i >= v.lineNumOffset {
943 colorcolumn := int(v.Buf.Settings["colorcolumn"].(float64))
944 if colorcolumn != 0 && screenX-v.lineNumOffset+i == colorcolumn-1 {
945 if style, ok := colorscheme["color-column"]; ok {
946 fg, _, _ := style.Decompose()
947 lineStyle = lineStyle.Background(fg)
950 v.drawCell(screenX-v.leftCol+i, screenY, ' ', nil, lineStyle)
956 // DisplayCursor draws the current buffer's cursor to the screen
957 func (v *View) DisplayCursor(x, y int) {
958 // screen.ShowCursor(v.x+v.Cursor.GetVisualX()+v.lineNumOffset-v.leftCol, y)
959 screen.ShowCursor(x, y)
962 // Display renders the view, the cursor, and statusline
963 func (v *View) Display() {
965 // Don't draw the cursor if it is out of the viewport or if it has a selection
966 if (v.Cursor.Y-v.Topline < 0 || v.Cursor.Y-v.Topline > v.Height-1) || v.Cursor.HasSelection() {
969 _, screenH := screen.Size()
970 if v.Buf.Settings["statusline"].(bool) {
972 } else if (v.y + v.Height) != screenH-1 {
973 for x := 0; x < v.Width; x++ {
974 screen.SetContent(v.x+x, v.y+v.Height, '-', nil, defStyle.Reverse(true))