api_handler_sch.cpp File Reference

#include <api/api_handler_sch.h>
#include <api/api_enums.h>
#include <api/api_sch_utils.h>
#include <api/api_utils.h>
#include <api/cross_probe_client.h>
#include <api/sch_context.h>
#include <fmt.h>
#include <fmt/ranges.h>
#include <wx/log.h>
#include <magic_enum.hpp>
#include <base_screen.h>
#include <jobs/job_export_bom.h>
#include <jobs/job_export_sch_netlist.h>
#include <jobs/job_export_sch_plot.h>
#include <kiway.h>
#include <plotters/plotter_png.h>
#include <sch_field.h>
#include <sch_group.h>
#include <common.h>
#include <connection_graph.h>
#include <sch_commit.h>
#include <string_utils.h>
#include <sch_edit_frame.h>
#include <io/kicad/kicad_io_utils.h>
#include <ki_error.h>
#include <richio.h>
#include <sch_io/kicad_sexpr/sch_io_kicad_sexpr.h>
#include <sch_label.h>
#include <sch_screen.h>
#include <sch_sheet.h>
#include <sch_sheet_path.h>
#include <sch_sheet_pin.h>
#include <sch_symbol.h>
#include <schematic.h>
#include <tool/actions.h>
#include <tool/tool_manager.h>
#include <tools/sch_actions.h>
#include <tools/sch_selection_tool.h>
#include <project.h>
#include <wildcards_and_files_ext.h>
#include <wx/filename.h>
#include <api/common/commands/library_commands.pb.h>
#include <api/common/types/base_types.pb.h>
#include <libraries/symbol_library_adapter.h>
#include <project_sch.h>
#include <trace_helpers.h>

Go to the source code of this file.

Functions
HANDLER_RESULT< types::RunJobResponse >	ExecuteSchematicJob (KIWAY *aKiway, JOB &aJob)
static std::optional< ApiResponseStatus >	applySchematicPlotSettings (const schematic::jobs::SchematicPlotSettings &aSettings, JOB_EXPORT_SCH_PLOT &aJob)
bool	findSymbolsAndPins (const SCH_SHEET_LIST &aSchematicSheetList, const SCH_SHEET_PATH &aSheetPath, std::unordered_map< wxString, std::vector< SCH_REFERENCE > > &aSyncSymMap, std::unordered_map< wxString, std::unordered_map< wxString, SCH_PIN * > > &aSyncPinMap, const wxString &aVariantName=wxEmptyString, bool aRecursive=false)
bool	sheetContainsOnlyWantedItems (const SCH_SHEET_LIST &aSchematicSheetList, const SCH_SHEET_PATH &aSheetPath, std::unordered_map< wxString, std::vector< SCH_REFERENCE > > &aSyncSymMap, std::unordered_map< wxString, std::unordered_map< wxString, SCH_PIN * > > &aSyncPinMap, std::unordered_map< SCH_SHEET_PATH, bool > &aCache)
std::optional< std::tuple< SCH_SHEET_PATH, SCH_ITEM *, std::vector< SCH_ITEM * > > >	findItemsFromSyncSelection (const SCHEMATIC &aSchematic, const kiapi::common::commands::SyncSelection &aSync)

Function Documentation

applySchematicPlotSettings()

static std::optional< ApiResponseStatus > applySchematicPlotSettings ( const schematic::jobs::SchematicPlotSettings & aSettings, JOB_EXPORT_SCH_PLOT & aJob )

static

Definition at line 1427 of file api_handler_sch.cpp.

References FromProtoEnum(), JOB_EXPORT_SCH_PLOT::m_blackAndWhite, JOB_EXPORT_SCH_PLOT::m_defaultFont, JOB_EXPORT_SCH_PLOT::m_drawingSheet, JOB_EXPORT_SCH_PLOT::m_minPenWidth, JOB_EXPORT_SCH_PLOT::m_pageSizeSelect, JOB_EXPORT_SCH_PLOT::m_plotAll, JOB_EXPORT_SCH_PLOT::m_plotDrawingSheet, JOB_EXPORT_SCH_PLOT::m_plotPages, JOB_EXPORT_SCH_PLOT::m_show_hop_over, JOB_EXPORT_SCH_PLOT::m_theme, JOB_EXPORT_SCH_PLOT::m_useBackgroundColor, and JOB_EXPORT_SCH_PLOT::m_variant.

