[[ Log ]] Implement the logMessage global property

montegoulding · montegoulding · commit 93f302e07c2d · 2019-05-09T08:41:44.000+10:00
diff --git a/docs/dictionary/property/logmessage.lcdoc b/docs/dictionary/property/logmessage.lcdoc
@@ -0,0 +1,47 @@
+Name: logMessage
+
+Type: property
+
+Syntax: set the logMessage to <handlerName>
+
+Summary:
+The name of the handler that is called by the <log> command.
+
+Introduced: 9.5
+
+OS: mac, windows, linux, ios, android, html5
+
+Platforms: desktop, server, mobile
+
+Example:
+on preOpenStack
+   -- uBuildMode property set before building standalone
+   if the uBuildMode of this stack is "release" then
+      set the logMessage to empty
+   end if
+   
+   loadResources
+end preOpenStack
+
+command loadResources
+   log "loading resources"
+end loadResources
+
+on log pInfo
+   -- unhandled put will go to system logs
+   put pInfo
+end log
+
+Value:
+The <logMessage> is the name of the handler called by the <log> command. The
+default <logMessage> is `log`. If set to empty then the <log> command does not
+invoke any handler or evaluate parameters, therefore, allowing for many logs to
+be added to scripts for development and an easy low-cost method to turn the
+logging off for a release build. The <logMessage> may be set to any handler name,
+however, if the handler is not in the message path then use of the <log> command
+will throw a `can't find handler` error.
+
+References: log (command), put (command), msgChanged (message)
+
+Tags: debugging
+
diff --git a/engine/src/debug.cpp b/engine/src/debug.cpp
@@ -67,6 +67,7 @@ MCExecContext *MCexecutioncontexts[MAX_CONTEXTS];
 uint2 MCnexecutioncontexts = 0;
 uint2 MCdebugcontext = MAXUINT2;
 Boolean MCmessagemessages = False;
+MCNameRef MClogmessage;
 
 ////////////////////////////////////////////////////////////////////////////////
 
diff --git a/engine/src/debug.h b/engine/src/debug.h
@@ -97,6 +97,7 @@ extern MCExecContext *MCexecutioncontexts[MAX_CONTEXTS];
 extern uint2 MCnexecutioncontexts;
 extern uint2 MCdebugcontext;
 extern Boolean MCmessagemessages;
+extern MCNameRef MClogmessage;
 
 struct MCExecValue;
 
diff --git a/engine/src/exec-debugging.cpp b/engine/src/exec-debugging.cpp
@@ -369,6 +369,25 @@ void MCDebuggingSetWatchedVariables(MCExecContext& ctxt, MCStringRef p_value)
 
 ////////////////////////////////////////////////////////////////////////////////
 
+void MCDebuggingGetLogMessage(MCExecContext& ctxt, MCStringRef& r_value)
+{
+    r_value = MCValueRetain(MCNameGetString(MClogmessage));
+}
+
+void MCDebuggingSetLogMessage(MCExecContext& ctxt, MCStringRef p_value)
+{
+    MCNewAutoNameRef t_logmessage;
+    if (!MCNameCreate(p_value, &t_logmessage))
+    {
+        ctxt.Throw();
+        return;
+    }
+    
+    MCValueAssign(MClogmessage, *t_logmessage);
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
 void MCDebuggingExecAssert(MCExecContext& ctxt, int type, bool p_eval_success, bool p_result)
 {
     switch(type)
diff --git a/engine/src/exec.h b/engine/src/exec.h
@@ -3782,6 +3782,8 @@ void MCDebuggingGetExecutionContexts(MCExecContext& ctxt, MCStringRef& r_value);
 void MCDebuggingGetWatchedVariables(MCExecContext& ctxt, MCStringRef& r_value);
 void MCDebuggingSetWatchedVariables(MCExecContext& ctxt, MCStringRef p_value);
 void MCDebuggingExecPutIntoMessage(MCExecContext& ctxt, MCStringRef value, int where);
+void MCDebuggingGetLogMessage(MCExecContext& ctxt, MCStringRef& r_value);
+void MCDebuggingSetLogMessage(MCExecContext& ctxt, MCStringRef p_value);
 
 ///////////
 
diff --git a/engine/src/globals.cpp b/engine/src/globals.cpp
@@ -886,6 +886,8 @@ void X_clear_globals(void)
 #endif
 	
 	MCDateTimeInitialize();
+    
+    MClogmessage = MCNAME("log");
 }
 
 /* ---------------------------------------------------------------- */
@@ -1546,6 +1548,8 @@ int X_close(void)
     if (MCcmd != nullptr)
         MCValueRelease(MCcmd);
     
+    MCValueRelease(MClogmessage);
+    
 	return MCretcode;
 }
 
