1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2013-2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2008-2015 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
7  * Copyright (C) 2004-2021 KiCad Developers, see change_log.txt for contributors.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
25  */
26 
27 #ifndef EDA_ITEM_FLAGS_H
28 #define EDA_ITEM_FLAGS_H
29 
30 #include <cstdint>
31 
32 // These define are used for the .m_flags and .m_UndoRedoStatus member of the
33 // class EDA_ITEM
34 //
35 // NB: DO NOT ADD FLAGS ANYWHERE BUT AT THE END: THE FLAG-SET IS STORED AS AN INTEGER IN FILES.
36 //
37 #define IS_CHANGED     (1 << 0)    ///< Item was edited, and modified
38 #define IS_LINKED      (1 << 1)    ///< Used in calculation to mark linked items (temporary use)
39 #define IN_EDIT        (1 << 2)    ///< Item currently edited
40 #define IS_MOVING      (1 << 3)    ///< Item being moved
41 #define IS_NEW         (1 << 4)    ///< New item, just created
42 #define IS_RESIZING    (1 << 5)    ///< Item being resized
43 #define IS_DRAGGING    (1 << 6)    ///< Item being dragged
44 #define IS_DELETED     (1 << 7)
45 #define IS_WIRE_IMAGE  (1 << 8)    ///< Item to be drawn as wireframe while editing
46 #define STARTPOINT     (1 << 9)    ///< When a line is selected, these flags indicate which
47 #define ENDPOINT       (1 << 10)   ///< ends.  (Used to support dragging.)
48 #define SELECTED       (1 << 11)
49 #define TEMP_SELECTED  (1 << 12)   ///< flag indicating that the structure has already selected
50 #define STRUCT_DELETED (1 << 13)   ///< flag indication structures to be erased
51 #define CANDIDATE      (1 << 14)   ///< flag indicating that the structure is connected
52 #define SKIP_STRUCT    (1 << 15)   ///< flag indicating that the structure should be ignored
53 #define DO_NOT_DRAW    (1 << 16)   ///< Used to disable draw function
54 #define IS_PASTED      (1 << 17)   ///< Modifier on IS_NEW which indicates it came from clipboard
55 #define LOCKED         (1 << 18)   ///< Pcbnew: locked from movement and deletion
56                                    ///< NB: stored in m_status flags, NOT m_flags.
57 #define UNUSED         (1 << 19)
58 #define MALFORMED_F_COURTYARD (1 << 20)
59 #define MALFORMED_B_COURTYARD (1 << 21)
60 #define MALFORMED_COURTYARDS ( MALFORMED_F_COURTYARD | MALFORMED_B_COURTYARD )
61 #define BEGIN_ONPAD    (1 << 22)   ///< Pcbnew: flag set for track segment starting on a pad
62 #define END_ONPAD      (1 << 23)   ///< Pcbnew: flag set for track segment ending on a pad
63 #define HOLE_PROXY     (1 << 24)   ///< Indicates the BOARD_ITEM is a proxy for its hole
64 #define IS_ROLLOVER    (1 << 25)   ///< Rollover active.  Used for hyperlink highlighting.
65 #define BRIGHTENED     (1 << 26)   ///< item is drawn with a bright contour
66 
67 #define DP_COUPLED     (1 << 27)   ///< item is coupled with another item making a differential pair
68                                    ///< (applies to segments only)
69 #define UR_TRANSIENT   (1 << 28)   ///< indicates the item is owned by the undo/redo stack
70 
71 #define IS_DANGLING    (1 << 29)   ///< indicates a pin is dangling
72 #define ENTERED        (1 << 30)   ///< indicates a group has been entered
73 
74 // WARNING: if you add flags, you'll probably need to adjust the masks in GetEditFlags() and
75 // ClearTempFlags().
76 
77 #define EDA_ITEM_ALL_FLAGS UINT32_MAX
78 
79 typedef std::uint32_t EDA_ITEM_FLAGS;
80 
81 #endif