1557 lines
61 KiB
Plaintext
1557 lines
61 KiB
Plaintext
// stb_textedit.h - v1.14 - public domain - Sean Barrett
|
|
// Development of this library was sponsored by RAD Game Tools
|
|
//
|
|
// This C header file implements the guts of a multi-line text-editing
|
|
// widget; you implement display, word-wrapping, and low-level string
|
|
// insertion/deletion, and stb_textedit will map user inputs into
|
|
// insertions & deletions, plus updates to the cursor position,
|
|
// selection state, and undo state.
|
|
//
|
|
// It is intended for use in games and other systems that need to build
|
|
// their own custom widgets and which do not have heavy text-editing
|
|
// requirements (this library is not recommended for use for editing large
|
|
// texts, as its performance does not scale and it has limited undo).
|
|
//
|
|
// Non-trivial behaviors are modelled after Windows text controls.
|
|
//
|
|
//
|
|
// LICENSE
|
|
//
|
|
// See end of file for license information.
|
|
//
|
|
//
|
|
// DEPENDENCIES
|
|
//
|
|
// Uses the C runtime function 'memmove', which you can override
|
|
// by defining STB_TEXTEDIT_memmove before the implementation.
|
|
// Uses no other functions. Performs no runtime allocations.
|
|
//
|
|
//
|
|
// VERSION HISTORY
|
|
//
|
|
// 1.14 (2021-07-11) page up/down, various fixes
|
|
// 1.13 (2019-02-07) fix bug in undo size management
|
|
// 1.12 (2018-01-29) user can change STB_TEXTEDIT_KEYTYPE, fix redo to avoid crash
|
|
// 1.11 (2017-03-03) fix HOME on last line, dragging off single-line textfield
|
|
// 1.10 (2016-10-25) supress warnings about casting away const with -Wcast-qual
|
|
// 1.9 (2016-08-27) customizable move-by-word
|
|
// 1.8 (2016-04-02) better keyboard handling when mouse button is down
|
|
// 1.7 (2015-09-13) change y range handling in case baseline is non-0
|
|
// 1.6 (2015-04-15) allow STB_TEXTEDIT_memmove
|
|
// 1.5 (2014-09-10) add support for secondary keys for OS X
|
|
// 1.4 (2014-08-17) fix signed/unsigned warnings
|
|
// 1.3 (2014-06-19) fix mouse clicking to round to nearest char boundary
|
|
// 1.2 (2014-05-27) fix some RAD types that had crept into the new code
|
|
// 1.1 (2013-12-15) move-by-word (requires STB_TEXTEDIT_IS_SPACE )
|
|
// 1.0 (2012-07-26) improve documentation, initial public release
|
|
// 0.3 (2012-02-24) bugfixes, single-line mode; insert mode
|
|
// 0.2 (2011-11-28) fixes to undo/redo
|
|
// 0.1 (2010-07-08) initial version
|
|
//
|
|
// ADDITIONAL CONTRIBUTORS
|
|
//
|
|
// Ulf Winklemann: move-by-word in 1.1
|
|
// Fabian Giesen: secondary key inputs in 1.5
|
|
// Martins Mozeiko: STB_TEXTEDIT_memmove in 1.6
|
|
// Louis Schnellbach: page up/down in 1.14
|
|
//
|
|
// Bugfixes:
|
|
// Scott Graham
|
|
// Daniel Keller
|
|
// Omar Cornut
|
|
// Dan Thompson
|
|
//
|
|
// USAGE
|
|
//
|
|
// This file behaves differently depending on what symbols you define
|
|
// before including it.
|
|
//
|
|
//
|
|
// Header-file mode:
|
|
//
|
|
// If you do not define STB_TEXTEDIT_IMPLEMENTATION before including this,
|
|
// it will operate in "header file" mode. In this mode, it declares a
|
|
// single public symbol, STB_TexteditState, which encapsulates the current
|
|
// state of a text widget (except for the string, which you will store
|
|
// separately).
|
|
//
|
|
// To compile in this mode, you must define STB_TEXTEDIT_CHARTYPE to a
|
|
// primitive type that defines a single character (e.g. char, wchar_t, etc).
|
|
//
|
|
// To save space or increase undo-ability, you can optionally define the
|
|
// following things that are used by the undo system:
|
|
//
|
|
// STB_TEXTEDIT_POSITIONTYPE small int type encoding a valid cursor position
|
|
// STB_TEXTEDIT_UNDOSTATECOUNT the number of undo states to allow
|
|
// STB_TEXTEDIT_UNDOCHARCOUNT the number of characters to store in the undo buffer
|
|
//
|
|
// If you don't define these, they are set to permissive types and
|
|
// moderate sizes. The undo system does no memory allocations, so
|
|
// it grows STB_TexteditState by the worst-case storage which is (in bytes):
|
|
//
|
|
// [4 + 3 * sizeof(STB_TEXTEDIT_POSITIONTYPE)] * STB_TEXTEDIT_UNDOSTATECOUNT
|
|
// + sizeof(STB_TEXTEDIT_CHARTYPE) * STB_TEXTEDIT_UNDOCHARCOUNT
|
|
//
|
|
//
|
|
// Implementation mode:
|
|
//
|
|
// If you define STB_TEXTEDIT_IMPLEMENTATION before including this, it
|
|
// will compile the implementation of the text edit widget, depending
|
|
// on a large number of symbols which must be defined before the include.
|
|
//
|
|
// The implementation is defined only as static functions. You will then
|
|
// need to provide your own APIs in the same file which will access the
|
|
// static functions.
|
|
//
|
|
// The basic concept is that you provide a "string" object which
|
|
// behaves like an array of characters. stb_textedit uses indices to
|
|
// refer to positions in the string, implicitly representing positions
|
|
// in the displayed textedit. This is true for both plain text and
|
|
// rich text; even with rich text stb_truetype interacts with your
|
|
// code as if there was an array of all the displayed characters.
|
|
//
|
|
// Symbols that must be the same in header-file and implementation mode:
|
|
//
|
|
// STB_TEXTEDIT_CHARTYPE the character type
|
|
// STB_TEXTEDIT_POSITIONTYPE small type that is a valid cursor position
|
|
// STB_TEXTEDIT_UNDOSTATECOUNT the number of undo states to allow
|
|
// STB_TEXTEDIT_UNDOCHARCOUNT the number of characters to store in the undo buffer
|
|
//
|
|
// Symbols you must define for implementation mode:
|
|
//
|
|
// STB_TEXTEDIT_STRING the type of object representing a string being edited,
|
|
// typically this is a wrapper object with other data you need
|
|
//
|
|
// STB_TEXTEDIT_STRINGLEN(obj) the length of the string (ideally O(1))
|
|
// STB_TEXTEDIT_LAYOUTROW(&r,obj,n) returns the results of laying out a line of characters
|
|
// starting from character #n (see discussion below)
|
|
// STB_TEXTEDIT_GETWIDTH(obj,n,i) returns the pixel delta from the xpos of the i'th character
|
|
// to the xpos of the i+1'th char for a line of characters
|
|
// starting at character #n (i.e. accounts for kerning
|
|
// with previous char)
|
|
// STB_TEXTEDIT_KEYTOTEXT(k) maps a keyboard input to an insertable character
|
|
// (return type is int, -1 means not valid to insert)
|
|
// STB_TEXTEDIT_GETCHAR(obj,i) returns the i'th character of obj, 0-based
|
|
// STB_TEXTEDIT_NEWLINE the character returned by _GETCHAR() we recognize
|
|
// as manually wordwrapping for end-of-line positioning
|
|
//
|
|
// STB_TEXTEDIT_DELETECHARS(obj,i,n) delete n characters starting at i
|
|
// STB_TEXTEDIT_INSERTCHARS(obj,i,c*,n) insert n characters at i (pointed to by STB_TEXTEDIT_CHARTYPE*)
|
|
//
|
|
// STB_TEXTEDIT_K_SHIFT a power of two that is or'd in to a keyboard input to represent the shift key
|
|
//
|
|
// STB_TEXTEDIT_K_LEFT keyboard input to move cursor left
|
|
// STB_TEXTEDIT_K_RIGHT keyboard input to move cursor right
|
|
// STB_TEXTEDIT_K_UP keyboard input to move cursor up
|
|
// STB_TEXTEDIT_K_DOWN keyboard input to move cursor down
|
|
// STB_TEXTEDIT_K_PGUP keyboard input to move cursor up a page
|
|
// STB_TEXTEDIT_K_PGDOWN keyboard input to move cursor down a page
|
|
// STB_TEXTEDIT_K_LINESTART keyboard input to move cursor to start of line // e.g. HOME
|
|
// STB_TEXTEDIT_K_LINEEND keyboard input to move cursor to end of line // e.g. END
|
|
// STB_TEXTEDIT_K_TEXTSTART keyboard input to move cursor to start of text // e.g. ctrl-HOME
|
|
// STB_TEXTEDIT_K_TEXTEND keyboard input to move cursor to end of text // e.g. ctrl-END
|
|
// STB_TEXTEDIT_K_DELETE keyboard input to delete selection or character under cursor
|
|
// STB_TEXTEDIT_K_BACKSPACE keyboard input to delete selection or character left of cursor
|
|
// STB_TEXTEDIT_K_UNDO keyboard input to perform undo
|
|
// STB_TEXTEDIT_K_REDO keyboard input to perform redo
|
|
//
|
|
// Optional:
|
|
// STB_TEXTEDIT_K_INSERT keyboard input to toggle insert mode
|
|
// STB_TEXTEDIT_IS_SPACE(ch) true if character is whitespace (e.g. 'isspace'),
|
|
// required for default WORDLEFT/WORDRIGHT handlers
|
|
// STB_TEXTEDIT_MOVEWORDLEFT(obj,i) custom handler for WORDLEFT, returns index to move cursor to
|
|
// STB_TEXTEDIT_MOVEWORDRIGHT(obj,i) custom handler for WORDRIGHT, returns index to move cursor to
|
|
// STB_TEXTEDIT_K_WORDLEFT keyboard input to move cursor left one word // e.g. ctrl-LEFT
|
|
// STB_TEXTEDIT_K_WORDRIGHT keyboard input to move cursor right one word // e.g. ctrl-RIGHT
|
|
// STB_TEXTEDIT_K_LINESTART2 secondary keyboard input to move cursor to start of line
|
|
// STB_TEXTEDIT_K_LINEEND2 secondary keyboard input to move cursor to end of line
|
|
// STB_TEXTEDIT_K_TEXTSTART2 secondary keyboard input to move cursor to start of text
|
|
// STB_TEXTEDIT_K_TEXTEND2 secondary keyboard input to move cursor to end of text
|
|
//
|
|
// Keyboard input must be encoded as a single integer value; e.g. a character code
|
|
// and some bitflags that represent shift states. to simplify the interface, SHIFT must
|
|
// be a bitflag, so we can test the shifted state of cursor movements to allow selection,
|
|
// i.e. (STB_TEXTEDIT_K_RIGHT|STB_TEXTEDIT_K_SHIFT) should be shifted right-arrow.
|
|
//
|
|
// You can encode other things, such as CONTROL or ALT, in additional bits, and
|
|
// then test for their presence in e.g. STB_TEXTEDIT_K_WORDLEFT. For example,
|
|
// my Windows implementations add an additional CONTROL bit, and an additional KEYDOWN
|
|
// bit. Then all of the STB_TEXTEDIT_K_ values bitwise-or in the KEYDOWN bit,
|
|
// and I pass both WM_KEYDOWN and WM_CHAR events to the "key" function in the
|
|
// API below. The control keys will only match WM_KEYDOWN events because of the
|
|
// keydown bit I add, and STB_TEXTEDIT_KEYTOTEXT only tests for the KEYDOWN
|
|
// bit so it only decodes WM_CHAR events.
|
|
//
|
|
// STB_TEXTEDIT_LAYOUTROW returns information about the shape of one displayed
|
|
// row of characters assuming they start on the i'th character--the width and
|
|
// the height and the number of characters consumed. This allows this library
|
|
// to traverse the entire layout incrementally. You need to compute word-wrapping
|
|
// here.
|
|
//
|
|
// Each textfield keeps its own insert mode state, which is not how normal
|
|
// applications work. To keep an app-wide insert mode, update/copy the
|
|
// "insert_mode" field of STB_TexteditState before/after calling API functions.
|
|
//
|
|
// API
|
|
//
|
|
// void stb_textedit_initialize_state(STB_TexteditState *state, int is_single_line)
|
|
//
|
|
// void stb_textedit_click(STB_TEXTEDIT_STRING *str, STB_TexteditState *state, float x, float y)
|
|
// void stb_textedit_drag(STB_TEXTEDIT_STRING *str, STB_TexteditState *state, float x, float y)
|
|
// int stb_textedit_cut(STB_TEXTEDIT_STRING *str, STB_TexteditState *state)
|
|
// int stb_textedit_paste(STB_TEXTEDIT_STRING *str, STB_TexteditState *state, STB_TEXTEDIT_CHARTYPE *text, int len)
|
|
// void stb_textedit_key(STB_TEXTEDIT_STRING *str, STB_TexteditState *state, STB_TEXTEDIT_KEYTYPE key)
|
|
//
|
|
// Each of these functions potentially updates the string and updates the
|
|
// state.
|
|
//
|
|
// initialize_state:
|
|
// set the textedit state to a known good default state when initially
|
|
// constructing the textedit.
|
|
//
|
|
// click:
|
|
// call this with the mouse x,y on a mouse down; it will update the cursor
|
|
// and reset the selection start/end to the cursor point. the x,y must
|
|
// be relative to the text widget, with (0,0) being the top left.
|
|
//
|
|
// drag:
|
|
// call this with the mouse x,y on a mouse drag/up; it will update the
|
|
// cursor and the selection end point
|
|
//
|
|
// cut:
|
|
// call this to delete the current selection; returns true if there was
|
|
// one. you should FIRST copy the current selection to the system paste buffer.
|
|
// (To copy, just copy the current selection out of the string yourself.)
|
|
//
|
|
// paste:
|
|
// call this to paste text at the current cursor point or over the current
|
|
// selection if there is one.
|
|
//
|
|
// key:
|
|
// call this for keyboard inputs sent to the textfield. you can use it
|
|
// for "key down" events or for "translated" key events. if you need to
|
|
// do both (as in Win32), or distinguish Unicode characters from control
|
|
// inputs, set a high bit to distinguish the two; then you can define the
|
|
// various definitions like STB_TEXTEDIT_K_LEFT have the is-key-event bit
|
|
// set, and make STB_TEXTEDIT_KEYTOCHAR check that the is-key-event bit is
|
|
// clear. STB_TEXTEDIT_KEYTYPE defaults to int, but you can #define it to
|
|
// anything other type you wante before including.
|
|
//
|
|
//
|
|
// When rendering, you can read the cursor position and selection state from
|
|
// the STB_TexteditState.
|
|
//
|
|
//
|
|
// Notes:
|
|
//
|
|
// This is designed to be usable in IMGUI, so it allows for the possibility of
|
|
// running in an IMGUI that has NOT cached the multi-line layout. For this
|
|
// reason, it provides an interface that is compatible with computing the
|
|
// layout incrementally--we try to make sure we make as few passes through
|
|
// as possible. (For example, to locate the mouse pointer in the text, we
|
|
// could define functions that return the X and Y positions of characters
|
|
// and binary search Y and then X, but if we're doing dynamic layout this
|
|
// will run the layout algorithm many times, so instead we manually search
|
|
// forward in one pass. Similar logic applies to e.g. up-arrow and
|
|
// down-arrow movement.)
|
|
//
|
|
// If it's run in a widget that *has* cached the layout, then this is less
|
|
// efficient, but it's not horrible on modern computers. But you wouldn't
|
|
// want to edit million-line files with it.
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////
|
|
////////////////////////////////////////////////////////////////////////////
|
|
////
|
|
//// Header-file mode
|
|
////
|
|
////
|
|
|
|
////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// STB_TexteditState
|
|
//
|
|
// Definition of STB_TexteditState which you should store
|
|
// per-textfield; it includes cursor position, selection state,
|
|
// and undo state.
|
|
//
|
|
|
|
STB_TEXTEDIT_STRING :: TextInput;
|
|
|
|
STB_TEXTEDIT_STRINGLEN :: (obj: *STB_TEXTEDIT_STRING) -> s32 {
|
|
return xx obj.text.count;
|
|
}
|
|
|
|
STB_TEXTEDIT_KEYTOTEXT :: (k: STB_TEXTEDIT_KEYTYPE) -> s32 #expand {
|
|
return ifx k >= 0 then k else -1;
|
|
}
|
|
|
|
STB_TEXTEDIT_DELETECHARS :: (obj: *STB_TEXTEDIT_STRING, i: s32, n: s32) {
|
|
if (i >= obj.text.count) return; // Nothing to remove
|
|
if (i + n > obj.text.count) n = xx obj.text.count - i; // Trim n if it goes past end
|
|
memcpy(*obj.text.data[i], *obj.text.data[i + n], obj.text.count - i - n);
|
|
array_resize(*obj.text, obj.text.count - n, false);
|
|
}
|
|
|
|
STB_TEXTEDIT_GETCHAR :: (obj: *STB_TEXTEDIT_STRING, i: s32) -> STB_TEXTEDIT_CHARTYPE {
|
|
if i > obj.text.count return 0;
|
|
|
|
return obj.text.data[i];
|
|
}
|
|
|
|
STB_TEXTEDIT_INSERTCHARS :: (obj: *STB_TEXTEDIT_STRING, i: s32, c: *STB_TEXTEDIT_CHARTYPE, n: s32) -> bool {
|
|
// insert n characters at i (pointed to by STB_TEXTEDIT_CHARTYPE*)
|
|
// Ensure index doesn't exceed current string length
|
|
if (i > obj.text.count) i = xx obj.text.count;
|
|
|
|
len := obj.text.count;
|
|
|
|
if n + len > obj.text.count {
|
|
array_resize(*obj.text, n + len);
|
|
}
|
|
|
|
|
|
// Shift the tail of the string right by n characters
|
|
if i != len
|
|
//memcpy(obj.text.data + ((i + n) * size_of(STB_TEXTEDIT_CHARTYPE)), obj.text.data + (i * size_of(STB_TEXTEDIT_CHARTYPE)), (len - i) * size_of(STB_TEXTEDIT_CHARTYPE));
|
|
memcpy(obj.text.data + ((i + n)), obj.text.data + (i), (len - i) * size_of(STB_TEXTEDIT_CHARTYPE));
|
|
|
|
//memcpy(obj.text.data + (i * size_of(STB_TEXTEDIT_CHARTYPE)), c, n * size_of(STB_TEXTEDIT_CHARTYPE));
|
|
memcpy(obj.text.data + (i), c, n * size_of(STB_TEXTEDIT_CHARTYPE));
|
|
|
|
return true;
|
|
}
|
|
|
|
STB_TEXTEDIT_LAYOUTROW :: (row: *StbTexteditRow, obj: *STB_TEXTEDIT_STRING, n: s32) {
|
|
idx : s32;
|
|
if n + idx < obj.text.count && row.x1 < obj.max_size.x - (2 * obj.margin + 2 * obj.border_size + 2 * obj.padding) {
|
|
size, max_descent, read := next_line_size(obj.font, obj.text, n + idx, obj.max_size.x - (2 * obj.margin + 2 * obj.border_size + 2 * obj.padding));
|
|
|
|
if row.x1 + size.x > obj.max_size.x - (2 * obj.margin + 2 * obj.border_size + 2 * obj.padding) {
|
|
|
|
while word := n + idx < obj.text.count && row.x1 < obj.max_size.x - (2 * obj.margin + 2 * obj.border_size + 2 * obj.padding) {
|
|
size, max_descent, read := next_word_size(obj.font, obj.text, n + idx, obj.max_size.x - (2 * obj.margin + 2 * obj.border_size + 2 * obj.padding));
|
|
|
|
if row.x1 + size.x > obj.max_size.x - (2 * obj.margin + 2 * obj.border_size + 2 * obj.padding) {
|
|
while grapheme := idx < obj.text.count {
|
|
size, max_descent, read := next_grapheme_size(obj.font, obj.text, n + idx, obj.max_size.x - (2 * obj.margin + 2 * obj.border_size + 2 * obj.padding));
|
|
|
|
if row.x1 + size.x > obj.max_size.x - (2 * obj.margin + 2 * obj.border_size + 2 * obj.padding) {
|
|
//break word;
|
|
return;
|
|
}
|
|
|
|
row.x1 += size.x;
|
|
row.baseline_y_delta = max(row.baseline_y_delta, size.y);
|
|
row.ymin = max(row.ymin, max_descent);
|
|
row.ymax = max(row.ymax, size.y - row.ymin);
|
|
row.num_chars += read;
|
|
idx += read;
|
|
}
|
|
}
|
|
|
|
row.x1 += size.x;
|
|
row.baseline_y_delta = max(row.baseline_y_delta, size.y);
|
|
row.ymin = max(row.ymin, max_descent);
|
|
row.ymax = max(row.ymax, size.y - row.ymin);
|
|
row.num_chars += read;
|
|
idx += read;
|
|
}
|
|
}
|
|
|
|
row.x1 += size.x;
|
|
row.baseline_y_delta = max(row.baseline_y_delta, size.y);
|
|
row.ymin = max(row.ymin, max_descent);
|
|
row.ymax = max(row.ymax, size.y - row.ymin);
|
|
row.num_chars += read;
|
|
idx += read;
|
|
}
|
|
|
|
row.x0 = 0.0;
|
|
}
|
|
|
|
STB_TEXTEDIT_GETWIDTH :: (obj: *STB_TEXTEDIT_STRING, n: s32, i: s32) -> float {
|
|
textp : *u32 = obj.text.data;
|
|
Codepoints : *u32 = textp + n;
|
|
CodepointCount : u64 = xx (obj.text.count - (Codepoints - textp));
|
|
|
|
Cursor : kbts_cursor;
|
|
Direction : kbts_direction = .NONE;
|
|
Script : kbts_script = .DONT_KNOW;
|
|
RunStart : u64 = 0;
|
|
BreakState : kbts_break_state;
|
|
kbts_BeginBreak(*BreakState, .NONE, .NORMAL);
|
|
|
|
width : float;
|
|
|
|
CodepointIndex : u64;
|
|
while CodepointIndex <= xx i {
|
|
kbts_BreakAddCodepoint(*BreakState, Codepoints[CodepointIndex], 1, xx ((CodepointIndex + 1) == xx CodepointCount));
|
|
Break : kbts_break;
|
|
while kbts_Break(*BreakState, *Break) {
|
|
|
|
if Break.Flags & .DIRECTION {
|
|
Direction = Break.Direction;
|
|
if(!Cursor.Direction) Cursor = kbts_Cursor(BreakState.MainDirection);
|
|
}
|
|
|
|
if Break.Flags & .SCRIPT {
|
|
Script = Break.Script;
|
|
}
|
|
|
|
if (Break.Position > RunStart) && (Break.Flags & .GRAPHEME) {
|
|
RunLength : u64 = Break.Position - RunStart;
|
|
size, max_descent := ShapeText(obj.font, *Cursor, Codepoints + RunStart, RunLength, BreakState.MainDirection, Direction, Script);
|
|
|
|
width = size.x;
|
|
}
|
|
}
|
|
|
|
CodepointIndex += 1;
|
|
}
|
|
|
|
return width;
|
|
}
|
|
|
|
STB_TEXTEDIT_K_LEFT :: 0x200000; // keyboard input to move cursor left
|
|
STB_TEXTEDIT_K_RIGHT :: 0x200001; // keyboard input to move cursor right
|
|
STB_TEXTEDIT_K_UP :: 0x200002; // keyboard input to move cursor up
|
|
STB_TEXTEDIT_K_DOWN :: 0x200003; // keyboard input to move cursor down
|
|
STB_TEXTEDIT_K_LINESTART :: 0x200004; // keyboard input to move cursor to start of line
|
|
STB_TEXTEDIT_K_LINEEND :: 0x200005; // keyboard input to move cursor to end of line
|
|
STB_TEXTEDIT_K_TEXTSTART :: 0x200006; // keyboard input to move cursor to start of text
|
|
STB_TEXTEDIT_K_TEXTEND :: 0x200007; // keyboard input to move cursor to end of text
|
|
STB_TEXTEDIT_K_DELETE :: 0x200008; // keyboard input to delete selection or character under cursor
|
|
STB_TEXTEDIT_K_BACKSPACE :: 0x200009; // keyboard input to delete selection or character left of cursor
|
|
STB_TEXTEDIT_K_UNDO :: 0x20000A; // keyboard input to perform undo
|
|
STB_TEXTEDIT_K_REDO :: 0x20000B; // keyboard input to perform redo
|
|
STB_TEXTEDIT_K_WORDLEFT :: 0x20000C; // keyboard input to move cursor left one word
|
|
STB_TEXTEDIT_K_WORDRIGHT :: 0x20000D; // keyboard input to move cursor right one word
|
|
STB_TEXTEDIT_K_PGUP :: 0x20000E; // keyboard input to move cursor up a page
|
|
STB_TEXTEDIT_K_PGDOWN :: 0x20000F; // keyboard input to move cursor down a page
|
|
STB_TEXTEDIT_K_SHIFT :: 0x400000;
|
|
|
|
STB_TEXTEDIT_NEWLINE :: #char "\n";
|
|
|
|
#if !#exists(STB_TEXTEDIT_UNDOSTATECOUNT)
|
|
STB_TEXTEDIT_UNDOSTATECOUNT :: 99;
|
|
|
|
#if !#exists(STB_TEXTEDIT_UNDOCHARCOUNT)
|
|
STB_TEXTEDIT_UNDOCHARCOUNT :: 999;
|
|
|
|
#if !#exists(STB_TEXTEDIT_CHARTYPE)
|
|
STB_TEXTEDIT_CHARTYPE :: u32;
|
|
|
|
#if !#exists(STB_TEXTEDIT_POSITIONTYPE)
|
|
STB_TEXTEDIT_POSITIONTYPE :: s32;
|
|
|
|
STB_TEXTEDIT_IS_SPACE :: (ch: u32) -> bool {
|
|
return ch == #char " ";
|
|
}
|
|
|
|
StbUndoRecord :: struct {
|
|
// private data
|
|
where : STB_TEXTEDIT_POSITIONTYPE;
|
|
insert_length : STB_TEXTEDIT_POSITIONTYPE;
|
|
delete_length : STB_TEXTEDIT_POSITIONTYPE;
|
|
char_storage : s32;
|
|
}
|
|
|
|
StbUndoState :: struct {
|
|
// private data
|
|
undo_rec : [STB_TEXTEDIT_UNDOSTATECOUNT]StbUndoRecord;
|
|
undo_char : [STB_TEXTEDIT_UNDOCHARCOUNT]STB_TEXTEDIT_CHARTYPE;
|
|
undo_point, redo_point : s16;
|
|
undo_char_point, redo_char_point : s32;
|
|
}
|
|
|
|
STB_TexteditState :: struct {
|
|
/////////////////////
|
|
//
|
|
// public data
|
|
//
|
|
|
|
cursor : s32;
|
|
// position of the text cursor within the string
|
|
|
|
select_start : s32; // selection start point
|
|
select_end : s32;
|
|
// selection start and end point in characters; if equal, no selection.
|
|
// note that start may be less than or greater than end (e.g. when
|
|
// dragging the mouse, start is where the initial click was, and you
|
|
// can drag in either direction)
|
|
|
|
insert_mode : u8;
|
|
// each textfield keeps its own insert mode state. to keep an app-wide
|
|
// insert mode, copy this value in/out of the app state
|
|
|
|
row_count_per_page : s32;
|
|
// page size in number of row.
|
|
// this value MUST be set to >0 for pageup or pagedown in multilines documents.
|
|
|
|
/////////////////////
|
|
//
|
|
// private data
|
|
//
|
|
cursor_at_end_of_line : u8; // not implemented yet
|
|
initialized : u8;
|
|
has_preferred_x : u8;
|
|
single_line : u8;
|
|
padding1, padding2, padding3 : u8;
|
|
preferred_x : float; // this determines where the cursor up/down tries to seek to along x
|
|
undostate : StbUndoState;
|
|
}
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// StbTexteditRow
|
|
//
|
|
// Result of layout query, used by stb_textedit to determine where
|
|
// the text in each row is.
|
|
|
|
// result of layout query
|
|
StbTexteditRow :: struct {
|
|
x0, x1 : float; // starting x location, end x location (allows for align=right, etc)
|
|
baseline_y_delta : float; // position of baseline relative to previous row's baseline
|
|
ymin, ymax : float; // height of row above and below baseline
|
|
num_chars : s32;
|
|
}
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////
|
|
////////////////////////////////////////////////////////////////////////////
|
|
////
|
|
//// Implementation mode
|
|
////
|
|
////
|
|
|
|
|
|
// implementation isn't include-guarded, since it might have indirectly
|
|
// included just the "header" portion
|
|
|
|
#if !#exists(STB_TEXTEDIT_memmove) {
|
|
//#include <string.h>
|
|
STB_TEXTEDIT_memmove :: memcpy;
|
|
}
|
|
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Mouse input handling
|
|
//
|
|
|
|
// traverse the layout to locate the nearest character to a display position
|
|
stb_text_locate_coord :: (str: *STB_TEXTEDIT_STRING, x: float, y: float) -> s32 {
|
|
r : StbTexteditRow;
|
|
n : s32 = STB_TEXTEDIT_STRINGLEN(str);
|
|
base_y : float = 0;
|
|
prev_x : float;
|
|
i : s32 = 0;
|
|
k : s32;
|
|
|
|
r.x0 = 0;
|
|
r.x1 = 0;
|
|
r.ymin = 0;
|
|
r.ymax = 0;
|
|
r.num_chars = 0;
|
|
|
|
// search rows to find one that straddles 'y'
|
|
while i < n {
|
|
STB_TEXTEDIT_LAYOUTROW(*r, str, i);
|
|
if r.num_chars <= 0
|
|
return n;
|
|
|
|
if i == 0 && y < base_y + r.ymin
|
|
return 0;
|
|
|
|
if y < base_y + r.ymax
|
|
break;
|
|
|
|
i += r.num_chars;
|
|
base_y += r.baseline_y_delta;
|
|
}
|
|
|
|
// below all text, return 'after' last character
|
|
if i >= n
|
|
return n;
|
|
|
|
// check if it's before the beginning of the line
|
|
if x < r.x0
|
|
return i;
|
|
|
|
// check if it's before the end of the line
|
|
if x < r.x1 {
|
|
// search characters in row for one that straddles 'x'
|
|
prev_x = r.x0;
|
|
for k : 0..r.num_chars - 1 {
|
|
w : float = STB_TEXTEDIT_GETWIDTH(str, i, k);
|
|
if x < prev_x + w {
|
|
if x < prev_x + w / 2 {
|
|
return k + i;
|
|
} else {
|
|
return k + i + 1;
|
|
}
|
|
}
|
|
prev_x += w;
|
|
}
|
|
// shouldn't happen, but if it does, fall through to end-of-line case
|
|
}
|
|
|
|
// if the last character is a newline, return that. otherwise return 'after' the last character
|
|
if STB_TEXTEDIT_GETCHAR(str, i + r.num_chars - 1) == STB_TEXTEDIT_NEWLINE
|
|
return i + r.num_chars - 1;
|
|
else
|
|
return i + r.num_chars;
|
|
}
|
|
|
|
// API click: on mouse down, move the cursor to the clicked location, and reset the selection
|
|
stb_textedit_click :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState, x: float, y: float) {
|
|
// In single-line mode, just always make y = 0. This lets the drag keep working if the mouse
|
|
// goes off the top or bottom of the text
|
|
if state.single_line {
|
|
r : StbTexteditRow;
|
|
STB_TEXTEDIT_LAYOUTROW(*r, str, 0);
|
|
y = r.ymin;
|
|
}
|
|
|
|
state.cursor = stb_text_locate_coord(str, x, y);
|
|
state.select_start = state.cursor;
|
|
state.select_end = state.cursor;
|
|
state.has_preferred_x = 0;
|
|
}
|
|
|
|
// API drag: on mouse drag, move the cursor and selection endpoint to the clicked location
|
|
stb_textedit_drag :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState, x: float, y: float) {
|
|
p : s32 = 0;
|
|
|
|
// In single-line mode, just always make y = 0. This lets the drag keep working if the mouse
|
|
// goes off the top or bottom of the text
|
|
if state.single_line {
|
|
r :StbTexteditRow ;
|
|
STB_TEXTEDIT_LAYOUTROW(*r, str, 0);
|
|
y = r.ymin;
|
|
}
|
|
|
|
if state.select_start == state.select_end
|
|
state.select_start = state.cursor;
|
|
|
|
p = stb_text_locate_coord(str, x, y);
|
|
state.cursor = p;
|
|
state.select_end = p;
|
|
}
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Keyboard input handling
|
|
//
|
|
|
|
// forward declarations
|
|
//static void stb_text_undo(STB_TEXTEDIT_STRING *str, STB_TexteditState *state);
|
|
//static void stb_text_redo(STB_TEXTEDIT_STRING *str, STB_TexteditState *state);
|
|
//static void stb_text_makeundo_delete(STB_TEXTEDIT_STRING *str, STB_TexteditState *state, int where, int length);
|
|
//static void stb_text_makeundo_insert(STB_TexteditState *state, int where, int length);
|
|
//static void stb_text_makeundo_replace(STB_TEXTEDIT_STRING *str, STB_TexteditState *state, int where, int old_length, int new_length);
|
|
|
|
StbFindState :: struct {
|
|
x, y : float; // position of n'th character
|
|
height : float; // height of line
|
|
first_char, length : s32; // first char of row, and length
|
|
prev_first : s32; // first char of previous row
|
|
}
|
|
|
|
// find the x/y location of a character, and remember info about the previous row in
|
|
// case we get a move-up event (for page up, we'll have to rescan)
|
|
stb_textedit_find_charpos :: (find: *StbFindState, str: *STB_TEXTEDIT_STRING, n: s32, single_line: s32) {
|
|
r : StbTexteditRow;
|
|
prev_start : s32 = 0;
|
|
z : s32 = STB_TEXTEDIT_STRINGLEN(str);
|
|
i : s32 = 0;
|
|
first : s32;
|
|
|
|
if n == z {
|
|
// if it's at the end, then find the last line -- simpler than trying to
|
|
// explicitly handle this case in the regular code
|
|
if single_line {
|
|
STB_TEXTEDIT_LAYOUTROW(*r, str, 0);
|
|
find.y = 0;
|
|
find.first_char = 0;
|
|
find.length = z;
|
|
find.height = r.ymax - r.ymin;
|
|
find.x = r.x1;
|
|
} else {
|
|
find.y = 0;
|
|
find.x = 0;
|
|
find.height = 1;
|
|
while (i < z) {
|
|
STB_TEXTEDIT_LAYOUTROW(*r, str, i);
|
|
prev_start = i;
|
|
i += r.num_chars;
|
|
}
|
|
find.first_char = i;
|
|
find.length = 0;
|
|
find.prev_first = prev_start;
|
|
}
|
|
return;
|
|
}
|
|
|
|
// search rows to find the one that straddles character n
|
|
find.y = 0;
|
|
|
|
while true {
|
|
STB_TEXTEDIT_LAYOUTROW(*r, str, i);
|
|
if n < i + r.num_chars
|
|
break;
|
|
prev_start = i;
|
|
i += r.num_chars;
|
|
find.y += r.baseline_y_delta;
|
|
}
|
|
|
|
find.first_char = i;
|
|
first = i;
|
|
find.length = r.num_chars;
|
|
find.height = r.ymax - r.ymin;
|
|
find.prev_first = prev_start;
|
|
|
|
// now scan to find xpos
|
|
find.x = r.x0;
|
|
i = 0;
|
|
while first + i < n {
|
|
find.x += STB_TEXTEDIT_GETWIDTH(str, first, i);
|
|
|
|
i += 1;
|
|
}
|
|
}
|
|
|
|
STB_TEXT_HAS_SELECTION :: (s: *STB_TexteditState) -> bool #expand {
|
|
return ((s).select_start != (s).select_end);
|
|
}
|
|
|
|
// make the selection/cursor state valid if client altered the string
|
|
stb_textedit_clamp :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState) {
|
|
n : s32 = STB_TEXTEDIT_STRINGLEN(str);
|
|
if STB_TEXT_HAS_SELECTION(state) {
|
|
if (state.select_start > n) state.select_start = n;
|
|
if (state.select_end > n) state.select_end = n;
|
|
// if clamping forced them to be equal, move the cursor to match
|
|
if (state.select_start == state.select_end)
|
|
state.cursor = state.select_start;
|
|
}
|
|
if (state.cursor > n) state.cursor = n;
|
|
}
|
|
|
|
// delete characters while updating undo
|
|
stb_textedit_delete :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState, where: s32, len: s32) {
|
|
stb_text_makeundo_delete(str, state, where, len);
|
|
STB_TEXTEDIT_DELETECHARS(str, where, len);
|
|
state.has_preferred_x = 0;
|
|
}
|
|
|
|
// delete the section
|
|
stb_textedit_delete_selection :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState) {
|
|
stb_textedit_clamp(str, state);
|
|
if (STB_TEXT_HAS_SELECTION(state)) {
|
|
if (state.select_start < state.select_end) {
|
|
stb_textedit_delete(str, state, state.select_start, state.select_end - state.select_start);
|
|
state.select_end = state.select_start;
|
|
state.cursor = state.select_start;
|
|
} else {
|
|
stb_textedit_delete(str, state, state.select_end, state.select_start - state.select_end);
|
|
state.select_start = state.select_end;
|
|
state.cursor = state.select_end;
|
|
}
|
|
state.has_preferred_x = 0;
|
|
}
|
|
}
|
|
|
|
// canoncialize the selection so start <= end
|
|
stb_textedit_sortselection :: (state: *STB_TexteditState) {
|
|
if (state.select_end < state.select_start) {
|
|
temp : s32 = state.select_end;
|
|
state.select_end = state.select_start;
|
|
state.select_start = temp;
|
|
}
|
|
}
|
|
|
|
// move cursor to first character of selection
|
|
stb_textedit_move_to_first :: (state: *STB_TexteditState) {
|
|
if (STB_TEXT_HAS_SELECTION(state)) {
|
|
stb_textedit_sortselection(state);
|
|
state.cursor = state.select_start;
|
|
state.select_end = state.select_start;
|
|
state.has_preferred_x = 0;
|
|
}
|
|
}
|
|
|
|
// move cursor to last character of selection
|
|
stb_textedit_move_to_last :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState) {
|
|
if (STB_TEXT_HAS_SELECTION(state)) {
|
|
stb_textedit_sortselection(state);
|
|
stb_textedit_clamp(str, state);
|
|
state.cursor = state.select_end;
|
|
state.select_start = state.select_end;
|
|
state.has_preferred_x = 0;
|
|
}
|
|
}
|
|
|
|
#if #exists(STB_TEXTEDIT_IS_SPACE) {
|
|
is_word_boundary :: (str: *STB_TEXTEDIT_STRING, idx: s32) -> bool{
|
|
return ifx idx > 0 then (STB_TEXTEDIT_IS_SPACE(STB_TEXTEDIT_GETCHAR(str, idx - 1)) && !STB_TEXTEDIT_IS_SPACE(STB_TEXTEDIT_GETCHAR(str, idx))) else true;
|
|
}
|
|
}
|
|
|
|
#if !#exists(STB_TEXTEDIT_MOVEWORDLEFT) {
|
|
stb_textedit_move_to_word_previous :: (str: *STB_TEXTEDIT_STRING, c: s32) -> s32 {
|
|
c -= 1; // always move at least one character
|
|
while(c >= 0 && !is_word_boundary(str, c))
|
|
c -= 1;
|
|
|
|
if( c < 0 )
|
|
c = 0;
|
|
|
|
return c;
|
|
}
|
|
|
|
STB_TEXTEDIT_MOVEWORDLEFT :: stb_textedit_move_to_word_previous;
|
|
}
|
|
|
|
#if !#exists(STB_TEXTEDIT_MOVEWORDRIGHT) {
|
|
stb_textedit_move_to_word_next :: (str: *STB_TEXTEDIT_STRING, c: s32) -> s32 {
|
|
len : s32 = STB_TEXTEDIT_STRINGLEN(str);
|
|
c += 1; // always move at least one character
|
|
while c < len && !is_word_boundary( str, c )
|
|
c += 1;
|
|
|
|
if c > len
|
|
c = len;
|
|
|
|
return c;
|
|
}
|
|
STB_TEXTEDIT_MOVEWORDRIGHT :: stb_textedit_move_to_word_next;
|
|
}
|
|
|
|
// update selection and cursor to match each other
|
|
stb_textedit_prep_selection_at_cursor :: (state: *STB_TexteditState) {
|
|
if (!STB_TEXT_HAS_SELECTION(state)) {
|
|
state.select_start = state.cursor;
|
|
state.select_end = state.cursor;
|
|
} else {
|
|
state.cursor = state.select_end;
|
|
}
|
|
}
|
|
|
|
// API cut: delete selection
|
|
stb_textedit_cut :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState) -> s32 {
|
|
if (STB_TEXT_HAS_SELECTION(state)) {
|
|
stb_textedit_delete_selection(str,state); // implicitly clamps
|
|
state.has_preferred_x = 0;
|
|
return 1;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
// API paste: replace existing selection with passed-in text
|
|
stb_textedit_paste_internal :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState, text: *STB_TEXTEDIT_CHARTYPE, len: s32) -> s32 {
|
|
// if there's a selection, the paste should delete it
|
|
stb_textedit_clamp(str, state);
|
|
stb_textedit_delete_selection(str,state);
|
|
// try to insert the characters
|
|
if (STB_TEXTEDIT_INSERTCHARS(str, state.cursor, text, len)) {
|
|
stb_text_makeundo_insert(state, state.cursor, len);
|
|
state.cursor += len;
|
|
state.has_preferred_x = 0;
|
|
return 1;
|
|
}
|
|
// note: paste failure will leave deleted selection, may be restored with an undo (see https://github.com/nothings/stb/issues/734 for details)
|
|
return 0;
|
|
}
|
|
|
|
#if !#exists(STB_TEXTEDIT_KEYTYPE)
|
|
STB_TEXTEDIT_KEYTYPE :: s32;
|
|
|
|
// API key: process a keyboard input
|
|
stb_textedit_key :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState, key: STB_TEXTEDIT_KEYTYPE) {
|
|
while retry := true {
|
|
if key == {
|
|
case;
|
|
c : s32 = STB_TEXTEDIT_KEYTOTEXT(key);
|
|
if c > 0 {
|
|
ch : STB_TEXTEDIT_CHARTYPE = cast(STB_TEXTEDIT_CHARTYPE, c);
|
|
|
|
// can't add newline in single-line mode
|
|
if c == #char "\n" && state.single_line
|
|
break;
|
|
|
|
if state.insert_mode && !STB_TEXT_HAS_SELECTION(state) && state.cursor < STB_TEXTEDIT_STRINGLEN(str) {
|
|
stb_text_makeundo_replace(str, state, state.cursor, 1, 1);
|
|
STB_TEXTEDIT_DELETECHARS(str, state.cursor, 1);
|
|
if STB_TEXTEDIT_INSERTCHARS(str, state.cursor, *ch, 1) {
|
|
state.cursor += 1;
|
|
state.has_preferred_x = 0;
|
|
}
|
|
} else {
|
|
stb_textedit_delete_selection(str,state); // implicitly clamps
|
|
if STB_TEXTEDIT_INSERTCHARS(str, state.cursor, *ch, 1) {
|
|
stb_text_makeundo_insert(state, state.cursor, 1);
|
|
state.cursor += 1;
|
|
state.has_preferred_x = 0;
|
|
}
|
|
}
|
|
}
|
|
|
|
// #if #exists(STB_TEXTEDIT_K_INSERT) {
|
|
// case STB_TEXTEDIT_K_INSERT;
|
|
// state.insert_mode = !state.insert_mode;
|
|
// }
|
|
|
|
case STB_TEXTEDIT_K_UNDO;
|
|
stb_text_undo(str, state);
|
|
state.has_preferred_x = 0;
|
|
|
|
case STB_TEXTEDIT_K_REDO;
|
|
stb_text_redo(str, state);
|
|
state.has_preferred_x = 0;
|
|
|
|
case STB_TEXTEDIT_K_LEFT;
|
|
// if currently there's a selection, move cursor to start of selection
|
|
if (STB_TEXT_HAS_SELECTION(state))
|
|
stb_textedit_move_to_first(state);
|
|
else if state.cursor > 0
|
|
state.cursor -= 1;
|
|
state.has_preferred_x = 0;
|
|
|
|
case STB_TEXTEDIT_K_RIGHT;
|
|
// if currently there's a selection, move cursor to end of selection
|
|
if STB_TEXT_HAS_SELECTION(state)
|
|
stb_textedit_move_to_last(str, state);
|
|
else
|
|
state.cursor += 1;
|
|
stb_textedit_clamp(str, state);
|
|
state.has_preferred_x = 0;
|
|
|
|
case STB_TEXTEDIT_K_LEFT | STB_TEXTEDIT_K_SHIFT;
|
|
stb_textedit_clamp(str, state);
|
|
stb_textedit_prep_selection_at_cursor(state);
|
|
// move selection left
|
|
if (state.select_end > 0)
|
|
state.select_end -= 1;
|
|
state.cursor = state.select_end;
|
|
state.has_preferred_x = 0;
|
|
|
|
//#if #exists(STB_TEXTEDIT_MOVEWORDLEFT) {
|
|
case STB_TEXTEDIT_K_WORDLEFT;
|
|
if (STB_TEXT_HAS_SELECTION(state))
|
|
stb_textedit_move_to_first(state);
|
|
else {
|
|
state.cursor = STB_TEXTEDIT_MOVEWORDLEFT(str, state.cursor);
|
|
stb_textedit_clamp( str, state );
|
|
}
|
|
|
|
case STB_TEXTEDIT_K_WORDLEFT | STB_TEXTEDIT_K_SHIFT;
|
|
if !STB_TEXT_HAS_SELECTION( state )
|
|
stb_textedit_prep_selection_at_cursor(state);
|
|
|
|
state.cursor = STB_TEXTEDIT_MOVEWORDLEFT(str, state.cursor);
|
|
state.select_end = state.cursor;
|
|
|
|
stb_textedit_clamp( str, state );
|
|
//}
|
|
|
|
// #if #exists(STB_TEXTEDIT_MOVEWORDRIGHT) {
|
|
case STB_TEXTEDIT_K_WORDRIGHT;
|
|
if (STB_TEXT_HAS_SELECTION(state)) {
|
|
stb_textedit_move_to_last(str, state);
|
|
} else {
|
|
state.cursor = STB_TEXTEDIT_MOVEWORDRIGHT(str, state.cursor);
|
|
stb_textedit_clamp(str, state);
|
|
}
|
|
|
|
case STB_TEXTEDIT_K_WORDRIGHT | STB_TEXTEDIT_K_SHIFT;
|
|
if !STB_TEXT_HAS_SELECTION(state)
|
|
stb_textedit_prep_selection_at_cursor(state);
|
|
|
|
state.cursor = STB_TEXTEDIT_MOVEWORDRIGHT(str, state.cursor);
|
|
state.select_end = state.cursor;
|
|
|
|
stb_textedit_clamp( str, state );
|
|
// }
|
|
|
|
case STB_TEXTEDIT_K_RIGHT | STB_TEXTEDIT_K_SHIFT;
|
|
stb_textedit_prep_selection_at_cursor(state);
|
|
// move selection right
|
|
state.select_end += 1;
|
|
stb_textedit_clamp(str, state);
|
|
state.cursor = state.select_end;
|
|
state.has_preferred_x = 0;
|
|
|
|
case STB_TEXTEDIT_K_DOWN;
|
|
#through;
|
|
case STB_TEXTEDIT_K_DOWN | STB_TEXTEDIT_K_SHIFT;
|
|
#through;
|
|
case STB_TEXTEDIT_K_PGDOWN;
|
|
#through;
|
|
case STB_TEXTEDIT_K_PGDOWN | STB_TEXTEDIT_K_SHIFT;
|
|
find : StbFindState;
|
|
row : StbTexteditRow;
|
|
i : s32;
|
|
j : s32;
|
|
sel : s32 = xx ((key & STB_TEXTEDIT_K_SHIFT) != 0);
|
|
is_page : s32 = xx ((key & ~STB_TEXTEDIT_K_SHIFT) == STB_TEXTEDIT_K_PGDOWN);
|
|
row_count : s32 = ifx is_page then state.row_count_per_page else 1;
|
|
|
|
if !is_page && state.single_line {
|
|
// on windows, up&down in single-line behave like left&right
|
|
key = STB_TEXTEDIT_K_RIGHT | (key & STB_TEXTEDIT_K_SHIFT);
|
|
continue retry;
|
|
}
|
|
|
|
if sel
|
|
stb_textedit_prep_selection_at_cursor(state);
|
|
else if STB_TEXT_HAS_SELECTION(state)
|
|
stb_textedit_move_to_last(str, state);
|
|
|
|
// compute current position of cursor point
|
|
stb_textedit_clamp(str, state);
|
|
stb_textedit_find_charpos(*find, str, state.cursor, state.single_line);
|
|
|
|
for j : 0..row_count - 1 {
|
|
x, goal_x : float = ifx state.has_preferred_x then state.preferred_x else find.x;
|
|
start : s32 = find.first_char + find.length;
|
|
|
|
if find.length == 0
|
|
break;
|
|
|
|
// now find character position down a row
|
|
state.cursor = start;
|
|
STB_TEXTEDIT_LAYOUTROW(*row, str, state.cursor);
|
|
x = row.x0;
|
|
for i : 0..row.num_chars - 1 {
|
|
dx : float = STB_TEXTEDIT_GETWIDTH(str, start, i);
|
|
#if #exists(STB_TEXTEDIT_GETWIDTH_NEWLINE) {
|
|
if dx == STB_TEXTEDIT_GETWIDTH_NEWLINE
|
|
break;
|
|
}
|
|
x += dx;
|
|
if x > goal_x
|
|
break;
|
|
state.cursor += 1;
|
|
}
|
|
stb_textedit_clamp(str, state);
|
|
|
|
state.has_preferred_x = 1;
|
|
state.preferred_x = goal_x;
|
|
|
|
if sel
|
|
state.select_end = state.cursor;
|
|
|
|
// go to next line
|
|
find.first_char = find.first_char + find.length;
|
|
find.length = row.num_chars;
|
|
}
|
|
|
|
case STB_TEXTEDIT_K_UP;
|
|
#through;
|
|
case STB_TEXTEDIT_K_UP | STB_TEXTEDIT_K_SHIFT;
|
|
#through;
|
|
case STB_TEXTEDIT_K_PGUP;
|
|
#through;
|
|
case STB_TEXTEDIT_K_PGUP | STB_TEXTEDIT_K_SHIFT;
|
|
find : StbFindState;
|
|
row : StbTexteditRow;
|
|
i : s32;
|
|
j : s32;
|
|
prev_scan : s32;
|
|
sel : s32 = xx ((key & STB_TEXTEDIT_K_SHIFT) != 0);
|
|
is_page : bool = (key & ~STB_TEXTEDIT_K_SHIFT) == STB_TEXTEDIT_K_PGUP;
|
|
row_count : s32 = ifx is_page then state.row_count_per_page else 1;
|
|
|
|
if !is_page && state.single_line {
|
|
// on windows, up&down become left&right
|
|
key = STB_TEXTEDIT_K_LEFT | (key & STB_TEXTEDIT_K_SHIFT);
|
|
continue retry;
|
|
}
|
|
|
|
if sel
|
|
stb_textedit_prep_selection_at_cursor(state);
|
|
else if STB_TEXT_HAS_SELECTION(state)
|
|
stb_textedit_move_to_first(state);
|
|
|
|
// compute current position of cursor point
|
|
stb_textedit_clamp(str, state);
|
|
stb_textedit_find_charpos(*find, str, state.cursor, state.single_line);
|
|
|
|
for j : 0..row_count - 1 {
|
|
x, goal_x : float = ifx state.has_preferred_x then state.preferred_x else find.x;
|
|
|
|
// can only go up if there's a previous row
|
|
if find.prev_first == find.first_char
|
|
break;
|
|
|
|
// now find character position up a row
|
|
state.cursor = find.prev_first;
|
|
STB_TEXTEDIT_LAYOUTROW(*row, str, state.cursor);
|
|
x = row.x0;
|
|
for i : 0..row.num_chars - 1 {
|
|
dx : float = STB_TEXTEDIT_GETWIDTH(str, find.prev_first, i);
|
|
#if #exists(STB_TEXTEDIT_GETWIDTH_NEWLINE) {
|
|
if dx == STB_TEXTEDIT_GETWIDTH_NEWLINE
|
|
break;
|
|
}
|
|
x += dx;
|
|
if x > goal_x
|
|
break;
|
|
state.cursor += 1;
|
|
}
|
|
stb_textedit_clamp(str, state);
|
|
|
|
state.has_preferred_x = 1;
|
|
state.preferred_x = goal_x;
|
|
|
|
if sel
|
|
state.select_end = state.cursor;
|
|
|
|
// go to previous line
|
|
// (we need to scan previous line the hard way. maybe we could expose this as a new API function?)
|
|
prev_scan = ifx find.prev_first > 0 then find.prev_first - 1 else 0;
|
|
while prev_scan > 0 && STB_TEXTEDIT_GETCHAR(str, prev_scan - 1) != STB_TEXTEDIT_NEWLINE
|
|
prev_scan -= 1;
|
|
find.first_char = find.prev_first;
|
|
find.prev_first = prev_scan;
|
|
}
|
|
|
|
case STB_TEXTEDIT_K_DELETE;
|
|
#through;
|
|
case STB_TEXTEDIT_K_DELETE | STB_TEXTEDIT_K_SHIFT;
|
|
if STB_TEXT_HAS_SELECTION(state)
|
|
stb_textedit_delete_selection(str, state);
|
|
else {
|
|
n : s32 = STB_TEXTEDIT_STRINGLEN(str);
|
|
if (state.cursor < n)
|
|
stb_textedit_delete(str, state, state.cursor, 1);
|
|
}
|
|
state.has_preferred_x = 0;
|
|
|
|
case STB_TEXTEDIT_K_BACKSPACE;
|
|
#through;
|
|
case STB_TEXTEDIT_K_BACKSPACE | STB_TEXTEDIT_K_SHIFT;
|
|
if STB_TEXT_HAS_SELECTION(state) {
|
|
stb_textedit_delete_selection(str, state);
|
|
} else {
|
|
stb_textedit_clamp(str, state);
|
|
if (state.cursor > 0) {
|
|
stb_textedit_delete(str, state, state.cursor-1, 1);
|
|
state.cursor -= 1;
|
|
}
|
|
}
|
|
state.has_preferred_x = 0;
|
|
|
|
// #if #exists(STB_TEXTEDIT_K_TEXTSTART2) {
|
|
// case STB_TEXTEDIT_K_TEXTSTART2;
|
|
// #through
|
|
// }
|
|
case STB_TEXTEDIT_K_TEXTSTART;
|
|
state.cursor = 0;
|
|
state.select_start = 0;
|
|
state.select_end = 0;
|
|
state.has_preferred_x = 0;
|
|
|
|
// #if #exists(STB_TEXTEDIT_K_TEXTEND2) {
|
|
// case STB_TEXTEDIT_K_TEXTEND2;
|
|
// #through
|
|
// }
|
|
case STB_TEXTEDIT_K_TEXTEND;
|
|
state.cursor = STB_TEXTEDIT_STRINGLEN(str);
|
|
state.select_start = 0;
|
|
state.select_end = 0;
|
|
state.has_preferred_x = 0;
|
|
|
|
// #if #exists(STB_TEXTEDIT_K_TEXTSTART2) {
|
|
// case STB_TEXTEDIT_K_TEXTSTART2 | STB_TEXTEDIT_K_SHIFT;
|
|
// #through
|
|
// }
|
|
case STB_TEXTEDIT_K_TEXTSTART | STB_TEXTEDIT_K_SHIFT;
|
|
stb_textedit_prep_selection_at_cursor(state);
|
|
state.cursor = 0;
|
|
state.select_end = 0;
|
|
state.has_preferred_x = 0;
|
|
|
|
// #if #exists(STB_TEXTEDIT_K_TEXTEND2) {
|
|
// case STB_TEXTEDIT_K_TEXTEND2 | STB_TEXTEDIT_K_SHIFT;
|
|
// #through
|
|
// }
|
|
case STB_TEXTEDIT_K_TEXTEND | STB_TEXTEDIT_K_SHIFT;
|
|
stb_textedit_prep_selection_at_cursor(state);
|
|
state.cursor = STB_TEXTEDIT_STRINGLEN(str);
|
|
state.select_end = STB_TEXTEDIT_STRINGLEN(str);
|
|
state.has_preferred_x = 0;
|
|
|
|
|
|
// #if #exists(STB_TEXTEDIT_K_LINESTART2) {
|
|
// case STB_TEXTEDIT_K_LINESTART2;
|
|
// #through
|
|
// }
|
|
case STB_TEXTEDIT_K_LINESTART;
|
|
stb_textedit_clamp(str, state);
|
|
stb_textedit_move_to_first(state);
|
|
if (state.single_line)
|
|
state.cursor = 0;
|
|
else while state.cursor > 0 && STB_TEXTEDIT_GETCHAR(str, state.cursor-1) != STB_TEXTEDIT_NEWLINE
|
|
state.cursor -= 1;
|
|
state.has_preferred_x = 0;
|
|
|
|
// #if #exists(STB_TEXTEDIT_K_LINEEND2) {
|
|
// case STB_TEXTEDIT_K_LINEEND2;
|
|
// #through
|
|
// }
|
|
case STB_TEXTEDIT_K_LINEEND;
|
|
n : s32 = STB_TEXTEDIT_STRINGLEN(str);
|
|
stb_textedit_clamp(str, state);
|
|
stb_textedit_move_to_first(state);
|
|
if (state.single_line)
|
|
state.cursor = n;
|
|
else while state.cursor < n && STB_TEXTEDIT_GETCHAR(str, state.cursor) != STB_TEXTEDIT_NEWLINE
|
|
state.cursor += 1;
|
|
state.has_preferred_x = 0;
|
|
|
|
// #if #exists(STB_TEXTEDIT_K_LINESTART2) {
|
|
// case STB_TEXTEDIT_K_LINESTART2 | STB_TEXTEDIT_K_SHIFT;
|
|
// #through
|
|
// }
|
|
case STB_TEXTEDIT_K_LINESTART | STB_TEXTEDIT_K_SHIFT;
|
|
stb_textedit_clamp(str, state);
|
|
stb_textedit_prep_selection_at_cursor(state);
|
|
if state.single_line
|
|
state.cursor = 0;
|
|
else while state.cursor > 0 && STB_TEXTEDIT_GETCHAR(str, state.cursor-1) != STB_TEXTEDIT_NEWLINE
|
|
state.cursor -= 1;
|
|
state.select_end = state.cursor;
|
|
state.has_preferred_x = 0;
|
|
|
|
// #if #exists(STB_TEXTEDIT_K_LINEEND2) {
|
|
// case STB_TEXTEDIT_K_LINEEND2 | STB_TEXTEDIT_K_SHIFT;
|
|
// #through
|
|
// }
|
|
case STB_TEXTEDIT_K_LINEEND | STB_TEXTEDIT_K_SHIFT;
|
|
n : s32 = STB_TEXTEDIT_STRINGLEN(str);
|
|
stb_textedit_clamp(str, state);
|
|
stb_textedit_prep_selection_at_cursor(state);
|
|
if state.single_line
|
|
state.cursor = n;
|
|
else while state.cursor < n && STB_TEXTEDIT_GETCHAR(str, state.cursor) != STB_TEXTEDIT_NEWLINE
|
|
state.cursor += 1;
|
|
state.select_end = state.cursor;
|
|
state.has_preferred_x = 0;
|
|
}
|
|
break retry;
|
|
}
|
|
}
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Undo processing
|
|
//
|
|
// @OPTIMIZE: the undo/redo buffer should be circular
|
|
|
|
stb_textedit_flush_redo :: (state: *StbUndoState) {
|
|
state.redo_point = STB_TEXTEDIT_UNDOSTATECOUNT;
|
|
state.redo_char_point = STB_TEXTEDIT_UNDOCHARCOUNT;
|
|
}
|
|
|
|
// discard the oldest entry in the undo list
|
|
stb_textedit_discard_undo :: (state: *StbUndoState) {
|
|
if (state.undo_point > 0) {
|
|
// if the 0th undo state has characters, clean those up
|
|
if (state.undo_rec[0].char_storage >= 0) {
|
|
n : s32 = state.undo_rec[0].insert_length;
|
|
// delete n characters from all other records
|
|
state.undo_char_point -= n;
|
|
STB_TEXTEDIT_memmove(state.undo_char.data, xx (cast(u64, state.undo_char.data) + xx n), cast(s64, (state.undo_char_point * size_of(STB_TEXTEDIT_CHARTYPE))));
|
|
for i : 0..state.undo_point - 1 {
|
|
if (state.undo_rec[i].char_storage >= 0)
|
|
state.undo_rec[i].char_storage -= n; // @OPTIMIZE: get rid of char_storage and infer it
|
|
}
|
|
}
|
|
state.undo_point -= 1;
|
|
STB_TEXTEDIT_memmove(state.undo_rec.data, state.undo_rec.data + 1, cast(s64, (state.undo_point * size_of(type_of(state.undo_rec[0])))));
|
|
}
|
|
}
|
|
|
|
// discard the oldest entry in the redo list--it's bad if this
|
|
// ever happens, but because undo & redo have to store the actual
|
|
// characters in different cases, the redo character buffer can
|
|
// fill up even though the undo buffer didn't
|
|
stb_textedit_discard_redo :: (state: *StbUndoState) {
|
|
k : s32 = STB_TEXTEDIT_UNDOSTATECOUNT - 1;
|
|
|
|
if state.redo_point <= k {
|
|
// if the k'th undo state has characters, clean those up
|
|
if (state.undo_rec[k].char_storage >= 0) {
|
|
n : s32 = state.undo_rec[k].insert_length;
|
|
// move the remaining redo character data to the end of the buffer
|
|
state.redo_char_point += n;
|
|
STB_TEXTEDIT_memmove(xx (cast(u64, state.undo_char.data) + xx state.redo_char_point), xx (cast(u64, state.undo_char.data) + xx (state.redo_char_point - n)), cast(s64, ((STB_TEXTEDIT_UNDOCHARCOUNT - state.redo_char_point) * size_of(STB_TEXTEDIT_CHARTYPE))));
|
|
// adjust the position of all the other records to account for above memmove
|
|
for i : state.redo_point..k - 1
|
|
if (state.undo_rec[i].char_storage >= 0)
|
|
state.undo_rec[i].char_storage += n;
|
|
}
|
|
// now move all the redo records towards the end of the buffer; the first one is at 'redo_point'
|
|
STB_TEXTEDIT_memmove(state.undo_rec.data + cast(u64, state.redo_point + 1), state.undo_rec.data + cast(u64, state.redo_point), cast(s64, ((STB_TEXTEDIT_UNDOSTATECOUNT - state.redo_point) * size_of(type_of(state.undo_rec[0])))));
|
|
// now move redo_point to point to the new one
|
|
state.redo_point += 1;
|
|
}
|
|
}
|
|
|
|
stb_text_create_undo_record :: (state: *StbUndoState, numchars: s32) -> *StbUndoRecord {
|
|
// any time we create a new undo record, we discard redo
|
|
stb_textedit_flush_redo(state);
|
|
|
|
// if we have no free records, we have to make room, by sliding the
|
|
// existing records down
|
|
if state.undo_point == STB_TEXTEDIT_UNDOSTATECOUNT
|
|
stb_textedit_discard_undo(state);
|
|
|
|
// if the characters to store won't possibly fit in the buffer, we can't undo
|
|
if numchars > STB_TEXTEDIT_UNDOCHARCOUNT {
|
|
state.undo_point = 0;
|
|
state.undo_char_point = 0;
|
|
return null;
|
|
}
|
|
|
|
// if we don't have enough free characters in the buffer, we have to make room
|
|
while state.undo_char_point + numchars > STB_TEXTEDIT_UNDOCHARCOUNT
|
|
stb_textedit_discard_undo(state);
|
|
|
|
state.undo_point += 1;
|
|
|
|
return *state.undo_rec[state.undo_point - 1];
|
|
}
|
|
|
|
stb_text_createundo :: (state: *StbUndoState, pos: s32, insert_len: s32, delete_len: s32) -> *STB_TEXTEDIT_CHARTYPE {
|
|
r : *StbUndoRecord = stb_text_create_undo_record(state, insert_len);
|
|
if r == null
|
|
return null;
|
|
|
|
r.where = pos;
|
|
r.insert_length = cast(STB_TEXTEDIT_POSITIONTYPE, insert_len);
|
|
r.delete_length = cast(STB_TEXTEDIT_POSITIONTYPE, delete_len);
|
|
|
|
if insert_len == 0 {
|
|
r.char_storage = -1;
|
|
return null;
|
|
} else {
|
|
r.char_storage = state.undo_char_point;
|
|
state.undo_char_point += insert_len;
|
|
return *state.undo_char[r.char_storage];
|
|
}
|
|
}
|
|
|
|
stb_text_undo :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState) {
|
|
s : *StbUndoState = *state.undostate;
|
|
u : StbUndoRecord;
|
|
r : *StbUndoRecord;
|
|
if s.undo_point == 0
|
|
return;
|
|
|
|
// we need to do two things: apply the undo record, and create a redo record
|
|
u = s.undo_rec[s.undo_point-1];
|
|
r = *s.undo_rec[s.redo_point-1];
|
|
r.char_storage = -1;
|
|
|
|
r.insert_length = u.delete_length;
|
|
r.delete_length = u.insert_length;
|
|
r.where = u.where;
|
|
|
|
if u.delete_length {
|
|
// if the undo record says to delete characters, then the redo record will
|
|
// need to re-insert the characters that get deleted, so we need to store
|
|
// them.
|
|
|
|
// there are three cases:
|
|
// there's enough room to store the characters
|
|
// characters stored for *redoing* don't leave room for redo
|
|
// characters stored for *undoing* don't leave room for redo
|
|
// if the last is true, we have to bail
|
|
|
|
if s.undo_char_point + u.delete_length >= STB_TEXTEDIT_UNDOCHARCOUNT {
|
|
// the undo records take up too much character space; there's no space to store the redo characters
|
|
r.insert_length = 0;
|
|
} else {
|
|
i : s32;
|
|
|
|
// there's definitely room to store the characters eventually
|
|
while (s.undo_char_point + u.delete_length > s.redo_char_point) {
|
|
// should never happen:
|
|
if s.redo_point == STB_TEXTEDIT_UNDOSTATECOUNT
|
|
return;
|
|
// there's currently not enough room, so discard a redo record
|
|
stb_textedit_discard_redo(s);
|
|
}
|
|
r = *s.undo_rec[s.redo_point - 1];
|
|
|
|
r.char_storage = s.redo_char_point - u.delete_length;
|
|
s.redo_char_point = s.redo_char_point - u.delete_length;
|
|
|
|
// now save the characters
|
|
for i : 0..u.delete_length - 1
|
|
s.undo_char[r.char_storage + i] = STB_TEXTEDIT_GETCHAR(str, u.where + i);
|
|
}
|
|
|
|
// now we can carry out the deletion
|
|
STB_TEXTEDIT_DELETECHARS(str, u.where, u.delete_length);
|
|
}
|
|
|
|
// check type of recorded action:
|
|
if u.insert_length {
|
|
// easy case: was a deletion, so we need to insert n characters
|
|
STB_TEXTEDIT_INSERTCHARS(str, u.where, *s.undo_char[u.char_storage], u.insert_length);
|
|
s.undo_char_point -= u.insert_length;
|
|
}
|
|
|
|
state.cursor = u.where + u.insert_length;
|
|
|
|
s.undo_point -= 1;
|
|
s.redo_point -= 1;
|
|
}
|
|
|
|
stb_text_redo :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState) {
|
|
s : *StbUndoState = *state.undostate;
|
|
u : *StbUndoRecord;
|
|
r : StbUndoRecord;
|
|
if s.redo_point == STB_TEXTEDIT_UNDOSTATECOUNT
|
|
return;
|
|
|
|
// we need to do two things: apply the redo record, and create an undo record
|
|
u = *s.undo_rec[s.undo_point];
|
|
r = s.undo_rec[s.redo_point];
|
|
|
|
// we KNOW there must be room for the undo record, because the redo record
|
|
// was derived from an undo record
|
|
|
|
u.delete_length = r.insert_length;
|
|
u.insert_length = r.delete_length;
|
|
u.where = r.where;
|
|
u.char_storage = -1;
|
|
|
|
if r.delete_length {
|
|
// the redo record requires us to delete characters, so the undo record
|
|
// needs to store the characters
|
|
|
|
if (s.undo_char_point + u.insert_length > s.redo_char_point) {
|
|
u.insert_length = 0;
|
|
u.delete_length = 0;
|
|
} else {
|
|
u.char_storage = s.undo_char_point;
|
|
s.undo_char_point = s.undo_char_point + u.insert_length;
|
|
|
|
// now save the characters
|
|
for i : 0..u.insert_length - 1
|
|
s.undo_char[u.char_storage + i] = STB_TEXTEDIT_GETCHAR(str, u.where + i);
|
|
}
|
|
|
|
STB_TEXTEDIT_DELETECHARS(str, r.where, r.delete_length);
|
|
}
|
|
|
|
if r.insert_length {
|
|
// easy case: need to insert n characters
|
|
STB_TEXTEDIT_INSERTCHARS(str, r.where, *s.undo_char[r.char_storage], r.insert_length);
|
|
s.redo_char_point += r.insert_length;
|
|
}
|
|
|
|
state.cursor = r.where + r.insert_length;
|
|
|
|
s.undo_point += 1;
|
|
s.redo_point += 1;
|
|
}
|
|
|
|
stb_text_makeundo_insert :: (state: *STB_TexteditState, where: s32, length: s32) {
|
|
stb_text_createundo(*state.undostate, where, 0, length);
|
|
}
|
|
|
|
stb_text_makeundo_delete :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState, where: s32, length: s32) {
|
|
p: *STB_TEXTEDIT_CHARTYPE = stb_text_createundo(*state.undostate, where, length, 0);
|
|
if p {
|
|
for i : 0..length - 1
|
|
p[i] = STB_TEXTEDIT_GETCHAR(str, where + i);
|
|
}
|
|
}
|
|
|
|
stb_text_makeundo_replace :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState, where: s32, old_length: s32, new_length: s32) {
|
|
p : *STB_TEXTEDIT_CHARTYPE = stb_text_createundo(*state.undostate, where, old_length, new_length);
|
|
if p {
|
|
for i : 0..old_length - 1 {
|
|
p[i] = STB_TEXTEDIT_GETCHAR(str, where + i);
|
|
}
|
|
}
|
|
}
|
|
|
|
// reset the state to default
|
|
stb_textedit_clear_state :: (state: *STB_TexteditState, is_single_line: s32) {
|
|
state.undostate.undo_point = 0;
|
|
state.undostate.undo_char_point = 0;
|
|
state.undostate.redo_point = STB_TEXTEDIT_UNDOSTATECOUNT;
|
|
state.undostate.redo_char_point = STB_TEXTEDIT_UNDOCHARCOUNT;
|
|
state.select_end = 0;
|
|
state.select_start = 0;
|
|
state.cursor = 0;
|
|
state.has_preferred_x = 0;
|
|
state.preferred_x = 0;
|
|
state.cursor_at_end_of_line = 0;
|
|
state.initialized = 1;
|
|
state.single_line = cast(u8, is_single_line);
|
|
state.insert_mode = 0;
|
|
state.row_count_per_page = 0;
|
|
}
|
|
|
|
// API initialize
|
|
stb_textedit_initialize_state :: (state: *STB_TexteditState, is_single_line: s32) {
|
|
stb_textedit_clear_state(state, is_single_line);
|
|
}
|
|
|
|
stb_textedit_paste :: (str: *STB_TEXTEDIT_STRING, state: *STB_TexteditState, ctext: *STB_TEXTEDIT_CHARTYPE, len: s32) -> s32 {
|
|
return stb_textedit_paste_internal(str, state, cast(*STB_TEXTEDIT_CHARTYPE, ctext), len);
|
|
}
|
|
|
|
/*
|
|
------------------------------------------------------------------------------
|
|
This software is available under 2 licenses -- choose whichever you prefer.
|
|
------------------------------------------------------------------------------
|
|
ALTERNATIVE A - MIT License
|
|
Copyright (c) 2017 Sean Barrett
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
this software and associated documentation files (the "Software"), to deal in
|
|
the Software without restriction, including without limitation the rights to
|
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
of the Software, and to permit persons to whom the Software is furnished to do
|
|
so, subject to the following conditions:
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|
|
------------------------------------------------------------------------------
|
|
ALTERNATIVE B - Public Domain (www.unlicense.org)
|
|
This is free and unencumbered software released into the public domain.
|
|
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this
|
|
software, either in source code form or as a compiled binary, for any purpose,
|
|
commercial or non-commercial, and by any means.
|
|
In jurisdictions that recognize copyright laws, the author or authors of this
|
|
software dedicate any and all copyright interest in the software to the public
|
|
domain. We make this dedication for the benefit of the public at large and to
|
|
the detriment of our heirs and successors. We intend this dedication to be an
|
|
overt act of relinquishment in perpetuity of all present and future rights to
|
|
this software under copyright law.
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
------------------------------------------------------------------------------
|
|
*/
|