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 := ioutil.ReadFile(filename)
249 messenger.Message(err.Error())
250 // File does not exist -- create an empty buffer with that name
251 buf = NewBuffer([]byte{}, filename)
253 buf = NewBuffer(file, filename)
258 // CloseBuffer performs any closing functions on the buffer
259 func (v *View) CloseBuffer() {
265 // ReOpen reloads the current buffer
266 func (v *View) ReOpen() {
275 // HSplit opens a horizontal split with the given buffer
276 func (v *View) HSplit(buf *Buffer) {
278 if v.Buf.Settings["splitBottom"].(bool) {
281 v.splitNode.HSplit(buf, v.Num+i)
284 // VSplit opens a vertical split with the given buffer
285 func (v *View) VSplit(buf *Buffer) {
287 if v.Buf.Settings["splitRight"].(bool) {
290 v.splitNode.VSplit(buf, v.Num+i)
293 // HSplitIndex opens a horizontal split with the given buffer at the given index
294 func (v *View) HSplitIndex(buf *Buffer, splitIndex int) {
295 v.splitNode.HSplit(buf, splitIndex)
298 // VSplitIndex opens a vertical split with the given buffer at the given index
299 func (v *View) VSplitIndex(buf *Buffer, splitIndex int) {
300 v.splitNode.VSplit(buf, splitIndex)
303 // GetSoftWrapLocation gets the location of a visual click on the screen and converts it to col,line
304 func (v *View) GetSoftWrapLocation(vx, vy int) (int, int) {
305 if !v.Buf.Settings["softwrap"].(bool) {
306 vx = v.Cursor.GetCharPosInLine(vy, vx)
310 screenX, screenY := 0, v.Topline
311 for lineN := v.Topline; lineN < v.Bottomline(); lineN++ {
312 line := v.Buf.Line(lineN)
315 for _, ch := range line {
316 if screenX >= v.Width-v.lineNumOffset {
321 if screenX == vx && screenY == vy {
326 screenX += int(v.Buf.Settings["tabsize"].(float64)) - 1
342 func (v *View) Bottomline() int {
343 if !v.Buf.Settings["softwrap"].(bool) {
344 return v.Topline + v.Height
347 screenX, screenY := 0, 0
349 for lineN := v.Topline; lineN < v.Topline+v.Height; lineN++ {
350 line := v.Buf.Line(lineN)
353 for _, ch := range line {
354 if screenX >= v.Width-v.lineNumOffset {
360 screenX += int(v.Buf.Settings["tabsize"].(float64)) - 1
370 if screenY >= v.Height {
374 return numLines + v.Topline
377 // Relocate moves the view window so that the cursor is in view
378 // This is useful if the user has scrolled far away, and then starts typing
379 func (v *View) Relocate() bool {
380 height := v.Bottomline() - v.Topline
383 scrollmargin := int(v.Buf.Settings["scrollmargin"].(float64))
384 if cy < v.Topline+scrollmargin && cy > scrollmargin-1 {
385 v.Topline = cy - scrollmargin
387 } else if cy < v.Topline {
391 if cy > v.Topline+height-1-scrollmargin && cy < v.Buf.NumLines-scrollmargin {
392 v.Topline = cy - height + 1 + scrollmargin
394 } else if cy >= v.Buf.NumLines-scrollmargin && cy > height {
395 v.Topline = v.Buf.NumLines - height
399 if !v.Buf.Settings["softwrap"].(bool) {
400 cx := v.Cursor.GetVisualX()
405 if cx+v.lineNumOffset+1 > v.leftCol+v.Width {
406 v.leftCol = cx - v.Width + v.lineNumOffset + 1
413 // MoveToMouseClick moves the cursor to location x, y assuming x, y were given
415 func (v *View) MoveToMouseClick(x, y int) {
416 if y-v.Topline > v.Height-1 {
418 y = v.Height + v.Topline - 1
420 if y >= v.Buf.NumLines {
421 y = v.Buf.NumLines - 1
430 x, y = v.GetSoftWrapLocation(x, y)
431 // x = v.Cursor.GetCharPosInLine(y, x)
432 if x > Count(v.Buf.Line(y)) {
433 x = Count(v.Buf.Line(y))
437 v.Cursor.LastVisualX = v.Cursor.GetVisualX()
440 // HandleEvent handles an event passed by the main loop
441 func (v *View) HandleEvent(event tcell.Event) {
442 // This bool determines whether the view is relocated at the end of the function
443 // By default it's true because most events should cause a relocate
448 switch e := event.(type) {
449 case *tcell.EventResize:
451 tabs[v.TabNum].Resize()
452 case *tcell.EventKey:
453 // Check first if input is a key binding, if it is we 'eat' the input and don't insert a rune
455 if e.Key() != tcell.KeyRune || e.Modifiers() != 0 {
456 for key, actions := range bindings {
457 if e.Key() == key.keyCode {
458 if e.Key() == tcell.KeyRune {
459 if e.Rune() != key.r {
463 if e.Modifiers() == key.modifiers {
466 for _, action := range actions {
467 relocate = action(v, true) || relocate
468 funcName := FuncName(action)
469 if funcName != "main.(*View).ToggleMacro" && funcName != "main.(*View).PlayMacro" {
471 curMacro = append(curMacro, action)
480 if !isBinding && e.Key() == tcell.KeyRune {
481 // Insert a character
482 if v.Cursor.HasSelection() {
483 v.Cursor.DeleteSelection()
484 v.Cursor.ResetSelection()
486 v.Buf.Insert(v.Cursor.Loc, string(e.Rune()))
489 for _, pl := range loadedPlugins {
490 _, err := Call(pl+".onRune", string(e.Rune()), v)
491 if err != nil && !strings.HasPrefix(err.Error(), "function does not exist") {
497 curMacro = append(curMacro, e.Rune())
500 case *tcell.EventPaste:
501 if !PreActionCall("Paste", v) {
507 PostActionCall("Paste", v)
508 case *tcell.EventMouse:
510 x -= v.lineNumOffset - v.leftCol + v.x
512 // Don't relocate for mouse events
515 button := e.Buttons()
521 v.MoveToMouseClick(x, y)
522 if time.Since(v.lastClickTime)/time.Millisecond < doubleClickThreshold {
525 v.lastClickTime = time.Now()
528 v.doubleClick = false
530 v.Cursor.SelectLine()
533 v.lastClickTime = time.Now()
536 v.tripleClick = false
538 v.Cursor.SelectWord()
541 v.doubleClick = false
542 v.tripleClick = false
543 v.lastClickTime = time.Now()
545 v.Cursor.OrigSelection[0] = v.Cursor.Loc
546 v.Cursor.CurSelection[0] = v.Cursor.Loc
547 v.Cursor.CurSelection[1] = v.Cursor.Loc
549 v.mouseReleased = false
550 } else if !v.mouseReleased {
551 v.MoveToMouseClick(x, y)
553 v.Cursor.AddLineToSelection()
554 } else if v.doubleClick {
555 v.Cursor.AddWordToSelection()
557 v.Cursor.SetSelectionEnd(v.Cursor.Loc)
561 // Middle mouse button was clicked,
562 // We should paste primary
564 case tcell.ButtonNone:
565 // Mouse event with no click
566 if !v.mouseReleased {
567 // Mouse was just released
569 // Relocating here isn't really necessary because the cursor will
570 // be in the right place from the last mouse event
571 // However, if we are running in a terminal that doesn't support mouse motion
572 // events, this still allows the user to make selections, except only after they
575 if !v.doubleClick && !v.tripleClick {
576 v.MoveToMouseClick(x, y)
577 v.Cursor.SetSelectionEnd(v.Cursor.Loc)
579 v.mouseReleased = true
583 scrollspeed := int(v.Buf.Settings["scrollspeed"].(float64))
584 v.ScrollUp(scrollspeed)
585 case tcell.WheelDown:
587 scrollspeed := int(v.Buf.Settings["scrollspeed"].(float64))
588 v.ScrollDown(scrollspeed)
597 // GutterMessage creates a message in this view's gutter
598 func (v *View) GutterMessage(section string, lineN int, msg string, kind int) {
600 gutterMsg := GutterMessage{
605 for _, v := range v.messages {
606 for _, gmsg := range v {
607 if gmsg.lineNum == lineN {
612 messages := v.messages[section]
613 v.messages[section] = append(messages, gutterMsg)
616 // ClearGutterMessages clears all gutter messages from a given section
617 func (v *View) ClearGutterMessages(section string) {
618 v.messages[section] = []GutterMessage{}
621 // ClearAllGutterMessages clears all the gutter messages
622 func (v *View) ClearAllGutterMessages() {
623 for k := range v.messages {
624 v.messages[k] = []GutterMessage{}
628 // Opens the given help page in a new horizontal split
629 func (v *View) openHelp(helpPage string) {
630 if data, err := FindRuntimeFile(RTHelp, helpPage).Data(); err != nil {
631 TermMessage("Unable to load help text", helpPage, "\n", err)
633 helpBuffer := NewBuffer(data, helpPage+".md")
634 helpBuffer.name = "Help"
636 if v.Type == vtHelp {
637 v.OpenBuffer(helpBuffer)
640 CurView().Type = vtHelp
645 func (v *View) drawCell(x, y int, ch rune, combc []rune, style tcell.Style) {
646 if x >= v.x && x < v.x+v.Width && y >= v.y && y < v.y+v.Height {
647 screen.SetContent(x, y, ch, combc, style)
651 // DisplayView renders the view to the screen
652 func (v *View) DisplayView() {
654 // Log views should always follow the cursor...
658 if v.Buf.Settings["syntax"].(bool) {
662 // The charNum we are currently displaying
663 // starts at the start of the viewport
664 charNum := Loc{0, v.Topline}
666 // Convert the length of buffer to a string, and get the length of the string
667 // We are going to have to offset by that amount
668 maxLineLength := len(strconv.Itoa(v.Buf.NumLines))
670 if v.Buf.Settings["ruler"] == true {
671 // + 1 for the little space after the line number
672 v.lineNumOffset = maxLineLength + 1
677 // We need to add to the line offset if there are gutter messages
678 var hasGutterMessages bool
679 for _, v := range v.messages {
681 hasGutterMessages = true
684 if hasGutterMessages {
689 // One space for the extra split divider
693 // These represent the current screen coordinates
694 screenX, screenY := v.x, v.y-1
696 highlightStyle := defStyle
699 // ViewLine is the current line from the top of the viewport
700 for viewLine := 0; viewLine < v.Height; viewLine++ {
704 // This is the current line number of the buffer that we are drawing
705 curLineN = viewLine + v.Topline
707 if screenY-v.y >= v.Height {
712 // Draw the split divider
713 v.drawCell(screenX, screenY, '|', nil, defStyle.Reverse(true))
717 // If the buffer is smaller than the view height we have to clear all this space
718 if curLineN >= v.Buf.NumLines {
719 for i := screenX; i < v.x+v.Width; i++ {
720 v.drawCell(i, screenY, ' ', nil, defStyle)
725 line := v.Buf.Line(curLineN)
727 // If there are gutter messages we need to display the '>>' symbol here
728 if hasGutterMessages {
729 // msgOnLine stores whether or not there is a gutter message on this line in particular
731 for k := range v.messages {
732 for _, msg := range v.messages[k] {
733 if msg.lineNum == curLineN {
735 gutterStyle := defStyle
738 if style, ok := colorscheme["gutter-info"]; ok {
742 if style, ok := colorscheme["gutter-warning"]; ok {
746 if style, ok := colorscheme["gutter-error"]; ok {
750 v.drawCell(screenX, screenY, '>', nil, gutterStyle)
752 v.drawCell(screenX, screenY, '>', nil, gutterStyle)
754 if v.Cursor.Y == curLineN && !messenger.hasPrompt {
755 messenger.Message(msg.msg)
756 messenger.gutterMessage = true
761 // If there is no message on this line we just display an empty offset
763 v.drawCell(screenX, screenY, ' ', nil, defStyle)
765 v.drawCell(screenX, screenY, ' ', nil, defStyle)
767 if v.Cursor.Y == curLineN && messenger.gutterMessage {
769 messenger.gutterMessage = false
774 lineNumStyle := defStyle
775 if v.Buf.Settings["ruler"] == true {
776 // Write the line number
777 if style, ok := colorscheme["line-number"]; ok {
780 if style, ok := colorscheme["current-line-number"]; ok {
781 if curLineN == v.Cursor.Y && tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() {
786 lineNum := strconv.Itoa(curLineN + 1)
788 // Write the spaces before the line number if necessary
789 for i := 0; i < maxLineLength-len(lineNum); i++ {
790 v.drawCell(screenX, screenY, ' ', nil, lineNumStyle)
793 // Write the actual line number
794 for _, ch := range lineNum {
795 v.drawCell(screenX, screenY, ch, nil, lineNumStyle)
799 // Write the extra space
800 v.drawCell(screenX, screenY, ' ', nil, lineNumStyle)
804 // Now we actually draw the line
807 tabSize := int(v.Buf.Settings["tabsize"].(float64))
808 for _, ch := range line {
809 if v.Buf.Settings["softwrap"].(bool) {
810 if screenX-v.x >= v.Width {
812 for i := 0; i < v.lineNumOffset; i++ {
813 screen.SetContent(v.x+i, screenY, ' ', nil, lineNumStyle)
815 screenX = v.x + v.lineNumOffset
819 if tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN && colN == v.Cursor.X {
820 v.DisplayCursor(screenX-v.leftCol, screenY)
823 lineStyle := defStyle
825 if v.Buf.Settings["syntax"].(bool) {
826 // Syntax highlighting is enabled
827 highlightStyle = v.matches[viewLine][colN]
830 if v.Cursor.HasSelection() &&
831 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
832 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
833 // The current character is selected
834 lineStyle = defStyle.Reverse(true)
836 if style, ok := colorscheme["selection"]; ok {
840 lineStyle = highlightStyle
843 // We need to display the background of the linestyle with the correct color if cursorline is enabled
844 // and this is the current view and there is no selection on this line and the cursor is on this line
845 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
846 if style, ok := colorscheme["cursor-line"]; ok {
847 fg, _, _ := style.Decompose()
848 lineStyle = lineStyle.Background(fg)
853 // If the character we are displaying is a tab, we need to do a bunch of special things
855 // First the user may have configured an `indent-char` to be displayed to show that this
856 // is a tab character
857 lineIndentStyle := defStyle
858 if style, ok := colorscheme["indent-char"]; ok && v.Buf.Settings["indentchar"].(string) != " " {
859 lineIndentStyle = style
861 if v.Cursor.HasSelection() &&
862 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
863 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
865 lineIndentStyle = defStyle.Reverse(true)
867 if style, ok := colorscheme["selection"]; ok {
868 lineIndentStyle = style
871 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
872 if style, ok := colorscheme["cursor-line"]; ok {
873 fg, _, _ := style.Decompose()
874 lineIndentStyle = lineIndentStyle.Background(fg)
877 // Here we get the indent char
878 indentChar := []rune(v.Buf.Settings["indentchar"].(string))
879 if screenX-v.x-v.leftCol >= v.lineNumOffset {
880 v.drawCell(screenX-v.leftCol, screenY, indentChar[0], nil, lineIndentStyle)
882 // Now the tab has to be displayed as a bunch of spaces
884 remainder := tabSize - (visLoc % tabSize)
885 for i := 0; i < remainder-1; i++ {
887 if screenX-v.x-v.leftCol >= v.lineNumOffset {
888 v.drawCell(screenX-v.leftCol, screenY, ' ', nil, lineStyle)
891 } else if runewidth.RuneWidth(ch) > 1 {
892 if screenX-v.x-v.leftCol >= v.lineNumOffset {
893 v.drawCell(screenX, screenY, ch, nil, lineStyle)
895 for i := 0; i < runewidth.RuneWidth(ch)-1; i++ {
897 if screenX-v.x-v.leftCol >= v.lineNumOffset {
898 v.drawCell(screenX-v.leftCol, screenY, '<', nil, lineStyle)
902 if screenX-v.x-v.leftCol >= v.lineNumOffset {
903 v.drawCell(screenX-v.leftCol, screenY, ch, nil, lineStyle)
906 charNum = charNum.Move(1, v.Buf)
909 strWidth += StringWidth(string(ch), tabSize)
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))