command.c File Reference

Implements functions used to generate and manage commands. More...

#include "command.h"
#include <stdlib.h>
#include <stdio.h>
#include <string.h>

Functions
CommandHolder	mk_command_holder (char *redirect_in, char *redirect_out, char flags, Command cmd)
	Create the properties for a command. More...
Command	mk_generic_command (char **args)
	Create a GenericCommand structure and return a copy. More...
Command	mk_echo_command (char **strs)
	Create a GenericCommand structure and return a copy. More...
Command	mk_export_command (char *env_var, char *val)
	Create a ExportCommand structure and return a copy. More...
Command	mk_cd_command (char *dir)
	Create a CDCommand structure and return a copy. More...
Command	mk_kill_command (char *sig, char *job)
	Create a KillCommand structure and return a copy. More...
Command	mk_pwd_command ()
	Create a PWDCommand structure and return a copy. More...
Command	mk_jobs_command ()
	Create a JobsCommand structure and return a copy. More...
Command	mk_exit_command ()
	Create a ExitCommand structure and return a copy. More...
Command	mk_eoc ()
	Create a EOCCommand structure and return a copy. More...
CommandType	get_command_type (Command cmd)
	Get the type of the command. More...
CommandType	get_command_holder_type (CommandHolder holder)
	Get the type of the Command in the CommandHolder. More...
void	debug_print_script (const CommandHolder *holders)
	Print all commands in the script with print_command() More...

Detailed Description

Implements functions used to generate and manage commands.

Function Documentation

debug_print_script()

void debug_print_script

(

const CommandHolder *

holders

)

Print all commands in the script with print_command()

Note

This only works when the DEBUG macro is defined

Parameters

holders

CommandHolder array to print

See also

CommandHolder

get_command_holder_type()

CommandType get_command_holder_type

(

CommandHolder

holder

)

Get the type of the Command in the CommandHolder.

Uses the property that all Command variants can be cast to SimpleCommand to extract the CommandType of the Command.

Parameters

holder

CommandHolder from which this function extracts the CommandType

Returns

The resulting CommandType of the cmd parameter

See also

CommandType, CommandHolder, SimpleCommand

get_command_type()

CommandType get_command_type

(

Command

cmd

)

Get the type of the command.

Uses the property that all Command variants can be cast to SimpleCommand to extract the CommandType of the Command.

Parameters

cmd	Command from which this function extracts the CommandType

Returns

The resulting CommandType of the cmd parameter

See also

CommandType, Command, SimpleCommand

mk_cd_command()

Command mk_cd_command

(

char *

dir

)

Create a CDCommand structure and return a copy.

Parameters

dir	Path to the directory we wish to change to

Returns

Copy of constructed CDCommand

See also

realpath(), Command, CDCommand

mk_command_holder()

CommandHolder mk_command_holder	(	char *	redirect_in,
		char *	redirect_out,
		char	flags,
		Command	cmd
	)

Create the properties for a command.

Parameters

redirect_in	Redirect standard in of this command to a file name redirect_in
redirect_out	Redirect standard out of this command to a file name redirect_out
flags	A set of bits that hold information about how to execute the command. The properties can be extracted from the flags field by using a bit-wise & (i.e. flags & PIPE_IN) are macro defined as: REDIRECT_IN REDIRECT_OUT REDIRECT_APPEND PIPE_IN PIPE_OUT BACKGROUND
cmd	Command to hold

Returns

A CommandHolder

See also

CommandType, REDIRECT_IN, REDIRECT_OUT, REDIRECT_APPEND, PIPE_IN, PIPE_OUT, BACKGROUND, Command, CommandHolder

mk_echo_command()

Command mk_echo_command

(

char **

args

)

Create a GenericCommand structure and return a copy.

Returns

Copy of constructed GenericCommand

See also

CommandType, REDIRECT_IN, REDIRECT_OUT, REDIRECT_APPEND, PIPE_IN, PIPE_OUT, BACKGROUND, Command, GenericCommand

mk_eoc()

Command mk_eoc

(

)

Create a EOCCommand structure and return a copy.

Returns

Copy of constructed EOCCommand

See also

Command, EOCCommand

mk_exit_command()

Command mk_exit_command

(

)

Create a ExitCommand structure and return a copy.

Returns

Copy of constructed ExitCommand

See also

Command, ExitCommand

mk_export_command()

Command mk_export_command	(	char *	env_var,
		char *	val
	)

Create a ExportCommand structure and return a copy.

Parameters

env_var	Name of environment variable to set
val	String that should be stored in env_var environment variable

Returns

Copy of constructed ExportCommand

See also

lookup_env(), write_env(), Command, ExportCommand

mk_generic_command()

Command mk_generic_command

(

char **

args

)

Create a GenericCommand structure and return a copy.

Parameters

args	A NULL terminated array of c-strings ready to pass to exec functions

Returns

Copy of constructed GenericCommand

See also

CommandType, REDIRECT_IN, REDIRECT_OUT, REDIRECT_APPEND, PIPE_IN, PIPE_OUT, BACKGROUND, Command, GenericCommand

mk_jobs_command()

Command mk_jobs_command

(

)

Create a JobsCommand structure and return a copy.

Returns

Copy of constructed JobsCommand

See also

Command, JobsCommand

mk_kill_command()

Command mk_kill_command	(	char *	sig,
		char *	job
	)

Create a KillCommand structure and return a copy.

Parameters

sig	Signal to send to the job
job	Job id number

Returns

Copy of constructed KillCommand

See also

Command, KillCommand

mk_pwd_command()

Command mk_pwd_command

(

)

Create a PWDCommand structure and return a copy.

Returns

Copy of constructed PWDCommand

See also

Command, PWDCommand