/* getlun.f -- translated by f2c (version 19980913).
   You must link the resulting object file with the libraries:
	-lf2c -lm   (in that order)
*/

#include "f2c.h"

/* $Procedure      GETLUN ( Get a free logical unit ) */
/* Subroutine */ int getlun_(integer *unit)
{
    /* System generated locals */
    integer i__1;

    /* Local variables */
    extern /* Subroutine */ int chkin_(char *, ftnlen), fndlun_(integer *), 
	    sigerr_(char *, ftnlen), chkout_(char *, ftnlen), setmsg_(char *, 
	    ftnlen), errint_(char *, integer *, ftnlen);
    extern logical return_(void);

/* $ Abstract */

/*     Return the number of a free logical unit. */

/* $ Disclaimer */

/*     THIS SOFTWARE AND ANY RELATED MATERIALS WERE CREATED BY THE */
/*     CALIFORNIA INSTITUTE OF TECHNOLOGY (CALTECH) UNDER A U.S. */
/*     GOVERNMENT CONTRACT WITH THE NATIONAL AERONAUTICS AND SPACE */
/*     ADMINISTRATION (NASA). THE SOFTWARE IS TECHNOLOGY AND SOFTWARE */
/*     PUBLICLY AVAILABLE UNDER U.S. EXPORT LAWS AND IS PROVIDED "AS-IS" */
/*     TO THE RECIPIENT WITHOUT WARRANTY OF ANY KIND, INCLUDING ANY */
/*     WARRANTIES OF PERFORMANCE OR MERCHANTABILITY OR FITNESS FOR A */
/*     PARTICULAR USE OR PURPOSE (AS SET FORTH IN UNITED STATES UCC */
/*     SECTIONS 2312-2313) OR FOR ANY PURPOSE WHATSOEVER, FOR THE */
/*     SOFTWARE AND RELATED MATERIALS, HOWEVER USED. */

/*     IN NO EVENT SHALL CALTECH, ITS JET PROPULSION LABORATORY, OR NASA */
/*     BE LIABLE FOR ANY DAMAGES AND/OR COSTS, INCLUDING, BUT NOT */
/*     LIMITED TO, INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND, */
/*     INCLUDING ECONOMIC DAMAGE OR INJURY TO PROPERTY AND LOST PROFITS, */
/*     REGARDLESS OF WHETHER CALTECH, JPL, OR NASA BE ADVISED, HAVE */
/*     REASON TO KNOW, OR, IN FACT, SHALL KNOW OF THE POSSIBILITY. */

/*     RECIPIENT BEARS ALL RISK RELATING TO QUALITY AND PERFORMANCE OF */
/*     THE SOFTWARE AND ANY RELATED MATERIALS, AND AGREES TO INDEMNIFY */
/*     CALTECH AND NASA FOR ALL THIRD-PARTY CLAIMS RESULTING FROM THE */
/*     ACTIONS OF RECIPIENT IN THE USE OF THE SOFTWARE. */

/* $ Required_Reading */

/*     None. */

/* $ Keywords */

/*     FILES */

/* $ Declarations */
/* $ Brief_I/O */

/*     VARIABLE  I/O  DESCRIPTION */
/*     --------  ---  -------------------------------------------------- */
/*     UNIT       O   The number of a free logical unit. */

/* $ Detailed_Input */

/*     None. */

/* $ Detailed_Output */

/*     UNIT        is the number of a free logical unit (also called */
/*                 an "external unit"). If no free units are available, */
/*                 the value of UNIT is 0. */

/* $ Parameters */

/*     None. */

/* $ Exceptions */

/*     1)  If there are no free logical units available, UNIT is assigned */
/*         the value 0, and the error SPICE(NOFREELOGICALUNIT) is */
/*         signalled. */

/*     2)  This routine obtains a logical unit number from FNDLUN. */
/*         FNDLUN executes a Fortran INQUIRE statement; if that statement */
/*         fails to execute properly, FNDLUN returns a negative unit */
/*         number.  In this case, GETLUN assigns the value 0 to UNIT, */
/*         and the error SPICE(INQUIREFAILED) is signalled. */

/* $ Files */

/*     None. */

/* $ Particulars */

/*     GETLUN returns the number of the first (unreserved) unit not */
/*     currently connected to a file.  It thus frees the user from */
/*     having to maintain an accounting of which units are open, which */
/*     are closed, and which are available. */

/*     This routine is related to the routines FNDLUN, RESLUN, and */
/*     FRELUN.  Together, these routines support coordinated usage of */
/*     Fortran logical units.  GETLUN (Get a free logical unit) and */
/*     FNDLUN (Find a free logical unit) both have the function of */
/*     returning a logical unit number that is not reserved or already */
/*     in use.  The principal difference between the functionality of */
/*     these routines is that GETLUN both returns a status code and */
/*     signals an error if a free unit is not found, while FNDLUN */
/*     merely returns a status code. */

/*     RESLUN is used to reserve logical unit numbers, so that they will */
/*     not be returned by GETLUN or FNDLUN; FRELUN frees logical units */
/*     previously reserved via calls to RESLUN. */

/*     Logical units 5-7 are reserved by default. Other units may be */
/*     reserved by calling RESLUN. Once reserved, units (except 5-7) may */
/*     be unreserved by calling FRELUN. */

/*     To reserve logical unit numbers for special use, refer to */
/*     RESLUN. To make reserved units available to GETLUN or FNDLUN, */
/*     refer to FRELUN. */

/*     A unit returned by GETLUN does NOT automatically become a */
/*     reserved unit.  If the user wishes to reserve a unit found by */
/*     GETLUN, the call to GETLUN must be followed by a call to RESLUN. */

/*     This routine obtains a logical unit number via a call to FNDLUN. */
/*     FNDLUN uses an INQUIRE statement; if that statement doesn't */
/*     execute properly, GETLUN will signal the error.  This arrangement */
/*     allows FNDLUN to be error free. */

/*     The range of possible unit numbers returned by GETLUN is dependent */
/*     on the parameters MINLUN and MAXLUN, which are defined in FNDLUN. */

/*     Note that although 0 is a valid logical unit number on some */
/*     systems, a value of 0 returned by GETLUN indicates that no free */
/*     logical unit was available, rather than that logical unit 0 is */
/*     available. */

/* $ Examples */

/*     The following code fragment illustrates the use of GETLUN. */

/*        CALL GETLUN ( UNIT ) */

/*        IF ( UNIT .EQ. 0 ) THEN */
/*           RETURN */
/*        END IF */

/* $ Restrictions */

/*     This routine never returns a logical unit number of 0.  The */
/*     value 0 is used to indicate that no free logical unit was */
/*     found. */

/* $ Literature_References */

/*     None. */

/* $ Author_and_Institution */

/*     N.J. Bachman    (JPL) */
/*     C.A. Curzon     (JPL) */
/*     H.A. Neilan     (JPL) */
/*     I.M. Underwood  (JPL) */

/* $ Version */

/* -    SPICELIB Version 1.0.2, 18-MAY-2010 (BVS) */

/*        Removed "C$" marker from text in the header. */

/* -    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 (CAC) (IMU) */

/* -& */
/* $ Index_Entries */

/*     get a free logical unit */

/* -& */
/* $ Revisions */

/* -     Beta Version 2.0.0, 24-FEB-1989 (HAN) (NJB) */

/*         This routine has been substantially re-written so as to */
/*         obtain a free logical unit number via a call to FNDLUN. */

/*         If there are no free logical units available, UNIT */
/*         is assigned the value 0, and an error is signalled. */

/*         The "Parameters" section was added to the header. */

/* -& */

/*     Spicelib functions */


/*     Standard SPICE error handling. */

    if (return_()) {
	return 0;
    } else {
	chkin_("GETLUN", (ftnlen)6);
    }

/*     Find a free logical unit, if there's one to be had. */

    fndlun_(unit);
    if (*unit == 0) {

/*        There are no free units to be had.  C'est la vie.  Signal an */
/*        error. */

	setmsg_("No free logical units are available.", (ftnlen)36);
	sigerr_("SPICE(NOFREELOGICALUNIT)", (ftnlen)24);
	chkout_("GETLUN", (ftnlen)6);
	return 0;
    } else if (*unit < 0) {

/*        There are no free units to be had.  In this case, we know the */
/*        "INQUIRE" attempted by FNDLUN failed.  Assign 0 to the unit */
/*        number, and signal an error. */

	setmsg_("INQUIRE iostat was #.", (ftnlen)21);
	i__1 = -(*unit);
	errint_("#", &i__1, (ftnlen)1);
	sigerr_("SPICE(INQUIREFAILED)", (ftnlen)20);
	*unit = 0;
	chkout_("GETLUN", (ftnlen)6);
	return 0;
    }
    chkout_("GETLUN", (ftnlen)6);
    return 0;
} /* getlun_ */

