Merge pull request #38850 from mantidproject/38840-ornl-next

Simplify NeXus logging -- `ornl-next`

Author: rboston628

Framework/API/inc/MantidAPI/FrameworkManager.h

@@ -76,8 +76,6 @@ class MANTID_API_DLL FrameworkManagerImpl {
   void loadPluginsUsingKey(const std::string &locationKey, const std::string &excludeKey);
   /// Set up the global locale
   void setGlobalNumericLocaleToC();
-  /// Silence NeXus output
-  void disableNexusOutput();
   /// Starts asynchronous tasks that are done as part of Start-up
   void asynchronousStartupTasks();
   /// Setup Usage Reporting if enabled

Framework/API/src/FrameworkManager.cpp

@@ -16,7 +16,6 @@
 #include "MantidKernel/MultiThreaded.h"
 #include "MantidKernel/PropertyManagerDataService.h"
 #include "MantidKernel/UsageService.h"
-#include "MantidNexusCpp/NeXusFile.hpp"
 
 #include <boost/algorithm/string/classification.hpp>
 #include <boost/algorithm/string/split.hpp>
@@ -64,15 +63,6 @@ const char *PLUGINS_DIR_KEY = "framework.plugins.directory";
 const char *PLUGINS_EXCLUDE_KEY = "framework.plugins.exclude";
 } // namespace
 
-/** This is a function called every time NeXuS raises an error.
- * This swallows the errors and outputs nothing.
- */
-// Prevent clang-tidy trying to change the signature for ext. interface
-// NOLINTNEXTLINE(readability-non-const-parameter)
-void NexusErrorFunction(void *, const char *) {
-  // Do nothing.
-}
-
 #ifdef __linux__
 /**
  * Print current backtrace to the given stream
@@ -133,7 +123,6 @@ FrameworkManagerImpl::FrameworkManagerImpl() {
   ConfigService::Instance();
   g_log.notice() << Mantid::welcomeMessage() << '\n';
   loadPlugins();
-  disableNexusOutput();
   setNumOMPThreadsToConfigValue();
 
   g_log.debug() << "FrameworkManager created.\n";
@@ -339,9 +328,6 @@ void FrameworkManagerImpl::setGlobalNumericLocaleToC() {
   setlocale(LC_NUMERIC, "C");
 }
 
-/// Silence NeXus output
-void FrameworkManagerImpl::disableNexusOutput() { NXMSetError(nullptr, NexusErrorFunction); }
-
 /// Starts asynchronous tasks that are done as part of Start-up.
 void FrameworkManagerImpl::asynchronousStartupTasks() {
   auto instrumentUpdates = Kernel::ConfigService::Instance().getValue<bool>("UpdateInstrumentDefinitions.OnStartup");

Framework/DataHandling/src/SaveNexusProcessed.cpp

@@ -204,8 +204,8 @@ void SaveNexusProcessed::getWSIndexList(std::vector<int> &indices, const MatrixW
 void SaveNexusProcessed::doExec(const Workspace_sptr &inputWorkspace,
                                 std::shared_ptr<Mantid::NeXus::NexusFileIO> &nexusFile, const bool keepFile,
                                 optional_size_t entryNumber) {
-  // TODO: Remove?
-  NXMEnableErrorReporting();
+  //
+  //
 
   // Retrieve the filename from the properties
   const std::string filename = getPropertyValue("Filename");

Framework/LegacyNexus/inc/MantidLegacyNexus/napi.h

@@ -770,12 +770,6 @@ MANTID_LEGACYNEXUS_DLL void NXMSetError(void *pData, ErrFunc newErr);
  */
 MANTID_LEGACYNEXUS_DLL void NXMSetTError(void *pData, ErrFunc newErr);
 
-/**
- * Retrieve the current error display function
- * \return The current error display function.
- */
-MANTID_LEGACYNEXUS_DLL ErrFunc NXMGetError();
-
 /**
  * Suppress error reports from the NeXus-API
  */

Framework/LegacyNexus/src/napi.cpp

@@ -238,18 +238,20 @@ NXstatus NXsetcache(long newVal) {
 }
 
 /*-------------------------------------------------------------------------*/
