Break batch analysis CMake/pre-processor variable up into GUI and CLI components since we may want to use one but not the other

Author: wcjohns

CMakeLists.txt

@@ -1,4 +1,4 @@
- cmake_minimum_required(VERSION 3.1...3.20 FATAL_ERROR)
+ cmake_minimum_required(VERSION 3.20 FATAL_ERROR)
 
 project(InterSpec VERSION 1.0.14)
 
@@ -139,14 +139,15 @@ if(BUILD_FOR_WEB_DEPLOYMENT)
     set(PERFORM_DEVELOPER_CHECKS OFF CACHE INTERNAL "")
     set(SpecUtils_ENABLE_EQUALITY_CHECKS OFF CACHE INTERNAL "")
     set(USE_SPECRUM_FILE_QUERY_WIDGET OFF)
-    set(USE_BATCH_TOOLS OFF)
 endif(BUILD_FOR_WEB_DEPLOYMENT)
 
 
 if( IOS OR ANDROID OR BUILD_FOR_WEB_DEPLOYMENT )
-  set( USE_BATCH_TOOLS OFF CACHE INTERNAL "")
-else( )
-  option( USE_BATCH_TOOLS "Enables (command line for now) batch processing." ON )
+  set(USE_BATCH_CLI_TOOLS OFF CACHE INTERNAL "")
+  set(USE_BATCH_GUI_TOOLS OFF CACHE INTERNAL "")
+else()
+  option( USE_BATCH_CLI_TOOLS "Enables command line batch processing." ON )
+  option( USE_BATCH_GUI_TOOLS "Enables GUI batch processing." ON )
 endif()
 
 if(MSVC)
