mgui/appmain.h

Go to the documentation of this file.

#ifndef  INC_MGUI_APPMAIN_H
#define  INC_MGUI_APPMAIN_H

#ifndef INC_MI32_ICONID_H
   #include <mi32/iconid.h>
#endif

#if !defined(_XtIntrinsic_h)
   #include <X11/Intrinsic.h>
#endif

#ifndef  INC_MI32_MILIST_H
   #include <mi32/milist.h>
#endif

#ifndef  INC_MI32_DELEGATE_H
   #include <mi32/delegate.h>
#endif

#ifndef  INC_MI32_CRITSEC_H
   #include <mi32/critsec.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward declarations.
struct McbAnyCallbackStruct;
class FILEPATH;
namespace MGUI {
   class APP_MAIN;
   class TIMER;
   }
#endif


namespace MGUI {

//=====================================================================================================================

class APP_BASE {
   public:

      enum LEGACYINIT {
         LEGACYINIT_Default =             0x00,
         LEGACYINIT_NoSetPosition =       0x01, 
         LEGACYINIT_NoSetTitle =          0x02, 
         LEGACYINIT_NoRealize =           0x04, 
         LEGACYINIT_NoAutoSetExit =       0x08, 
         LEGACYINIT_LockShellSize =       0x10, 
         LEGACYINIT_NoDestroyTopOnExit =  0x20  
         };

      static MDLGPARENT GetTopDlgParent ();
   
      inline int GetCmdParmCount () const;

      inline const char* GetCmdParm (
         int idx                       
         ) const;

      bool GetCmdParmPath (
         int idx,
         FILEPATH& pathret
         ) const;

      ICONID GetDefaultIconID (
         ) const { return (v_GetDefaultIconID()); }

   protected:

      APP_BASE (
         UINT32 AllowedProduct1 = 0,      
         UINT32 AllowedProduct2 = 0,
         UINT32 AllowedProduct3 = 0,
         UINT32 AllowedProduct4 = 0
         );

      virtual ~APP_BASE ();

      DEPRECATED Widget MxInitLegacy (LEGACYINIT flags = LEGACYINIT_Default);

      void SetLegacyAllowShellResize (
         ) { m_LegacyAllowShellResize = true; }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      LEGACYINIT m_LegacyInitFlags;
      bool m_LegacyAllowShellResize;
      MDLGPARENT m_TopParent;
      UINT32 m_ProductCode;
      UINT32 m_AllowedProducts[4];
      MILIST<DELEGATE_VOID_NOPARMS> m_QueuedDelegates;
      MGUI::TIMER *m_pQueueTimer;
      MITHREAD::CRITICALSECTION m_QueueCritSec;

      void AddQueuedDelegate (DELEGATE_VOID_NOPARMS delegate);
      void EnableQueueDelegates (bool enable);
      UINT32 DetermineProductCode ()
         { return (v_DetermineProductCode()); }
      void ExitInstance ();
      const char* GetProcessName () const
         { return (v_GetProcessName()); }
      bool InitInstance ();
      bool IsProductAllowed (UINT32) const;
      void OnQueueTimer ();
      void RemoveQueuedDelegate (DELEGATE_VOID_NOPARMS delegate);

      friend class MGUI::APP_MAIN;

      APP_BASE (const APP_BASE&);
      APP_BASE& operator= (const APP_BASE&);

      #endif // GENERATING_DOXYGEN_OUTPUT

      // Overridables.

      virtual UINT32 v_DetermineProductCode () const;

      virtual void v_ExitInstance ();

      virtual ICONID v_GetDefaultIconID () const;

      virtual const char* v_GetProcessName () const = 0;

      virtual void v_GetSessionLogPath (FILEPATH& path);

      virtual bool v_InitInstance () = 0;

      virtual bool v_PreInitInstance ();

   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(APP_BASE::LEGACYINIT)
#endif

//=====================================================================================================================

class APP_MAIN {
   public:

