gcmc - G-Code Meta Compiler

Returns number of coordinates or the number of vectors in arg for argument types vector and vectorlist respectively.

Returns the length of arg calculated as sqrt(arg * arg).

Returns the scaled version of arg such that length(normalize(arg)) equals 1.0. The resulting normalized vector has no units associated.

Returns the reversed version of arg such that all coordinates of a vector or vectors of a vectorlist are reversed. I.e. the first becomes the last, etc..

Returns the current absolute position as a vector. The number of coordinates returned is 6 or 9, depending whether 9-axis mode is enabled on the command-line. The optional argument naxes limits the number of axis returned.

Returns arg rotated by angle. The plane of rotation is XY, XZ or YZ for respective functions. If arg is of type vectorlist, then each containing vector is rotated and a vectorlist is returned.

Multiply arg with coefficients from mult. Where mult can be seen as the primary diagonal of a multiplication matrix. If the first argument is of type vectorlist, then each containing vector of arg is iterated and scaled separately.

Returns the first nr number of entries from arg as a vector or vectorlist. If arg is a vector and has fewer than nr entries, then the result is padded with undef until the result has nr entries.
If arg is a vectorlist and has fewer than nr entries, then only the available entries are returned.
If nr is negative then a vector/vectorlist is returned with |nr| fewer entries than count(arg).

Returns the last nr number of entries from arg as a vector or vectorlist. If arg is a vector and has fewer than nr entries, then the result is prepended with undef until the result has nr entries.
If arg is a vectorlst and has fewer than nr entries, then only the available entries are returned.
If nr is negative then a vector/vectorlist is returned with |nr| fewer entries than count(arg).

Return the absolute value of val. Units are preserved.

Return the arc-cosine of val in radians.

Return the arc-sine of val in radians.

Return the arc-tangent of y/x in radians.

Return the smallest integral number not smaller than val. Units are preserved. Examples:
ceil(0.5) → 1.0
ceil(-0.5) → 0.0

Return the cosine of angle. The returned value has no units associated.

Return the exponentiation of val with base e. The returned value has no units associated.

Return the largest integral number not greater than val. Units are preserved. Examples:
floor(0.5) → 0.0
floor(-0.5) → -1.0

Return the logarithm of val with base 10, 2 and e respectively. The returned value has no units associated.

Returns pi (3.141529.....).

Return the x raised to the power y. The returned value has no units associated.

Return val rounded with half-way cases rounded away from zero. Units are preserved. Examples:
round(0.7) → 1.0
round(0.5) → 1.0
round(0.4) → 0.0
round(-0.4) → 0.0
round(-0.5) → -1.0
round(-0.7) → -1.0

Return the sine of angle. The returned value has no units associated.

Return the square root of val. The returned value has no units associated.

Return the tangent of angle. The returned value has no units associated.

Returns arg / pi() * 180.0 (deg) if arg has unit radians, returns arg otherwise. Vectors and vectorlists are iterated over all scalars contained in them and return vector or vectorlist. Conversions:

1	→ 1deg
1mm	→ Warning, 1deg
1in	→ Warning, 1deg
1deg	→ 1deg
1rad	→ 57.29577951deg
undef	→ undef

Returns arg * pi() / 180.0 (rad) if arg has unit degrees, returns arg otherwise. Vectors and vectorlists are iterated over all scalars contained in them and return vector or vectorlist. Conversions:

1	→ 1rad
1mm	→ Warning, 1rad
1in	→ Warning, 1rad
1deg	→ 0.01745329rad
1rad	→ 1rad
undef	→ undef

Returns arg coverted to inch. If arg has no units or already is in inch, then no conversion is performed. Vectors and vectorlists are iterated over all scalars contained in them and return vector or vectorlist. Conversions:

1	→ 1in
1mm	→ 0.03937008in
1in	→ 1in
1deg	→ Warning, 1in
1rad	→ Warning, 1in
undef	→ undef

Returns arg coverted to mm. If arg has no units or already is in mm, then no conversion is performed. Vectors and vectorlists are iterated over all scalars contained in them and return vector or vectorlist. Conversions:

1	→ 1mm
1mm	→ 1mm
1in	→ 25.4mm
1deg	→ Warning, 1mm
1rad	→ Warning, 1mm
undef	→ undef

Returns arg stripping any associated units. Vectors and vectorlists are iterated over all scalars contained in them and return vector or vectorlist. Conversions:

1	→ 1
1mm	→ 1
1in	→ 1
1deg	→ 1
1rad	→ 1
undef	→ undef

Convert arg to floating point. Vectors and vectorlists are iterated over all scalars contained in them and return vector or vectorlist. Undef is returned as undef and units are preserved.

Convert arg to integer. Floating point numbers are converted by truncation. Vectors and vectorlists are iterated over all scalars contained in them and return vector or vectorlist. Undef is returned as undef and units are preserved.

