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) bool {
277 v.splitNode.HSplit(buf, v.Buf.Settings["splitRight"].(bool))
281 // VSplit opens a vertical split with the given buffer
282 func (v *View) VSplit(buf *Buffer) bool {
283 v.splitNode.VSplit(buf, v.Buf.Settings["splitBottom"].(bool))
287 // GetSoftWrapLocation gets the location of a visual click on the screen and converts it to col,line
288 func (v *View) GetSoftWrapLocation(vx, vy int) (int, int) {
289 if !v.Buf.Settings["softwrap"].(bool) {
290 vx = v.Cursor.GetCharPosInLine(vy, vx)
294 screenX, screenY := 0, v.Topline
295 for lineN := v.Topline; lineN < v.Bottomline(); lineN++ {
296 line := v.Buf.Line(lineN)
299 for _, ch := range line {
300 if screenX >= v.width-v.lineNumOffset {
305 if screenX == vx && screenY == vy {
310 screenX += int(v.Buf.Settings["tabsize"].(float64)) - 1
326 func (v *View) Bottomline() int {
327 if !v.Buf.Settings["softwrap"].(bool) {
328 return v.Topline + v.height
331 screenX, screenY := 0, 0
333 for lineN := v.Topline; lineN < v.Topline+v.height; lineN++ {
334 line := v.Buf.Line(lineN)
337 for _, ch := range line {
338 if screenX >= v.width-v.lineNumOffset {
344 screenX += int(v.Buf.Settings["tabsize"].(float64)) - 1
354 if screenY >= v.height {
358 return numLines + v.Topline
361 // Relocate moves the view window so that the cursor is in view
362 // This is useful if the user has scrolled far away, and then starts typing
363 func (v *View) Relocate() bool {
364 height := v.Bottomline() - v.Topline
367 scrollmargin := int(v.Buf.Settings["scrollmargin"].(float64))
368 if cy < v.Topline+scrollmargin && cy > scrollmargin-1 {
369 v.Topline = cy - scrollmargin
371 } else if cy < v.Topline {
375 if cy > v.Topline+height-1-scrollmargin && cy < v.Buf.NumLines-scrollmargin {
376 v.Topline = cy - height + 1 + scrollmargin
378 } else if cy >= v.Buf.NumLines-scrollmargin && cy > height {
379 v.Topline = v.Buf.NumLines - height
383 if !v.Buf.Settings["softwrap"].(bool) {
384 cx := v.Cursor.GetVisualX()
389 if cx+v.lineNumOffset+1 > v.leftCol+v.width {
390 v.leftCol = cx - v.width + v.lineNumOffset + 1
397 // MoveToMouseClick moves the cursor to location x, y assuming x, y were given
399 func (v *View) MoveToMouseClick(x, y int) {
400 if y-v.Topline > v.height-1 {
402 y = v.height + v.Topline - 1
404 if y >= v.Buf.NumLines {
405 y = v.Buf.NumLines - 1
414 x, y = v.GetSoftWrapLocation(x, y)
415 // x = v.Cursor.GetCharPosInLine(y, x)
416 if x > Count(v.Buf.Line(y)) {
417 x = Count(v.Buf.Line(y))
421 v.Cursor.LastVisualX = v.Cursor.GetVisualX()
424 // HandleEvent handles an event passed by the main loop
425 func (v *View) HandleEvent(event tcell.Event) {
426 // This bool determines whether the view is relocated at the end of the function
427 // By default it's true because most events should cause a relocate
432 switch e := event.(type) {
433 case *tcell.EventResize:
435 tabs[v.TabNum].Resize()
436 case *tcell.EventKey:
437 // Check first if input is a key binding, if it is we 'eat' the input and don't insert a rune
439 if e.Key() != tcell.KeyRune || e.Modifiers() != 0 {
440 for key, actions := range bindings {
441 if e.Key() == key.keyCode {
442 if e.Key() == tcell.KeyRune {
443 if e.Rune() != key.r {
447 if e.Modifiers() == key.modifiers {
450 for _, action := range actions {
451 relocate = action(v, true) || relocate
452 funcName := FuncName(action)
453 if funcName != "main.(*View).ToggleMacro" && funcName != "main.(*View).PlayMacro" {
455 curMacro = append(curMacro, action)
464 if !isBinding && e.Key() == tcell.KeyRune {
465 // Insert a character
466 if v.Cursor.HasSelection() {
467 v.Cursor.DeleteSelection()
468 v.Cursor.ResetSelection()
470 v.Buf.Insert(v.Cursor.Loc, string(e.Rune()))
473 for _, pl := range loadedPlugins {
474 _, err := Call(pl+".onRune", string(e.Rune()), v)
475 if err != nil && !strings.HasPrefix(err.Error(), "function does not exist") {
481 curMacro = append(curMacro, e.Rune())
484 case *tcell.EventPaste:
485 if !PreActionCall("Paste", v) {
491 PostActionCall("Paste", v)
492 case *tcell.EventMouse:
494 x -= v.lineNumOffset - v.leftCol + v.x
496 // Don't relocate for mouse events
499 button := e.Buttons()
505 v.MoveToMouseClick(x, y)
506 if time.Since(v.lastClickTime)/time.Millisecond < doubleClickThreshold {
509 v.lastClickTime = time.Now()
512 v.doubleClick = false
514 v.Cursor.SelectLine()
517 v.lastClickTime = time.Now()
520 v.tripleClick = false
522 v.Cursor.SelectWord()
525 v.doubleClick = false
526 v.tripleClick = false
527 v.lastClickTime = time.Now()
529 v.Cursor.OrigSelection[0] = v.Cursor.Loc
530 v.Cursor.CurSelection[0] = v.Cursor.Loc
531 v.Cursor.CurSelection[1] = v.Cursor.Loc
533 v.mouseReleased = false
534 } else if !v.mouseReleased {
535 v.MoveToMouseClick(x, y)
537 v.Cursor.AddLineToSelection()
538 } else if v.doubleClick {
539 v.Cursor.AddWordToSelection()
541 v.Cursor.SetSelectionEnd(v.Cursor.Loc)
545 // Middle mouse button was clicked,
546 // We should paste primary
548 case tcell.ButtonNone:
549 // Mouse event with no click
550 if !v.mouseReleased {
551 // Mouse was just released
553 // Relocating here isn't really necessary because the cursor will
554 // be in the right place from the last mouse event
555 // However, if we are running in a terminal that doesn't support mouse motion
556 // events, this still allows the user to make selections, except only after they
559 if !v.doubleClick && !v.tripleClick {
560 v.MoveToMouseClick(x, y)
561 v.Cursor.SetSelectionEnd(v.Cursor.Loc)
563 v.mouseReleased = true
567 scrollspeed := int(v.Buf.Settings["scrollspeed"].(float64))
568 v.ScrollUp(scrollspeed)
569 case tcell.WheelDown:
571 scrollspeed := int(v.Buf.Settings["scrollspeed"].(float64))
572 v.ScrollDown(scrollspeed)
581 // GutterMessage creates a message in this view's gutter
582 func (v *View) GutterMessage(section string, lineN int, msg string, kind int) {
584 gutterMsg := GutterMessage{
589 for _, v := range v.messages {
590 for _, gmsg := range v {
591 if gmsg.lineNum == lineN {
596 messages := v.messages[section]
597 v.messages[section] = append(messages, gutterMsg)
600 // ClearGutterMessages clears all gutter messages from a given section
601 func (v *View) ClearGutterMessages(section string) {
602 v.messages[section] = []GutterMessage{}
605 // ClearAllGutterMessages clears all the gutter messages
606 func (v *View) ClearAllGutterMessages() {
607 for k := range v.messages {
608 v.messages[k] = []GutterMessage{}
612 // Opens the given help page in a new horizontal split
613 func (v *View) openHelp(helpPage string) {
614 if data, err := FindRuntimeFile(RTHelp, helpPage).Data(); err != nil {
615 TermMessage("Unable to load help text", helpPage, "\n", err)
617 helpBuffer := NewBuffer(data, helpPage+".md")
618 helpBuffer.name = "Help"
620 if v.Type == vtHelp {
621 v.OpenBuffer(helpBuffer)
624 CurView().Type = vtHelp
629 func (v *View) drawCell(x, y int, ch rune, combc []rune, style tcell.Style) {
630 if x >= v.x && x < v.x+v.width && y >= v.y && y < v.y+v.height {
631 screen.SetContent(x, y, ch, combc, style)
635 // DisplayView renders the view to the screen
636 func (v *View) DisplayView() {
638 // Log views should always follow the cursor...
642 if v.Buf.Settings["syntax"].(bool) {
646 // The charNum we are currently displaying
647 // starts at the start of the viewport
648 charNum := Loc{0, v.Topline}
650 // Convert the length of buffer to a string, and get the length of the string
651 // We are going to have to offset by that amount
652 maxLineLength := len(strconv.Itoa(v.Buf.NumLines))
654 if v.Buf.Settings["ruler"] == true {
655 // + 1 for the little space after the line number
656 v.lineNumOffset = maxLineLength + 1
661 // We need to add to the line offset if there are gutter messages
662 var hasGutterMessages bool
663 for _, v := range v.messages {
665 hasGutterMessages = true
668 if hasGutterMessages {
673 // One space for the extra split divider
677 // These represent the current screen coordinates
678 screenX, screenY := v.x, v.y-1
680 highlightStyle := defStyle
683 // ViewLine is the current line from the top of the viewport
684 for viewLine := 0; viewLine < v.height; viewLine++ {
688 // This is the current line number of the buffer that we are drawing
689 curLineN = viewLine + v.Topline
691 if screenY-v.y >= v.height {
696 // Draw the split divider
697 v.drawCell(screenX, screenY, '|', nil, defStyle.Reverse(true))
701 // If the buffer is smaller than the view height we have to clear all this space
702 if curLineN >= v.Buf.NumLines {
703 for i := screenX; i < v.x+v.width; i++ {
704 v.drawCell(i, screenY, ' ', nil, defStyle)
709 line := v.Buf.Line(curLineN)
711 // If there are gutter messages we need to display the '>>' symbol here
712 if hasGutterMessages {
713 // msgOnLine stores whether or not there is a gutter message on this line in particular
715 for k := range v.messages {
716 for _, msg := range v.messages[k] {
717 if msg.lineNum == curLineN {
719 gutterStyle := defStyle
722 if style, ok := colorscheme["gutter-info"]; ok {
726 if style, ok := colorscheme["gutter-warning"]; ok {
730 if style, ok := colorscheme["gutter-error"]; ok {
734 v.drawCell(screenX, screenY, '>', nil, gutterStyle)
736 v.drawCell(screenX, screenY, '>', nil, gutterStyle)
738 if v.Cursor.Y == curLineN && !messenger.hasPrompt {
739 messenger.Message(msg.msg)
740 messenger.gutterMessage = true
745 // If there is no message on this line we just display an empty offset
747 v.drawCell(screenX, screenY, ' ', nil, defStyle)
749 v.drawCell(screenX, screenY, ' ', nil, defStyle)
751 if v.Cursor.Y == curLineN && messenger.gutterMessage {
753 messenger.gutterMessage = false
758 lineNumStyle := defStyle
759 if v.Buf.Settings["ruler"] == true {
760 // Write the line number
761 if style, ok := colorscheme["line-number"]; ok {
764 if style, ok := colorscheme["current-line-number"]; ok {
765 if curLineN == v.Cursor.Y && tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() {
770 lineNum := strconv.Itoa(curLineN + 1)
772 // Write the spaces before the line number if necessary
773 for i := 0; i < maxLineLength-len(lineNum); i++ {
774 v.drawCell(screenX, screenY, ' ', nil, lineNumStyle)
777 // Write the actual line number
778 for _, ch := range lineNum {
779 v.drawCell(screenX, screenY, ch, nil, lineNumStyle)
783 // Write the extra space
784 v.drawCell(screenX, screenY, ' ', nil, lineNumStyle)
788 // Now we actually draw the line
791 tabSize := int(v.Buf.Settings["tabsize"].(float64))
792 for _, ch := range line {
793 if v.Buf.Settings["softwrap"].(bool) {
794 if screenX-v.x >= v.width {
796 for i := 0; i < v.lineNumOffset; i++ {
797 screen.SetContent(v.x+i, screenY, ' ', nil, lineNumStyle)
799 screenX = v.x + v.lineNumOffset
803 if tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN && colN == v.Cursor.X {
804 v.DisplayCursor(screenX-v.leftCol, screenY)
807 lineStyle := defStyle
809 if v.Buf.Settings["syntax"].(bool) {
810 // Syntax highlighting is enabled
811 highlightStyle = v.matches[viewLine][colN]
814 if v.Cursor.HasSelection() &&
815 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
816 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
817 // The current character is selected
818 lineStyle = defStyle.Reverse(true)
820 if style, ok := colorscheme["selection"]; ok {
824 lineStyle = highlightStyle
827 // We need to display the background of the linestyle with the correct color if cursorline is enabled
828 // and this is the current view and there is no selection on this line and the cursor is on this line
829 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
830 if style, ok := colorscheme["cursor-line"]; ok {
831 fg, _, _ := style.Decompose()
832 lineStyle = lineStyle.Background(fg)
837 // If the character we are displaying is a tab, we need to do a bunch of special things
839 // First the user may have configured an `indent-char` to be displayed to show that this
840 // is a tab character
841 lineIndentStyle := defStyle
842 if style, ok := colorscheme["indent-char"]; ok && v.Buf.Settings["indentchar"].(string) != " " {
843 lineIndentStyle = style
845 if v.Cursor.HasSelection() &&
846 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
847 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
849 lineIndentStyle = defStyle.Reverse(true)
851 if style, ok := colorscheme["selection"]; ok {
852 lineIndentStyle = style
855 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
856 if style, ok := colorscheme["cursor-line"]; ok {
857 fg, _, _ := style.Decompose()
858 lineIndentStyle = lineIndentStyle.Background(fg)
861 // Here we get the indent char
862 indentChar := []rune(v.Buf.Settings["indentchar"].(string))
863 if screenX-v.x-v.leftCol >= v.lineNumOffset {
864 v.drawCell(screenX-v.leftCol, screenY, indentChar[0], nil, lineIndentStyle)
866 // Now the tab has to be displayed as a bunch of spaces
868 remainder := tabSize - (visLoc % tabSize)
869 for i := 0; i < remainder-1; i++ {
871 if screenX-v.x-v.leftCol >= v.lineNumOffset {
872 v.drawCell(screenX-v.leftCol, screenY, ' ', nil, lineStyle)
875 } else if runewidth.RuneWidth(ch) > 1 {
876 if screenX-v.x-v.leftCol >= v.lineNumOffset {
877 v.drawCell(screenX, screenY, ch, nil, lineStyle)
879 for i := 0; i < runewidth.RuneWidth(ch)-1; i++ {
881 if screenX-v.x-v.leftCol >= v.lineNumOffset {
882 v.drawCell(screenX-v.leftCol, screenY, '<', nil, lineStyle)
886 if screenX-v.x-v.leftCol >= v.lineNumOffset {
887 v.drawCell(screenX-v.leftCol, screenY, ch, nil, lineStyle)
890 charNum = charNum.Move(1, v.Buf)
893 strWidth += StringWidth(string(ch), tabSize)
895 // Here we are at a newline
897 if tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN && colN == v.Cursor.X {
898 v.DisplayCursor(screenX-v.leftCol, screenY)
901 // The newline may be selected, in which case we should draw the selection style
902 // with a space to represent it
903 if v.Cursor.HasSelection() &&
904 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
905 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
907 selectStyle := defStyle.Reverse(true)
909 if style, ok := colorscheme["selection"]; ok {
912 v.drawCell(screenX, screenY, ' ', nil, selectStyle)
916 charNum = charNum.Move(1, v.Buf)
918 for i := 0; i < v.width; i++ {
919 lineStyle := defStyle
920 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
921 if style, ok := colorscheme["cursor-line"]; ok {
922 fg, _, _ := style.Decompose()
923 lineStyle = lineStyle.Background(fg)
926 if screenX-v.x-v.leftCol+i >= v.lineNumOffset {
927 colorcolumn := int(v.Buf.Settings["colorcolumn"].(float64))
928 if colorcolumn != 0 && screenX-v.lineNumOffset+i == colorcolumn-1 {
929 if style, ok := colorscheme["color-column"]; ok {
930 fg, _, _ := style.Decompose()
931 lineStyle = lineStyle.Background(fg)
934 v.drawCell(screenX-v.leftCol+i, screenY, ' ', nil, lineStyle)
940 // DisplayCursor draws the current buffer's cursor to the screen
941 func (v *View) DisplayCursor(x, y int) {
942 // screen.ShowCursor(v.x+v.Cursor.GetVisualX()+v.lineNumOffset-v.leftCol, y)
943 screen.ShowCursor(x, y)
946 // Display renders the view, the cursor, and statusline
947 func (v *View) Display() {
949 // Don't draw the cursor if it is out of the viewport or if it has a selection
950 if (v.Cursor.Y-v.Topline < 0 || v.Cursor.Y-v.Topline > v.height-1) || v.Cursor.HasSelection() {
953 _, screenH := screen.Size()
954 if v.Buf.Settings["statusline"].(bool) {
956 } else if (v.y + v.height) != screenH-1 {
957 for x := 0; x < v.width; x++ {
958 screen.SetContent(v.x+x, v.y+v.height, '-', nil, defStyle.Reverse(true))