make code completion on dynamic trait properties work

Author: bhaller

EidosScribe/EidosTextView.mm

@@ -2005,7 +2005,7 @@ - (NSMutableArray *)completionsForKeyPathEndingInTokenIndex:(int)lastDotTokenInd
 		else
 		{
 			// We have a property; look up its signature and get the class
-			const EidosPropertySignature *property_signature = key_path_class->SignatureForProperty(identifier_id);
+			const EidosPropertySignature *property_signature = key_path_class->SignatureForProperty_TYPE_INTERPRETER(identifier_id);
 
 			if (!property_signature)
 				return nil;			// no signature, so the class does not support the property given
@@ -2023,7 +2023,7 @@ - (NSMutableArray *)completionsForKeyPathEndingInTokenIndex:(int)lastDotTokenInd
 	const EidosClass *terminus = key_path_class;
 
 	// First, a sorted list of globals
-	for (auto symbol_sig : *terminus->Properties())
+	for (auto symbol_sig : terminus->Properties_TYPE_INTERPRETER())
 	{
 		if (!symbol_sig->deprecated_)
 			[candidates addObject:[NSString stringWithUTF8String:symbol_sig->property_name_.c_str()]];
@@ -2337,6 +2337,9 @@ - (void)_completionHandlerWithRangeForCompletion:(NSRange *)baseRange completion
 			std::cout << "Eidos AST:\n" << parse_stream.str() << std::endl << std::endl;
 #endif
 
+			// Clear out dynamic property signatures kept by EidosClass, since we're starting a new type-interpretation pass.
+			EidosClass::ClearDynamicSignatures();
+			
 			EidosTypeInterpreter typeInterpreter(script, *typeTablePtr, *functionMapPtr, *callTypeTablePtr);
 
 			typeInterpreter.TypeEvaluateInterpreterBlock_AddArgumentCompletions(&argumentCompletions, script_string.length());	// result not used

QtSLiM/QtSLiMScriptTextEdit.cpp

@@ -1568,7 +1568,7 @@ QStringList QtSLiMTextEdit::completionsForKeyPathEndingInTokenIndexOfTokenStream
 		else
 		{
 			// We have a property; look up its signature and get the class
-			const EidosPropertySignature *property_signature = key_path_class->SignatureForProperty(identifier_id);
+			const EidosPropertySignature *property_signature = key_path_class->SignatureForProperty_TYPE_INTERPRETER(identifier_id);
 
 			if (!property_signature)
 				return QStringList();			// no signature, so the class does not support the property given
@@ -1586,7 +1586,7 @@ QStringList QtSLiMTextEdit::completionsForKeyPathEndingInTokenIndexOfTokenStream
 	const EidosClass *terminus = key_path_class;
 
 	// First, a sorted list of globals
-	for (const auto &symbol_sig : *terminus->Properties())
+	for (const auto &symbol_sig : terminus->Properties_TYPE_INTERPRETER())
     {
         if (!symbol_sig->deprecated_)
             candidates << QString::fromStdString(symbol_sig->property_name_);
@@ -2345,6 +2345,9 @@ void QtSLiMTextEdit::_completionHandlerWithRangeForCompletion(NSRange *baseRange
 			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)
 
+			// Clear out dynamic property signatures kept by EidosClass, since we're starting a new type-interpretation pass.
+			EidosClass::ClearDynamicSignatures();
+			
 			EidosTypeInterpreter typeInterpreter(script, *typeTablePtr, *functionMapPtr, *callTypeTablePtr);
 
 			typeInterpreter.TypeEvaluateInterpreterBlock_AddArgumentCompletions(&argumentCompletions, script_string.length());	// result not used

VERSIONS

@@ -56,6 +56,7 @@ multitrait branch:
 		draw an individual's trait offsets from the trait individual-offset distributions, at the individual's moment of generation
 	add Individual properties for each trait in the individual's species, allowing direct access to the phenotype for each trait in an individual
 	add Species properties for each trait in the species, allowing direct access to traits in this species
+	make code completion work for the new dynamic properties on Species and Individual generated by initializeTrait()
 
 
 version 5.1 (Eidos version 4.1):

core/slim_eidos_block.cpp

@@ -1807,6 +1807,9 @@ const std::vector<EidosPropertySignature_CSP> *SLiMEidosBlock_Class::Properties(
 }
 
 
+#ifdef EIDOS_GUI
+// SLiMTypeTable and SLiMTypeInterpreter are only used in SLiMgui and QtSLiM
+
 //
 //	SLiMTypeTable
 //
@@ -1996,6 +1999,25 @@ EidosTypeSpecifier SLiMTypeInterpreter::_TypeEvaluate_FunctionCall_Internal(std:
 	{
 		_SetTypeForISArgumentOfClass(p_arguments[0], 'i', gSLiM_InteractionType_Class);
 	}
+	else if ((p_function_name == "initializeTrait") && (argument_count >= 1))
+	{
+		EidosASTNode *trait_name_node = p_arguments[0];
+		const EidosToken *trait_name_token = trait_name_node->token_;
+		
+		if (trait_name_token->token_type_ == EidosTokenType::kTokenString)
+		{
+			// initializeTrait() has the side effect of defining dynamic properties on Species and Individual;
+			// we need to set up the information needed to make that work with code completion; we do that
+			// with AddSignatureForProperty_TYPE_INTERPRETER(), a version of AddSignatureForProperty() that
+			// uses scratch space belonging only to us, so we don't interfere with anything in SLiM itself.
+			const std::string &trait_name = trait_name_token->token_string_;
+			EidosPropertySignature_CSP species_signature((new EidosPropertySignature(trait_name, true, kEidosValueMaskObject | kEidosValueMaskSingleton, gSLiM_Trait_Class))->MarkAsDynamicWithOwner("Trait"));
+			EidosPropertySignature_CSP individual_signature((new EidosPropertySignature(trait_name, false, kEidosValueMaskFloat | kEidosValueMaskSingleton))->MarkAsDynamicWithOwner("Trait"));
+			
+			gSLiM_Species_Class->AddSignatureForProperty_TYPE_INTERPRETER(species_signature);
+			gSLiM_Individual_Class->AddSignatureForProperty_TYPE_INTERPRETER(individual_signature);
+		}
+	}
 
 	return ret;
 }
@@ -2053,6 +2075,7 @@ EidosTypeSpecifier SLiMTypeInterpreter::_TypeEvaluate_MethodCall_Internal(const
 	return ret;
 }
 
+#endif // EIDOS_GUI
 
 
 

core/slim_eidos_block.h

@@ -255,6 +255,8 @@ class SLiMEidosBlock_Class : public EidosClass
 	virtual const std::vector<EidosPropertySignature_CSP> *Properties(void) const override;
 };
 
+#ifdef EIDOS_GUI
+// SLiMTypeTable and SLiMTypeInterpreter are only used in SLiMgui and QtSLiM
 
 #pragma mark -
 #pragma mark SLiMTypeTable
@@ -311,6 +313,7 @@ class SLiMTypeInterpreter : public EidosTypeInterpreter
 	virtual EidosTypeSpecifier _TypeEvaluate_MethodCall_Internal(const EidosClass *p_target, const EidosMethodSignature *p_method_signature, const std::vector<EidosASTNode *> &p_arguments) override;
 };
 
+#endif	// EIDOS_GUI
 
 #endif /* defined(__SLiM__slim_script_block__) */
 

core/species_eidos.cpp

@@ -1712,6 +1712,7 @@ EidosValue_SP Species::ExecuteContextFunction_initializeTrait(const std::string
 		}
 		else
 		{
+			// see also SLiMTypeInterpreter::_TypeEvaluate_FunctionCall_Internal(), which also tracks this
 			EidosPropertySignature_CSP signature((new EidosPropertySignature(name, true, kEidosValueMaskObject | kEidosValueMaskSingleton, gSLiM_Trait_Class))->MarkAsDynamicWithOwner("Trait"));
 
 			gSLiM_Species_Class->AddSignatureForProperty(signature);
@@ -1731,7 +1732,8 @@ EidosValue_SP Species::ExecuteContextFunction_initializeTrait(const std::string
 		}
 		else
 		{
-			EidosPropertySignature_CSP signature((new EidosPropertySignature(name, false, kEidosValueMaskFloat | kEidosValueMaskSingleton, gSLiM_Trait_Class))->MarkAsDynamicWithOwner("Trait"));
+			// see also SLiMTypeInterpreter::_TypeEvaluate_FunctionCall_Internal(), which also tracks this
+			EidosPropertySignature_CSP signature((new EidosPropertySignature(name, false, kEidosValueMaskFloat | kEidosValueMaskSingleton))->MarkAsDynamicWithOwner("Trait"));
 
 			gSLiM_Individual_Class->AddSignatureForProperty(signature);
 		}

eidos/eidos_class_Object.cpp

@@ -746,6 +746,57 @@ EidosValue_SP EidosClass::ExecuteMethod_size_length(EidosGlobalStringID p_method
 }
 
 
+#ifdef EIDOS_GUI
+// We provide some support here for EidosTypeInterpreter to make code completion work with dynamic properties
+
+void EidosClass::ClearDynamicSignatures(void)
+{
+	std::vector<EidosClass *> classes = EidosClass::RegisteredClasses(/* p_builtin */ true, /* p_context */ true);
+	
+	for (EidosClass *one_class : classes)
+		one_class->dynamic_property_signatures_.clear();
+}
+
+void EidosClass::AddSignatureForProperty_TYPE_INTERPRETER(EidosPropertySignature_CSP p_property_signature)
+{
+	// if a dynamic property already exists with the given name, we assume it is the same, and just return
+	for (EidosPropertySignature_CSP dynamic_property : dynamic_property_signatures_)
+		if (dynamic_property->property_id_ == p_property_signature->property_id_)
+			return;
+	
+	dynamic_property_signatures_.push_back(p_property_signature);
+}
+
+// This calls Properties() to get the built-in properties, and then adds the dynamic ones
+std::vector<EidosPropertySignature_CSP> EidosClass::Properties_TYPE_INTERPRETER(void) const
+{
+	std::vector<EidosPropertySignature_CSP> properties = *Properties();		// make a local copy for ourselves to modify
+	
+	for (EidosPropertySignature_CSP dynamic_property : dynamic_property_signatures_)
+		properties.push_back(dynamic_property);
+	
+	std::sort(properties.begin(), properties.end(), CompareEidosPropertySignatures);
+	
+	return properties;
+}
+
+// This calls SignatureForProperty(), and then checks the dynamic ones if that failed
+const EidosPropertySignature *EidosClass::SignatureForProperty_TYPE_INTERPRETER(EidosGlobalStringID p_property_id) const
+{
+	const EidosPropertySignature *signature = SignatureForProperty(p_property_id);
+	
+	if (signature)
+		return signature;
+	
+	for (EidosPropertySignature_CSP dynamic_property : dynamic_property_signatures_)
+		if (dynamic_property->property_id_ == p_property_id)
+			return dynamic_property.get();
+	
+	return nullptr;
+}
+
+#endif	// EIDOS_GUI
+
 
 
 

eidos/eidos_class_Object.h

@@ -209,6 +209,25 @@ class EidosClass
 	EidosValue_SP ExecuteMethod_propertySignature(EidosGlobalStringID p_method_id, EidosValue_Object *p_target, const std::vector<EidosValue_SP> &p_arguments, EidosInterpreter &p_interpreter) const;
 	EidosValue_SP ExecuteMethod_methodSignature(EidosGlobalStringID p_method_id, EidosValue_Object *p_target, const std::vector<EidosValue_SP> &p_arguments, EidosInterpreter &p_interpreter) const;
 	EidosValue_SP ExecuteMethod_size_length(EidosGlobalStringID p_method_id, EidosValue_Object *p_target, const std::vector<EidosValue_SP> &p_arguments, EidosInterpreter &p_interpreter) const;
+	
+#ifdef EIDOS_GUI
+	// We provide some support here for EidosTypeInterpreter to make code completion work with dynamic properties
+	
+	// This is scratch space for dynamic property signatures generated as a side effect of type-interpretation
+	std::vector<EidosPropertySignature_CSP> dynamic_property_signatures_;
+	
+	// This clears out dynamic_property_signatures_ for all registered classes, to reset type-interpreter state.
+	static void ClearDynamicSignatures(void);
+	
+	// This adds a signature to the EidosTypeInterpreter scratch space above
+	void AddSignatureForProperty_TYPE_INTERPRETER(EidosPropertySignature_CSP p_property_signature);
+	
+	// This calls Properties() to get the built-in properties, and then adds the dynamic ones
+	std::vector<EidosPropertySignature_CSP> Properties_TYPE_INTERPRETER(void) const;
+	
+	// This calls SignatureForProperty(), and then checks the dynamic ones if that failed
+	const EidosPropertySignature *SignatureForProperty_TYPE_INTERPRETER(EidosGlobalStringID p_property_id) const;
+#endif	// EIDOS_GUI
 };
 
 

eidos/eidos_symbol_table.cpp

@@ -844,6 +844,8 @@ void EidosSymbolTable::PrintSymbolTableChain(std::ostream &p_outstream)
 	p_outstream << "================================================" << std::endl;
 }
 
+#ifdef EIDOS_GUI
+// EidosTypeTable and EidosTypeInterpreter are only used in EidosScribe, SLiMguiLegacy, and QtSLiM
 void EidosSymbolTable::AddSymbolsToTypeTable(EidosTypeTable *p_type_table) const
 {
 	// recurse to get the symbols from our chained symbol table
@@ -863,6 +865,7 @@ void EidosSymbolTable::AddSymbolsToTypeTable(EidosTypeTable *p_type_table) const
 		symbol = slot->next_;
 	}
 }
+#endif	// EIDOS_GUI
 
 // This stream output method for EidosSymbolTable dumps all available symbols
 std::ostream &operator<<(std::ostream &p_outstream, const EidosSymbolTable &p_symbols)

eidos/eidos_symbol_table.h

@@ -217,8 +217,11 @@ class EidosSymbolTable
 	void PrintSymbolTable(std::ostream &p_outstream);
 	void PrintSymbolTableChain(std::ostream &p_outstream);
 
+#ifdef EIDOS_GUI
+	// EidosTypeTable and EidosTypeInterpreter are only used in EidosScribe, SLiMguiLegacy, and QtSLiM
 	// A utility method to add entries for defined symbols into an EidosTypeTable
 	void AddSymbolsToTypeTable(EidosTypeTable *p_type_table) const;
+#endif	// EIDOS_GUI
 
 	// Direct access to the symbol table chain.  This should only be necessary for clients that are manipulating
 	// the symbol table chain themselves in some way, since normally the chain is encapsulated by this class.