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 if c.GetSelection() == "" {
  95                 return
  96         } else {
  97                 c.v.eh.Remove(c.curSelection[0], c.curSelection[1])
  98                 c.SetLoc(c.curSelection[0])
  99         }
 100 }
 101
 102 // GetSelection returns the cursor's selection
 103 func (c *Cursor) GetSelection() string {
 104         if c.curSelection[0] > c.curSelection[1] {
 105                 return string([]rune(c.v.buf.text)[c.curSelection[1]:c.curSelection[0]])
 106         }
 107         return string([]rune(c.v.buf.text)[c.curSelection[0]:c.curSelection[1]])
 108 }
 109
 110 // SelectLine selects the current line
 111 func (c *Cursor) SelectLine() {
 112         c.Start()
 113         c.curSelection[0] = c.Loc()
 114         c.End()
 115         if len(c.v.buf.lines)-1 > c.y {
 116                 c.curSelection[1] = c.Loc() + 1
 117         } else {
 118                 c.curSelection[1] = c.Loc()
 119         }
 120
 121         c.origSelection = c.curSelection
 122 }
 123
 124 // AddLineToSelection adds the current line to the selection
 125 func (c *Cursor) AddLineToSelection() {
 126         loc := c.Loc()
 127
 128         if loc < c.origSelection[0] {
 129                 c.Start()
 130                 c.curSelection[0] = c.Loc()
 131                 c.curSelection[1] = c.origSelection[1]
 132         }
 133         if loc > c.origSelection[1] {
 134                 c.End()
 135                 c.curSelection[1] = c.Loc()
 136                 c.curSelection[0] = c.origSelection[0]
 137         }
 138
 139         if loc < c.origSelection[1] && loc > c.origSelection[0] {
 140                 c.curSelection = c.origSelection
 141         }
 142 }
 143
 144 // SelectWord selects the word the cursor is currently on
 145 func (c *Cursor) SelectWord() {
 146         if len(c.v.buf.lines[c.y]) == 0 {
 147                 return
 148         }
 149
 150         if !IsWordChar(string(c.RuneUnder(c.x))) {
 151                 loc := c.Loc()
 152                 c.curSelection[0] = loc
 153                 c.curSelection[1] = loc + 1
 154                 c.origSelection = c.curSelection
 155                 return
 156         }
 157
 158         forward, backward := c.x, c.x
 159
 160         for backward > 0 && IsWordChar(string(c.RuneUnder(backward-1))) {
 161                 backward--
 162         }
 163
 164         c.curSelection[0] = ToCharPos(backward, c.y, c.v.buf)
 165         c.origSelection[0] = c.curSelection[0]
 166
 167         for forward < Count(c.v.buf.lines[c.y])-1 && IsWordChar(string(c.RuneUnder(forward+1))) {
 168                 forward++
 169         }
 170
 171         c.curSelection[1] = ToCharPos(forward, c.y, c.v.buf) + 1
 172         c.origSelection[1] = c.curSelection[1]
 173 }
 174
 175 // AddWordToSelection adds the word the cursor is currently on to the selection
 176 func (c *Cursor) AddWordToSelection() {
 177         loc := c.Loc()
 178
 179         if loc > c.origSelection[0] && loc < c.origSelection[1] {
 180                 c.curSelection = c.origSelection
 181                 return
 182         }
 183
 184         if loc < c.origSelection[0] {
 185                 backward := c.x
 186
 187                 for backward > 0 && IsWordChar(string(c.RuneUnder(backward-1))) {
 188                         backward--
 189                 }
 190
 191                 c.curSelection[0] = ToCharPos(backward, c.y, c.v.buf)
 192                 c.curSelection[1] = c.origSelection[1]
 193         }
 194
 195         if loc > c.origSelection[1] {
 196                 forward := c.x
 197
 198                 for forward < Count(c.v.buf.lines[c.y])-1 && IsWordChar(string(c.RuneUnder(forward+1))) {
 199                         forward++
 200                 }
 201
 202                 c.curSelection[1] = ToCharPos(forward, c.y, c.v.buf) + 1
 203                 c.curSelection[0] = c.origSelection[0]
 204         }
 205 }
 206
 207 func (c *Cursor) SelectTo(loc int) {
 208         if loc > c.origSelection[0] {
 209                 c.curSelection[0] = c.origSelection[0]
 210                 c.curSelection[1] = loc + 1
 211         } else {
 212                 c.curSelection[0] = loc
 213                 c.curSelection[1] = c.origSelection[0] + 1
 214         }
 215 }
 216
 217 func (c *Cursor) WordRight() {
 218         for IsWordChar(string(c.RuneUnder(c.x))) {
 219                 c.Right()
 220         }
 221         c.Right()
 222 }
 223
 224 func (c *Cursor) WordLeft() {
 225         for IsWordChar(string(c.RuneUnder(c.x))) {
 226                 c.Left()
 227         }
 228         c.Left()
 229 }
 230
 231 // RuneUnder returns the rune under the given x position
 232 func (c *Cursor) RuneUnder(x int) rune {
 233         line := []rune(c.v.buf.lines[c.y])
 234         if len(line) == 0 {
 235                 return '\n'
 236         }
 237         if x >= len(line) {
 238                 x = len(line) - 1
 239         } else if x < 0 {
 240                 x = 0
 241         }
 242         return line[x]
 243 }
 244
 245 // Up moves the cursor up one line (if possible)
 246 func (c *Cursor) Up() {
 247         if c.y > 0 {
 248                 c.y--
 249
 250                 runes := []rune(c.v.buf.lines[c.y])
 251                 c.x = c.GetCharPosInLine(c.y, c.lastVisualX)
 252                 if c.x > len(runes) {
 253                         c.x = len(runes)
 254                 }
 255         }
 256 }
 257
 258 // Down moves the cursor down one line (if possible)
 259 func (c *Cursor) Down() {
 260         if c.y < len(c.v.buf.lines)-1 {
 261                 c.y++
 262
 263                 runes := []rune(c.v.buf.lines[c.y])
 264                 c.x = c.GetCharPosInLine(c.y, c.lastVisualX)
 265                 if c.x > len(runes) {
 266                         c.x = len(runes)
 267                 }
 268         }
 269 }
 270
 271 // Left moves the cursor left one cell (if possible) or to the last line if it is at the beginning
 272 func (c *Cursor) Left() {
 273         if c.Loc() == 0 {
 274                 return
 275         }
 276         if c.x > 0 {
 277                 c.x--
 278         } else {
 279                 c.Up()
 280                 c.End()
 281         }
 282         c.lastVisualX = c.GetVisualX()
 283 }
 284
 285 // Right moves the cursor right one cell (if possible) or to the next line if it is at the end
 286 func (c *Cursor) Right() {
 287         if c.Loc() == c.v.buf.Len() {
 288                 return
 289         }
 290         if c.x < Count(c.v.buf.lines[c.y]) {
 291                 c.x++
 292         } else {
 293                 c.Down()
 294                 c.Start()
 295         }
 296         c.lastVisualX = c.GetVisualX()
 297 }
 298
 299 // End moves the cursor to the end of the line it is on
 300 func (c *Cursor) End() {
 301         c.x = Count(c.v.buf.lines[c.y])
 302         c.lastVisualX = c.GetVisualX()
 303 }
 304
 305 // Start moves the cursor to the start of the line it is on
 306 func (c *Cursor) Start() {
 307         c.x = 0
 308         c.lastVisualX = c.GetVisualX()
 309 }
 310
 311 // GetCharPosInLine gets the char position of a visual x y coordinate (this is necessary because tabs are 1 char but 4 visual spaces)
 312 func (c *Cursor) GetCharPosInLine(lineNum, visualPos int) int {
 313         // Get the tab size
 314         tabSize := settings.TabSize
 315         // This is the visual line -- every \t replaced with the correct number of spaces
 316         visualLine := strings.Replace(c.v.buf.lines[lineNum], "\t", "\t"+Spaces(tabSize-1), -1)
 317         if visualPos > Count(visualLine) {
 318                 visualPos = Count(visualLine)
 319         }
 320         numTabs := NumOccurences(visualLine[:visualPos], '\t')
 321         if visualPos >= (tabSize-1)*numTabs {
 322                 return visualPos - (tabSize-1)*numTabs
 323         }
 324         return visualPos / tabSize
 325 }
 326
 327 // GetVisualX returns the x value of the cursor in visual spaces
 328 func (c *Cursor) GetVisualX() int {
 329         runes := []rune(c.v.buf.lines[c.y])
 330         tabSize := settings.TabSize
 331         return c.x + NumOccurences(string(runes[:c.x]), '\t')*(tabSize-1)
 332 }
 333
 334 // Relocate makes sure that the cursor is inside the bounds of the buffer
 335 // If it isn't, it moves it to be within the buffer's lines
 336 func (c *Cursor) Relocate() {
 337         if c.y < 0 {
 338                 c.y = 0
 339         } else if c.y >= len(c.v.buf.lines) {
 340                 c.y = len(c.v.buf.lines) - 1
 341         }
 342
 343         if c.x < 0 {
 344                 c.x = 0
 345         } else if c.x > Count(c.v.buf.lines[c.y]) {
 346                 c.x = Count(c.v.buf.lines[c.y])
 347         }
 348 }
 349
 350 // Display draws the cursor to the screen at the correct position
 351 func (c *Cursor) Display() {
 352         // Don't draw the cursor if it is out of the viewport or if it has a selection
 353         if (c.y-c.v.topline < 0 || c.y-c.v.topline > c.v.height-1) || c.HasSelection() {
 354                 screen.HideCursor()
 355         } else {
 356                 screen.ShowCursor(c.GetVisualX()+c.v.lineNumOffset-c.v.leftCol, c.y-c.v.topline)
 357         }
 358 }