Outputs all arguments as text into the output. Note that the literal() function does not terminate the line with a newline and you must provide the newline as a string argument if the line must be terminated. The SVG and DXF backends ignore this function.

Do not use the literal() function lightly. It is extremely powerful but also very dangerous. It will make your source a lot more unreadable and may introduce side-effects that you did not intend.

If you simply want to embed a comment or a G-code debug statement, you should be using the comment() function instead because it is much safer to use.

Outputs all arguments as a G-code comment into the output. The comment() function will prepend a '(' and append a ')' including newline automatically.

Outputs all arguments as text to the console. Origin file and line number is prepended and a newline is appended if none in the last argument. The gcmc executable will return non-zero if error() is executed.

These functions return an integer (boolean) which is true (1) if arg is of tested type and false (0) otherwise.
Function isscalar(arg) equals "isint(arg) || isfloat(arg)".

These functions return an integer (boolean) which is true (1) if arg has the tested units and false (0) otherwise.
Function isangle(arg) equals "israd(arg) || isdeg(arg)".
Function isdistance(arg) equals "ismm(arg) || isinch(arg)".

These function return an integer (boolean) which is true (1) is the current output format is set as queried and false (0) otherwise.

Returns an integer (boolean) which is true (1) if a variable with name var is currently defined in either local or global scope and false (0) otherwise.

Returns an integer (boolean) which is true (1) if the output is set to relative mode (-r option) and false (0) otherwise.

Perform a counter clockwise (ccw) or clockwise (cw) arc from the current position to endpoint with radius radius. The arc will be shortest angular movement with positive radius and largest angular movement with negative radius. Optional turns sets the number of turns to perform. Functions arc_ccw_r() and arc_cw_r() use relative addressing. The argument endpoint returned.

Perform a clockwise (cw) or counter clockwise (ccw) circle with radius length(centerpoint) for the circle_cw_r and circle_ccw_r functions and radius length(centerpoint-position()) for the circle_cw and circle_ccw functions and where centerpoint is the center point or the circle. Optional turns sets the number of turns to perform. The specified centerpoint is a relative position for the circle_cw_r and circle_ccw_r functions and an absolute coordinate for circle_cw and circle_ccw. The non-active plane coordinate may be used to create a helical movement.

The scalar form performs a clockwise (cw) or counter clockwise (ccw) circle with radius radius. The center point is located at a vector calculated from the current position of length radius and angled at angle. Optional turns sets the number of turns to perform. The circle is always performed within the active plane.

Perform a drill-cycle to drillpoint with retract denoting the retract (Z) position after the cycle, increment the Z-axis increments and optional repeat repeats.

Rapid move (G0) to position endpoint. The endpoint position is an absolute position for goto() and a relative position for goto_r().
The endpoint vector may consist of up to nine coordinates and are interpreted for axis XYZABCUVW respectively. Coordinates for axes XYZ and UVW are interpreted with distance units and axes ABC are interpreted with angular units. The absolute position before the movement is returned.

Feed move (G1) to position endpoint. The endpoint position is an absolute position for move() and a relative position for move_r(). The optional rate argument sets the feed override (F-parameter) for this move and is interpreted in the context of the feedmode() setting.
The endpoint vector may consist of up to nine coordinates and are interpreted for axis XYZABCUVW respectively. Coordinates for axes XYZ and UVW are interpreted with distance units and axes ABC are interpreted with angular units. The absolute position before the movement is returned.

Set the operational plane to mode, which may be one of the following:

	scalar	string	Description
•	0	"XY"	use XY plane (G17) (default)
•	1	"XZ"	use XZ plane (G18)
•	2	"YZ"	use YZ plane (G19)

The previously active plane is returned.

Enable/disable coolant (M7, M8, M9). Argument state must be one of:

	scalar	string	Description
•	0	"off"	coolant off
•	1	"mist"	coolant mist
•	2	"flood"	coolant flood
•	3	"mist+flood"	coolant mist+flood

Pause (G4) for time seconds.

Feed rate mode setting to one of the following:

	scalar	string	Description
•	0	"inverse"	Inverse Time Mode (G93)
•	1	"upm"	Units Per Minute (G94) (default)
•	2	"upr"	Units Per Revolution (G95)

The time based units interpretation depend on the command-line setting whether metric (mm/s) or imperial (in/s).

Set feedrate (F) to rate. The rate is interpreted following the setting of the feedmode() function.

Enable/disable spindle turning and set the spindle's speed, where speed should be:

	scalar	Description
•	<0	spindle counter clockwise (M4)
•	0	spindle off (M5)
•	>0	spindle clockwise (M3)

The spindle speed is set with an S command to abs(speed).

Set the spindle's speed (S) to speed.

Change tool (T) to toolnr. An M6 code is also emitted to perform the actual tool change. If setoffs evaluates to true, then a G43 code is also emitted to set the tool's offset.

Emits a close-path SVG command (Z) to the path being output, such that the current shape becomes closed.