kcl_lib/std/
mod.rs

1//! Functions implemented for language execution.
2
3pub mod appearance;
4pub mod args;
5pub mod array;
6pub mod assert;
7pub mod axis_or_reference;
8pub mod chamfer;
9pub mod clone;
10pub mod constraints;
11pub mod csg;
12pub mod edge;
13pub mod extrude;
14pub mod fillet;
15pub mod gdt;
16pub mod helix;
17pub mod loft;
18pub mod math;
19pub mod mirror;
20pub mod patterns;
21pub mod planes;
22pub mod revolve;
23pub mod segment;
24pub mod shapes;
25pub mod shell;
26pub mod sketch;
27pub mod sweep;
28pub mod transform;
29pub mod utils;
30
31use anyhow::Result;
32pub use args::Args;
33
34use crate::{
35    errors::KclError,
36    execution::{ExecState, KclValue, types::PrimitiveType},
37};
38
39pub type StdFn = fn(
40    &mut ExecState,
41    Args,
42) -> std::pin::Pin<Box<dyn std::future::Future<Output = Result<KclValue, KclError>> + Send + '_>>;
43
44#[derive(Clone, Debug, PartialEq, Eq)]
45pub struct StdFnProps {
46    pub name: String,
47    pub include_in_feature_tree: bool,
48}
49
50impl StdFnProps {
51    fn default(name: &str) -> Self {
52        Self {
53            name: name.to_owned(),
54            include_in_feature_tree: false,
55        }
56    }
57
58    fn include_in_feature_tree(mut self) -> Self {
59        self.include_in_feature_tree = true;
60        self
61    }
62}
63
64pub(crate) fn std_fn(path: &str, fn_name: &str) -> (crate::std::StdFn, StdFnProps) {
65    match (path, fn_name) {
66        ("gdt", "datum") => (
67            |e, a| Box::pin(crate::std::gdt::datum(e, a)),
68            StdFnProps::default("std::gdt::datum").include_in_feature_tree(),
69        ),
70        ("gdt", "flatness") => (
71            |e, a| Box::pin(crate::std::gdt::flatness(e, a)),
72            StdFnProps::default("std::gdt::flatness").include_in_feature_tree(),
73        ),
74        ("math", "cos") => (
75            |e, a| Box::pin(crate::std::math::cos(e, a)),
76            StdFnProps::default("std::math::cos"),
77        ),
78        ("math", "sin") => (
79            |e, a| Box::pin(crate::std::math::sin(e, a)),
80            StdFnProps::default("std::math::sin"),
81        ),
82        ("math", "tan") => (
83            |e, a| Box::pin(crate::std::math::tan(e, a)),
84            StdFnProps::default("std::math::tan"),
85        ),
86        ("math", "acos") => (
87            |e, a| Box::pin(crate::std::math::acos(e, a)),
88            StdFnProps::default("std::math::acos"),
89        ),
90        ("math", "asin") => (
91            |e, a| Box::pin(crate::std::math::asin(e, a)),
92            StdFnProps::default("std::math::asin"),
93        ),
94        ("math", "atan") => (
95            |e, a| Box::pin(crate::std::math::atan(e, a)),
96            StdFnProps::default("std::math::atan"),
97        ),
98        ("math", "atan2") => (
99            |e, a| Box::pin(crate::std::math::atan2(e, a)),
100            StdFnProps::default("std::math::atan2"),
101        ),
102        ("math", "sqrt") => (
103            |e, a| Box::pin(crate::std::math::sqrt(e, a)),
104            StdFnProps::default("std::math::sqrt"),
105        ),
106
107        ("math", "abs") => (
108            |e, a| Box::pin(crate::std::math::abs(e, a)),
109            StdFnProps::default("std::math::abs"),
110        ),
111        ("math", "rem") => (
112            |e, a| Box::pin(crate::std::math::rem(e, a)),
113            StdFnProps::default("std::math::rem"),
114        ),
115        ("math", "round") => (
116            |e, a| Box::pin(crate::std::math::round(e, a)),
117            StdFnProps::default("std::math::round"),
118        ),
119        ("math", "floor") => (
120            |e, a| Box::pin(crate::std::math::floor(e, a)),
121            StdFnProps::default("std::math::floor"),
122        ),
123        ("math", "ceil") => (
124            |e, a| Box::pin(crate::std::math::ceil(e, a)),
125            StdFnProps::default("std::math::ceil"),
126        ),
127        ("math", "min") => (
128            |e, a| Box::pin(crate::std::math::min(e, a)),
129            StdFnProps::default("std::math::min"),
130        ),
131        ("math", "max") => (
132            |e, a| Box::pin(crate::std::math::max(e, a)),
133            StdFnProps::default("std::math::max"),
134        ),
135        ("math", "pow") => (
136            |e, a| Box::pin(crate::std::math::pow(e, a)),
137            StdFnProps::default("std::math::pow"),
138        ),
139        ("math", "log") => (
140            |e, a| Box::pin(crate::std::math::log(e, a)),
141            StdFnProps::default("std::math::log"),
142        ),
143        ("math", "log2") => (
144            |e, a| Box::pin(crate::std::math::log2(e, a)),
145            StdFnProps::default("std::math::log2"),
146        ),
147        ("math", "log10") => (
148            |e, a| Box::pin(crate::std::math::log10(e, a)),
149            StdFnProps::default("std::math::log10"),
150        ),
151        ("math", "ln") => (
152            |e, a| Box::pin(crate::std::math::ln(e, a)),
153            StdFnProps::default("std::math::ln"),
154        ),
155        ("math", "legLen") => (
156            |e, a| Box::pin(crate::std::math::leg_length(e, a)),
157            StdFnProps::default("std::math::legLen"),
158        ),
159        ("math", "legAngX") => (
160            |e, a| Box::pin(crate::std::math::leg_angle_x(e, a)),
161            StdFnProps::default("std::math::legAngX"),
162        ),
163        ("math", "legAngY") => (
164            |e, a| Box::pin(crate::std::math::leg_angle_y(e, a)),
165            StdFnProps::default("std::math::legAngY"),
166        ),
167        ("sketch", "circle") => (
168            |e, a| Box::pin(crate::std::shapes::circle(e, a)),
169            StdFnProps::default("std::sketch::circle"),
170        ),
171        ("sketch", "ellipse") => (
172            |e, a| Box::pin(crate::std::shapes::ellipse(e, a)),
173            StdFnProps::default("std::sketch::ellipse").include_in_feature_tree(),
174        ),
175        ("prelude", "helix") => (
176            |e, a| Box::pin(crate::std::helix::helix(e, a)),
177            StdFnProps::default("std::helix").include_in_feature_tree(),
178        ),
179        ("transform", "mirror2d") => (
180            |e, a| Box::pin(crate::std::mirror::mirror_2d(e, a)),
181            StdFnProps::default("std::transform::mirror2d").include_in_feature_tree(),
182        ),
183        ("transform", "translate") => (
184            |e, a| Box::pin(crate::std::transform::translate(e, a)),
185            StdFnProps::default("std::transform::translate").include_in_feature_tree(),
186        ),
187        ("transform", "rotate") => (
188            |e, a| Box::pin(crate::std::transform::rotate(e, a)),
189            StdFnProps::default("std::transform::rotate").include_in_feature_tree(),
190        ),
191        ("transform", "scale") => (
192            |e, a| Box::pin(crate::std::transform::scale(e, a)),
193            StdFnProps::default("std::transform::scale").include_in_feature_tree(),
194        ),
195        ("prelude", "offsetPlane") => (
196            |e, a| Box::pin(crate::std::planes::offset_plane(e, a)),
197            StdFnProps::default("std::offsetPlane").include_in_feature_tree(),
198        ),
199        ("prelude", "assert") => (
200            |e, a| Box::pin(crate::std::assert::assert(e, a)),
201            StdFnProps::default("std::assert"),
202        ),
203        ("prelude", "assertIs") => (
204            |e, a| Box::pin(crate::std::assert::assert_is(e, a)),
205            StdFnProps::default("std::assertIs"),
206        ),
207        ("solid", "fillet") => (
208            |e, a| Box::pin(crate::std::fillet::fillet(e, a)),
209            StdFnProps::default("std::solid::fillet").include_in_feature_tree(),
210        ),
211        ("solid", "chamfer") => (
212            |e, a| Box::pin(crate::std::chamfer::chamfer(e, a)),
213            StdFnProps::default("std::solid::chamfer").include_in_feature_tree(),
214        ),
215        ("solid", "shell") => (
216            |e, a| Box::pin(crate::std::shell::shell(e, a)),
217            StdFnProps::default("std::solid::shell").include_in_feature_tree(),
218        ),
219        ("solid", "hollow") => (
220            |e, a| Box::pin(crate::std::shell::hollow(e, a)),
221            StdFnProps::default("std::solid::hollow").include_in_feature_tree(),
222        ),
223        ("solid", "union") => (
224            |e, a| Box::pin(crate::std::csg::union(e, a)),
225            StdFnProps::default("std::solid::union").include_in_feature_tree(),
226        ),
227        ("solid", "intersect") => (
228            |e, a| Box::pin(crate::std::csg::intersect(e, a)),
229            StdFnProps::default("std::solid::intersect").include_in_feature_tree(),
230        ),
231        ("solid", "subtract") => (
232            |e, a| Box::pin(crate::std::csg::subtract(e, a)),
233            StdFnProps::default("std::solid::subtract").include_in_feature_tree(),
234        ),
235        ("solid", "patternTransform") => (
236            |e, a| Box::pin(crate::std::patterns::pattern_transform(e, a)),
237            StdFnProps::default("std::solid::patternTransform").include_in_feature_tree(),
238        ),
239        ("solid", "patternLinear3d") => (
240            |e, a| Box::pin(crate::std::patterns::pattern_linear_3d(e, a)),
241            StdFnProps::default("std::solid::patternLinear3d").include_in_feature_tree(),
242        ),
243        ("solid", "patternCircular3d") => (
244            |e, a| Box::pin(crate::std::patterns::pattern_circular_3d(e, a)),
245            StdFnProps::default("std::solid::patternCircular3d").include_in_feature_tree(),
246        ),
247        ("solid", "appearance") => (
248            |e, a| Box::pin(crate::std::appearance::appearance(e, a)),
249            StdFnProps::default("std::solid::appearance").include_in_feature_tree(),
250        ),
251        ("array", "map") => (
252            |e, a| Box::pin(crate::std::array::map(e, a)),
253            StdFnProps::default("std::array::map"),
254        ),
255        ("array", "reduce") => (
256            |e, a| Box::pin(crate::std::array::reduce(e, a)),
257            StdFnProps::default("std::array::reduce"),
258        ),
259        ("array", "push") => (
260            |e, a| Box::pin(crate::std::array::push(e, a)),
261            StdFnProps::default("std::array::push"),
262        ),
263        ("array", "pop") => (
264            |e, a| Box::pin(crate::std::array::pop(e, a)),
265            StdFnProps::default("std::array::pop"),
266        ),
267        ("array", "concat") => (
268            |e, a| Box::pin(crate::std::array::concat(e, a)),
269            StdFnProps::default("std::array::concat"),
270        ),
271        ("prelude", "clone") => (
272            |e, a| Box::pin(crate::std::clone::clone(e, a)),
273            StdFnProps::default("std::clone").include_in_feature_tree(),
274        ),
275        ("sketch", "conic") => (
276            |e, a| Box::pin(crate::std::sketch::conic(e, a)),
277            StdFnProps::default("std::sketch::conic").include_in_feature_tree(),
278        ),
279        ("sketch", "parabolic") => (
280            |e, a| Box::pin(crate::std::sketch::parabolic(e, a)),
281            StdFnProps::default("std::sketch::parabolic").include_in_feature_tree(),
282        ),
283        ("sketch", "parabolicPoint") => (
284            |e, a| Box::pin(crate::std::sketch::parabolic_point(e, a)),
285            StdFnProps::default("std::sketch::parabolicPoint"),
286        ),
287        ("sketch", "hyperbolic") => (
288            |e, a| Box::pin(crate::std::sketch::hyperbolic(e, a)),
289            StdFnProps::default("std::sketch::hyperbolic").include_in_feature_tree(),
290        ),
291        ("sketch", "hyperbolicPoint") => (
292            |e, a| Box::pin(crate::std::sketch::hyperbolic_point(e, a)),
293            StdFnProps::default("std::sketch::hyperbolicPoint"),
294        ),
295        ("sketch", "elliptic") => (
296            |e, a| Box::pin(crate::std::sketch::elliptic(e, a)),
297            StdFnProps::default("std::sketch::elliptic").include_in_feature_tree(),
298        ),
299        ("sketch", "ellipticPoint") => (
300            |e, a| Box::pin(crate::std::sketch::elliptic_point(e, a)),
301            StdFnProps::default("std::sketch::ellipticPoint"),
302        ),
303        ("sketch", "rectangle") => (
304            |e, a| Box::pin(crate::std::shapes::rectangle(e, a)),
305            StdFnProps::default("std::sketch::rectangle"),
306        ),
307        ("sketch", "planeOf") => (
308            |e, a| Box::pin(crate::std::planes::plane_of(e, a)),
309            StdFnProps::default("std::sketch::planeOf"),
310        ),
311        ("sketch", "extrude") => (
312            |e, a| Box::pin(crate::std::extrude::extrude(e, a)),
313            StdFnProps::default("std::sketch::extrude").include_in_feature_tree(),
314        ),
315        ("sketch", "patternTransform2d") => (
316            |e, a| Box::pin(crate::std::patterns::pattern_transform_2d(e, a)),
317            StdFnProps::default("std::sketch::patternTransform2d"),
318        ),
319        ("sketch", "revolve") => (
320            |e, a| Box::pin(crate::std::revolve::revolve(e, a)),
321            StdFnProps::default("std::sketch::revolve").include_in_feature_tree(),
322        ),
323        ("sketch", "sweep") => (
324            |e, a| Box::pin(crate::std::sweep::sweep(e, a)),
325            StdFnProps::default("std::sketch::sweep").include_in_feature_tree(),
326        ),
327        ("sketch", "loft") => (
328            |e, a| Box::pin(crate::std::loft::loft(e, a)),
329            StdFnProps::default("std::sketch::loft").include_in_feature_tree(),
330        ),
331        ("sketch", "polygon") => (
332            |e, a| Box::pin(crate::std::shapes::polygon(e, a)),
333            StdFnProps::default("std::sketch::polygon"),
334        ),
335        ("sketch", "circleThreePoint") => (
336            |e, a| Box::pin(crate::std::shapes::circle_three_point(e, a)),
337            StdFnProps::default("std::sketch::circleThreePoint"),
338        ),
339        ("sketch", "getCommonEdge") => (
340            |e, a| Box::pin(crate::std::edge::get_common_edge(e, a)),
341            StdFnProps::default("std::sketch::getCommonEdge"),
342        ),
343        ("sketch", "getNextAdjacentEdge") => (
344            |e, a| Box::pin(crate::std::edge::get_next_adjacent_edge(e, a)),
345            StdFnProps::default("std::sketch::getNextAdjacentEdge"),
346        ),
347        ("sketch", "getOppositeEdge") => (
348            |e, a| Box::pin(crate::std::edge::get_opposite_edge(e, a)),
349            StdFnProps::default("std::sketch::revolve"),
350        ),
351        ("sketch", "getPreviousAdjacentEdge") => (
352            |e, a| Box::pin(crate::std::edge::get_previous_adjacent_edge(e, a)),
353            StdFnProps::default("std::sketch::getPreviousAdjacentEdge"),
354        ),
355        ("sketch", "patternLinear2d") => (
356            |e, a| Box::pin(crate::std::patterns::pattern_linear_2d(e, a)),
357            StdFnProps::default("std::sketch::patternLinear2d"),
358        ),
359        ("sketch", "patternCircular2d") => (
360            |e, a| Box::pin(crate::std::patterns::pattern_circular_2d(e, a)),
361            StdFnProps::default("std::sketch::patternCircular2d"),
362        ),
363        ("sketch", "segEnd") => (
364            |e, a| Box::pin(crate::std::segment::segment_end(e, a)),
365            StdFnProps::default("std::sketch::segEnd"),
366        ),
367        ("sketch", "segEndX") => (
368            |e, a| Box::pin(crate::std::segment::segment_end_x(e, a)),
369            StdFnProps::default("std::sketch::segEndX"),
370        ),
371        ("sketch", "segEndY") => (
372            |e, a| Box::pin(crate::std::segment::segment_end_y(e, a)),
373            StdFnProps::default("std::sketch::segEndY"),
374        ),
375        ("sketch", "segStart") => (
376            |e, a| Box::pin(crate::std::segment::segment_start(e, a)),
377            StdFnProps::default("std::sketch::segStart"),
378        ),
379        ("sketch", "segStartX") => (
380            |e, a| Box::pin(crate::std::segment::segment_start_x(e, a)),
381            StdFnProps::default("std::sketch::segStartX"),
382        ),
383        ("sketch", "segStartY") => (
384            |e, a| Box::pin(crate::std::segment::segment_start_y(e, a)),
385            StdFnProps::default("std::sketch::segStartY"),
386        ),
387        ("sketch", "lastSegX") => (
388            |e, a| Box::pin(crate::std::segment::last_segment_x(e, a)),
389            StdFnProps::default("std::sketch::lastSegX"),
390        ),
391        ("sketch", "lastSegY") => (
392            |e, a| Box::pin(crate::std::segment::last_segment_y(e, a)),
393            StdFnProps::default("std::sketch::lastSegY"),
394        ),
395        ("sketch", "segLen") => (
396            |e, a| Box::pin(crate::std::segment::segment_length(e, a)),
397            StdFnProps::default("std::sketch::segLen"),
398        ),
399        ("sketch", "segAng") => (
400            |e, a| Box::pin(crate::std::segment::segment_angle(e, a)),
401            StdFnProps::default("std::sketch::segAng"),
402        ),
403        ("sketch", "tangentToEnd") => (
404            |e, a| Box::pin(crate::std::segment::tangent_to_end(e, a)),
405            StdFnProps::default("std::sketch::tangentToEnd"),
406        ),
407        ("sketch", "profileStart") => (
408            |e, a| Box::pin(crate::std::sketch::profile_start(e, a)),
409            StdFnProps::default("std::sketch::profileStart"),
410        ),
411        ("sketch", "profileStartX") => (
412            |e, a| Box::pin(crate::std::sketch::profile_start_x(e, a)),
413            StdFnProps::default("std::sketch::profileStartX"),
414        ),
415        ("sketch", "profileStartY") => (
416            |e, a| Box::pin(crate::std::sketch::profile_start_y(e, a)),
417            StdFnProps::default("std::sketch::profileStartY"),
418        ),
419        ("sketch", "startSketchOn") => (
420            |e, a| Box::pin(crate::std::sketch::start_sketch_on(e, a)),
421            StdFnProps::default("std::sketch::startSketchOn").include_in_feature_tree(),
422        ),
423        ("sketch", "startProfile") => (
424            |e, a| Box::pin(crate::std::sketch::start_profile(e, a)),
425            StdFnProps::default("std::sketch::startProfile"),
426        ),
427        ("sketch", "involuteCircular") => (
428            |e, a| Box::pin(crate::std::sketch::involute_circular(e, a)),
429            StdFnProps::default("std::sketch::involuteCircular"),
430        ),
431        ("sketch", "line") => (
432            |e, a| Box::pin(crate::std::sketch::line(e, a)),
433            StdFnProps::default("std::sketch::line"),
434        ),
435        ("sketch", "xLine") => (
436            |e, a| Box::pin(crate::std::sketch::x_line(e, a)),
437            StdFnProps::default("std::sketch::xLine"),
438        ),
439        ("sketch", "yLine") => (
440            |e, a| Box::pin(crate::std::sketch::y_line(e, a)),
441            StdFnProps::default("std::sketch::yLine"),
442        ),
443        ("sketch", "angledLine") => (
444            |e, a| Box::pin(crate::std::sketch::angled_line(e, a)),
445            StdFnProps::default("std::sketch::angledLine"),
446        ),
447        ("sketch", "angledLineThatIntersects") => (
448            |e, a| Box::pin(crate::std::sketch::angled_line_that_intersects(e, a)),
449            StdFnProps::default("std::sketch::angledLineThatIntersects"),
450        ),
451        ("sketch", "close") => (
452            |e, a| Box::pin(crate::std::sketch::close(e, a)),
453            StdFnProps::default("std::sketch::close"),
454        ),
455        ("sketch", "arc") => (
456            |e, a| Box::pin(crate::std::sketch::arc(e, a)),
457            StdFnProps::default("std::sketch::arc"),
458        ),
459        ("sketch", "tangentialArc") => (
460            |e, a| Box::pin(crate::std::sketch::tangential_arc(e, a)),
461            StdFnProps::default("std::sketch::tangentialArc"),
462        ),
463        ("sketch", "bezierCurve") => (
464            |e, a| Box::pin(crate::std::sketch::bezier_curve(e, a)),
465            StdFnProps::default("std::sketch::bezierCurve"),
466        ),
467        ("sketch", "subtract2d") => (
468            |e, a| Box::pin(crate::std::sketch::subtract_2d(e, a)),
469            StdFnProps::default("std::sketch::subtract2d").include_in_feature_tree(),
470        ),
471        ("appearance", "hexString") => (
472            |e, a| Box::pin(crate::std::appearance::hex_string(e, a)),
473            StdFnProps::default("std::appearance::hexString"),
474        ),
475        ("sketch2", "parallel") => (
476            |e, a| Box::pin(crate::std::constraints::parallel(e, a)),
477            StdFnProps::default("std::sketch2::parallel").include_in_feature_tree(),
478        ),
479        (module, fn_name) => {
480            panic!("No implementation found for {module}::{fn_name}, please add it to this big match statement")
481        }
482    }
483}
484
485pub(crate) fn std_ty(path: &str, fn_name: &str) -> (PrimitiveType, StdFnProps) {
486    match (path, fn_name) {
487        ("types", "Sketch") => (PrimitiveType::Sketch, StdFnProps::default("std::types::Sketch")),
488        ("types", "Solid") => (PrimitiveType::Solid, StdFnProps::default("std::types::Solid")),
489        ("types", "Plane") => (PrimitiveType::Plane, StdFnProps::default("std::types::Plane")),
490        ("types", "Face") => (PrimitiveType::Face, StdFnProps::default("std::types::Face")),
491        ("types", "Helix") => (PrimitiveType::Helix, StdFnProps::default("std::types::Helix")),
492        ("types", "Edge") => (PrimitiveType::Edge, StdFnProps::default("std::types::Edge")),
493        ("types", "Axis2d") => (PrimitiveType::Axis2d, StdFnProps::default("std::types::Axis2d")),
494        ("types", "Axis3d") => (PrimitiveType::Axis3d, StdFnProps::default("std::types::Axis3d")),
495        ("types", "TaggedEdge") => (PrimitiveType::TaggedEdge, StdFnProps::default("std::types::TaggedEdge")),
496        ("types", "TaggedFace") => (PrimitiveType::TaggedFace, StdFnProps::default("std::types::TaggedFace")),
497        _ => unreachable!(),
498    }
499}
500
501/// The default tolerance for modeling commands in millimeters.
502const DEFAULT_TOLERANCE_MM: f64 = 0.0000001;
kcl_lib/std/mod.rs

kcl_lib/std/
mod.rs
