vtkSlicerApplication.h

Go to the documentation of this file.

#ifndef __vtkSlicerApplication_h
#define __vtkSlicerApplication_h

#include "vtkSlicerConfigure.h"

#ifdef Slicer3_USE_QT
// QT includes
#include <QStringList>
#endif

#include "vtkStringArray.h"
#include "vtkSlicerBaseGUIWin32Header.h"
#include "vtkKWApplication.h"
#include "vtkKWRegistryHelper.h" 
#include "itkMutexLock.h"

#include "vtkSlicerApplicationGUI.h"

#ifdef Slicer3_USE_QT
//BTX
class qSlicerApplication;
class qSlicerModulePanel;
//ETX
#endif

class vtkSlicerModuleGUI;
class vtkSlicerGUILayout;
class vtkSlicerTheme;
class vtkSlicerGUICollection;
//BTX
class DisplayMessageQueue;
//ETX


//
class VTK_SLICER_BASE_GUI_EXPORT vtkSlicerApplication : public vtkKWApplication
{
 public:
    vtkTypeRevisionMacro ( vtkSlicerApplication, vtkKWApplication );

    static vtkSlicerApplication* New();

    static vtkSlicerApplication* GetInstance();

    static vtkSlicerApplication* GetInstance(const char* tmp_dir, const char* config_dir);

    void Init();

    virtual void DoOneTclEvent();

    vtkGetObjectMacro ( DefaultGeometry, vtkSlicerGUILayout );
    vtkGetObjectMacro ( SlicerTheme, vtkSlicerTheme );
    vtkGetObjectMacro ( ModuleGUICollection, vtkSlicerGUICollection );
    vtkGetObjectMacro ( ApplicationGUI, vtkSlicerApplicationGUI );
    vtkSetObjectMacro ( ApplicationGUI, vtkSlicerApplicationGUI );

    virtual void AddModuleGUI ( vtkSlicerModuleGUI *gui );
    virtual void RemoveModuleGUI ( vtkSlicerModuleGUI *gui );
    virtual vtkSlicerModuleGUI* GetModuleGUIByName ( const char *name );

    void SetMRMLScene( vtkMRMLScene* scene);
    vtkMRMLScene* GetMRMLScene();

    // Description:
    // Display the exit dialog.
    // Optionally provide a master window this dialog should be the slave of.
    // Return 1 if the user wants to exit, 0 otherwise
    virtual int DisplayExitDialog(vtkKWTopLevel *master);


#ifdef Slicer3_USE_QT
    //BTX
    void InitializeQtCoreModules();
    //ETX

    //BTX
    void InitializeQtLoadableModules();
    //ETX

    //BTX
    void InitializeQtCommandLineModules();
    //ETX

    //BTX
    void InitializeQtModules(const QStringList& names);
    //ETX

    //BTX
    void InitializeQtModule(const QString& moduleName);
    //ETX

    //BTX
    qSlicerModulePanel* modulePanel();
    //ETX
#endif

    //BTX
    virtual void RegisterDialogUp(vtkKWWidget *ptr);
    virtual void UnRegisterDialogUp(vtkKWWidget *ptr);
    //ETX

    virtual void CloseAllWindows ( ) ;

    virtual void ConfigureApplication ( );
    virtual int StartApplication ( );

    virtual void InstallTheme ( vtkKWTheme *theme );

  int HasRegistry(const char *key);
  void RequestRegistry(const char *key);
  const char *GetRegistryHolder();
  void SetRegistry(const char *key, char *value);

  virtual void RestoreApplicationSettingsFromRegistry();
  virtual void SaveApplicationSettingsToRegistry();
  virtual void ConfigureRemoteIOSettingsFromRegistry();
  virtual void UpdateRemoteIOSettingsForRegistry();
  virtual int FullFileSystemCheck ( );

  //BTX
  static const char *ConfirmDeleteRegKey;
  static const char *ModulePathsRegKey;
  static const char *ColorFilePathsRegKey;
  static const char *PotentialModulePathsRegKey;
  static const char *PotentialColorFilePathsRegKey;
  static const char *ExtensionsInstallPathRegKey;
  static const char *TemporaryDirectoryRegKey;
  static const char *WebBrowserRegKey;
  static const char *UnzipRegKey;
  static const char *ZipRegKey;
  static const char *RmRegKey;
  static const char *HomeModuleRegKey;
  static const char *LoadModulesRegKey;
  static const char *IgnoreModulesRegKey;
  static const char *LoadCommandLineModulesRegKey;
  static const char *EnableDaemonRegKey;
  static const char *ApplicationFontFamilyRegKey;
  static const char *ApplicationFontSizeRegKey;
  static const char *ApplicationWindowWidthRegKey;
  static const char *ApplicationWindowHeightRegKey;
  static const char *ApplicationSlicesFrameHeightRegKey;
  static const char *ApplicationLayoutTypeRegKey;
  static const char *ApplicationLayoutCompareViewRowsRegKey;
  static const char *ApplicationLayoutCompareViewColumnsRegKey;
  static const char *ApplicationLayoutLightboxRowsRegKey;
  static const char *ApplicationLayoutLightboxColumnsRegKey;
  static const char *EnableAsynchronousIORegKey;
  static const char *UseWelcomeModuleAtStartupRegKey;
  static const char *EnableForceRedownloadRegKey;
  static const char *EnableRemoteCacheOverwritingRegKey;
  static const char *RemoteCacheDirectoryRegKey;
  static const char *RemoteCacheLimitRegKey;
  static const char *RemoteCacheFreeBufferSizeRegKey;
  //ETX


