#include "project_downgrade.h"
#include <filesystem>
#include <system_error>
#include <utility>
#include <json_common.h>
#include <wx/dir.h>
#include <wx/ffile.h>
#include <wx/filefn.h>
#include <wx/filename.h>
#include <downgrade_scan.h>
#include <downgrade_target.h>
#include <drc_rules_downgrade.h>
#include <jobs/job_pcb_downgrade.h>
#include <jobs/job_sch_downgrade.h>
#include <kiway.h>
#include <libraries/library_table_parser.h>
#include <project/project_file_downgrade.h>
#include <wildcards_and_files_ext.h>

Classes
class	ERROR_COLLECTING_REPORTER

Functions
static bool	quoteLegacyLibraryTableValue (const std::string &aValue, bool aPreTen, std::string &aQuoted)

static bool	legacyLibraryTables (const wxString &aDir, const DOWNGRADE_TARGET &aTarget, std::vector< std::pair< wxString, wxString > > &aTables, wxString &aError)

static bool	downgradeProjectFileOnDisk (const wxString &aPath, const DOWNGRADE_TARGET &aTarget, COMPATIBILITY_REPORT &aReport)

static int	readSexprVersion (const wxString &aPath)

static wxString	firstTooNewFile (const wxString &aDir, const DOWNGRADE_TARGET &aTarget)

bool	ClassifyProjectForDowngrade (KIWAY &aKiway, const wxString &aProjectDir, const wxString &aProjectName, const wxString &aTargetName, COMPATIBILITY_REPORT &aReport, wxString &aError, std::vector< wxString > *aFoundVariants, bool aDropInsteadOfApproximate, const wxString &aVariant)
	Run the board and schematic classification for a whole project without writing anything.

bool	ExportProjectForDowngrade (KIWAY &aKiway, const wxString &aProjectDir, const wxString &aProjectName, const wxString &aTargetName, const wxString &aDestDir, wxString &aError, const wxString &aVariant, bool aDropInsteadOfApproximate)
	Export a downgraded copy of the project into aDestDir.

Function Documentation

◆ ClassifyProjectForDowngrade()

bool ClassifyProjectForDowngrade	(	KIWAY &	aKiway,
		const wxString &	aProjectDir,
		const wxString &	aProjectName,
		const wxString &	aTargetName,
		COMPATIBILITY_REPORT &	aReport,
		wxString &	aError,
		std::vector< wxString > *	aFoundVariants = nullptr,
		bool	aDropInsteadOfApproximate = false,
		const wxString &	aVariant = wxEmptyString )

Run the board and schematic classification for a whole project without writing anything.

Returns false with aError set when a document or requested variant cannot be exported. When the target drops variants, aFoundVariants receives the schematic's variant names for a picker. Use the same aVariant and aDropInsteadOfApproximate policy for the preview and the real export.

Definition at line 307 of file project_downgrade.cpp.

References _, COMPATIBILITY_REPORT::Add(), BLOCK, FILEEXT::DesignRulesFileExtension, DowngradeProjectFileJson(), DROP, KIWAY::FACE_PCB, KIWAY::FACE_SCH, FilterDrcRulesForTarget(), FindDowngradeTarget(), COMPATIBILITY_REPORT::IsBlocked(), FILEEXT::KiCadPcbFileExtension, FILEEXT::KiCadSchematicFileExtension, legacyLibraryTables(), JOB_PCB_DOWNGRADE::m_dropInsteadOfApproximate, JOB_SCH_DOWNGRADE::m_dropInsteadOfApproximate, DRC_RULES_FILTER_RESULT::m_dropped, JOB_PCB_DOWNGRADE::m_dryRun, JOB_SCH_DOWNGRADE::m_dryRun, DRC_RULES_FILTER_RESULT::m_error, JOB_PCB_DOWNGRADE::m_filename, JOB_SCH_DOWNGRADE::m_filename, JOB_SCH_DOWNGRADE::m_foundVariants, JOB_PCB_DOWNGRADE::m_libraryDir, JOB_SCH_DOWNGRADE::m_libraryDir, JOB_PCB_DOWNGRADE::m_report, JOB_SCH_DOWNGRADE::m_report, JOB_PCB_DOWNGRADE::m_target, JOB_SCH_DOWNGRADE::m_target, JOB_PCB_DOWNGRADE::m_variant, JOB_SCH_DOWNGRADE::m_variant, COMPATIBILITY_REPORT::Merge(), name, KIWAY::ProcessJob(), FILEEXT::ProjectFileExtension, reporter, and text.

Referenced by CLI::PROJECT_DOWNGRADE_COMMAND::doPerform(), and KICAD_MANAGER_CONTROL::ExportForOlderVersion().

◆ downgradeProjectFileOnDisk()

static bool downgradeProjectFileOnDisk	(	const wxString &	aPath,
		const DOWNGRADE_TARGET &	aTarget,
		COMPATIBILITY_REPORT &	aReport )

static

Definition at line 214 of file project_downgrade.cpp.

References DowngradeProjectFileJson(), COMPATIBILITY_REPORT::IsBlocked(), and text.

Referenced by ExportProjectForDowngrade().

◆ ExportProjectForDowngrade()

bool ExportProjectForDowngrade	(	KIWAY &	aKiway,
		const wxString &	aProjectDir,
		const wxString &	aProjectName,
		const wxString &	aTargetName,
		const wxString &	aDestDir,
		wxString &	aError,
		const wxString &	aVariant = wxEmptyString,
		bool	aDropInsteadOfApproximate = false )

Export a downgraded copy of the project into aDestDir.

The destination must be a new or empty folder. Copies design files only, downgrades them in the copy, and verifies the result. Fails closed: on any failure the destination is removed and aError explains why. The caller is expected to have classified first and obtained user consent. A non-empty aVariant is flattened into the export.

Definition at line 425 of file project_downgrade.cpp.

Referenced by CLI::PROJECT_DOWNGRADE_COMMAND::doPerform(), and KICAD_MANAGER_CONTROL::ExportForOlderVersion().

◆ firstTooNewFile()

static wxString firstTooNewFile	(	const wxString &	aDir,
		const DOWNGRADE_TARGET &	aTarget )

static

Definition at line 272 of file project_downgrade.cpp.

References IsDowngradeWorkingArtifact(), DOWNGRADE_TARGET::m_boardVersion, DOWNGRADE_TARGET::m_schVersion, DOWNGRADE_TARGET::m_symLibVersion, and readSexprVersion().

Referenced by ExportProjectForDowngrade().

◆ legacyLibraryTables()

static bool legacyLibraryTables	(	const wxString &	aDir,
		const DOWNGRADE_TARGET &	aTarget,
		std::vector< std::pair< wxString, wxString > > &	aTables,
		wxString &	aError )