KiCad PCB EDA Suite
rs274x.cpp File Reference
#include <base_units.h>
#include <math/util.h>
#include <gerbview.h>
#include <gerber_file_image.h>
#include <ignore.h>
#include <macros.h>
#include <X2_gerber_attributes.h>
#include <gbr_metadata.h>

Go to the source code of this file.

Macros

#define CODE(x, y)   ( ( (x) << 8 ) + (y) )
 

Enumerations

enum  RS274X_PARAMETERS {
  AXIS_SELECT = CODE( 'A', 'S' ) , FORMAT_STATEMENT = CODE( 'F', 'S' ) , MIRROR_IMAGE = CODE( 'M', 'I' ) , MODE_OF_UNITS = CODE( 'M', 'O' ) ,
  INCH = CODE( 'I', 'N' ) , MILLIMETER = CODE( 'M', 'M' ) , OFFSET = CODE( 'O', 'F' ) , SCALE_FACTOR = CODE( 'S', 'F' ) ,
  IMAGE_JUSTIFY = CODE( 'I', 'J' ) , IMAGE_NAME = CODE( 'I', 'N' ) , IMAGE_OFFSET = CODE( 'I', 'O' ) , IMAGE_POLARITY = CODE( 'I', 'P' ) ,
  IMAGE_ROTATION = CODE( 'I', 'R' ) , AP_DEFINITION = CODE( 'A', 'D' ) , AP_MACRO = CODE( 'A', 'M' ) , FILE_ATTRIBUTE = CODE( 'T', 'F' ) ,
  NET_ATTRIBUTE = CODE( 'T', 'O' ) , APERTURE_ATTRIBUTE = CODE( 'T', 'A' ) , REMOVE_APERTURE_ATTRIBUTE = CODE( 'T', 'D' ) , KNOCKOUT = CODE( 'K', 'O' ) ,
  STEP_AND_REPEAT = CODE( 'S', 'R' ) , ROTATE = CODE( 'R', 'O' ) , LOAD_POLARITY = CODE( 'L', 'P' ) , LOAD_NAME = CODE( 'L', 'N' )
}
 

Functions

int ReadInt (char *&text, bool aSkipSeparator=true)
 Read an integer from an ASCII character buffer. More...
 
double ReadDouble (char *&text, bool aSkipSeparator=true)
 Read a double precision floating point number from an ASCII character buffer. More...
 

Macro Definition Documentation

◆ CODE

#define CODE (   x,
 
)    ( ( (x) << 8 ) + (y) )

Definition at line 43 of file rs274x.cpp.

Enumeration Type Documentation

◆ RS274X_PARAMETERS

Enumerator
AXIS_SELECT 
FORMAT_STATEMENT 
MIRROR_IMAGE 
MODE_OF_UNITS 
INCH 
MILLIMETER 
OFFSET 
SCALE_FACTOR 
IMAGE_JUSTIFY 
IMAGE_NAME 
IMAGE_OFFSET 
IMAGE_POLARITY 
IMAGE_ROTATION 
AP_DEFINITION 
AP_MACRO 
FILE_ATTRIBUTE 
NET_ATTRIBUTE 
APERTURE_ATTRIBUTE 
REMOVE_APERTURE_ATTRIBUTE 
KNOCKOUT 
STEP_AND_REPEAT 
ROTATE 
LOAD_POLARITY 
LOAD_NAME 

Definition at line 56 of file rs274x.cpp.

