Remove bbcode_text from RichTextLabel

[HaSa1002]

This simplyfies the text setting and resolves some bugs as the internal data structure is the same.

It's a draft, since the points below must be discussed first (at least 1 to 3)

Things to discuss:

1. Make add_text, set_text, get_text private (hide them in their current form)?
2. Rename set_bbcode, get_bbcode and append_bbcode to set_text, get_text and add/append_text?
3. Rename bbcode_enabled?
4. How to parse old scene files (since we should put the bbcode_text into the text, when bbcode_enabled is true)?

fixes #36711
fixes #35553 and therefore supersedes #36037 if merged
fixes partly #18413

#35368 seems related acording to the title, but issue itself is unclear

We could alternativly make the RichTextLabel a base class for multiple parsers and reimplement a BBCodeLabel or go in the direction of godotengine/godot-proposals#826

[KoBeWi]

Current get_text() is actually useful, because it returns the actual text, without bbcodes. This possibility should be preserved somehow.

[HaSa1002]

I thought about having get_parsed_text, or rename the the bbcode text to something like get_raw_text

[HaSa1002]

Merged set_text
Renamed

• append_bbcode -> append_text
• get_bbcode -> get_raw_text
• set_bbcode -> set_text

text property is now set_text and get_raw_text. Maybe a change to get_text and rename of get_text to get_parsed_text is desired for consistency.

[HaSa1002]

rebased and tested.
I don't like having made the text property to set_textand get_raw_text, but I don't know how to phrase get_text_but_without_bbcode. Any ideas?

[KoBeWi]

The _validate_property() can be removed.

As for the naming, getter for text should be called get_text(). I feel like the get_text() and get_raw_text() would be fine swapped 🤔 Other names for no-BBCode could be get_clean_text(), get_final_text(), get_unformatted_text() or get_parsed_text().

Also the internal variable bbcode could be renamed to text, because it introduces some confusion.

[HaSa1002]

The _validate_property() can be removed.

done.

As for the naming, getter for text should be called get_text(). I feel like the get_text() and get_raw_text() would be fine swapped 🤔 Other names for no-BBCode could be get_clean_text(), get_final_text(), get_unformatted_text() or get_parsed_text().

I renamed get_raw_text() to get_parsed_text(). However, get_text() returns the raw text, if bbcode_enabled is true and the parsed text if not. Is that desired? It looks like a hack for the text <--> bbcode_text ambigity. I deleted that.

Also the internal variable bbcode could be renamed to text, because it introduces some confusion.

done.

[KoBeWi]

Looks alright now.

[reduz]

Is this the final resolution about this that everyone agrees to? I remember too many discussions on this topic at this point.

[reduz]

Ok I got confirmation that this is the case, so feel free to rebase and merge.

[HaSa1002]

will do

[HaSa1002]

Rebased. One thing to remember: This will erase all text from RTLs as they are not saved in the text property. Can we add a property upgrade hint somehow?

[akien-mga]

Rebased. One thing to remember: This will erase all text from RTLs as they are not saved in the text property. Can we add a property upgrade hint somehow?

Yes, see e.g. this:

godot/scene/resources/environment.cpp

Lines 1032 to 1049 in 104a619

	#ifndef DISABLE_DEPRECATED
	// Kept for compatibility from 3.x to 4.0.
	bool Environment::_set(const StringName &p_name, const Variant &p_value) {
	if (p_name == "background_sky") {
	set_sky(p_value);
	return true;
	} else if (p_name == "background_sky_custom_fov") {
	set_sky_custom_fov(p_value);
	return true;
	} else if (p_name == "background_sky_orientation") {
	Vector3 euler = p_value.operator Basis().get_euler();
	set_sky_rotation(euler);
	return true;
	} else {
	return false;
	}
	}
	#endif

[HaSa1002]

Rebased. One thing to remember: This will erase all text from RTLs as they are not saved in the text property. Can we add a property upgrade hint somehow?

Yes, see e.g. this:

godot/scene/resources/environment.cpp

Lines 1032 to 1049 in 104a619

	#ifndef DISABLE_DEPRECATED
	// Kept for compatibility from 3.x to 4.0.
	bool Environment::_set(const StringName &p_name, const Variant &p_value) {
	if (p_name == "background_sky") {
	set_sky(p_value);
	return true;
	} else if (p_name == "background_sky_custom_fov") {
	set_sky_custom_fov(p_value);
	return true;
	} else if (p_name == "background_sky_orientation") {
	Vector3 euler = p_value.operator Basis().get_euler();
	set_sky_rotation(euler);
	return true;
	} else {
	return false;
	}
	}
	#endif

Thank you. Done and rebased

[akien-mga]

Thanks!