Merge pull request #111 from mvnmgrx/feature_knockout

Feature: `knockout` token for GrText and FpText elements

Author: mvnmgrx

Diff for: src/kiutils/items/fpitems.py

@@ -48,6 +48,10 @@ class FpText():
     layer: str = "F.Cu"
     """The ``layer`` token defines the canonical layer the text resides on"""
 
+    knockout: bool = False
+    """The ``knockout`` token defines if the text is inverted (means transparent text and colored
+    background insted of colored text and transparent background)"""
+
     hide: bool = False
     """The optional ``hide`` token, defines if the text is hidden"""
 
@@ -91,7 +95,11 @@ def from_sexpr(cls, exp: list) -> FpText:
                 if item == 'hide': object.hide = True
                 continue
             if item[0] == 'at': object.position = Position().from_sexpr(item)
-            if item[0] == 'layer': object.layer = item[1]
+            if item[0] == 'layer': 
+                object.layer = item[1]
+                if(len(item) > 2):
+                    if(item[2] == "knockout"):
+                        object.knockout = True
             if item[0] == 'effects': object.effects = Effects().from_sexpr(item)
             if item[0] == 'tstamp': object.tstamp = item[1]
             if item[0] == 'render_cache': object.renderCache = RenderCache.from_sexpr(item)
@@ -113,8 +121,9 @@ def to_sexpr(self, indent: int = 2, newline: bool = True) -> str:
         hide = ' hide' if self.hide else ''
         unlocked = ' unlocked' if self.position.unlocked else ''
         posA = f' {self.position.angle}' if self.position.angle is not None else ''
+        ko = ' knockout' if self.knockout else ''
 
-        expression =  f'{indents}(fp_text {self.type} "{dequote(self.text)}" (at {self.position.X} {self.position.Y}{posA}{unlocked}) (layer "{dequote(self.layer)}"){hide}\n'
+        expression =  f'{indents}(fp_text {self.type} "{dequote(self.text)}" (at {self.position.X} {self.position.Y}{posA}{unlocked}) (layer "{dequote(self.layer)}"{ko}){hide}\n'
         expression += f'{indents}  {self.effects.to_sexpr()}'
         if self.tstamp is not None:
             expression += f'{indents}  (tstamp {self.tstamp})\n'

Diff for: src/kiutils/items/gritems.py

@@ -34,8 +34,13 @@ class GrText():
     text: str = ""
     """The ``text`` attribute is a string that defines the text"""
 
+    knockout: bool = False
+    """The ``knockout`` token defines if the text is inverted (means transparent text and colored
+    background insted of colored text and transparent background)"""
+
     position: Position = field(default_factory=lambda: Position())
-    """The ``position`` defines the X and Y position coordinates and optional orientation angle of the text"""
+    """The ``position`` defines the X and Y position coordinates and optional orientation angle of 
+    the text"""
 
     layer: Optional[str] = None
     """The ``layer`` token defines the canonical layer the text resides on"""
@@ -82,7 +87,11 @@ def from_sexpr(cls, exp: list) -> GrText:
                 if item == 'locked': object.locked = True
                 continue
             if item[0] == 'at': object.position = Position().from_sexpr(item)
-            if item[0] == 'layer': object.layer = item[1]
+            if item[0] == 'layer': 
+                object.layer = item[1]
+                if(len(item) > 2):
+                    if(item[2] == "knockout"):
+                        object.knockout = True
             if item[0] == 'effects': object.effects = Effects().from_sexpr(item)
             if item[0] == 'tstamp': object.tstamp = item[1]
             if item[0] == 'render_cache': object.renderCache = RenderCache.from_sexpr(item)
@@ -101,8 +110,9 @@ def to_sexpr(self, indent: int = 2, newline: bool = True) -> str:
         indents = ' '*indent
         endline = '\n' if newline else ''
 
+        ko = ' knockout' if self.knockout else ''
         posA = f' {self.position.angle}' if self.position.angle is not None else ''
-        layer =  f' (layer "{dequote(self.layer)}")' if self.layer is not None else ''
+        layer =  f' (layer "{dequote(self.layer)}"{ko})' if self.layer is not None else ''
         tstamp = f' (tstamp {self.tstamp})' if self.tstamp is not None else ''
         locked = f' locked' if self.locked else ''
 

Diff for: tests/test_board.py

