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.

478 lines
16 KiB

  1. /**
  2. * @file gerber_file_image.cpp
  3. * a GERBER class handle for a given layer info about used D_CODES and how the layer is drawn
  4. */
  5. /*
  6. * This program source code file is part of KiCad, a free EDA CAD application.
  7. *
  8. * Copyright (C) 1992-2016 Jean-Pierre Charras jp.charras at wanadoo.fr
  9. * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
  10. *
  11. * This program is free software; you can redistribute it and/or
  12. * modify it under the terms of the GNU General Public License
  13. * as published by the Free Software Foundation; either version 2
  14. * of the License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU General Public License
  22. * along with this program; if not, you may find one here:
  23. * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
  24. * or you may search the http://www.gnu.org website for the version 2 license,
  25. * or you may write to the Free Software Foundation, Inc.,
  26. * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  27. */
  28. #include <gerbview.h>
  29. #include <gerbview_frame.h>
  30. #include <gerber_file_image.h>
  31. #include <gerber_file_image_list.h>
  32. #include <X2_gerber_attributes.h>
  33. #include <wx/filename.h>
  34. #include <map>
  35. // The global image list:
  36. GERBER_FILE_IMAGE_LIST s_GERBER_List;
  37. GERBER_FILE_IMAGE_LIST::GERBER_FILE_IMAGE_LIST()
  38. {
  39. m_GERBER_List.reserve( GERBER_DRAWLAYERS_COUNT );
  40. for( unsigned layer = 0; layer < GERBER_DRAWLAYERS_COUNT; ++layer )
  41. m_GERBER_List.push_back( nullptr );
  42. }
  43. GERBER_FILE_IMAGE_LIST::~GERBER_FILE_IMAGE_LIST()
  44. {
  45. DeleteAllImages();
  46. }
  47. GERBER_FILE_IMAGE_LIST& GERBER_FILE_IMAGE_LIST::GetImagesList()
  48. {
  49. return s_GERBER_List;
  50. }
  51. GERBER_FILE_IMAGE* GERBER_FILE_IMAGE_LIST::GetGbrImage( int aIdx )
  52. {
  53. if( (unsigned)aIdx < m_GERBER_List.size() )
  54. return m_GERBER_List[aIdx];
  55. return nullptr;
  56. }
  57. unsigned GERBER_FILE_IMAGE_LIST::GetLoadedImageCount()
  58. {
  59. auto notNull = []( GERBER_FILE_IMAGE* image )
  60. {
  61. return image != nullptr;
  62. };
  63. return std::count_if( m_GERBER_List.begin(), m_GERBER_List.end(), notNull );
  64. }
  65. int GERBER_FILE_IMAGE_LIST::AddGbrImage( GERBER_FILE_IMAGE* aGbrImage, int aIdx )
  66. {
  67. int idx = aIdx;
  68. if( idx < 0 )
  69. {
  70. for( idx = 0; idx < (int)m_GERBER_List.size(); idx++ )
  71. {
  72. if( m_GERBER_List[idx] == nullptr )
  73. break;
  74. }
  75. }
  76. if( idx >= (int)m_GERBER_List.size() )
  77. return -1; // No room
  78. m_GERBER_List[idx] = aGbrImage;
  79. return idx;
  80. }
  81. void GERBER_FILE_IMAGE_LIST::DeleteAllImages()
  82. {
  83. for( unsigned idx = 0; idx < m_GERBER_List.size(); ++idx )
  84. DeleteImage( idx );
  85. }
  86. void GERBER_FILE_IMAGE_LIST::DeleteImage( unsigned int aIdx )
  87. {
  88. // Ensure the index is valid:
  89. if( aIdx >= m_GERBER_List.size() )
  90. return;
  91. // delete image aIdx
  92. GERBER_FILE_IMAGE* gbr_image = GetGbrImage( static_cast<int>( aIdx ) );
  93. delete gbr_image;
  94. m_GERBER_List[ aIdx ] = nullptr;
  95. }
  96. const wxString GERBER_FILE_IMAGE_LIST::GetDisplayName( int aIdx, bool aNameOnly, bool aFullName )
  97. {
  98. wxString name;
  99. GERBER_FILE_IMAGE* gerber = nullptr;
  100. if( aIdx >= 0 && aIdx < (int)m_GERBER_List.size() )
  101. gerber = m_GERBER_List[aIdx];
  102. // if a file is loaded, build the name:
  103. // <id> <short filename> <X2 FileFunction info> if a X2 FileFunction info is found
  104. // or (if no FileFunction info)
  105. // <id> <short filename> *
  106. if( gerber )
  107. {
  108. wxFileName fn( gerber->m_FileName );
  109. wxString filename = fn.GetFullName();
  110. // If the filename is too long, display a shortened name if requested
  111. const int maxlen = 30;
  112. if( !aFullName && filename.Length() > maxlen )
  113. {
  114. wxString shortenedfn = filename.Left(2) + wxT( "..." ) + filename.Right(maxlen-5);
  115. filename = shortenedfn;
  116. }
  117. if( gerber->m_FileFunction )
  118. {
  119. if( gerber->m_FileFunction->IsCopper() )
  120. {
  121. name.Printf( wxT( "%s (%s, %s, %s)" ),
  122. filename.GetData(),
  123. gerber->m_FileFunction->GetFileType(),
  124. gerber->m_FileFunction->GetBrdLayerId(),
  125. gerber->m_FileFunction->GetBrdLayerSide() );
  126. }
  127. if( gerber->m_FileFunction->IsDrillFile() )
  128. {
  129. name.Printf( wxT( "%s (%s,%s,%s,%s)" ),
  130. filename.GetData(),
  131. gerber->m_FileFunction->GetFileType(),
  132. gerber->m_FileFunction->GetDrillLayerPair(),
  133. gerber->m_FileFunction->GetLPType(),
  134. gerber->m_FileFunction->GetRouteType() );
  135. }
  136. else
  137. {
  138. name.Printf( wxT( "%s (%s, %s)" ),
  139. filename.GetData(),
  140. gerber->m_FileFunction->GetFileType(),
  141. gerber->m_FileFunction->GetBrdLayerId() );
  142. }
  143. }
  144. else
  145. {
  146. name = filename;
  147. }
  148. if( aNameOnly )
  149. return name;
  150. wxString fullname;
  151. fullname.Printf( wxT( "%d " ), aIdx + 1 );
  152. fullname << name;
  153. return fullname;
  154. }
  155. else
  156. {
  157. name.Printf( _( "Graphic layer %d" ), aIdx + 1 );
  158. }
  159. return name;
  160. }
  161. struct GERBER_ORDER
  162. {
  163. std::string m_FilenameMask;
  164. GERBER_ORDER_ENUM m_Order;
  165. };
  166. // clang-format off
  167. static struct GERBER_ORDER gerberFileExtensionOrder[] =
  168. {
  169. { ".GM1", GERBER_ORDER_ENUM::GERBER_BOARD_OUTLINE },
  170. { ".GM3", GERBER_ORDER_ENUM::GERBER_BOARD_OUTLINE },
  171. { ".GBR", GERBER_ORDER_ENUM::GERBER_BOARD_OUTLINE },
  172. { ".DIM", GERBER_ORDER_ENUM::GERBER_BOARD_OUTLINE },
  173. { ".MIL", GERBER_ORDER_ENUM::GERBER_BOARD_OUTLINE },
  174. { ".GML", GERBER_ORDER_ENUM::GERBER_BOARD_OUTLINE },
  175. { "EDGE.CUTS", GERBER_ORDER_ENUM::GERBER_BOARD_OUTLINE },
  176. { ".FAB", GERBER_ORDER_ENUM::GERBER_BOARD_OUTLINE },
  177. { ".GKO", GERBER_ORDER_ENUM::GERBER_KEEP_OUT },
  178. { ".GM?", GERBER_ORDER_ENUM::GERBER_MECHANICAL },
  179. { ".GM??", GERBER_ORDER_ENUM::GERBER_MECHANICAL },
  180. { ".TXT", GERBER_ORDER_ENUM::GERBER_DRILL },
  181. { ".XLN", GERBER_ORDER_ENUM::GERBER_DRILL },
  182. { ".TAP", GERBER_ORDER_ENUM::GERBER_DRILL },
  183. { ".DRD", GERBER_ORDER_ENUM::GERBER_DRILL },
  184. { ".DRL", GERBER_ORDER_ENUM::GERBER_DRILL },
  185. { ".NC", GERBER_ORDER_ENUM::GERBER_DRILL },
  186. { ".XNC", GERBER_ORDER_ENUM::GERBER_DRILL },
  187. { ".GTP", GERBER_ORDER_ENUM::GERBER_TOP_PASTE },
  188. { ".CRC", GERBER_ORDER_ENUM::GERBER_TOP_PASTE },
  189. { ".TSP", GERBER_ORDER_ENUM::GERBER_TOP_PASTE },
  190. { "F.PASTE", GERBER_ORDER_ENUM::GERBER_TOP_PASTE },
  191. { ".SPT", GERBER_ORDER_ENUM::GERBER_TOP_PASTE },
  192. { "PT.PHO", GERBER_ORDER_ENUM::GERBER_TOP_PASTE },
  193. { ".GTO", GERBER_ORDER_ENUM::GERBER_TOP_SILK_SCREEN },
  194. { ".PLC", GERBER_ORDER_ENUM::GERBER_TOP_SILK_SCREEN },
  195. { ".TSK", GERBER_ORDER_ENUM::GERBER_TOP_SILK_SCREEN },
  196. { "F.SILKS", GERBER_ORDER_ENUM::GERBER_TOP_SILK_SCREEN },
  197. { ".SST", GERBER_ORDER_ENUM::GERBER_TOP_SILK_SCREEN },
  198. { "ST.PHO", GERBER_ORDER_ENUM::GERBER_TOP_SILK_SCREEN },
  199. { ".GTS", GERBER_ORDER_ENUM::GERBER_TOP_SOLDER_MASK },
  200. { ".STC", GERBER_ORDER_ENUM::GERBER_TOP_SOLDER_MASK },
  201. { ".TSM", GERBER_ORDER_ENUM::GERBER_TOP_SOLDER_MASK },
  202. { "F.MASK", GERBER_ORDER_ENUM::GERBER_TOP_SOLDER_MASK },
  203. { ".SMT", GERBER_ORDER_ENUM::GERBER_TOP_SOLDER_MASK },
  204. { "MT.PHO", GERBER_ORDER_ENUM::GERBER_TOP_SOLDER_MASK },
  205. { ".GTL", GERBER_ORDER_ENUM::GERBER_TOP_COPPER },
  206. { ".CMP", GERBER_ORDER_ENUM::GERBER_TOP_COPPER },
  207. { ".TOP", GERBER_ORDER_ENUM::GERBER_TOP_COPPER },
  208. { "F.CU", GERBER_ORDER_ENUM::GERBER_TOP_COPPER },
  209. { "L1.PHO", GERBER_ORDER_ENUM::GERBER_TOP_COPPER },
  210. { ".PHD", GERBER_ORDER_ENUM::GERBER_TOP_COPPER },
  211. { ".ART", GERBER_ORDER_ENUM::GERBER_TOP_COPPER },
  212. { ".GBL", GERBER_ORDER_ENUM::GERBER_BOTTOM_COPPER },
  213. { ".SOL", GERBER_ORDER_ENUM::GERBER_BOTTOM_COPPER },
  214. { ".BOT", GERBER_ORDER_ENUM::GERBER_BOTTOM_COPPER },
  215. { "B.CU", GERBER_ORDER_ENUM::GERBER_BOTTOM_COPPER },
  216. { ".BOT", GERBER_ORDER_ENUM::GERBER_BOTTOM_COPPER },
  217. { ".GBS", GERBER_ORDER_ENUM::GERBER_BOTTOM_SOLDER_MASK },
  218. { ".STS", GERBER_ORDER_ENUM::GERBER_BOTTOM_SOLDER_MASK },
  219. { ".BSM", GERBER_ORDER_ENUM::GERBER_BOTTOM_SOLDER_MASK },
  220. { "B.MASK", GERBER_ORDER_ENUM::GERBER_BOTTOM_SOLDER_MASK },
  221. { ".SMB", GERBER_ORDER_ENUM::GERBER_BOTTOM_SOLDER_MASK },
  222. { "MB.PHO", GERBER_ORDER_ENUM::GERBER_BOTTOM_SOLDER_MASK },
  223. { ".GBO", GERBER_ORDER_ENUM::GERBER_BOTTOM_SILK_SCREEN },
  224. { ".PLS", GERBER_ORDER_ENUM::GERBER_BOTTOM_SILK_SCREEN },
  225. { ".BSK", GERBER_ORDER_ENUM::GERBER_BOTTOM_SILK_SCREEN },
  226. { "B.SILK", GERBER_ORDER_ENUM::GERBER_BOTTOM_SILK_SCREEN },
  227. { ".SSB", GERBER_ORDER_ENUM::GERBER_BOTTOM_SILK_SCREEN },
  228. { "SB.PHO", GERBER_ORDER_ENUM::GERBER_BOTTOM_SILK_SCREEN },
  229. { ".GBP", GERBER_ORDER_ENUM::GERBER_BOTTOM_PASTE },
  230. { ".CRS", GERBER_ORDER_ENUM::GERBER_BOTTOM_PASTE },
  231. { ".BSP", GERBER_ORDER_ENUM::GERBER_BOTTOM_PASTE },
  232. { "B.PASTE", GERBER_ORDER_ENUM::GERBER_BOTTOM_PASTE },
  233. { ".SMB", GERBER_ORDER_ENUM::GERBER_BOTTOM_PASTE },
  234. { "MB.PHO", GERBER_ORDER_ENUM::GERBER_BOTTOM_PASTE },
  235. // EAGLE CAD file to explicitly ignore that can match some other
  236. // layers otherwise
  237. { ".GPI", GERBER_ORDER_ENUM::GERBER_LAYER_UNKNOWN },
  238. // Inner copper layers need to come last so the wildcard
  239. // number matching doesn't pick up other specific layer names.
  240. { ".GI?", GERBER_ORDER_ENUM::GERBER_INNER },
  241. { ".GI??", GERBER_ORDER_ENUM::GERBER_INNER },
  242. { ".G?", GERBER_ORDER_ENUM::GERBER_INNER },
  243. { ".G??", GERBER_ORDER_ENUM::GERBER_INNER },
  244. { ".G?L", GERBER_ORDER_ENUM::GERBER_INNER },
  245. { ".G??L", GERBER_ORDER_ENUM::GERBER_INNER },
  246. };
  247. // clang-format on
  248. void GERBER_FILE_IMAGE_LIST::GetGerberLayerFromFilename( const wxString& filename,
  249. enum GERBER_ORDER_ENUM& order,
  250. wxString& matchedExtension )
  251. {
  252. order = GERBER_ORDER_ENUM::GERBER_LAYER_UNKNOWN;
  253. matchedExtension = "";
  254. for( struct GERBER_ORDER o : gerberFileExtensionOrder )
  255. {
  256. wxString ext = filename.Right( o.m_FilenameMask.length() ).Upper();
  257. if( ext.Matches( o.m_FilenameMask ) )
  258. {
  259. order = o.m_Order;
  260. matchedExtension = ext;
  261. return;
  262. }
  263. }
  264. }
  265. static bool sortFileExtension( const GERBER_FILE_IMAGE* const& ref,
  266. const GERBER_FILE_IMAGE* const& test )
  267. {
  268. // Do not change order: no criteria to sort items
  269. if( !ref && !test )
  270. return false;
  271. // Not used: ref ordered after
  272. if( !ref || !ref->m_InUse )
  273. return false;
  274. // Not used: ref ordered before
  275. if( !test || !test->m_InUse )
  276. return true;
  277. enum GERBER_ORDER_ENUM ref_layer;
  278. enum GERBER_ORDER_ENUM test_layer;
  279. wxString ref_extension;
  280. wxString test_extension;
  281. GERBER_FILE_IMAGE_LIST::GetGerberLayerFromFilename( ref->m_FileName, ref_layer,
  282. ref_extension );
  283. GERBER_FILE_IMAGE_LIST::GetGerberLayerFromFilename( test->m_FileName, test_layer,
  284. test_extension );
  285. // Inner layers have a numeric code that we can compare against
  286. if( ref_layer == GERBER_ORDER_ENUM::GERBER_INNER
  287. && test_layer == GERBER_ORDER_ENUM::GERBER_INNER )
  288. {
  289. unsigned long ref_layer_number = 0;
  290. unsigned long test_layer_number = 0;
  291. // Strip extensions down to only the numbers in it. Later conversion to int will
  292. // automatically skip the spaces
  293. for( wxString::iterator it = ref_extension.begin(); it != ref_extension.end(); ++it )
  294. {
  295. if( !isdigit( *it ) )
  296. *it = ' ';
  297. }
  298. for( wxString::iterator it = test_extension.begin(); it != test_extension.end(); ++it )
  299. {
  300. if( !isdigit( *it ) )
  301. *it = ' ';
  302. }
  303. ref_extension.ToULong( &ref_layer_number );
  304. test_extension.ToULong( &test_layer_number );
  305. return ref_layer_number < test_layer_number;
  306. }
  307. return (int) ref_layer < (int) test_layer;
  308. }
  309. // Helper function, for std::sort.
  310. // Sort loaded images by Z order priority, if they have the X2 FileFormat info
  311. // returns true if the first argument (ref) is ordered before the second (test).
  312. static bool sortZorder( const GERBER_FILE_IMAGE* const& ref, const GERBER_FILE_IMAGE* const& test )
  313. {
  314. if( !ref && !test )
  315. return false; // do not change order: no criteria to sort items
  316. if( !ref || !ref->m_InUse )
  317. return false; // Not used: ref ordered after
  318. if( !test || !test->m_InUse )
  319. return true; // Not used: ref ordered before
  320. if( !ref->m_FileFunction && !test->m_FileFunction )
  321. return false; // do not change order: no criteria to sort items
  322. if( !ref->m_FileFunction )
  323. return false;
  324. if( !test->m_FileFunction )
  325. return true;
  326. if( ref->m_FileFunction->GetZOrder() != test->m_FileFunction->GetZOrder() )
  327. return ref->m_FileFunction->GetZOrder() > test->m_FileFunction->GetZOrder();
  328. return ref->m_FileFunction->GetZSubOrder() > test->m_FileFunction->GetZSubOrder();
  329. }
  330. std::unordered_map<int, int> GERBER_FILE_IMAGE_LIST::GetLayerRemap()
  331. {
  332. // The image order has changed.
  333. // Graphic layer numbering must be updated to match the widgets layer order
  334. // Store the old/new graphic layer info:
  335. std::unordered_map<int, int> tab_lyr;
  336. for( unsigned layer = 0; layer < m_GERBER_List.size(); ++layer )
  337. {
  338. GERBER_FILE_IMAGE* gerber = m_GERBER_List[layer];
  339. if( !gerber )
  340. continue;
  341. tab_lyr[gerber->m_GraphicLayer] = layer;
  342. gerber->m_GraphicLayer = layer ;
  343. }
  344. return tab_lyr;
  345. }
  346. std::unordered_map<int, int>
  347. GERBER_FILE_IMAGE_LIST::SortImagesByFunction( LayerSortFunction sortFunction )
  348. {
  349. std::sort( m_GERBER_List.begin(), m_GERBER_List.end(), sortFunction );
  350. return GetLayerRemap();
  351. }
  352. std::unordered_map<int, int> GERBER_FILE_IMAGE_LIST::SortImagesByFileExtension()
  353. {
  354. return SortImagesByFunction( sortFileExtension );
  355. }
  356. std::unordered_map<int, int> GERBER_FILE_IMAGE_LIST::SortImagesByZOrder()
  357. {
  358. return SortImagesByFunction( sortZorder );
  359. }
  360. std::unordered_map<int, int> GERBER_FILE_IMAGE_LIST::SwapImages( unsigned int layer1,
  361. unsigned int layer2 )
  362. {
  363. if( ( layer1 >= m_GERBER_List.size() ) || ( layer2 >= m_GERBER_List.size() ) )
  364. return std::unordered_map<int, int>();
  365. std::swap( m_GERBER_List[layer1], m_GERBER_List[layer2] );
  366. return GetLayerRemap();
  367. }
  368. std::unordered_map<int, int> GERBER_FILE_IMAGE_LIST::RemoveImage( unsigned int layer )
  369. {
  370. if( layer >= m_GERBER_List.size() )
  371. return std::unordered_map<int, int>();
  372. DeleteImage( layer );
  373. // Move deleted image to end of list, move all other images up
  374. std::rotate( m_GERBER_List.begin() + layer, m_GERBER_List.begin() + layer + 1,
  375. m_GERBER_List.end() );
  376. return GetLayerRemap();
  377. }