task.h File Reference

Contains structures and functions for handling task-related operations. More...

#include <stdlib.h>
#include <stdio.h>
#include <stddef.h>
#include <string.h>

Go to the source code of this file.

Classes
struct	Task
	A basic task. More...
struct	TaskClass
	A task class containing other tasks. More...
struct	TaskCollection
	A task collection containing other classes. More...

Macros
#define	MAX_TABLE_SIZE   50

Typedefs
typedef struct Task	Task
	A basic task.
typedef struct TaskClass	TaskClass
	A task class containing other tasks.
typedef struct TaskCollection	TaskCollection
	A task collection containing other classes.

Functions
Task *	create_task (char *class_of_task, char *task_content)
	Creates a task of known class and content.
TaskClass *	create_task_class (char *class_of_task, size_t class_size)
	Creates a task class of a known class and size.
TaskCollection *	create_task_collection (size_t collection_size)
	Creates a task collection of known size.
Task *	get_task (TaskClass *task_class, const char *key)
	Finds a task in a task class by its content.
void	add_task (TaskClass *task_class, Task *new_task)
	Adds a task to a task class.
TaskClass *	get_task_class (TaskCollection *task_collection, const char *key)
	Gets a task class by its class name from a task collection.
void	add_task_class (TaskCollection *task_collection, TaskClass *task_class)
	Adds a task class to a task collection.
void	remove_task (TaskClass *task_class, char *task_content)
	Removes a task from a task class by its content.
void	remove_task_class (TaskCollection *task_collection, char *class_name)
	Removes a task class from a task collection.
void	print_task (Task *task)
	Prints the content of a task.

Detailed Description

Contains structures and functions for handling task-related operations.

Defines the schema of tasks, task classes, and task collections. It also contains the procedures for creating, modifying, removing, and destroying the task structures.

Definition in file task.h.

Macro Definition Documentation

MAX_TABLE_SIZE

#define MAX_TABLE_SIZE   50

Definition at line 9 of file task.h.

Typedef Documentation

Task

typedef struct Task Task

A basic task.

Contains two strings, which are the class and the content.

TaskClass

typedef struct TaskClass TaskClass

A task class containing other tasks.

Synonymous to a subject or category that the task belongs to.

TaskCollection

typedef struct TaskCollection TaskCollection

A task collection containing other classes.

Serves as a lookup table for the existing classes in the serverside

Function Documentation

add_task()

void add_task	(	TaskClass *	task_class,
		Task *	new_task )

Adds a task to a task class.

Parameters

task_class	Pointer to the task class that will contain the new task
new_task	Pointer to the task to be added

Note

Wrapper around the hashmap_set function

Definition at line 74 of file task.c.

{
  if ( task_class == NULL || new_task->task_content == NULL ) 
  {
    printf("Task class error: task class or key is null\n");
    return;
  }
  if ( new_task == NULL ) 
  {
    printf("Task class error: new task to be added is null\n");
    return;
  }
  if ( task_class->table_size <= 0 ) 
  {
    printf("Task class error: invalid table size (%zu)", task_class->table_size);
    return;
  }
  
  hashmap_set(task_class->task_class_table, new_task->task_content, new_task);
}

add_task_class()

void add_task_class	(	TaskCollection *	task_collection,
		TaskClass *	task_class )

Adds a task class to a task collection.

Parameters

task_collection	Pointer to the task collection that will contain the new task
task_class	Pointer to the task class to be added

Note

Wrapper around hashmap_set

Definition at line 123 of file task.c.

{
  if (task_collection == NULL || task_class == NULL) 
  {
    return;
  }
  if (task_class->task_class_name == NULL)
  {
    return;
  }
 
  hashmap_set(task_collection->task_collection, task_class->task_class_name, task_class);
}

create_task()

Task * create_task	(	char *	class_of_task,
		char *	task_content )

Creates a task of known class and content.

Parameters

class_of_task	Pointer to the class string of the task
task_content	Pointer to the content string of the task

Returns

Pointer to the created task

Definition at line 16 of file task.c.

{
  Task* task = (Task*)malloc(sizeof(Task));
  task->task_class = class_of_task;
  task->task_content = task_content;
  return task;
}

create_task_class()

TaskClass * create_task_class	(	char *	class_of_task,
		size_t	class_size )