  void SetApplicationFontFamily ( const char *family);
  const char *GetApplicationFontFamily ( ) const;

  void SetApplicationFontSize ( const char *size );
  const char *GetApplicationFontSize ( ) const;

  void SetConfirmDelete(const char* state);
  const char* GetConfirmDelete() const;

  void SetModulePaths(const char *paths);
  const char* GetModulePaths() const;


  void SetPotentialModulePaths(const char *paths);
  const char* GetPotentialModulePaths() const;

  void AppendPotentialModulePath(const char *path, bool enabled);

  void SetColorFilePaths(const char *paths);
  const char *GetColorFilePaths() const;
  void SetPotentialColorFilePaths(const char *paths);
  const char* GetPotentialColorFilePaths() const;

  void SetExtensionsInstallPath(const char *path);
  const char* GetExtensionsInstallPath();

  void SetHomeModule (const char *name);
  const char *GetHomeModule() const;

  void SetWebBrowser ( const char *browser);
  const char* GetWebBrowser () const;

  void SetUnzip ( const char *unzip );
  const char *GetUnzip() const;
  void SetZip (const char *zip);
  const char *GetZip() const;

  void SetRm ( const char *rm );
  const char *GetRm() const;

  void SetTemporaryDirectory(const char *path);
  const char* GetTemporaryDirectory() const;

  void SetRemoteCacheDirectory(const char *path);
  const char* GetRemoteCacheDirectory() const;

  void SetBinDir(const char* path);
  const char* GetBinDir() const;

  const char* GetPluginsDir() const;

  void SetApplicationWindowSize (int width, int height );
  vtkGetMacro (ApplicationWindowWidth, int);
  vtkSetMacro (ApplicationWindowWidth, int);
  vtkGetMacro (ApplicationWindowHeight, int);
  vtkSetMacro (ApplicationWindowHeight, int);

  void SaveApplicationWindowConfiguration ( );

  vtkGetMacro (ApplicationSlicesFrameHeight, int );
  vtkSetMacro (ApplicationSlicesFrameHeight, int );
  vtkGetMacro (ApplicationLayoutType, int );
  vtkSetMacro (ApplicationLayoutType, int );
  vtkGetMacro (ApplicationLayoutCompareViewRows, int );
  vtkSetMacro (ApplicationLayoutCompareViewRows, int );
  vtkGetMacro (ApplicationLayoutCompareViewColumns, int );
  vtkSetMacro (ApplicationLayoutCompareViewColumns, int );
  vtkGetMacro (ApplicationLayoutLightboxRows, int );
  vtkSetMacro (ApplicationLayoutLightboxRows, int );
  vtkGetMacro (ApplicationLayoutLightboxColumns, int );
  vtkSetMacro (ApplicationLayoutLightboxColumns, int );

  vtkSetMacro(LoadModules, int);
  vtkGetMacro(LoadModules, int);
  vtkBooleanMacro(LoadModules, int);

  vtkSetObjectMacro(IgnoreModules, vtkStringArray);
  vtkGetObjectMacro(IgnoreModules, vtkStringArray);

  vtkSetObjectMacro(LoadableModules, vtkStringArray);
  vtkGetObjectMacro(LoadableModules, vtkStringArray);


  vtkSetMacro(LoadCommandLineModules, int);
  vtkGetMacro(LoadCommandLineModules, int);
  vtkBooleanMacro(LoadCommandLineModules, int);

  vtkSetMacro(EnableDaemon, int);
  vtkGetMacro(EnableDaemon, int);
  vtkBooleanMacro(EnableDaemon, int);

  void SetEnableAsynchronousIO ( int );
  vtkGetMacro(EnableAsynchronousIO, int);
  vtkBooleanMacro(EnableAsynchronousIO, int);

  void SetUseWelcomeModuleAtStartup (int );
  vtkGetMacro (UseWelcomeModuleAtStartup, int );
  vtkBooleanMacro (UseWelcomeModuleAtStartup, int );

  void SetEnableForceRedownload (int);
  vtkGetMacro(EnableForceRedownload, int);
  vtkBooleanMacro(EnableForceRedownload, int);

  void SetEnableRemoteCacheOverwriting (int);
  vtkGetMacro(EnableRemoteCacheOverwriting, int);
  vtkBooleanMacro(EnableRemoteCacheOverwriting, int);

  void SetRemoteCacheLimit ( int);
  vtkGetMacro (RemoteCacheLimit, int);

