Docs Update
This commit is contained in:
Robert Jelic
252
src/elements/TextBox.lua
Normal file
252
src/elements/TextBox.lua
Normal file
@@ -0,0 +1,252 @@
|
||||
local VisualElement = require("elements/VisualElement")
|
||||
local tHex = require("libraries/colorHex")
|
||||
|
||||
---A multi-line text editor component with cursor support and text manipulation features
|
||||
---@class TextBox : VisualElement
|
||||
local TextBox = setmetatable({}, VisualElement)
|
||||
TextBox.__index = TextBox
|
||||
|
||||
---@property lines table {} Array of text lines
|
||||
TextBox.defineProperty(TextBox, "lines", {default = {""}, type = "table", canTriggerRender = true})
|
||||
---@property cursorX number 1 Cursor X position
|
||||
TextBox.defineProperty(TextBox, "cursorX", {default = 1, type = "number"})
|
||||
---@property cursorY number 1 Cursor Y position (line number)
|
||||
TextBox.defineProperty(TextBox, "cursorY", {default = 1, type = "number"})
|
||||
---@property scrollX number 0 Horizontal scroll offset
|
||||
TextBox.defineProperty(TextBox, "scrollX", {default = 0, type = "number", canTriggerRender = true})
|
||||
---@property scrollY number 0 Vertical scroll offset
|
||||
TextBox.defineProperty(TextBox, "scrollY", {default = 0, type = "number", canTriggerRender = true})
|
||||
---@property editable boolean true Whether text can be edited
|
||||
TextBox.defineProperty(TextBox, "editable", {default = true, type = "boolean"})
|
||||
---@property syntaxPatterns table {} Syntax highlighting patterns
|
||||
TextBox.defineProperty(TextBox, "syntaxPatterns", {default = {}, type = "table"})
|
||||
|
||||
TextBox.listenTo(TextBox, "mouse_click")
|
||||
TextBox.listenTo(TextBox, "key")
|
||||
TextBox.listenTo(TextBox, "char")
|
||||
TextBox.listenTo(TextBox, "mouse_scroll")
|
||||
|
||||
function TextBox.new()
|
||||
local self = setmetatable({}, TextBox):__init()
|
||||
self.set("width", 20)
|
||||
self.set("height", 10)
|
||||
return self
|
||||
end
|
||||
|
||||
function TextBox:init(props, basalt)
|
||||
VisualElement.init(self, props, basalt)
|
||||
self.set("type", "TextBox")
|
||||
return self
|
||||
end
|
||||
|
||||
--- Adds a new syntax highlighting pattern
|
||||
--- @param pattern string The regex pattern to match
|
||||
--- @param color color The color to apply
|
||||
function TextBox:addSyntaxPattern(pattern, color)
|
||||
table.insert(self.get("syntaxPatterns"), {pattern = pattern, color = color})
|
||||
return self
|
||||
end
|
||||
|
||||
local function insertChar(self, char)
|
||||
local lines = self.get("lines")
|
||||
local cursorX = self.get("cursorX")
|
||||
local cursorY = self.get("cursorY")
|
||||
local currentLine = lines[cursorY]
|
||||
lines[cursorY] = currentLine:sub(1, cursorX-1) .. char .. currentLine:sub(cursorX)
|
||||
self.set("cursorX", cursorX + 1)
|
||||
self:updateViewport()
|
||||
self:updateRender()
|
||||
end
|
||||
|
||||
local function newLine(self)
|
||||
local lines = self.get("lines")
|
||||
local cursorX = self.get("cursorX")
|
||||
local cursorY = self.get("cursorY")
|
||||
local currentLine = lines[cursorY]
|
||||
|
||||
local restOfLine = currentLine:sub(cursorX)
|
||||
lines[cursorY] = currentLine:sub(1, cursorX-1)
|
||||
table.insert(lines, cursorY + 1, restOfLine)
|
||||
|
||||
self.set("cursorX", 1)
|
||||
self.set("cursorY", cursorY + 1)
|
||||
self:updateViewport()
|
||||
self:updateRender()
|
||||
end
|
||||
|
||||
local function backspace(self)
|
||||
local lines = self.get("lines")
|
||||
local cursorX = self.get("cursorX")
|
||||
local cursorY = self.get("cursorY")
|
||||
local currentLine = lines[cursorY]
|
||||
|
||||
if cursorX > 1 then
|
||||
lines[cursorY] = currentLine:sub(1, cursorX-2) .. currentLine:sub(cursorX)
|
||||
self.set("cursorX", cursorX - 1)
|
||||
elseif cursorY > 1 then
|
||||
local previousLine = lines[cursorY-1]
|
||||
self.set("cursorX", #previousLine + 1)
|
||||
self.set("cursorY", cursorY - 1)
|
||||
lines[cursorY-1] = previousLine .. currentLine
|
||||
table.remove(lines, cursorY)
|
||||
end
|
||||
self:updateViewport()
|
||||
self:updateRender()
|
||||
end
|
||||
|
||||
function TextBox:updateViewport()
|
||||
local cursorX = self.get("cursorX")
|
||||
local cursorY = self.get("cursorY")
|
||||
local scrollX = self.get("scrollX")
|
||||
local scrollY = self.get("scrollY")
|
||||
local width = self.get("width")
|
||||
local height = self.get("height")
|
||||
|
||||
-- Horizontal scrolling
|
||||
if cursorX - scrollX > width then
|
||||
self.set("scrollX", cursorX - width)
|
||||
elseif cursorX - scrollX < 1 then
|
||||
self.set("scrollX", cursorX - 1)
|
||||
end
|
||||
|
||||
-- Vertical scrolling
|
||||
if cursorY - scrollY > height then
|
||||
self.set("scrollY", cursorY - height)
|
||||
elseif cursorY - scrollY < 1 then
|
||||
self.set("scrollY", cursorY - 1)
|
||||
end
|
||||
end
|
||||
|
||||
function TextBox:char(char)
|
||||
if not self.get("editable") or not self.get("focused") then return false end
|
||||
insertChar(self, char)
|
||||
return true
|
||||
end
|
||||
|
||||
function TextBox:key(key)
|
||||
if not self.get("editable") or not self.get("focused") then return false end
|
||||
local lines = self.get("lines")
|
||||
local cursorX = self.get("cursorX")
|
||||
local cursorY = self.get("cursorY")
|
||||
|
||||
if key == keys.enter then
|
||||
newLine(self)
|
||||
elseif key == keys.backspace then
|
||||
backspace(self)
|
||||
elseif key == keys.left then
|
||||
if cursorX > 1 then
|
||||
self.set("cursorX", cursorX - 1)
|
||||
elseif cursorY > 1 then
|
||||
self.set("cursorY", cursorY - 1)
|
||||
self.set("cursorX", #lines[cursorY-1] + 1)
|
||||
end
|
||||
elseif key == keys.right then
|
||||
if cursorX <= #lines[cursorY] then
|
||||
self.set("cursorX", cursorX + 1)
|
||||
elseif cursorY < #lines then
|
||||
self.set("cursorY", cursorY + 1)
|
||||
self.set("cursorX", 1)
|
||||
end
|
||||
elseif key == keys.up and cursorY > 1 then
|
||||
self.set("cursorY", cursorY - 1)
|
||||
self.set("cursorX", math.min(cursorX, #lines[cursorY-1] + 1))
|
||||
elseif key == keys.down and cursorY < #lines then
|
||||
self.set("cursorY", cursorY + 1)
|
||||
self.set("cursorX", math.min(cursorX, #lines[cursorY+1] + 1))
|
||||
end
|
||||
self:updateRender()
|
||||
self:updateViewport()
|
||||
return true
|
||||
end
|
||||
|
||||
function TextBox:mouse_scroll(direction, x, y)
|
||||
if self:isInBounds(x, y) then
|
||||
local scrollY = self.get("scrollY")
|
||||
self.set("scrollY", math.max(0, scrollY + direction))
|
||||
self:updateRender()
|
||||
return true
|
||||
end
|
||||
return false
|
||||
end
|
||||
|
||||
function TextBox:mouse_click(button, x, y)
|
||||
if VisualElement.mouse_click(self, button, x, y) then
|
||||
local relX, relY = self:getRelativePosition(x, y)
|
||||
local scrollX = self.get("scrollX")
|
||||
local scrollY = self.get("scrollY")
|
||||
|
||||
local targetY = relY + scrollY
|
||||
local lines = self.get("lines")
|
||||
|
||||
if targetY <= #lines then
|
||||
self.set("cursorY", targetY)
|
||||
self.set("cursorX", math.min(relX + scrollX, #lines[targetY] + 1))
|
||||
end
|
||||
return true
|
||||
end
|
||||
return false
|
||||
end
|
||||
|
||||
function TextBox:setText(text)
|
||||
self.set("lines", {""})
|
||||
for line in text:gmatch("[^\n]+") do
|
||||
table.insert(self.get("lines"), line)
|
||||
end
|
||||
return self
|
||||
end
|
||||
|
||||
function TextBox:getText()
|
||||
return table.concat(self.get("lines"), "\n")
|
||||
end
|
||||
|
||||
local function applySyntaxHighlighting(self, line)
|
||||
local text = line
|
||||
local colors = string.rep(tHex[self.get("foreground")], #text)
|
||||
local patterns = self.get("syntaxPatterns")
|
||||
|
||||
for _, syntax in ipairs(patterns) do
|
||||
local start = 1
|
||||
while true do
|
||||
local s, e = text:find(syntax.pattern, start)
|
||||
if not s then break end
|
||||
colors = colors:sub(1, s-1) .. string.rep(tHex[syntax.color], e-s+1) .. colors:sub(e+1)
|
||||
start = e + 1
|
||||
end
|
||||
end
|
||||
|
||||
return text, colors
|
||||
end
|
||||
|
||||
function TextBox:render()
|
||||
VisualElement.render(self)
|
||||
|
||||
local lines = self.get("lines")
|
||||
local scrollX = self.get("scrollX")
|
||||
local scrollY = self.get("scrollY")
|
||||
local width = self.get("width")
|
||||
local height = self.get("height")
|
||||
local fg = tHex[self.get("foreground")]
|
||||
local bg = tHex[self.get("background")]
|
||||
|
||||
for y = 1, height do
|
||||
local lineNum = y + scrollY
|
||||
local line = lines[lineNum] or ""
|
||||
local visibleText = line:sub(scrollX + 1, scrollX + width)
|
||||
if #visibleText < width then
|
||||
visibleText = visibleText .. string.rep(" ", width - #visibleText)
|
||||
end
|
||||
|
||||
local text, colors = applySyntaxHighlighting(self, visibleText)
|
||||
self:blit(1, y, text, colors, string.rep(bg, #visibleText))
|
||||
end
|
||||
|
||||
if self.get("focused") then
|
||||
local relativeX = self.get("cursorX") - scrollX
|
||||
local relativeY = self.get("cursorY") - scrollY
|
||||
if relativeX >= 1 and relativeX <= width and relativeY >= 1 and relativeY <= height then
|
||||
self:setCursor(relativeX, relativeY, true)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
return TextBox
|
||||
Reference in New Issue
Block a user