/* Manual.c
 *
 * Copyright (C) 1996-2003 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 2002/05/28
 * pb 2003/03/09 searching: more points for multiple occurrences within a paragraph
 */

#include <ctype.h>
#include "Manual.h"
#include "Printer.h"
#include "machine.h"
#include "site.h"
#include <time.h>
#include "EditorM.h"
extern int praat_executeFromFile (const char *nameAndArguments);   /* BUG? */

/* Remaining BUGS: HTML writer does not recognize "\s{". */

#define SEARCH_PAGE  0
#if defined (_WIN32)
	#define SOUND_WIDTH  35
	#define SOUND_X  140
	#define SEARCH_SPACING  22
	#define SEARCH_WIDTH  70
	#define SEARCH_COLUMNS  26
	#define STRING_SPACING 2
#elif defined (macintosh)
	#define SOUND_WIDTH  25
	#define SOUND_X  140
	#define SEARCH_SPACING  18
	#define SEARCH_WIDTH  70
	#define SEARCH_COLUMNS  30
	#define STRING_SPACING 6
#else
	#define SOUND_WIDTH  50
	#define SOUND_X  170
	#define SEARCH_SPACING  28
	#define SEARCH_WIDTH  80
	#define SEARCH_COLUMNS  30
	#define STRING_SPACING 2
#endif

static const char *month [] =
	{ "", "January", "February", "March", "April", "May", "June",
	  "July", "August", "September", "October", "November", "December" };

FORM_WRITE (Manual, cb_writeOneToHtmlFile, "Write to HTML file", 0)
	ManPages manPages = my data;
	char *p = defaultName;
	strcpy (defaultName, ((ManPage) manPages -> pages -> item [my path]) -> title);
	while (*p) { if (! isalnum (*p) && *p != '_') *p = '_'; p ++; }
	strcat (defaultName, ".html");
DO_WRITE
	if (! ManPages_writeOneToHtmlFile (my data, my path, file)) return 0;
END

FORM (Manual, cb_writeAllToHtmlDir, "Write all pages as HTML files", 0)
	LABEL ("", "Type a directory name:")
	TEXTFIELD ("directory", "")
	OK
struct MelderDir currentDirectory;
Melder_getDefaultDir (& currentDirectory);
SET_STRING ("directory", Melder_dirToPath (& currentDirectory))
DO
	char *directory = GET_STRING ("directory");
	if (! ManPages_writeAllToHtmlDir (my data, directory)) return 0;
END

FORM (Manual, cb_searchForPageList, "Search for page", 0)
	{ ManPages manPages = my data;
	long numberOfPages;
	const char **pages = ManPages_getTitles (manPages, & numberOfPages);
	LIST ("Page", manPages -> pages -> size, pages, 1) }
	OK
DO
	if (! HyperPage_goToPage_i (me, GET_INTEGER ("Page"))) return 0;
END

static void destroy (I) {
	iam (Manual);
	ManPages pages = my data;
	if (pages && pages -> dynamic) forget (pages);
	inherited (Manual) destroy (me);
}

