add stringRepresentation() method to Object

Author: bhaller

EidosScribe/EidosHelpClasses.rtf

@@ -90,6 +90,26 @@
 \pard\pardeftab397\li547\ri720\sb60\sa60\partightenfactor0
 
 \f4\fs20 \cf2 Prints the internal property structure of the receiving object; in particular, the element type of the object is printed, followed, on successive lines, by all of the properties supported by the object, their types, and a sample of their values.\
+\pard\pardeftab397\li720\fi-446\ri720\sb180\sa60\partightenfactor0
+
+\f3\fs18 \cf2 \'96\'a0(string$)stringRepresentation(void)\
+\pard\pardeftab397\li547\ri720\sb60\sa60\partightenfactor0
+
+\f4\fs20 \cf2 Returns a singleton 
+\f3\fs18 string
+\f4\fs20  value that represents the receiving object.  By default, this is simply the name of the class of the receiving object; however, many subclasses of 
+\f3\fs18 Object
+\f4\fs20  provide a different string representation.  The value returned by 
+\f3\fs18 stringRepresentation()
+\f4\fs20  is the same string that would be printed by 
+\f3\fs18 print()
+\f4\fs20  for the object, so 
+\f3\fs18 stringRepresentation()
+\f4\fs20  allows the same representation to be used in other contexts such as 
+\f3\fs18 paste()
+\f4\fs20  and 
+\f3\fs18 cat()
+\f4\fs20 .\
 \pard\pardeftab720\ri720\sb360\sa60\partightenfactor0
 
 \f0\b\fs22 \cf2 5.2  Class DataFrame\

QtSLiM/help/EidosHelpClasses.html

@@ -28,6 +28,8 @@
 <p class="p4">Returns the size of the receiving object.<span class="Apple-converted-space">  </span>This is equivalent to the <span class="s1">size()</span> (or <span class="s1">length()</span>) function; in other words, for any <span class="s1">object</span> <span class="s1">x</span>, the return value of the function call <span class="s1">size(x)</span> equals the return value of the class method call <span class="s1">x.size()</span>.<span class="Apple-converted-space">  </span>This method is provided solely for syntactic convenience.<span class="Apple-converted-space">  </span>Note that <span class="s1">+length()</span> is a synonym for <span class="s1">+size()</span>.</p>
 <p class="p3">– (void)str(void)</p>
 <p class="p4">Prints the internal property structure of the receiving object; in particular, the element type of the object is printed, followed, on successive lines, by all of the properties supported by the object, their types, and a sample of their values.</p>
+<p class="p3">– (string$)stringRepresentation(void)</p>
+<p class="p4">Returns a singleton <span class="s1">string</span> value that represents the receiving object.<span class="Apple-converted-space">  </span>By default, this is simply the name of the class of the receiving object; however, many subclasses of <span class="s1">Object</span> provide a different string representation.<span class="Apple-converted-space">  </span>The value returned by <span class="s1">stringRepresentation()</span> is the same string that would be printed by <span class="s1">print()</span> for the object, so <span class="s1">stringRepresentation()</span> allows the same representation to be used in other contexts such as <span class="s1">paste()</span> and <span class="s1">cat()</span>.</p>
 <p class="p1"><b>5.2<span class="Apple-converted-space">  </span>Class DataFrame</b></p>
 <p class="p3">(object&lt;DataFrame&gt;$)DataFrame(...)</p>
 <p class="p4">The <span class="s1">DataFrame</span> constructor can be called in the same ways as the constructor for <span class="s1">Dictionary</span> (its superclass): with no parameters to make an empty <span class="s1">DataFrame</span>, with key-value pairs, with a singleton <span class="s1">Dictionary</span> (or a subclass of <span class="s1">Dictionary</span>, like <span class="s1">DataFrame</span>) to make a copy, or with a singleton string in JSON format.<span class="Apple-converted-space">  </span>See the <span class="s1">Dictionary</span> class for further documentation.</p>

VERSIONS

@@ -16,6 +16,7 @@ development head (in the master branch):
 	revise recipe 6.1.2 (reading a recombination map from a file) to use readCSV() instead of readFile()
 	extend the subset() method of DataFrame to accept NULL for rows/cols, to take entire columns or entire rows respectively, for usability
 	extend readCSV() to allow sep="", meaning that the separator is "whitespace", as in R
+	add a stringRepresentation() method on Object, to provide the same string representation printed by print()
 
 
 version 4.0 (Eidos version 3.0):

eidos/eidos_class_Object.cpp