@@ -171,11 +172,13 @@ set(MAX_SPECTRUM_MEMMORY_SIZE_MB 256
 # If we are creating the normal InterSpec executable, and the InterSpec_batch executable,
 #  we will compile LibInterSpec as a shared library, so both exes can use it; otherwise
 #  we will create a static library, and statically link it into our final executable.
-#  (Electron doesnt need a separate exe for batch)
-if( ((USE_BATCH_TOOLS AND NOT BUILD_AS_ELECTRON_APP) OR BUILD_AS_OSX_APP) AND NOT BUILD_AS_UNIT_TEST_SUITE )
+#  (Electron doesnt need a separate exe for batch, and we dont care abour disk space for unit tests)
+if( USE_BATCH_CLI_TOOLS AND NOT BUILD_AS_ELECTRON_APP AND NOT BUILD_AS_UNIT_TEST_SUITE )
   set( INTERSPEC_LIB_TYPE SHARED )
+  set( BUILD_LibInterSpec_SHARED ON )
 else()
   set( INTERSPEC_LIB_TYPE STATIC )
+  set( BUILD_LibInterSpec_SHARED OFF )
 endif()
 
 
@@ -590,21 +593,25 @@ if( USE_REL_ACT_TOOL )
 endif( USE_REL_ACT_TOOL )
 
 
-if( USE_BATCH_TOOLS )
+if( USE_BATCH_CLI_TOOLS )
+  list( APPEND sources src/BatchCommandLine.cpp )
+  list( APPEND headers InterSpec/BatchCommandLine.h )
+endif( USE_BATCH_CLI_TOOLS )
+
+
+if( USE_BATCH_GUI_TOOLS )
   list( APPEND sources
-        src/BatchCommandLine.cpp
         src/BatchGuiWidget.cpp
         src/BatchGuiAnaWidget.cpp
         src/BatchGuiInputFile.cpp
   )
 
   list( APPEND headers
-        InterSpec/BatchCommandLine.h
         InterSpec/BatchGuiWidget.h
         InterSpec/BatchGuiAnaWidget.h
         InterSpec/BatchGuiInputFile.h
   )
-endif( USE_BATCH_TOOLS )
+endif( USE_BATCH_GUI_TOOLS )
 
 if( (NOT IOS) AND (NOT ANDROID) AND (NOT BUILD_FOR_WEB_DEPLOYMENT) )
   list( APPEND sources src/DirectorySelector.cpp )
@@ -736,13 +743,13 @@ if(WIN32)
   target_compile_definitions( InterSpecLib PRIVATE InterSpec_EXPORTS )
   add_definitions( /bigobj )
 
-  if( USE_BATCH_TOOLS )
+  if( INTERSPEC_LIB_TYPE STREQUAL "SHARED" )
     # We get error compiling multi-processor debug build of shared LibInterSpec, presumably due to some 
     #  file locking issues, so only enable parallel builds for release, if we are building shared LibInterSpec
     target_compile_options( InterSpecLib PUBLIC $<$<CONFIG:Release>:/MP> )
-  else( USE_BATCH_TOOLS )
+  else()
     add_definitions( /MP )
-  endif( USE_BATCH_TOOLS )
+  endif()
 endif(WIN32)
 
 target_link_libraries(
@@ -856,7 +863,7 @@ if( BUILD_AS_OSX_APP )
     ${FOUNDATION_LIBRARY}
   )
 
-  if( USE_BATCH_TOOLS )
+  if( INTERSPEC_LIB_TYPE STREQUAL "SHARED" )
     set_target_properties( InterSpecLib PROPERTIES
       FRAMEWORK TRUE
       FRAMEWORK_VERSION A
@@ -875,7 +882,7 @@ if( BUILD_AS_OSX_APP )
     set_target_properties( InterSpecLib PROPERTIES
       PUBLIC_HEADER "InterSpec_config.h"
     )
-  endif( USE_BATCH_TOOLS )
+  endif( INTERSPEC_LIB_TYPE STREQUAL "SHARED" )
 endif( BUILD_AS_OSX_APP )
 
 

InterSpec/AppUtils.h

@@ -70,7 +70,7 @@ namespace AppUtils
   /** Sanatizes a string so it can be a CSS class name. */
   //std::string sanitize_css_class_name( const std::string &src_name );
 
-#if( USE_BATCH_TOOLS || BUILD_AS_LOCAL_SERVER || BUILD_FOR_WEB_DEPLOYMENT )
+#if( USE_BATCH_CLI_TOOLS || BUILD_AS_LOCAL_SERVER || BUILD_FOR_WEB_DEPLOYMENT )
   /** Returns the terminal character width */
   InterSpec_API unsigned terminal_width();
 #endif

InterSpec/InterSpec_config.h.in

@@ -28,6 +28,7 @@
 #cmakedefine01 BUILD_AS_ELECTRON_APP
 #cmakedefine01 BUILD_AS_WX_WIDGETS_APP
 #cmakedefine01 BUILD_FOR_WEB_DEPLOYMENT
+#cmakedefine01 BUILD_LibInterSpec_SHARED
 
 #cmakedefine01 PERFORM_DEVELOPER_CHECKS
 #cmakedefine01 USE_OSX_NATIVE_MENU
@@ -52,7 +53,8 @@
 #cmakedefine01 USE_DETECTION_LIMIT_TOOL
 #cmakedefine01 USE_QR_CODES
 #cmakedefine01 USE_REMOTE_RID
-#cmakedefine01 USE_BATCH_TOOLS
+#cmakedefine01 USE_BATCH_CLI_TOOLS
+#cmakedefine01 USE_BATCH_GUI_TOOLS
 #cmakedefine01 USE_LLM_INTERFACE
 // TODO: figure out stuff behind enabling/requiring MCP authorization a little better.
 #define MCP_ENABLE_AUTH 1
@@ -110,10 +112,10 @@ void log_developer_error( const char *location, const char *error );
 
 #define InterSpec_PHONE_ROTATE_FOR_TABS 1
 
-// On Windows, we will compile LibInterSpec as a shared DLL only when
-//  `USE_BATCH_TOOLS` is enabled - so in this case we need to export the functions
+// On Windows, we will compile LibInterSpec as a shared DLL when building for
+//  command-line batch tools - so in this case we need to export the functions
 //  we will want to use from the DLL.
-#if( (USE_BATCH_TOOLS && !BUILD_AS_ELECTRON_APP) && (defined(WIN32) || defined(UNDER_CE) || defined(_WIN32) || defined(WIN64)) )
+#if( BUILD_LibInterSpec_SHARED && (defined(WIN32) || defined(UNDER_CE) || defined(_WIN32) || defined(WIN64)) )
   #ifdef InterSpec_EXPORTS
     #define InterSpec_API __declspec(dllexport)
   #else

InterSpec/SpecMeasManager.h

@@ -391,7 +391,7 @@ class SpecMeasManager : public Wt::WObject
   FileDragUploadResource *foregroundDragNDrop();
   FileDragUploadResource *secondForegroundDragNDrop();
   FileDragUploadResource *backgroundDragNDrop();
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_GUI_TOOLS )
   FileDragUploadResource *batchDragNDrop();
 #endif
 
@@ -438,7 +438,7 @@ class SpecMeasManager : public Wt::WObject
                        SimpleDialog *dialog,
                        Wt::WApplication *app );
 
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_GUI_TOOLS )
   void showBatchDialog();
   void handleBatchDialogFinished();
 #endif