static void draw (I) {
	iam (Manual);
	ManPages manPages = my data;
	ManPage page;
	ManPage_Paragraph paragraph;
	if (my path == SEARCH_PAGE) {
		int i;
		HyperPage_pageTitle (me, "Best matches");
		HyperPage_intro (me, "The best matches to your query seem to be:");
		for (i = 1; i <= my numberOfMatches; i ++) {
			char link [300];
			page = manPages -> pages -> item [my matches [i]];
			sprintf (link, "\\bu @@%s", page -> title);
			HyperPage_listItem (me, link);
		}
		return;
	}
	page = manPages -> pages -> item [my path];
	if (! my paragraphs) return;
	HyperPage_pageTitle (me, page -> title);
	for (paragraph = & page -> paragraphs [0]; paragraph -> type != 0; paragraph ++) {
		switch (paragraph -> type) {
			case  enumi (ManPage_TYPE, intro): HyperPage_intro (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, entry): HyperPage_entry (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, normal): HyperPage_paragraph (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, list_item): HyperPage_listItem (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, tag): HyperPage_listTag (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, definition): HyperPage_definition (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, code): HyperPage_code (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, prototype): HyperPage_prototype (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, formula): HyperPage_formula (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, picture): HyperPage_picture (me, paragraph -> width,
				paragraph -> height, paragraph -> draw); break;
			case  enumi (ManPage_TYPE, list_item1): HyperPage_listItem1 (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, list_item2): HyperPage_listItem2 (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, list_item3): HyperPage_listItem3 (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, tag1): HyperPage_listTag1 (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, tag2): HyperPage_listTag2 (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, tag3): HyperPage_listTag3 (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, definition1): HyperPage_definition1 (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, definition2): HyperPage_definition2 (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, definition3): HyperPage_definition3 (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, code1): HyperPage_code1 (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, code2): HyperPage_code2 (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, code3): HyperPage_code3 (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, code4): HyperPage_code4 (me, paragraph -> text); break;
			case  enumi (ManPage_TYPE, code5): HyperPage_code5 (me, paragraph -> text); break;
			default: break;
		}
	}
	if (ManPages_uniqueLinksHither (manPages, my path)) {
		long ilink, jlink, lastParagraph = 0;
		int goAhead = TRUE;
		while (page -> paragraphs [lastParagraph]. type != 0) lastParagraph ++;
		if (lastParagraph > 0) {
			const char *text = page -> paragraphs [lastParagraph - 1]. text;
			if (text == NULL || text [0] == '\0' || text [strlen (text) - 1] != ':')
				if (my printing && my suppressLinksHither)
					goAhead = FALSE;
				else
					HyperPage_entry (me, "Links to this page");
		}
		if (goAhead) for (ilink = 1; ilink <= page -> nlinksHither; ilink ++) {
			long link = page -> linksHither [ilink];
			int alreadyShown = FALSE;
			for (jlink = 1; jlink <= page -> nlinksThither; jlink ++)
				if (page -> linksThither [jlink] == link)
					alreadyShown = TRUE;
			if (! alreadyShown) {
				char linkText [304];
				sprintf (linkText, "@@%s@",
					((ManPage) manPages -> pages -> item [page -> linksHither [ilink]]) -> title);
				HyperPage_listItem (me, linkText);
			}
		}
	}
	if (! my printing && page -> date) {
		char signature [100];
		long date = page -> date;
		int imonth = date % 10000 / 100;
		if (imonth < 0 || imonth > 12) imonth = 0;
		sprintf (signature, "\\co %s, %s %ld, %ld", page -> author,
			month [imonth], date % 100, date / 10000);
		HyperPage_any (me, "", my font, my fontSize, 0, 0.0,
			0.0, 0.0, 0.1, 0.1, HyperPage_ADD_BORDER);
		HyperPage_any (me, signature, my font, my fontSize, Graphics_ITALIC, 0.0,
			0.03, 0.0, 0.1, 0.0, 0);
	}
}

/********** PRINTING **********/

static void print (I, Graphics graphics) {
	iam (Manual);
	/*ManPages manPages = my data;*/
	int /*numberOfPages = manPages -> pages -> size,*/ savePage = my path;
	long ipage;
	my ps = graphics;
	Graphics_setDollarSignIsCode (my ps, TRUE);
	Graphics_setAtSignIsLink (my ps, TRUE);
	my printing = TRUE;
	HyperPage_initSheetOfPaper ((HyperPage) me);
	/*Melder_progress (0.0, "Printing...");*/
	for (ipage = my fromPage; ipage <= my toPage; ipage ++) {
		/*ManPage page = manPages -> pages -> item [ipage];*/
		our goToPage_i (me, ipage);
		our draw (me);
		our goToPage_i (me, savePage);
		/*
		 * Guard against the non-reentrance of our draw ().
		 */
		my printing = FALSE;
		/*if (! Melder_progress ((double) ipage / numberOfPages, "%s", page -> title)) break;*/
		my printing = TRUE;
	}
	my printing = FALSE;
	/*Melder_progress (1.0, NULL);*/
}

FORM (Manual, cb_printRange, "Print range", 0)
	SENTENCE ("Left or inside header", "")
	SENTENCE ("Middle header", "")
	LABEL ("", "Right or outside header:")
	TEXTFIELD ("Right or outside header", "Manual")
	SENTENCE ("Left or inside footer", "")
	SENTENCE ("Middle footer", "")
	SENTENCE ("Right or outside footer", "")
	BOOLEAN ("Mirror even/odd headers", TRUE)
	INTEGER ("From manual page number", "1")
	INTEGER ("To manual page number", "100")
	INTEGER ("First paper page number", "1")
	BOOLEAN ("Suppress \"Links to this page\"", FALSE)
	OK
ManPages manPages = my data;
time_t today = time (NULL);
#ifdef UNIX
	{ struct tm *tm = localtime (& today); char date [50]; strftime (date, 50, "%B %e, %Y", tm);
	SET_STRING ("Left or inside header", date) }
#else
	SET_STRING ("Left or inside header", ctime (& today))
