rsspice 0.1.0

Pure Rust port of the SPICE Toolkit for space geometry
Documentation
//
// GENERATED FILE
//

use super::*;
use crate::SpiceContext;
use f2rust_std::*;

/// Character position
///
/// Find the first occurrence in a string of a character belonging
/// to a collection of characters, starting at a specified location,
/// searching forward.
///
/// # Required Reading
///
/// * [SCANNING](crate::required_reading::scanning)
///
/// # Brief I/O
///
/// ```text
///  VARIABLE  I/O  DESCRIPTION
///  --------  ---  --------------------------------------------------
///  STR        I   Any character string.
///  CHARS      I   A collection of characters.
///  START      I   Position to begin looking for one of CHARS
///
///  The function returns the index of the first character of STR
///  at or following index START that is in the collection CHARS.
/// ```
///
/// # Detailed Input
///
/// ```text
///  STR      is any character string.
///
///  CHARS    is a character string containing a collection
///           of characters. Spaces in CHARS are significant.
///
///  START    is the position in STR to begin looking for one of
///           the characters in CHARS.
/// ```
///
/// # Detailed Output
///
/// ```text
///  The function returns the index of the first character of STR
///  (at or following index START) that is one of the characters in
///  the string CHARS. If none of the characters is found, the
///  function returns zero.
/// ```
///
/// # Exceptions
///
/// ```text
///  Error free.
///
///  1)  If START is less than 1, the search begins at the first
///      character of the string.
///
///  2)  If START is greater than the length of the string, CPOS
///      returns zero.
/// ```
///
/// # Particulars
///
/// ```text
///  CPOS is case sensitive.
///
///  An entire family of related SPICELIB routines (POS, CPOS, NCPOS,
///  POSR, CPOSR, NCPOSR) is described in the Required Reading.
///
///  Those familiar with the True BASIC language should note that
///  these functions are equivalent to the True BASIC intrinsic
///  functions with the same names.
/// ```
///
/// # Examples
///
/// ```text
///  Let STRING = 'BOB, JOHN, TED, AND MARTIN....'
///                123456789012345678901234567890
///
///  Normal (sequential) searching
///  -----------------------------
///
///        CPOS( STRING, ' ,',    1  ) =  4
///
///        CPOS( STRING, ' ,',    5  ) =  5
///
///        CPOS( STRING, ' ,',    6  ) = 10
///
///        CPOS( STRING, ' ,',    11 ) = 11
///
///        CPOS( STRING, ' ,',    12 ) = 15
///
///        CPOS( STRING, ' ,',    16 ) = 16
///
///        CPOS( STRING, ' ,',    17 ) = 20
///
///        CPOS( STRING, ' ,',    21 ) = 0
///
///
///  START out of bounds
///  -------------------
///
///        CPOS( STRING, ' ,',  -113 ) = 4
///
///        CPOS( STRING, ' ,',    -1 ) = 4
///
///        CPOS( STRING, ' ,',    31 ) = 0
///
///        CPOS( STRING, ' ,',  1231 ) = 0
///
///
///  Order within CHARS
///  ------------------
///
///        CPOS( STRING, ',. ',   22 ) = 27
///
///        CPOS( STRING, ' ,.',   22 ) = 27
///
///        CPOS( STRING, ', .',   22 ) = 27
/// ```
///
/// # Author and Institution
///
/// ```text
///  J. Diaz del Rio    (ODC Space)
///  H.A. Neilan        (JPL)
///  B.V. Semenov       (JPL)
///  W.L. Taber         (JPL)
/// ```
///
/// # Version
///
/// ```text
/// -    SPICELIB Version 1.1.0, 02-JUL-2021 (JDR)
///
///         Added IMPLICIT NONE statement.
///
///         Edited the header to comply with NAIF standard.
///
/// -    SPICELIB Version 1.0.3, 31-JAN-2008 (BVS)
///
///         Removed non-standard end-of-declarations marker
///         'C%&END_DECLARATIONS' from comments.
///
/// -    SPICELIB Version 1.0.2, 10-MAR-1992 (WLT)
///
///         Comment section for permuted index source lines was added
///         following the header.
///
/// -    SPICELIB Version 1.0.1, 26-MAR-1991 (HAN)
///
///         The Required Reading file POSITION was renamed to SCANNING.
///         This header was updated to reflect the change.
///
/// -    SPICELIB Version 1.0.0, 31-JAN-1990 (WLT)
/// ```
pub fn cpos(str: &str, chars: &str, start: i32) -> i32 {
    let ret = CPOS(str.as_bytes(), chars.as_bytes(), start);
    ret
}

//$Procedure CPOS ( Character position )
pub fn CPOS(STR: &[u8], CHARS: &[u8], START: i32) -> i32 {
    let mut CPOS: i32 = 0;
    let mut FOUND: bool = false;
    let mut LENSTR: i32 = 0;
    let mut B: i32 = 0;

    //
    // Local variables
    //

    LENSTR = intrinsics::LEN(STR);

    B = intrinsics::MAX0(&[1, START]);
    FOUND = false;
    CPOS = 0;

    while !FOUND {
        if (B > LENSTR) {
            return CPOS;
        } else if (intrinsics::INDEX(CHARS, fstr::substr(STR, B..=B)) != 0) {
            CPOS = B;
            return CPOS;
        } else {
            B = (B + 1);
        }
    }

    CPOS
}