/* UiPause.c
 *
 * Copyright (C) 2009 Paul Boersma
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*
 * pb 2009/01/20 created
 */

#include "UiPause.h"
#include "praatP.h"

static UiForm thePauseForm = NULL;
static Any thePauseFormRadio = NULL;
static int thePauseForm_clicked = 0;
static int theEventLoopDepth = 0;

static int thePauseFormOkCallback (UiForm sendingForm, const wchar_t *sendingString, Interpreter interpreter, void *closure) {
	(void) sendingForm;
	(void) sendingString;
	(void) interpreter;
	/* BUG: should also restore praatP. editor. */
	/*
	 * Get the data from the pause form.
	 */
	UiForm_Interpreter_addVariables (thePauseForm, closure);   // 'closure', not 'interpreter' or 'theInterpreter'!
	thePauseForm_clicked = UiForm_getClickedContinueButton (thePauseForm);
	return 1;
}
static int thePauseFormCancelCallback (Any dia, void *closure) {
	(void) dia;
	(void) closure;
	thePauseForm_clicked = -1;
	return 1;
}
int UiPause_begin (Widget topShell, const wchar_t *title, Interpreter interpreter) {
	if (theEventLoopDepth > 0)
		error1 (L"Praat cannot have more than one pause form at a time.")
	forget (thePauseForm);   // in case an earlier build-up of another pause window was interrupted
	thePauseForm = UiForm_create (topShell, Melder_wcscat2 (L"Pause: ", title),
		thePauseFormOkCallback, interpreter,   // pass interpreter as closure!
		NULL); cherror
end:
	iferror return 0;
	return 1;
}
int UiPause_real (const wchar_t *label, const wchar_t *defaultValue) {
	if (thePauseForm == NULL)
		error1 (L"The function \"real\" has to be between a \"beginPause\" and an \"endPause\".")
	UiForm_addReal (thePauseForm, label, defaultValue); cherror
end:
	iferror return 0;
	return 1;
}
int UiPause_positive (const wchar_t *label, const wchar_t *defaultValue) {
	if (thePauseForm == NULL)
		error1 (L"The function \"positive\" has to be between a \"beginPause\" and an \"endPause\".")
	UiForm_addPositive (thePauseForm, label, defaultValue); cherror
end:
	iferror return 0;
	return 1;
}
int UiPause_integer (const wchar_t *label, const wchar_t *defaultValue) {
	if (thePauseForm == NULL)
		error1 (L"The function \"integer\" has to be between a \"beginPause\" and an \"endPause\".")
	UiForm_addInteger (thePauseForm, label, defaultValue); cherror
end:
	iferror return 0;
	return 1;
}
int UiPause_natural (const wchar_t *label, const wchar_t *defaultValue) {
	if (thePauseForm == NULL)
		error1 (L"The function \"natural\" has to be between a \"beginPause\" and an \"endPause\".")
	UiForm_addNatural (thePauseForm, label, defaultValue); cherror
end:
	iferror return 0;
	return 1;
}
int UiPause_word (const wchar_t *label, const wchar_t *defaultValue) {
	if (thePauseForm == NULL)
		error1 (L"The function \"word\" has to be between a \"beginPause\" and an \"endPause\".")
	UiForm_addWord (thePauseForm, label, defaultValue); cherror
end:
	iferror return 0;
	return 1;
}
int UiPause_sentence (const wchar_t *label, const wchar_t *defaultValue) {
	if (thePauseForm == NULL)
		error1 (L"The function \"sentence\" has to be between a \"beginPause\" and an \"endPause\".")
	UiForm_addSentence (thePauseForm, label, defaultValue); cherror
end:
	iferror return 0;
	return 1;
}
int UiPause_text (const wchar_t *label, const wchar_t *defaultValue) {
	if (thePauseForm == NULL)
		error1 (L"The function \"text\" has to be between a \"beginPause\" and an \"endPause\".")
	UiForm_addText (thePauseForm, label, defaultValue); cherror
end:
	iferror return 0;
	return 1;
}
int UiPause_boolean (const wchar_t *label, int defaultValue) {
	if (thePauseForm == NULL)
		error1 (L"The function \"boolean\" has to be between a \"beginPause\" and an \"endPause\".")
	UiForm_addBoolean (thePauseForm, label, defaultValue); cherror
end:
	iferror return 0;
	return 1;
}
int UiPause_choice (const wchar_t *label, int defaultValue) {
	if (thePauseForm == NULL)
		error1 (L"The function \"choice\" has to be between a \"beginPause\" and an \"endPause\".")
	thePauseFormRadio = UiForm_addRadio (thePauseForm, label, defaultValue); cherror
end:
	iferror return 0;
	return 1;
}
int UiPause_optionMenu (const wchar_t *label, int defaultValue) {
	if (thePauseForm == NULL)
		error1 (L"The function \"optionMenu\" has to be between a \"beginPause\" and an \"endPause\".")
	thePauseFormRadio = UiForm_addOptionMenu (thePauseForm, label, defaultValue); cherror
end:
	iferror return 0;
	return 1;
}
int UiPause_option (const wchar_t *label) {
	if (thePauseForm == NULL)
		error1 (L"The function \"option\" has to be between a \"beginPause\" and an \"endPause\".")
	if (thePauseFormRadio == NULL) {
		forget (thePauseForm);
		error1 (L"Found the function \"option\" without a preceding \"choice\" or \"optionMenu\".")
	}
	UiOptionMenu_addButton (thePauseFormRadio, label); cherror
end:
	iferror return 0;
	return 1;
}
int UiPause_comment (const wchar_t *label) {
	if (thePauseForm == NULL)
		error1 (L"The function \"comment\" has to be between a \"beginPause\" and an \"endPause\".")
	UiForm_addLabel (thePauseForm, L"", label); cherror
end:
	iferror return 0;
	return 1;
}
int UiPause_end (int numberOfContinueButtons, int defaultContinueButton,
	const wchar_t *continueText1, const wchar_t *continueText2, const wchar_t *continueText3,
	const wchar_t *continueText4, const wchar_t *continueText5, const wchar_t *continueText6,
	const wchar_t *continueText7, const wchar_t *continueText8, const wchar_t *continueText9,
	const wchar_t *continueText10, Interpreter interpreter)
{
	if (thePauseForm == NULL)
		error1 (L"Found the function \"endPause\" without a preceding \"beginPause\".")
	UiForm_setPauseForm (thePauseForm, numberOfContinueButtons, defaultContinueButton,
		continueText1, continueText2, continueText3, continueText4, continueText5,
		continueText6, continueText7, continueText8, continueText9, continueText10,
		thePauseFormCancelCallback);
	UiForm_finish (thePauseForm); cherror
	int wasBackgrounding = Melder_backgrounding;
	structMelderDir dir = { { 0 } };
	Melder_getDefaultDir (& dir);
	if (theCurrentPraat -> batch) goto end;
	UiFile_hide ();
	if (wasBackgrounding) praat_foreground ();
	/*
	 * Put the pause form on the screen.
	 */
	UiForm_destroyWhenUnmanaged (thePauseForm);
	UiForm_do (thePauseForm, false);
	/*
	 * Wait for the user to click Stop or Continue.
	 */
	#ifndef CONSOLE_APPLICATION
		thePauseForm_clicked = 0;
		Melder_assert (theEventLoopDepth == 0);
		theEventLoopDepth ++;
		do {
			XEvent event;
			XtAppNextEvent (Melder_appContext, & event);
			XtDispatchEvent (& event);
		} while (! thePauseForm_clicked);
		theEventLoopDepth --;
		if (wasBackgrounding) praat_background ();
		Melder_setDefaultDir (& dir);
		/* BUG: should also restore praatP. editor. */
		thePauseForm = NULL;   // undangle
		thePauseFormRadio = NULL;   // undangle
		if (thePauseForm_clicked == -1) {
			Interpreter_stop (interpreter);
			error1 (L"You interrupted the script.");
			//Melder_flushError (NULL);
			//Melder_clearError ();
		}
	#endif
end:
	iferror return 0;
	return thePauseForm_clicked;
}

/* End of file UiPause.c */

