quash.h File Reference

#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include "execute.h"

Go to the source code of this file.

Classes
struct	QuashState
	Holds information about the state and environment Quash is running in. More...

Typedefs
typedef struct QuashState	QuashState
	Holds information about the state and environment Quash is running in.

Functions
QuashState	initial_state ()
	Create the initial QuashState structure. More...
char *	get_command_string ()
	Get a deep copy of the current command string. More...
bool	is_running ()
	Query if quash should accept more input or not. More...
void	end_main_loop ()
	Causes the execution loop to end.

Detailed Description

Quash essential functions and structures.

Function Documentation

get_command_string()

char* get_command_string

(

)

Get a deep copy of the current command string.

Note

The free function must be called on the result eventually

Returns

A copy of the command string

initial_state()

QuashState initial_state

(

)

Create the initial QuashState structure.

Returns

Returns a copy of the initialized state.

is_running()

bool is_running

(

)

Query if quash should accept more input or not.

Returns

True if Quash should accept more input and false otherwise