KiCad PCB EDA Suite
Loading...
Searching...
No Matches
kiface_services.h File Reference
#include <set>
#include <string>
#include <type_traits>
#include <wx/string.h>
#include <kiface_ids.h>
#include <kiway.h>

Go to the source code of this file.

Classes

struct  KIFACE_SERVICE< aId, T >
 Describes an object or function exported by a KIFACE through IfaceOrAddress() More...
 

Namespaces

namespace  KICAD_DIFF
 

Typedefs

using KIFACE_FOOTPRINT_LIBRARY_ADAPTER_SERVICE
 
using KIFACE_FILTER_FOOTPRINTS_SERVICE
 
using KIFACE_TRIGGER_FOOTPRINTS_LOAD_SERVICE
 
using KIFACE_FOOTPRINTS_LOAD_PROGRESS_SERVICE
 
using KIFACE_FILTER_FOOTPRINT_USERS_SERVICE
 
using KIFACE_TRIGGER_SYMBOLS_LOAD_SERVICE
 
using KIFACE_SYMBOLS_LOAD_PROGRESS_SERVICE
 
using KIFACE_NETLIST_SCHEMATIC_SERVICE
 
using KIFACE_MERGE_DOCUMENT_SERVICE
 
using KIFACE_OPEN_DIFF_DIALOG_SERVICE
 
using KIFACE_ATTACH_DIFF_CANVASES_SERVICE
 
using KIFACE_TEST_FOOTPRINT_LINK_SERVICE
 
using KIFACE_FOOTPRINT_PAD_NUMBERS_SERVICE
 

Functions

template<typename Service, typename T>
void * KifaceServiceAddress (T aAddress)
 Return a service address for IfaceOrAddress().
 
template<typename Service>
Service::Type GetKifaceService (KIFACE *aKiface)
 Look up a service exported by a KIFACE.
 

Typedef Documentation

◆ KIFACE_ATTACH_DIFF_CANVASES_SERVICE

