Merge pull request #47 from XanatosX/feature/45_add-support-for-optional-parameters

feat: add optional arguments

Author: XanatosX

addons/gameconsole/builtin/command_argument_count_not_matching.gd

@@ -13,5 +13,5 @@ func _argument_count_not_matching(command_name: String) -> String:
     var return_data = "";
     var command = Console._console_commands[command_name]
     var command_arguments = command.get_arguments()
-    return_data += "[color=red]The arguments provided do not match the arguments %s of command[/color]" % [command_arguments]
+    return_data += "[color=red]The required arguments provided do not match the number of required arguments %s of command[/color]" % [command_arguments]
     return return_data

addons/gameconsole/builtin/command_to_many_arguments.gd

@@ -0,0 +1,15 @@
+extends CommandTemplate
+
+func create_command() -> Command:
+    var command = Command.new("to_many_arguments",
+							  _to_many_arguments,
+							  [CommandArgument.new(CommandArgument.Type.STRING, "Command Name"),
+							   CommandArgument.new(CommandArgument.Type.INT, "Number of given arguments"),
+							   CommandArgument.new(CommandArgument.Type.INT, "Number of requested arguments")],
+							  "The provided arguments do not match"
+							  )
+    command.is_hidden = true
+    return command
+
+func _to_many_arguments(command_name: String, given_argument_count: int, required_argument_count: int) -> String:
+    return "[color=red]The command %s does require %s arguments, but %s where given![/color]" % [command_name, required_argument_count, given_argument_count]

addons/gameconsole/console/command/command.gd

@@ -14,6 +14,8 @@ var self_man_link: Interaction
 var self_enter_link: Interaction
 var self_example_links := {}
 
+var _is_valid: bool = true
+
 func _init(command_name: String,
 		   functionality: Callable,
 		   in_arguments : Array[CommandArgument] = [],
@@ -33,43 +35,83 @@ func _init(command_name: String,
 	self_man_link.from_raw("man", command)
 	self_enter_link.from_raw("enter", command)
 
+	_validate_self()
+
 	for example in examples:
 		var example_link = Interaction.new()
 		example_link.from_raw("enter", example)
 		self_example_links[example] = example_link
 
+func _validate_self():
+	var optional_mode: bool = false
+	for argument in arguments:
+		if optional_mode and not argument.is_optional():
+			_is_valid = false
+			return
+		if argument.is_optional():
+			optional_mode = true
+
+func is_valid_command():
+	return _is_valid
+
 func get_command_name() -> String :
 	return command
 
 func execute(in_arguments: Array) -> String:
-	if in_arguments.size() != arguments.size():
+	if arguments.size() > 0 and in_arguments.size() < arguments.filter(func(argument): return not argument.is_optional()).size():
 		Console.search_and_execute_command("argument_not_matching %s" % command)
 		return ""
 
+	if arguments.size() > 0 and in_arguments.size() > arguments.size():
+		Console.search_and_execute_command("to_many_arguments %s %s %s" % [command, in_arguments.size(), arguments.size()])
+		Console.search_and_execute_command("man %s" % [command])
+		return ""
+	
+	if !_validate_arguments(in_arguments):
+		return ""
+
+
+	var converted_data: Array[Variant] = []
+	for i in arguments.size():
+		var raw_data: String = _get_data_at_position(in_arguments, arguments[i], i)
+		var data = arguments[i].convert_data(raw_data)
+		converted_data.append(data)
+
+	var data = function.callv(converted_data)
+	if data == null:
+		data = ""
+	return data
+
+func _get_data_at_position(in_arguments: Array, current_argument: CommandArgument, data_index: int) -> String:
+	var value: String = ""
+	if current_argument.is_optional():
+		value = current_argument.get_default_value()
+	if data_index < in_arguments.size():
+		value = in_arguments[data_index]
+	return value
+
+		
+
+func _validate_arguments(in_arguments: Array) -> bool:
 	var is_valid: bool = true
-	for i in in_arguments.size():
+	for i in arguments.size():
 		var current_argument_type = arguments[i]
-		if not current_argument_type.is_valid_for(in_arguments[i]):
+
+		var value: String = _get_data_at_position(in_arguments, current_argument_type, i)
+
+		if not current_argument_type.is_valid_for(value):
 			is_valid = false
 			var data = "%s %s %s %s %s" % ["argument_not_valid",
 										   command,
 										   current_argument_type.get_display_name().to_snake_case(),
 										   current_argument_type.Type.keys()[current_argument_type.get_type()],
-										   in_arguments[i]
+										   value
 										  ]
 			Console.search_and_execute_command(data)
-			return ""
+			return is_valid
 
-
-	var converted_data: Array[Variant] = []
-	for i in in_arguments.size():
-		var data = arguments[i].convert_data(in_arguments[i])
-		converted_data.append(data)
-
-	var data = function.callv(converted_data)
-	if data == null:
-		data = ""
-	return data
+	return is_valid
+		
 
 func get_interactive_command():
 	var url_part = "[url=%s]" % self_man_link.get_as_string()
@@ -101,10 +143,13 @@ func get_man_page() -> String:
 		return_text += "\n[i][b]Arguments[/b][/i]\n\n"
 		return_text += "[ul]"
 		for argument in arguments:
+			if argument.is_optional():
+				return_text += "[Optional] "
 			return_text += "%s" % argument.get_display_name()
 			var argument_description = argument.get_description()
 			if not argument_description.is_empty():
 				return_text += " -> %s" % argument_description
+			
 			return_text += "\n"
 
 		return_text += "[/ul]"

addons/gameconsole/console/command/command_argument.gd

@@ -13,11 +13,25 @@ var _argument_type: Type
 var _argument_name: String
 var _argument_description: String = ""
 
-func _init(type: Type, name: String, description: String):
+var _is_optional: bool = false
+var _default_value: String = ""
+
+## Create a new command argument, if you provide a default value this command will be optional
+func _init(type: Type, name: String, description: String = "", default_value: String = ""):
 	_argument_type = type
 	_argument_name = name
 	_argument_description = description
-	
+
+	make_optional(default_value)
+
+func make_optional(default_value: String) -> bool:
+	if default_value.is_empty() or not is_valid_for(default_value):
+		return false
+
+	_default_value = default_value
+	_is_optional = true
+	return true
+
 func get_type() -> Type:
 	return _argument_type
 
@@ -72,4 +86,10 @@ func convert_data(data: String) -> Variant:
 		Type.BOOL:
 			return int(data) == 1
 		_:
-			return null
+			return null
+
+func is_optional() -> bool:
+	return _is_optional
+
+func get_default_value() -> String:
+	return _default_value

addons/gameconsole/console/console.gd

@@ -156,28 +156,36 @@ func register_custom_strong_command(command: String,
 							 in_arguments: Array[CommandArgument],
 							 short_description: String = "",
 							 description: String = "",
-							 example: PackedStringArray = []):
+							 example: PackedStringArray = []) -> bool:
 	var real_command = Command.new(command, function, in_arguments, short_description, description, example)
-	register_command(real_command)
+
+	return register_command(real_command)
 
 ## Register a custom command without using the new parameter types
 func register_custom_command(command: String,
 							 function: Callable,
 							 in_arguments : PackedStringArray = [],
 							 short_description: String = "",
 							 description: String = "",
-							 example: PackedStringArray = []):
+							 example: PackedStringArray = []) -> bool:
 	var converted_arguments: Array[CommandArgument] = []
 	for argument in in_arguments:
 		converted_arguments.append(CommandArgument.new(CommandArgument.Type.UNKNOWN, argument, ""))