Creates a task class of a known class and size.

Parameters

class_of_task	Pointer to the class string of the task class
class_size	Size of the task class hash table

Returns

Pointer to the created task class

Note

This is a wrapper around the hashmap_create function

Definition at line 24 of file task.c.

{
  TaskClass* task_class = (TaskClass*)malloc(sizeof(TaskClass));
  task_class->task_class_name = class_name;
  task_class->table_size = class_size;
  task_class->task_class_table = hashmap_create(class_size);
  return task_class;
}

create_task_collection()

TaskCollection * create_task_collection

(

size_t

collection_size

)

Creates a task collection of known size.

Parameters

collection_size

Size of the task collection hash table

Returns

Pointer to the created task collection

Note

This is a wrapper around the hashmap_create function

Definition at line 36 of file task.c.

{
  TaskCollection* task_collection = (TaskCollection*)malloc(sizeof(TaskCollection)); 
  task_collection->collection_size = collection_size;
  task_collection->task_collection = hashmap_create(collection_size);
  return task_collection;
}

get_task()

Task * get_task	(	TaskClass *	task_class,
		const char *	key )

Finds a task in a task class by its content.

Parameters

task_class	Pointer to the task class to look into
key	Pointer to the key string (task content)

Returns

Pointer to the task found. Returns NULL if not found

Note

Wrapper around the hashmap_get function.

Casts the output of hashmap_get to a Task* type

Definition at line 47 of file task.c.

{
  if ( task_class == NULL || key == NULL ) 
  {
    printf("Task class error: task class or key is null\n");
    return NULL;
  }
  if (task_class->table_size <= 0) 
  {
    printf("Task class error: invalid table size (%zu)", task_class->table_size);
    return NULL;
  }
 
  void* ret = hashmap_get(task_class->task_class_table, key);
  if (ret == NULL)
  {
    return NULL;
  }
 
  return (Task*)ret; //cast into Task type
}

get_task_class()

TaskClass * get_task_class	(	TaskCollection *	task_collection,
		const char *	key )

Gets a task class by its class name from a task collection.

Parameters

task_collection	Pointer to the task collection containing the task class to be found
key	Pointer to the key string (task class name)

Returns

Pointer to the task class found. Returns NULL if not found

Note

Wrapper around the hashmap_get function

Casts the output of hashmap_get to a TaskClass* type

Definition at line 98 of file task.c.

{
  if (task_collection == NULL || key == NULL) 
  {
    return NULL;
  }
  if (task_collection->collection_size <= 0)
  {
    return NULL;
  }
 
  void* ret = hashmap_get(task_collection->task_collection, key);
 
  if (ret == NULL)
  {
    return NULL;
  }
  return (TaskClass*)ret; // Cast into a TaskClass type
}

print_task()

void print_task

(

Task *

task

)

Prints the content of a task.

Parameters

task	Pointer to the task to be printed

Warning

Assumes that the task attributes are non-NULL

Definition at line 172 of file task.c.

{
  if (task == NULL)
  {
    return;
  }
  printf("Task class: %s\nContent: %s\n", task->task_class, task->task_content);
}

remove_task()

void remove_task	(	TaskClass *	task_class,
		char *	task_content )

Removes a task from a task class by its content.

Parameters

task_class	Pointer to the task class that contains the task to be removed
task_content	Pointer to the content string of the task to be removed

Note

Wrapper around hashmap_elem_remove

Definition at line 140 of file task.c.

{
  if (task_class == NULL || task_content == NULL)
  {
    return;
  }
  if (task_class->task_class_table == NULL)
  {
    return; 
  }
  hashmap_elem_remove(task_class->task_class_table, task_content);
}

remove_task_class()

void remove_task_class	(	TaskCollection *	task_collection,
		char *	class_name )

Removes a task class from a task collection.

Parameters

task_collection	Pointer to the task collection that contains the task class to be removed
class_name	Pointer to the class name string of the task class to be removed

Note

Wrapper around hashmap_elem_remove

Definition at line 156 of file task.c.

{
  if (task_collection == NULL || class_name == NULL)
  {
    return;
  }
  if (task_collection->task_collection == NULL)
  {
    return; 
  }
  hashmap_elem_remove(task_collection->task_collection, class_name);
}