ControlTextbox multiline overhaul, use in script editor
#3036
Conversation
1. `DrawingRequest` no longer preserves a variable indicating its type, but rather utilizes a `virtual` function for this purpose. 2. `DrawingRequest` now initializes some of its variables from the current `DrawingTransform`. 2. The viewport rectangle is now stored in `DrawingTransform`, instead of `DrawingContext`. bb18239 has added per-request viewport cropping. Utilizing it now is more convenient, because the old viewport wouldn't have to be stored in a separate variable in a draw function, so it could be restored later. A new transform could be pushed and popped instead.
Includes some scripting reference generation improvements as well.
Credits to RustyBox for the new text cursor!
Vankata453
added
involves:editor
status:in-progress
|
I'll probably do some style fixes soon. |
|
For reasons, Im interested in reviewing this when I get a chance :) |
| ItemScriptField::get_height() const | ||
| { | ||
| return static_cast<int>(m_control->get_rect().get_height()); | ||
| } |
There was a problem hiding this comment.
Shall these (get_width/get_height) go to the header?
| bool locks_navigation() const override { return true; } | ||
| bool locked() const override { return m_control->suggestions_active(); } | ||
| bool select_blink() const override { return false; } | ||
| bool overrides_cursor_state() const override { return true; } |
There was a problem hiding this comment.
Huh?
I suppose this is a practice around here; why aren't we using member variables for this? Smells Java-esque.
| virtual bool locks_navigation() const { return false; } | ||
|
|
||
| /** Returns true when the menu's focus is locked to this item. */ | ||
| virtual bool locked() const { return false; } |
There was a problem hiding this comment.
Again, I don't know what to think about this. Follow up to me if you can
| m_function_parameters(), | ||
| m_hovered_parameter(nullptr) | ||
| { | ||
| m_suggestions_scrollbar.reset(new ControlScrollbar(1.f, SUGGESTION_RECT_HEIGHT, m_suggestions_offset, 35.f)); |
| { | ||
| ControlTextbox::draw(context); | ||
|
|
||
| /** Line numbers */ |
There was a problem hiding this comment.
Not a very helpful comment, also /** is javadoc starter i think. I don't typically see this.
Could also go into a private function anyway. Maybe this logic could be refactored a bit if you want to do that?
|
|
||
| return false; | ||
| } | ||
|
|
||
| bool | ||
| ControlTextbox::parse_value(bool call_on_change /* = true (see header)*/) | ||
| ControlTextbox::parse_value(bool call_on_change /* = true (see header)*/, TextAction action /* = TextAction::NONE (see header)*/) |
There was a problem hiding this comment.
Just don't (see header) the reader like this at all. They'll see the header if they need to, as it's obvious.
| if (m_string) | ||
| *m_string = new_str; | ||
| if (m_string) | ||
| *m_string = new_str; |
There was a problem hiding this comment.
what if instead of a pointer we just set some int variables or something, then returned a string view of some sort? Food for thought of the soul. It is certainly how most editors handle such logic, if I'm getting this down correctly
| int line = 0; | ||
| for (char c : str) | ||
| { | ||
| if (c == '\n') | ||
| { | ||
| if (!m_multiline) | ||
| continue; | ||
|
|
||
| m_charlist.push_back({}); | ||
| line++; | ||
| continue; | ||
| } | ||
| m_charlist[line].push_back(c); | ||
| } |
There was a problem hiding this comment.
Standard for statement can't possibly hurt in this case. Not a big deal though.
| @@ -361,102 +574,125 @@ ControlTextbox::get_string() const | |||
| } | |||
|
|
|||
| std::string | |||
| ControlTextbox::get_contents() const | |||
| ControlTextbox::get_contents(int line) const | |||
There was a problem hiding this comment.
This does handle negative logic too? I think it can be made clear with a comment.
| ControlTextbox::get_first_chars(int amount) const | ||
| ControlTextbox::get_first_chars(int line, int amount) const | ||
| { | ||
| std::string temp; | ||
| std::string out; | ||
|
|
||
| for (char c : m_charlist) { | ||
| for (char c : m_charlist[line]) | ||
| { | ||
| if (!(amount--)) break; | ||
| temp += c; | ||
| out += c; | ||
| } | ||
|
|
||
| return temp; | ||
| return out; | ||
| } |
There was a problem hiding this comment.
Could this logic be improved somehow, anyway?
This PR overhauls
ControlTextboxso it supports multiple lines.A new derived from
ControlTextboxclass has been added -ControlScriptbox. It features suggestions when typing (just like the console does when "Tab" is pressed). Additional information and parameters for the suggested functions are also displayed. That information is fetched from the "data/scripts/reference.stsr" file, which is of type "supertux-scripting-reference". Other such files can also be imported using theregister_scripting_reference()andunregister_scripting_reference()scripting functions.Short video showcase from 2023 development summary video
NOTE: This is a WIP, since it needs to be suited to all additions and changes since the implementation of the simplesquirrel library. It also needs to further be tested for bugs.