@@ -525,7 +525,7 @@ class SpecMeasManager : public Wt::WObject
   FileDragUploadResource *m_foregroundDragNDrop;
   FileDragUploadResource *m_secondForegroundDragNDrop;
   FileDragUploadResource *m_backgroundDragNDrop;
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_GUI_TOOLS )
   FileDragUploadResource *m_batchDragNDrop;
 #endif
 
@@ -559,7 +559,7 @@ class SpecMeasManager : public Wt::WObject
   /** Dialog created when a non-spectrum file is dropped on the app. */
   SimpleDialog *m_nonSpecFileDialog;
 
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_GUI_TOOLS )
   /** Dialog created when a batch of files is dropped on the app. */
   BatchGuiDialog *m_batchDialog;
 #endif

main.cpp

@@ -43,7 +43,7 @@
 #include "InterSpec/InterSpec.h"
 #include "InterSpec/InterSpecServer.h"
 
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_CLI_TOOLS )
 #include "InterSpec/BatchCommandLine.h"
 #endif
 
@@ -70,7 +70,7 @@ int main( int argc, char **argv )
   int server_port_num;
   std::string docroot, wt_config, user_data_dir;
 
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_CLI_TOOLS )
   bool batch_peak_fit = false, batch_act_fit = false;
 #endif
 
@@ -115,7 +115,7 @@ int main( int argc, char **argv )
   ("static-data-dir", "The static data directory (e.g., 'data' dir that holds cross-sections, "
    "nuclear-data, etc) to use.  If not specified, uses 'data' in the `docroot` directory."
    )
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_CLI_TOOLS )
   ("batch-peak-fit", po::value<bool>(&batch_peak_fit)->implicit_value(true)->default_value(false),
      "Batch-fit peaks.\n"
      "\tUse '--batch-peak-fit --help' to see available options."
@@ -132,7 +132,7 @@ int main( int argc, char **argv )
   {
     po::parsed_options parsed_opts
       = po::command_line_parser(argc,argv)
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_CLI_TOOLS )
        .allow_unregistered()
 #endif
        .options(cl_desc)
@@ -148,7 +148,7 @@ int main( int argc, char **argv )
   }//try catch
 
 
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_CLI_TOOLS )
   const bool is_batch = (batch_peak_fit || batch_act_fit);
 #else
   const bool is_batch = false;
@@ -313,7 +313,7 @@ int main( int argc, char **argv )
   //return RelActAutoDev::dev_code();
 #endif
 
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_CLI_TOOLS )
   if( is_batch )
     return BatchCommandLine::run_batch_command( argc, argv );
 #endif

src/AppUtils.cpp

@@ -230,7 +230,7 @@ namespace AppUtils
   }//string sanitize_css_class_name( const string &src_name )
    */
 
-#if( USE_BATCH_TOOLS || BUILD_AS_LOCAL_SERVER || BUILD_FOR_WEB_DEPLOYMENT )
+#if( USE_BATCH_CLI_TOOLS || BUILD_AS_LOCAL_SERVER || BUILD_FOR_WEB_DEPLOYMENT )
 #if defined(__APPLE__) || defined(unix) || defined(__unix) || defined(__unix__)
 unsigned terminal_width()
 {
@@ -256,7 +256,7 @@ unsigned terminal_width()
 #else
 static_assert( 0, "Not unix and not win32?  Unsupported getting terminal width" );
 #endif
-#endif //#if( USE_BATCH_TOOLS || BUILD_AS_LOCAL_SERVER )
+#endif //#if( USE_BATCH_CLI_TOOLS || BUILD_AS_LOCAL_SERVER )
 
 
 uint32_t compile_date_as_int()

src/InterSpec.cpp

@@ -1691,7 +1691,7 @@ void InterSpec::initDragNDrop()
   doJavaScript( "$('.Wt-domRoot').data('SecondUpUrl','" +
                m_fileManager->secondForegroundDragNDrop()->url() + "');" );
 
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_GUI_TOOLS )
   doJavaScript( "$('.Wt-domRoot').data('BatchUploadEnabled', true);" );
   doJavaScript( "$('.Wt-domRoot').data('BatchUpUrl','" +
                m_fileManager->batchDragNDrop()->url() + "');" );

src/SpecMeasManager.cpp

@@ -154,7 +154,7 @@
 #include "InterSpec/QRSpectrum.h"
 #endif
 
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_GUI_TOOLS )
 #include "InterSpec/BatchGuiWidget.h"
 #endif
 
