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)
278 tabs[v.TabNum].Resize()
282 // VSplit opens a vertical split with the given buffer
283 func (v *View) VSplit(buf *Buffer) bool {
284 v.splitNode.VSplit(buf)
285 tabs[v.TabNum].Resize()
289 // GetSoftWrapLocation gets the location of a visual click on the screen and converts it to col,line
290 func (v *View) GetSoftWrapLocation(vx, vy int) (int, int) {
291 if !v.Buf.Settings["softwrap"].(bool) {
292 vx = v.Cursor.GetCharPosInLine(vy, vx)
296 screenX, screenY := 0, v.Topline
297 for lineN := v.Topline; lineN < v.Bottomline(); lineN++ {
298 line := v.Buf.Line(lineN)
301 for _, ch := range line {
302 if screenX >= v.width-v.lineNumOffset {
307 if screenX == vx && screenY == vy {
312 screenX += int(v.Buf.Settings["tabsize"].(float64)) - 1
328 func (v *View) Bottomline() int {
329 if !v.Buf.Settings["softwrap"].(bool) {
330 return v.Topline + v.height
333 screenX, screenY := 0, 0
335 for lineN := v.Topline; lineN < v.Topline+v.height; lineN++ {
336 line := v.Buf.Line(lineN)
339 for _, ch := range line {
340 if screenX >= v.width-v.lineNumOffset {
346 screenX += int(v.Buf.Settings["tabsize"].(float64)) - 1
356 if screenY >= v.height {
360 return numLines + v.Topline
363 // Relocate moves the view window so that the cursor is in view
364 // This is useful if the user has scrolled far away, and then starts typing
365 func (v *View) Relocate() bool {
366 height := v.Bottomline() - v.Topline
369 scrollmargin := int(v.Buf.Settings["scrollmargin"].(float64))
370 if cy < v.Topline+scrollmargin && cy > scrollmargin-1 {
371 v.Topline = cy - scrollmargin
373 } else if cy < v.Topline {
377 if cy > v.Topline+height-1-scrollmargin && cy < v.Buf.NumLines-scrollmargin {
378 v.Topline = cy - height + 1 + scrollmargin
380 } else if cy >= v.Buf.NumLines-scrollmargin && cy > height {
381 v.Topline = v.Buf.NumLines - height
385 if !v.Buf.Settings["softwrap"].(bool) {
386 cx := v.Cursor.GetVisualX()
391 if cx+v.lineNumOffset+1 > v.leftCol+v.width {
392 v.leftCol = cx - v.width + v.lineNumOffset + 1
399 // MoveToMouseClick moves the cursor to location x, y assuming x, y were given
401 func (v *View) MoveToMouseClick(x, y int) {
402 if y-v.Topline > v.height-1 {
404 y = v.height + v.Topline - 1
406 if y >= v.Buf.NumLines {
407 y = v.Buf.NumLines - 1
416 x, y = v.GetSoftWrapLocation(x, y)
417 // x = v.Cursor.GetCharPosInLine(y, x)
418 if x > Count(v.Buf.Line(y)) {
419 x = Count(v.Buf.Line(y))
423 v.Cursor.LastVisualX = v.Cursor.GetVisualX()
426 // HandleEvent handles an event passed by the main loop
427 func (v *View) HandleEvent(event tcell.Event) {
428 // This bool determines whether the view is relocated at the end of the function
429 // By default it's true because most events should cause a relocate
434 switch e := event.(type) {
435 case *tcell.EventResize:
437 tabs[v.TabNum].Resize()
438 case *tcell.EventKey:
439 // Check first if input is a key binding, if it is we 'eat' the input and don't insert a rune
441 if e.Key() != tcell.KeyRune || e.Modifiers() != 0 {
442 for key, actions := range bindings {
443 if e.Key() == key.keyCode {
444 if e.Key() == tcell.KeyRune {
445 if e.Rune() != key.r {
449 if e.Modifiers() == key.modifiers {
452 for _, action := range actions {
453 relocate = action(v, true) || relocate
454 funcName := FuncName(action)
455 if funcName != "main.(*View).ToggleMacro" && funcName != "main.(*View).PlayMacro" {
457 curMacro = append(curMacro, action)
466 if !isBinding && e.Key() == tcell.KeyRune {
467 // Insert a character
468 if v.Cursor.HasSelection() {
469 v.Cursor.DeleteSelection()
470 v.Cursor.ResetSelection()
472 v.Buf.Insert(v.Cursor.Loc, string(e.Rune()))
475 for _, pl := range loadedPlugins {
476 _, err := Call(pl+".onRune", string(e.Rune()), v)
477 if err != nil && !strings.HasPrefix(err.Error(), "function does not exist") {
483 curMacro = append(curMacro, e.Rune())
486 case *tcell.EventPaste:
487 if !PreActionCall("Paste", v) {
493 PostActionCall("Paste", v)
494 case *tcell.EventMouse:
496 x -= v.lineNumOffset - v.leftCol + v.x
498 // Don't relocate for mouse events
501 button := e.Buttons()
507 v.MoveToMouseClick(x, y)
508 if time.Since(v.lastClickTime)/time.Millisecond < doubleClickThreshold {
511 v.lastClickTime = time.Now()
514 v.doubleClick = false
516 v.Cursor.SelectLine()
519 v.lastClickTime = time.Now()
522 v.tripleClick = false
524 v.Cursor.SelectWord()
527 v.doubleClick = false
528 v.tripleClick = false
529 v.lastClickTime = time.Now()
531 v.Cursor.OrigSelection[0] = v.Cursor.Loc
532 v.Cursor.CurSelection[0] = v.Cursor.Loc
533 v.Cursor.CurSelection[1] = v.Cursor.Loc
535 v.mouseReleased = false
536 } else if !v.mouseReleased {
537 v.MoveToMouseClick(x, y)
539 v.Cursor.AddLineToSelection()
540 } else if v.doubleClick {
541 v.Cursor.AddWordToSelection()
543 v.Cursor.SetSelectionEnd(v.Cursor.Loc)
547 // Middle mouse button was clicked,
548 // We should paste primary
550 case tcell.ButtonNone:
551 // Mouse event with no click
552 if !v.mouseReleased {
553 // Mouse was just released
555 // Relocating here isn't really necessary because the cursor will
556 // be in the right place from the last mouse event
557 // However, if we are running in a terminal that doesn't support mouse motion
558 // events, this still allows the user to make selections, except only after they
561 if !v.doubleClick && !v.tripleClick {
562 v.MoveToMouseClick(x, y)
563 v.Cursor.SetSelectionEnd(v.Cursor.Loc)
565 v.mouseReleased = true
569 scrollspeed := int(v.Buf.Settings["scrollspeed"].(float64))
570 v.ScrollUp(scrollspeed)
571 case tcell.WheelDown:
573 scrollspeed := int(v.Buf.Settings["scrollspeed"].(float64))
574 v.ScrollDown(scrollspeed)
583 // GutterMessage creates a message in this view's gutter
584 func (v *View) GutterMessage(section string, lineN int, msg string, kind int) {
586 gutterMsg := GutterMessage{
591 for _, v := range v.messages {
592 for _, gmsg := range v {
593 if gmsg.lineNum == lineN {
598 messages := v.messages[section]
599 v.messages[section] = append(messages, gutterMsg)
602 // ClearGutterMessages clears all gutter messages from a given section
603 func (v *View) ClearGutterMessages(section string) {
604 v.messages[section] = []GutterMessage{}
607 // ClearAllGutterMessages clears all the gutter messages
608 func (v *View) ClearAllGutterMessages() {
609 for k := range v.messages {
610 v.messages[k] = []GutterMessage{}
614 // Opens the given help page in a new horizontal split
615 func (v *View) openHelp(helpPage string) {
616 if data, err := FindRuntimeFile(RTHelp, helpPage).Data(); err != nil {
617 TermMessage("Unable to load help text", helpPage, "\n", err)
619 helpBuffer := NewBuffer(data, helpPage+".md")
620 helpBuffer.name = "Help"
622 if v.Type == vtHelp {
623 v.OpenBuffer(helpBuffer)
626 CurView().Type = vtHelp
631 func (v *View) drawCell(x, y int, ch rune, combc []rune, style tcell.Style) {
632 if x >= v.x && x < v.x+v.width && y >= v.y && y < v.y+v.height {
633 screen.SetContent(x, y, ch, combc, style)
637 // DisplayView renders the view to the screen
638 func (v *View) DisplayView() {
640 // Log views should always follow the cursor...
644 if v.Buf.Settings["syntax"].(bool) {
648 // The charNum we are currently displaying
649 // starts at the start of the viewport
650 charNum := Loc{0, v.Topline}
652 // Convert the length of buffer to a string, and get the length of the string
653 // We are going to have to offset by that amount
654 maxLineLength := len(strconv.Itoa(v.Buf.NumLines))
656 if v.Buf.Settings["ruler"] == true {
657 // + 1 for the little space after the line number
658 v.lineNumOffset = maxLineLength + 1
663 // We need to add to the line offset if there are gutter messages
664 var hasGutterMessages bool
665 for _, v := range v.messages {
667 hasGutterMessages = true
670 if hasGutterMessages {
675 // One space for the extra split divider
679 // These represent the current screen coordinates
680 screenX, screenY := v.x, v.y-1
682 highlightStyle := defStyle
685 // ViewLine is the current line from the top of the viewport
686 for viewLine := 0; viewLine < v.height; viewLine++ {
690 // This is the current line number of the buffer that we are drawing
691 curLineN = viewLine + v.Topline
693 if screenY-v.y >= v.height {
698 // Draw the split divider
699 v.drawCell(screenX, screenY, '|', nil, defStyle.Reverse(true))
703 // If the buffer is smaller than the view height we have to clear all this space
704 if curLineN >= v.Buf.NumLines {
705 for i := screenX; i < v.x+v.width; i++ {
706 v.drawCell(i, screenY, ' ', nil, defStyle)
711 line := v.Buf.Line(curLineN)
713 // If there are gutter messages we need to display the '>>' symbol here
714 if hasGutterMessages {
715 // msgOnLine stores whether or not there is a gutter message on this line in particular
717 for k := range v.messages {
718 for _, msg := range v.messages[k] {
719 if msg.lineNum == curLineN {
721 gutterStyle := defStyle
724 if style, ok := colorscheme["gutter-info"]; ok {
728 if style, ok := colorscheme["gutter-warning"]; ok {
732 if style, ok := colorscheme["gutter-error"]; ok {
736 v.drawCell(screenX, screenY, '>', nil, gutterStyle)
738 v.drawCell(screenX, screenY, '>', nil, gutterStyle)
740 if v.Cursor.Y == curLineN && !messenger.hasPrompt {
741 messenger.Message(msg.msg)
742 messenger.gutterMessage = true
747 // If there is no message on this line we just display an empty offset
749 v.drawCell(screenX, screenY, ' ', nil, defStyle)
751 v.drawCell(screenX, screenY, ' ', nil, defStyle)
753 if v.Cursor.Y == curLineN && messenger.gutterMessage {
755 messenger.gutterMessage = false
760 lineNumStyle := defStyle
761 if v.Buf.Settings["ruler"] == true {
762 // Write the line number
763 if style, ok := colorscheme["line-number"]; ok {
766 if style, ok := colorscheme["current-line-number"]; ok {
767 if curLineN == v.Cursor.Y && tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() {
772 lineNum := strconv.Itoa(curLineN + 1)
774 // Write the spaces before the line number if necessary
775 for i := 0; i < maxLineLength-len(lineNum); i++ {
776 v.drawCell(screenX, screenY, ' ', nil, lineNumStyle)
779 // Write the actual line number
780 for _, ch := range lineNum {
781 v.drawCell(screenX, screenY, ch, nil, lineNumStyle)
785 // Write the extra space
786 v.drawCell(screenX, screenY, ' ', nil, lineNumStyle)
790 // Now we actually draw the line
793 tabSize := int(v.Buf.Settings["tabsize"].(float64))
794 for _, ch := range line {
795 if v.Buf.Settings["softwrap"].(bool) {
796 if screenX-v.x >= v.width {
798 for i := 0; i < v.lineNumOffset; i++ {
799 screen.SetContent(v.x+i, screenY, ' ', nil, lineNumStyle)
801 screenX = v.x + v.lineNumOffset
805 if tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN && colN == v.Cursor.X {
806 v.DisplayCursor(screenX-v.leftCol, screenY)
809 lineStyle := defStyle
811 if v.Buf.Settings["syntax"].(bool) {
812 // Syntax highlighting is enabled
813 highlightStyle = v.matches[viewLine][colN]
816 if v.Cursor.HasSelection() &&
817 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
818 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
819 // The current character is selected
820 lineStyle = defStyle.Reverse(true)
822 if style, ok := colorscheme["selection"]; ok {
826 lineStyle = highlightStyle
829 // We need to display the background of the linestyle with the correct color if cursorline is enabled
830 // and this is the current view and there is no selection on this line and the cursor is on this line
831 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
832 if style, ok := colorscheme["cursor-line"]; ok {
833 fg, _, _ := style.Decompose()
834 lineStyle = lineStyle.Background(fg)
839 // If the character we are displaying is a tab, we need to do a bunch of special things
841 // First the user may have configured an `indent-char` to be displayed to show that this
842 // is a tab character
843 lineIndentStyle := defStyle
844 if style, ok := colorscheme["indent-char"]; ok && v.Buf.Settings["indentchar"].(string) != " " {
845 lineIndentStyle = style
847 if v.Cursor.HasSelection() &&
848 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
849 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
851 lineIndentStyle = defStyle.Reverse(true)
853 if style, ok := colorscheme["selection"]; ok {
854 lineIndentStyle = style
857 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
858 if style, ok := colorscheme["cursor-line"]; ok {
859 fg, _, _ := style.Decompose()
860 lineIndentStyle = lineIndentStyle.Background(fg)
863 // Here we get the indent char
864 indentChar := []rune(v.Buf.Settings["indentchar"].(string))
865 if screenX-v.x-v.leftCol >= v.lineNumOffset {
866 v.drawCell(screenX-v.leftCol, screenY, indentChar[0], nil, lineIndentStyle)
868 // Now the tab has to be displayed as a bunch of spaces
870 remainder := tabSize - (visLoc % tabSize)
871 for i := 0; i < remainder-1; i++ {
873 if screenX-v.x-v.leftCol >= v.lineNumOffset {
874 v.drawCell(screenX-v.leftCol, screenY, ' ', nil, lineStyle)
877 } else if runewidth.RuneWidth(ch) > 1 {
878 if screenX-v.x-v.leftCol >= v.lineNumOffset {
879 v.drawCell(screenX, screenY, ch, nil, lineStyle)
881 for i := 0; i < runewidth.RuneWidth(ch)-1; i++ {
883 if screenX-v.x-v.leftCol >= v.lineNumOffset {
884 v.drawCell(screenX-v.leftCol, screenY, '<', nil, lineStyle)
888 if screenX-v.x-v.leftCol >= v.lineNumOffset {
889 v.drawCell(screenX-v.leftCol, screenY, ch, nil, lineStyle)
892 charNum = charNum.Move(1, v.Buf)
895 strWidth += StringWidth(string(ch), tabSize)
897 // Here we are at a newline
899 if tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN && colN == v.Cursor.X {
900 v.DisplayCursor(screenX-v.leftCol, screenY)
903 // The newline may be selected, in which case we should draw the selection style
904 // with a space to represent it
905 if v.Cursor.HasSelection() &&
906 (charNum.GreaterEqual(v.Cursor.CurSelection[0]) && charNum.LessThan(v.Cursor.CurSelection[1]) ||
907 charNum.LessThan(v.Cursor.CurSelection[0]) && charNum.GreaterEqual(v.Cursor.CurSelection[1])) {
909 selectStyle := defStyle.Reverse(true)
911 if style, ok := colorscheme["selection"]; ok {
914 v.drawCell(screenX, screenY, ' ', nil, selectStyle)
918 charNum = charNum.Move(1, v.Buf)
920 for i := 0; i < v.width; i++ {
921 lineStyle := defStyle
922 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].curView == v.Num && !v.Cursor.HasSelection() && v.Cursor.Y == curLineN {
923 if style, ok := colorscheme["cursor-line"]; ok {
924 fg, _, _ := style.Decompose()
925 lineStyle = lineStyle.Background(fg)
928 if screenX-v.x-v.leftCol+i >= v.lineNumOffset {
929 colorcolumn := int(v.Buf.Settings["colorcolumn"].(float64))
930 if colorcolumn != 0 && screenX-v.lineNumOffset+i == colorcolumn-1 {
931 if style, ok := colorscheme["color-column"]; ok {
932 fg, _, _ := style.Decompose()
933 lineStyle = lineStyle.Background(fg)
936 v.drawCell(screenX-v.leftCol+i, screenY, ' ', nil, lineStyle)
942 // DisplayCursor draws the current buffer's cursor to the screen
943 func (v *View) DisplayCursor(x, y int) {
944 // screen.ShowCursor(v.x+v.Cursor.GetVisualX()+v.lineNumOffset-v.leftCol, y)
945 screen.ShowCursor(x, y)
948 // Display renders the view, the cursor, and statusline
949 func (v *View) Display() {
951 // Don't draw the cursor if it is out of the viewport or if it has a selection
952 if (v.Cursor.Y-v.Topline < 0 || v.Cursor.Y-v.Topline > v.height-1) || v.Cursor.HasSelection() {
955 _, screenH := screen.Size()
956 if v.Buf.Settings["statusline"].(bool) {
958 } else if (v.y + v.height) != screenH-1 {
959 for x := 0; x < v.width; x++ {
960 screen.SetContent(v.x+x, v.y+v.height, '-', nil, defStyle.Reverse(true))