Initial value:
KICAD_DIFF::DIFF_CANVAS_CONTEXT* (*)( int, const wxString&, const wxString&,
Keeps the documents drawn on a pair of diff canvases alive.
A pure virtual class used to derive REPORTER objects from.
Definition reporter.h:73
GAL-backed canvas for visualizing a KICAD_DIFF::DIFF_SCENE.
@ KIFACE_ATTACH_DIFF_CANVASES
KICAD_DIFF::DIFF_CANVAS_CONTEXT* (*)( int aKind, const wxString& aFileA, const wxString& aFileB,...
Definition kiface_ids.h:85
The full set of changes between two parsed documents of one type.
Describes an object or function exported by a KIFACE through IfaceOrAddress()

Definition at line 88 of file kiface_services.h.

◆ KIFACE_FILTER_FOOTPRINT_USERS_SERVICE

Initial value:
KIFACE_SERVICE<KIFACE_FILTER_FOOTPRINT_USERS, wxString (*)( const wxString& )>
@ KIFACE_FILTER_FOOTPRINT_USERS
Function pointer type: wxString (*)(const wxString& aQueryJson) Input JSON: the object written by FOO...
Definition kiface_ids.h:50

Definition at line 66 of file kiface_services.h.

◆ KIFACE_FILTER_FOOTPRINTS_SERVICE

Initial value:
KIFACE_SERVICE<KIFACE_FILTER_FOOTPRINTS, wxString (*)( const wxString& )>
@ KIFACE_FILTER_FOOTPRINTS
Function pointer type: wxString (*)(const wxString& aFilterJson) Input JSON: {"pin_count": N,...
Definition kiface_ids.h:35

Definition at line 57 of file kiface_services.h.

◆ KIFACE_FOOTPRINT_LIBRARY_ADAPTER_SERVICE

◆ KIFACE_FOOTPRINT_PAD_NUMBERS_SERVICE

Initial value:
void (*)( const wxString&, PROJECT*, std::set<wxString>& )>
Container for project specific data.
Definition project.h:63
@ KIFACE_FOOTPRINT_PAD_NUMBERS
Function pointer type: void (*)( const wxString& aFootprint, PROJECT* aProject, std::set<wxString>& a...
Definition kiface_ids.h:95

Definition at line 97 of file kiface_services.h.

◆ KIFACE_FOOTPRINTS_LOAD_PROGRESS_SERVICE

Initial value:
@ KIFACE_FOOTPRINTS_LOAD_PROGRESS
Function pointer type: float (*)() Returns how far the library loader has gotten as a fraction of the...
Definition kiface_ids.h:45

Definition at line 63 of file kiface_services.h.

◆ KIFACE_MERGE_DOCUMENT_SERVICE

Initial value:
KIFACE_SERVICE<KIFACE_MERGE_DOCUMENT, int (*)( int, const wxString&, const wxString&,
const wxString&, const wxString&, bool, bool,
@ KIFACE_MERGE_DOCUMENT
int (*)( int aKind, const wxString& aAncestor, const wxString& aOurs, const wxString& aTheirs,...
Definition kiface_ids.h:70

Definition at line 78 of file kiface_services.h.

◆ KIFACE_NETLIST_SCHEMATIC_SERVICE

Initial value:
KIFACE_SERVICE<KIFACE_NETLIST_SCHEMATIC, bool (*)( const wxString&, std::string&, KIWAY* )>
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:348
@ KIFACE_NETLIST_SCHEMATIC
Definition kiface_ids.h:63

Definition at line 75 of file kiface_services.h.

◆ KIFACE_OPEN_DIFF_DIALOG_SERVICE

Initial value:
KIFACE_SERVICE<KIFACE_OPEN_DIFF_DIALOG, int (*)( int, const wxString&, const wxString&,
const wxString&, const wxString&, wxWindow*,
@ KIFACE_OPEN_DIFF_DIALOG
int (*)( int aKind, const wxString& aFileA, const wxString& aFileB, const wxString& aLabelA,...
Definition kiface_ids.h:77

Definition at line 83 of file kiface_services.h.

◆ KIFACE_SYMBOLS_LOAD_PROGRESS_SERVICE

Initial value:
@ KIFACE_SYMBOLS_LOAD_PROGRESS
Function pointer type: float (*)() Returns how far the library loader has gotten as a fraction of the...
Definition kiface_ids.h:60

Definition at line 72 of file kiface_services.h.

◆ KIFACE_TEST_FOOTPRINT_LINK_SERVICE

Initial value:
KIFACE_SERVICE<KIFACE_TEST_FOOTPRINT_LINK, int (*)( const wxString&, PROJECT* )>
@ KIFACE_TEST_FOOTPRINT_LINK
Definition kiface_ids.h:87

Definition at line 94 of file kiface_services.h.

◆ KIFACE_TRIGGER_FOOTPRINTS_LOAD_SERVICE

Initial value:
@ KIFACE_TRIGGER_FOOTPRINTS_LOAD
Function pointer type: bool (*)() Starts loading the footprint libraries in the background.
Definition kiface_ids.h:40

Definition at line 60 of file kiface_services.h.

◆ KIFACE_TRIGGER_SYMBOLS_LOAD_SERVICE

Initial value:
@ KIFACE_TRIGGER_SYMBOLS_LOAD
Function pointer type: bool (*)() Starts loading the symbol libraries in the background.
Definition kiface_ids.h:55

Definition at line 69 of file kiface_services.h.

Function Documentation

◆ GetKifaceService()

◆ KifaceServiceAddress()

template<typename Service, typename T>
void * KifaceServiceAddress ( T aAddress)

Return a service address for IfaceOrAddress().

Template Parameters
Serviceis the KIFACE_SERVICE descriptor for the exported object
Parameters
aAddressis the producer's object or function address

Definition at line 108 of file kiface_services.h.

References T.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CV::IFACE::IfaceOrAddress(), PCB::IFACE::IfaceOrAddress(), and SCH::IFACE::IfaceOrAddress().