shell.c File Reference

#include "arc/console/shell.h"
#include "arc/console/buffer.h"
#include "arc/std/string.h"
#include "arc/std/vector.h"
#include <stdlib.h>

Go to the source code of this file.

Functions
void	ARC_ConsoleShell_Create (ARC_ConsoleShell **shell, ARC_ConsoleView *view, ARC_ConsoleShell_UpdateFn updateFn)
	creates ARC_ConsoleShell type
void	ARC_ConsoleShell_Destroy (ARC_ConsoleShell *shell)
	destroys ARC_ConsoleShell type
void	ARC_ConsoleShell_Update (ARC_ConsoleShell *shell)
	updates the ARC_ConsoleShell type
void	ARC_ConsoleShell_Render (ARC_ConsoleShell *shell)
	renders the ARC_ConsoleShell type
void	ARC_ConsoleShell_AddHistory (ARC_ConsoleShell *shell, ARC_String *string)
	adds history ARC_String to ARC_ConsoleShell
ARC_String *	ARC_ConsoleShell_GetHistoryAt (ARC_ConsoleShell *shell, uint32_t index)
	gets history from ARC_ConsoleShell

Function Documentation

ARC_ConsoleShell_AddHistory()

void ARC_ConsoleShell_AddHistory	(	ARC_ConsoleShell *	shell,
		ARC_String *	string )

adds history ARC_String to ARC_ConsoleShell

Parameters

shell	the ARC_ConsoleShell to add history to
string	the history string to add to ARC_ConsoleShell

Definition at line 46 of file shell.c.

                                                                             {
    ARC_Vector_Add(shell->history, (void *)string);
}

References ARC_Vector_Add(), and ARC_ConsoleShell::history.

ARC_ConsoleShell_Create()

void ARC_ConsoleShell_Create	(	ARC_ConsoleShell **	shell,
		ARC_ConsoleView *	view,
		ARC_ConsoleShell_UpdateFn	updateFn )

creates ARC_ConsoleShell type

Parameters

shell	ARC_ConsoleShell to create
view	ARC_ConsoleView to attach the shell to
updateFn	ARC_ConsoleShell_UpdateFn provided that will run the console

Definition at line 8 of file shell.c.

                                                                                                                 {
    *shell = (ARC_ConsoleShell *)malloc(sizeof(ARC_ConsoleShell));
 
    (*shell)->view = view;
    ARC_ConsoleBuffer_Create(&((*shell)->buffer));
    (*shell)->bufferLineIndex = 0;
 
    ARC_Vector_Create(&((*shell)->history));
    (*shell)->historyIndex = 0;
 
    (*shell)->updateFn = updateFn;
    (*shell)->currentLine = NULL;
    (*shell)->userInput = NULL;
}

References ARC_ConsoleBuffer_Create(), ARC_Vector_Create(), and ARC_ConsoleShell::view.

ARC_ConsoleShell_Destroy()

void ARC_ConsoleShell_Destroy

(

ARC_ConsoleShell *

shell

)

destroys ARC_ConsoleShell type

Parameters

shell

ARC_ConsoleShell to destroy

Definition at line 23 of file shell.c.

                                                      {
    ARC_ConsoleBuffer_Destroy(shell->buffer);
 
    for(uint32_t i = 0; i < ARC_Vector_Size(shell->history); i++){
        ARC_String *temp = (ARC_String *)ARC_Vector_Get(shell->history, i);
 
        if(temp != NULL){
            ARC_String_Destroy(temp);
        }
    }
 
    ARC_Vector_Destroy(shell->history);
    free(shell);
}

References ARC_ConsoleBuffer_Destroy(), ARC_String_Destroy(), ARC_Vector_Destroy(), ARC_Vector_Get(), ARC_ConsoleShell::buffer, and ARC_ConsoleShell::history.

ARC_ConsoleShell_GetHistoryAt()

ARC_String * ARC_ConsoleShell_GetHistoryAt	(	ARC_ConsoleShell *	shell,
		uint32_t	index )

gets history from ARC_ConsoleShell

Note

the index 0 will start from the last added history

Parameters

shell	the ARC_ConsoleShell to get history from
index	the location to get history at

Returns

the history as an ARC_String

Definition at line 50 of file shell.c.

                                                                                  {
    uint32_t maxHistory = ARC_Vector_Size(shell->history);
    if(index >= maxHistory){
        return NULL;
    }
 
    return (ARC_String *)ARC_Vector_Get(shell->history, (maxHistory - 1) - index);
}

References ARC_Vector_Get(), and ARC_ConsoleShell::history.

ARC_ConsoleShell_Render()

void ARC_ConsoleShell_Render

(

ARC_ConsoleShell *

shell

)

renders the ARC_ConsoleShell type

Parameters

shell

the ARC_ConsoleShell to render

Definition at line 42 of file shell.c.

                                                     {
    ARC_ConsoleBuffer_Render(shell->buffer, shell->view);
}

References ARC_ConsoleBuffer_Render(), ARC_ConsoleShell::buffer, and ARC_ConsoleShell::view.

ARC_ConsoleShell_Update()

void ARC_ConsoleShell_Update

(

ARC_ConsoleShell *

shell

)

updates the ARC_ConsoleShell type

Parameters

shell

the ARC_ConsoleShell to update

Definition at line 38 of file shell.c.

                                                     {
    shell->updateFn(shell);
}

References ARC_ConsoleShell::updateFn.