diff --git a/engine/src/lextable.cpp b/engine/src/lextable.cpp
@@ -1173,6 +1173,7 @@ const LT factor_table[] =
         {"lockupdates", TT_PROPERTY, P_LOCK_UPDATES},
         {"log10", TT_FUNCTION, F_LOG10},
         {"log2", TT_FUNCTION, F_LOG2},
+        {"logmessage", TT_PROPERTY, P_LOG_MESSAGE},
         {"long", TT_PROPERTY, P_LONG},
         {"longfilepath", TT_FUNCTION, F_LONG_FILE_PATH},
         {"longwindowtitles", TT_PROPERTY, P_LONG_WINDOW_TITLES},
diff --git a/engine/src/parsedef.h b/engine/src/parsedef.h
@@ -1105,6 +1105,7 @@ enum Properties {
     P_EXECUTION_CONTEXTS,
     P_MESSAGE_MESSAGES,
     P_WATCHED_VARIABLES,
+    P_LOG_MESSAGE,
     P_ALLOW_INLINE_INPUT,
     P_SSL_CERTIFICATES,
 	P_HIDE_BACKDROP,
diff --git a/engine/src/property.cpp b/engine/src/property.cpp
@@ -362,6 +362,7 @@ static MCPropertyInfo kMCPropertyInfoTable[] =
 	DEFINE_RO_PROPERTY(P_EXECUTION_CONTEXTS, String, Debugging, ExecutionContexts)
 	DEFINE_RW_PROPERTY(P_BREAK_POINTS, String, Debugging, Breakpoints)
 	DEFINE_RW_PROPERTY(P_WATCHED_VARIABLES, String, Debugging, WatchedVariables)
+    DEFINE_RW_PROPERTY(P_LOG_MESSAGE, String, Debugging, LogMessage)
 
     DEFINE_RW_ARRAY_PROPERTY(P_CLIPBOARD_DATA, Any, Pasteboard, ClipboardData)
     DEFINE_RW_ARRAY_PROPERTY(P_DRAG_DATA, Any, Pasteboard, DragData)
@@ -860,6 +861,7 @@ Parse_stat MCProperty::parse(MCScriptPoint &sp, Boolean the)
 	case P_EXECUTION_CONTEXTS:
 	case P_MESSAGE_MESSAGES:
 	case P_WATCHED_VARIABLES:
+    case P_LOG_MESSAGE:
 	case P_ALLOW_INLINE_INPUT:
 	case P_ACCEPT_DROP:
 	case P_ALLOWABLE_DRAG_ACTIONS:

Original file line number	Diff line number	Diff line change
`@@ -886,6 +886,8 @@ void X_clear_globals(void)`
`886`	`886`	`#endif`
`887`	`887`
`888`	`888`	`MCDateTimeInitialize();`
	`889`	`+`
	`890`	`+ MClogmessage = MCNAME("log");`
`889`	`891`	`}`
`890`	`892`
`891`	`893`	`/* ---------------------------------------------------------------- */`
`@@ -1546,6 +1548,8 @@ int X_close(void)`
`1546`	`1548`	`if (MCcmd != nullptr)`
`1547`	`1549`	`MCValueRelease(MCcmd);`
`1548`	`1550`
	`1551`	`+ MCValueRelease(MClogmessage);`
	`1552`	`+`
`1549`	`1553`	`return MCretcode;`
`1550`	`1554`	`}`
`1551`	`1555`