adjust status and logfile names

Author: rosasurfer

mql40/experts/ZigZag EA.mq4

@@ -137,7 +137,7 @@ extern double Lots                           = 0.1;
 #include <rsf/experts/instance/RestoreInstance.mqh>
 #include <rsf/experts/instance/SetInstanceId.mqh>
 
-#include <rsf/experts/log/GetLogFilename.mqh>
+#include <rsf/experts/log/GetLogFileName.mqh>
 
 #include <rsf/experts/metric/GetMT4SymbolDefinition.mqh>
 #include <rsf/experts/metric/RecordMetrics.mqh>
@@ -154,8 +154,8 @@ extern double Lots                           = 0.1;
 #include <rsf/experts/status/StatusDescription.mqh>
 
 #include <rsf/experts/status/file/FindStatusFile.mqh>
-#include <rsf/experts/status/file/GetStatusFilename.mqh>
-#include <rsf/experts/status/file/SetStatusFilename.mqh>
+#include <rsf/experts/status/file/GetStatusFileName.mqh>
+#include <rsf/experts/status/file/SetStatusFileName.mqh>
 #include <rsf/experts/status/file/ReadStatus.General.mqh>
 #include <rsf/experts/status/file/ReadStatus.HistoryRecord.mqh>
 #include <rsf/experts/status/file/ReadStatus.OpenPosition.mqh>
@@ -997,7 +997,7 @@ bool SaveStatus() {
    }
    else if (IsTestInstance()) return(true);                    // don't modify the status file of a finished test
 
-   string section="", separator="", file=GetStatusFilename();
+   string section="", separator="", file=GetStatusFileName();
    bool fileExists = IsFile(file, MODE_SYSTEM);
    if (!fileExists) separator = CRLF;                          // an empty line separator
    SS.All();                                                   // update trade stats and global string representations
