%% options copyright owner = Dirk Krause copyright year = 2015-xxxx SPDX-License-Identifier: BSD-3-Clause %% header /** @file Dk4WxAutostartController.h Autostart controller. */ #ifndef DK4CONF_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4conf.h" #else #include #endif #endif #ifndef DK4TYPES_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4types.h" #else #include #endif #endif #ifndef DK4CONST_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4const.h" #else #include #endif #endif #ifndef DK4ERROR_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4error.h" #else #include #endif #endif #ifndef DK4TIME_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4time.h" #else #include #endif #endif #ifndef WX_WXPREC_H_INCLUDED #include "wx/wxprec.h" #define WX_WXPREC_H_INCLUDED 1 #endif #ifdef __BORLANDC__ #pragma hdrstop #endif #ifndef WX_PRECOMP #ifndef WX_WX_H_INCLUDED #include "wx/wx.h" #define WX_WX_H_INCLUDED 1 #endif #endif #ifndef WX_THREAD_H_INCLUDED #include #define WX_THREAD_H_INCLUDED 1 #endif /** Controller to check whether or not to start an autostart run on idle events. */ class Dk4WxAutostartController { protected: /** Internal controller state. */ enum { /** No idle event received yet. */ STATE_NONE = 0 , /** Expecting start processing. */ STATE_EXPECT_START , /** In processing. */ STATE_PROCESSING , /** Processing finished, expecting application end. */ STATE_EXPECT_EXIT , /** Processing finished. */ STATE_FINISHED }; /** Synchronize access from multiple threads or events. */ wxCriticalSection csProtect; /** Time for automatic exit. */ dk4_time_t iExitTime; /** Current controller state. */ int iState; /** Flag: Start automatically. */ bool bAutostart; /** Flag: Exit after successfull processing via autostart. */ bool bAutoexit; public: /** Reactions on idle events. */ enum { /** Ignore the event, we are done. */ REACTION_IGNORE = 0 , /** Start autorun. */ REACTION_START , /** Request more idle events. */ REACTION_MORE , /** Exit the application. */ REACTION_EXIT }; /** Default controller. */ Dk4WxAutostartController(); /** Enable auto start. Call this function from the frames constructor. @param fl Flag to enable/disable auto start. */ void SetAutoStart(bool fl = true); /** Enable auto exit. An application can exit automatically if no feedback is required after an automatic one-time processing resulting in success. Example: A program to schedule a file to a print queue invoked via the file managers context menu. The program should immediately transfer the file to the print queue, so you enable auto start. After completing successfully you want the program to exit immediately. Call this function from the frames constructor. @param fl Flag to enable/disable auto exit. */ void SetAutoExit(bool fl = true); /** Get reaction for one idle event. This function is typically called from the frames idle event handler to decide what to do. @return One from: - REACTION_IGNORE
to ignore the idle event, - REACTION_START
to start an automatic run, - REACTION_MORE
to request more idle events, or - REACTION_EXIT
to exit the application. */ int GetReaction(void); /** Indicate to the controller that processing was started. Call this function to indicate start of processing. Should be called for both auto start runs and manually started runs. */ void StartProcessing(void); /** Indicate end of processing. Should be called for both auto start runs and manually started runs. @param success Result from processing. */ void EndProcessing(bool success = true); }; %% module #include "dk4conf.h" #include "Dk4WxAutostartController.h" $!trace-include Dk4WxAutostartController::Dk4WxAutostartController() { iExitTime = (dk4_time_t)0UL; iState = STATE_NONE; bAutostart = false; bAutoexit = false; } void Dk4WxAutostartController::SetAutoStart(bool fl) { { wxCriticalSectionLocker lock(csProtect); bAutostart = fl; } } void Dk4WxAutostartController::SetAutoExit(bool fl) { { wxCriticalSectionLocker lock(csProtect); bAutoexit = fl; } } int Dk4WxAutostartController::GetReaction(void) { dk4_time_t timer = (dk4_time_t)0UL; int back = REACTION_IGNORE; { wxCriticalSectionLocker lock(csProtect); switch (iState) { case STATE_NONE : { if (bAutostart) { back = REACTION_START; iState = STATE_EXPECT_START; } } break; #if 0 case STATE_EXPECT_START : { } break; case STATE_PROCESSING : { } break; #endif case STATE_EXPECT_EXIT : { back = REACTION_MORE; dk4time_get(&timer); if (timer >= iExitTime) { iState = STATE_FINISHED; back = REACTION_EXIT; } } break; #if 0 case STATE_FINISHED : { } break; #endif } } return back; } void Dk4WxAutostartController::StartProcessing(void) { wxCriticalSectionLocker lock(csProtect); iState = STATE_PROCESSING; } void Dk4WxAutostartController::EndProcessing(bool success) { dk4_time_t timer = (dk4_time_t)0UL; dk4time_get(&timer); { wxCriticalSectionLocker lock(csProtect); if ((bAutostart) && (bAutoexit) && (success)) { iExitTime = timer + (dk4_time_t)2UL; iState = STATE_EXPECT_EXIT; } else { iState = STATE_FINISHED; } } }