Browse Source
Split out LSEQ/LSET from LAYER_ID
Split out LSEQ/LSET from LAYER_ID
Separate the layer grouping classes for easier modificationjobs
Seth Hillbrand
1 year ago
103 changed files with 701 additions and 535 deletions
-
13d-viewer/3d_canvas/board_adapter.cpp
-
13d-viewer/3d_canvas/create_layer_items.cpp
-
13d-viewer/3d_rendering/opengl/create_scene.cpp
-
13d-viewer/3d_rendering/opengl/render_3d_opengl.cpp
-
13d-viewer/dialogs/panel_preview_3d_model.cpp
-
1common/CMakeLists.txt
-
1common/board_printout.cpp
-
1common/jobs/job_export_pcb_dxf.h
-
1common/jobs/job_export_pcb_gerber.h
-
1common/jobs/job_export_pcb_gerbers.h
-
1common/jobs/job_export_pcb_pdf.h
-
1common/jobs/job_export_pcb_svg.h
-
1common/jobs/job_fp_export_svg.h
-
166common/layer_id.cpp
-
23common/lseq.cpp
-
141common/lset.cpp
-
2common/project/board_project_settings.cpp
-
1common/project/project_local_settings.cpp
-
1gerbview/files.cpp
-
1gerbview/gerbview_frame.cpp
-
1gerbview/gerbview_frame.h
-
3gerbview/gerbview_printout.cpp
-
1gerbview/gerbview_printout.h
-
1gerbview/widgets/gerbview_layer_widget.cpp
-
1include/board_design_settings.h
-
2include/board_item.h
-
1include/board_printout.h
-
370include/layer_ids.h
-
86include/lseq.h
-
332include/lset.h
-
1include/pcb_base_frame.h
-
1include/project/board_project_settings.h
-
1include/render_settings.h
-
2kicad/cli/command_pcb_export_base.cpp
-
2kicad/cli/command_pcb_export_base.h
-
1pcbnew/api/api_pcb_utils.cpp
-
1pcbnew/api/api_pcb_utils.h
-
1pcbnew/autorouter/ar_autoplacer.cpp
-
1pcbnew/autorouter/ar_autoplacer.h
-
1pcbnew/autorouter/ar_matrix.cpp
-
1pcbnew/autorouter/ar_matrix.h
-
1pcbnew/board.cpp
-
1pcbnew/board.h
-
1pcbnew/board_commit.cpp
-
1pcbnew/board_connected_item.cpp
-
1pcbnew/board_design_settings.cpp
-
1pcbnew/board_item.cpp
-
1pcbnew/board_stackup_manager/board_stackup.h
-
1pcbnew/collectors.h
-
1pcbnew/dialogs/dialog_map_layers.cpp
-
2pcbnew/drc/drc_engine.h
-
1pcbnew/drc/drc_rule.h
-
1pcbnew/exporters/step/exporter_step.h
-
1pcbnew/footprint.cpp
-
1pcbnew/footprint.h
-
1pcbnew/footprint_chooser_frame.cpp
-
1pcbnew/footprint_editor_settings.cpp
-
1pcbnew/grid_layer_box_helpers.cpp
-
1pcbnew/grid_layer_box_helpers.h
-
1pcbnew/initpcb.cpp
-
4pcbnew/pad.cpp
-
1pcbnew/pad.h
-
1pcbnew/padstack.h
-
1pcbnew/pcb_base_frame.cpp
-
1pcbnew/pcb_edit_frame.cpp
-
1pcbnew/pcb_generator.h
-
1pcbnew/pcb_group.h
-
2pcbnew/pcb_io/altium/altium_pcb.cpp
-
1pcbnew/pcb_io/common/plugin_common_layer_mapping.h
-
1pcbnew/pcb_io/eagle/pcb_io_eagle.h
-
2pcbnew/pcb_io/easyeda/pcb_io_easyeda_parser.cpp
-
2pcbnew/pcb_io/easyedapro/pcb_io_easyedapro_parser.cpp
-
2pcbnew/pcb_io/fabmaster/import_fabmaster.cpp
-
1pcbnew/pcb_io/kicad_legacy/pcb_io_kicad_legacy.h
-
1pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr.h
-
1pcbnew/pcb_layer_box_selector.h
-
1pcbnew/pcb_painter.cpp
-
1pcbnew/pcb_plot_params.cpp
-
1pcbnew/pcb_shape.cpp
-
1pcbnew/pcb_track.cpp
-
1pcbnew/pcb_track.h
-
1pcbnew/pcbexpr_evaluator.cpp
-
1pcbnew/pcbexpr_functions.cpp
-
1pcbnew/pcbnew_jobs_handler.cpp
-
1pcbnew/pcbnew_printout.cpp
-
1pcbnew/pcbnew_printout.h
-
3pcbnew/pcbnew_settings.cpp
-
1pcbnew/pcbplot.cpp
-
1pcbnew/pcbplot.h
-
1pcbnew/plot_board_layers.cpp
-
1pcbnew/plot_brditems_plotter.cpp
-
1pcbnew/plotcontroller.h
-
1pcbnew/sel_layer.cpp
-
1pcbnew/toolbars_footprint_editor.cpp
-
2pcbnew/tools/pcb_grid_helper.h
-
1pcbnew/tracks_cleaner.cpp
-
1pcbnew/undo_redo.cpp
-
3pcbnew/zone.cpp
-
1pcbnew/zone.h
-
1pcbnew/zone_settings.cpp
@ -0,0 +1,23 @@ |
|||
/*
|
|||
* This program source code file is part of KiCad, a free EDA CAD application. |
|||
* |
|||
* Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors. |
|||
* |
|||
* This program is free software: you can redistribute it and/or modify it |
|||
* under the terms of the GNU General Public License as published by the |
|||
* Free Software Foundation, either version 3 of the License, or (at your |
|||
* option) any later version. |
|||
* |
|||
* This program is distributed in the hope that it will be useful, but |
|||
* WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
* General Public License for more details. |
|||
* |
|||
* You should have received a copy of the GNU General Public License along |
|||
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
|||
*/ |
|||
|
|||
#include <layer_ids.h>
|
|||
#include <lseq.h>
|
|||
|
|||
#include <vector>
|
|||
@ -0,0 +1,86 @@ |
|||
/* |
|||
* This program source code file is part of KiCad, a free EDA CAD application. |
|||
* |
|||
* Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors. |
|||
* |
|||
* This program is free software: you can redistribute it and/or modify it |
|||
* under the terms of the GNU General Public License as published by the |
|||
* Free Software Foundation, either version 3 of the License, or (at your |
|||
* option) any later version. |
|||
* |
|||
* This program is distributed in the hope that it will be useful, but |
|||
* WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
* General Public License for more details. |
|||
* |
|||
* You should have received a copy of the GNU General Public License along |
|||
* with this program. If not, see <http://www.gnu.org/licenses/>. |
|||
*/ |
|||
|
|||
#ifndef LSEQ_H |
|||
#define LSEQ_H |
|||
|
|||
#include <vector> |
|||
#include <layer_ids.h> |
|||
|
|||
/// A sequence of layers, a sequence provides a certain order. |
|||
typedef std::vector<PCB_LAYER_ID> BASE_SEQ; |
|||
|
|||
|
|||
/** |
|||
* LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs. A sequence provides |
|||
* a certain order. |
|||
* <p> |
|||
* It can also be used as an iterator: |
|||
* <code> |
|||
* |
|||
* for( LSEQ cu_stack = aSet.CuStack(); cu_stack; ++cu_stack ) |
|||
* { |
|||
* layer_id = *cu_stack; |
|||
* : |
|||
* things to do with layer_id; |
|||
* } |
|||
* |
|||
* </code> |
|||
*/ |
|||
class KICOMMON_API LSEQ : public BASE_SEQ |
|||
{ |
|||
unsigned m_index; |
|||
|
|||
public: |
|||
|
|||
LSEQ() : |
|||
m_index( 0 ) |
|||
{} |
|||
|
|||
template <class InputIterator> |
|||
LSEQ( InputIterator aStart, InputIterator aEnd ) : |
|||
BASE_SEQ( aStart, aEnd ), m_index( 0 ) |
|||
{} |
|||
|
|||
LSEQ( std::initializer_list<PCB_LAYER_ID> aLayers ) : |
|||
BASE_SEQ( aLayers ), m_index( 0 ) |
|||
{} |
|||
|
|||
|
|||
operator bool () { return m_index < size(); } |
|||
|
|||
PCB_LAYER_ID operator * () const |
|||
{ |
|||
return at( m_index ); // throws std::out_of_range |
|||
} |
|||
|
|||
int TestLayers( PCB_LAYER_ID aRhs, PCB_LAYER_ID aLhs ) const |
|||
{ |
|||
if( aRhs == aLhs ) |
|||
return 0; |
|||
|
|||
auto itRhs = std::find( begin(), end(), aRhs ); |
|||
auto itLhs = std::find( begin(), end(), aLhs ); |
|||
|
|||
return std::distance( itRhs, itLhs ); |
|||
} |
|||
}; |
|||
|
|||
|
|||
#endif // LSEQ_H |
|||
@ -0,0 +1,332 @@ |
|||
/* |
|||
* This program source code file is part of KiCad, a free EDA CAD application. |
|||
* |
|||
* Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors. |
|||
* |
|||
* This program is free software: you can redistribute it and/or modify it |
|||
* under the terms of the GNU General Public License as published by the |
|||
* Free Software Foundation, either version 3 of the License, or (at your |
|||
* option) any later version. |
|||
* |
|||
* This program is distributed in the hope that it will be useful, but |
|||
* WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|||
* General Public License for more details. |
|||
* |
|||
* You should have received a copy of the GNU General Public License along |
|||
* with this program. If not, see <http://www.gnu.org/licenses/>. |
|||
*/ |
|||
|
|||
#ifndef LSET_H |
|||
#define LSET_H |
|||
|
|||
#include <bitset> |
|||
|
|||
#include <layer_ids.h> |
|||
|
|||
class LSEQ; |
|||
typedef std::bitset<PCB_LAYER_ID_COUNT> BASE_SET; |
|||
|
|||
|
|||
/** |
|||
* LSET is a set of PCB_LAYER_IDs. It can be converted to numerous purpose LSEQs using |
|||
* the various member functions, most of which are based on Seq(). The advantage |
|||
* of converting to LSEQ using purposeful code, is it removes any dependency |
|||
* on order/sequence inherent in this set. |
|||
*/ |
|||
class KICOMMON_API LSET : public BASE_SET |
|||
{ |
|||
public: |
|||
|
|||
// The constructor flavors are carefully chosen to prevent LSET( int ) from compiling. |
|||
// That excludes "LSET s = 0;" and excludes "LSET s = -1;", etc. |
|||
// LSET s = 0; needs to be removed from the code, this accomplishes that. |
|||
// Remember LSET( PCB_LAYER_ID(0) ) sets bit 0, so "LSET s = 0;" is illegal |
|||
// to prevent that surprise. Therefore LSET's constructor suite is significantly |
|||
// different than the base class from which it is derived. |
|||
|
|||
// Other member functions (non-constructor functions) are identical to the base |
|||
// class's and therefore are re-used from the base class. |
|||
|
|||
/** |
|||
* Create an empty (cleared) set. |
|||
*/ |
|||
LSET() : |
|||
BASE_SET() // all bits are set to zero in BASE_SET() |
|||
{ |
|||
} |
|||
|
|||
LSET( const BASE_SET& aOther ) : |
|||
BASE_SET( aOther ) |
|||
{ |
|||
} |
|||
|
|||
/** |
|||
* Take a PCB_LAYER_ID and sets that bit. This makes the following code into |
|||
* a bug: |
|||
* |
|||
* <code> LSET s = 0; </code> |
|||
* |
|||
* Instead use: |
|||
* |
|||
* <code> |
|||
* LSET s; |
|||
* </code> |
|||
* |
|||
* for an empty set. |
|||
*/ |
|||
LSET( PCB_LAYER_ID aLayer ) : // PCB_LAYER_ID deliberately excludes int and relatives |
|||
BASE_SET() |
|||
{ |
|||
set( aLayer ); |
|||
} |
|||
|
|||
/** |
|||
* Create an array or LSEQ. |
|||
*/ |
|||
LSET( const PCB_LAYER_ID* aArray, unsigned aCount ); |
|||
|
|||
/** |
|||
* Take one or more PCB_LAYER_IDs in the argument list to construct the set. Typically |
|||
* only used in static construction. |
|||
* |
|||
* @param aIdCount is the number of PCB_LAYER_IDs which follow. |
|||
* @param aFirst is the first included in @a aIdCount and must always be present, and can |
|||
* be followed by any number of additional PCB_LAYER_IDs so long as @a aIdCount accurately |
|||
* reflects the count. |
|||
* |
|||
* Parameter is 'int' to avoid va_start undefined behavior. |
|||
*/ |
|||
LSET( unsigned aIdCount, int aFirst, ... ); // args chosen to prevent LSET( int ) from compiling |
|||
|
|||
LSET( const LSEQ& aSeq ); |
|||
|
|||
LSET( unsigned long __val ) = delete; |
|||
|
|||
/** |
|||
* See if the layer set contains a PCB layer. |
|||
* |
|||
* @param aLayer is the layer to check |
|||
* @return true if the layer is included |
|||
*/ |
|||
bool Contains( PCB_LAYER_ID aLayer ) |
|||
{ |
|||
try |
|||
{ |
|||
return test( aLayer ); |
|||
} |
|||
catch( std::out_of_range& ) |
|||
{ |
|||
return false; |
|||
} |
|||
} |
|||
|
|||
/** |
|||
* Return the fixed name association with aLayerId. |
|||
*/ |
|||
static const wxChar* Name( PCB_LAYER_ID aLayerId ); |
|||
|
|||
/** |
|||
* Return a complete set of internal copper layers which is all Cu layers |
|||
* except F_Cu and B_Cu. |
|||
*/ |
|||
static LSET InternalCuMask(); |
|||
|
|||
/** |
|||
* Return a complete set of all top assembly layers which is all F_SilkS and F_Mask |
|||
*/ |
|||
static LSET FrontAssembly(); |
|||
|
|||
/** |
|||
* Return a complete set of all bottom assembly layers which is all B_SilkS and B_Mask |
|||
*/ |
|||
static LSET BackAssembly(); |
|||
|
|||
/** |
|||
* Return a mask holding the requested number of Cu PCB_LAYER_IDs. |
|||
*/ |
|||
static LSET AllCuMask( int aCuLayerCount = MAX_CU_LAYERS ); |
|||
|
|||
/** |
|||
* Return a mask holding the Front and Bottom layers. |
|||
*/ |
|||
static LSET ExternalCuMask(); |
|||
|
|||
/** |
|||
* Return a mask holding all layer minus CU layers. |
|||
*/ |
|||
static LSET AllNonCuMask(); |
|||
|
|||
static LSET AllLayersMask(); |
|||
|
|||
/** |
|||
* Return a mask holding all technical layers (no CU layer) on front side. |
|||
*/ |
|||
static LSET FrontTechMask(); |
|||
|
|||
/** |
|||
* Return a mask holding technical layers used in a board fabrication |
|||
* (no CU layer) on front side. |
|||
*/ |
|||
static LSET FrontBoardTechMask(); |
|||
|
|||
/** |
|||
* Return a mask holding all technical layers (no CU layer) on back side. |
|||
*/ |
|||
static LSET BackTechMask(); |
|||
|
|||
/** |
|||
* Return a mask holding technical layers used in a board fabrication |
|||
* (no CU layer) on Back side. |
|||
*/ |
|||
static LSET BackBoardTechMask(); |
|||
|
|||
/** |
|||
* Return a mask holding all technical layers (no CU layer) on both side. |
|||
*/ |
|||
static LSET AllTechMask(); |
|||
|
|||
/** |
|||
* Return a mask holding board technical layers (no CU layer) on both side. |
|||
*/ |
|||
static LSET AllBoardTechMask(); |
|||
|
|||
/** |
|||
* Return a mask holding all technical layers and the external CU layer on front side. |
|||
*/ |
|||
static LSET FrontMask(); |
|||
|
|||
/** |
|||
* Return a mask holding all technical layers and the external CU layer on back side. |
|||
*/ |
|||
static LSET BackMask(); |
|||
|
|||
static LSET SideSpecificMask(); |
|||
|
|||
static LSET UserMask(); |
|||
|
|||
/** |
|||
* Return a mask holding all layers which are physically realized. Equivalent to the copper |
|||
* layers + the board tech mask. |
|||
*/ |
|||
static LSET PhysicalLayersMask(); |
|||
|
|||
/** |
|||
* Return a mask with all of the allowable user defined layers. |
|||
*/ |
|||
static LSET UserDefinedLayers(); |
|||
|
|||
/** |
|||
* Layers which are not allowed within footprint definitions. Currently internal |
|||
* copper layers and Margin. |
|||
*/ |
|||
|
|||
static LSET ForbiddenFootprintLayers(); |
|||
|
|||
/** |
|||
* Return a sequence of copper layers in starting from the front/top |
|||
* and extending to the back/bottom. This specific sequence is depended upon |
|||
* in numerous places. |
|||
*/ |
|||
LSEQ CuStack() const; |
|||
|
|||
/** |
|||
* Return a sequence of technical layers. A sequence provides a certain order. |
|||
* |
|||
* @param aSubToOmit is the subset of the technical layers to omit, defaults to none. |
|||
*/ |
|||
LSEQ Technicals( LSET aSubToOmit = LSET() ) const; |
|||
|
|||
/// *_User layers. |
|||
LSEQ Users() const; |
|||
|
|||
/// Returns the technical and user layers in the order shown in layer widget |
|||
LSEQ TechAndUserUIOrder() const; |
|||
|
|||
LSEQ UIOrder() const; |
|||
|
|||
/** |
|||
* Return an LSEQ from the union of this LSET and a desired sequence. The LSEQ |
|||
* element will be in the same sequence as aWishListSequence if they are present. |
|||
* @param aWishListSequence establishes the order of the returned LSEQ, and the LSEQ will only |
|||
* contain PCB_LAYER_IDs which are present in this set. |
|||
* @param aCount is the length of aWishListSequence array. |
|||
*/ |
|||
LSEQ Seq( const PCB_LAYER_ID* aWishListSequence, unsigned aCount ) const; |
|||
|
|||
LSEQ Seq( const LSEQ& aSequence ) const; |
|||
|
|||
/** |
|||
* Return a LSEQ from this LSET in ascending PCB_LAYER_ID order. Each LSEQ |
|||
* element will be in the same sequence as in PCB_LAYER_ID and only present |
|||
* in the resultant LSEQ if present in this set. Therefore the sequence is |
|||
* subject to change, use it only when enumeration and not order is important. |
|||
*/ |
|||
LSEQ Seq() const; |
|||
|
|||
/** |
|||
* Generate a sequence of layers that represent a top to bottom stack of this set of layers. |
|||
* |
|||
* @param aSelectedLayer is the layer to put at the top of stack when defined. |
|||
* |
|||
* @return the top to bottom layer sequence. |
|||
*/ |
|||
LSEQ SeqStackupTop2Bottom( PCB_LAYER_ID aSelectedLayer = UNDEFINED_LAYER ) const; |
|||
|
|||
/** |
|||
* Return the sequence that is typical for a bottom-to-top stack-up. |
|||
* For instance, to plot multiple layers in a single image, the top layers output last. |
|||
*/ |
|||
LSEQ SeqStackupForPlotting() const; |
|||
|
|||
/** |
|||
* Execute a function on each layer of the LSET. |
|||
*/ |
|||
void RunOnLayers( const std::function<void( PCB_LAYER_ID )>& aFunction ) const |
|||
{ |
|||
for( size_t ii = 0; ii < size(); ++ii ) |
|||
{ |
|||
if( test( ii ) ) |
|||
aFunction( PCB_LAYER_ID( ii ) ); |
|||
} |
|||
} |
|||
|
|||
/** |
|||
* Return a hex string showing contents of this LSEQ. |
|||
*/ |
|||
std::string FmtHex() const; |
|||
|
|||
/** |
|||
* Convert the output of FmtHex() and replaces this set's values |
|||
* with those given in the input string. Parsing stops at the first |
|||
* non hex ASCII byte, except that marker bytes output from FmtHex are |
|||
* not terminators. |
|||
* @return int - number of bytes consumed |
|||
*/ |
|||
int ParseHex( const char* aStart, int aCount ); |
|||
|
|||
/** |
|||
* Return a binary string showing contents of this LSEQ. |
|||
*/ |
|||
std::string FmtBin() const; |
|||
|
|||
/** |
|||
* Find the first set PCB_LAYER_ID. Returns UNDEFINED_LAYER if more |
|||
* than one is set or UNSELECTED_LAYER if none is set. |
|||
*/ |
|||
PCB_LAYER_ID ExtractLayer() const; |
|||
|
|||
|
|||
/** |
|||
* Flip the layers in this set. |
|||
* |
|||
* BACK and FRONT copper layers, mask, paste, solder layers are swapped |
|||
* internal layers are flipped only if the copper layers count is known |
|||
* @param aMask = the LSET to flip |
|||
* @param aCopperLayersCount = the number of copper layers. if 0 (in fact if < 4 ) |
|||
* internal layers will be not flipped because the layer count is not known |
|||
*/ |
|||
LSET& Flip( int aCopperLayersCount = 0 ); |
|||
|
|||
}; |
|||
#endif // LSET_H |
|||
Some files were not shown because too many files changed in this diff
Write
Preview
Loading…
Cancel
Save
Reference in new issue