9 "github.com/mitchellh/go-homedir"
10 "github.com/zyedidia/tcell"
13 type ViewType struct {
15 readonly bool // The file cannot be edited
16 scratch bool // The file cannot be saved
20 vtDefault = ViewType{0, false, false}
21 vtHelp = ViewType{1, true, true}
22 vtLog = ViewType{2, true, true}
23 vtScratch = ViewType{3, false, true}
26 // The View struct stores information about a view into a buffer.
27 // It stores information about the cursor, and the viewport
28 // that the user sees the buffer from.
30 // A pointer to the buffer's cursor for ease of access
33 // The topmost line, used for vertical scrolling
35 // The leftmost column, used for horizontal scrolling
38 // Specifies whether or not this view holds a help buffer
41 // Actual width and height
48 // Where this view is located
51 // How much to offset because of line numbers
54 // Holds the list of gutter messages
55 messages map[string][]GutterMessage
57 // This is the index of this view in the views array
59 // What tab is this view stored in
67 // Since tcell doesn't differentiate between a mouse release event
68 // and a mouse move event with no keys pressed, we need to keep
69 // track of whether or not the mouse was pressed (or not released) last event to determine
70 // mouse release events
73 // This stores when the last click was
74 // This is useful for detecting double and triple clicks
75 lastClickTime time.Time
77 // lastCutTime stores when the last ctrl+k was issued.
78 // It is used for clearing the clipboard to replace it with fresh cut lines.
81 // freshClip returns true if the clipboard has never been pasted.
84 // Was the last mouse event actually a double click?
85 // Useful for detecting triple clicks -- if a double click is detected
86 // but the last mouse event was actually a double click, it's a triple click
88 // Same here, just to keep track for mouse move events
96 // NewView returns a new fullscreen view
97 func NewView(buf *Buffer) *View {
98 screenW, screenH := screen.Size()
99 return NewViewWidthHeight(buf, screenW, screenH)
102 // NewViewWidthHeight returns a new view with the specified width and height
103 // Note that w and h are raw column and row values
104 func NewViewWidthHeight(buf *Buffer, w, h int) *View {
111 v.cellview = new(CellView)
117 v.messages = make(map[string][]GutterMessage)
119 v.sline = Statusline{
123 if v.Buf.Settings["statusline"].(bool) {
127 for pl := range loadedPlugins {
128 _, err := Call(pl+".onViewOpen", v)
129 if err != nil && !strings.HasPrefix(err.Error(), "function does not exist") {
138 // ToggleStatusLine creates an extra row for the statusline if necessary
139 func (v *View) ToggleStatusLine() {
140 if v.Buf.Settings["statusline"].(bool) {
147 // ToggleTabbar creates an extra row for the tabbar if necessary
148 func (v *View) ToggleTabbar() {
151 // Include one line for the tab bar at the top
163 func (v *View) paste(clip string) {
164 leadingWS := GetLeadingWhitespace(v.Buf.Line(v.Cursor.Y))
166 if v.Cursor.HasSelection() {
167 v.Cursor.DeleteSelection()
168 v.Cursor.ResetSelection()
170 clip = strings.Replace(clip, "\n", "\n"+leadingWS, -1)
171 v.Buf.Insert(v.Cursor.Loc, clip)
172 v.Cursor.Loc = v.Cursor.Loc.Move(Count(clip), v.Buf)
174 messenger.Message("Pasted clipboard")
177 // ScrollUp scrolls the view up n lines (if possible)
178 func (v *View) ScrollUp(n int) {
179 // Try to scroll by n but if it would overflow, scroll by 1
180 if v.Topline-n >= 0 {
182 } else if v.Topline > 0 {
187 // ScrollDown scrolls the view down n lines (if possible)
188 func (v *View) ScrollDown(n int) {
189 // Try to scroll by n but if it would overflow, scroll by 1
190 if v.Topline+n <= v.Buf.NumLines {
192 } else if v.Topline < v.Buf.NumLines-1 {
197 // CanClose returns whether or not the view can be closed
198 // If there are unsaved changes, the user will be asked if the view can be closed
199 // causing them to lose the unsaved changes
200 func (v *View) CanClose() bool {
201 if v.Type == vtDefault && v.Buf.IsModified {
204 if v.Buf.Settings["autosave"].(bool) {
207 choice, canceled = messenger.YesNoPrompt("Save changes to " + v.Buf.GetName() + " before closing? (y,n,esc) ")
224 // OpenBuffer opens a new buffer in this view.
225 // This resets the topline, event handler and cursor.
226 func (v *View) OpenBuffer(buf *Buffer) {
230 v.Cursor = &buf.Cursor
233 v.Cursor.ResetSelection()
236 v.messages = make(map[string][]GutterMessage)
238 // Set mouseReleased to true because we assume the mouse is not being pressed when
239 // the editor is opened
240 v.mouseReleased = true
241 v.lastClickTime = time.Time{}
244 // Open opens the given file in the view
245 func (v *View) Open(filename string) {
246 home, _ := homedir.Dir()
247 filename = strings.Replace(filename, "~", home, 1)
248 file, err := os.Open(filename)
249 fileInfo, _ := os.Stat(filename)
251 if err == nil && fileInfo.IsDir() {
252 messenger.Error(filename, " is a directory")
260 messenger.Message(err.Error())
261 // File does not exist -- create an empty buffer with that name
262 buf = NewBufferFromString("", filename)
264 buf = NewBuffer(file, FSize(file), filename)
269 // CloseBuffer performs any closing functions on the buffer
270 func (v *View) CloseBuffer() {
276 // ReOpen reloads the current buffer
277 func (v *View) ReOpen() {
285 // HSplit opens a horizontal split with the given buffer
286 func (v *View) HSplit(buf *Buffer) {
288 if v.Buf.Settings["splitBottom"].(bool) {
291 v.splitNode.HSplit(buf, v.Num+i)
294 // VSplit opens a vertical split with the given buffer
295 func (v *View) VSplit(buf *Buffer) {
297 if v.Buf.Settings["splitRight"].(bool) {
300 v.splitNode.VSplit(buf, v.Num+i)
303 // HSplitIndex opens a horizontal split with the given buffer at the given index
304 func (v *View) HSplitIndex(buf *Buffer, splitIndex int) {
305 v.splitNode.HSplit(buf, splitIndex)
308 // VSplitIndex opens a vertical split with the given buffer at the given index
309 func (v *View) VSplitIndex(buf *Buffer, splitIndex int) {
310 v.splitNode.VSplit(buf, splitIndex)
313 // GetSoftWrapLocation gets the location of a visual click on the screen and converts it to col,line
314 func (v *View) GetSoftWrapLocation(vx, vy int) (int, int) {
315 if !v.Buf.Settings["softwrap"].(bool) {
316 if vy >= v.Buf.NumLines {
317 vy = v.Buf.NumLines - 1
319 vx = v.Cursor.GetCharPosInLine(vy, vx)
323 screenX, screenY := 0, v.Topline
324 for lineN := v.Topline; lineN < v.Bottomline(); lineN++ {
325 line := v.Buf.Line(lineN)
326 if lineN >= v.Buf.NumLines {
327 return 0, v.Buf.NumLines - 1
331 for _, ch := range line {
332 if screenX >= v.Width-v.lineNumOffset {
337 if screenX == vx && screenY == vy {
342 screenX += int(v.Buf.Settings["tabsize"].(float64)) - 1
358 func (v *View) Bottomline() int {
359 if !v.Buf.Settings["softwrap"].(bool) {
360 return v.Topline + v.Height
363 screenX, screenY := 0, 0
365 for lineN := v.Topline; lineN < v.Topline+v.Height; lineN++ {
366 line := v.Buf.Line(lineN)
369 for _, ch := range line {
370 if screenX >= v.Width-v.lineNumOffset {
376 screenX += int(v.Buf.Settings["tabsize"].(float64)) - 1
386 if screenY >= v.Height {
390 return numLines + v.Topline
393 // Relocate moves the view window so that the cursor is in view
394 // This is useful if the user has scrolled far away, and then starts typing
395 func (v *View) Relocate() bool {
396 height := v.Bottomline() - v.Topline
399 scrollmargin := int(v.Buf.Settings["scrollmargin"].(float64))
400 if cy < v.Topline+scrollmargin && cy > scrollmargin-1 {
401 v.Topline = cy - scrollmargin
403 } else if cy < v.Topline {
407 if cy > v.Topline+height-1-scrollmargin && cy < v.Buf.NumLines-scrollmargin {
408 v.Topline = cy - height + 1 + scrollmargin
410 } else if cy >= v.Buf.NumLines-scrollmargin && cy > height {
411 v.Topline = v.Buf.NumLines - height
415 if !v.Buf.Settings["softwrap"].(bool) {
416 cx := v.Cursor.GetVisualX()
421 if cx+v.lineNumOffset+1 > v.leftCol+v.Width {
422 v.leftCol = cx - v.Width + v.lineNumOffset + 1
429 // MoveToMouseClick moves the cursor to location x, y assuming x, y were given
431 func (v *View) MoveToMouseClick(x, y int) {
432 if y-v.Topline > v.Height-1 {
434 y = v.Height + v.Topline - 1
443 x, y = v.GetSoftWrapLocation(x, y)
444 // x = v.Cursor.GetCharPosInLine(y, x)
445 if x > Count(v.Buf.Line(y)) {
446 x = Count(v.Buf.Line(y))
450 v.Cursor.LastVisualX = v.Cursor.GetVisualX()
453 func (v *View) ExecuteActions(actions []func(*View, bool) bool) bool {
455 readonlyBindingsList := []string{"Delete", "Insert", "Backspace", "Cut", "Play", "Paste", "Move", "Add", "DuplicateLine", "Macro"}
456 for _, action := range actions {
457 readonlyBindingsResult := false
458 funcName := ShortFuncName(action)
459 if v.Type.readonly == true {
460 // check for readonly and if true only let key bindings get called if they do not change the contents.
461 for _, readonlyBindings := range readonlyBindingsList {
462 if strings.Contains(funcName, readonlyBindings) {
463 readonlyBindingsResult = true
467 if !readonlyBindingsResult {
468 // call the key binding
469 relocate = action(v, true) || relocate
471 if funcName != "ToggleMacro" && funcName != "PlayMacro" {
473 curMacro = append(curMacro, action)
482 // HandleEvent handles an event passed by the main loop
483 func (v *View) HandleEvent(event tcell.Event) {
484 // This bool determines whether the view is relocated at the end of the function
485 // By default it's true because most events should cause a relocate
490 switch e := event.(type) {
491 case *tcell.EventKey:
492 // Check first if input is a key binding, if it is we 'eat' the input and don't insert a rune
494 if e.Key() != tcell.KeyRune || e.Modifiers() != 0 {
495 for key, actions := range bindings {
496 if e.Key() == key.keyCode {
497 if e.Key() == tcell.KeyRune {
498 if e.Rune() != key.r {
502 if e.Modifiers() == key.modifiers {
505 relocate = v.ExecuteActions(actions)
511 if !isBinding && e.Key() == tcell.KeyRune {
512 // Check viewtype if readonly don't insert a rune (readonly help and log view etc.)
513 if v.Type.readonly == false {
514 // Insert a character
515 if v.Cursor.HasSelection() {
516 v.Cursor.DeleteSelection()
517 v.Cursor.ResetSelection()
519 v.Buf.Insert(v.Cursor.Loc, string(e.Rune()))
522 for pl := range loadedPlugins {
523 _, err := Call(pl+".onRune", string(e.Rune()), v)
524 if err != nil && !strings.HasPrefix(err.Error(), "function does not exist") {
530 curMacro = append(curMacro, e.Rune())
534 case *tcell.EventPaste:
535 // Check viewtype if readonly don't paste (readonly help and log view etc.)
536 if v.Type.readonly == false {
537 if !PreActionCall("Paste", v) {
543 PostActionCall("Paste", v)
545 case *tcell.EventMouse:
547 x -= v.lineNumOffset - v.leftCol + v.x
549 // Don't relocate for mouse events
552 button := e.Buttons()
554 for key, actions := range bindings {
555 if button == key.buttons {
556 relocate = v.ExecuteActions(actions)
560 for key, actions := range mouseBindings {
561 if button == key.buttons {
562 for _, action := range actions {
569 case tcell.ButtonNone:
570 // Mouse event with no click
571 if !v.mouseReleased {
572 // Mouse was just released
574 // Relocating here isn't really necessary because the cursor will
575 // be in the right place from the last mouse event
576 // However, if we are running in a terminal that doesn't support mouse motion
577 // events, this still allows the user to make selections, except only after they
580 if !v.doubleClick && !v.tripleClick {
581 v.MoveToMouseClick(x, y)
582 v.Cursor.SetSelectionEnd(v.Cursor.Loc)
583 v.Cursor.CopySelection("primary")
585 v.mouseReleased = true
592 // We run relocate again because there's a bug with relocating with softwrap
593 // when for example you jump to the bottom of the buffer and it tries to
594 // calculate where to put the topline so that the bottom line is at the bottom
595 // of the terminal and it runs into problems with visual lines vs real lines.
596 // This is (hopefully) a temporary solution
601 // GutterMessage creates a message in this view's gutter
602 func (v *View) GutterMessage(section string, lineN int, msg string, kind int) {
604 gutterMsg := GutterMessage{
609 for _, v := range v.messages {
610 for _, gmsg := range v {
611 if gmsg.lineNum == lineN {
616 messages := v.messages[section]
617 v.messages[section] = append(messages, gutterMsg)
620 // ClearGutterMessages clears all gutter messages from a given section
621 func (v *View) ClearGutterMessages(section string) {
622 v.messages[section] = []GutterMessage{}
625 // ClearAllGutterMessages clears all the gutter messages
626 func (v *View) ClearAllGutterMessages() {
627 for k := range v.messages {
628 v.messages[k] = []GutterMessage{}
632 // Opens the given help page in a new horizontal split
633 func (v *View) openHelp(helpPage string) {
634 if data, err := FindRuntimeFile(RTHelp, helpPage).Data(); err != nil {
635 TermMessage("Unable to load help text", helpPage, "\n", err)
637 helpBuffer := NewBufferFromString(string(data), helpPage+".md")
638 helpBuffer.name = "Help"
640 if v.Type == vtHelp {
641 v.OpenBuffer(helpBuffer)
644 CurView().Type = vtHelp
649 func (v *View) DisplayView() {
650 if v.Buf.Settings["softwrap"].(bool) && v.leftCol != 0 {
655 // Log views should always follow the cursor...
659 // We need to know the string length of the largest line number
660 // so we can pad appropriately when displaying line numbers
661 maxLineNumLength := len(strconv.Itoa(v.Buf.NumLines))
663 if v.Buf.Settings["ruler"] == true {
664 // + 1 for the little space after the line number
665 v.lineNumOffset = maxLineNumLength + 1
670 // We need to add to the line offset if there are gutter messages
671 var hasGutterMessages bool
672 for _, v := range v.messages {
674 hasGutterMessages = true
677 if hasGutterMessages {
683 // One space for the extra split divider
688 xOffset := v.x + v.lineNumOffset
696 v.cellview.Draw(v.Buf, top, height, left, width-v.lineNumOffset)
702 for visualLineN, line = range v.cellview.lines {
709 if firstChar != nil {
710 if firstChar.realLoc.Y == realLineN {
713 realLineN = firstChar.realLoc.Y
718 colorcolumn := int(v.Buf.Settings["colorcolumn"].(float64))
719 if colorcolumn != 0 {
720 style := GetColor("color-column")
721 fg, _, _ := style.Decompose()
722 st := defStyle.Background(fg)
723 screen.SetContent(xOffset+colorcolumn, yOffset+visualLineN, ' ', nil, st)
728 // If there are gutter messages we need to display the '>>' symbol here
729 if hasGutterMessages {
730 // msgOnLine stores whether or not there is a gutter message on this line in particular
732 for k := range v.messages {
733 for _, msg := range v.messages[k] {
734 if msg.lineNum == realLineN {
736 gutterStyle := defStyle
739 if style, ok := colorscheme["gutter-info"]; ok {
743 if style, ok := colorscheme["gutter-warning"]; ok {
747 if style, ok := colorscheme["gutter-error"]; ok {
751 screen.SetContent(screenX, yOffset+visualLineN, '>', nil, gutterStyle)
753 screen.SetContent(screenX, yOffset+visualLineN, '>', nil, gutterStyle)
755 if v.Cursor.Y == realLineN && !messenger.hasPrompt {
756 messenger.Message(msg.msg)
757 messenger.gutterMessage = true
762 // If there is no message on this line we just display an empty offset
764 screen.SetContent(screenX, yOffset+visualLineN, ' ', nil, defStyle)
766 screen.SetContent(screenX, yOffset+visualLineN, ' ', nil, defStyle)
768 if v.Cursor.Y == realLineN && messenger.gutterMessage {
770 messenger.gutterMessage = false
775 lineNumStyle := defStyle
776 if v.Buf.Settings["ruler"] == true {
777 // Write the line number
778 if style, ok := colorscheme["line-number"]; ok {
781 if style, ok := colorscheme["current-line-number"]; ok {
782 if realLineN == v.Cursor.Y && tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() {
787 lineNum := strconv.Itoa(realLineN + 1)
789 // Write the spaces before the line number if necessary
790 for i := 0; i < maxLineNumLength-len(lineNum); i++ {
791 screen.SetContent(screenX+divider, yOffset+visualLineN, ' ', nil, lineNumStyle)
794 if softwrapped && visualLineN != 0 {
795 // Pad without the line number because it was written on the visual line before
797 screen.SetContent(screenX+divider, yOffset+visualLineN, ' ', nil, lineNumStyle)
801 // Write the actual line number
802 for _, ch := range lineNum {
803 screen.SetContent(screenX+divider, yOffset+visualLineN, ch, nil, lineNumStyle)
808 // Write the extra space
809 screen.SetContent(screenX+divider, yOffset+visualLineN, ' ', nil, lineNumStyle)
815 for _, char := range line {
817 lineStyle := char.style
819 colorcolumn := int(v.Buf.Settings["colorcolumn"].(float64))
820 if colorcolumn != 0 && char.visualLoc.X == colorcolumn {
821 style := GetColor("color-column")
822 fg, _, _ := style.Decompose()
823 lineStyle = lineStyle.Background(fg)
826 charLoc := char.realLoc
827 if v.Cursor.HasSelection() &&
828 (charLoc.GreaterEqual(v.Cursor.CurSelection[0]) && charLoc.LessThan(v.Cursor.CurSelection[1]) ||
829 charLoc.LessThan(v.Cursor.CurSelection[0]) && charLoc.GreaterEqual(v.Cursor.CurSelection[1])) {
830 // The current character is selected
831 lineStyle = defStyle.Reverse(true)
833 if style, ok := colorscheme["selection"]; ok {
838 if tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() &&
839 v.Cursor.Y == char.realLoc.Y && v.Cursor.X == char.realLoc.X && !cursorSet {
840 screen.ShowCursor(xOffset+char.visualLoc.X, yOffset+char.visualLoc.Y)
844 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].CurView == v.Num &&
845 !v.Cursor.HasSelection() && v.Cursor.Y == realLineN {
846 style := GetColor("cursor-line")
847 fg, _, _ := style.Decompose()
848 lineStyle = lineStyle.Background(fg)
851 screen.SetContent(xOffset+char.visualLoc.X, yOffset+char.visualLoc.Y, char.drawChar, nil, lineStyle)
862 lastX = xOffset + lastChar.visualLoc.X + lastChar.width
863 if tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() &&
864 v.Cursor.Y == lastChar.realLoc.Y && v.Cursor.X == lastChar.realLoc.X+1 {
865 screen.ShowCursor(lastX, yOffset+lastChar.visualLoc.Y)
866 cx, cy = lastX, yOffset+lastChar.visualLoc.Y
868 realLoc = Loc{lastChar.realLoc.X, realLineN}
869 visualLoc = Loc{lastX - xOffset, lastChar.visualLoc.Y}
870 } else if len(line) == 0 {
871 if tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() &&
872 v.Cursor.Y == realLineN {
873 screen.ShowCursor(xOffset, yOffset+visualLineN)
874 cx, cy = xOffset, yOffset+visualLineN
877 realLoc = Loc{0, realLineN}
878 visualLoc = Loc{0, visualLineN}
881 if v.Cursor.HasSelection() &&
882 (realLoc.GreaterEqual(v.Cursor.CurSelection[0]) && realLoc.LessThan(v.Cursor.CurSelection[1]) ||
883 realLoc.LessThan(v.Cursor.CurSelection[0]) && realLoc.GreaterEqual(v.Cursor.CurSelection[1])) {
884 // The current character is selected
885 selectStyle := defStyle.Reverse(true)
887 if style, ok := colorscheme["selection"]; ok {
890 screen.SetContent(xOffset+visualLoc.X, yOffset+visualLoc.Y, ' ', nil, selectStyle)
893 if v.Buf.Settings["cursorline"].(bool) && tabs[curTab].CurView == v.Num &&
894 !v.Cursor.HasSelection() && v.Cursor.Y == realLineN {
895 for i := lastX; i < xOffset+v.Width; i++ {
896 style := GetColor("cursor-line")
897 fg, _, _ := style.Decompose()
898 style = style.Background(fg)
899 if !(tabs[curTab].CurView == v.Num && !v.Cursor.HasSelection() && i == cx && yOffset+visualLineN == cy) {
900 screen.SetContent(i, yOffset+visualLineN, ' ', nil, style)
907 dividerStyle := defStyle
908 if style, ok := colorscheme["divider"]; ok {
911 for i := 0; i < v.Height; i++ {
912 screen.SetContent(v.x, yOffset+i, '|', nil, dividerStyle.Reverse(true))
917 // Display renders the view, the cursor, and statusline
918 func (v *View) Display() {
919 if globalSettings["termtitle"].(bool) {
920 screen.SetTitle("micro: " + v.Buf.GetName())
923 // Don't draw the cursor if it is out of the viewport or if it has a selection
924 if v.Num == tabs[curTab].CurView && (v.Cursor.Y-v.Topline < 0 || v.Cursor.Y-v.Topline > v.Height-1 || v.Cursor.HasSelection()) {
927 _, screenH := screen.Size()
928 if v.Buf.Settings["statusline"].(bool) {
930 } else if (v.y + v.Height) != screenH-1 {
931 for x := 0; x < v.Width; x++ {
932 screen.SetContent(v.x+x, v.y+v.Height, '-', nil, defStyle.Reverse(true))