56 {
57 // Directive parameters: single usage recommended
58 // Must be at the beginning of the file
59 AXIS_SELECT = CODE( 'A', 'S' ), // Default: A=X, B=Y
60 FORMAT_STATEMENT = CODE( 'F', 'S' ), // no default: this command must exists
61 MIRROR_IMAGE = CODE( 'M', 'I' ), // Default: mo mirror
62 MODE_OF_UNITS = CODE( 'M', 'O' ), // Default: inch
63 INCH = CODE( 'I', 'N' ),
64 MILLIMETER = CODE( 'M', 'M' ),
65 OFFSET = CODE( 'O', 'F' ), // Default: A = 0, B = 0
66 SCALE_FACTOR = CODE( 'S', 'F' ), // Default: A = 1.0, B = 1.0
67
68 // Image parameters:
69 // commands used only once at the beginning of the file, and are deprecated
70 IMAGE_JUSTIFY = CODE( 'I', 'J' ), // Default: no justification
71 IMAGE_NAME = CODE( 'I', 'N' ), // Default: void
72 IMAGE_OFFSET = CODE( 'I', 'O' ), // Default: A = 0, B = 0
73 IMAGE_POLARITY = CODE( 'I', 'P' ), // Default: Positive
74 IMAGE_ROTATION = CODE( 'I', 'R' ), // Default: 0
75
76 // Aperture parameters:
77 // Usually for the whole file
78 AP_DEFINITION = CODE( 'A', 'D' ),
79 AP_MACRO = CODE( 'A', 'M' ),
80
81 // X2 extension attribute commands
82 // Mainly are found standard attributes and user attributes
83 // standard attributes commands are:
84 // TF (file attribute) TO (net attribute)
85 // TA (aperture attribute) and TD (delete aperture attribute)
86 FILE_ATTRIBUTE = CODE( 'T', 'F' ),
87
88 // X2 extension Net attribute info
89 // Net attribute options are:
90 // TO (net attribute data): TO.CN or TO.P TO.N or TO.C
91 NET_ATTRIBUTE = CODE( 'T', 'O' ),
92
93 // X2 extension Aperture attribute TA
94 APERTURE_ATTRIBUTE = CODE( 'T', 'A' ),
95
96 // TD (delete aperture/object attribute):
97 // Delete aperture attribute added by %TA or Oblect attribute added b %TO
98 // TD (delete all) or %TD<attr name> to delete <attr name>.
99 // eg: TD.P or TD.N or TD.C ...
100 REMOVE_APERTURE_ATTRIBUTE = CODE( 'T', 'D' ),
101
102 // Layer specific parameters
103 // May be used singly or may be layer specific
104 // These parameters are at the beginning of the file or layer
105 // and reset some layer parameters (like interpolation)
106 KNOCKOUT = CODE( 'K', 'O' ), // Default: off
107 STEP_AND_REPEAT = CODE( 'S', 'R' ), // Default: A = 1, B = 1
108 ROTATE = CODE( 'R', 'O' ), // Default: 0
109
110 LOAD_POLARITY = CODE( 'L', 'P' ), //LPC or LPD. Default: Dark (LPD)
111 LOAD_NAME = CODE( 'L', 'N' ), // Deprecated: equivalent to G04
112};
@ FILE_ATTRIBUTE
Definition: rs274x.cpp:86
@ IMAGE_JUSTIFY
Definition: rs274x.cpp:70
@ APERTURE_ATTRIBUTE
Definition: rs274x.cpp:94
@ FORMAT_STATEMENT
Definition: rs274x.cpp:60
@ NET_ATTRIBUTE
Definition: rs274x.cpp:91
@ IMAGE_OFFSET
Definition: rs274x.cpp:72
@ ROTATE
Definition: rs274x.cpp:108
@ STEP_AND_REPEAT
Definition: rs274x.cpp:107
@ LOAD_NAME
Definition: rs274x.cpp:111
@ REMOVE_APERTURE_ATTRIBUTE
Definition: rs274x.cpp:100
@ KNOCKOUT
Definition: rs274x.cpp:106
@ AP_MACRO
Definition: rs274x.cpp:79
@ MIRROR_IMAGE
Definition: rs274x.cpp:61
@ MODE_OF_UNITS
Definition: rs274x.cpp:62
@ INCH
Definition: rs274x.cpp:63
@ IMAGE_NAME
Definition: rs274x.cpp:71
@ OFFSET
Definition: rs274x.cpp:65
@ MILLIMETER
Definition: rs274x.cpp:64
@ AXIS_SELECT
Definition: rs274x.cpp:59
@ SCALE_FACTOR
Definition: rs274x.cpp:66
@ IMAGE_ROTATION
Definition: rs274x.cpp:74
@ LOAD_POLARITY
Definition: rs274x.cpp:110
@ IMAGE_POLARITY
Definition: rs274x.cpp:73
@ AP_DEFINITION
Definition: rs274x.cpp:78
#define CODE(x, y)
Definition: rs274x.cpp:43

Function Documentation

◆ ReadDouble()

double ReadDouble ( char *&  text,
bool  aSkipSeparator = true 
)

Read a double precision floating point number from an ASCII character buffer.

If there is a comma after the number, then skip over that.

Parameters
textis a reference to a character pointer from which the ASCII double is read from and the pointer advanced for each character read.
aSkipSeparatorset to true (default) to skip comma.
Returns
number read.

Definition at line 295 of file rs274_read_XY_and_IJ_coordinates.cpp.

296{
297 double ret;
298
299 // For strtod, a string starting by 0X or 0x is a valid number in hexadecimal or octal.
300 // However, 'X' is a separator in Gerber strings with numbers.
301 // We need to detect that
302 if( strncasecmp( text, "0X", 2 ) == 0 )
303 {
304 text++;
305 ret = 0.0;
306 }
307 else
308 {
309 ret = strtod( text, &text );
310 }
311
312 if( *text == ',' || isspace( *text ) )
313 {
314 if( aSkipSeparator )
315 ++text;
316 }
317
318 return ret;
319}

Referenced by GERBER_FILE_IMAGE::ExecuteRS274XCommand().

◆ ReadInt()

int ReadInt ( char *&  text,
bool  aSkipSeparator = true 
)

Read an integer from an ASCII character buffer.

If there is a comma after the integer, then skip over that.

Parameters
textis a reference to a character pointer from which bytes are read and the pointer is advanced for each byte read.
aSkipSeparatorset to true (default) to skip comma.
Returns
The integer read in.

Definition at line 258 of file rs274_read_XY_and_IJ_coordinates.cpp.

259{
260 int ret;
261
262 // For strtol, a string starting by 0X or 0x is a valid number in hexadecimal or octal.
263 // However, 'X' is a separator in Gerber strings with numbers.
264 // We need to detect that
265 if( strncasecmp( text, "0X", 2 ) == 0 )
266 {
267 text++;
268 ret = 0;
269 }
270 else
271 {
272 ret = (int) strtol( text, &text, 10 );
273 }
274
275 if( *text == ',' || isspace( *text ) )
276 {
277 if( aSkipSeparator )
278 ++text;
279 }
280
281 return ret;
282}

Referenced by GERBER_FILE_IMAGE::ExecuteRS274XCommand(), and GERBER_FILE_IMAGE::ReadApertureMacro().