@@ -133,4 +133,11 @@ def test_textsWithRenderCaches(self):
         self.testData.compareToTestFile = True
         self.testData.pathToTestFile = path.join(BOARD_BASE, 'since_v7', 'test_textsWithRenderCaches')
         board = Board().from_file(self.testData.pathToTestFile)
-        self.assertTrue(to_file_and_compare(board, self.testData))
+        self.assertTrue(to_file_and_compare(board, self.testData))
+
+    def test_testKnockout(self):
+        """Tests the ``knockout`` token of a graphical text"""
+        self.testData.compareToTestFile = True
+        self.testData.pathToTestFile = path.join(BOARD_BASE, 'since_v7', 'test_textKnockout')
+        footprint = Board().from_file(self.testData.pathToTestFile)
+        self.assertTrue(to_file_and_compare(footprint, self.testData))

Diff for: tests/test_footprint.py

@@ -175,3 +175,9 @@ def test_netTiePadGroups(self):
         footprint = Footprint().from_file(self.testData.pathToTestFile)
         self.assertTrue(to_file_and_compare(footprint, self.testData))
 
+    def test_testKnockout(self):
+        """Tests the ``knockout`` token of a footprint text"""
+        self.testData.compareToTestFile = True
+        self.testData.pathToTestFile = path.join(FOOTPRINT_BASE, 'since_v7', 'test_textKnockout')
+        footprint = Footprint().from_file(self.testData.pathToTestFile)
+        self.assertTrue(to_file_and_compare(footprint, self.testData))

Diff for: tests/testdata/board/since_v7/test_textKnockout

@@ -0,0 +1,50 @@
+(kicad_pcb (version 20221018) (generator pcbnew)
+
+  (general
+    (thickness 1.6)
+  )
+
+  (paper "A4")
+  (layers
+    (0 "F.Cu" signal)
+    (31 "B.Cu" signal)
+    (32 "B.Adhes" user "B.Adhesive")
+    (33 "F.Adhes" user "F.Adhesive")
+    (34 "B.Paste" user)
+    (35 "F.Paste" user)
+    (36 "B.SilkS" user "B.Silkscreen")
+    (37 "F.SilkS" user "F.Silkscreen")
+    (38 "B.Mask" user)
+    (39 "F.Mask" user)
+    (40 "Dwgs.User" user "User.Drawings")
+    (41 "Cmts.User" user "User.Comments")
+    (42 "Eco1.User" user "User.Eco1")
+    (43 "Eco2.User" user "User.Eco2")
+    (44 "Edge.Cuts" user)
+    (45 "Margin" user)
+    (46 "B.CrtYd" user "B.Courtyard")
+    (47 "F.CrtYd" user "F.Courtyard")
+    (48 "B.Fab" user)
+    (49 "F.Fab" user)
+    (50 "User.1" user)
+    (51 "User.2" user)
+    (52 "User.3" user)
+    (53 "User.4" user)
+    (54 "User.5" user)
+    (55 "User.6" user)
+    (56 "User.7" user)
+    (57 "User.8" user)
+    (58 "User.9" user)
+  )
+
+  (setup
+    (pad_to_mask_clearance 0)
+  )
+
+  (net 0 "")
+
+  (gr_text "test" (at 168.42 92.81) (layer "F.Cu" knockout) (tstamp 37d6611e-bb8c-49f5-bc61-44562605f28f)
+    (effects (font (size 1.5 1.5) (thickness 0.3) bold) (justify left bottom))
+  )
+
+)

Diff for: tests/testdata/footprint/since_v7/test_textKnockout

@@ -0,0 +1,15 @@
+(footprint "CP_Elec_3x5.4" (version 20221018) (generator pcbnew)
+  (layer "F.Cu")
+  (tedit 65bd7f8d)
+  (descr "SMD capacitor, aluminum electrolytic, Nichicon, 3.0x5.4mm")
+  (tags "capacitor electrolytic")
+  (attr smd)
+  (fp_text reference "REF**" (at 0 -2.7) (layer "F.SilkS" knockout)
+    (effects (font (size 1 1) (thickness 0.15)))
+    (tstamp 44d2ce4a-f555-443e-872b-4f08845b4e47)
+  )
+  (fp_text user "${REFERENCE}" (at 0 0) (layer "F.Fab")
+    (effects (font (size 0.6 0.6) (thickness 0.09)))
+    (tstamp b78f3199-5a9c-4fe8-bce1-484a2ec30068)
+  )
+)