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
//
// GENERATED FILE
//

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

const BCMARK: &[u8] = b"~NAIF/SPC BEGIN COMMENTS~";
const ECMARK: &[u8] = b"~NAIF/SPC END COMMENTS~";
const LINLEN: i32 = 255;
const ARCHLN: i32 = 3;
const TYPELN: i32 = 4;
const RESREC: i32 = 0;

//$ Procedure CONVTB ( Convert kernel file from text to binary )
pub fn CONVTB(TXTFIL: &[u8], BINFIL: &[u8], ctx: &mut Context) -> f2rust_std::Result<()> {
    let mut ARCH = [b' '; ARCHLN as usize];
    let mut LINE = [b' '; LINLEN as usize];
    let mut TYPE = [b' '; TYPELN as usize];
    let mut HANDLE: i32 = 0;
    let mut IOSTAT: i32 = 0;
    let mut SCRLUN: i32 = 0;
    let mut TXTLUN: i32 = 0;
    let mut HAVCOM: bool = false;
    let mut EOC: bool = false;

    //
    // SPICELIB functions
    //

    //
    // Local parameters
    //
    // Begin and end markers in the file for the comment area.
    //

    //
    // Maximum length of an input text line.
    //
    //
    // Maximum length of a file architecture.
    //
    //
    // Maximum length of a file type.
    //
    //
    // Number of reserved records to use when creating a binar DAF file.
    //
    //
    // Local variables
    //

    //
    // Standard SPICE error handling.
    //
    if spicelib::RETURN(ctx) {
        return Ok(());
    } else {
        spicelib::CHKIN(b"CONVTB", ctx)?;
    }
    //
    // Get the architecture and type of the file to be converted.
    //
    spicelib::GETFAT(TXTFIL, &mut ARCH, &mut TYPE, ctx)?;

    if spicelib::FAILED(ctx) {
        spicelib::CHKOUT(b"CONVTB", ctx)?;
        return Ok(());
    }
    //
    // Verify the architecture and type of the file, and perform any
    // processing necessary..
    //
    if (fstr::eq(&ARCH, b"XFR") || fstr::eq(&ARCH, b"DEC")) {
        //
        // Open the text file that is to be converted to binary.
        //
        spicelib::TXTOPR(TXTFIL, &mut TXTLUN, ctx)?;

        if spicelib::FAILED(ctx) {
            spicelib::CHKOUT(b"CONVTB", ctx)?;
            return Ok(());
        }
        //
        // Read the information line to skip it. We already know the
        // architecture and type of the file.
        //
        {
            use f2rust_std::{
                data::Val,
                io::{self, Reader},
            };

            let mut reader = io::FormattedReader::new(ctx.io_unit(TXTLUN)?, None, b"(A)")?;
            IOSTAT = io::capture_iostat(|| {
                reader.start()?;
                reader.read_str(&mut LINE)?;
                reader.finish()?;
                Ok(())
            })?;
        }

        if (IOSTAT != 0) {
            //
            // If there was an error then we need to close the text
            // file, and then check out and return to the caller.
            //
            {
                use f2rust_std::io;

                let specs = io::CloseSpecs {
                    unit: Some(TXTLUN),
                    ..Default::default()
                };
                ctx.close(specs)?;
            }
            spicelib::SETMSG(b"Error reading the text file: #. IOSTAT =  #.", ctx);
            spicelib::ERRCH(b"#", TXTFIL, ctx);
            spicelib::ERRINT(b"#", IOSTAT, ctx);
            spicelib::SIGERR(b"SPICE(FILEREADFAILED)", ctx)?;
            spicelib::CHKOUT(b"CONVTB", ctx)?;
            return Ok(());
        }
    }
    //
    // Process the file based on the derived architecture and type.
    //
    if (fstr::eq(&ARCH, b"XFR") && fstr::eq(&TYPE, b"DAF")) {
        //
        // We got a DAF file.
        //
        // Convert the data portion of the text file to binary. At this
        // point, we know that we have a current DAF text file format.
        //
        // We expect to have comments.
        //
        HAVCOM = true;
        //
        // Convert it.
        //
        spicelib::DAFTB(TXTLUN, BINFIL, ctx)?;

        if spicelib::FAILED(ctx) {
            //
            // If there was an error then we need to close the
            // text file, and then check out and return to the
            // caller.
            //
            {
                use f2rust_std::io;

                let specs = io::CloseSpecs {
                    unit: Some(TXTLUN),
                    ..Default::default()
                };
                ctx.close(specs)?;
            }
            spicelib::CHKOUT(b"CONVTB", ctx)?;
            return Ok(());
        }
    } else if (fstr::eq(&ARCH, b"XFR") && fstr::eq(&TYPE, b"DAS")) {
        //
        // We got a DAS file. So we should begin converting it to binary.
        // DAS files are easier: all we do is call one routine.
        //
        // We do not have comments. Actually, we might but they are
        // included as part of the DAS file conversion process.
        //
        HAVCOM = false;
        //
        // Convert it.
        //
        spicelib::DASTB(TXTLUN, BINFIL, ctx)?;

        if spicelib::FAILED(ctx) {
            //
            // If there was an error then we need to close the
            // text file, and then check out and return to the
            // caller.
            //
            {
                use f2rust_std::io;

                let specs = io::CloseSpecs {
                    unit: Some(TXTLUN),
                    ..Default::default()
                };
                ctx.close(specs)?;
            }
            spicelib::CHKOUT(b"CONVTB", ctx)?;
            return Ok(());
        }
    } else if fstr::eq(&ARCH, b"DAS") {
        //
        // This is an error case, most likely caused by reading a binary
        // DAS file by accident. So signal an appropriate error.
        //
        spicelib::SETMSG(
            b"The file \'#\' appears to be a binary DAS file and not a transfer file.",
            ctx,
        );
        spicelib::ERRCH(b"#", TXTFIL, ctx);
        spicelib::SIGERR(b"SPICE(NOTATRANSFERFILE)", ctx)?;
        spicelib::CHKOUT(b"CONVTB", ctx)?;
        return Ok(());
    } else if (fstr::eq(&ARCH, b"DAS") && fstr::eq(&TYPE, b"PRE")) {
        //
        // This is an error case, most likely caused by reading a binary
        // DAS file by accident. So signal an appropriate error.
        //
        {
            use f2rust_std::io;

            let specs = io::CloseSpecs {
                unit: Some(TXTLUN),
                ..Default::default()
            };
            ctx.close(specs)?;
        }
        spicelib::SETMSG(
            b"The file \'#\' appears to be a pre-release binary DAS file and not a transfer file.",
            ctx,
        );
        spicelib::ERRCH(b"#", TXTFIL, ctx);
        spicelib::SIGERR(b"SPICE(NOTATRANSFERFILE)", ctx)?;
        spicelib::CHKOUT(b"CONVTB", ctx)?;
        return Ok(());
    } else if fstr::eq(&ARCH, b"DAF") {
        //
        // This is an error case, most likely caused by reading a binary
        // DAF file by accident. So signal an appropriate error.
        //
        spicelib::SETMSG(
            b"The file \'#\' appears to be a binary DAF file and not a transfer file.",
            ctx,
        );
        spicelib::ERRCH(b"#", TXTFIL, ctx);
        spicelib::SIGERR(b"SPICE(NOTATRANSFERFILE)", ctx)?;
        spicelib::CHKOUT(b"CONVTB", ctx)?;
        return Ok(());
    } else if (fstr::eq(&ARCH, b"DEC") && fstr::eq(&TYPE, b"DAF")) {
        //
        // This is the case for the old text file format. It has no
        // identifying marks whatsoever, so we simply have to try and
        // convert it.
        //
        // We expect to have comments.
        //
        HAVCOM = true;
        //
        // Back up one record so that we are positioned in the file where
        // we were when this routine was entered.
        //
        {
            use f2rust_std::io;

            let specs = io::PosSpecs {
                unit: Some(TXTLUN),
                ..Default::default()
            };
            ctx.backspace(specs)?;
        }
        //
        // Convert it.
        //
        spicelib::DAFT2B(TXTLUN, BINFIL, RESREC, ctx)?;

        if spicelib::FAILED(ctx) {
            //
            // If there was an error then we need to close the text
            // file, and then check out and return to the caller.
            //
            {
                use f2rust_std::io;

                let specs = io::CloseSpecs {
                    unit: Some(TXTLUN),
                    ..Default::default()
                };
                ctx.close(specs)?;
            }
            spicelib::CHKOUT(b"CONVTB", ctx)?;
            return Ok(());
        }
    } else {
        //
        // This is the catch all error case. At this point, we didn't
        // match any of the files whose architecture and types are
        // recognized. So, we toss our hands in the air and signal an
        // error.
        //
        spicelib::SETMSG(
            b"The architecture and type of the file \'#\'could not be determined.",
            ctx,
        );
        spicelib::ERRCH(b"#", TXTFIL, ctx);
        spicelib::SIGERR(b"SPICE(UNRECOGNIZABLEFILE)", ctx)?;
        spicelib::CHKOUT(b"CONVTB", ctx)?;
        return Ok(());
    }
    //
    // If we have comments to process, then process them.
    //
    if HAVCOM {
        //
        // There are three situations that we need to consider here:
        //
        //    1) We have a SPICE text file with comments. This implies
        //       that we have a bunch of comments to be put into the
        //       comment area that are surrounded by the begin comments
        //       marker, BCMARK, and the end comemnts marker, ECMARK.
        //
        //    2) We are at the end of the file. This means that we have
        //       an old SPICE kernel file, from the good old days before
        //       the comment area was implemented, or we ahve a plain old
        //       ordinary DAF file.
        //
        //    3) We are not at the end of the file, but there are no
        //       comments. This means that a text DAF file may be embedded
        //       in a larger text file or something. PDS does things like
        //       this: SFDUs and such.
        //
        // So, we need to look out for and deal with each of these
        // possibilities.
        //
        {
            use f2rust_std::{
                data::Val,
                io::{self, Reader},
            };

            let mut reader = io::FormattedReader::new(ctx.io_unit(TXTLUN)?, None, b"(A)")?;
            IOSTAT = io::capture_iostat(|| {
                reader.start()?;
                reader.read_str(&mut LINE)?;
                reader.finish()?;
                Ok(())
            })?;
        }

        if (IOSTAT > 0) {
            //
            // If there was an error then we need to close the text
            // file, and then check out and return to the caller.
            //
            {
                use f2rust_std::io;

                let specs = io::CloseSpecs {
                    unit: Some(TXTLUN),
                    ..Default::default()
                };
                ctx.close(specs)?;
            }
            spicelib::SETMSG(b"Error reading the text file: #. IOSTAT = #.", ctx);
            spicelib::ERRCH(b"#", TXTFIL, ctx);
            spicelib::ERRINT(b"#", IOSTAT, ctx);
            spicelib::SIGERR(b"SPICE(FILEREADFAILED)", ctx)?;
            spicelib::CHKOUT(b"CONVTB", ctx)?;
            return Ok(());
        }
        //
        // If we encountered the end of the file, just check out and
        // return. This is not an error.
        //
        if (IOSTAT < 0) {
            spicelib::CHKOUT(b"CONVTB", ctx)?;
            return Ok(());
        }
        //
        // We got a line, so left justify it and see if it matches the
        // begin comments marker. If not, then use the Fortran BACKSPACE
        // command to reposition the file pointer to be ready to read the
        // line we just read.
        //
        if fstr::ne(fstr::substr(&LINE, spicelib::LTRIM(&LINE)..), BCMARK) {
            {
                use f2rust_std::io;

                let specs = io::PosSpecs {
                    unit: Some(TXTLUN),
                    ..Default::default()
                };
                ctx.backspace(specs)?;
            }
            spicelib::CHKOUT(b"CONVTB", ctx)?;
            return Ok(());
        }
        //
        // We're not at the end of the file, and the line we read
        // is BCMARK, so we write the comments to a scratch file.
        // We do this because we have to use SPCAC to add the comments
        // to the comment area of the binary file, and SPCAC rewinds
        // the file. It's okay for SPCAC to rewind a scratch file, because
        // it will probably not be very big, but it's not okay to rewind
        // the file connected to TXTLUN -- we don't know the initial
        // location of the file pointer or how big the file is.
        //
        spicelib::GETLUN(&mut SCRLUN, ctx)?;
        {
            use f2rust_std::io;

            let specs = io::OpenSpecs {
                unit: Some(SCRLUN),
                form: Some(b"FORMATTED"),
                access: Some(b"SEQUENTIAL"),
                status: Some(b"SCRATCH"),
                ..Default::default()
            };
            IOSTAT = io::capture_iostat(|| ctx.open(specs))?;
        }

        if (IOSTAT != 0) {
            //
            // If there was an error then we need to close the text
            // file, and then check out and return to the caller.
            //
            {
                use f2rust_std::io;

                let specs = io::CloseSpecs {
                    unit: Some(SCRLUN),
                    ..Default::default()
                };
                ctx.close(specs)?;
            }
            {
                use f2rust_std::io;

                let specs = io::CloseSpecs {
                    unit: Some(TXTLUN),
                    ..Default::default()
                };
                ctx.close(specs)?;
            }
            spicelib::SETMSG(b"Error opening temporary file. IOSTAT = #.", ctx);
            spicelib::ERRINT(b"#", IOSTAT, ctx);
            spicelib::SIGERR(b"SPICE(FILEOPENERROR)", ctx)?;
            spicelib::CHKOUT(b"CONVTB", ctx)?;
            return Ok(());
        }
        //
        // Continue reading lines from the text file and storing them
        // in the scratch file until we get to the end marker. We do not
        // write the begin and end markers to the scratch file. We do not
        // need them.
        //
        EOC = false;

        while !EOC {
            {
                use f2rust_std::{
                    data::Val,
                    io::{self, Reader},
                };

                let mut reader = io::FormattedReader::new(ctx.io_unit(TXTLUN)?, None, b"(A)")?;
                IOSTAT = io::capture_iostat(|| {
                    reader.start()?;
                    reader.read_str(&mut LINE)?;
                    reader.finish()?;
                    Ok(())
                })?;
            }

            if (IOSTAT != 0) {
                //
                // If there was an error then we need to close the
                // scratch file, the text file, and then check out
                // and return to the caller.
                //
                {
                    use f2rust_std::io;

                    let specs = io::CloseSpecs {
                        unit: Some(SCRLUN),
                        ..Default::default()
                    };
                    ctx.close(specs)?;
                }
                {
                    use f2rust_std::io;

                    let specs = io::CloseSpecs {
                        unit: Some(TXTLUN),
                        ..Default::default()
                    };
                    ctx.close(specs)?;
                }
                spicelib::SETMSG(b"Error reading the text file: #. IOSTAT = #.", ctx);
                spicelib::ERRCH(b"#", TXTFIL, ctx);
                spicelib::ERRINT(b"#", IOSTAT, ctx);
                spicelib::SIGERR(b"SPICE(FILEREADFAILED)", ctx)?;
                spicelib::CHKOUT(b"CONVTB", ctx)?;
                return Ok(());
            }
            //
            // If we are not at the end of the comments, then write the
            // line ot the scratch file. Otherwise set the end of comments
            // flag to .TRUE..
            //
            if fstr::ne(fstr::substr(&LINE, spicelib::LTRIM(&LINE)..), ECMARK) {
                {
                    use f2rust_std::{
                        data::Val,
                        io::{self, Writer},
                    };

                    let mut writer = io::FormattedWriter::new(ctx.io_unit(SCRLUN)?, None, b"(A)")?;
                    IOSTAT = io::capture_iostat(|| {
                        writer.start()?;
                        writer.write_str(fstr::substr(&LINE, 1..=spicelib::RTRIM(&LINE)))?;
                        writer.finish()?;
                        Ok(())
                    })?;
                }

                if (IOSTAT != 0) {
                    //
                    // If there was an error then we need to close the
                    // scratch file, the text file, and then check out
                    // and return to the caller.
                    //
                    {
                        use f2rust_std::io;

                        let specs = io::CloseSpecs {
                            unit: Some(SCRLUN),
                            ..Default::default()
                        };
                        ctx.close(specs)?;
                    }
                    {
                        use f2rust_std::io;

                        let specs = io::CloseSpecs {
                            unit: Some(TXTLUN),
                            ..Default::default()
                        };
                        ctx.close(specs)?;
                    }
                    spicelib::SETMSG(b"Error writing to temporary file. IOSTAT = #.", ctx);
                    spicelib::ERRINT(b"#", IOSTAT, ctx);
                    spicelib::SIGERR(b"SPICE(FILEWRITEFAILED)", ctx)?;
                    spicelib::CHKOUT(b"CONVTB", ctx)?;
                    return Ok(());
                }
            } else {
                EOC = true;
            }
        }
        //
        // Open the new binary file and add the comments that have been
        // stored temporarily in a scratch file.
        //
        spicelib::DAFOPW(BINFIL, &mut HANDLE, ctx)?;

        if spicelib::FAILED(ctx) {
            //
            // If there was an error then we need to close the scratch
            // file and the text file, and then check out and return to
            // the caller.
            //
            {
                use f2rust_std::io;

                let specs = io::CloseSpecs {
                    unit: Some(SCRLUN),
                    ..Default::default()
                };
                ctx.close(specs)?;
            }
            {
                use f2rust_std::io;

                let specs = io::CloseSpecs {
                    unit: Some(TXTLUN),
                    ..Default::default()
                };
                ctx.close(specs)?;
            }
            spicelib::CHKOUT(b"CONVTB", ctx)?;
            return Ok(());
        }

        spicelib::SPCAC(HANDLE, SCRLUN, b" ", b" ", ctx)?;

        if spicelib::FAILED(ctx) {
            //
            // If there was an error then we need to close the scratch
            // file and the text file, and then check out and return to
            // the caller.
            //
            {
                use f2rust_std::io;

                let specs = io::CloseSpecs {
                    unit: Some(SCRLUN),
                    ..Default::default()
                };
                ctx.close(specs)?;
            }
            {
                use f2rust_std::io;

                let specs = io::CloseSpecs {
                    unit: Some(TXTLUN),
                    ..Default::default()
                };
                ctx.close(specs)?;
            }
            spicelib::DAFCLS(HANDLE, ctx)?;
            spicelib::CHKOUT(b"CONVTB", ctx)?;
            return Ok(());
        }
        //
        // We succeeded, so close the files we opened to deal with the
        // comments. The scratch file is automatically deleted.
        //
        {
            use f2rust_std::io;

            let specs = io::CloseSpecs {
                unit: Some(SCRLUN),
                ..Default::default()
            };
            ctx.close(specs)?;
        }
        spicelib::DAFCLS(HANDLE, ctx)?;
    }
    //
    // Close the transfer file. We know it is open, because we got here.
    //
    {
        use f2rust_std::io;

        let specs = io::CloseSpecs {
            unit: Some(TXTLUN),
            ..Default::default()
        };
        ctx.close(specs)?;
    }

    spicelib::CHKOUT(b"CONVTB", ctx)?;
    Ok(())
}