OpenCPN Partial API docs
Loading...
Searching...
No Matches
base_platform.cpp File Reference

Implement base_platform.h – OpenCPN Platform specific support utilities. More...

#include <algorithm>
#include <cstdlib>
#include <string>
#include <vector>
#include <wx/wxprec.h>
#include <wx/wx.h>
#include <wx/app.h>
#include <wx/apptrait.h>
#include <wx/dir.h>
#include <wx/filename.h>
#include <wx/platinfo.h>
#include <wx/stdpaths.h>
#include <wx/textfile.h>
#include <wx/tokenzr.h>
#include "config.h"
#include "model/base_platform.h"
#include "model/cmdline.h"
#include "model/config_vars.h"
#include "model/gui_vars.h"
#include "model/logger.h"
#include "model/ocpn_utils.h"
#include "ocpn_plugin.h"

Go to the source code of this file.

Functions

void appendOSDirSlash (wxString *pString)
 
wxString GetPluginDataDir (const char *plugin_name)
 Returns an installed plugin's data directory given a plugin name.
 

Variables

BasePlatformg_BasePlatform
 points to g_platform, handles brain-dead MS linker.
 

Detailed Description

Implement base_platform.h – OpenCPN Platform specific support utilities.

Definition in file base_platform.cpp.

Function Documentation

◆ appendOSDirSlash()

void appendOSDirSlash ( wxString *  pString)

Definition at line 483 of file base_platform.cpp.

◆ GetPluginDataDir()

wxString GetPluginDataDir ( const char *  plugin_name)

Returns an installed plugin's data directory given a plugin name.

Platform-specific behavior:

  • On Linux: Searches directories from XDG_DATA_DIRS env variable for "opencpn/plugins/<plugin_name>"
  • On other platforms: Checks GetSharedDataDir() + "/opencpn/plugins/" + plugin_name
Parameters
plugin_nameThe name of the plugin to find data for (e.g., "weather_routing_pi")
Returns
Path to the plugin's data directory if found, empty string if not found
Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 294 of file base_platform.cpp.

Variable Documentation

◆ g_BasePlatform

BasePlatform* g_BasePlatform

points to g_platform, handles brain-dead MS linker.

Definition at line 100 of file base_platform.cpp.