      static void AddQueuedDelegate (
         DELEGATE_VOID_NOPARMS delegate
         );

      static void EnableQueueDelegates (
         bool enable = true
         );

      static void Exit () { s_pMainInstance->DoExit(); }

      static APP_BASE* GetBaseInstance ()
         { return (s_pBaseInstance); }

      static ICONID GetDefaultIconID ();

      static APP_MAIN* GetMainInstance ()
         { return (s_pMainInstance); }

      static void ProcessPendingEvent ();

      static void ProcessPendingEvents ();

      static void RemoveQueuedDelegate (
         DELEGATE_VOID_NOPARMS delegate
         );

      APP_MAIN ();

      virtual ~APP_MAIN () = 0;

      int GetCmdParmCount () const
         { return (m_CmdParmCount); }

      const char* GetCmdParm (
         int idx                       
         ) const { return ((idx < 0 || idx >= m_CmdParmCount) ? NULL : m_CmdParmArray[idx]); }

   #ifdef WIN32
      void *GetInstanceHandle () const
         { return (m_hInstance); }
   #endif

      void RemoveCmdParm (
         int idx
         );

      #ifndef GENERATING_DOXYGEN_OUTPUT
   #if defined(WIN32)
      void DoWinMain (void *hInstance, const char *cmdline);
   #else
      // These should be private, but then main() can't access them.  I tried
      // friend int main(int, char**), but it didn't help.
      void Run();
      void SetCmdParms (const char**, int);
   #endif
      #endif // GENERATING_DOXYGEN_OUTPUT

   private:

      #ifndef GENERATING_DOXYGEN_OUTPUT

      static APP_MAIN *s_pMainInstance;
      static APP_BASE *s_pBaseInstance;
   #ifdef WIN32
      void *m_hInstance;
      char *m_ModNameStr;
      char *m_CmdLineStr;
   #endif

      void DoExit ();
      void ExitInstance ();
      bool InitInstance ();
      static void OnExitXServer (McbAnyCallbackStruct*, void*);
      static void OnTerminate ();

   #if defined(WIN32)
      void Run ();
   #endif

   #if defined(WIN32)
      void SetCmdLine (const char*);
   #endif
      char **m_CmdParmArray;
      int m_CmdParmCount;

      friend class MGUI::APP_BASE;

      APP_MAIN (const APP_MAIN&);
      APP_MAIN& operator= (const APP_MAIN&);

      #endif // GENERATING_DOXYGEN_OUTPUT

      // Overridables.

      virtual void v_ExitInstance ();

      virtual bool v_InitInstance ();

   };

//=====================================================================================================================

class APP_JOB : public APP_BASE {
   public:
      APP_JOB (
         UINT32 AllowedProduct1 = 0,      
         UINT32 AllowedProduct2 = 0,
         UINT32 AllowedProduct3 = 0,
         UINT32 AllowedProduct4 = 0
         );
      ~APP_JOB () {}

   protected:
      virtual bool v_InitInstance ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      void ExecuteJob (FILEPATH path);

      virtual ERRVALUE v_RunJob(const FILEPATH& path);

      // Overrides from APP_BASE.
      virtual void v_GetSessionLogPath (FILEPATH& path);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

//=====================================================================================================================

#ifndef GENERATING_DOXYGEN_OUTPUT

inline int APP_BASE::GetCmdParmCount (
   ) const {
   APP_MAIN *pMain = APP_MAIN::GetMainInstance();
   return ((pMain == 0) ? 0 : pMain->GetCmdParmCount());
   }

inline const char* APP_BASE::GetCmdParm (
   int idx                       
   ) const {
   APP_MAIN *pMain = APP_MAIN::GetMainInstance();
   return ((pMain == 0) ? 0 : pMain->GetCmdParm(idx));
   }

#endif // GENERATING_DOXYGEN_OUTPUT

//=====================================================================================================================

}  // End namespace MGUI

#endif   // INC_MGUI_APPMAIN_H

---