base_platform.h

/***************************************************************************
 *
 * Project:  OpenCPN
 * Purpose:  Basic platform specific support utilities without GUI deps.
 * Author:   David Register
 *
 ***************************************************************************
 *   Copyright (C) 2015 by David S. Register                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,  USA.         *
 **************************************************************************/
 
#ifndef BASEPLATFORM_H
#define BASEPLATFORM_H
 
#include <stdio.h>
#include <vector>
 
#include <wx/wxprec.h>
 
#ifndef WX_PRECOMP
#include <wx/wx.h>
#endif  // precompiled headers
 
#include <wx/gdicmn.h>
#include <wx/log.h>
#include <wx/stdpaths.h>
#include <wx/clrpicker.h>
#include <wx/colourdata.h>
#include <wx/colordlg.h>
 
#define PLATFORM_CAP_PLUGINS 1
#define PLATFORM_CAP_FASTPAN 2
 
class BasePlatform;  // forward
 
extern BasePlatform* g_BasePlatform;
 
typedef struct {
  char tsdk[20];
  char hn[20];
  char msdk[20];
} PlatSpec;
 
void appendOSDirSlash(wxString* path);
 
struct OCPN_OSDetail {
  OCPN_OSDetail() {};
  ~OCPN_OSDetail() {};
 
  std::string osd_name;
  std::string osd_version;
  std::vector<std::string> osd_names_like;
  std::string osd_arch;
  std::string osd_ID;
};
 
class AbstractPlatform {
public:
  AbstractPlatform() = default;
  virtual ~AbstractPlatform() = default;
 
  wxString& GetPrivateDataDir();
 
  wxString& DefaultPrivateDataDir();
 
  wxString* GetPluginDirPtr();
  wxString* GetSharedDataDirPtr();
 
  wxString* GetPrivateDataDirPtr();
 
  wxString& GetPluginDir();
 
  wxString GetSupplementalLicenseString();
 
  wxStandardPaths& GetStdPaths();
 
  wxString GetWinPluginBaseDir();
 
  wxString& GetSharedDataDir();
  wxString& GetExePath();
  wxString& GetHomeDir();
  wxString GetWritableDocumentsDir();
 
  wxString GetPluginDataPath();
 
  wxString& GetConfigFileName();
  wxString& GetLogFileName() { return mlog_file; }
 
  bool isFlatpacked() { return m_isFlatpacked; }
 
  bool isPlatformCapable(int flag);
  OCPN_OSDetail* GetOSDetail() { return m_osDetail; }
 
  void CloseLogFile(void);
  virtual bool InitializeLogFile(void) = 0;
  wxString& GetLargeLogMessage(void) { return large_log_message; }
  FILE* GetLogFilePtr() { return flog; }
 
  wxString NormalizePath(const wxString& full_path);
 
  virtual wxSize getDisplaySize() { return wxSize(); }
  virtual double GetDisplaySizeMM() { return 1.0; }
  virtual double GetDisplayDPmm() { return 1.0; }
  virtual unsigned int GetSelectRadiusPix();
 
  double GetDisplayDIPMult(wxWindow* win);
 
  virtual int GetSvgStdIconSize(const wxWindow* w, bool touch) = 0;
 
  static void ShowBusySpinner();
  static void HideBusySpinner();
 
protected:
  bool DetectOSDetail(OCPN_OSDetail* detail);
 
  wxString m_default_private_datadir;
  wxString m_PrivateDataDir;
  wxString m_PluginsDir;
  bool m_isFlatpacked;
  wxString m_homeDir;
  wxString m_exePath;
  wxString m_SData_Dir;
  wxString m_config_file_name;
  wxString m_pluginDataPath;
  wxString mlog_file;
 
  OCPN_OSDetail* m_osDetail;
 
  FILE* flog;
  wxLog* m_old_logger;
  wxString large_log_message;
 
  std::vector<int> m_displaySizeMMOverride;
 
#ifdef _MSC_VER
  bool GetWindowsMonitorSize(int* width, int* height);
#endif
  int m_monitorWidth, m_monitorHeight;
  bool m_bdisableWindowsDisplayEnum;
  static bool m_isBusy;
};
 
class BasePlatform : public AbstractPlatform {
public:
  BasePlatform();
  ~BasePlatform();
 
  bool InitializeLogFile() override;
 
  wxSize getDisplaySize() override;
  double GetDisplaySizeMM() override;
  double GetDisplayDPmm() override;
  int GetSvgStdIconSize(const wxWindow* w, bool touch) override;
};
 
#endif  //  BASEPLATFORM_H