summaryrefslogtreecommitdiff
path: root/gerber/rs274x.py
diff options
context:
space:
mode:
authorPaulo Henrique Silva <ph.silva@gmail.com>2014-10-26 20:55:22 -0200
committerPaulo Henrique Silva <ph.silva@gmail.com>2014-10-26 20:55:22 -0200
commitd5c8d896d87e02d32d0c0758a09f051c141006f6 (patch)
tree50e2788e5dfc63db909a3613fff6934a0e80b153 /gerber/rs274x.py
parentd0eedf3dd7ee4fbf19f51de319e48dd964b93561 (diff)
parent4f076d7b769b0f488888d268a9a199b7545afdd7 (diff)
downloadgerbonara-d5c8d896d87e02d32d0c0758a09f051c141006f6.tar.gz
gerbonara-d5c8d896d87e02d32d0c0758a09f051c141006f6.tar.bz2
gerbonara-d5c8d896d87e02d32d0c0758a09f051c141006f6.zip
Merge pull request #4 from hamiltonkibbe/master
Many fixes in parsing, rendering and new features
Diffstat (limited to 'gerber/rs274x.py')
-rw-r--r--gerber/rs274x.py434
1 files changed, 434 insertions, 0 deletions
diff --git a/gerber/rs274x.py b/gerber/rs274x.py
new file mode 100644
index 0000000..f18a35d
--- /dev/null
+++ b/gerber/rs274x.py
@@ -0,0 +1,434 @@
+#! /usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# copyright 2014 Hamilton Kibbe <ham@hamiltonkib.be>
+# Modified from parser.py by Paulo Henrique Silva <ph.silva@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+""" This module provides an RS-274-X class and parser.
+"""
+
+
+import copy
+import json
+import re
+from .gerber_statements import *
+from .primitives import *
+from .cam import CamFile, FileSettings
+
+def read(filename):
+ """ Read data from filename and return a GerberFile
+
+ Parameters
+ ----------
+ filename : string
+ Filename of file to parse
+
+ Returns
+ -------
+ file : :class:`gerber.rs274x.GerberFile`
+ A GerberFile created from the specified file.
+ """
+ return GerberParser().parse(filename)
+
+
+class GerberFile(CamFile):
+ """ A class representing a single gerber file
+
+ The GerberFile class represents a single gerber file.
+
+ Parameters
+ ----------
+ statements : list
+ list of gerber file statements
+
+ settings : dict
+ Dictionary of gerber file settings
+
+ filename : string
+ Filename of the source gerber file
+
+ Attributes
+ ----------
+ comments: list of strings
+ List of comments contained in the gerber file.
+
+ size : tuple, (<float>, <float>)
+ Size in [self.units] of the layer described by the gerber file.
+
+ bounds: tuple, ((<float>, <float>), (<float>, <float>))
+ boundaries of the layer described by the gerber file.
+ `bounds` is stored as ((min x, max x), (min y, max y))
+
+ """
+ def __init__(self, statements, settings, primitives, filename=None):
+ super(GerberFile, self).__init__(statements, settings, primitives, filename)
+
+
+ @property
+ def comments(self):
+ return [comment.comment for comment in self.statements
+ if isinstance(comment, CommentStmt)]
+
+ @property
+ def size(self):
+ xbounds, ybounds = self.bounds
+ return (xbounds[1] - xbounds[0], ybounds[1] - ybounds[0])
+
+ @property
+ def bounds(self):
+ xbounds = [0.0, 0.0]
+ ybounds = [0.0, 0.0]
+ for stmt in [stmt for stmt in self.statements
+ if isinstance(stmt, CoordStmt)]:
+ if stmt.x is not None:
+ if stmt.x < xbounds[0]:
+ xbounds[0] = stmt.x
+ elif stmt.x > xbounds[1]:
+ xbounds[1] = stmt.x
+ if stmt.y is not None:
+ if stmt.y < ybounds[0]:
+ ybounds[0] = stmt.y
+ elif stmt.y > ybounds[1]:
+ ybounds[1] = stmt.y
+ return (xbounds, ybounds)
+
+
+ def write(self, filename):
+ """ Write data out to a gerber file
+ """
+ with open(filename, 'w') as f:
+ for statement in self.statements:
+ f.write(statement.to_gerber())
+
+
+class GerberParser(object):
+ """ GerberParser
+ """
+ NUMBER = r"[\+-]?\d+"
+ DECIMAL = r"[\+-]?\d+([.]?\d+)?"
+ STRING = r"[a-zA-Z0-9_+\-/!?<>”’(){}.\|&@# :]+"
+ NAME = r"[a-zA-Z_$][a-zA-Z_$0-9]+"
+ FUNCTION = r"G\d{2}"
+
+ COORD_OP = r"D[0]?[123]"
+
+ FS = r"(?P<param>FS)(?P<zero>(L|T))?(?P<notation>(A|I))X(?P<x>[0-7][0-7])Y(?P<y>[0-7][0-7])"
+ MO = r"(?P<param>MO)(?P<mo>(MM|IN))"
+ IP = r"(?P<param>IP)(?P<ip>(POS|NEG))"
+ LP = r"(?P<param>LP)(?P<lp>(D|C))"
+ AD_CIRCLE = r"(?P<param>AD)D(?P<d>\d+)(?P<shape>C)[,](?P<modifiers>[^,]*)"
+ AD_RECT = r"(?P<param>AD)D(?P<d>\d+)(?P<shape>R)[,]?(?P<modifiers>[^,]+)?"
+ AD_OBROUND = r"(?P<param>AD)D(?P<d>\d+)(?P<shape>O)[,](?P<modifiers>[^,]*)"
+ AD_POLY = r"(?P<param>AD)D(?P<d>\d+)(?P<shape>P)[,](?P<modifiers>[^,]*)"
+ AD_MACRO = r"(?P<param>AD)D(?P<d>\d+)(?P<shape>{name})[,]?(?P<modifiers>[^,]+)?".format(name=NAME)
+ AM = r"(?P<param>AM)(?P<name>{name})\*(?P<macro>.*)".format(name=NAME)
+
+ # begin deprecated
+ OF = r"(?P<param>OF)(A(?P<a>{decimal}))?(B(?P<b>{decimal}))?".format(decimal=DECIMAL)
+ IN = r"(?P<param>IN)(?P<name>.*)"
+ LN = r"(?P<param>LN)(?P<name>.*)"
+ # end deprecated
+
+ PARAMS = (FS, MO, IP, LP, AD_CIRCLE, AD_RECT, AD_OBROUND, AD_POLY, AD_MACRO, AM, OF, IN, LN)
+ PARAM_STMT = [re.compile(r"%{0}\*%".format(p)) for p in PARAMS]
+
+ COORD_STMT = re.compile((
+ r"(?P<function>{function})?"
+ r"(X(?P<x>{number}))?(Y(?P<y>{number}))?"
+ r"(I(?P<i>{number}))?(J(?P<j>{number}))?"
+ r"(?P<op>{op})?\*".format(number=NUMBER, function=FUNCTION, op=COORD_OP)))
+
+ APERTURE_STMT = re.compile(r"(G54)?D(?P<d>\d+)\*")
+
+ COMMENT_STMT = re.compile(r"G04(?P<comment>[^*]*)(\*)?")
+
+ EOF_STMT = re.compile(r"(?P<eof>M02)\*")
+
+ REGION_MODE_STMT = re.compile(r'(?P<mode>G3[67])\*')
+ QUAD_MODE_STMT = re.compile(r'(?P<mode>G7[45])\*')
+
+ def __init__(self):
+ self.settings = FileSettings()
+ self.statements = []
+ self.primitives = []
+ self.apertures = {}
+ self.current_region = None
+ self.x = 0
+ self.y = 0
+
+ self.aperture = 0
+ self.interpolation = 'linear'
+ self.direction = 'clockwise'
+ self.image_polarity = 'positive'
+ self.level_polarity = 'dark'
+ self.region_mode = 'off'
+ self.quadrant_mode = 'multi-quadrant'
+ self.step_and_repeat = (1, 1, 0, 0)
+
+
+ def parse(self, filename):
+ fp = open(filename, "r")
+ data = fp.readlines()
+
+ for stmt in self._parse(data):
+ self.evaluate(stmt)
+ self.statements.append(stmt)
+
+ return GerberFile(self.statements, self.settings, self.primitives, filename)
+
+ def dump_json(self):
+ stmts = {"statements": [stmt.__dict__ for stmt in self.statements]}
+ return json.dumps(stmts)
+
+ def dump_str(self):
+ s = ""
+ for stmt in self.statements:
+ s += str(stmt) + "\n"
+ return s
+
+ def _parse(self, data):
+ oldline = ''
+
+ for i, line in enumerate(data):
+ line = oldline + line.strip()
+
+ # skip empty lines
+ if not len(line):
+ continue
+
+ # deal with multi-line parameters
+ if line.startswith("%") and not line.endswith("%"):
+ oldline = line
+ continue
+
+ did_something = True # make sure we do at least one loop
+ while did_something and len(line) > 0:
+ did_something = False
+
+ # Region Mode
+ (mode, r) = _match_one(self.REGION_MODE_STMT, line)
+ if mode:
+ yield RegionModeStmt.from_gerber(line)
+ line = r
+ did_something = True
+ continue
+
+ # Quadrant Mode
+ (mode, r) = _match_one(self.QUAD_MODE_STMT, line)
+ if mode:
+ yield QuadrantModeStmt.from_gerber(line)
+ line = r
+ did_something = True
+ continue
+
+ # coord
+ (coord, r) = _match_one(self.COORD_STMT, line)
+ if coord:
+ yield CoordStmt.from_dict(coord, self.settings)
+ line = r
+ did_something = True
+ continue
+
+ # aperture selection
+ (aperture, r) = _match_one(self.APERTURE_STMT, line)
+ if aperture:
+ yield ApertureStmt(**aperture)
+
+ did_something = True
+ line = r
+ continue
+
+ # comment
+ (comment, r) = _match_one(self.COMMENT_STMT, line)
+ if comment:
+ yield CommentStmt(comment["comment"])
+ did_something = True
+ line = r
+ continue
+
+ # parameter
+ (param, r) = _match_one_from_many(self.PARAM_STMT, line)
+ if param:
+ if param["param"] == "FS":
+ stmt = FSParamStmt.from_dict(param)
+ self.settings.zero_suppression = stmt.zero_suppression
+ self.settings.format = stmt.format
+ self.settings.notation = stmt.notation
+ yield stmt
+ elif param["param"] == "MO":
+ stmt = MOParamStmt.from_dict(param)
+ self.settings.units = stmt.mode
+ yield stmt
+ elif param["param"] == "IP":
+ yield IPParamStmt.from_dict(param)
+ elif param["param"] == "LP":
+ yield LPParamStmt.from_dict(param)
+ elif param["param"] == "AD":
+ yield ADParamStmt.from_dict(param)
+ elif param["param"] == "AM":
+ yield AMParamStmt.from_dict(param)
+ elif param["param"] == "OF":
+ yield OFParamStmt.from_dict(param)
+ elif param["param"] == "IN":
+ yield INParamStmt.from_dict(param)
+ elif param["param"] == "LN":
+ yield LNParamStmt.from_dict(param)
+ else:
+ yield UnknownStmt(line)
+ did_something = True
+ line = r
+ continue
+
+ # eof
+ (eof, r) = _match_one(self.EOF_STMT, line)
+ if eof:
+ yield EofStmt()
+ did_something = True
+ line = r
+ continue
+
+ if False:
+ print self.COORD_STMT.pattern
+ print self.APERTURE_STMT.pattern
+ print self.COMMENT_STMT.pattern
+ print self.EOF_STMT.pattern
+ for i in self.PARAM_STMT:
+ print i.pattern
+
+ if line.find('*') > 0:
+ yield UnknownStmt(line)
+ oldline = line
+
+ def evaluate(self, stmt):
+ """ Evaluate Gerber statement and update image accordingly.
+
+ This method is called once for each statement in the file as it
+ is parsed.
+
+ Parameters
+ ----------
+ statement : Statement
+ Gerber/Excellon statement to evaluate.
+
+ """
+ if isinstance(stmt, CoordStmt):
+ self._evaluate_coord(stmt)
+
+ elif isinstance(stmt, ParamStmt):
+ self._evaluate_param(stmt)
+
+ elif isinstance(stmt, ApertureStmt):
+ self._evaluate_aperture(stmt)
+
+ elif isinstance(stmt, (RegionModeStmt, QuadrantModeStmt)):
+ self._evaluate_mode(stmt)
+
+ elif isinstance(stmt, (CommentStmt, UnknownStmt, EofStmt)):
+ return
+
+ else:
+ raise Exception("Invalid statement to evaluate")
+
+
+ def _define_aperture(self, d, shape, modifiers):
+ aperture = None
+ if shape == 'C':
+ diameter = float(modifiers[0][0])
+ aperture = Circle(position=None, diameter=diameter)
+ elif shape == 'R':
+ width = float(modifiers[0][0])
+ height = float(modifiers[0][1])
+ aperture = Rectangle(position=None, width=width, height=height)
+ elif shape == 'O':
+ width = float(modifiers[0][0])
+ height = float(modifiers[0][1])
+ aperture = Obround(position=None, width=width, height=height)
+ self.apertures[d] = aperture
+
+ def _evaluate_mode(self, stmt):
+ if stmt.type == 'RegionMode':
+ if self.region_mode == 'on' and stmt.mode == 'off':
+ self.primitives.append(Region(self.current_region, self.level_polarity))
+ self.current_region = None
+ self.region_mode = stmt.mode
+ elif stmt.type == 'QuadrantMode':
+ self.quadrant_mode = stmt.mode
+
+ def _evaluate_param(self, stmt):
+ if stmt.param == "FS":
+ self.settings.zero_suppression = stmt.zero_suppression
+ self.settings.format = stmt.format
+ self.settings.notation = stmt.notation
+ elif stmt.param == "MO":
+ self.settings.units = stmt.mode
+ elif stmt.param == "IP":
+ self.image_polarity = stmt.ip
+ elif stmt.param == "LP":
+ self.level_polarity = stmt.lp
+ elif stmt.param == "AD":
+ self._define_aperture(stmt.d, stmt.shape, stmt.modifiers)
+
+ def _evaluate_coord(self, stmt):
+ x = self.x if stmt.x is None else stmt.x
+ y = self.y if stmt.y is None else stmt.y
+ if stmt.function in ("G01", "G1"):
+ self.interpolation = 'linear'
+ elif stmt.function in ('G02', 'G2', 'G03', 'G3'):
+ self.interpolation = 'arc'
+ self.direction = ('clockwise' if stmt.function in ('G02', 'G2')
+ else 'counterclockwise')
+ if stmt.op == "D01":
+ if self.region_mode == 'on':
+ if self.current_region is None:
+ self.current_region = [(self.x, self.y), ]
+ self.current_region.append((x, y,))
+ else:
+ start = (self.x, self.y)
+ end = (x, y)
+ width = self.apertures[self.aperture].stroke_width
+ if self.interpolation == 'linear':
+ self.primitives.append(Line(start, end, width, self.level_polarity))
+ else:
+ center = (start[0] + stmt.i, start[1] + stmt.j)
+ self.primitives.append(Arc(start, end, center, self.direction, width, self.level_polarity))
+
+ elif stmt.op == "D02":
+ pass
+
+ elif stmt.op == "D03":
+ primitive = copy.deepcopy(self.apertures[self.aperture])
+ primitive.position = (x, y)
+ primitive.level_polarity = self.level_polarity
+ self.primitives.append(primitive)
+ self.x, self.y = x, y
+
+ def _evaluate_aperture(self, stmt):
+ self.aperture = stmt.d
+
+
+def _match_one(expr, data):
+ match = expr.match(data)
+ if match is None:
+ return ({}, None)
+ else:
+ return (match.groupdict(), data[match.end(0):])
+
+
+def _match_one_from_many(exprs, data):
+ for expr in exprs:
+ match = expr.match(data)
+ if match:
+ return (match.groupdict(), data[match.end(0):])
+
+ return ({}, None)