Implementation of the Command structure and associated functions as used in the Command Pattern. More...

#include <errno.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include "Command_Command.h"

Include dependency graph for Command_Command.c:

Functions
Command *	Command_Create_Two_Parameters (const char commandName, Command_TextObject receiver, two_parameter_operation operation, const char arg1, const char arg2)
	Create a new Command object with the given parameters, creating a command that uses two additional parameters.

Command *	Command_Create_No_Parameters (const char commandName, Command_TextObject receiver, no_parameter_operation operation)
	Create a new Command object with the given parameters, creating a command that uses no additional parameters.

void	Command_Destroy (Command *commandObject)
	Destroy the given command object, releasing it and any associated resources.

void	Command_Execute (Command *commandObject)
	Execute the given command on the Command_TextObject it knows about.

const char *	Command_ToString (Command *commandObject)
	Convert the given command object to a string representation.

Detailed Description

Implementation of the Command structure and associated functions as used in the Command Pattern.

Definition in file Command_Command.c.

Function Documentation

Command * Command_Create_No_Parameters	(	const char *	commandName,
		Command_TextObject *	receiver,
		no_parameter_operation	operation
	)

Create a new Command object with the given parameters, creating a command that uses no additional parameters.

Parameters

commandName	The name of the command (for display purposes).
receiver	The target or receiver of the command operation.
operation	The function to call to perform the command.

Returns: Returns a new Command object if successful; returns NULL if out of memory

Definition at line 33 of file Command_Command.c.

Command * Command_Create_Two_Parameters	(	const char *	commandName,
		Command_TextObject *	receiver,
		two_parameter_operation	operation,
		const char *	arg1,
		const char *	arg2
	)

Create a new Command object with the given parameters, creating a command that uses two additional parameters.

Parameters

commandName	The name of the command (for display purposes).
receiver	The target or receiver of the command operation.
operation	The function to call to perform the command.
arg1	The first argument to pass to the command function.
arg2	The second argument to pass to the command function.