-	register_custom_strong_command(command, function, converted_arguments, short_description, description, example)
+	return register_custom_strong_command(command, function, converted_arguments, short_description, description, example)
 
 ## Register a new command you already created the object instance for
-func register_command(command: Command):
+func register_command(command: Command) -> bool:
+	if not command.is_valid_command():
+		var message = "Tried to register command %s which does use an invalid configuration!" % command.get_command_name()
+		print(message)
+		print_as_error(message)
+		return false
 	var name = command.get_command_name()
 	command.built_in = false
 	_console_commands[command.get_command_name()] = command
 
+	return true
+
 func remove_command(name: String) -> bool:
 	name = name.to_snake_case()
 	if !_console_commands.has(name):
@@ -189,6 +197,7 @@ func remove_command(name: String) -> bool:
 	return _console_commands.erase(name)
 
 func search_and_execute_command(command_text: String):
+	command_text = command_text.strip_edges()
 	var executer = CommandDefinition.new(command_text)
 	var command_to_run = _console_commands.get(executer.command)
 	if command_to_run == null:

addons/gameconsole/console/console/autocomplete_label.gd

@@ -43,7 +43,10 @@ func _display_autocomplete(data: StrippedCommand):
 		var color: Color = Console.console_settings.autocomplete_argument_color_odd
 		if argument_counter % 2 == 0:
 			color = Console.console_settings.autocomplete_argument_color_even
-		arguments += "[color=%s]%s[/color] " % [color.to_html(), argument.get_display_name()]
+		var optional = ""
+		if argument.is_optional():
+			optional = "[optional]"
+		arguments += "[color=%s]%s%s[/color] " % [color.to_html(), optional, argument.get_display_name()]
 		argument_counter += 1
 	arguments = arguments.trim_suffix(" ")
 

example/console_example.gd

@@ -36,21 +36,21 @@ func _register_commands():
 									"Increase the counter",
 									"Command will increase a local counter",
 									["count_up 1", "count_up 3"])
-
+	
 	var count_down_command = Command.new("count_down",
 										 _count_down,
-										[CommandArgument.new(CommandArgument.Type.INT, "amount", "The amount to count down from the current counter")],
+										[CommandArgument.new(CommandArgument.Type.INT, "amount", "The amount to count down from the current counter", "1")],
 										"Decrease the internal counter",
 										"Command will decrease a local counter",
-										["count_down 1", "count_down 5"])
+										["count_down", "count_down 2", "count_down 5"])
 
 	Console.register_command(count_down_command)
 	Console.register_custom_command("reload", _reload, [], "Reload current scene")
 	Console.register_custom_strong_command("spawn_entity",
 	 								_spawn_entity,
 									[CommandArgument.new(CommandArgument.Type.INT, "X Position", "The x position on screen for the entity"),
 									 CommandArgument.new(CommandArgument.Type.INT, "y Position", "The y position on screen for the entity"),
-									 CommandArgument.new(CommandArgument.Type.FLOAT, "time to life", "The time the entity should life in seconds")
+									 CommandArgument.new(CommandArgument.Type.FLOAT, "time to life", "The time the entity should life in seconds", "1"),
 									],
 									"Spawn an example entity at a global position",
 									"",
@@ -62,7 +62,7 @@ func _register_commands():
 
 	if !always_use_custom_console:
 		Console.register_custom_command("custom_console", _open_custom_console, [], "Open your custom console", "", [])
-		Console.register_custom_command("default_console", _open_default_console, [], "Open the default console", "", [])
+		Console.register_custom_command("default_console", _open_default_console, [], "Open the default console")
 
 func _spawn_entity(pos_x: int, pos_y: int, ttl: float) -> String:
 	_trigger_spawn_entity(pos_x, pos_y, ttl)