@@ -1447,7 +1447,7 @@ SpecMeasManager::SpecMeasManager( InterSpec *viewer )
     m_foregroundDragNDrop( new FileDragUploadResource(this) ),
     m_secondForegroundDragNDrop( new FileDragUploadResource(this) ),
     m_backgroundDragNDrop( new FileDragUploadResource(this) ),
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_GUI_TOOLS )
     m_batchDragNDrop( nullptr ),
 #endif
     m_multiUrlSpectrumDialog( nullptr ),
@@ -1456,7 +1456,7 @@ SpecMeasManager::SpecMeasManager( InterSpec *viewer )
     m_previousStatesDialog( nullptr ),
     m_processingUploadDialog( nullptr ),
     m_nonSpecFileDialog( nullptr ),
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_GUI_TOOLS )
     m_batchDialog( nullptr ),
 #endif
     m_processingUploadTimer{}
@@ -1502,7 +1502,7 @@ SpecMeasManager::SpecMeasManager( InterSpec *viewer )
   m_backgroundDragNDrop->dataReceived().connect( boost::bind( &SpecMeasManager::handleDataRecievedStatus, this,
                                       boost::placeholders::_1, boost::placeholders::_2, SpectrumType::Background ) );
 
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_GUI_TOOLS )
   m_batchDragNDrop = new FileDragUploadResource( this );
   m_batchDragNDrop->fileDrop().connect( this, &SpecMeasManager::showBatchDialog );
 #endif
@@ -1661,7 +1661,7 @@ FileDragUploadResource *SpecMeasManager::backgroundDragNDrop()
   return m_backgroundDragNDrop;
 }
 
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_GUI_TOOLS )
 FileDragUploadResource *SpecMeasManager::batchDragNDrop()
 {
   return m_batchDragNDrop;
@@ -3809,7 +3809,7 @@ void SpecMeasManager::handleFileDrop( const std::string &name,
 }//handleFileDrop(...)
 
 
-#if( USE_BATCH_TOOLS )
+#if( USE_BATCH_GUI_TOOLS )
 void SpecMeasManager::showBatchDialog()
 {
   if( m_batchDialog )

target/batch/batch_main.cpp

@@ -43,7 +43,7 @@
 #include "target/osx/macOsUtils.h"
 #endif
 
-static_assert( USE_BATCH_TOOLS, "You must have USE_BATCH_TOOLS enabled to build this code" );
+static_assert( USE_BATCH_CLI_TOOLS, "You must have USE_BATCH_CLI_TOOLS enabled to build this code" );
 
 
 #ifdef _WIN32

target/docker/build_instructions.md

@@ -58,7 +58,7 @@ apk update
 apk add --no-cache alpine-sdk cmake patch linux-headers suitesparse-dev patch curl uglify-js uglifycss git
 
 # If you want to CMake Fetch to build the dependencies, you can:
-cmake -B ./build_alpine -DInterSpec_FETCH_DEPENDENCIES=ON -DCMAKE_BUILD_TYPE=Release -DBUILD_FOR_WEB_DEPLOYMENT=ON -DUSE_REL_ACT_TOOL=ON -DBUILD_AS_LOCAL_SERVER=OFF -DBoost_INCLUDE_DIR=./build/_deps/boost-src/libs -DUSE_SEARCH_MODE_3D_CHART=ON -DUSE_QR_CODES=ON -DUSE_DETECTION_LIMIT_TOOL=ON -DUSE_BATCH_TOOLS=OFF -DCMAKE_EXE_LINKER_FLAGS="-static -static-libgcc -static-libstdc++" -DCMAKE_FIND_LIBRARY_SUFFIXES=".a" ./src/
+cmake -B ./build_alpine -DInterSpec_FETCH_DEPENDENCIES=ON -DCMAKE_BUILD_TYPE=Release -DBUILD_FOR_WEB_DEPLOYMENT=ON -DUSE_REL_ACT_TOOL=ON -DBUILD_AS_LOCAL_SERVER=OFF -DBoost_INCLUDE_DIR=./build/_deps/boost-src/libs -DUSE_SEARCH_MODE_3D_CHART=ON -DUSE_QR_CODES=ON -DUSE_DETECTION_LIMIT_TOOL=ON -DUSE_BATCH_CLI_TOOLS=OFF -DUSE_BATCH_GUI_TOOLS=OFF -DCMAKE_EXE_LINKER_FLAGS="-static -static-libgcc -static-libstdc++" -DCMAKE_FIND_LIBRARY_SUFFIXES=".a" ./src/
 
 # Or if you prefer, you can build a "prefix" you can use in later Docker sessions, via:
 #./target/patches/dep_build_linux.sh /work/src/ /tmp/ /work/src/alpine_prefix