#endif
SET_INTEGER ("To manual page number", manPages -> pages -> size)
if (my pageNumber) SET_INTEGER ("First paper page number", my pageNumber + 1)
DO
	ManPages manPages = my data;
	int numberOfPages = manPages -> pages -> size /*, savePage = my path*/;
	my insideHeader = GET_STRING ("Left or inside header");
	my middleHeader = GET_STRING ("Middle header");
	my outsideHeader = GET_STRING ("Right or outside header");
	my insideFooter = GET_STRING ("Left or inside footer");
	my middleFooter = GET_STRING ("Middle footer");
	my outsideFooter = GET_STRING ("Right or outside footer");
	my mirror = GET_INTEGER ("Mirror even/odd headers");
	my fromPage = GET_INTEGER ("From manual page number");
	my toPage = GET_INTEGER ("To manual page number");
	if (my fromPage < 1) my fromPage = 1;
	if (my toPage > numberOfPages) my toPage = numberOfPages;
	if (my toPage < my fromPage) return Melder_error ("No pages to print.");
	my pageNumber = GET_INTEGER ("First paper page number");
	my suppressLinksHither = GET_INTEGER ("Suppress \"Links to this page\"");
	Printer_print (print, me);
END

#if 0
FORM (Manual, cb_printRangeToFile, "Print range to file", 0)
	addLayoutFields (cmd);
	LABEL ("", "Print to PostScript file:")
	TEXTFIELD ("fileName", "manual.ps")
	OK
struct MelderDir dir;
char fileName [300];
int length;
setLayoutFields (me, cmd);
Melder_getDefaultDir (& dir);
strcpy (fileName, Melder_dirToPath (& dir));
length = strlen (fileName);
#ifndef macintosh
	fileName [length ++] = Melder_DIRECTORY_SEPARATOR;
#endif
strcpy (fileName + length, "manual.ps");
SET_STRING ("fileName", fileName)
DO
	char *fileName = GET_STRING ("fileName");   /* BUG: must use UiFileSelector */
	struct MelderFile file;
	if (! Melder_relativePathToFile (fileName, & file)) return 0;
	if (! printFromDialog (me, cmd, & file)) return 0;
END
#endif

/********** SEARCHING **********/

static float *goodnessOfMatch;

static float searchToken (ManPages me, long ipage, char *token) {
	double goodness = 0.0;
	ManPage page = my pages -> item [ipage];
	struct ManPage_Paragraph *par = & page -> paragraphs [0];
	char *p;
	if (! token [0]) return 1.0;
	/*
	 * Try to find a match in the title, case insensitively.
	 */
	strcpy (Melder_buffer1, page -> title);
	for (p = & Melder_buffer1 [0]; *p != '\0'; p ++) *p = tolower (*p);
	if (strstr (Melder_buffer1, token))
		goodness += 300.0;   /* Lots of points for a match in the title! */
	/*
	 * Try to find a match in the paragraphs, case-insensitively.
	 */
	while (par -> type) {
		if (par -> text) {
			char *ptoken;
			strcpy (Melder_buffer1, par -> text);
			for (p = & Melder_buffer1 [0]; *p != '\0'; p ++) *p = tolower (*p);
			ptoken = strstr (Melder_buffer1, token);
			if (ptoken) {
				goodness += 10.0;   /* Ten points for every paragraph with a match! */
				if (strstr (ptoken + strlen (token), token)) {
					goodness += 1.0;   /* One point for every second occurrence in a paragraph! */
				}
			}
		}
		par ++;
	}
	return goodness;
}

static void search (Manual me, const char *query) {
	ManPages manPages = my data;
	long numberOfPages = manPages -> pages -> size, ipage, imatch;
	char searchText [200], *p;
	strcpy (searchText, query);
	for (p = & searchText [0]; *p != '\0'; p ++) {
		if (*p == '\n') *p = ' ';
		*p = tolower (*p);
	}
	if (! goodnessOfMatch && ! (goodnessOfMatch = NUMfvector (1, numberOfPages)))
		{ Melder_flushError (NULL); return; }
	for (ipage = 1; ipage <= numberOfPages; ipage ++) {
		char *token = searchText;
		goodnessOfMatch [ipage] = 1.0;
		for (;;) {
			char *space = strchr (token, ' ');
			if (space) *space = '\0';
			goodnessOfMatch [ipage] *= searchToken (manPages, ipage, token);
			if (! space) break;
			*space = ' ';   /* Restore. */
			token = space + 1;
		}
	}
	/*
	 * Find the 20 best matches.
	 */
	my numberOfMatches = 0;
	for (imatch = 1; imatch <= 20; imatch ++) {
		long imax = 0;
		float max = 0.0;
		for (ipage = 1; ipage <= numberOfPages; ipage ++) {
			if (goodnessOfMatch [ipage] > max) {
				max = goodnessOfMatch [ipage];
				imax = ipage;
			}
		}
		if (! imax) break;
		my matches [++ my numberOfMatches] = imax;
		goodnessOfMatch [imax] = 0.0;   /* Skip next time. */
	}
	if (! HyperPage_goToPage_i (me, SEARCH_PAGE)) Melder_flushError (NULL);
}