Referenced by API_HANDLER_SCH::handleRunSchematicJobExportDxf(), API_HANDLER_SCH::handleRunSchematicJobExportPdf(), API_HANDLER_SCH::handleRunSchematicJobExportPng(), API_HANDLER_SCH::handleRunSchematicJobExportPs(), and API_HANDLER_SCH::handleRunSchematicJobExportSvg().

ExecuteSchematicJob()

HANDLER_RESULT< types::RunJobResponse > ExecuteSchematicJob	(	KIWAY *	aKiway,
		JOB &	aJob )

Definition at line 98 of file api_handler_sch.cpp.

References KIWAY::FACE_SCH, JOB::GetOutputs(), JOB::GetType(), KIWAY::ProcessJob(), and reporter.

Referenced by API_HANDLER_SCH::handleRunSchematicJobExportBOM(), API_HANDLER_SCH::handleRunSchematicJobExportDxf(), API_HANDLER_SCH::handleRunSchematicJobExportNetlist(), API_HANDLER_SCH::handleRunSchematicJobExportPdf(), API_HANDLER_SCH::handleRunSchematicJobExportPng(), API_HANDLER_SCH::handleRunSchematicJobExportPs(), and API_HANDLER_SCH::handleRunSchematicJobExportSvg().

findItemsFromSyncSelection()

std::optional< std::tuple< SCH_SHEET_PATH, SCH_ITEM *, std::vector< SCH_ITEM * > > > findItemsFromSyncSelection	(	const SCHEMATIC &	aSchematic,
		const kiapi::common::commands::SyncSelection &	aSync )

Definition at line 2049 of file api_handler_sch.cpp.

References SCHEMATIC::CurrentSheet(), findSymbolsAndPins(), SCHEMATIC::GetCurrentVariant(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), SCHEMATIC::Hierarchy(), SCH_SCREEN::Items(), SCH_SHEET_PATH::LastScreen(), EE_RTREE::OfType(), SCH_SHEET_PATH::Path(), pin, SCH_SHEET_T, and sheetContainsOnlyWantedItems().

Referenced by API_HANDLER_SCH::handleSyncSelection().

findSymbolsAndPins()

bool findSymbolsAndPins	(	const SCH_SHEET_LIST &	aSchematicSheetList,
		const SCH_SHEET_PATH &	aSheetPath,
		std::unordered_map< wxString, std::vector< SCH_REFERENCE > > &	aSyncSymMap,
		std::unordered_map< wxString, std::unordered_map< wxString, SCH_PIN * > > &	aSyncPinMap,
		const wxString &	aVariantName = wxEmptyString,
		bool	aRecursive = false )

Definition at line 1889 of file api_handler_sch.cpp.

References ExpandStackedPinNotation(), findSymbolsAndPins(), SCH_REFERENCE_LIST::GetCount(), SCH_SYMBOL::GetPins(), SCH_REFERENCE::GetRef(), SCH_REFERENCE::GetRefNumber(), SCH_REFERENCE::GetSymbol(), SCH_SHEET_PATH::GetSymbols(), SCH_REFERENCE::GetUnit(), SCH_SHEET_PATH::IsContainedWithin(), SCH_REFERENCE::IsSplitNeeded(), pad, pin, SCH_REFERENCE::Split(), and SYMBOL_FILTER_NON_POWER.

Referenced by findItemsFromSyncSelection(), and findSymbolsAndPins().

sheetContainsOnlyWantedItems()

bool sheetContainsOnlyWantedItems	(	const SCH_SHEET_LIST &	aSchematicSheetList,
		const SCH_SHEET_PATH &	aSheetPath,
		std::unordered_map< wxString, std::vector< SCH_REFERENCE > > &	aSyncSymMap,
		std::unordered_map< wxString, std::unordered_map< wxString, SCH_PIN * > > &	aSyncPinMap,
		std::unordered_map< SCH_SHEET_PATH, bool > &	aCache )

Definition at line 1976 of file api_handler_sch.cpp.

References SCH_REFERENCE_LIST::GetCount(), SCH_REFERENCE::GetRef(), SCH_REFERENCE::GetRefNumber(), SCH_SHEET_PATH::GetSymbols(), SCH_SHEET_PATH::IsContainedWithin(), SCH_REFERENCE::IsSplitNeeded(), sheetContainsOnlyWantedItems(), SCH_REFERENCE::Split(), and SYMBOL_FILTER_NON_POWER.

Referenced by findItemsFromSyncSelection(), and sheetContainsOnlyWantedItems().