rsspice 0.1.0

Pure Rust port of the SPICE Toolkit for space geometry
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
//
// GENERATED FILE
//

use super::*;
use f2rust_std::*;

const LMSGLN: i32 = (23 * 80);
const SMSGLN: i32 = 25;
const NDELIM: i32 = 5;
const DELIMS: &[u8; NDELIM as usize] = &fstr::extend_const::<{ NDELIM as usize }>(b".:-, ");
const TDB: i32 = 1;
const TDT: i32 = 2;
const MXPART: i32 = 9999;
const MXCOEF: i32 = 100000;
const MXNFLD: i32 = 10;
const DPLEN: i32 = 30;
const IXNFLD: i32 = 1;
const IXDLIM: i32 = (IXNFLD + 1);
const IXTSYS: i32 = (IXDLIM + 1);
const IXNCOF: i32 = (IXTSYS + 1);
const IXNPRT: i32 = (IXNCOF + 1);
const IXBCOF: i32 = (IXNPRT + 1);
const IXBSTR: i32 = (IXBCOF + 1);
const IXBEND: i32 = (IXBSTR + 1);
const IXBMOD: i32 = (IXBEND + 1);
const IXBOFF: i32 = (IXBMOD + 1);
const NIVALS: i32 = IXBOFF;
const MXNCLK: i32 = 100;
const DBUFSZ: i32 = (((3 * MXCOEF) + (2 * MXPART)) + (2 * MXNFLD));
const IBUFSZ: i32 = (NIVALS * MXNCLK);
const LBSNGL: i32 = -5;
const CPLSIZ: i32 = ((MXNCLK - LBSNGL) + 1);
const NAMLEN: i32 = 60;
const COFIDX: i32 = 1;
const PRSIDX: i32 = (COFIDX + 1);
const PREIDX: i32 = (PRSIDX + 1);
const OFFIDX: i32 = (PREIDX + 1);
const MODIDX: i32 = (OFFIDX + 1);
const NFLIDX: i32 = (MODIDX + 1);
const DELIDX: i32 = (NFLIDX + 1);
const SYSIDX: i32 = (DELIDX + 1);
const NKITEM: i32 = SYSIDX;
const NDP: i32 = MODIDX;
const MXCFSZ: i32 = (3 * MXCOEF);

struct SaveVars {
    NAMLST: ActualCharArray,
    IBIX: StackArray<i32, 8>,
    KVMAXN: StackArray<i32, 8>,
}

impl SaveInit for SaveVars {
    fn new() -> Self {
        let mut NAMLST = ActualCharArray::new(NAMLEN, 1..=NKITEM);
        let mut IBIX = StackArray::<i32, 8>::new(1..=NKITEM);
        let mut KVMAXN = StackArray::<i32, 8>::new(1..=NKITEM);

        {
            use f2rust_std::data::Val;

            let mut clist = [
                Val::C(b"SCLK01_COEFFICIENTS"),
                Val::I(MXCFSZ),
                Val::I(IXBCOF),
                Val::C(b"SCLK_PARTITION_START"),
                Val::I(MXPART),
                Val::I(IXBSTR),
                Val::C(b"SCLK_PARTITION_END"),
                Val::I(MXPART),
                Val::I(IXBEND),
                Val::C(b"SCLK01_OFFSETS"),
                Val::I(MXNFLD),
                Val::I(IXBOFF),
                Val::C(b"SCLK01_MODULI"),
                Val::I(MXNFLD),
                Val::I(IXBMOD),
                Val::C(b"SCLK01_N_FIELDS"),
                Val::I(1),
                Val::I(0),
                Val::C(b"SCLK01_OUTPUT_DELIM"),
                Val::I(1),
                Val::I(0),
                Val::C(b"SCLK01_TIME_SYSTEM"),
                Val::I(1),
                Val::I(0),
            ]
            .into_iter();
            for I in intrinsics::range(1, NKITEM, 1) {
                fstr::assign(NAMLST.get_mut(I), clist.next().unwrap().into_str());
                KVMAXN[I] = clist.next().unwrap().into_i32();
                IBIX[I] = clist.next().unwrap().into_i32();
            }

            debug_assert!(clist.next().is_none(), "DATA not fully initialised");
        }

        Self {
            NAMLST,
            IBIX,
            KVMAXN,
        }
    }
}