void Manual_search (Manual me, const char *query) {
	XmTextFieldSetString (my searchText, MOTIF_CONST_CHAR_ARG (query));
	search (me, query);
}

MOTIF_CALLBACK (cb_record)
	iam (Manual);
	XtSetSensitive (my recordButton, False);
	XtSetSensitive (my playButton, False);
	XtSetSensitive (my publishButton, False);
	XmUpdateDisplay (my shell);
	Melder_record (1.0);
	XtSetSensitive (my recordButton, True);
	XtSetSensitive (my playButton, True);
	XtSetSensitive (my publishButton, True);
MOTIF_CALLBACK_END

MOTIF_CALLBACK (cb_play)
	iam (Manual);
	XtSetSensitive (my recordButton, False);
	XtSetSensitive (my playButton, False);
	XtSetSensitive (my publishButton, False);
	XmUpdateDisplay (my shell);
	Melder_play ();
	XtSetSensitive (my recordButton, True);
	XtSetSensitive (my playButton, True);
	XtSetSensitive (my publishButton, True);
MOTIF_CALLBACK_END

MOTIF_CALLBACK (cb_publish)
	Melder_publishPlayed ();
MOTIF_CALLBACK_END

MOTIF_CALLBACK (cb_search)
	iam (Manual);
	char *query = XmTextFieldGetString (my searchText);
	search (me, query);
	XtFree (query);
MOTIF_CALLBACK_END

static void createChildren (I) {
	iam (Manual);
	ManPages pages = my data;   /* Has been installed here by Editor_init (). */
	Widget button;
	int height = Machine_getTextHeight (), width = SOUND_WIDTH, x = SOUND_X, y = Machine_getMenuBarHeight () + 4;
	inherited (Manual) createChildren (me);
	if (pages -> dynamic) {
		my recordButton = XtVaCreateManagedWidget ("Rec", xmPushButtonWidgetClass, my dialog,
			XmNx, x, XmNy, y, XmNheight, height, XmNwidth, width, 0);
		XtAddCallback (my recordButton, XmNactivateCallback, cb_record, (XtPointer) me);
		my playButton = XtVaCreateManagedWidget ("Play", xmPushButtonWidgetClass, my dialog,
			XmNx, x += width + 1, XmNy, y, XmNheight, height, XmNwidth, width, 0);
		XtAddCallback (my playButton, XmNactivateCallback, cb_play, (XtPointer) me);
		my publishButton = XtVaCreateManagedWidget ("Pub", xmPushButtonWidgetClass, my dialog,
			XmNx, x += width + 1, XmNy, y, XmNheight, height, XmNwidth, width, 0);
		XtAddCallback (my publishButton, XmNactivateCallback, cb_publish, (XtPointer) me);
		x += width;
	}
	x += SEARCH_SPACING;
	width = SEARCH_WIDTH;
	button = XtVaCreateManagedWidget ("Search:", xmPushButtonWidgetClass, my dialog,
		XmNx, x, XmNy, y, XmNheight, height, XmNwidth, width, 0);
	XtAddCallback (button, XmNactivateCallback, cb_search, (XtPointer) me);
	#ifdef _WIN32
	/* BUG: activateCallback should work for texts. */
	XtVaSetValues (my dialog, XmNdefaultButton, button, NULL);
	#endif
	my searchText = XtVaCreateManagedWidget ("searchText", xmTextFieldWidgetClass, my dialog,
		XmNx, x += width + STRING_SPACING, XmNy, y, XmNcolumns, SEARCH_COLUMNS, 0);
	XtAddCallback (my searchText, XmNactivateCallback, cb_search, (XtPointer) me);
}

DIRECT (Manual, cb_help)
	if (! HyperPage_goToPage (me, "Manual")) return 0;
END

