KiCad PCB EDA Suite
BIN_MOD Struct Reference

Pertains to a single program module, either an EXE or a DSO/DLL ("bin_mod"). More...

#include <bin_mod.h>

Public Member Functions

 BIN_MOD (const char *aName)
 
 ~BIN_MOD ()
 
void Init ()
 
void End ()
 
void InitSettings (APP_SETTINGS_BASE *aPtr)
 Takes ownership of a new application settings object. More...
 

Public Attributes

const char * m_name
 name of this binary module, static C string. More...
 
APP_SETTINGS_BASEm_config
 maybe from $HOME/.${m_name} More...
 
wxString m_help_file
 
SEARCH_STACK m_search
 

Detailed Description

Pertains to a single program module, either an EXE or a DSO/DLL ("bin_mod").

It manages miscellaneous configuration file information pertinent to one bin_mod. Because it serves in both DSO/DLLs and in EXEs, its name is neutral. Accessors are in containing (wrapper) classes.

Definition at line 40 of file bin_mod.h.

Constructor & Destructor Documentation

◆ BIN_MOD()

BIN_MOD::BIN_MOD ( const char *  aName)

Definition at line 31 of file bin_mod.cpp.

31  :
32  m_name( aName ),
33  m_config( nullptr )
34 {
35 }
APP_SETTINGS_BASE * m_config
maybe from $HOME/.${m_name}
Definition: bin_mod.h:57
const char * m_name
name of this binary module, static C string.
Definition: bin_mod.h:55

◆ ~BIN_MOD()

BIN_MOD::~BIN_MOD ( )

Definition at line 62 of file bin_mod.cpp.

63 {
64 }

Member Function Documentation

◆ End()

void BIN_MOD::End ( )

Definition at line 50 of file bin_mod.cpp.

51 {
52  if( m_config )
53  {
54  // The settings manager will outlive this module so we need to clean up the module level
55  // settings here instead of leaving it up to the manager
56  Pgm().GetSettingsManager().FlushAndRelease( m_config );
57  m_config = nullptr;
58  }
59 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
APP_SETTINGS_BASE * m_config
maybe from $HOME/.${m_name}
Definition: bin_mod.h:57

References m_config, and Pgm().

Referenced by PGM_KICAD::Destroy(), and KIFACE_I::end_common().

◆ Init()

void BIN_MOD::Init ( )

Definition at line 38 of file bin_mod.cpp.

39 {
40  // Prepare On Line Help. Use only lower case for help file names, in order to
41  // avoid problems with upper/lower case file names under windows and unix.
42  // Help files are now using html format.
43  // Old help files used pdf format.
44  // so when searching a help file, the .html file will be searched,
45  // and if not found, the .pdf file will be searched.
46  m_help_file = wxString::FromUTF8( m_name ); // no ext given. can be .html or .pdf
47 }
wxString m_help_file
Definition: bin_mod.h:58
const char * m_name
name of this binary module, static C string.
Definition: bin_mod.h:55

References m_help_file, and m_name.

Referenced by PGM_KICAD::OnPgmInit(), and KIFACE_I::start_common().

◆ InitSettings()

void BIN_MOD::InitSettings ( APP_SETTINGS_BASE aPtr)
inline

Takes ownership of a new application settings object.

Parameters
aPtris the settings object for this module.

Definition at line 53 of file bin_mod.h.

53 { m_config = aPtr; }
APP_SETTINGS_BASE * m_config
maybe from $HOME/.${m_name}
Definition: bin_mod.h:57

References m_config.

Referenced by KIFACE_I::InitSettings(), and PGM_KICAD::OnPgmInit().

Member Data Documentation

◆ m_config

APP_SETTINGS_BASE* BIN_MOD::m_config

maybe from $HOME/.${m_name}

Definition at line 57 of file bin_mod.h.

Referenced by End(), InitSettings(), KIFACE_I::KifaceSettings(), and PGM_KICAD::PgmSettings().

◆ m_help_file

wxString BIN_MOD::m_help_file

Definition at line 58 of file bin_mod.h.

Referenced by PGM_KICAD::GetHelpFileName(), KIFACE_I::GetHelpFileName(), and Init().

◆ m_name

const char* BIN_MOD::m_name

name of this binary module, static C string.

Definition at line 55 of file bin_mod.h.

Referenced by Init(), and KIFACE_I::Name().

◆ m_search


The documentation for this struct was generated from the following files: