summaryrefslogtreecommitdiff
path: root/gerber/render/rs274x_backend.py
blob: 3dc8c1a92a60698a7d3c5eb8b7b881982ff18267 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
from .render import GerberContext
from ..am_statements import *
from ..gerber_statements import *
from ..primitives import AMGroup, Arc, Circle, Line, Obround, Outline, Polygon, Rectangle
from copy import deepcopy

class AMGroupContext(object):
    '''A special renderer to generate aperature macros from an AMGroup'''
    
    def __init__(self):
        self.statements = []
    
    def render(self, amgroup, name):
        
        # Clone ourselves, then offset by the psotion so that
        # our render doesn't have to consider offset. Just makes things simplder
        nooffset_group = deepcopy(amgroup)
        nooffset_group.position = (0, 0)
        
        # Now draw the shapes
        for primitive in nooffset_group.primitives:
            if isinstance(primitive, Outline):
                self._render_outline(primitive)
            elif isinstance(primitive, Circle):
                self._render_circle(primitive)
            elif isinstance(primitive, Rectangle):
                self._render_rectangle(primitive)
            elif isinstance(primitive, Line):
                self._render_line(primitive)
            elif isinstance(primitive, Polygon):
                self._render_polygon(primitive)
            else:
                raise ValueError('amgroup')

        statement = AMParamStmt('AM', name, self._statements_to_string())
        return statement
    
    def _statements_to_string(self):
        macro = ''

        for statement in self.statements:
            macro += statement.to_gerber()
            
        return macro
    
    def _render_circle(self, circle):
        self.statements.append(AMCirclePrimitive.from_primitive(circle))
        
    def _render_rectangle(self, rectangle):
        self.statements.append(AMCenterLinePrimitive.from_primitive(rectangle))
        
    def _render_line(self, line):
        self.statements.append(AMVectorLinePrimitive.from_primitive(line))
     
    def _render_outline(self, outline):
        self.statements.append(AMOutlinePrimitive.from_primitive(outline))
        
    def _render_polygon(self, polygon):
        self.statements.append(AMPolygonPrimitive.from_primitive(polygon))
    
    def _render_thermal(self, thermal):
        pass
    

class Rs274xContext(GerberContext):
    
    def __init__(self, settings):
        GerberContext.__init__(self)
        self.comments = []
        self.header = []
        self.body = []
        self.end = [EofStmt()]
        
        # Current values so we know if we have to execute
        # moves, levey changes before anything else
        self._level_polarity = None
        self._pos = (None, None)
        self._func = None
        self._quadrant_mode = None
        self._dcode = None
        
        self._next_dcode = 10
        self._rects = {}
        self._circles = {}
        self._obrounds = {}
        self._polygons = {}
        self._macros = {}
        
        self._i_none = 0
        self._j_none = 0
        
        self.settings = settings

        self._start_header(settings)
        
    def _start_header(self, settings):
        self.header.append(FSParamStmt.from_settings(settings))
        self.header.append(MOParamStmt.from_units(settings.units))
        
    def _simplify_point(self, point):
        return (point[0] if point[0] != self._pos[0] else None, point[1] if point[1] != self._pos[1] else None)
    
    def _simplify_offset(self, point, offset):
        
        if point[0] != offset[0]:
            xoffset = point[0] - offset[0]
        else:
            xoffset = self._i_none
            
        if point[1] != offset[1]:
            yoffset = point[1] - offset[1]
        else:
            yoffset = self._j_none
        
        return (xoffset, yoffset)
        
    @property
    def statements(self):
        return self.comments + self.header + self.body + self.end
        
    def set_bounds(self, bounds):
        pass
    
    def _paint_background(self):
        pass
    
    def _select_aperture(self, aperture):
        
        # Select the right aperture if not already selected
        if aperture:
            if isinstance(aperture, Circle):
                aper = self._get_circle(aperture.diameter)
            elif isinstance(aperture, Rectangle):
                aper = self._get_rectangle(aperture.width, aperture.height)
            elif isinstance(aperture, Obround):
                aper = self._get_obround(aperture.width, aperture.height)
            elif isinstance(aperture, AMGroup):
                aper = self._get_amacro(aperture)
            else:
                raise NotImplementedError('Line with invalid aperture type')
                
            if aper.d != self._dcode:
                self.body.append(ApertureStmt(aper.d))
                self._dcode = aper.d
        
    def _render_line(self, line, color):
        
        self._select_aperture(line.aperture)
        
        self._render_level_polarity(line)
            
        # Get the right function
        if self._func != CoordStmt.FUNC_LINEAR:
            func = CoordStmt.FUNC_LINEAR
        else:
            func = None
        self._func = CoordStmt.FUNC_LINEAR
        
        if self._pos != line.start:
            self.body.append(CoordStmt.move(func, self._simplify_point(line.start)))
            self._pos = line.start
            # We already set the function, so the next command doesn't require that
            func = None
        
        point = self._simplify_point(line.end)
        
        # In some files, we see a lot of duplicated ponts, so omit those
        if point[0] != None or point[1] != None:
            self.body.append(CoordStmt.line(func, self._simplify_point(line.end)))
            self._pos = line.end
        elif func:
            self.body.append(CoordStmt.mode(func))
        
    def _render_arc(self, arc, color):
        
        # Optionally set the quadrant mode if it has changed:
        if arc.quadrant_mode != self._quadrant_mode:
            
            if arc.quadrant_mode != 'multi-quadrant':
                self.body.append(QuadrantModeStmt.single())
            else:
                self.body.append(QuadrantModeStmt.multi())
            
            self._quadrant_mode = arc.quadrant_mode
            
        # Select the right aperture if not already selected
        self._select_aperture(arc.aperture)
        
        self._render_level_polarity(arc)
        
        # Find the right movement mode. Always set to be sure it is really right
        dir = arc.direction
        if dir == 'clockwise':
            func = CoordStmt.FUNC_ARC_CW
            self._func = CoordStmt.FUNC_ARC_CW
        elif dir == 'counterclockwise':
            func = CoordStmt.FUNC_ARC_CCW
            self._func = CoordStmt.FUNC_ARC_CCW
        else:
            raise ValueError('Invalid circular interpolation mode')
            
        if self._pos != arc.start:
            # TODO I'm not sure if this is right
            self.body.append(CoordStmt.move(CoordStmt.FUNC_LINEAR, self._simplify_point(arc.start)))
            self._pos = arc.start
            
        center = self._simplify_offset(arc.center, arc.start)
        end = self._simplify_point(arc.end)
        self.body.append(CoordStmt.arc(func, end, center))
        self._pos = arc.end

    def _render_region(self, region, color):
        
        self._render_level_polarity(region)
        
        self.body.append(RegionModeStmt.on())
        
        for p in region.primitives:
            
            if isinstance(p, Line):
                self._render_line(p, color)
            else:
                self._render_arc(p, color)
                

        self.body.append(RegionModeStmt.off())
        
    def _render_level_polarity(self, region):
        if region.level_polarity != self._level_polarity:
            self._level_polarity = region.level_polarity
            self.body.append(LPParamStmt.from_region(region))
            
    def _render_flash(self, primitive, aperture):
        
        if aperture.d != self._dcode:
            self.body.append(ApertureStmt(aperture.d))
            self._dcode = aperture.d
        
        self.body.append(CoordStmt.flash( self._simplify_point(primitive.position)))
        self._pos = primitive.position
            
    def _get_circle(self, diameter, dcode = None):
        '''Define a circlar aperture'''
        
        aper = self._circles.get(diameter, None)

        if not aper:
            if not dcode:
                dcode = self._next_dcode
                self._next_dcode += 1
            else:
                self._next_dcode = max(dcode + 1, self._next_dcode)
                
            aper = ADParamStmt.circle(dcode, diameter)
            self._circles[diameter] = aper
            self.header.append(aper)

        return aper
        
    def _render_circle(self, circle, color):

        aper = self._get_circle(circle.diameter)
        self._render_flash(circle, aper)

    def _get_rectangle(self, width, height, dcode = None):
        '''Get a rectanglar aperture. If it isn't defined, create it'''
        
        key = (width, height)
        aper = self._rects.get(key, None)
        
        if not aper:
            if not dcode:
                dcode = self._next_dcode
                self._next_dcode += 1
            else:
                self._next_dcode = max(dcode + 1, self._next_dcode)
            
            aper = ADParamStmt.rect(dcode, width, height)
            self._rects[(width, height)] = aper
            self.header.append(aper)
    
        return aper

    def _render_rectangle(self, rectangle, color):
        
        aper = self._get_rectangle(rectangle.width, rectangle.height)
        self._render_flash(rectangle, aper)
        
    def _get_obround(self, width, height, dcode = None):
        
        key = (width, height)
        aper = self._obrounds.get(key, None)
        
        if not aper:
            if not dcode:
                dcode = self._next_dcode
                self._next_dcode += 1
            else:
                self._next_dcode = max(dcode + 1, self._next_dcode)
            
            aper = ADParamStmt.obround(dcode, width, height)
            self._obrounds[(width, height)] = aper
            self.header.append(aper)
    
        return aper
        
    def _render_obround(self, obround, color):
        
        aper = self._get_obround(obround.width, obround.height)
        self._render_flash(obround, aper)
        
        pass
        
    def _render_polygon(self, polygon, color):
        raise ValueError('Polygons can only exist in the context of aperture macro')
        
    def _render_drill(self, drill, color):
        raise ValueError('Drills are not valid in RS274X files')
    
    def _hash_amacro(self, amgroup):
        '''Calculate a very quick hash code for deciding if we should even check AM groups for comparision'''
        
        hash = ''
        for primitive in amgroup.primitives:
            
            hash += primitive.__class__.__name__[0]
            
            bbox = primitive.bounding_box
            hash += str((bbox[0][1] - bbox[0][0]) * 100000)[0:2]
            hash += str((bbox[1][1] - bbox[1][0]) * 100000)[0:2]
            
            if hasattr(primitive, 'primitives'):
                hash += str(len(primitive.primitives))
                
            if isinstance(primitive, Rectangle):
                hash += str(primitive.width * 1000000)[0:2]
                hash += str(primitive.height * 1000000)[0:2]
            elif isinstance(primitive, Circle):
                hash += str(primitive.diameter * 1000000)[0:2]
            
        return hash

    def _get_amacro(self, amgroup, dcode = None):
        # Macros are a little special since we don't have a good way to compare them quickly
        # but in most cases, this should work
        
        hash = self._hash_amacro(amgroup)
        macro = None
        macroinfo = self._macros.get(hash, None)
        
        if macroinfo:
            
            # We hae a definition, but check that the groups actually are the same
            for macro in macroinfo:
                
                # Macros should have positions, right? But if the macro is selected for non-flashes
                # then it won't have a position. This is of course a bad gerber, but they do exist
                if amgroup.position:
                    position = amgroup.position
                else:
                    position = (0, 0)

                offset = (position[0] - macro[1].position[0], position[1] - macro[1].position[1])
                if amgroup.equivalent(macro[1], offset):
                    break
                macro = None
                
        # Did we find one in the group0
        if not macro:
            # This is a new macro, so define it
            if not dcode:
                dcode = self._next_dcode
                self._next_dcode += 1
            else:
                self._next_dcode = max(dcode + 1, self._next_dcode)
            
            # Create the statements
            # TODO
            amrenderer = AMGroupContext()
            statement = amrenderer.render(amgroup, hash)
            
            self.header.append(statement)
            
            aperdef = ADParamStmt.macro(dcode, hash)
            self.header.append(aperdef)
            
            # Store the dcode and the original so we can check if it really is the same
            # If it didn't have a postition, set it to 0, 0
            if amgroup.position == None:
                amgroup.position = (0, 0)
            macro = (aperdef, amgroup)
            
            if macroinfo:
                macroinfo.append(macro)
            else:
                self._macros[hash] = [macro]                
            
        return macro[0]
        
    def _render_amgroup(self, amgroup, color):
        
        aper = self._get_amacro(amgroup)
        self._render_flash(amgroup, aper)

    def _render_inverted_layer(self):
        pass