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

kcl_lib/std/
mod.rs
