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
//
// GENERATED FILE
//
use super::*;
use crate::SpiceContext;
use f2rust_std::*;
const LMSGLN: i32 = (23 * 80);
const SMSGLN: i32 = 25;
/// Insert String into Error Message Text
///
/// Substitute a character string for the first occurrence of
/// a marker in the current long error message.
///
/// # Required Reading
///
/// * [ERROR](crate::required_reading::error)
///
/// # Brief I/O
///
/// ```text
/// VARIABLE I/O DESCRIPTION
/// -------- --- ---------------------------------------------------
/// MARKER I A substring of the error message to be replaced.
/// STRING I The character string to substitute for MARKER.
/// ```
///
/// # Detailed Input
///
/// ```text
/// MARKER is a character string that marks a position in
/// the long error message where a character string
/// is to be substituted. Leading and trailing blanks
/// in MARKER are not significant.
///
/// Case IS significant: 'XX' is considered to be
/// a different marker from 'xx'.
///
/// STRING is a character string that will be substituted for
/// the first occurrence of MARKER in the long error
/// message. This occurrence of the substring indicated
/// by MARKER will be removed and replaced by STRING.
/// Leading and trailing blanks in STRING are not
/// significant. However, if STRING is completely blank,
/// a single blank character will be substituted for
/// the marker.
/// ```
///
/// # Parameters
///
/// ```text
/// LMSGLN is the maximum length of the long error message. See
/// the include file errhnd.inc for the value of LMSGLN.
/// ```
///
/// # Exceptions
///
/// ```text
/// 1) If the character string resulting from the substitution
/// exceeds the maximum length of the long error message, the
/// long error message is truncated on the right. No error is
/// signaled.
///
/// 2) If MARKER is blank, no substitution is performed. No error
/// is signaled.
///
/// 3) If STRING is blank, then the first occurrence of MARKER is
/// replaced by a single blank.
///
/// 4) If MARKER does not appear in the long error message, no
/// substitution is performed. No error is signaled.
///
/// 5) If changes to the long error message are disabled, this
/// routine has no effect.
/// ```
///
/// # Particulars
///
/// ```text
/// The purpose of this routine is to allow you to tailor the long
/// error message to include specific information that is available
/// only at run time. This capability is somewhat like being able to
/// put variables in your error messages.
/// ```
///
/// # Examples
///
/// ```text
/// 1) In this example, the marker is '#'. We'll signal a file
/// open error, and we'll include in the error message the name
/// of the file we tried to open. There are three steps:
///
/// -- Set the long message, using a marker for the location
/// where a value is to be substituted.
///
/// -- Substitute the file name into the error message.
///
/// -- Signal the error (causing output of error messages)
/// using the SPICELIB routine SIGERR.
///
/// C
/// C Error on file open attempt. Signal an error.
/// C The character string variable FILE contains the
/// C file name.
/// C
/// C After the call to ERRCH, the long error message
/// C will contain the file name held in the string
/// C FILE. For example, if FILE contains the name
/// C 'MYFILE.DAT', the long error message will be
/// C
/// C 'File open error. File is MYFILE.DAT.'
/// C
///
/// CALL SETMSG ( 'File open error. File is #.' )
/// CALL ERRCH ( '#', FILE )
/// CALL SIGERR ( SPICE(FILEOPENFAILED) )
///
///
/// 2) Same example as (1), except this time we'll use a better-
/// looking and more descriptive marker than '#'. Instead,
/// we'll use the marker 'FILENAME'. This does not affect the
/// long error message; it just makes the code more readable.
///
/// C
/// C Error on file open attempt. Signal an error.
/// C The character string variable FILE contains the
/// C file name.
/// C
/// CALL SETMSG ( 'File open error. File is FILENAME.')
/// CALL ERRCH ( 'FILENAME', FILE )
/// CALL SIGERR ( SPICE(FILEOPENFAILED) )
///
///
/// 3) Same example as (2), except this time there's a problem with
/// the variable FILE: it's blank. This time, the code fragment
///
/// C
/// C Error on file open attempt. Signal an error.
/// C The character string variable FILE contains the
/// C file name.
/// C
/// CALL SETMSG ( 'File open error. File is FILENAME.')
/// CALL ERRCH ( 'FILENAME', FILE )
///
/// sets the long error message to
///
/// 'File open error. File is '.
/// ```
///
/// # Restrictions
///
/// ```text
/// 1) The caller must ensure that the message length, after sub-
/// stitution is performed, doesn't exceed LMSGLN characters.
/// ```
///
/// # Author and Institution
///
/// ```text
/// N.J. Bachman (JPL)
/// J. Diaz del Rio (ODC Space)
/// J.E. McLean (JPL)
/// W.L. Taber (JPL)
/// ```
///
/// # Version
///
/// ```text
/// - SPICELIB Version 2.2.0, 13-AUG-2021 (JDR)
///
/// Added IMPLICIT NONE statement.
///
/// Edited the header to comply with NAIF standard.
///
/// - SPICELIB Version 2.1.0, 29-JUL-1997 (NJB)
///
/// Maximum length of the long error message is now represented
/// by the parameter LMSGLN.
///
/// - SPICELIB Version 2.0.1, 10-MAR-1992 (WLT)
///
/// Comment section for permuted index source lines was added
/// following the header.
///
/// - SPICELIB Version 2.0.0, 25-MAR-1991 (JEM) (NJB)
///
/// When the input value of STRING is blank, this version
/// replaces the first occurrence of MARKER with a
/// single blank character. Header was edited to improve
/// clarity. Cosmetic changes to code were made.
///
/// - SPICELIB Version 1.0.0, 31-JAN-1990 (NJB)
/// ```
///
/// # Revisions
///
/// ```text
/// - SPICELIB Version 2.1.0, 29-JUL-1997 (NJB)
///
/// Maximum length of the long error message is now represented
/// by the parameter LMSGLN.
///
/// - SPICELIB Version 2.0.0, 25-MAR-1991 (JEM) (NJB)
///
/// When the input value of STRING is blank, this version
/// replaces the first occurrence of MARKER with a
/// single blank character. The previous version made
/// no substitution, leaving the marker in the long error
/// message.
///
/// The $Exceptions, $Examples, and $Particulars sections were
/// updated to improve accuracy and clarity. Some cosmetic
/// changes were made as well.
///
/// Also, some cosmetic changes to the code were made.
/// ```
pub fn errch(ctx: &mut SpiceContext, marker: &str, string: &str) {
ERRCH(marker.as_bytes(), string.as_bytes(), ctx.raw_context());
}
//$Procedure ERRCH ( Insert String into Error Message Text )
pub fn ERRCH(MARKER: &[u8], STRING: &[u8], ctx: &mut Context) {
let mut LNGMSG = [b' '; LMSGLN as usize];
let mut TMPMSG = [b' '; LMSGLN as usize];
let mut MRKPOS: i32 = 0;
//
// SPICELIB functions
//
//
// Local Variables:
//
//
// Changes to the long error message must be allowed, or we do
// nothing.
//
if !ALLOWD(ctx) {
return;
}
//
// MARKER must have some non-blank characters, or we do nothing.
//
if (LASTNB(MARKER) == 0) {
return;
}
//
// Get a copy of the current long error message.
//
GETLMS(&mut LNGMSG, ctx);
//
// Locate the leftmost occurrence of MARKER, if there is one
// (ignoring leading and trailing blanks):
//
MRKPOS = intrinsics::INDEX(
&LNGMSG,
fstr::substr(MARKER, FRSTNB(MARKER)..=LASTNB(MARKER)),
);
if (MRKPOS == 0) {
//
// MARKER does not occur in the long error message, so there's
// no substitution to perform.
//
return;
} else {
//
// We put together TMPMSG, a copy of LNGMSG with MARKER
// replaced by STRING.
//
if (MRKPOS > 1) {
//
// MARKER is not at the beginning of the long error message.
//
if ((MRKPOS + NBLEN(MARKER)) <= LASTNB(&LNGMSG)) {
//
// There's more of the long message after the marker.
//
if fstr::ne(STRING, b" ") {
fstr::assign(
&mut TMPMSG,
&fstr::concat(
&fstr::concat(
fstr::substr(&LNGMSG, 1..=(MRKPOS - 1)),
fstr::substr(STRING, FRSTNB(STRING)..=LASTNB(STRING)),
),
fstr::substr(&LNGMSG, (MRKPOS + NBLEN(MARKER))..),
),
);
} else {
fstr::assign(
&mut TMPMSG,
&fstr::concat(
&fstr::concat(fstr::substr(&LNGMSG, 1..=(MRKPOS - 1)), b" "),
fstr::substr(&LNGMSG, (MRKPOS + NBLEN(MARKER))..),
),
);
}
} else {
//
// The long error message ends with MARKER.
//
if fstr::ne(STRING, b" ") {
fstr::assign(
&mut TMPMSG,
&fstr::concat(
fstr::substr(&LNGMSG, 1..=(MRKPOS - 1)),
fstr::substr(STRING, FRSTNB(STRING)..=LASTNB(STRING)),
),
);
} else {
fstr::assign(
&mut TMPMSG,
&fstr::concat(fstr::substr(&LNGMSG, 1..=(MRKPOS - 1)), b" "),
);
}
}
} else {
//
// The long error message starts with MARKER (MRKPOS is 1).
//
if (NBLEN(MARKER) < LASTNB(&LNGMSG)) {
//
// There's more of the long message after the marker...
//
if fstr::ne(STRING, b" ") {
fstr::assign(
&mut TMPMSG,
&fstr::concat(
fstr::substr(STRING, FRSTNB(STRING)..=LASTNB(STRING)),
fstr::substr(&LNGMSG, (1 + NBLEN(MARKER))..),
),
);
} else {
fstr::assign(
&mut TMPMSG,
&fstr::concat(b" ", fstr::substr(&LNGMSG, (1 + NBLEN(MARKER))..)),
);
}
} else {
//
// The marker's the whole string:
//
if fstr::ne(STRING, b" ") {
fstr::assign(
&mut TMPMSG,
fstr::substr(STRING, FRSTNB(STRING)..=LASTNB(STRING)),
);
} else {
fstr::assign(&mut TMPMSG, b" ");
}
}
}
//
// Update the long error message:
//
PUTLMS(&TMPMSG, ctx);
}
}