@@ -116,7 +116,8 @@ EidosValue_SP EidosObject::ExecuteInstanceMethod(EidosGlobalStringID p_method_id
 #pragma unused(p_arguments, p_interpreter)
 	switch (p_method_id)
 	{
-		case gEidosID_str:	return ExecuteMethod_str(p_method_id, p_arguments, p_interpreter);
+		case gEidosID_str:					return ExecuteMethod_str(p_method_id, p_arguments, p_interpreter);
+		case gEidosID_stringRepresentation:	return ExecuteMethod_stringRepresentation(p_method_id, p_arguments, p_interpreter);
 
 		default:
 		{
@@ -234,6 +235,19 @@ EidosValue_SP EidosObject::ExecuteMethod_str(EidosGlobalStringID p_method_id, co
 	return gStaticEidosValueVOID;
 }
 
+//	*********************	– (string$)stringRepresentation(void)
+//
+EidosValue_SP EidosObject::ExecuteMethod_stringRepresentation(EidosGlobalStringID p_method_id, const std::vector<EidosValue_SP> &p_arguments, EidosInterpreter &p_interpreter)
+{
+#pragma unused (p_method_id, p_arguments, p_interpreter)
+	
+	std::ostringstream oss;
+	
+	Print(oss);
+	
+	return EidosValue_SP(new (gEidosValuePool->AllocateChunk()) EidosValue_String_singleton(oss.str()));
+}
+
 EidosValue_SP EidosObject::ContextDefinedFunctionDispatch(const std::string &p_function_name, const std::vector<EidosValue_SP> &p_arguments, EidosInterpreter &p_interpreter)
 {
 #pragma unused(p_function_name, p_arguments, p_interpreter)
@@ -520,6 +534,7 @@ const std::vector<EidosMethodSignature_CSP> *EidosClass::Methods(void) const
 		methods->emplace_back((EidosClassMethodSignature *)(new EidosClassMethodSignature(gEidosStr_size, kEidosValueMaskInt | kEidosValueMaskSingleton)));
 		methods->emplace_back((EidosClassMethodSignature *)(new EidosClassMethodSignature(gEidosStr_length, kEidosValueMaskInt | kEidosValueMaskSingleton)));
 		methods->emplace_back((EidosInstanceMethodSignature *)(new EidosInstanceMethodSignature(gEidosStr_str, kEidosValueMaskVOID)));
+		methods->emplace_back((EidosInstanceMethodSignature *)(new EidosInstanceMethodSignature(gEidosStr_stringRepresentation, kEidosValueMaskString | kEidosValueMaskSingleton)));
 
 		std::sort(methods->begin(), methods->end(), CompareEidosCallSignatures);
 	}

eidos/eidos_class_Object.h

@@ -78,6 +78,7 @@ class EidosObject
 
 	virtual EidosValue_SP ExecuteInstanceMethod(EidosGlobalStringID p_method_id, const std::vector<EidosValue_SP> &p_arguments, EidosInterpreter &p_interpreter);
 	EidosValue_SP ExecuteMethod_str(EidosGlobalStringID p_method_id, const std::vector<EidosValue_SP> &p_arguments, EidosInterpreter &p_interpreter);
+	EidosValue_SP ExecuteMethod_stringRepresentation(EidosGlobalStringID p_method_id, const std::vector<EidosValue_SP> &p_arguments, EidosInterpreter &p_interpreter);
 
 	// EidosContext is a typedef for EidosObject at present, so this class is the superclass of the Context
 	// object.  If that gets complicated we'll probably want to make a new EidosContext class to formalize things,

eidos/eidos_globals.cpp

@@ -2702,6 +2702,7 @@ const std::string &gEidosStr_length = EidosRegisteredString("length", gEidosID_l
 const std::string &gEidosStr_methodSignature = EidosRegisteredString("methodSignature", gEidosID_methodSignature);
 const std::string &gEidosStr_propertySignature = EidosRegisteredString("propertySignature", gEidosID_propertySignature);
 const std::string &gEidosStr_str = EidosRegisteredString("str", gEidosID_str);
+const std::string &gEidosStr_stringRepresentation = EidosRegisteredString("stringRepresentation", gEidosID_stringRepresentation);
 
 // strings for EidosTestElement
 const std::string &gEidosStr__TestElement = EidosRegisteredString("_TestElement", gEidosID__TestElement);

eidos/eidos_globals.h

@@ -881,6 +881,7 @@ extern const std::string &gEidosStr_length;
 extern const std::string &gEidosStr_methodSignature;
 extern const std::string &gEidosStr_propertySignature;
 extern const std::string &gEidosStr_str;
+extern const std::string &gEidosStr_stringRepresentation;
 
 extern const std::string &gEidosStr__TestElement;
 extern const std::string &gEidosStr__yolk;
@@ -1001,6 +1002,7 @@ enum _EidosGlobalStringID : uint32_t
 	gEidosID_methodSignature,
 	gEidosID_propertySignature,
 	gEidosID_str,
+	gEidosID_stringRepresentation,
 
 	gEidosID__TestElement,
 	gEidosID__yolk,

eidos/eidos_test_functions_other.cpp

@@ -939,6 +939,9 @@ void _RunClassTests(std::string temp_path)
 	EidosAssertScriptSuccess_VOID("matrix(_Test(7)).str();");
 	EidosAssertScriptSuccess_VOID("matrix(c(_Test(7), _Test(8), _Test(9))).str();");
 
+	// stringRepresentation()
+	EidosAssertScriptSuccess_SV("matrix(rep(_Test(7), 3)).stringRepresentation();", {"_TestElement", "_TestElement", "_TestElement"});
+	EidosAssertScriptSuccess_S("Dictionary('a', 1:3, 'b', 5:6).stringRepresentation();", "{a=1 2 3;b=5 6;}");
 
 	// Test EidosDictionaryUnretained properties and methods, using EidosDictionaryRetained
 	// since there's no way to instantiate an EidosDictionaryUnretained directly