  void SetRemoteCacheFreeBufferSize ( int );
  vtkGetMacro (RemoteCacheFreeBufferSize, int);

  const char *Evaluate(const char *expression);

  bool RequestDisplayMessage( const char *type, const char* message );

  void ProcessDisplayMessage();

  virtual void WarningMessage(const char* message);
  virtual void ErrorMessage(const char* message);
  virtual void DebugMessage(const char* message);
  virtual void InformationMessage(const char* message);

  virtual void DisplayTclInteractor(vtkKWTopLevel *master);
  virtual void DisplayLogDialog(vtkKWTopLevel *master);

//BTX
  virtual void InitializePython(void* mod, void* dict);
  virtual void* GetPythonModule();
  virtual void* GetPythonDictionary();
//ETX

  virtual void AddAboutCopyrights(ostream &);

  vtkSetMacro (UseSplashScreen, int);
  vtkGetMacro (UseSplashScreen, int);


  vtkSetMacro (StereoEnabled, int);
  vtkGetMacro (StereoEnabled, int);

  void SplashMessage (const char * message);

  const char *TraceScript (const char *script) {return (this->Script(script));};
  const char *Eval (const char *script) {return (this->Script(script));};
  const char *Eval (const char *script, const char *args) {return (this->Script("%s %s", script, args));};

  virtual vtkKWColorPickerDialog* GetColorPickerDialog();

  const char* GetPlatform();
  const char* GetBuildDate();
  const char* GetSvnUrl();
  const char* GetSvnRevision();


 protected:
  vtkSlicerApplication ( );
  vtkSlicerApplication (const char* tmp_dir, const char* config_dir);
  virtual ~vtkSlicerApplication ( );

  vtkSlicerGUILayout *DefaultGeometry;
  vtkSlicerTheme *SlicerTheme;
  vtkSlicerApplicationGUI *ApplicationGUI;
  vtkSlicerGUICollection *ModuleGUICollection;

//BTX
  void StringToArray(std::string string, char separator, vtkStringArray *array);
  void ArrayToString(vtkStringArray *array, std::string sep, char *string, int maxLength );
//ETX

  char ConfirmDelete[vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char ModulePaths[vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char ColorFilePaths[vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char PotentialModulePaths[vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char PotentialColorFilePaths[vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char ExtensionsInstallPath[vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char ExtensionsInstallPathDefault[vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char WebBrowser [vtkKWRegistryHelper::RegistryKeyValueSizeMax ];
  char Unzip [vtkKWRegistryHelper::RegistryKeyValueSizeMax ];
  char Zip [vtkKWRegistryHelper::RegistryKeyValueSizeMax ];
  char Rm [vtkKWRegistryHelper::RegistryKeyValueSizeMax ];
  char TemporaryDirectory[vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char HomeModule [ vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char ApplicationFontSize [vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char ApplicationFontFamily [vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char IgnoreModuleNames [vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char BinDir [vtkKWRegistryHelper::RegistryKeyValueSizeMax];

  char Platform [vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char BuildDate [vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char SvnUrl [vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  char SvnRevision [vtkKWRegistryHelper::RegistryKeyValueSizeMax];

  int ApplicationWindowWidth;
  int ApplicationWindowHeight;
  int ApplicationSlicesFrameHeight;
  int ApplicationLayoutType;
  int ApplicationLayoutCompareViewRows;
  int ApplicationLayoutCompareViewColumns;
  int ApplicationLayoutLightboxRows;
  int ApplicationLayoutLightboxColumns;

  char RegistryHolder [vtkKWRegistryHelper::RegistryKeyValueSizeMax];

  vtkStringArray *IgnoreModules;
  vtkStringArray *LoadableModules;

  int LoadModules;
  int LoadCommandLineModules;
  int EnableDaemon;
  void* PythonModule;
  void* PythonDictionary;

  int EnableAsynchronousIO;
  int EnableForceRedownload;
  int EnableRemoteCacheOverwriting;
  char RemoteCacheDirectory[vtkKWRegistryHelper::RegistryKeyValueSizeMax];
  int RemoteCacheLimit;
  int RemoteCacheFreeBufferSize;

  int UseWelcomeModuleAtStartup;
  bool TemporaryDirectorySpecified;

  void PrintSelf ( ostream& os, vtkIndent indent );

private:
  vtkSlicerApplication ( const vtkSlicerApplication& ); 
  void operator = ( const vtkSlicerApplication& ); //Not implemented.

  //BTX
  void InitializeSlicer3Version();
  //ETX

  //BTX
  itk::MutexLock::Pointer DisplayMessageQueueActiveLock;
  itk::MutexLock::Pointer DisplayMessageQueueLock;
  std::string NameSeparator;
  //ETX

  bool DisplayMessageQueueActive;

  DisplayMessageQueue* InternalDisplayMessageQueue;

  static vtkSlicerApplication* Instance;

  int UseSplashScreen;
  int StereoEnabled;

  int ColorSwatchesAdded;

//BTX
  class vtkInternal;
  vtkInternal* Internal;
//ETX

};

#endif