//$Procedure ZZSCAD01 ( SPICE private, add clock to database, type 01 )
pub fn ZZSCAD01(
    SC: i32,
    HDSCLK: &mut [i32],
    SCPOOL: &mut [i32],
    CLKLST: &mut [i32],
    DPFREE: &mut i32,
    DPBUFF: &mut [f64],
    IFREE: &mut i32,
    INTBUF: &mut [i32],
    SCBASE: &mut [i32],
    SCLKAT: &mut i32,
    ctx: &mut Context,
) -> f2rust_std::Result<()> {
    let save = ctx.get_vars::<SaveVars>();
    let save = &mut *save.borrow_mut();

    let mut HDSCLK = DummyArrayMut::new(HDSCLK, 1..);
    let mut SCPOOL = DummyArrayMut::new(SCPOOL, LBSNGL..);
    let mut CLKLST = DummyArrayMut::new(CLKLST, 1..);
    let mut DPBUFF = DummyArrayMut::new(DPBUFF, 1..);
    let mut INTBUF = DummyArrayMut::new(INTBUF, 1..);
    let mut SCBASE = DummyArrayMut::new(SCBASE, 1..);
    let mut KVTYPE = ActualCharArray::new(1, 1..=NKITEM);
    let mut KVNAME = ActualCharArray::new(NAMLEN, 1..=NKITEM);
    let mut SHRTMS = [b' '; SMSGLN as usize];
    let mut DPBASE: i32 = 0;
    let mut DPROOM: i32 = 0;
    let mut I: i32 = 0;
    let mut IBASE: i32 = 0;
    let mut IROOM: i32 = 0;
    let mut KVSIZE = StackArray::<i32, 8>::new(1..=NKITEM);
    let mut N: i32 = 0;
    let mut NCOEFF: i32 = 0;
    let mut NDPVAL: i32 = 0;
    let mut NMOD: i32 = 0;
    let mut NOFF: i32 = 0;
    let mut NPART: i32 = 0;
    let mut NPARTB: i32 = 0;
    let mut NPARTE: i32 = 0;
    let mut NSCAVL: i32 = 0;
    let mut NSYS: i32 = 0;
    let mut PRVSC: i32 = 0;
    let mut FOUND: bool = false;
    let mut NEW: bool = false;

    //
    // SPICELIB functions
    //

    //
    // Local parameters
    //

    //
    // Following are parameters for the indices within the
    // array NAMLST of the kernel variable names used by the
    // SC01 entry points.
    //
    // NOTE: indices for the d.p. variables must be listed first.
    //

    //
    // Maximum number of elements in coefficient array:
    //

    //
    // Local variables
    //

    //
    // Saved values
    //

    //
    // Initial values
    //

    if RETURN(ctx) {
        return Ok(());
    }

    CHKIN(b"ZZSCAD01", ctx)?;

    //
    // Make up a list of names of kernel variables that we'll use.
    // The first name in the list is SCLK_KERNEL_ID, which does not
    // require the addition of a spacecraft code suffix.  For the
    // rest of the names, we'll have to add the suffix.
    //
    MOVEC(save.NAMLST.as_arg(), NKITEM, KVNAME.as_arg_mut());

    {
        let m1__: i32 = 1;
        let m2__: i32 = NKITEM;
        let m3__: i32 = 1;
        I = m1__;
        for _ in 0..((m2__ - m1__ + m3__) / m3__) as i32 {
            SUFFIX(b"_#", 0, &mut KVNAME[I]);
            REPMI(&KVNAME[I].to_vec(), b"#", -SC, &mut KVNAME[I], ctx);
            I += m3__;
        }
    }

    //
    // Check available room in the clock hash and in the numeric data
    // buffers. If there's no room, re-initialize the entire data
    // structure.
    //
    ZZHSIAVL(SCPOOL.as_slice(), &mut NSCAVL);

    if (NSCAVL == 0) {
        ZZSCIN01(
            HDSCLK.as_slice_mut(),
            SCPOOL.as_slice_mut(),
            CLKLST.as_slice_mut(),
            DPFREE,
            IFREE,
            &mut PRVSC,
            ctx,
        )?;
    }

    //
    // Add this clock to the hash.
    //
    ZZHSIADD(
        HDSCLK.as_slice_mut(),
        SCPOOL.as_slice_mut(),
        CLKLST.as_slice_mut(),
        SC,
        SCLKAT,
        &mut NEW,
        ctx,
    )?;

    if FAILED(ctx) {
        //
        // This code should be unreachable but is provided for safety.
        //
        ZZSCIN01(
            HDSCLK.as_slice_mut(),
            SCPOOL.as_slice_mut(),
            CLKLST.as_slice_mut(),
            DPFREE,
            IFREE,
            &mut PRVSC,
            ctx,
        )?;
        CHKOUT(b"ZZSCAD01", ctx)?;
        return Ok(());
    }

    //
    // Check room in the integer buffer.
    //
    IROOM = ((IBUFSZ + 1) - *IFREE);

    if ((IROOM < NIVALS) || (IROOM > IBUFSZ)) {
        //
        // This code should be unreachable but is provided for safety.
        //
        I = *IFREE;

        ZZSCIN01(
            HDSCLK.as_slice_mut(),
            SCPOOL.as_slice_mut(),
            CLKLST.as_slice_mut(),
            DPFREE,
            IFREE,
            &mut PRVSC,
            ctx,
        )?;

        SETMSG(
            b"IROOM was #; must be in range #:#. IFREE was #; must be in range 1:#.",
            ctx,
        );
        ERRINT(b"#", IROOM, ctx);
        ERRINT(b"#", NIVALS, ctx);
        ERRINT(b"#", IBUFSZ, ctx);
        ERRINT(b"#", I, ctx);
        ERRINT(b"#", (IBUFSZ + 1), ctx);
        SIGERR(b"SPICE(BUG)", ctx)?;
        CHKOUT(b"ZZSCAD01", ctx)?;
        return Ok(());
    }

    //
    // Compute available room for double precision data.
    //
    DPROOM = ((DBUFSZ + 1) - *DPFREE);

    if ((DPROOM < 0) || (DPROOM > DBUFSZ)) {
        //
        // This code should be unreachable but is provided for safety.
        //
        I = *DPFREE;

        ZZSCIN01(
            HDSCLK.as_slice_mut(),
            SCPOOL.as_slice_mut(),
            CLKLST.as_slice_mut(),
            DPFREE,
            IFREE,
            &mut PRVSC,
            ctx,
        )?;

        SETMSG(
            b"DPROOM was #; must be in range 0:#. DPFREE was #; must be in range 1:#.",
            ctx,
        );
        ERRINT(b"#", DPROOM, ctx);
        ERRINT(b"#", DBUFSZ, ctx);
        ERRINT(b"#", I, ctx);
        ERRINT(b"#", (DBUFSZ + 1), ctx);
        SIGERR(b"SPICE(BUG)", ctx)?;
        CHKOUT(b"ZZSCAD01", ctx)?;
        return Ok(());
    }

    //
    // Set the base address for the next item to be added to the
    // integer buffer. The index of the first element of the item
    // is the successor of IBASE.
    //
    IBASE = (*IFREE - 1);
    SCBASE[*SCLKAT] = IBASE;

    //
    // Fetch from the kernel pool the integer items we need:
    //
    //    -  The number of fields in an (unabridged) SCLK string
    //    -  The output delimiter code
    //    -  The parallel time system code (optional; defaults to TDB)
    //
    SCLI01(
        &save.NAMLST[NFLIDX],
        SC,
        1,
        &mut N,
        INTBUF.subarray_mut((IBASE + IXNFLD)),
        ctx,
    )?;
    SCLI01(
        &save.NAMLST[DELIDX],
        SC,
        1,
        &mut N,
        INTBUF.subarray_mut((IBASE + IXDLIM)),
        ctx,
    )?;
    SCLI01(
        &save.NAMLST[SYSIDX],
        SC,
        1,
        &mut NSYS,
        INTBUF.subarray_mut((IBASE + IXTSYS)),
        ctx,
    )?;

    if FAILED(ctx) {
        ZZSCIN01(
            HDSCLK.as_slice_mut(),
            SCPOOL.as_slice_mut(),
            CLKLST.as_slice_mut(),
            DPFREE,
            IFREE,
            &mut PRVSC,
            ctx,
        )?;
        CHKOUT(b"ZZSCAD01", ctx)?;
        return Ok(());
    }

    //
    // The time system code need not be provided in the kernel pool.
    // Set it to the default value if it's not present.
    //
    if (NSYS == 0) {
        INTBUF[(IBASE + IXTSYS)] = TDB;
    }

    //
    // Check for presence in the kernel pool of all required d.p. kernel
    // variables.
    //
    // Get and check the sizes of the d.p. arrays: coefficients,
    // partitions, moduli, and offsets.
    //
    // We obtain sizes of d.p. kernel variables rather than using sizes
    // returned by SCLD01 because we'll read data directly into our
    // passed-in buffers. We need to know in advance how much room is
    // needed.
    //
    {
        let m1__: i32 = 1;
        let m2__: i32 = NDP;
        let m3__: i32 = 1;
        I = m1__;
        for _ in 0..((m2__ - m1__ + m3__) / m3__) as i32 {
            DTPOOL(&KVNAME[I], &mut FOUND, &mut KVSIZE[I], &mut KVTYPE[I], ctx)?;

            if FAILED(ctx) {
                //
                // This code should be unreachable but is provided for
                // safety. Initialize local data structures. ZZSCIN01 sets
                // PRVSC to 0.
                //
                ZZSCIN01(
                    HDSCLK.as_slice_mut(),
                    SCPOOL.as_slice_mut(),
                    CLKLST.as_slice_mut(),
                    DPFREE,
                    IFREE,
                    &mut PRVSC,
                    ctx,
                )?;

                CHKOUT(b"ZZSCAD01", ctx)?;
                return Ok(());
            }

            //
            // Check that each required d.p. kernel variable was found.
            //
            if !FOUND {
                ZZSCIN01(
                    HDSCLK.as_slice_mut(),
                    SCPOOL.as_slice_mut(),
                    CLKLST.as_slice_mut(),
                    DPFREE,
                    IFREE,
                    &mut PRVSC,
                    ctx,
                )?;

                SETMSG(b"Kernel variable # for spacecraft clock # was not found. An SCLK kernel for this clock may not have been loaded.", ctx);
                ERRCH(b"#", &KVNAME[I], ctx);
                ERRINT(b"#", SC, ctx);
                SIGERR(b"SPICE(KERNELVARNOTFOUND)", ctx)?;
                CHKOUT(b"ZZSCAD01", ctx)?;
                return Ok(());
            }

            //
            // Check the number of values associated with the kernel
            // variable.
            //
            if (KVSIZE[I] > save.KVMAXN[I]) {
                ZZSCIN01(
                    HDSCLK.as_slice_mut(),
                    SCPOOL.as_slice_mut(),
                    CLKLST.as_slice_mut(),
                    DPFREE,
                    IFREE,
                    &mut PRVSC,
                    ctx,
                )?;

                SETMSG(b"The number of values associated with the kernel variable # for clock # is #, which exceeds the limit #.", ctx);
                ERRCH(b"#", &KVNAME[I], ctx);
                ERRINT(b"#", SC, ctx);
                ERRINT(b"#", KVSIZE[I], ctx);
                ERRINT(b"#", save.KVMAXN[I], ctx);
                //
                // Customize the short error message a bit.
                //
                if (I == COFIDX) {
                    fstr::assign(&mut SHRTMS, b"SPICE(TOOMANYCOEFFS)");
                } else if ((I == PRSIDX) || (I == PREIDX)) {
                    fstr::assign(&mut SHRTMS, b"SPICE(TOOMANYPARTITIONS)");
                } else {
                    fstr::assign(&mut SHRTMS, b"SPICE(KERNELVARTOOLARGE)");
                }

                SIGERR(&SHRTMS, ctx)?;
                CHKOUT(b"ZZSCAD01", ctx)?;
                return Ok(());
            }

            I += m3__;
        }
    }

    //
    // Store kernel variable sizes as scalars for convenience.
    //
    NCOEFF = KVSIZE[COFIDX];
    NPARTB = KVSIZE[PRSIDX];
    NPARTE = KVSIZE[PREIDX];
    NMOD = KVSIZE[MODIDX];
    NOFF = KVSIZE[OFFIDX];

    //
    // NDPVAL is the number of d.p. values that must be buffered to
    // support this clock.
    //
    NDPVAL = ((((NCOEFF + NPARTB) + NPARTE) + NMOD) + NOFF);

    //
    // Check whether sizes of partition start and end kernel variables
    // match.
    //
    if (NPARTB != NPARTE) {
        ZZSCIN01(
            HDSCLK.as_slice_mut(),
            SCPOOL.as_slice_mut(),
            CLKLST.as_slice_mut(),
            DPFREE,
            IFREE,
            &mut PRVSC,
            ctx,
        )?;

        SETMSG(b"The numbers of partition start times # and stop times # are unequal for spacecraft clock #.", ctx);
        ERRINT(b"#", NPARTB, ctx);
        ERRINT(b"#", NPARTE, ctx);
        ERRINT(b"#", SC, ctx);
        SIGERR(b"SPICE(NUMPARTSUNEQUAL)", ctx)?;
        CHKOUT(b"ZZSCAD01", ctx)?;
        return Ok(());
    } else {
        NPART = NPARTB;
    }

    if (NDPVAL > DBUFSZ) {
        //
        // We couldn't make enough room even if we dumped all buffered
        // data.
        //
        // This code should be unreachable but is provided for safety.
        // We've already checked the existence, types, and sizes of the
        // d.p. kernel variables.
        //
        ZZSCIN01(
            HDSCLK.as_slice_mut(),
            SCPOOL.as_slice_mut(),
            CLKLST.as_slice_mut(),
            DPFREE,
            IFREE,
            &mut PRVSC,
            ctx,
        )?;

        SETMSG(b"Total number of double precision data values for SCLK # is #; this count exceeds the maximum supported count #.", ctx);
        ERRINT(b"#", SC, ctx);
        ERRINT(b"#", NDPVAL, ctx);
        ERRINT(b"#", DBUFSZ, ctx);
        SIGERR(b"SPICE(BUG)", ctx)?;
        CHKOUT(b"ZZSCAD01", ctx)?;
        return Ok(());
    } else if (NDPVAL > DPROOM) {
        //
        // We don't have room for this clock, but we will if we dump
        // the existing buffered data.
        //
        ZZSCIN01(
            HDSCLK.as_slice_mut(),
            SCPOOL.as_slice_mut(),
            CLKLST.as_slice_mut(),
            DPFREE,
            IFREE,
            &mut PRVSC,
            ctx,
        )?;
    }

    //
    // Store in the integer buffer the sizes of the coefficient array
    // and the number of partitions.
    //
    INTBUF[(IBASE + IXNCOF)] = NCOEFF;
    INTBUF[(IBASE + IXNPRT)] = NPART;

    //
    // Fetch from the kernel pool the d.p. items we need:
    //
    //    -  The SCLK coefficients array
    //    -  The partition start times
    //    -  The partition end times
    //    -  The moduli of the fields of an SCLK string
    //    -  The offsets for each clock field.
    //
    // Set the base index in the d.p. buffer of the next d.p. item
    // to store. The first element of the item has index DPBASE+1.
    //
    // We don't update DPFREE until all d.p. data have been fetched
    // successfully.
    //
    DPBASE = (*DPFREE - 1);

    {
        let m1__: i32 = 1;
        let m2__: i32 = NDP;
        let m3__: i32 = 1;
        I = m1__;
        for _ in 0..((m2__ - m1__ + m3__) / m3__) as i32 {
            //
            // Store in the integer buffer the base index in the d.p.
            // buffer of the kernel variable's values.
            //
            INTBUF[(IBASE + save.IBIX[I])] = DPBASE;
            //
            // Fetch d.p. values into buffer.
            //
            SCLD01(
                &save.NAMLST[I],
                SC,
                save.KVMAXN[I],
                &mut N,
                DPBUFF.subarray_mut((DPBASE + 1)),
                ctx,
            )?;

            if FAILED(ctx) {
                //
                // This code could be reached if the kernel variable has
                // character type.
                //
                ZZSCIN01(
                    HDSCLK.as_slice_mut(),
                    SCPOOL.as_slice_mut(),
                    CLKLST.as_slice_mut(),
                    DPFREE,
                    IFREE,
                    &mut PRVSC,
                    ctx,
                )?;

                CHKOUT(b"ZZSCAD01", ctx)?;
                return Ok(());
            }
            //
            // Update the d.p. buffer base index.
            //
            DPBASE = (DPBASE + N);

            I += m3__;
        }
    }

    //
    // Account for buffer usage for the new clock.
    //
    *DPFREE = (*DPFREE + NDPVAL);
    *IFREE = (*IFREE + NIVALS);

    CHKOUT(b"ZZSCAD01", ctx)?;
    Ok(())
}