rsspice 0.1.0

//
// GENERATED FILE
//

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

pub const LBCELL: i32 = -5;

/// Return all components for a symbol
///
/// Return the dimension and associated values for a particular
/// symbol.
///
/// # Required Reading
///
/// * [SYMBOLS](crate::required_reading::symbols)
///
/// # Brief I/O
///
/// ```text
///  VARIABLE  I/O  DESCRIPTION
///  --------  ---  --------------------------------------------------
///  NAME       I   Name of the symbol whose components are to be
///                 returned.
///  TABSYM,
///  TABPTR,
///  TABVAL     I   Components of the symbol table.
///
///  N          O   Dimension of the symbol.
///  VALUES     O   Values associated with the symbol.
///  FOUND      O   .TRUE. if the symbol NAME is in the symbol table.
/// ```
///
/// # Detailed Input
///
/// ```text
///  NAME     is the name of the symbol whose components are to be
///           returned. If NAME is not in the symbol table, FOUND is
///           .FALSE.
///
///  TABSYM,
///  TABPTR,
///  TABVAL   are the components of an integer symbol table.
///           The symbol NAME may or may not be in the symbol
///           table. The symbol table is not modified by this
///           subroutine.
/// ```
///
/// # Detailed Output
///
/// ```text
///  N        is the dimension of the symbol NAME. The dimension is
///           the number of values associated with the given symbol.
///           N is defined only if the output argument FOUND is
///           .TRUE.
///
///  VALUES   is an array containing the values associated with the
///           symbol. If the array is not large enough to hold all
///           of the values associated with NAME, as many as will
///           fit are returned. VALUES is defined only if the
///           output argument FOUND is .TRUE.
///
///  FOUND    is .TRUE. if NAME is in the symbol table.
///           If NAME is not in the table, FOUND is .FALSE.
/// ```
///
/// # Exceptions
///
/// ```text
///  1)  If there is an issue while reading the components of a
///      integer symbol table, an error is signaled by a routine in
///      the call tree of this routine. This normally indicates that
///      the integer symbol table is corrupted.
/// ```
///
/// # Examples
///
/// ```text
///  The contents of the symbol table are:
///
///      books   -->   5
///      erasers -->   6
///      pencils -->  12
///                   24
///      pens    -->  10
///                   12
///                   24
///
///   Let the dimension of VALUES be 3.
///
///   The calls,
///
///   CALL SYGETI ( 'pencils', TABSYM, TABPTR, TABVAL,
///  .               N,         VALUES, FOUND           )
///
///   CALL SYGETI ( 'pens',     TABSYM, TABPTR, TABVAL,
///  .               N,         VALUES, FOUND           )
///
///   CALL SYGETI ( 'desks',    TABSYM, TABPTR, TABVAL,
///  .               N,         VALUES, FOUND           )
///
///
///   return the values for N, VALUES, and FOUND associated with NAME:
///
///      NAME         N      VALUES    FOUND
///      ----------  ---    --------  -------
///      pencils      2        12      .TRUE.
///                            24
///      pens         3        10      .TRUE.
///                            12
///                            24
///      desks                        .FALSE.
/// ```
///
/// # Restrictions
///
/// ```text
///  1)  This subroutine does not check to see if the output array
///      VALUES is large enough to hold all of the values associated
///      with the symbol NAME. The caller must provide the required
///      space.
/// ```
///
/// # Author and Institution
///
/// ```text
///  N.J. Bachman       (JPL)
///  J. Diaz del Rio    (ODC Space)
///  H.A. Neilan        (JPL)
///  W.L. Taber         (JPL)
///  I.M. Underwood     (JPL)
/// ```
///
/// # Version
///
/// ```text
/// -    SPICELIB Version 1.1.0, 16-AUG-2021 (JDR)
///
///         Added IMPLICIT NONE statement.
///
///         Edited the header to comply with NAIF standard. Moved entry
///         from $Exceptions to $Restrictions and added entry #1 in
///         $Exceptions.
///
/// -    SPICELIB Version 1.0.2, 03-NOV-2005 (NJB)
///
///         Various header corrections were made. In particular,
///         the header no longer asserts that this routine will
///         "return as many values as will fit" in the output array
///         VALUES.
///
/// -    SPICELIB Version 1.0.1, 10-MAR-1992 (WLT)
///
///         Comment section for permuted index source lines was added
///         following the header.
///
/// -    SPICELIB Version 1.0.0, 31-JAN-1990 (IMU) (HAN)
/// ```
pub fn sygeti(
    ctx: &mut SpiceContext,
    name: &str,
    tabsym: CharArray,
    tabptr: &[i32],
    tabval: &[i32],
    n: &mut i32,
    values: &mut [i32],
    found: &mut bool,
) -> crate::Result<()> {
    SYGETI(
        name.as_bytes(),
        tabsym,
        tabptr,
        tabval,
        n,
        values,
        found,
        ctx.raw_context(),
    )?;
    ctx.handle_errors()?;
    Ok(())
}

//$Procedure SYGETI ( Return all components for a symbol )
pub fn SYGETI(
    NAME: &[u8],
    TABSYM: CharArray,
    TABPTR: &[i32],
    TABVAL: &[i32],
    N: &mut i32,
    VALUES: &mut [i32],
    FOUND: &mut bool,
    ctx: &mut Context,
) -> f2rust_std::Result<()> {
    let TABSYM = DummyCharArray::new(TABSYM, None, LBCELL..);
    let TABPTR = DummyArray::new(TABPTR, LBCELL..);
    let TABVAL = DummyArray::new(TABVAL, LBCELL..);
    let mut VALUES = DummyArrayMut::new(VALUES, 1..);
    let mut NSYM: i32 = 0;
    let mut LOCSYM: i32 = 0;
    let mut LOCVAL: i32 = 0;

    //
    // SPICELIB functions
    //

    //
    // Local variables
    //

    //
    // Standard SPICE error handling.
    //
    if RETURN(ctx) {
        return Ok(());
    } else {
        CHKIN(b"SYGETI", ctx)?;
    }

    //
    // How many symbols to start with?
    //
    NSYM = CARDC(TABSYM.as_arg(), ctx)?;

    //
    // Is this symbol even in the table?
    //
    LOCSYM = BSRCHC(NAME, NSYM, TABSYM.subarray(1));

    //
    // If it's not in the table, it's definitely a problem.
    //
    if (LOCSYM == 0) {
        *FOUND = false;

    //
    // Otherwise, we can proceed without fear of error. Merely locate
    // and return the appropriate component from the values table.
    // We trust that the user has supplied enough room.
    //
    } else {
        *FOUND = true;

        LOCVAL = (SUMAI(TABPTR.subarray(1), (LOCSYM - 1)) + 1);
        *N = TABPTR[LOCSYM];

        MOVEI(TABVAL.subarray(LOCVAL), *N, VALUES.as_slice_mut());
    }

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