-static void NXNXNXReportError(void *pData, const char *string) {
+static void NXNXNoReport(void *pData, const char *string) {
+  // do nothing but declare the variables unused
   UNUSED_ARG(pData);
-  fprintf(stderr, "%s \n", string);
+  UNUSED_ARG(string);
 }
 
 /*---------------------------------------------------------------------*/
 
 static void *NXEHpData = NULL;
-static void (*NXEHIReportError)(void *pData, const char *string) = NXNXNXReportError;
+// default to no logging
+static ErrFunc NXEHIReportError = NXNXNoReport;
 #ifdef HAVE_TLS
 static THREAD_LOCAL void *NXEHpTData = NULL;
-static THREAD_LOCAL void (*NXEHIReportTError)(void *pData, const char *string) = NULL;
+static THREAD_LOCAL ErrFunc NXEHIReportTError = NULL;
 #endif
 
 void NXIReportError(void *pData, const char *string) {
@@ -273,13 +275,13 @@ void NXReportError(const char *string) {
 }
 
 /*---------------------------------------------------------------------*/
-extern void NXMSetError(void *pData, void (*NewError)(void *pD, const char *text)) {
+extern void NXMSetError(void *pData, ErrFunc NewError) {
   NXEHpData = pData;
   NXEHIReportError = NewError;
 }
 
 /*----------------------------------------------------------------------*/
-extern void NXMSetTError(void *pData, void (*NewError)(void *pD, const char *text)) {
+extern void NXMSetTError(void *pData, ErrFunc NewError) {
 #ifdef HAVE_TLS
   NXEHpTData = pData;
   NXEHIReportTError = NewError;
@@ -288,26 +290,9 @@ extern void NXMSetTError(void *pData, void (*NewError)(void *pD, const char *tex
 #endif
 }
 
-/*----------------------------------------------------------------------*/
-extern ErrFunc NXMGetError() {
-#ifdef HAVE_TLS
-  if (NXEHIReportTError) {
-    return NXEHIReportTError;
-  }
-#endif
-  return NXEHIReportError;
-}
-
-/*----------------------------------------------------------------------*/
-static void NXNXNoReport(void *pData, const char *string) {
-  // do nothing but declare the variables unused
-  (void)pData;
-  (void)string;
-}
-
 /*----------------------------------------------------------------------*/
 
-static ErrFunc last_global_errfunc = NXNXNXReportError;
+static ErrFunc last_global_errfunc = NXEHIReportError;
 #ifdef HAVE_TLS
 static THREAD_LOCAL ErrFunc last_thread_errfunc = NULL;
 #endif

Framework/NexusCpp/inc/MantidNexusCpp/napi.h

@@ -738,60 +738,11 @@ MANTID_NEXUSCPP_DLL NXstatus NXgetrawinfo(NXhandle handle, int *rank, int dimens
  */
 MANTID_NEXUSCPP_DLL NXstatus NXgetrawinfo64(NXhandle handle, int *rank, int64_t dimension[], NXnumtype *datatype);
 
-/** \typedef void (*ErrFunc)(void *data, const char *text)
- * All NeXus error reporting happens through this special function, the
- * ErrFunc. The NeXus-API allows this error reporting function to be replaced
- * through a user defined implementation. The default error function prints to stderr. User
- * defined ones may pop up dialog boxes or whatever.
- * \param data A pointer to some user defined data structure
- * \param text The text of the error message to display.
- */
-typedef void (*ErrFunc)(void *data, const char *text);
-
-/**
- * Set a global error function.
- * Not threadsafe.
- * \param pData A pointer to a user defined data structure which be passed to
- * the error display function.
- * \param newErr The new error display function.
- */
-MANTID_NEXUSCPP_DLL void NXMSetError(void *pData, ErrFunc newErr);
-
 /**
- * Set an error function for the current thread.
- * When used this overrides anything set in NXMSetError (for the current thread).
- * Use this method in threaded applications.
- * \param pData A pointer to a user defined data structure which be passed to
- * the error display function.
- * \param newErr The new error display function.
- */
-MANTID_NEXUSCPP_DLL void NXMSetTError(void *pData, ErrFunc newErr);
-
-/**
- * Retrieve the current error display function
- * \return The current error display function.
- */
-MANTID_NEXUSCPP_DLL ErrFunc NXMGetError();
-
-/**
- * Suppress error reports from the NeXus-API
- */
-MANTID_NEXUSCPP_DLL void NXMDisableErrorReporting();
-
-/**
- * Enable error reports from the NeXus-API
- */
-MANTID_NEXUSCPP_DLL void NXMEnableErrorReporting();
-
-/**
- * Dispatches the error message to the error function defined by NXMSetTError
+ * Dispatches the error message
  */
 MANTID_NEXUSCPP_DLL void NXReportError(const char *text);
 
-/**
- * Do not use, first parameter should be set by NXMSetTError
- */
-MANTID_NEXUSCPP_DLL void NXIReportError(void *pData, const char *text);
 /* extern void *NXpData; */
 MANTID_NEXUSCPP_DLL char *NXIformatNeXusTime();
 

Framework/NexusCpp/src/napi.cpp

@@ -237,108 +237,9 @@ NXstatus NXsetcache(long newVal) {
   return NXstatus::NX_ERROR;
 }
 
-/*-------------------------------------------------------------------------*/
-static void NXNXNXReportError(void *pData, const char *string) {
-  UNUSED_ARG(pData);
-  fprintf(stderr, "%s \n", string);
-}
-
-/*---------------------------------------------------------------------*/
-
-static void *NXEHpData = NULL;
-static void (*NXEHIReportError)(void *pData, const char *string) = NXNXNXReportError;
-#ifdef HAVE_TLS
-static THREAD_LOCAL void *NXEHpTData = NULL;
-static THREAD_LOCAL void (*NXEHIReportTError)(void *pData, const char *string) = NULL;
-#endif
-
-void NXIReportError(void *pData, const char *string) {
-  UNUSED_ARG(pData);
-  fprintf(
-      stderr,
-      "Your application uses NXIReportError, but its first parameter is ignored now - you should use NXReportError.");
-  NXReportError(string);
-}
-
-void NXReportError(const char *string) {
-#ifdef HAVE_TLS
-  if (NXEHIReportTError) {
-    (*NXEHIReportTError)(NXEHpTData, string);
-    return;
-  }
-#endif
-  if (NXEHIReportError) {
-    (*NXEHIReportError)(NXEHpData, string);
-  }
-}
-
-/*---------------------------------------------------------------------*/
-extern void NXMSetError(void *pData, void (*NewError)(void *pD, const char *text)) {
-  NXEHpData = pData;
-  NXEHIReportError = NewError;
-}
-
 /*----------------------------------------------------------------------*/
-extern void NXMSetTError(void *pData, void (*NewError)(void *pD, const char *text)) {
-#ifdef HAVE_TLS
-  NXEHpTData = pData;
-  NXEHIReportTError = NewError;
-#else
-  NXMSetError(pData, NewError);
-#endif
-}
 
-/*----------------------------------------------------------------------*/
-extern ErrFunc NXMGetError() {
-#ifdef HAVE_TLS
-  if (NXEHIReportTError) {
-    return NXEHIReportTError;
-  }
-#endif
-  return NXEHIReportError;
-}
-
-/*----------------------------------------------------------------------*/
-static void NXNXNoReport(void *pData, const char *string) {
-  // do nothing but declare the variables unused
-  (void)pData;
-  (void)string;
-}
-
-/*----------------------------------------------------------------------*/
-
-static ErrFunc last_global_errfunc = NXNXNXReportError;
-#ifdef HAVE_TLS
-static THREAD_LOCAL ErrFunc last_thread_errfunc = NULL;
-#endif
-
-extern void NXMDisableErrorReporting() {
-#ifdef HAVE_TLS
-  if (NXEHIReportTError) {
-    last_thread_errfunc = NXEHIReportTError;
-    NXEHIReportTError = NXNXNoReport;
-    return;
-  }
-#endif
-  if (NXEHIReportError) {
-    last_global_errfunc = NXEHIReportError;
-    NXEHIReportError = NXNXNoReport;
-  }
-}
-
-extern void NXMEnableErrorReporting() {
-#ifdef HAVE_TLS
-  if (last_thread_errfunc) {
-    NXEHIReportTError = last_thread_errfunc;
-    last_thread_errfunc = NULL;
-    return;
-  }
-#endif
-  if (last_global_errfunc) {
-    NXEHIReportError = last_global_errfunc;
-    last_global_errfunc = NULL;
-  }
-}
+void NXReportError(const char *string) { UNUSED_ARG(string); }
 
 /*----------------------------------------------------------------------*/
 #ifdef WITH_HDF5
@@ -690,10 +591,8 @@ NXstatus NXopengroup(NXhandle fid, CONSTCHAR *name, CONSTCHAR *nxclass) {
   if (status == NXstatus::NX_OK) {
     pushPath(fileStack, name);
   }
-  NXMDisableErrorReporting();
   char nxurl[1024];
   attStatus = NXgetattr(fid, "napimount", nxurl, &length, &type);
-  NXMEnableErrorReporting();
   if (attStatus == NXstatus::NX_OK) {
     // this is an external linking group
     char exfile[512];
@@ -813,10 +712,8 @@ NXstatus NXopendata(NXhandle fid, CONSTCHAR *name) {
     pushPath(fileStack, name);
   }
 
-  NXMDisableErrorReporting();
   char nxurl[1024];
   attStatus = NXgetattr(fid, "napimount", nxurl, &length, &type);
-  NXMEnableErrorReporting();
   if (attStatus == NXstatus::NX_OK) {
     // this is an external linking group
     char exfile[512];
@@ -1271,9 +1168,7 @@ NXstatus NXisexternalgroup(NXhandle fid, CONSTCHAR *name, CONSTCHAR *nxclass, ch
   if (status != NXstatus::NX_OK) {
     return status;
   }
-  NXMDisableErrorReporting();
   attStatus = NXgetattr(fid, "napimount", nxurl, &length, &type);
-  NXMEnableErrorReporting();
   LOCKED_CALL(pFunc->nxclosegroup(pFunc->pNexusData));
   if (attStatus == NXstatus::NX_OK) {
     length = (int)strlen(nxurl);
@@ -1308,10 +1203,8 @@ NXstatus NXisexternaldataset(NXhandle fid, CONSTCHAR *name, char *url, int urlLe
   if (status != NXstatus::NX_OK) {
     return status;
   }
-  NXMDisableErrorReporting();
   int length = 1023;
   attStatus = NXgetattr(fid, "napimount", nxurl, &length, &type);
-  NXMEnableErrorReporting();
   LOCKED_CALL(pFunc->nxclosedata(pFunc->pNexusData));
   if (attStatus == NXstatus::NX_OK) {
     length = static_cast<int>(strlen(nxurl));
@@ -1355,9 +1248,7 @@ NXstatus NXlinkexternal(NXhandle fid, CONSTCHAR *name, CONSTCHAR *nxclass, CONST
     return NXstatus::NX_OK;
   }
 
-  NXMDisableErrorReporting();
   LOCKED_CALL(pFunc->nxmakegroup(pFunc->pNexusData, name, nxclass));
-  NXMEnableErrorReporting();
 
   status = LOCKED_CALL(pFunc->nxopengroup(pFunc->pNexusData, name, nxclass));
   if (status != NXstatus::NX_OK) {

Framework/NexusCpp/src/napi4.cpp

@@ -1096,13 +1096,11 @@ NXstatus NX4getdataID(NXhandle fid, NXlink *sRes) {
   } else {
     sRes->iTag = DFTAG_NDG;
     sRes->iRef = SDidtoref(pFile->iCurrentSDS);
-    NXMDisableErrorReporting();
     datalen = 1024;
     memset(&sRes->targetPath, 0, 1024);
     if (NX4getattr(fid, "target", &sRes->targetPath, &datalen, &type) != NXstatus::NX_OK) {
       NXIbuildPath(pFile, sRes->targetPath, 1024);
     }
-    NXMEnableErrorReporting();
     return NXstatus::NX_OK;
   }
   sRes->iTag = static_cast<int>(NXstatus::NX_ERROR);