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

#include <stdbool.h>

Include dependency graph for Command_TextObject.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	Command_TextObject
	Container for a string. Need to use a structure to keep the starting text and the current text together. Operations applied to an instance of this structure alter the contents but not the structure itself. More...

Macros
#define	__COMMAND_TEXTOBJECT_H__

Typedefs
typedef struct Command_TextObject	Command_TextObject
	Container for a string. Need to use a structure to keep the starting text and the current text together. Operations applied to an instance of this structure alter the contents but not the structure itself.

Functions
bool	Command_TextObject_Initialize (Command_TextObject textObject, const char startingText)
	Initialize a Command_TextObject with the specified text.

void	Command_TextObject_Clear (Command_TextObject *textObject)
	Clear the contents of the specified Command_TextObject, releasing any allocated resources associated with the Command_TextObject.

void	Command_TextObject_Reset (Command_TextObject *textObject)
	Resets the Command_TextObject to the starting string.

char *	Command_TextObject_GetText (Command_TextObject *textObject)
	Gets the text in the specified Command_TextObject.

void	Command_TextObject_SetText (Command_TextObject textObject, const char newText)
	Sets the text in the specified Command_TextObject.

const char *	Command_TextObject_ToString (Command_TextObject *textObject)
	Converts the Command_TextObject to a string (basically, returns the current text from the Command_TextObject).

Detailed Description

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

Definition in file Command_TextObject.h.

Macro Definition Documentation

◆ __COMMAND_TEXTOBJECT_H__

#define __COMMAND_TEXTOBJECT_H__

Definition at line 8 of file Command_TextObject.h.

Typedef Documentation

◆ Command_TextObject

typedef struct Command_TextObject Command_TextObject

Container for a string. Need to use a structure to keep the starting text and the current text together. Operations applied to an instance of this structure alter the contents but not the structure itself.

Function Documentation

◆ Command_TextObject_Clear()

void Command_TextObject_Clear ( Command_TextObject * textObject )

Clear the contents of the specified Command_TextObject, releasing any allocated resources associated with the Command_TextObject.

Parameters

textObject A Command_TextObject whose contents are to be destroyed.

Definition at line 35 of file Command_TextObject.c.

References Command_TextObject::startingText, and Command_TextObject::text.

Referenced by Command_Exercise(), and Command_TextObject_Initialize().

◆ Command_TextObject_GetText()

char * Command_TextObject_GetText ( Command_TextObject * textObject )

Gets the text in the specified Command_TextObject.

Parameters

textObject The Command_TextObject from which to get the text.

Returns: Returns a pointer to the mutable text in the Command_TextObject.

Definition at line 60 of file Command_TextObject.c.

References Command_TextObject::text.

Referenced by Command_Operation_Replace(), and Command_Operation_Reverse().

◆ Command_TextObject_Initialize()

bool Command_TextObject_Initialize	(	Command_TextObject *	textObject,
		const char *	startingText
	)

Initialize a Command_TextObject with the specified text.

Parameters

textObject	A Command_TextObject to initialize with the given text.
startingText	The text with which to initialize the object. String is not duplicated.

Returns: Returns true if the initialization was successful; otherwise, returns false (a null pointer was passed in or a out of memory condition occurred.

Definition at line 18 of file Command_TextObject.c.

References Command_TextObject_Clear(), Command_TextObject::startingText, STRDUP, and Command_TextObject::text.

Referenced by Command_Exercise().