/*	**************************************************************	*/

/*
 *	Module RUNPARAM
 *	This module contains utility functions which get run parameter information.
 *
 *	Zachary Wolf
 *	11/18/99
 */

/*	*************************************************************  */

/*	INCLUDE FILES */
#include <ansi_c.h>
#include <formatio.h>
#include <utility.h>
#include "runparam.h"
#include "runparamui.h"

/*	**************************************************************	*/

/*	PRIVATE FUNCTION DECLARATIONS  */
void runparam_error(char* message);

/*	**************************************************************	*/

/*	PUBLIC FUNCTIONS  */

/*	**************************************************************	*/

/*
 *	runparam_get_run_param
 *	This function opens a window and gets the run parameters from
 *	the user.
 *	
 *	Output:
 *	run_param, structure containing the run parameters
 *
 *	Zachary Wolf
 *	11/19/99
 */

void runparam_get_run_param(struct run_param_struct* run_param)
{
	/* Get the run parameters from the user */
	runparamui_get_run_param(run_param);
	
	/* Done */
	return;
}

/*	**************************************************************	*/

/*
 *	runparam_create_file
 *	This function makes a full file name using the run parameters.
 *	It checks to make sure a file with that name does not already exist.
 *	It creates any required directories to make the path specified in the
 *	file name.
 *	It creates a file with the specified file name.
 *	
 *	Input:
 *	run_param, structure containing the run parameters
 *	base_name, basic name for file, eg. logfile, wiredat, harplt, ...
 *
 *	Output:
 *	err, 0 = ok, otherwise there was a problem
 *	file_name, full name including the directory path and extension
 *
 *	Zachary Wolf
 *	11/19/99
 */

int runparam_create_file(struct run_param_struct run_param, char* base_name, char* file_name)
{
	/* Declare variables */
	int run_num;
	char ext[4];
	int file_handle;
	char directory[80];
	int status;
	FILE* file_ptr;
	
	/* Construct an extension for the file */
	Scan(run_param.run_num, "%s>%i", &run_num);
	if (run_num >= 1 && run_num < 10) Fmt(ext, "%s<ru%i", run_num);
	else if (run_num >= 10 && run_num < 100) Fmt(ext, "%s<r%i", run_num);
	else if (run_num >= 100 && run_num < 1000) Fmt(ext, "%s<%i", run_num);
	else
	{
		printf("Invalid run number, try again...\n");
		Beep();
		return 1;
	}
	
	/* Construct a file name from the run parameters */
	Fmt(file_name, "%s<c:\\magdata\\%s\\%s\\%s\\%s.%s", run_param.project, run_param.mag_type, run_param.mag_name, base_name, ext);

	/* See if the file already exists */
	SetBreakOnLibraryErrors(0);
	file_handle = OpenFile(file_name, VAL_READ_ONLY, VAL_OPEN_AS_IS, VAL_ASCII);
	SetBreakOnLibraryErrors(1);
	if (file_handle != -1)
	{
		CloseFile(file_handle);
		printf("File already exists, try a different run number...\n");
		Beep();
		return 1;
	}
	
	/* Create any required directories */
	SetBreakOnLibraryErrors(0);
	Fmt(directory, "%s<c:\\magdata\\%s", run_param.project);
	status = MakeDir(directory);
	if (status != 0 && status != -9) runparam_error("Problem creating the directory structure");
	Fmt(directory, "%s<%s\\%s", directory, run_param.mag_type);
	status = MakeDir(directory);
	if (status != 0 && status != -9) runparam_error("Problem creating the directory structure");
	Fmt(directory, "%s<%s\\%s", directory, run_param.mag_name);
	status = MakeDir(directory);
	if (status != 0 && status != -9) runparam_error("Problem creating the directory structure");
	SetBreakOnLibraryErrors(1);

	/* Create the file */
	file_ptr = fopen(file_name, "w");
	if (file_ptr == NULL) runparam_error("Problem opening a file");
	fclose(file_ptr);
	
	/* Done */
	return 0;
}

/*	**************************************************************	*/

/*
 *	runparam_write_header
 *	This function writes a header to the specified file
 *	using the run parameters.
 *
 *	Input:
 *	run_param, structure containing the run parameters
 *	file_name, file name including the directory path and extension
 *
 *	Zachary Wolf
 *	11/19/99
 */

