Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.07 KB

FIX_PLUGIN_INFO.md

File metadata and controls

32 lines (22 loc) · 1.07 KB
Raw

Fix plugin information

Upcoming changes in main OpenCPN makes it important to provide correct information in the plugin API. In this context, "correct" means using the info defined in Plugin.cmake and hence in the plugin catalog.

In order to achieve this, first add these two lines to the top of config.h.in:

#ifndef CONFIG_H__
#define CONFIG_H__

Before the end, add these

#define PLUGIN_API_NAME "@PLUGIN_API_NAME@"
#define PKG_SUMMARY _("@PKG_SUMMARY@")
static const char* const PKG_DESCRIPTION = _(R"""(@PKG_DESCRIPTION@)""");

At the very end, add

#endif    // CONFIG_H__

In the next step redefine the API functions GetCommonName(), GetShortDescription() and GetLongDescription(). In the shipdriver case these lives in src/Shipdriver_pi.cpp and becomes:

wxString ShipDriver_pi::GetCommonName() { return PLUGIN_API_NAME; }
wxString ShipDriver_pi::GetShortDescription() { return PKG_SUMMARY; }
wxString ShipDriver_pi::GetLongDescription() { return PKG_DESCRIPTION; }

This is boilerplate code common for all plugins.