static void createMenus (I) {
	iam (Manual);
	inherited (Manual) createMenus (me);

	Editor_addCommand (me, "File", "Print manual...", 0, cb_printRange);
	Editor_addCommand (me, "File", "Write page to HTML file...", 0, cb_writeOneToHtmlFile);
	Editor_addCommand (me, "File", "Write manual to HTML directory...", 0, cb_writeAllToHtmlDir);
	Editor_addCommand (me, "File", "-- close --", 0, NULL);

	Editor_addCommand (me, "Go to", "Search for page (list)...", 0, cb_searchForPageList);

	Editor_addCommand (me, "Help", "Manual help", '?', cb_help);
}

static void defaultHeaders (EditorCommand cmd) {
	Manual me = (Manual) cmd -> editor;
	ManPages manPages = my data;
	if (my path) {
		char string [400];
		static const char *month [] =
			{ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
		ManPage page = manPages -> pages -> item [my path];
		long date = page -> date;
		SET_STRING ("Right or outside header", page -> title)
		SET_STRING ("Left or inside footer", page -> author)
		if (date) {
			sprintf (string, "%s %ld, %ld", month [date % 10000 / 100 - 1], date % 100, date / 10000);
			SET_STRING ("Left or inside header", string)
		}
	}
}

static long getNumberOfPages (I) {
	iam (Manual);
	ManPages manPages = my data;
	return manPages -> pages -> size;
}

static long getCurrentPageNumber (I) {
	iam (Manual);
	return my path ? my path : 1;
}

static int goToPage_i (I, long i) {
	iam (Manual);
	ManPages manPages = my data;
	ManPage page;
	ManPage_Paragraph par;
	if (i < 1 || i > manPages -> pages -> size) {
		if (i == SEARCH_PAGE) {
			my path = SEARCH_PAGE;
			Melder_free (my currentPageTitle);
			return 1;
		} else return Melder_error ("Page %ld not found.", i);
	}
	my path = i;
	page = manPages -> pages -> item [my path];
	my paragraphs = page -> paragraphs;
	my numberOfParagraphs = 0;
	par = my paragraphs;
	while ((par ++) -> type) my numberOfParagraphs ++;
	Melder_free (my currentPageTitle);
	my currentPageTitle = Melder_strdup (page -> title);
	return 1;
}

static int goToPage (I, const char *title) {
	iam (Manual);
	ManPages manPages = my data;
	if (title [0] == '\\' && title [1] == 'F' && title [2] == 'I') {
		struct MelderFile file;
		MelderDir_getFile (& manPages -> rootDirectory, title + 3, & file);
		Melder_recordFromFile (& file);
		return 0;
	} else if (title [0] == '\\' && title [1] == 'S' && title [2] == 'C') {
		struct MelderFile file;
		char path [270];
		MelderDir_getFile (& manPages -> rootDirectory, title + 3, & file);
		sprintf (path, "\"%s\"", Melder_fileToPath (& file));
		if (! praat_executeFromFile (path)) {
			Melder_flushError (NULL);
		}
		return 0;
	} else {
		long i;
		i = ManPages_lookUp (manPages, title);
		if (! i)
			return Melder_error ("Page \"%s\" not found.", title);
		return goToPage_i (me, i);
	}
}

static int hasHistory = TRUE, isOrdered = TRUE, canIndex = TRUE;

class_methods (Manual, HyperPage)
	class_method (destroy)
	us -> scriptable = FALSE;
	class_method (draw)
	class_method (createChildren)
	class_method (createMenus)
	class_method (defaultHeaders)
	class_method (getNumberOfPages)
	class_method (getCurrentPageNumber)
	class_method (goToPage)
	class_method (goToPage_i)
	class_method (hasHistory)
	class_method (isOrdered)
	class_method (canIndex)
class_methods_end

int Manual_init (I, Widget parent, const char *title, Any data) {
	iam (Manual);
	ManPages manPages = data;
	long i;
	ManPage_Paragraph par;
	if (! (i = ManPages_lookUp (manPages, title)))
		return Melder_error ("Page \"%s\" not found.", title);
	my path = i;
	my paragraphs = ((ManPage) manPages -> pages -> item [i]) -> paragraphs;
	my numberOfParagraphs = 0;
	par = my paragraphs;
	while ((par ++) -> type) my numberOfParagraphs ++;

	if (! HyperPage_init (me, parent, "Manual", data)) { forget (me); return 0; }
	my history [0]. page = Melder_strdup (title);   /* BAD */
	return 1;
}

Manual Manual_create (Widget parent, const char *title, Any data) {
	Manual me = new (Manual);
	if (! me || ! Manual_init (me, parent, title, data)) forget (me);
	return me;
}

/* End of file Manual.c */