commands.h File Reference

---

Detailed Description

Author:

Hal Finkel

Command lexing and parsing

#include "common.h"

Include dependency graph for commands.h:

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

Go to the source code of this file.

Data Structures
struct	pf_plot_range
	A plot-range specification. More...
Enumerations
enum	pf_command {   command_invalid, command_quit, command_load, command_print_data,   command_print_peaks, command_print_peak, command_print_calibration, command_plot_data,   command_plot_peak, command_calibrate, command_clear_calibration }
	A command type. More...
Functions
enum pf_command	pf_get_parsed_command ()
	Get the parsed command.
enum pf_peak_sort	pf_get_parsed_sort ()
	Get the parsed sort flag.
pf_plot_range *	pf_get_parsed_plot_range ()
	Get the parsed plot range.
char *	pf_get_parsed_file ()
	Get the parsed file name.
char *	pf_get_parsed_driver ()
	Get the parsed driver name.
int	pf_get_parsed_rescale ()
	Get the parsed rescale flag.
int	pf_get_parsed_cal ()
	Get the parsed calibration flag.
int	pf_get_parsed_norm ()
	Get the parsed normailzation flag.
int	pf_get_parsed_marked ()
	Get the parsed mark flag.
int	pf_get_parsed_annot ()
	Get the parsed annotate flag.
int	pf_get_parsed_peak ()
	Get the parsed peak number.
double	pf_get_parsed_rotation ()
	The the parsed rotation amount.
void	pf_get_parsed_plot_params (struct pf_plot_params *p)
	Get the parsed plot parameters.
void	pf_init_parse_data ()
	Initialize the parse context data.
void	pf_free_parse_data ()
	Free any data associated with the last parse.
void	pf_execute_command ()
	Execute the next command.
void	pf_set_command_parse_buffer (char *cmd)
	Set the buffer to parse.

---

Enumeration Type Documentation

enum pf_command

A command type. Enumeration values: command_invalid  Invalid command. command_quit  Quit command. command_load  Load command. command_print_data  Print-data command. command_print_peaks  Print-peaks command. command_print_peak  Print-peak command. command_print_calibration  Print-calibration command. command_plot_data  Plot-data command. command_plot_peak  Plot-peak command. command_calibrate  Calibrate command. command_clear_calibration  Clear-calibration command.

---

Function Documentation

void pf_execute_command (   )

Execute the next command.

Here is the call graph for this function:

void pf_free_parse_data (   )

Free any data associated with the last parse.

int pf_get_parsed_annot (   )

Get the parsed annotate flag. Returns: The parsed annotate flag

int pf_get_parsed_cal (   )

Get the parsed calibration flag. Returns: The parsed calibration flag

enum pf_command pf_get_parsed_command (   )

Get the parsed command. Returns: The parsed command

char* pf_get_parsed_driver (   )

Get the parsed driver name. Returns: The parsed driver name

char* pf_get_parsed_file (   )

Get the parsed file name. Returns: The parsed file name

int pf_get_parsed_marked (   )

Get the parsed mark flag. Returns: The parsed mark flag

int pf_get_parsed_norm (   )

Get the parsed normailzation flag. Returns: The parsed normailzation flag

int pf_get_parsed_peak (   )

Get the parsed peak number. Returns: The parsed peak number

void pf_get_parsed_plot_params (  struct pf_plot_params *  p  )

Get the parsed plot parameters. Parameters: [out]  p  The plot parameters

struct pf_plot_range* pf_get_parsed_plot_range (   )

Get the parsed plot range. Returns: The parsed plot range

int pf_get_parsed_rescale (   )

Get the parsed rescale flag. Returns: The parsed rescale flag

double pf_get_parsed_rotation (   )

The the parsed rotation amount. Returns: The parsed rotation amount

enum pf_peak_sort pf_get_parsed_sort (   )

Get the parsed sort flag. Returns: The parsed sort flag

void pf_init_parse_data (   )

Initialize the parse context data.

void pf_set_command_parse_buffer (  char *  cmd  )

Set the buffer to parse. Parameters: [in]  cmd  The buffer with the command string

---