void runparam_write_header(struct run_param_struct run_param, char* file_name)
{
	/* Declare variables */
	FILE* file_ptr;

	/* Open the file */
	file_ptr = fopen(file_name, "a");
	if (file_ptr == NULL) runparam_error("Problem opening a file to write a header");

	/* Write the header */
	fprintf(file_ptr, "SLAC Magnetic Measurements\n");
	fprintf(file_ptr, "Date: %s\n", DateStr());
	fprintf(file_ptr, "Time: %s\n", TimeStr());
	fprintf(file_ptr, "\n");
	fprintf(file_ptr, "Project: %s\n", run_param.project);
	fprintf(file_ptr, "Magnet Type: %s\n", run_param.mag_type);
	fprintf(file_ptr, "Magnet Name: %s\n", run_param.mag_name);
	fprintf(file_ptr, "Serial Number: %s\n", run_param.ser_num);
	fprintf(file_ptr, "Run Number: %s\n", run_param.run_num);
	fprintf(file_ptr, "Measurement Device: %s\n", run_param.meas_dev);
	fprintf(file_ptr, "Operator: %s\n", run_param.operator);
	fprintf(file_ptr, "Comment: %s\n", run_param.comment);
	
	/* Close the file */
	fclose(file_ptr);
	
	/* Done */
	return;
}

/*	**************************************************************	*/

/*
 *	runparam_update_index
 *	This function updates the run index for the specified project,
 *	magnet type, and magnet name.
 *
 *	Input:
 *	run_param, structure containing the run parameters
 *
 *	Zachary Wolf
 *	4/20/01
 */

void runparam_update_index(struct run_param_struct run_param)
{
	/* Declare variables */
	char file_name[80];
	int file_handle;
	enum binary {TRUE, FALSE} file_exists;
	char directory[80];
	int status;
	FILE* file_ptr;
	
	/* Construct a file name from the run parameters */
	Fmt(file_name, "%s<c:\\magdata\\%s\\%s\\%s\\index.dat", run_param.project, run_param.mag_type, run_param.mag_name);

	/* See if the file already exists */
	SetBreakOnLibraryErrors(0);
	file_handle = OpenFile(file_name, VAL_READ_ONLY, VAL_OPEN_AS_IS, VAL_ASCII);
	SetBreakOnLibraryErrors(1);
	if (file_handle == -1) file_exists = FALSE;
	else file_exists = TRUE;
	
	/* If the file does not exist, create any required directories, create the file */
	if (file_exists == FALSE)
	{
		SetBreakOnLibraryErrors(0);
		Fmt(directory, "%s<c:\\magdata\\%s", run_param.project);
		status = MakeDir(directory);
		if (status != 0 && status != -9) runparam_error("Problem creating the directory structure");
		Fmt(directory, "%s<%s\\%s", directory, run_param.mag_type);
		status = MakeDir(directory);
		if (status != 0 && status != -9) runparam_error("Problem creating the directory structure");
		Fmt(directory, "%s<%s\\%s", directory, run_param.mag_name);
		status = MakeDir(directory);
		if (status != 0 && status != -9) runparam_error("Problem creating the directory structure");
		SetBreakOnLibraryErrors(1);
		file_ptr = fopen(file_name, "w");
		if (file_ptr == NULL) runparam_error("Problem opening a file");
	}

	/* If the file does already exist, open it */
	if (file_exists == TRUE)
	{
		file_ptr = fopen(file_name, "a");
		if (file_ptr == NULL) runparam_error("Problem opening a file");
	}
	
	/* Put a header on a new file */
	if (file_exists == FALSE)
	{
		fprintf(file_ptr, "Project: %s\n", run_param.project);
		fprintf(file_ptr, "Magnet Type: %s\n", run_param.mag_type);
		fprintf(file_ptr, "Magnet Name: %s\n", run_param.mag_name);
		fprintf(file_ptr, "Serial Number: %s\n", run_param.ser_num);
		fprintf(file_ptr, "\n");
		fprintf(file_ptr, "  Date      Time    Run    Device    Oper  Comment\n");
		fprintf(file_ptr, "--------  --------  ---  ----------  ----  -------->\n");
	}

	/* Update the index file */
	fprintf(file_ptr, "%8.8s", DateStr());
	fprintf(file_ptr, "  %8.8s", TimeStr());
	fprintf(file_ptr, "  %3.3s", run_param.run_num);
	fprintf(file_ptr, "  %10.10s", run_param.meas_dev);
	fprintf(file_ptr, "  %4.4s", run_param.operator);
	fprintf(file_ptr, "  %-s", run_param.comment);
	fprintf(file_ptr, "\n");
	
	/* Close the file */
	fclose(file_ptr);
	
	/* Done */
	return;
}

/*	**************************************************************	*/

/*	PRIVATE FUNCTIONS  */

/*	**************************************************************	*/
/*
 *	runparam_error
 *	This function handles errors for the run parameter module.
 *
 *	Input:
 *	message, string to display in standard I/O
 *
 *	Zachary Wolf
 *	11/19/99
 */
 
void runparam_error(char* message)
{
	/* Declare variables */
	char buf[80];
	
	/* Notify the operator of the error */
	printf("\nERROR: %s\n", message);
	Beep();
	Delay(.5);
	Beep();
	
	/* Terminate the program if the operator desires */
	printf("Press ENTER to continue.\nPress any key then ENTER to terminate program.\n");
	fgets(buf, 80, stdin);
	if (buf[0] == '\n') return;
	else exit(0);
}