cmd/micro/cursor.go

   1 package main
   2
   3 import (
   4         "strings"
   5 )
   6
   7 // FromCharPos converts from a character position to an x, y position
   8 func FromCharPos(loc int, buf *Buffer) (int, int) {
   9         return FromCharPosStart(0, 0, 0, loc, buf)
  10 }
  11
  12 // FromCharPosStart converts from a character position to an x, y position, starting at the specified character location
  13 func FromCharPosStart(startLoc, startX, startY, loc int, buf *Buffer) (int, int) {
  14         charNum := startLoc
  15         x, y := startX, startY
  16
  17         lineLen := Count(buf.lines[y]) + 1
  18         for charNum+lineLen <= loc {
  19                 charNum += lineLen
  20                 y++
  21                 lineLen = Count(buf.lines[y]) + 1
  22         }
  23         x = loc - charNum
  24
  25         return x, y
  26 }
  27
  28 // ToCharPos converts from an x, y position to a character position
  29 func ToCharPos(x, y int, buf *Buffer) int {
  30         loc := 0
  31         for i := 0; i < y; i++ {
  32                 // + 1 for the newline
  33                 loc += Count(buf.lines[i]) + 1
  34         }
  35         loc += x
  36         return loc
  37 }
  38
  39 // The Cursor struct stores the location of the cursor in the view
  40 // The complicated part about the cursor is storing its location.
  41 // The cursor must be displayed at an x, y location, but since the buffer
  42 // uses a rope to store text, to insert text we must have an index. It
  43 // is also simpler to use character indicies for other tasks such as
  44 // selection.
  45 type Cursor struct {
  46         v *View
  47
  48         // The cursor display location
  49         x int
  50         y int
  51
  52         // Last cursor x position
  53         lastVisualX int
  54
  55         // The current selection as a range of character numbers (inclusive)
  56         curSelection [2]int
  57         // The original selection as a range of character numbers
  58         // This is used for line and word selection where it is necessary
  59         // to know what the original selection was
  60         origSelection [2]int
  61 }
  62
  63 // SetLoc sets the location of the cursor in terms of character number
  64 // and not x, y location
  65 // It's just a simple wrapper of FromCharPos
  66 func (c *Cursor) SetLoc(loc int) {
  67         c.x, c.y = FromCharPos(loc, c.v.buf)
  68         c.lastVisualX = c.GetVisualX()
  69 }
  70
  71 // Loc gets the cursor location in terms of character number instead
  72 // of x, y location
  73 // It's just a simple wrapper of ToCharPos
  74 func (c *Cursor) Loc() int {
  75         return ToCharPos(c.x, c.y, c.v.buf)
  76 }
  77
  78 // ResetSelection resets the user's selection
  79 func (c *Cursor) ResetSelection() {
  80         c.curSelection[0] = 0
  81         c.curSelection[1] = 0
  82 }
  83
  84 // HasSelection returns whether or not the user has selected anything
  85 func (c *Cursor) HasSelection() bool {
  86         return c.curSelection[0] != c.curSelection[1]
  87 }
  88
  89 // DeleteSelection deletes the currently selected text
  90 func (c *Cursor) DeleteSelection() {
  91         if c.curSelection[0] > c.curSelection[1] {
  92                 c.v.eh.Remove(c.curSelection[1], c.curSelection[0])
  93                 c.SetLoc(c.curSelection[1])
  94         } else {
  95                 c.v.eh.Remove(c.curSelection[0], c.curSelection[1])
  96                 c.SetLoc(c.curSelection[0])
  97         }
  98 }
  99
 100 // GetSelection returns the cursor's selection
 101 func (c *Cursor) GetSelection() string {
 102         if c.curSelection[0] > c.curSelection[1] {
 103                 return string([]rune(c.v.buf.text)[c.curSelection[1]:c.curSelection[0]])
 104         }
 105         return string([]rune(c.v.buf.text)[c.curSelection[0]:c.curSelection[1]])
 106 }
 107
 108 // SelectLine selects the current line
 109 func (c *Cursor) SelectLine() {
 110         c.Start()
 111         c.curSelection[0] = c.Loc()
 112         c.End()
 113         c.curSelection[1] = c.Loc() + 1
 114
 115         c.origSelection = c.curSelection
 116 }
 117
 118 // AddLineToSelection adds the current line to the selection
 119 func (c *Cursor) AddLineToSelection() {
 120         loc := c.Loc()
 121
 122         if loc < c.origSelection[0] {
 123                 c.Start()
 124                 c.curSelection[0] = c.Loc()
 125                 c.curSelection[1] = c.origSelection[1]
 126         }
 127         if loc > c.origSelection[1] {
 128                 c.End()
 129                 c.curSelection[1] = c.Loc()
 130                 c.curSelection[0] = c.origSelection[0]
 131         }
 132
 133         if loc < c.origSelection[1] && loc > c.origSelection[0] {
 134                 c.curSelection = c.origSelection
 135         }
 136 }
 137
 138 // SelectWord selects the word the cursor is currently on
 139 func (c *Cursor) SelectWord() {
 140         if len(c.v.buf.lines[c.y]) == 0 {
 141                 return
 142         }
 143
 144         if !IsWordChar(string(c.RuneUnder(c.x))) {
 145                 loc := c.Loc()
 146                 c.curSelection[0] = loc
 147                 c.curSelection[1] = loc + 1
 148                 c.origSelection = c.curSelection
 149                 return
 150         }
 151
 152         forward, backward := c.x, c.x
 153
 154         for backward > 0 && IsWordChar(string(c.RuneUnder(backward-1))) {
 155                 backward--
 156         }
 157
 158         c.curSelection[0] = ToCharPos(backward, c.y, c.v.buf)
 159         c.origSelection[0] = c.curSelection[0]
 160
 161         for forward < Count(c.v.buf.lines[c.y])-1 && IsWordChar(string(c.RuneUnder(forward+1))) {
 162                 forward++
 163         }
 164
 165         c.curSelection[1] = ToCharPos(forward, c.y, c.v.buf) + 1
 166         c.origSelection[1] = c.curSelection[1]
 167 }
 168
 169 // AddWordToSelection adds the word the cursor is currently on to the selection
 170 func (c *Cursor) AddWordToSelection() {
 171         loc := c.Loc()
 172
 173         if loc > c.origSelection[0] && loc < c.origSelection[1] {
 174                 c.curSelection = c.origSelection
 175                 return
 176         }
 177
 178         if loc < c.origSelection[0] {
 179                 backward := c.x
 180
 181                 for backward > 0 && IsWordChar(string(c.RuneUnder(backward-1))) {
 182                         backward--
 183                 }
 184
 185                 c.curSelection[0] = ToCharPos(backward, c.y, c.v.buf)
 186                 c.curSelection[1] = c.origSelection[1]
 187         }
 188
 189         if loc > c.origSelection[1] {
 190                 forward := c.x
 191
 192                 for forward < Count(c.v.buf.lines[c.y])-1 && IsWordChar(string(c.RuneUnder(forward+1))) {
 193                         forward++
 194                 }
 195
 196                 c.curSelection[1] = ToCharPos(forward, c.y, c.v.buf) + 1
 197                 c.curSelection[0] = c.origSelection[0]
 198         }
 199 }
 200
 201 // RuneUnder returns the rune under the given x position
 202 func (c *Cursor) RuneUnder(x int) rune {
 203         line := []rune(c.v.buf.lines[c.y])
 204         if x >= len(line) {
 205                 x = len(line) - 1
 206         } else if x < 0 {
 207                 x = 0
 208         }
 209         return line[x]
 210 }
 211
 212 // Up moves the cursor up one line (if possible)
 213 func (c *Cursor) Up() {
 214         if c.y > 0 {
 215                 c.y--
 216
 217                 runes := []rune(c.v.buf.lines[c.y])
 218                 c.x = c.GetCharPosInLine(c.y, c.lastVisualX)
 219                 if c.x > len(runes) {
 220                         c.x = len(runes)
 221                 }
 222         }
 223 }
 224
 225 // Down moves the cursor down one line (if possible)
 226 func (c *Cursor) Down() {
 227         if c.y < len(c.v.buf.lines)-1 {
 228                 c.y++
 229
 230                 runes := []rune(c.v.buf.lines[c.y])
 231                 c.x = c.GetCharPosInLine(c.y, c.lastVisualX)
 232                 if c.x > len(runes) {
 233                         c.x = len(runes)
 234                 }
 235         }
 236 }
 237
 238 // Left moves the cursor left one cell (if possible) or to the last line if it is at the beginning
 239 func (c *Cursor) Left() {
 240         if c.Loc() == 0 {
 241                 return
 242         }
 243         if c.x > 0 {
 244                 c.x--
 245         } else {
 246                 c.Up()
 247                 c.End()
 248         }
 249         c.lastVisualX = c.GetVisualX()
 250 }
 251
 252 // Right moves the cursor right one cell (if possible) or to the next line if it is at the end
 253 func (c *Cursor) Right() {
 254         if c.Loc() == c.v.buf.Len() {
 255                 return
 256         }
 257         if c.x < Count(c.v.buf.lines[c.y]) {
 258                 c.x++
 259         } else {
 260                 c.Down()
 261                 c.Start()
 262         }
 263         c.lastVisualX = c.GetVisualX()
 264 }
 265
 266 // End moves the cursor to the end of the line it is on
 267 func (c *Cursor) End() {
 268         c.x = Count(c.v.buf.lines[c.y])
 269         c.lastVisualX = c.GetVisualX()
 270 }
 271
 272 // Start moves the cursor to the start of the line it is on
 273 func (c *Cursor) Start() {
 274         c.x = 0
 275         c.lastVisualX = c.GetVisualX()
 276 }
 277
 278 // GetCharPosInLine gets the char position of a visual x y coordinate (this is necessary because tabs are 1 char but 4 visual spaces)
 279 func (c *Cursor) GetCharPosInLine(lineNum, visualPos int) int {
 280         // Get the tab size
 281         tabSize := settings.TabSize
 282         // This is the visual line -- every \t replaced with the correct number of spaces
 283         visualLine := strings.Replace(c.v.buf.lines[lineNum], "\t", "\t"+Spaces(tabSize-1), -1)
 284         if visualPos > Count(visualLine) {
 285                 visualPos = Count(visualLine)
 286         }
 287         numTabs := NumOccurences(visualLine[:visualPos], '\t')
 288         if visualPos >= (tabSize-1)*numTabs {
 289                 return visualPos - (tabSize-1)*numTabs
 290         }
 291         return visualPos / tabSize
 292 }
 293
 294 // GetVisualX returns the x value of the cursor in visual spaces
 295 func (c *Cursor) GetVisualX() int {
 296         runes := []rune(c.v.buf.lines[c.y])
 297         tabSize := settings.TabSize
 298         return c.x + NumOccurences(string(runes[:c.x]), '\t')*(tabSize-1)
 299 }
 300
 301 // Display draws the cursor to the screen at the correct position
 302 func (c *Cursor) Display() {
 303         // Don't draw the cursor if it is out of the viewport or if it has a selection
 304         if (c.y-c.v.topline < 0 || c.y-c.v.topline > c.v.height-1) || c.HasSelection() {
 305                 screen.HideCursor()
 306         } else {
 307                 screen.ShowCursor(c.GetVisualX()+c.v.lineNumOffset-c.v.leftCol, c.y-c.v.topline)
 308         }
 309 }