fix error tracking issues with user-defined functions and nested calls

Author: bhaller

EidosScribe/EidosConsoleWindowController.mm

@@ -252,7 +252,7 @@ - (void)validateSymbolTableAndFunctionMap
 - (NSString *)_executeScriptString:(NSString *)scriptString tokenString:(NSString **)tokenString parseString:(NSString **)parseString executionString:(NSString **)executionString errorString:(NSString **)errorString withOptionalSemicolon:(BOOL)semicolonOptional
 {
 	std::string script_string([scriptString UTF8String]);
-	EidosScript script(script_string, -1);	// the position arguments are for debug points in QtSLiM, which are not supported here, so we can just pass -1
+	EidosScript script(script_string);
 	std::string output;
 
 	// Unfortunately, running readFromPopulationFile() is too much of a shock for SLiMgui.  It invalidates variables that are being displayed in
@@ -531,12 +531,14 @@ - (void)executeScriptString:(NSString *)scriptString withOptionalSemicolon:(BOOL
 			[outputTextView appendSpacer];
 		}
 
-		if (errorString && !gEidosErrorContext.executingRuntimeScript &&
+		// If we have an error, it is in the user script, and it has a valid position, then we can try to
+		// highlight it in the input.  Note that gEidosErrorContext.currentScript is nullptr in the console.
+		if (errorString &&
+			(!gEidosErrorContext.currentScript || (gEidosErrorContext.currentScript->UserScriptUTF16Offset() == 0)) &&
 			(gEidosErrorContext.errorPosition.characterStartOfErrorUTF16 >= 0) &&
 			(gEidosErrorContext.errorPosition.characterEndOfErrorUTF16 >= gEidosErrorContext.errorPosition.characterStartOfErrorUTF16) &&
 			(scriptRange.location != NSNotFound))
 		{
-			// An error occurred, so let's try to highlight it in the input
 			int errorTokenStart = gEidosErrorContext.errorPosition.characterStartOfErrorUTF16 + (int)scriptRange.location;
 			int errorTokenEnd = gEidosErrorContext.errorPosition.characterEndOfErrorUTF16 + (int)scriptRange.location;
 
@@ -592,8 +594,8 @@ - (BOOL)validateMenuItem:(NSMenuItem *)menuItem
 - (BOOL)checkScriptSuppressSuccessResponse:(BOOL)suppressSuccessResponse
 {
 	NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
-	NSString *currentScriptString = [scriptTextView string];
-	const char *cstr = [currentScriptString UTF8String];
+	NSString *scriptString = [scriptTextView string];
+	const char *cstr = [scriptString UTF8String];
 	NSString *errorDiagnostic = nil;
 
 	if (!cstr)
@@ -602,7 +604,7 @@ - (BOOL)checkScriptSuppressSuccessResponse:(BOOL)suppressSuccessResponse
 	}
 	else
 	{
-		EidosScript script(cstr, -1);
+		EidosScript script(cstr);
 
 		try {
 			script.Tokenize();
@@ -685,9 +687,9 @@ - (IBAction)prettyprintScript:(id)sender
 		if ([self checkScriptSuppressSuccessResponse:YES])
 		{
 			// We know the script is syntactically correct, so we can tokenize and parse it without worries
-			NSString *currentScriptString = [scriptTextView string];
-			const char *cstr = [currentScriptString UTF8String];
-			EidosScript script(cstr, -1);
+			NSString *scriptString = [scriptTextView string];
+			const char *cstr = [scriptString UTF8String];
+			EidosScript script(cstr);
 
 			script.Tokenize(false, true);	// get whitespace and comment tokens
 

EidosScribe/EidosTextView.mm

@@ -154,7 +154,7 @@ - (void)insertText:(id)insertString replacementRange:(NSRange)replacementRange
 			// because of strings, which are a pain in the butt.  To simplify that issue, we tokenize and search
 			// in the token stream parallel to searching in the text.
 			std::string script_string([scriptString UTF8String]);
-			EidosScript script(script_string, -1);
+			EidosScript script(script_string);
 
 			// Tokenize
 			script.Tokenize(true, true);	// make bad tokens as needed, keep nonsignificant tokens
@@ -766,9 +766,9 @@ - (BOOL)validateMenuItem:(NSMenuItem *)menuItem
 
 - (void)selectErrorRange
 {
-	// If there is error-tracking information set, and the error is not attributed to a runtime script
-	// such as a lambda or a callback, then we can highlight the error range
-	if (!gEidosErrorContext.executingRuntimeScript &&
+	// If there is error-tracking information set, and the error is attributed to the user script,
+	// then we can highlight the error range
+	if ((!gEidosErrorContext.currentScript || (gEidosErrorContext.currentScript->UserScriptUTF16Offset() == 0)) &&
 		(gEidosErrorContext.errorPosition.characterStartOfErrorUTF16 >= 0) &&
 		(gEidosErrorContext.errorPosition.characterEndOfErrorUTF16 >= gEidosErrorContext.errorPosition.characterStartOfErrorUTF16))
 	{
@@ -783,7 +783,7 @@ - (void)selectErrorRange
 
 	// In any case, since we are the ultimate consumer of the error information, we should clear out
 	// the error state to avoid misattribution of future errors
-	gEidosErrorContext = EidosErrorContext{{-1, -1, -1, -1}, nullptr, false};
+	ClearErrorContext();
 }
 
 - (void)setSelectedRanges:(NSArray *)ranges affinity:(NSSelectionAffinity)affinity stillSelecting:(BOOL)stillSelectingFlag
@@ -957,7 +957,7 @@ - (NSRange)selectionRangeForProposedRange:(NSRange)proposedCharRange granularity
 						// because of strings, which are a pain in the butt.  To simplify that issue, we tokenize and search
 						// in the token stream parallel to searching in the text.
 						std::string script_string([scriptString UTF8String]);
-						EidosScript script(script_string, -1);
+						EidosScript script(script_string);
 
 						// Tokenize
 						script.Tokenize(true, true);	// make bad tokens as needed, keep nonsignificant tokens
@@ -1091,7 +1091,7 @@ - (void)syntaxColorForEidos
 	// Construct a Script object from the current script string
 	NSString *scriptString = [self string];
 	std::string script_string([scriptString UTF8String]);
-	EidosScript script(script_string, -1);
+	EidosScript script(script_string);
 
 	// Tokenize
 	script.Tokenize(true, true);	// make bad tokens as needed, keep nonsignificant tokens
@@ -1459,7 +1459,7 @@ - (EidosFunctionMap *)functionMapForScriptString:(NSString *)scriptString includ
 	// This returns a function map (owned by the caller) that reflects the best guess we can make, incorporating
 	// any functions known to our delegate, as well as all functions we can scrape from the script string.
 	std::string script_string([scriptString UTF8String]);
-	EidosScript script(script_string, -1);
+	EidosScript script(script_string);
 
 	// Tokenize
 	script.Tokenize(true, false);	// make bad tokens as needed, don't keep nonsignificant tokens
@@ -1516,7 +1516,7 @@ - (NSAttributedString *)attributedSignatureForScriptString:(NSString *)scriptStr
 	if ([scriptString length])
 	{
 		std::string script_string([scriptString UTF8String]);
-		EidosScript script(script_string, -1);
+		EidosScript script(script_string);
 
 		// Tokenize
 		script.Tokenize(true, false);	// make bad tokens as needed, don't keep nonsignificant tokens
@@ -2318,7 +2318,7 @@ - (void)_completionHandlerWithRangeForCompletion:(NSRange *)baseRange completion
 			delete definitive_function_map;
 
 			// Next, add type table entries based on parsing and analysis of the user's code
-			EidosScript script(script_string, -1);
+			EidosScript script(script_string);
 
 #if EIDOS_DEBUG_COMPLETION
 			std::cout << "Eidos script:\n" << script_string << std::endl << std::endl;
@@ -2343,7 +2343,7 @@ - (void)_completionHandlerWithRangeForCompletion:(NSRange *)baseRange completion
 #endif
 
 		// Tokenize; we can't use the tokenization done above, as we want whitespace tokens here...
-		EidosScript script(script_string, -1);
+		EidosScript script(script_string);
 		script.Tokenize(true, true);	// make bad tokens as needed, keep nonsignificant tokens
 
 #if EIDOS_DEBUG_COMPLETION

QtSLiM/QtSLiMConsoleTextEdit.cpp

@@ -210,11 +210,12 @@ void QtSLiMConsoleTextEdit::appendExecution(QString result, QString errorString,
         textCursor().setBlockFormat(marginBlockFormat);
         insertPlainText(errorString);
 
-        if (!gEidosErrorContext.executingRuntimeScript &&
-                (gEidosErrorContext.errorPosition.characterStartOfErrorUTF16 >= 0) &&
-                (gEidosErrorContext.errorPosition.characterEndOfErrorUTF16 >= gEidosErrorContext.errorPosition.characterStartOfErrorUTF16))
+		// If we have an error, it is in the user script, and it has a valid position,
+		// then we can try to highlight it in the input
+        if ((!gEidosErrorContext.currentScript || (gEidosErrorContext.currentScript->UserScriptUTF16Offset() == 0)) &&
+            (gEidosErrorContext.errorPosition.characterStartOfErrorUTF16 >= 0) &&
+            (gEidosErrorContext.errorPosition.characterEndOfErrorUTF16 >= gEidosErrorContext.errorPosition.characterStartOfErrorUTF16))
 		{
-			// An error occurred, so let's try to highlight it in the input
             int promptEnd = lastPromptCursor.position();
 			int errorTokenStart = gEidosErrorContext.errorPosition.characterStartOfErrorUTF16 + promptEnd;
 			int errorTokenEnd = gEidosErrorContext.errorPosition.characterEndOfErrorUTF16 + promptEnd;

QtSLiM/QtSLiMEidosConsole.cpp

@@ -282,7 +282,7 @@ QString QtSLiMEidosConsole::_executeScriptString(QString scriptString, QString *
     scriptString.replace(QChar::LineSeparator, "\n");
 
     std::string script_string(scriptString.toStdString());
-	EidosScript script(script_string, -1);
+	EidosScript script(script_string);
 	std::string output;
 
 	// Unfortunately, running readFromPopulationFile() is too much of a shock for SLiMgui.  It invalidates variables that are being displayed in

QtSLiM/QtSLiMEidosPrettyprinter.cpp

@@ -759,7 +759,7 @@ bool Eidos_reformatTokensFromScript(const std::vector<EidosToken> &tokens, Eidos
     // We're done reformatting; now we need to generate a new script and a new token stream, and fix the indentation of our
     // reformatted string by calling Eidos_prettyprintTokensFromScript(); this avoids duplicating a bunch of logic
     try {
-        EidosScript indentScript(pretty, -1);
+        EidosScript indentScript(pretty);
 
         indentScript.Tokenize(false, true);	// get whitespace and comment tokens
 

QtSLiM/QtSLiMScriptTextEdit.cpp

@@ -221,10 +221,14 @@ void QtSLiMTextEdit::highlightError(int startPosition, int endPosition)
 
 void QtSLiMTextEdit::selectErrorRange(EidosErrorContext &errorContext)
 {
-	// If there is error-tracking information set, and the error is not attributed to a runtime script
-	// such as a lambda or a callback, then we can highlight the error range
-	if (!errorContext.executingRuntimeScript && (errorContext.errorPosition.characterStartOfErrorUTF16 >= 0) && (errorContext.errorPosition.characterEndOfErrorUTF16 >= errorContext.errorPosition.characterStartOfErrorUTF16))
-        highlightError(errorContext.errorPosition.characterStartOfErrorUTF16, errorContext.errorPosition.characterEndOfErrorUTF16 + 1);
+    // If there is error-tracking information set, and the error is attributed to the user script,
+    // then we can highlight the error range
+    if ((!gEidosErrorContext.currentScript || (gEidosErrorContext.currentScript->UserScriptUTF16Offset() == 0)) &&
+        (errorContext.errorPosition.characterStartOfErrorUTF16 >= 0) &&
+        (errorContext.errorPosition.characterEndOfErrorUTF16 >= errorContext.errorPosition.characterStartOfErrorUTF16))
+    {
+		highlightError(errorContext.errorPosition.characterStartOfErrorUTF16, errorContext.errorPosition.characterEndOfErrorUTF16 + 1);
+    }
 }
 
 QPalette QtSLiMTextEdit::qtslimStandardPalette(void)
@@ -288,8 +292,7 @@ bool QtSLiMTextEdit::checkScriptSuppressSuccessResponse(bool suppressSuccessResp
 {
 	// Note this does *not* check out scriptString, which represents the state of the script when the Community object was created
 	// Instead, it checks the current script in the script TextView – which is not used for anything until the recycle button is clicked.
-	QString currentScriptString = toPlainText();
-    QByteArray utf8bytes = currentScriptString.toUtf8();
+    QByteArray utf8bytes = toPlainText().toUtf8();
 	const char *cstr = utf8bytes.constData();
 	std::string errorDiagnostic;
 
@@ -301,7 +304,7 @@ bool QtSLiMTextEdit::checkScriptSuppressSuccessResponse(bool suppressSuccessResp
 	{
         if (scriptType == EidosScriptType)
         {
-            EidosScript script(cstr, -1);
+            EidosScript script(cstr);
 
             try {
                 script.Tokenize();
@@ -342,7 +345,7 @@ bool QtSLiMTextEdit::checkScriptSuppressSuccessResponse(bool suppressSuccessResp
 
             EidosErrorContext errorContext = gEidosErrorContext;
 
-            gEidosErrorContext = EidosErrorContext{{-1, -1, -1, -1}, nullptr, false};
+            ClearErrorContext();
 
             selectErrorRange(errorContext);
 
@@ -406,10 +409,9 @@ void QtSLiMTextEdit::_prettyprint_reformat(bool p_reformat)
 		if (checkScriptSuppressSuccessResponse(true))
 		{
 			// We know the script is syntactically correct, so we can tokenize and parse it without worries
-            QString currentScriptString = toPlainText();
-            QByteArray utf8bytes = currentScriptString.toUtf8();
+            QByteArray utf8bytes = toPlainText().toUtf8();
             const char *cstr = utf8bytes.constData();
-			EidosScript script(cstr, -1);
+			EidosScript script(cstr);
 
 			script.Tokenize(false, true);	// get whitespace and comment tokens
 
@@ -736,7 +738,7 @@ EidosFunctionMap *QtSLiMTextEdit::functionMapForScriptString(QString scriptStrin
 	// This returns a function map (owned by the caller) that reflects the best guess we can make, incorporating
 	// any functions known to our delegate, as well as all functions we can scrape from the script string.
 	std::string script_string = scriptString.toStdString();
-	EidosScript script(script_string, -1);
+	EidosScript script(script_string);
 
 	// Tokenize
 	script.Tokenize(true, false);	// make bad tokens as needed, don't keep nonsignificant tokens
@@ -825,7 +827,7 @@ EidosCallSignature_CSP QtSLiMTextEdit::signatureForScriptSelection(QString &call
     if (scriptString.length())
 	{
 		std::string script_string = scriptString.toStdString();
-		EidosScript script(script_string, -1);
+		EidosScript script(script_string);
 
 		// Tokenize
 		script.Tokenize(true, false);	// make bad tokens as needed, don't keep nonsignificant tokens
@@ -2323,7 +2325,7 @@ void QtSLiMTextEdit::_completionHandlerWithRangeForCompletion(NSRange *baseRange
 			delete definitive_function_map;
 
 			// Next, add type table entries based on parsing and analysis of the user's code
-			EidosScript script(script_string, -1);
+			EidosScript script(script_string);
 
 			script.Tokenize(true, false);					// make bad tokens as needed, do not keep nonsignificant tokens
 			script.ParseInterpreterBlockToAST(true, true);	// make bad nodes as needed (i.e. never raise, and produce a correct tree)
@@ -2334,7 +2336,7 @@ void QtSLiMTextEdit::_completionHandlerWithRangeForCompletion(NSRange *baseRange
 		}
 
 		// Tokenize; we can't use the tokenization done above, as we want whitespace tokens here...
-		EidosScript script(script_string, -1);
+		EidosScript script(script_string);
 		script.Tokenize(true, true);	// make bad tokens as needed, keep nonsignificant tokens
 
 		const std::vector<EidosToken> &tokens = script.Tokens();

QtSLiM/QtSLiMSyntaxHighlighting.cpp

@@ -200,7 +200,7 @@ void QtSLiMScriptHighlighter::highlightBlock(__attribute__((__unused__)) const Q
     // set up a new cached script if we don't have one
     if (!script)
     {
-        script = new EidosScript(document()->toPlainText().toUtf8().constData(), -1);
+        script = new EidosScript(document()->toPlainText().toUtf8().constData());
 
         script->Tokenize(true, true);	// make bad tokens as needed, keep nonsignificant tokens
 

QtSLiM/QtSLiMWindow.cpp

@@ -1217,9 +1217,9 @@ bool QtSLiMWindow::isScriptModified(void)
     if (scriptChangeObserved)
         return true;
 
-    QString currentScript = ui->scriptTextEdit->toPlainText();
+    QString curScriptString = ui->scriptTextEdit->toPlainText();
 
-    if (lastSavedString != currentScript)
+    if (lastSavedString != curScriptString)
     {
         scriptChangeObserved = true;    // sticky until saved
         return true;
@@ -2155,7 +2155,7 @@ void QtSLiMWindow::checkForSimulationTermination(void)
         // Get the error position and clear the global
         EidosErrorContext errorContext = gEidosErrorContext;
 
-        gEidosErrorContext = EidosErrorContext{{-1, -1, -1, -1}, nullptr, false};
+        ClearErrorContext();
 
         // Send the signal, which connects up to QtSLiMWindow::showTerminationMessage() through a Qt::QueuedConnection
         emit terminationWithMessage(message, errorContext);
@@ -2275,7 +2275,7 @@ void QtSLiMWindow::startNewSimulationFromScript(void)
         {
             Species *species = (block->species_spec_ ? block->species_spec_ : (block->ticks_spec_ ? block->ticks_spec_ : nullptr));
 
-            if (species && (block->user_script_line_offset_ != -1) && block->root_node_ && block->root_node_->token_)
+            if (species && !block->script_ && block->root_node_ && block->root_node_->token_)
             {
                 EidosToken *block_root_token = block->root_node_->token_;
                 int startPos = block_root_token->token_UTF16_start_;
@@ -2831,7 +2831,7 @@ void QtSLiMWindow::updateAfterTickFull(bool fullUpdate)
             gEidosTermination.clear();
             gEidosTermination.str("");
             gEidosTermination << "ERROR (Eidos_FlushFiles): A compressed file buffer failed to write out to disk.  Please check file paths, filesystem writeability and permissions, available disk space, and other possible causes of file I/O problems.\n";
-            gEidosErrorContext = EidosErrorContext{{-1, -1, -1, -1}, nullptr, false};
+            ClearErrorContext();
         }
     }
 
@@ -5441,8 +5441,8 @@ void QtSLiMWindow::debugOutputClicked(void)
 void QtSLiMWindow::jumpToPopupButtonRunMenu(void)
 {
     QPlainTextEdit *scriptTE = ui->scriptTextEdit;
-    QString currentScriptString = scriptTE->toPlainText();
-    QByteArray utf8bytes = currentScriptString.toUtf8();
+    QString jumpScriptString = scriptTE->toPlainText();
+    QByteArray utf8bytes = jumpScriptString.toUtf8();
 	const char *cstr = utf8bytes.constData();
     bool failedParse = true;
 
@@ -5664,7 +5664,7 @@ void QtSLiMWindow::jumpToPopupButtonRunMenu(void)
                 SLiMEidosBlock *new_script_block = new SLiMEidosBlock(script_block_node);
                 int32_t decl_start = new_script_block->root_node_->token_->token_UTF16_start_;
                 int32_t code_start = new_script_block->compound_statement_node_->token_->token_UTF16_start_;
-                QString decl = currentScriptString.mid(decl_start, code_start - decl_start);
+                QString decl = jumpScriptString.mid(decl_start, code_start - decl_start);
 
                 // Remove everything including and after the first newline
                 if (decl.indexOf(QChar::LineFeed) != -1)
@@ -5788,8 +5788,8 @@ void QtSLiMWindow::setScriptBlockLabelTextFromSelection(void)
     // this does a subset of the parsing logic of QtSLiMWindow::jumpToPopupButtonRunMenu()
     // it is used to get the label text for the script block label, to the right of the Jump button
     QPlainTextEdit *scriptTE = ui->scriptTextEdit;
-    QString currentScriptString = scriptTE->toPlainText();
-    QByteArray utf8bytes = currentScriptString.toUtf8();
+    QString curScriptString = scriptTE->toPlainText();
+    QByteArray utf8bytes = curScriptString.toUtf8();
     const char *cstr = utf8bytes.constData();
 
     QTextCursor selection_cursor(scriptTE->textCursor());
@@ -5851,7 +5851,7 @@ void QtSLiMWindow::setScriptBlockLabelTextFromSelection(void)
                 if ((selStart >= decl_start) && (selStart <= code_end) && (selEnd <= code_end + 2))     // +2 allows a selection through the end brace and one more character (typically a newline)
                 {
                     int32_t code_start = new_script_block->compound_statement_node_->token_->token_UTF16_start_;
-                    QString decl = currentScriptString.mid(decl_start, code_start - decl_start);
+                    QString decl = curScriptString.mid(decl_start, code_start - decl_start);
 
                     // Remove everything including and after the first newline
                     if (decl.indexOf(QChar::LineFeed) != -1)