@@ -1065,7 +1065,7 @@ bool ReadStatus() {
    if (IsLastError()) return(false);
    if (!instance.id)  return(!catch("ReadStatus(1)  "+ instance.name +" illegal value of instance.id: "+ instance.id, ERR_ILLEGAL_STATE));
 
-   string section="", file=GetStatusFilename();
+   string section="", file=GetStatusFileName();
    if (file == "")                 return(!catch("ReadStatus(2)  "+ instance.name +" status file not found", ERR_RUNTIME_ERROR));
    if (!IsFile(file, MODE_SYSTEM)) return(!catch("ReadStatus(3)  "+ instance.name +" file \""+ file +"\" not found", ERR_FILE_NOT_FOUND));
 
@@ -1215,16 +1215,6 @@ bool SynchronizeStatus() {
 }
 
 
-/**
- * Return a distinctive instance detail to be inserted in the status/log filename.
- *
- * @return string
- */
-string GetStatusFilenameData() {
-   return("P="+ ZigZag.Periods);
-}
-
-
 /**
  * Whether the specified ticket exists in the local history of closed positions.
  *

mql40/include/rsf/experts/init.mqh

@@ -23,7 +23,7 @@ int onInit() {
 int onInitUser() {
    if (ValidateInputs.ID()) {                      // TRUE: a valid instance id was specified
       if (RestoreInstance()) {                     // try to reload the given instance
-         logInfo("onInitUser(1)  "+ instance.name +" restored in status \""+ StatusDescription(instance.status) +"\" from file \""+ GetStatusFilename(true) +"\"");
+         logInfo("onInitUser(1)  "+ instance.name +" restored in status \""+ StatusDescription(instance.status) +"\" from file \""+ GetStatusFileName(true) +"\"");
       }
    }
    else if (StrTrim(Instance.ID) == "") {          // no instance id was specified
@@ -34,7 +34,7 @@ int onInitUser() {
          instance.created = GetLocalTime();        // local system time (also in tester)
          instance.started = TimeServer();          // trade server time (modeled in tester)
          instance.status  = ifInt(__isTesting, STATUS_WAITING, STATUS_STOPPED);
-         SetStatusFilename();
+         SetStatusFileName();
          logInfo("onInitUser(2)  instance "+ instance.name +" created");
          SaveStatus();
       }
@@ -88,7 +88,7 @@ int onInitSymbolChange() {
 int onInitTemplate() {
    if (RestoreVolatileStatus()) {                  // an instance id was found and restored
       if (RestoreInstance()) {                     // the instance was restored
-         logInfo("onInitTemplate(1)  "+ instance.name +" restored in status \""+ StatusDescription(instance.status) +"\" from file \""+ GetStatusFilename(true) +"\"");
+         logInfo("onInitTemplate(1)  "+ instance.name +" restored in status \""+ StatusDescription(instance.status) +"\" from file \""+ GetStatusFileName(true) +"\"");
       }
       return(last_error);
    }
@@ -104,7 +104,7 @@ int onInitTemplate() {
 int onInitRecompile() {
    if (RestoreVolatileStatus()) {                  // same as for onInitTemplate()
       if (RestoreInstance()) {
-         logInfo("onInitRecompile(1)  "+ instance.name +" restored in status \""+ StatusDescription(instance.status) +"\" from file \""+ GetStatusFilename(true) +"\"");
+         logInfo("onInitRecompile(1)  "+ instance.name +" restored in status \""+ StatusDescription(instance.status) +"\" from file \""+ GetStatusFileName(true) +"\"");
       }
       return(last_error);
    }
@@ -119,7 +119,7 @@ int onInitRecompile() {
  */
 int afterInit() {
    if (__isTesting || !IsTestInstance()) {         // open the log file (flushes the log buffer) except if in a finished test
-      string filename = GetLogFilename();
+      string filename = GetLogFileName();
       if (filename == "")        return(last_error);
       if (!SetLogfile(filename)) return(catch("afterInit(1)"));
    }
@@ -132,8 +132,3 @@ int afterInit() {
    StoreVolatileStatus();                          // store the instance id for template reload/restart/recompilation etc.
    return(catch("afterInit(2)"));
 }
-
-
-#import "rsfMT4Expander.dll"
-   string GetStatusFilenameData();                 // A no-op in the Expander allows the user to optionally provide his own data.
-#import

mql40/include/rsf/experts/log/GetLogFilename.mqh renamed to mql40/include/rsf/experts/log/GetLogFileName.mqh

@@ -3,8 +3,8 @@
  *
  * @return string - filename or an empty string in case of errors
  */
-string GetLogFilename() {
-   string name = GetStatusFilename();
+string GetLogFileName() {
+   string name = GetStatusFileName();
    if (name == "") return("");
    return(StrLeftTo(name, ".", -1) +".log");
 }

mql40/include/rsf/experts/status/file/FindStatusFile.mqh

@@ -1,5 +1,10 @@
 /**
- * Find an existing status file for the specified instance.
+ * Find an existing status file for the specified instance id. Finds any file matching
+ *
+ *   "<program-name>, <symbol>,* id=<instance-id>.set" (no matter what the custom name is)
+ *
+ * but doesn't scan subdirectories. The EA will use whatever was found for status and logfile.
+ * A more strict pattern is used for name generation in SetStatusFileName().
  *
  * @param  int  instanceId - instance id
  * @param  bool isTest     - whether the instance is a test instance
@@ -13,7 +18,7 @@ string FindStatusFile(int instanceId, bool isTest) {
 
    string sandboxDir  = GetMqlSandboxPath() +"\\";
    string statusDir   = "presets\\"+ ifString(isTest, "Tester", GetAccountCompanyId()) +"\\";
-   string basePattern = ProgramName() +", "+ Symbol() +",* id="+ StrPadLeft(""+ instanceId, 3, "0") +".set";   // matches files with and w/o user-specified data in the name
+   string basePattern = ProgramName() +", "+ Symbol() +",* id="+ StrPadLeft(""+ instanceId, 3, "0") +".set";   // matches files with custom names
    string pathPattern = sandboxDir + statusDir + basePattern;
 
    string result[];

mql40/include/rsf/experts/status/file/GetStatusFilename.mqh renamed to mql40/include/rsf/experts/status/file/GetStatusFileName.mqh

@@ -6,11 +6,11 @@
  *
  * @return string - filename or an empty string in case of errors
  */
-string GetStatusFilename(bool relative = false) {
+string GetStatusFileName(bool relative = false) {
    relative = relative!=0;
 
    if (status.filename == "") {
-      status.filename = FindStatusFile(instance.id, instance.isTest);   // intentionally trigger an error if instance.id is not set
+      status.filename = FindStatusFile(instance.id, instance.isTest);
       if (status.filename == "") return("");
    }
 

mql40/include/rsf/experts/status/file/SetStatusFileName.mqh

@@ -0,0 +1,27 @@
+/**
+ * Generates and initializes the name of the status file. Requires 'instance.id' and 'instance.created' to be set.
+ *
+ * If the expert implements GetStatusFileNameData() the returned string will be inserted into the resulting
+ * filename. This can be used to insert custom data into the name (e.g. SL/TP vars or trading modes).
+ *
+ * @return bool - success status
+ */
+bool SetStatusFileName() {
+   if (status.filename != "") return(!catch("SetStatusFileName(1)  "+ instance.name +" cannot modify an already set status filename: \""+ status.filename +"\"", ERR_ILLEGAL_STATE));
+   if (!instance.id)          return(!catch("SetStatusFileName(2)  "+ instance.name +" illegal value of instance.id: 0", ERR_ILLEGAL_STATE));
+   if (!instance.created)     return(!catch("SetStatusFileName(3)  "+ instance.name +" cannot create status filename (instance.created not set)", ERR_ILLEGAL_STATE));
+
+   string userData = StrTrim(GetStatusFileNameData());
+   if (userData != "") userData = userData +", ";
+
+   string directory = "presets\\"+ ifString(IsTestInstance(), "Tester", GetAccountCompanyId()) +"\\";
+   string baseName  = ProgramName() +", "+ Symbol() +","+ PeriodDescription() +" "+ userData + GmtTimeFormat(instance.created, "%Y.%m.%d %H.%M") +", id="+ StrPadLeft(instance.id, 3, "0") +".set";
+   status.filename = directory + baseName;
+
+   return(!catch("SetStatusFileName(4)"));
+}
+
+
+#import "rsfMT4Expander.dll"
+   string GetStatusFileNameData();                 // a no-op in the Expander allows optional override in MQL
+#import