You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1263 lines
50 KiB

8 years ago
14 years ago
4 years ago
6 years ago
14 years ago
  1. /*
  2. * This program source code file is part of KiCad, a free EDA CAD application.
  3. *
  4. * Copyright (C) 1992-2022 KiCad Developers, see AUTHORS.txt for contributors.
  5. *
  6. * This program is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU General Public License
  8. * as published by the Free Software Foundation; either version 2
  9. * of the License, or (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program; if not, you may find one here:
  18. * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
  19. * or you may search the http://www.gnu.org website for the version 2 license,
  20. * or you may write to the Free Software Foundation, Inc.,
  21. * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  22. */
  23. #include <pcb_dimension.h>
  24. #include <pcb_track.h>
  25. #include <layer_ids.h>
  26. #include <kiface_base.h>
  27. #include <pad.h>
  28. #include <board_design_settings.h>
  29. #include <drc/drc_item.h>
  30. #include <drc/drc_engine.h>
  31. #include <settings/json_settings_internals.h>
  32. #include <settings/parameters.h>
  33. #include <project/project_file.h>
  34. #include <advanced_config.h>
  35. #include <pcbnew.h>
  36. const int bdsSchemaVersion = 2;
  37. BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS( JSON_SETTINGS* aParent, const std::string& aPath ) :
  38. NESTED_SETTINGS( "board_design_settings", bdsSchemaVersion, aParent, aPath )
  39. {
  40. // We want to leave alone parameters that aren't found in the project JSON as they may be
  41. // initialized by the board file parser before NESTED_SETTINGS::LoadFromFile is called.
  42. m_resetParamsIfMissing = false;
  43. // Create a default NET_SETTINGS so that things don't break horribly if there's no project
  44. // loaded. This also is used during file load for legacy boards that have netclasses stored
  45. // in the file. After load, this information will be moved to the project and the pointer
  46. // updated.
  47. m_NetSettings = std::make_shared<NET_SETTINGS>( nullptr, "" );
  48. m_HasStackup = false; // no stackup defined by default
  49. m_Pad_Master = std::make_unique<PAD>( nullptr );
  50. LSET all_set = LSET().set();
  51. m_enabledLayers = all_set; // All layers enabled at first.
  52. // SetCopperLayerCount() will adjust this.
  53. SetCopperLayerCount( 2 ); // Default design is a double sided board
  54. m_CurrentViaType = VIATYPE::THROUGH;
  55. // if true, when creating a new track starting on an existing track, use this track width
  56. m_UseConnectedTrackWidth = false;
  57. m_TempOverrideTrackWidth = false;
  58. // First is always the reference designator
  59. m_DefaultFPTextItems.emplace_back( wxT( "REF**" ), true, F_SilkS );
  60. // Second is always the value
  61. m_DefaultFPTextItems.emplace_back( wxT( "" ), true, F_Fab );
  62. // Any following ones are freebies
  63. m_DefaultFPTextItems.emplace_back( wxT( "${REFERENCE}" ), true, F_Fab );
  64. m_LineThickness[ LAYER_CLASS_SILK ] = Millimeter2iu( DEFAULT_SILK_LINE_WIDTH );
  65. m_TextSize[ LAYER_CLASS_SILK ] = wxSize( Millimeter2iu( DEFAULT_SILK_TEXT_SIZE ),
  66. Millimeter2iu( DEFAULT_SILK_TEXT_SIZE ) );
  67. m_TextThickness[ LAYER_CLASS_SILK ] = Millimeter2iu( DEFAULT_SILK_TEXT_WIDTH );
  68. m_TextItalic[ LAYER_CLASS_SILK ] = false;
  69. m_TextUpright[ LAYER_CLASS_SILK ] = false;
  70. m_LineThickness[ LAYER_CLASS_COPPER ] = Millimeter2iu( DEFAULT_COPPER_LINE_WIDTH );
  71. m_TextSize[ LAYER_CLASS_COPPER ] = wxSize( Millimeter2iu( DEFAULT_COPPER_TEXT_SIZE ),
  72. Millimeter2iu( DEFAULT_COPPER_TEXT_SIZE ) );
  73. m_TextThickness[ LAYER_CLASS_COPPER ] = Millimeter2iu( DEFAULT_COPPER_TEXT_WIDTH );
  74. m_TextItalic[ LAYER_CLASS_COPPER ] = false;
  75. m_TextUpright[ LAYER_CLASS_COPPER ] = false;
  76. // Edges & Courtyards; text properties aren't used but better to have them holding
  77. // reasonable values than not.
  78. m_LineThickness[ LAYER_CLASS_EDGES ] = Millimeter2iu( DEFAULT_EDGE_WIDTH );
  79. m_TextSize[ LAYER_CLASS_EDGES ] = wxSize( Millimeter2iu( DEFAULT_TEXT_SIZE ),
  80. Millimeter2iu( DEFAULT_TEXT_SIZE ) );
  81. m_TextThickness[ LAYER_CLASS_EDGES ] = Millimeter2iu( DEFAULT_TEXT_WIDTH );
  82. m_TextItalic[ LAYER_CLASS_EDGES ] = false;
  83. m_TextUpright[ LAYER_CLASS_EDGES ] = false;
  84. m_LineThickness[ LAYER_CLASS_COURTYARD ] = Millimeter2iu( DEFAULT_COURTYARD_WIDTH );
  85. m_TextSize[ LAYER_CLASS_COURTYARD ] = wxSize( Millimeter2iu( DEFAULT_TEXT_SIZE ),
  86. Millimeter2iu( DEFAULT_TEXT_SIZE ) );
  87. m_TextThickness[ LAYER_CLASS_COURTYARD ] = Millimeter2iu( DEFAULT_TEXT_WIDTH );
  88. m_TextItalic[ LAYER_CLASS_COURTYARD ] = false;
  89. m_TextUpright[ LAYER_CLASS_COURTYARD ] = false;
  90. m_LineThickness[ LAYER_CLASS_FAB ] = Millimeter2iu( DEFAULT_LINE_WIDTH );
  91. m_TextSize[ LAYER_CLASS_FAB ] = wxSize( Millimeter2iu( DEFAULT_TEXT_SIZE ),
  92. Millimeter2iu( DEFAULT_TEXT_SIZE ) );
  93. m_TextThickness[ LAYER_CLASS_FAB ] = Millimeter2iu( DEFAULT_TEXT_WIDTH );
  94. m_TextItalic[ LAYER_CLASS_FAB ] = false;
  95. m_TextUpright[ LAYER_CLASS_FAB ] = false;
  96. m_LineThickness[ LAYER_CLASS_OTHERS ] = Millimeter2iu( DEFAULT_LINE_WIDTH );
  97. m_TextSize[ LAYER_CLASS_OTHERS ] = wxSize( Millimeter2iu( DEFAULT_TEXT_SIZE ),
  98. Millimeter2iu( DEFAULT_TEXT_SIZE ) );
  99. m_TextThickness[ LAYER_CLASS_OTHERS ] = Millimeter2iu( DEFAULT_TEXT_WIDTH );
  100. m_TextItalic[ LAYER_CLASS_OTHERS ] = false;
  101. m_TextUpright[ LAYER_CLASS_OTHERS ] = false;
  102. m_DimensionPrecision = 4;
  103. m_DimensionUnitsMode = DIM_UNITS_MODE::AUTOMATIC;
  104. m_DimensionUnitsFormat = DIM_UNITS_FORMAT::BARE_SUFFIX;
  105. m_DimensionSuppressZeroes = false;
  106. m_DimensionTextPosition = DIM_TEXT_POSITION::OUTSIDE;
  107. m_DimensionKeepTextAligned = true;
  108. m_DimensionArrowLength = Mils2iu( DEFAULT_DIMENSION_ARROW_LENGTH );
  109. m_DimensionExtensionOffset = Millimeter2iu( DEFAULT_DIMENSION_EXTENSION_OFFSET );
  110. m_useCustomTrackVia = false;
  111. m_customTrackWidth = Millimeter2iu( DEFAULT_CUSTOMTRACKWIDTH );
  112. m_customViaSize.m_Diameter = Millimeter2iu( DEFAULT_VIASMINSIZE );
  113. m_customViaSize.m_Drill = Millimeter2iu( DEFAULT_MINTHROUGHDRILL );
  114. m_useCustomDiffPair = false;
  115. m_customDiffPair.m_Width = Millimeter2iu( DEFAULT_CUSTOMDPAIRWIDTH );
  116. m_customDiffPair.m_Gap = Millimeter2iu( DEFAULT_CUSTOMDPAIRGAP );
  117. m_customDiffPair.m_ViaGap = Millimeter2iu( DEFAULT_CUSTOMDPAIRVIAGAP );
  118. m_MinClearance = Millimeter2iu( DEFAULT_MINCLEARANCE );
  119. m_MinConn = Millimeter2iu( DEFAULT_MINCONNECTION );
  120. m_TrackMinWidth = Millimeter2iu( DEFAULT_TRACKMINWIDTH );
  121. m_ViasMinAnnularWidth = Millimeter2iu( DEFAULT_VIASMINSIZE - DEFAULT_MINTHROUGHDRILL ) / 2;
  122. m_ViasMinSize = Millimeter2iu( DEFAULT_VIASMINSIZE );
  123. m_MinThroughDrill = Millimeter2iu( DEFAULT_MINTHROUGHDRILL );
  124. m_MicroViasMinSize = Millimeter2iu( DEFAULT_MICROVIASMINSIZE );
  125. m_MicroViasMinDrill = Millimeter2iu( DEFAULT_MICROVIASMINDRILL );
  126. m_CopperEdgeClearance = Millimeter2iu( DEFAULT_COPPEREDGECLEARANCE );
  127. m_HoleClearance = Millimeter2iu( DEFAULT_HOLECLEARANCE );
  128. m_HoleToHoleMin = Millimeter2iu( DEFAULT_HOLETOHOLEMIN );
  129. m_SilkClearance = Millimeter2iu( DEFAULT_SILKCLEARANCE );
  130. m_MinResolvedSpokes = DEFAULT_MINRESOLVEDSPOKES;
  131. m_MinSilkTextHeight = Millimeter2iu( DEFAULT_SILK_TEXT_SIZE * 0.8 );
  132. m_MinSilkTextThickness= Millimeter2iu( DEFAULT_SILK_TEXT_WIDTH * 0.8 );
  133. for( int errorCode = DRCE_FIRST; errorCode <= DRCE_LAST; ++errorCode )
  134. m_DRCSeverities[ errorCode ] = RPT_SEVERITY_ERROR;
  135. m_DRCSeverities[ DRCE_DRILLED_HOLES_COLOCATED ] = RPT_SEVERITY_WARNING;
  136. m_DRCSeverities[ DRCE_MISSING_COURTYARD ] = RPT_SEVERITY_IGNORE;
  137. m_DRCSeverities[ DRCE_PTH_IN_COURTYARD ] = RPT_SEVERITY_IGNORE;
  138. m_DRCSeverities[ DRCE_NPTH_IN_COURTYARD ] = RPT_SEVERITY_IGNORE;
  139. m_DRCSeverities[ DRCE_DANGLING_TRACK ] = RPT_SEVERITY_WARNING;
  140. m_DRCSeverities[ DRCE_DANGLING_VIA ] = RPT_SEVERITY_WARNING;
  141. m_DRCSeverities[ DRCE_COPPER_SLIVER ] = RPT_SEVERITY_WARNING;
  142. m_DRCSeverities[ DRCE_ISOLATED_COPPER ] = RPT_SEVERITY_WARNING;
  143. m_DRCSeverities[ DRCE_PADSTACK ] = RPT_SEVERITY_WARNING;
  144. m_DRCSeverities[ DRCE_OVERLAPPING_PADS ] = RPT_SEVERITY_WARNING;
  145. m_DRCSeverities[ DRCE_MISSING_FOOTPRINT ] = RPT_SEVERITY_WARNING;
  146. m_DRCSeverities[ DRCE_DUPLICATE_FOOTPRINT ] = RPT_SEVERITY_WARNING;
  147. m_DRCSeverities[ DRCE_EXTRA_FOOTPRINT ] = RPT_SEVERITY_WARNING;
  148. m_DRCSeverities[ DRCE_NET_CONFLICT ] = RPT_SEVERITY_WARNING;
  149. m_DRCSeverities[ DRCE_OVERLAPPING_SILK ] = RPT_SEVERITY_WARNING;
  150. m_DRCSeverities[ DRCE_SILK_CLEARANCE ] = RPT_SEVERITY_WARNING;
  151. m_DRCSeverities[ DRCE_SILK_EDGE_CLEARANCE ] = RPT_SEVERITY_WARNING;
  152. m_DRCSeverities[ DRCE_TEXT_HEIGHT ] = RPT_SEVERITY_WARNING;
  153. m_DRCSeverities[ DRCE_TEXT_THICKNESS ] = RPT_SEVERITY_WARNING;
  154. m_DRCSeverities[ DRCE_FOOTPRINT_TYPE_MISMATCH ] = RPT_SEVERITY_WARNING;
  155. m_DRCSeverities[ DRCE_LIB_FOOTPRINT_ISSUES ] = RPT_SEVERITY_WARNING;
  156. m_DRCSeverities[ DRCE_LIB_FOOTPRINT_MISMATCH ] = RPT_SEVERITY_WARNING;
  157. // TODO: Change to warning after testing
  158. m_DRCSeverities[ DRCE_CONNECTION_WIDTH ] = RPT_SEVERITY_IGNORE;
  159. m_MaxError = ARC_HIGH_DEF;
  160. m_ZoneKeepExternalFillets = false;
  161. m_UseHeightForLengthCalcs = true;
  162. // Global mask margins:
  163. m_SolderMaskExpansion = Millimeter2iu( DEFAULT_SOLDERMASK_EXPANSION );
  164. m_SolderMaskMinWidth = Millimeter2iu( DEFAULT_SOLDERMASK_MIN_WIDTH );
  165. m_SolderMaskToCopperClearance = Millimeter2iu( DEFAULT_SOLDERMASK_TO_COPPER_CLEARANCE );
  166. // Solder paste margin absolute value
  167. m_SolderPasteMargin = Millimeter2iu( DEFAULT_SOLDERPASTE_CLEARANCE );
  168. // Solder paste margin as a ratio of pad size
  169. // The final margin is the sum of these 2 values
  170. // Usually < 0 because the mask is smaller than pad
  171. m_SolderPasteMarginRatio = DEFAULT_SOLDERPASTE_RATIO;
  172. m_AllowSoldermaskBridgesInFPs = false;
  173. // Layer thickness for 3D viewer
  174. m_boardThickness = Millimeter2iu( DEFAULT_BOARD_THICKNESS_MM );
  175. m_viaSizeIndex = 0;
  176. m_trackWidthIndex = 0;
  177. m_diffPairIndex = 0;
  178. // Parameters stored in JSON in the project file
  179. // NOTE: Previously, BOARD_DESIGN_SETTINGS stored the basic board layer information (layer
  180. // names and enable/disable state) in the project file even though this information is also
  181. // stored in the board file. This was implemented for importing these settings from another
  182. // project. Going forward, the import feature will just import from other board files (since
  183. // we could have multi-board projects in the future anyway) so this functionality is dropped.
  184. m_params.emplace_back( new PARAM<bool>( "rules.use_height_for_length_calcs",
  185. &m_UseHeightForLengthCalcs, true ) );
  186. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_clearance",
  187. &m_MinClearance, Millimeter2iu( DEFAULT_MINCLEARANCE ),
  188. Millimeter2iu( 0.01 ), Millimeter2iu( 25.0 ), MM_PER_IU ) );
  189. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_connection",
  190. &m_MinConn, Millimeter2iu( DEFAULT_MINCONNECTION ),
  191. Millimeter2iu( 0.00 ), Millimeter2iu( 100.0 ), MM_PER_IU ) );
  192. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_track_width",
  193. &m_TrackMinWidth, Millimeter2iu( DEFAULT_TRACKMINWIDTH ),
  194. Millimeter2iu( 0.01 ), Millimeter2iu( 25.0 ), MM_PER_IU ) );
  195. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_annular_width",
  196. &m_ViasMinAnnularWidth, Millimeter2iu( DEFAULT_VIASMINSIZE ),
  197. Millimeter2iu( 0.01 ), Millimeter2iu( 25.0 ), MM_PER_IU ) );
  198. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_diameter",
  199. &m_ViasMinSize, Millimeter2iu( DEFAULT_VIASMINSIZE ),
  200. Millimeter2iu( 0.01 ), Millimeter2iu( 25.0 ), MM_PER_IU ) );
  201. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_through_hole_diameter",
  202. &m_MinThroughDrill, Millimeter2iu( DEFAULT_MINTHROUGHDRILL ),
  203. Millimeter2iu( 0.01 ), Millimeter2iu( 25.0 ), MM_PER_IU ) );
  204. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_microvia_diameter",
  205. &m_MicroViasMinSize, Millimeter2iu( DEFAULT_MICROVIASMINSIZE ),
  206. Millimeter2iu( 0.01 ), Millimeter2iu( 10.0 ), MM_PER_IU ) );
  207. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_microvia_drill",
  208. &m_MicroViasMinDrill, Millimeter2iu( DEFAULT_MICROVIASMINDRILL ),
  209. Millimeter2iu( 0.01 ), Millimeter2iu( 10.0 ), MM_PER_IU ) );
  210. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_hole_to_hole",
  211. &m_HoleToHoleMin, Millimeter2iu( DEFAULT_HOLETOHOLEMIN ),
  212. Millimeter2iu( 0.00 ), Millimeter2iu( 10.0 ), MM_PER_IU ) );
  213. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_hole_clearance",
  214. &m_HoleClearance, Millimeter2iu( DEFAULT_HOLECLEARANCE ),
  215. Millimeter2iu( 0.00 ), Millimeter2iu( 100.0 ), MM_PER_IU ) );
  216. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_silk_clearance",
  217. &m_SilkClearance, Millimeter2iu( DEFAULT_SILKCLEARANCE ),
  218. Millimeter2iu( 0.00 ), Millimeter2iu( 100.0 ), MM_PER_IU ) );
  219. // While the maximum *effective* value is 4, we've had users interpret this as the count on
  220. // all layers, and enter something like 10. They'll figure it out soon enough *unless* we
  221. // enforce a max of 4 (and therefore reset it back to the default of 2), at which point it
  222. // just looks buggy.
  223. m_params.emplace_back( new PARAM<int>( "rules.min_resolved_spokes",
  224. &m_MinResolvedSpokes, DEFAULT_MINRESOLVEDSPOKES, 0, 99 ) );
  225. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_text_height",
  226. &m_MinSilkTextHeight, Millimeter2iu( DEFAULT_SILK_TEXT_SIZE * 0.8 ),
  227. Millimeter2iu( 0.00 ), Millimeter2iu( 100.0 ), MM_PER_IU ) );
  228. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_text_thickness",
  229. &m_MinSilkTextThickness, Millimeter2iu( DEFAULT_SILK_TEXT_WIDTH * 0.8 ),
  230. Millimeter2iu( 0.00 ), Millimeter2iu( 25.0 ), MM_PER_IU ) );
  231. // Note: a clearance of -0.01 is a flag indicating we should use the legacy (pre-6.0) method
  232. // based on the edge cut thicknesses.
  233. m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_copper_edge_clearance",
  234. &m_CopperEdgeClearance, Millimeter2iu( LEGACY_COPPEREDGECLEARANCE ),
  235. Millimeter2iu( -0.01 ), Millimeter2iu( 25.0 ), MM_PER_IU ) );
  236. m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "rule_severities",
  237. [&]() -> nlohmann::json
  238. {
  239. nlohmann::json ret = {};
  240. for( const RC_ITEM& item : DRC_ITEM::GetItemsWithSeverities() )
  241. {
  242. wxString name = item.GetSettingsKey();
  243. int code = item.GetErrorCode();
  244. if( name.IsEmpty() || m_DRCSeverities.count( code ) == 0 )
  245. continue;
  246. ret[std::string( name.ToUTF8() )] = SeverityToString( m_DRCSeverities[code] );
  247. }
  248. return ret;
  249. },
  250. [&]( const nlohmann::json& aJson )
  251. {
  252. if( !aJson.is_object() )
  253. return;
  254. for( const RC_ITEM& item : DRC_ITEM::GetItemsWithSeverities() )
  255. {
  256. wxString name = item.GetSettingsKey();
  257. std::string key( name.ToUTF8() );
  258. if( aJson.contains( key ) )
  259. m_DRCSeverities[item.GetErrorCode()] = SeverityFromString( aJson[key] );
  260. }
  261. }, {} ) );
  262. m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "drc_exclusions",
  263. [&]() -> nlohmann::json
  264. {
  265. nlohmann::json js = nlohmann::json::array();
  266. for( const auto& entry : m_DrcExclusions )
  267. js.push_back( entry );
  268. return js;
  269. },
  270. [&]( const nlohmann::json& aObj )
  271. {
  272. m_DrcExclusions.clear();
  273. if( !aObj.is_array() )
  274. return;
  275. for( const nlohmann::json& entry : aObj )
  276. {
  277. if( entry.empty() )
  278. continue;
  279. m_DrcExclusions.insert( entry.get<wxString>() );
  280. }
  281. },
  282. {} ) );
  283. m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "track_widths",
  284. [&]() -> nlohmann::json
  285. {
  286. nlohmann::json js = nlohmann::json::array();
  287. for( const int& width : m_TrackWidthList )
  288. js.push_back( Iu2Millimeter( width ) );
  289. return js;
  290. },
  291. [&]( const nlohmann::json& aJson )
  292. {
  293. if( !aJson.is_array() )
  294. return;
  295. m_TrackWidthList.clear();
  296. for( const nlohmann::json& entry : aJson )
  297. {
  298. if( entry.empty() )
  299. continue;
  300. m_TrackWidthList.emplace_back( Millimeter2iu( entry.get<double>() ) );
  301. }
  302. },
  303. {} ) );
  304. m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "via_dimensions",
  305. [&]() -> nlohmann::json
  306. {
  307. nlohmann::json js = nlohmann::json::array();
  308. for( const auto& via : m_ViasDimensionsList )
  309. {
  310. nlohmann::json entry = {};
  311. entry["diameter"] = Iu2Millimeter( via.m_Diameter );
  312. entry["drill"] = Iu2Millimeter( via.m_Drill );
  313. js.push_back( entry );
  314. }
  315. return js;
  316. },
  317. [&]( const nlohmann::json& aObj )
  318. {
  319. if( !aObj.is_array() )
  320. return;
  321. m_ViasDimensionsList.clear();
  322. for( const nlohmann::json& entry : aObj )
  323. {
  324. if( entry.empty() || !entry.is_object() )
  325. continue;
  326. if( !entry.contains( "diameter" ) || !entry.contains( "drill" ) )
  327. continue;
  328. int diameter = Millimeter2iu( entry["diameter"].get<double>() );
  329. int drill = Millimeter2iu( entry["drill"].get<double>() );
  330. m_ViasDimensionsList.emplace_back( VIA_DIMENSION( diameter, drill ) );
  331. }
  332. },
  333. {} ) );
  334. m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "diff_pair_dimensions",
  335. [&]() -> nlohmann::json
  336. {
  337. nlohmann::json js = nlohmann::json::array();
  338. for( const auto& pair : m_DiffPairDimensionsList )
  339. {
  340. nlohmann::json entry = {};
  341. entry["width"] = Iu2Millimeter( pair.m_Width );
  342. entry["gap"] = Iu2Millimeter( pair.m_Gap );
  343. entry["via_gap"] = Iu2Millimeter( pair.m_ViaGap );
  344. js.push_back( entry );
  345. }
  346. return js;
  347. },
  348. [&]( const nlohmann::json& aObj )
  349. {
  350. if( !aObj.is_array() )
  351. return;
  352. m_DiffPairDimensionsList.clear();
  353. for( const nlohmann::json& entry : aObj )
  354. {
  355. if( entry.empty() || !entry.is_object() )
  356. continue;
  357. if( !entry.contains( "width" ) || !entry.contains( "gap" )
  358. || !entry.contains( "via_gap" ) )
  359. continue;
  360. int width = Millimeter2iu( entry["width"].get<double>() );
  361. int gap = Millimeter2iu( entry["gap"].get<double>() );
  362. int via_gap = Millimeter2iu( entry["via_gap"].get<double>() );
  363. m_DiffPairDimensionsList.emplace_back(
  364. DIFF_PAIR_DIMENSION( width, gap, via_gap ) );
  365. }
  366. },
  367. {} ) );
  368. // Handle options for teardrops (targets and some others):
  369. m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "teardrop_options",
  370. [&]() -> nlohmann::json
  371. {
  372. nlohmann::json js = nlohmann::json::array();
  373. nlohmann::json entry = {};
  374. entry["td_onviapad"] = m_TeardropParamsList.m_TargetViasPads;
  375. entry["td_onpadsmd"] = m_TeardropParamsList.m_TargetPadsWithNoHole;
  376. entry["td_ontrackend"] = m_TeardropParamsList.m_TargetTrack2Track;
  377. entry["td_onroundshapesonly"] = m_TeardropParamsList.m_UseRoundShapesOnly;
  378. entry["td_allow_use_two_tracks"] = m_TeardropParamsList.m_AllowUseTwoTracks;
  379. entry["td_curve_segcount"] = m_TeardropParamsList.m_CurveSegCount;
  380. entry["td_on_pad_in_zone"] = m_TeardropParamsList.m_TdOnPadsInZones;
  381. js.push_back( entry );
  382. return js;
  383. },
  384. [&]( const nlohmann::json& aObj )
  385. {
  386. if( !aObj.is_array() )
  387. return;
  388. for( const nlohmann::json& entry : aObj )
  389. {
  390. if( entry.empty() || !entry.is_object() )
  391. continue;
  392. if( entry.contains( "td_onviapad" ) )
  393. m_TeardropParamsList.m_TargetViasPads = entry["td_onviapad"].get<bool>();
  394. if( entry.contains( "td_onpadsmd" ) )
  395. m_TeardropParamsList.m_TargetPadsWithNoHole = entry["td_onpadsmd"].get<bool>();
  396. if( entry.contains( "td_ontrackend" ) )
  397. m_TeardropParamsList.m_TargetTrack2Track = entry["td_ontrackend"].get<bool>();
  398. if( entry.contains( "td_onroundshapesonly" ) )
  399. m_TeardropParamsList.m_UseRoundShapesOnly = entry["td_onroundshapesonly"].get<bool>();
  400. if( entry.contains( "td_allow_use_two_tracks" ) )
  401. m_TeardropParamsList.m_AllowUseTwoTracks = entry["td_allow_use_two_tracks"].get<bool>();
  402. if( entry.contains( "td_curve_segcount" ) )
  403. m_TeardropParamsList.m_CurveSegCount = entry["td_curve_segcount"].get<int>();
  404. if( entry.contains( "td_on_pad_in_zone" ) )
  405. m_TeardropParamsList.m_TdOnPadsInZones = entry["td_on_pad_in_zone"].get<bool>();
  406. }
  407. },
  408. {} ) );
  409. // Handle parameters (sizes, shape) for each type of teardrop:
  410. m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "teardrop_parameters",
  411. [&]() -> nlohmann::json
  412. {
  413. nlohmann::json js = nlohmann::json::array();
  414. for( int ii = 0; ii < m_TeardropParamsList.GetParametersCount(); ii++ )
  415. {
  416. nlohmann::json entry = {};
  417. TEARDROP_PARAMETERS* td_prm = m_TeardropParamsList.GetParameters( (TARGET_TD)ii );
  418. entry["td_target_name"] = GetTeardropTargetCanonicalName( (TARGET_TD)ii );
  419. entry["td_maxlen"] = Iu2Millimeter( td_prm->m_TdMaxLen );
  420. entry["td_maxheight"] = Iu2Millimeter( td_prm->m_TdMaxHeight );
  421. entry["td_length_ratio"] = td_prm->m_LengthRatio;
  422. entry["td_height_ratio"] = td_prm->m_HeightRatio;
  423. entry["td_curve_segcount"] = td_prm->m_CurveSegCount;
  424. entry["td_width_to_size_filter_ratio"] = td_prm->m_WidthtoSizeFilterRatio;
  425. js.push_back( entry );
  426. }
  427. return js;
  428. },
  429. [&]( const nlohmann::json& aObj )
  430. {
  431. if( !aObj.is_array() )
  432. return;
  433. for( const nlohmann::json& entry : aObj )
  434. {
  435. if( entry.empty() || !entry.is_object() )
  436. continue;
  437. if( !entry.contains( "td_target_name" ) )
  438. continue;
  439. int idx = GetTeardropTargetTypeFromCanonicalName( entry["td_target_name"].get<std::string>() );
  440. if( idx >= 0 && idx < 3 )
  441. {
  442. TEARDROP_PARAMETERS* td_prm = m_TeardropParamsList.GetParameters( (TARGET_TD)idx );
  443. if( entry.contains( "td_maxlen" ) )
  444. td_prm->m_TdMaxLen = Millimeter2iu( entry["td_maxlen"].get<double>() );
  445. if( entry.contains( "td_maxheight" ) )
  446. td_prm->m_TdMaxHeight = Millimeter2iu( entry["td_maxheight"].get<double>() );
  447. if( entry.contains( "td_length_ratio" ) )
  448. td_prm->m_LengthRatio = entry["td_length_ratio"].get<double>();
  449. if( entry.contains( "td_height_ratio" ) )
  450. td_prm->m_HeightRatio = entry["td_height_ratio"].get<double>();
  451. if( entry.contains( "td_curve_segcount" ) )
  452. td_prm->m_CurveSegCount = entry["td_curve_segcount"].get<int>();
  453. if( entry.contains( "td_width_to_size_filter_ratio" ) )
  454. td_prm->m_WidthtoSizeFilterRatio = entry["td_width_to_size_filter_ratio"].get<double>();
  455. }
  456. }
  457. },
  458. {} ) );
  459. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_line_width",
  460. &m_LineThickness[LAYER_CLASS_SILK], Millimeter2iu( DEFAULT_SILK_LINE_WIDTH ),
  461. Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ), MM_PER_IU ) );
  462. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_size_v",
  463. &m_TextSize[LAYER_CLASS_SILK].y, Millimeter2iu( DEFAULT_SILK_TEXT_SIZE ),
  464. TEXTS_MIN_SIZE, TEXTS_MAX_SIZE, MM_PER_IU ) );
  465. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_size_h",
  466. &m_TextSize[LAYER_CLASS_SILK].x, Millimeter2iu( DEFAULT_SILK_TEXT_SIZE ),
  467. TEXTS_MIN_SIZE, TEXTS_MAX_SIZE, MM_PER_IU ) );
  468. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_thickness",
  469. &m_TextThickness[LAYER_CLASS_SILK], Millimeter2iu( DEFAULT_SILK_TEXT_WIDTH ), 1,
  470. TEXTS_MAX_WIDTH, MM_PER_IU ) );
  471. m_params.emplace_back( new PARAM<bool>( "defaults.silk_text_italic",
  472. &m_TextItalic[LAYER_CLASS_SILK], false ) );
  473. m_params.emplace_back( new PARAM<bool>( "defaults.silk_text_upright",
  474. &m_TextUpright[ LAYER_CLASS_SILK ], true ) );
  475. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_line_width",
  476. &m_LineThickness[LAYER_CLASS_COPPER], Millimeter2iu( DEFAULT_COPPER_LINE_WIDTH ),
  477. Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ), MM_PER_IU ) );
  478. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_size_v",
  479. &m_TextSize[LAYER_CLASS_COPPER].y, Millimeter2iu( DEFAULT_COPPER_TEXT_SIZE ),
  480. TEXTS_MIN_SIZE, TEXTS_MAX_SIZE, MM_PER_IU ) );
  481. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_size_h",
  482. &m_TextSize[LAYER_CLASS_COPPER].x, Millimeter2iu( DEFAULT_COPPER_TEXT_SIZE ),
  483. TEXTS_MIN_SIZE, TEXTS_MAX_SIZE, MM_PER_IU ) );
  484. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_thickness",
  485. &m_TextThickness[LAYER_CLASS_COPPER], Millimeter2iu( DEFAULT_COPPER_TEXT_WIDTH ),
  486. Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ), MM_PER_IU ) );
  487. m_params.emplace_back( new PARAM<bool>( "defaults.copper_text_italic",
  488. &m_TextItalic[LAYER_CLASS_COPPER], false ) );
  489. m_params.emplace_back( new PARAM<bool>( "defaults.copper_text_upright",
  490. &m_TextUpright[LAYER_CLASS_COPPER], true ) );
  491. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.board_outline_line_width",
  492. &m_LineThickness[LAYER_CLASS_EDGES], Millimeter2iu( DEFAULT_EDGE_WIDTH ),
  493. Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ), MM_PER_IU ) );
  494. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.courtyard_line_width",
  495. &m_LineThickness[LAYER_CLASS_COURTYARD], Millimeter2iu( DEFAULT_COURTYARD_WIDTH ),
  496. Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ), MM_PER_IU ) );
  497. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_line_width",
  498. &m_LineThickness[LAYER_CLASS_FAB], Millimeter2iu( DEFAULT_LINE_WIDTH ),
  499. Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ), MM_PER_IU ) );
  500. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_size_v",
  501. &m_TextSize[LAYER_CLASS_FAB].y, Millimeter2iu( DEFAULT_TEXT_SIZE ),
  502. TEXTS_MIN_SIZE, TEXTS_MAX_SIZE, MM_PER_IU ) );
  503. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_size_h",
  504. &m_TextSize[LAYER_CLASS_FAB].x, Millimeter2iu( DEFAULT_TEXT_SIZE ),
  505. TEXTS_MIN_SIZE, TEXTS_MAX_SIZE, MM_PER_IU ) );
  506. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_thickness",
  507. &m_TextThickness[LAYER_CLASS_FAB], Millimeter2iu( DEFAULT_TEXT_WIDTH ),
  508. Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ), MM_PER_IU ) );
  509. m_params.emplace_back( new PARAM<bool>( "defaults.fab_text_italic",
  510. &m_TextItalic[LAYER_CLASS_FAB], false ) );
  511. m_params.emplace_back( new PARAM<bool>( "defaults.fab_text_upright",
  512. &m_TextUpright[LAYER_CLASS_FAB], true ) );
  513. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_line_width",
  514. &m_LineThickness[LAYER_CLASS_OTHERS], Millimeter2iu( DEFAULT_LINE_WIDTH ),
  515. Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ), MM_PER_IU ) );
  516. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_size_v",
  517. &m_TextSize[LAYER_CLASS_OTHERS].y, Millimeter2iu( DEFAULT_TEXT_SIZE ), TEXTS_MIN_SIZE,
  518. TEXTS_MAX_SIZE, MM_PER_IU ) );
  519. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_size_h",
  520. &m_TextSize[LAYER_CLASS_OTHERS].x, Millimeter2iu( DEFAULT_TEXT_SIZE ), TEXTS_MIN_SIZE,
  521. TEXTS_MAX_SIZE, MM_PER_IU ) );
  522. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_thickness",
  523. &m_TextThickness[LAYER_CLASS_OTHERS], Millimeter2iu( DEFAULT_TEXT_WIDTH ),
  524. Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ), MM_PER_IU ) );
  525. m_params.emplace_back( new PARAM<bool>( "defaults.other_text_italic",
  526. &m_TextItalic[LAYER_CLASS_OTHERS], false ) );
  527. m_params.emplace_back( new PARAM<bool>( "defaults.other_text_upright",
  528. &m_TextUpright[LAYER_CLASS_OTHERS], true ) );
  529. m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_MODE>( "defaults.dimension_units",
  530. &m_DimensionUnitsMode, DIM_UNITS_MODE::AUTOMATIC, DIM_UNITS_MODE::INCHES,
  531. DIM_UNITS_MODE::AUTOMATIC ) );
  532. m_params.emplace_back( new PARAM<int>( "defaults.dimension_precision",
  533. &m_DimensionPrecision, 4, 0, 5 ) );
  534. m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_FORMAT>( "defaults.dimensions.units_format",
  535. &m_DimensionUnitsFormat, DIM_UNITS_FORMAT::BARE_SUFFIX, DIM_UNITS_FORMAT::NO_SUFFIX,
  536. DIM_UNITS_FORMAT::PAREN_SUFFIX ) );
  537. m_params.emplace_back( new PARAM<bool>( "defaults.dimensions.suppress_zeroes",
  538. &m_DimensionSuppressZeroes, false ) );
  539. // NOTE: excluding DIM_TEXT_POSITION::MANUAL from the valid range here
  540. m_params.emplace_back( new PARAM_ENUM<DIM_TEXT_POSITION>( "defaults.dimensions.text_position",
  541. &m_DimensionTextPosition, DIM_TEXT_POSITION::OUTSIDE, DIM_TEXT_POSITION::OUTSIDE,
  542. DIM_TEXT_POSITION::INLINE ) );
  543. m_params.emplace_back( new PARAM<bool>( "defaults.dimensions.keep_text_aligned",
  544. &m_DimensionKeepTextAligned, true ) );
  545. m_params.emplace_back( new PARAM<int>( "defaults.dimensions.arrow_length",
  546. &m_DimensionArrowLength,
  547. Mils2iu( DEFAULT_DIMENSION_ARROW_LENGTH ) ) );
  548. m_params.emplace_back( new PARAM<int>( "defaults.dimensions.extension_offset",
  549. &m_DimensionExtensionOffset,
  550. Millimeter2iu( DEFAULT_DIMENSION_EXTENSION_OFFSET ) ) );
  551. m_params.emplace_back( new PARAM_SCALED<int>( "defaults.zones.min_clearance",
  552. &m_defaultZoneSettings.m_ZoneClearance, Mils2iu( ZONE_CLEARANCE_MIL ),
  553. Millimeter2iu( 0.0 ), Millimeter2iu( 25.0 ), MM_PER_IU ) );
  554. m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "defaults.pads",
  555. [&]() -> nlohmann::json
  556. {
  557. nlohmann::json ret =
  558. {
  559. { "width", Iu2Millimeter( m_Pad_Master->GetSize().x ) },
  560. { "height", Iu2Millimeter( m_Pad_Master->GetSize().y ) },
  561. { "drill", Iu2Millimeter( m_Pad_Master->GetDrillSize().x ) }
  562. };
  563. return ret;
  564. },
  565. [&]( const nlohmann::json& aJson )
  566. {
  567. if( aJson.contains( "width" ) && aJson.contains( "height" )
  568. && aJson.contains( "drill" ) )
  569. {
  570. wxSize sz;
  571. sz.SetWidth( Millimeter2iu( aJson["width"].get<double>() ) );
  572. sz.SetHeight( Millimeter2iu( aJson["height"].get<double>() ) );
  573. m_Pad_Master->SetSize( sz );
  574. int drill = Millimeter2iu( aJson["drill"].get<double>() );
  575. m_Pad_Master->SetDrillSize( wxSize( drill, drill ) );
  576. }
  577. }, {} ) );
  578. m_params.emplace_back( new PARAM_SCALED<int>( "rules.max_error",
  579. &m_MaxError, ARC_HIGH_DEF, Millimeter2iu( 0.0001 ), Millimeter2iu( 1.0 ), MM_PER_IU ) );
  580. m_params.emplace_back( new PARAM_SCALED<int>( "rules.solder_mask_to_copper_clearance",
  581. &m_SolderMaskToCopperClearance, Millimeter2iu( DEFAULT_SOLDERMASK_TO_COPPER_CLEARANCE ),
  582. Millimeter2iu( 0.0 ), Millimeter2iu( 25.0 ), MM_PER_IU ) );
  583. m_params.emplace_back( new PARAM<bool>( "zones_allow_external_fillets",
  584. &m_ZoneKeepExternalFillets, false ) );
  585. registerMigration( 0, 1, std::bind( &BOARD_DESIGN_SETTINGS::migrateSchema0to1, this ) );
  586. registerMigration( 1, 2,
  587. [&]() -> bool
  588. {
  589. // Schema 1 to 2: move mask and paste margin settings back to board.
  590. // The parameters are removed, so we just have to manually load them here and
  591. // they will get saved with the board
  592. if( OPT<double> optval = Get<double>( "rules.solder_mask_clearance" ) )
  593. m_SolderMaskExpansion = static_cast<int>( *optval * IU_PER_MM );
  594. if( OPT<double> optval = Get<double>( "rules.solder_mask_min_width" ) )
  595. m_SolderMaskMinWidth = static_cast<int>( *optval * IU_PER_MM );
  596. if( OPT<double> optval = Get<double>( "rules.solder_paste_clearance" ) )
  597. m_SolderPasteMargin = static_cast<int>( *optval * IU_PER_MM );
  598. if( OPT<double> optval = Get<double>( "rules.solder_paste_margin_ratio" ) )
  599. m_SolderPasteMarginRatio = *optval;
  600. try
  601. {
  602. At( "rules" ).erase( "solder_mask_clearance" );
  603. At( "rules" ).erase( "solder_mask_min_width" );
  604. At( "rules" ).erase( "solder_paste_clearance" );
  605. At( "rules" ).erase( "solder_paste_margin_ratio" );
  606. }
  607. catch( ... )
  608. {}
  609. return true;
  610. } );
  611. }
  612. BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS()
  613. {
  614. if( m_parent )
  615. {
  616. m_parent->ReleaseNestedSettings( this );
  617. m_parent = nullptr;
  618. }
  619. }
  620. BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS( const BOARD_DESIGN_SETTINGS& aOther ) :
  621. NESTED_SETTINGS( "board_design_settings", bdsSchemaVersion, aOther.m_parent,
  622. aOther.m_path ),
  623. m_Pad_Master( nullptr )
  624. {
  625. initFromOther( aOther );
  626. }
  627. BOARD_DESIGN_SETTINGS& BOARD_DESIGN_SETTINGS::operator=( const BOARD_DESIGN_SETTINGS& aOther )
  628. {
  629. initFromOther( aOther );
  630. return *this;
  631. }
  632. void BOARD_DESIGN_SETTINGS::initFromOther( const BOARD_DESIGN_SETTINGS& aOther )
  633. {
  634. // Copy of NESTED_SETTINGS around is not allowed, so let's just update the params.
  635. m_TrackWidthList = aOther.m_TrackWidthList;
  636. m_ViasDimensionsList = aOther.m_ViasDimensionsList;
  637. m_DiffPairDimensionsList = aOther.m_DiffPairDimensionsList;
  638. m_CurrentViaType = aOther.m_CurrentViaType;
  639. m_UseConnectedTrackWidth = aOther.m_UseConnectedTrackWidth;
  640. m_MinClearance = aOther.m_MinClearance;
  641. m_MinConn = aOther.m_MinConn;
  642. m_TrackMinWidth = aOther.m_TrackMinWidth;
  643. m_ViasMinAnnularWidth = aOther.m_ViasMinAnnularWidth;
  644. m_ViasMinSize = aOther.m_ViasMinSize;
  645. m_MinThroughDrill = aOther.m_MinThroughDrill;
  646. m_MicroViasMinSize = aOther.m_MicroViasMinSize;
  647. m_MicroViasMinDrill = aOther.m_MicroViasMinDrill;
  648. m_CopperEdgeClearance = aOther.m_CopperEdgeClearance;
  649. m_HoleClearance = aOther.m_HoleClearance;
  650. m_HoleToHoleMin = aOther.m_HoleToHoleMin;
  651. m_SilkClearance = aOther.m_SilkClearance;
  652. m_MinSilkTextHeight = aOther.m_MinSilkTextHeight;
  653. m_MinSilkTextThickness = aOther.m_MinSilkTextThickness;
  654. m_DRCSeverities = aOther.m_DRCSeverities;
  655. m_DrcExclusions = aOther.m_DrcExclusions;
  656. m_ZoneKeepExternalFillets = aOther.m_ZoneKeepExternalFillets;
  657. m_MaxError = aOther.m_MaxError;
  658. m_SolderMaskExpansion = aOther.m_SolderMaskExpansion;
  659. m_SolderMaskMinWidth = aOther.m_SolderMaskMinWidth;
  660. m_SolderMaskToCopperClearance = aOther.m_SolderMaskToCopperClearance;
  661. m_SolderPasteMargin = aOther.m_SolderPasteMargin;
  662. m_SolderPasteMarginRatio = aOther.m_SolderPasteMarginRatio;
  663. m_DefaultFPTextItems = aOther.m_DefaultFPTextItems;
  664. std::copy( std::begin( aOther.m_LineThickness ), std::end( aOther.m_LineThickness ),
  665. std::begin( m_LineThickness ) );
  666. std::copy( std::begin( aOther.m_TextSize ), std::end( aOther.m_TextSize ),
  667. std::begin( m_TextSize ) );
  668. std::copy( std::begin( aOther.m_TextThickness ), std::end( aOther.m_TextThickness ),
  669. std::begin( m_TextThickness ) );
  670. std::copy( std::begin( aOther.m_TextItalic ), std::end( aOther.m_TextItalic ),
  671. std::begin( m_TextItalic ) );
  672. std::copy( std::begin( aOther.m_TextUpright ), std::end( aOther.m_TextUpright ),
  673. std::begin( m_TextUpright ) );
  674. m_DimensionUnitsMode = aOther.m_DimensionUnitsMode;
  675. m_DimensionPrecision = aOther.m_DimensionPrecision;
  676. m_DimensionUnitsFormat = aOther.m_DimensionUnitsFormat;
  677. m_DimensionSuppressZeroes = aOther.m_DimensionSuppressZeroes;
  678. m_DimensionTextPosition = aOther.m_DimensionTextPosition;
  679. m_DimensionKeepTextAligned = aOther.m_DimensionKeepTextAligned;
  680. m_DimensionArrowLength = aOther.m_DimensionArrowLength;
  681. m_DimensionExtensionOffset = aOther.m_DimensionExtensionOffset;
  682. m_auxOrigin = aOther.m_auxOrigin;
  683. m_gridOrigin = aOther.m_gridOrigin;
  684. m_HasStackup = aOther.m_HasStackup;
  685. m_UseHeightForLengthCalcs= aOther.m_UseHeightForLengthCalcs;
  686. m_trackWidthIndex = aOther.m_trackWidthIndex;
  687. m_viaSizeIndex = aOther.m_viaSizeIndex;
  688. m_diffPairIndex = aOther.m_diffPairIndex;
  689. m_useCustomTrackVia = aOther.m_useCustomTrackVia;
  690. m_customTrackWidth = aOther.m_customTrackWidth;
  691. m_customViaSize = aOther.m_customViaSize;
  692. m_useCustomDiffPair = aOther.m_useCustomDiffPair;
  693. m_customDiffPair = aOther.m_customDiffPair;
  694. m_copperLayerCount = aOther.m_copperLayerCount;
  695. m_enabledLayers = aOther.m_enabledLayers;
  696. m_boardThickness = aOther.m_boardThickness;
  697. m_currentNetClassName = aOther.m_currentNetClassName;
  698. m_stackup = aOther.m_stackup;
  699. m_NetSettings = aOther.m_NetSettings;
  700. m_Pad_Master = std::make_unique<PAD>( *aOther.m_Pad_Master );
  701. m_defaultZoneSettings = aOther.m_defaultZoneSettings;
  702. }
  703. bool BOARD_DESIGN_SETTINGS::migrateSchema0to1()
  704. {
  705. /**
  706. * Schema 0 to 1: default dimension precision changed in meaning.
  707. * Previously it was an enum with the following meaning:
  708. *
  709. * 0: 0.01mm / 1 mil / 0.001 in
  710. * 1: 0.001mm / 0.1 mil / 0.0001 in
  711. * 2: 0.0001mm / 0.01 mil / 0.00001 in
  712. *
  713. * Now it is independent of display units and is an integer meaning the number of digits
  714. * displayed after the decimal point, so we have to migrate based on the default units.
  715. *
  716. * The units is an integer with the following mapping:
  717. *
  718. * 0: Inches
  719. * 1: Mils
  720. * 2: Millimeters
  721. */
  722. std::string units_ptr( "defaults.dimension_units" );
  723. std::string precision_ptr( "defaults.dimension_precision" );
  724. if( !( Contains( units_ptr ) && Contains( precision_ptr ) &&
  725. At( units_ptr ).is_number_integer() &&
  726. At( precision_ptr ).is_number_integer() ) )
  727. {
  728. // if either is missing or invalid, migration doesn't make sense
  729. return true;
  730. }
  731. int units = Get<int>( units_ptr ).value();
  732. int precision = Get<int>( precision_ptr ).value();
  733. // The enum maps directly to precision if the units is mils
  734. int extraDigits = 0;
  735. switch( units )
  736. {
  737. case 0: extraDigits = 3; break;
  738. case 2: extraDigits = 2; break;
  739. default: break;
  740. }
  741. precision += extraDigits;
  742. Set( precision_ptr, precision );
  743. return true;
  744. }
  745. bool BOARD_DESIGN_SETTINGS::LoadFromFile( const wxString& aDirectory )
  746. {
  747. bool ret = NESTED_SETTINGS::LoadFromFile( aDirectory );
  748. // A number of things won't have been translated by the PROJECT_FILE migration because of
  749. // descoped objects required to decode this data. So, it will be in the legacy.pcbnew
  750. // section and needs to be pulled out here
  751. PROJECT_FILE* project = dynamic_cast<PROJECT_FILE*>( GetParent() );
  752. if( !project )
  753. return ret;
  754. bool migrated = false;
  755. auto drcName =
  756. []( int aCode ) -> std::string
  757. {
  758. std::shared_ptr<DRC_ITEM> item = DRC_ITEM::Create( aCode );
  759. wxString name = item->GetSettingsKey();
  760. return std::string( name.ToUTF8() );
  761. };
  762. std::string bp = "board.design_settings.rule_severities.";
  763. std::string rs = "rule_severities.";
  764. if( OPT<bool> v = project->Get<bool>( bp + "legacy_no_courtyard_defined" ) )
  765. {
  766. if( *v )
  767. Set( rs + drcName( DRCE_MISSING_COURTYARD ), "error" );
  768. else
  769. Set( rs + drcName( DRCE_MISSING_COURTYARD ), "ignore" );
  770. project->Internals()->erase( m_internals->PointerFromString( bp + "legacy_no_courtyard_defined" ) );
  771. migrated = true;
  772. }
  773. if( OPT<bool> v = project->Get<bool>( bp + "legacy_courtyards_overlap" ) )
  774. {
  775. if( *v )
  776. Set( rs + drcName( DRCE_OVERLAPPING_FOOTPRINTS ), "error" );
  777. else
  778. Set( rs + drcName( DRCE_OVERLAPPING_FOOTPRINTS ), "ignore" );
  779. project->Internals()->erase( JSON_SETTINGS_INTERNALS::PointerFromString( bp + "legacy_courtyards_overlap" ) );
  780. migrated = true;
  781. }
  782. if( Contains( "legacy" ) )
  783. {
  784. // This defaults to false for new boards, but version 5.1.x and prior kept the fillets
  785. // so we do the same for legacy boards.
  786. m_ZoneKeepExternalFillets = true;
  787. project->At( "legacy" ).erase( "pcbnew" );
  788. }
  789. // Now that we have everything, we need to load again
  790. if( migrated )
  791. Load();
  792. return ret;
  793. }
  794. SEVERITY BOARD_DESIGN_SETTINGS::GetSeverity( int aDRCErrorCode )
  795. {
  796. return m_DRCSeverities[ aDRCErrorCode ];
  797. }
  798. bool BOARD_DESIGN_SETTINGS::Ignore( int aDRCErrorCode )
  799. {
  800. return m_DRCSeverities[ aDRCErrorCode ] == RPT_SEVERITY_IGNORE;
  801. }
  802. int BOARD_DESIGN_SETTINGS::GetBiggestClearanceValue() const
  803. {
  804. int biggest = 0;
  805. DRC_CONSTRAINT constraint;
  806. if( m_DRCEngine )
  807. {
  808. m_DRCEngine->QueryWorstConstraint( CLEARANCE_CONSTRAINT, constraint );
  809. biggest = std::max( biggest, constraint.Value().Min() );
  810. m_DRCEngine->QueryWorstConstraint( HOLE_CLEARANCE_CONSTRAINT, constraint );
  811. biggest = std::max( biggest, constraint.Value().Min() );
  812. m_DRCEngine->QueryWorstConstraint( EDGE_CLEARANCE_CONSTRAINT, constraint );
  813. biggest = std::max( biggest, constraint.Value().Min() );
  814. m_DRCEngine->QueryWorstConstraint( HOLE_TO_HOLE_CONSTRAINT, constraint );
  815. biggest = std::max( biggest, constraint.Value().Min() );
  816. }
  817. return biggest;
  818. }
  819. int BOARD_DESIGN_SETTINGS::GetSmallestClearanceValue() const
  820. {
  821. int clearance = m_NetSettings->m_DefaultNetClass->GetClearance();
  822. for( const auto& [ name, netclass ] : m_NetSettings->m_NetClasses )
  823. clearance = std::min( clearance, netclass->GetClearance() );
  824. return clearance;
  825. }
  826. void BOARD_DESIGN_SETTINGS::SetViaSizeIndex( unsigned aIndex )
  827. {
  828. m_viaSizeIndex = std::min( aIndex, (unsigned) m_ViasDimensionsList.size() );
  829. m_useCustomTrackVia = false;
  830. }
  831. int BOARD_DESIGN_SETTINGS::GetCurrentViaSize() const
  832. {
  833. if( m_useCustomTrackVia )
  834. return m_customViaSize.m_Diameter;
  835. else if( m_viaSizeIndex == 0 )
  836. return m_NetSettings->m_DefaultNetClass->GetViaDiameter();
  837. else
  838. return m_ViasDimensionsList[ m_viaSizeIndex ].m_Diameter;
  839. }
  840. int BOARD_DESIGN_SETTINGS::GetCurrentViaDrill() const
  841. {
  842. int drill;
  843. if( m_useCustomTrackVia )
  844. drill = m_customViaSize.m_Drill;
  845. else if( m_viaSizeIndex == 0 )
  846. drill = m_NetSettings->m_DefaultNetClass->GetViaDrill();
  847. else
  848. drill = m_ViasDimensionsList[ m_viaSizeIndex ].m_Drill;
  849. return drill > 0 ? drill : -1;
  850. }
  851. void BOARD_DESIGN_SETTINGS::SetTrackWidthIndex( unsigned aIndex )
  852. {
  853. m_trackWidthIndex = std::min( aIndex, (unsigned) m_TrackWidthList.size() );
  854. m_useCustomTrackVia = false;
  855. }
  856. int BOARD_DESIGN_SETTINGS::GetCurrentTrackWidth() const
  857. {
  858. if( m_useCustomTrackVia )
  859. return m_customTrackWidth;
  860. else if( m_trackWidthIndex == 0 )
  861. return m_NetSettings->m_DefaultNetClass->GetTrackWidth();
  862. else
  863. return m_TrackWidthList[ m_trackWidthIndex ];
  864. }
  865. void BOARD_DESIGN_SETTINGS::SetDiffPairIndex( unsigned aIndex )
  866. {
  867. if( !m_DiffPairDimensionsList.empty() )
  868. {
  869. m_diffPairIndex = std::min( aIndex,
  870. static_cast<unsigned>( m_DiffPairDimensionsList.size() ) - 1 );
  871. }
  872. m_useCustomDiffPair = false;
  873. }
  874. int BOARD_DESIGN_SETTINGS::GetCurrentDiffPairWidth() const
  875. {
  876. if( m_useCustomDiffPair )
  877. {
  878. return m_customDiffPair.m_Width;
  879. }
  880. else if( m_diffPairIndex == 0 )
  881. {
  882. if( m_NetSettings->m_DefaultNetClass->HasDiffPairWidth() )
  883. return m_NetSettings->m_DefaultNetClass->GetDiffPairWidth();
  884. else
  885. return m_NetSettings->m_DefaultNetClass->GetTrackWidth();
  886. }
  887. else
  888. {
  889. return m_DiffPairDimensionsList[m_diffPairIndex].m_Width;
  890. }
  891. }
  892. int BOARD_DESIGN_SETTINGS::GetCurrentDiffPairGap() const
  893. {
  894. if( m_useCustomDiffPair )
  895. {
  896. return m_customDiffPair.m_Gap;
  897. }
  898. else if( m_diffPairIndex == 0 )
  899. {
  900. if( m_NetSettings->m_DefaultNetClass->HasDiffPairGap() )
  901. return m_NetSettings->m_DefaultNetClass->GetDiffPairGap();
  902. else
  903. return m_NetSettings->m_DefaultNetClass->GetClearance();
  904. }
  905. else
  906. {
  907. return m_DiffPairDimensionsList[m_diffPairIndex].m_Gap;
  908. }
  909. }
  910. int BOARD_DESIGN_SETTINGS::GetCurrentDiffPairViaGap() const
  911. {
  912. if( m_useCustomDiffPair )
  913. {
  914. return m_customDiffPair.m_ViaGap;
  915. }
  916. else if( m_diffPairIndex == 0 )
  917. {
  918. if( m_NetSettings->m_DefaultNetClass->HasDiffPairViaGap() )
  919. return m_NetSettings->m_DefaultNetClass->GetDiffPairViaGap();
  920. else
  921. return GetCurrentDiffPairGap();
  922. }
  923. else
  924. {
  925. return m_DiffPairDimensionsList[m_diffPairIndex].m_ViaGap;
  926. }
  927. }
  928. void BOARD_DESIGN_SETTINGS::SetCopperLayerCount( int aNewLayerCount )
  929. {
  930. m_copperLayerCount = aNewLayerCount;
  931. // Update only enabled copper layers mask
  932. m_enabledLayers &= ~LSET::AllCuMask();
  933. if( aNewLayerCount > 0 )
  934. m_enabledLayers |= LSET::AllCuMask( aNewLayerCount );
  935. }
  936. void BOARD_DESIGN_SETTINGS::SetEnabledLayers( LSET aMask )
  937. {
  938. // Back and front layers are always enabled.
  939. aMask.set( B_Cu ).set( F_Cu );
  940. m_enabledLayers = aMask;
  941. // update m_CopperLayerCount to ensure its consistency with m_EnabledLayers
  942. m_copperLayerCount = ( aMask & LSET::AllCuMask() ).count();
  943. }
  944. // Return the layer class index { silk, copper, edges & courtyards, fab, others } of the
  945. // given layer.
  946. int BOARD_DESIGN_SETTINGS::GetLayerClass( PCB_LAYER_ID aLayer ) const
  947. {
  948. if( aLayer == F_SilkS || aLayer == B_SilkS )
  949. return LAYER_CLASS_SILK;
  950. else if( IsCopperLayer( aLayer ) )
  951. return LAYER_CLASS_COPPER;
  952. else if( aLayer == Edge_Cuts )
  953. return LAYER_CLASS_EDGES;
  954. else if( aLayer == F_CrtYd || aLayer == B_CrtYd )
  955. return LAYER_CLASS_COURTYARD;
  956. else if( aLayer == F_Fab || aLayer == B_Fab )
  957. return LAYER_CLASS_FAB;
  958. else
  959. return LAYER_CLASS_OTHERS;
  960. }
  961. int BOARD_DESIGN_SETTINGS::GetDRCEpsilon() const
  962. {
  963. return Millimeter2iu( ADVANCED_CFG::GetCfg().m_DRCEpsilon );
  964. }
  965. int BOARD_DESIGN_SETTINGS::GetHolePlatingThickness() const
  966. {
  967. return Millimeter2iu( ADVANCED_CFG::GetCfg().m_HoleWallThickness );
  968. }
  969. int BOARD_DESIGN_SETTINGS::GetLineThickness( PCB_LAYER_ID aLayer ) const
  970. {
  971. return m_LineThickness[ GetLayerClass( aLayer ) ];
  972. }
  973. wxSize BOARD_DESIGN_SETTINGS::GetTextSize( PCB_LAYER_ID aLayer ) const
  974. {
  975. return m_TextSize[ GetLayerClass( aLayer ) ];
  976. }
  977. int BOARD_DESIGN_SETTINGS::GetTextThickness( PCB_LAYER_ID aLayer ) const
  978. {
  979. return m_TextThickness[ GetLayerClass( aLayer ) ];
  980. }
  981. bool BOARD_DESIGN_SETTINGS::GetTextItalic( PCB_LAYER_ID aLayer ) const
  982. {
  983. return m_TextItalic[ GetLayerClass( aLayer ) ];
  984. }
  985. bool BOARD_DESIGN_SETTINGS::GetTextUpright( PCB_LAYER_ID aLayer ) const
  986. {
  987. return m_TextUpright[ GetLayerClass( aLayer ) ];
  988. }