ParameterInput: Add a separate option data property

Instead of inferring that there is a list of options based on the
current value, ParameterInput expects to be given a list of options,
and get_raw_input and set_raw_input understand that the raw input is a
value from the list.

In addition, change TemplateEditor itself to determine the list of
options for a given parameter. This option data is always from the
parameter_defaults property, regardless of the block's current value.

https://phabricator.endlessm.com/T35564

Author: dylanmccall

addons/block_code/ui/blocks/utilities/parameter_input/parameter_input.gd

@@ -1,6 +1,7 @@
 @tool
 extends MarginContainer
 
+const OptionData = preload("res://addons/block_code/code_generation/option_data.gd")
 const Types = preload("res://addons/block_code/types/types.gd")
 
 signal modified
@@ -10,8 +11,9 @@ signal modified
 
 @export var variant_type: Variant.Type = TYPE_STRING
 @export var block_type: Types.BlockType = Types.BlockType.VALUE
-var option: bool = false:
-	set = _set_option
+@export var option_data: OptionData:
+	set = _set_option_data
+
 var default_value: Variant
 
 @onready var _panel := %Panel
@@ -51,6 +53,13 @@ func set_raw_input(raw_input: Variant):
 		# Continue from here to reset the editor to default values
 		raw_input = null
 
+	if option_data:
+		_update_option_input(raw_input)
+		return
+
+	if raw_input == null:
+		raw_input = default_value
+
 	match variant_type:
 		TYPE_COLOR:
 			_color_input.color = raw_input
@@ -60,7 +69,7 @@ func set_raw_input(raw_input: Variant):
 			_x_line_edit.text = ("%.4f" % raw_input.x).rstrip("0").rstrip(".") if raw_input != null else ""
 			_y_line_edit.text = ("%.4f" % raw_input.y).rstrip("0").rstrip(".") if raw_input != null else ""
 		TYPE_BOOL:
-			_bool_input_option.select(raw_input)
+			_bool_input_option.select(1 if raw_input else 0)
 		TYPE_NIL:
 			_line_edit.text = raw_input if raw_input != null else ""
 		_:
@@ -76,6 +85,9 @@ func get_raw_input() -> Variant:
 	if snapped_block:
 		return snapped_block
 
+	if option_data:
+		return _option_input.get_selected_metadata()
+
 	match variant_type:
 		TYPE_COLOR:
 			return _color_input.color
@@ -95,31 +107,35 @@ func get_raw_input() -> Variant:
 			return _line_edit.text
 
 
-func _set_placeholder(new_placeholder: String) -> void:
-	placeholder = new_placeholder
+func _set_option_data(new_option_data: OptionData) -> void:
+	option_data = new_option_data
 
 	if not is_node_ready():
 		return
 
-	_line_edit.placeholder_text = placeholder
+	# If options are being provided, you can't snap blocks.
+	snap_point.visible = not option_data
 
+	_update_option_input()
 
-func _set_option(value: bool) -> void:
-	option = value
+
+func _set_placeholder(new_placeholder: String) -> void:
+	placeholder = new_placeholder
 
 	if not is_node_ready():
 		return
 
-	# If options are being provided, you can't snap blocks.
-	snap_point.visible = not option
+	_line_edit.placeholder_text = placeholder
+	_input_switcher.tooltip_text = placeholder
+	_option_input.tooltip_text = placeholder
 
 
 func _ready():
 	var stylebox = _panel.get_theme_stylebox("panel")
 	stylebox.bg_color = Color.WHITE
 
 	_set_placeholder(placeholder)
-	_set_option(option)
+	_set_option_data(option_data)
 
 	snap_point.block_type = block_type
 	snap_point.variant_type = variant_type
@@ -178,7 +194,7 @@ func _on_y_line_edit_focus_exited():
 func _update_visible_input():
 	if snap_point.has_snapped_block():
 		_switch_input(null)
-	elif option:
+	elif option_data:
 		_switch_input(_option_input)
 	else:
 		match variant_type:
@@ -195,6 +211,44 @@ func _update_visible_input():
 func _switch_input(node: Node):
 	for c in _input_switcher.get_children():
 		c.visible = c == node
+	_panel.visible = node not in [_option_input]
+
+
+func _update_option_input(current_value: Variant = null):
+	if not option_data:
+		return
+
+	if current_value is OptionData:
+		# Temporary hack: previously, the value was stored as an OptionValue
+		# object with a list of items and a "selected" property. Instead,
+		# convert that value to the corresponding item.
+		current_value = current_value.items[current_value.selected]
+
+	if current_value == null:
+		current_value = _option_input.get_selected_metadata()
+
+	_option_input.clear()
+
+	var selected_item_index: int = -1
+
+	for item in option_data.items:
+		var item_index = _option_input.item_count
+		var option_label = item.capitalize() if item is String else str(item)
+		_option_input.add_item(option_label)
+		_option_input.set_item_tooltip(item_index, item)
+		_option_input.set_item_metadata(item_index, item)
+		if item == current_value:
+			selected_item_index = item_index
+
+	if _option_input.item_count == 0:
+		var item_index = _option_input.item_count
+		_option_input.add_item("<%s>" % placeholder)
+		_option_input.set_item_disabled(item_index, true)
+		selected_item_index = item_index
+	elif selected_item_index == -1:
+		selected_item_index = option_data.selected
+
+	_option_input.select(selected_item_index)
 
 
 func _on_color_input_color_changed(color):

addons/block_code/ui/blocks/utilities/parameter_input/parameter_input.tscn

@@ -42,6 +42,7 @@ theme_override_styles/panel = SubResource("StyleBoxFlat_tn6h4")
 [node name="InputSwitcher" type="MarginContainer" parent="."]
 unique_name_in_owner = true
 layout_mode = 2
+tooltip_text = "Parameter"
 mouse_filter = 2
 theme_override_constants/margin_left = 0
 theme_override_constants/margin_top = 0
@@ -84,6 +85,7 @@ unique_name_in_owner = true
 visible = false
 custom_minimum_size = Vector2(40, 0)
 layout_mode = 2
+tooltip_text = "Parameter"
 theme_override_styles/normal = SubResource("StyleBoxEmpty_fjquj")
 
 [node name="Vector2Input" type="MarginContainer" parent="InputSwitcher"]

addons/block_code/ui/blocks/utilities/template_editor/template_editor.gd

@@ -112,8 +112,16 @@ func _append_input_parameter(parameter: Dictionary, id: int):
 	parameter_input.name = "ParameterInput%d" % id
 	parameter_input.placeholder = parameter["name"]
 	parameter_input.variant_type = parameter["type"]
-	parameter_input.option = parameter["is_option"]
-	parameter_input.default_value = default_value
+
+	if parameter["is_option"] and default_value is OptionData:
+		var option_data := default_value as OptionData
+		parameter_input.option_data = option_data
+		if option_data.selected < option_data.items.size():
+			parameter_input.default_value = option_data.items[option_data.selected]
+	elif parameter["is_option"]:
+		push_warning("The block parameter %s in %s appears to be an option, but no option data is provided" % [parameter_format, parent_block])
+	else:
+		parameter_input.default_value = default_value
 
 	parameter_input.modified.connect(modified.emit)