| 1 | |
|---|
| 2 | /* file CPAR.H |
|---|
| 3 | * ====== |
|---|
| 4 | * |
|---|
| 5 | * version 4, 22-May-2006 |
|---|
| 6 | * |
|---|
| 7 | * include file of module CPAR.C |
|---|
| 8 | * K. Stammler, 9-May-92 |
|---|
| 9 | */ |
|---|
| 10 | |
|---|
| 11 | |
|---|
| 12 | /* |
|---|
| 13 | * |
|---|
| 14 | * SeismicHandler, seismic analysis software |
|---|
| 15 | * Copyright (C) 1996, Klaus Stammler, Federal Institute for Geosciences |
|---|
| 16 | * and Natural Resources (BGR), Germany |
|---|
| 17 | * |
|---|
| 18 | * This program is free software; you can redistribute it and/or modify |
|---|
| 19 | * it under the terms of the GNU General Public License as published by |
|---|
| 20 | * the Free Software Foundation; either version 2 of the License, or |
|---|
| 21 | * (at your option) any later version. |
|---|
| 22 | * |
|---|
| 23 | * This program is distributed in the hope that it will be useful, |
|---|
| 24 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 25 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 26 | * GNU General Public License for more details. |
|---|
| 27 | * |
|---|
| 28 | * You should have received a copy of the GNU General Public License |
|---|
| 29 | * along with this program; if not, write to the Free Software |
|---|
| 30 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
|---|
| 31 | * |
|---|
| 32 | */ |
|---|
| 33 | |
|---|
| 34 | |
|---|
| 35 | /* global constants */ |
|---|
| 36 | #define PAC_MAXPAR 20 |
|---|
| 37 | /* maximum number of parameters */ |
|---|
| 38 | #define PAC_MAXQUAL 20 |
|---|
| 39 | /* maximum number of qualifers */ |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | /*--------------------------------------------------------------------*/ |
|---|
| 43 | |
|---|
| 44 | |
|---|
| 45 | void pa_init( int argc, char *argv[] ); |
|---|
| 46 | |
|---|
| 47 | /* intializes pa-variables. Determines number of parameters and |
|---|
| 48 | * number of qualifers |
|---|
| 49 | * |
|---|
| 50 | * parameters of routine |
|---|
| 51 | * int argc; input; number of items (quals and pars) |
|---|
| 52 | * char *argv[]; input; argument string |
|---|
| 53 | */ |
|---|
| 54 | |
|---|
| 55 | |
|---|
| 56 | /*--------------------------------------------------------------------*/ |
|---|
| 57 | |
|---|
| 58 | |
|---|
| 59 | int pa_pnumber( void ); |
|---|
| 60 | |
|---|
| 61 | /* returns number of parameters |
|---|
| 62 | * |
|---|
| 63 | * no parameters |
|---|
| 64 | */ |
|---|
| 65 | |
|---|
| 66 | |
|---|
| 67 | /*--------------------------------------------------------------------*/ |
|---|
| 68 | |
|---|
| 69 | |
|---|
| 70 | int pa_qnumber( void ); |
|---|
| 71 | |
|---|
| 72 | /* returns number of qualifiers |
|---|
| 73 | * |
|---|
| 74 | * no parameters |
|---|
| 75 | */ |
|---|
| 76 | |
|---|
| 77 | |
|---|
| 78 | /*--------------------------------------------------------------------*/ |
|---|
| 79 | |
|---|
| 80 | |
|---|
| 81 | char *pa_pvalue( int number ); |
|---|
| 82 | |
|---|
| 83 | /* returns value of parameter number "number" |
|---|
| 84 | * |
|---|
| 85 | * parameters of routine |
|---|
| 86 | * int number; number of parameter |
|---|
| 87 | */ |
|---|
| 88 | |
|---|
| 89 | |
|---|
| 90 | /*--------------------------------------------------------------------*/ |
|---|
| 91 | |
|---|
| 92 | |
|---|
| 93 | BOOLEAN pa_qspecified( char name[] ); |
|---|
| 94 | |
|---|
| 95 | /* checks whether a particular qualifier is specified in the command |
|---|
| 96 | * line |
|---|
| 97 | * |
|---|
| 98 | * parameter of the routine |
|---|
| 99 | * char name[]; input; name of the qualifier |
|---|
| 100 | * returns TRUE if the qualifier was specified |
|---|
| 101 | */ |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | /*--------------------------------------------------------------------*/ |
|---|
| 105 | |
|---|
| 106 | |
|---|
| 107 | char *pa_qvalue( char name[] ); |
|---|
| 108 | |
|---|
| 109 | /* returns value of a particular qualifier |
|---|
| 110 | * |
|---|
| 111 | * parameter of the routine |
|---|
| 112 | * char name[]; input; name of the qualifier |
|---|
| 113 | * returns TRUE if the qualifier was specified |
|---|
| 114 | */ |
|---|
| 115 | |
|---|
| 116 | |
|---|
| 117 | /*--------------------------------------------------------------------*/ |
|---|
| 118 | |
|---|
| 119 | |
|---|
| 120 | int pa_qunchecked( char first[] ); |
|---|
| 121 | |
|---|
| 122 | /* returns the number of unchecked qualifers. If the number is |
|---|
| 123 | * greater than zero, "first" contains the first unchecked qualifier |
|---|
| 124 | * |
|---|
| 125 | * parameters of routine |
|---|
| 126 | * char first[]; output; first unchecked qualifier |
|---|
| 127 | * returns number of unchecked qualifiers |
|---|
| 128 | */ |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | /*--------------------------------------------------------------------*/ |
|---|
| 132 | |
|---|
| 133 | |
|---|
| 134 | char *pa_progname( void ); |
|---|
| 135 | |
|---|
| 136 | /* returns name of program without path |
|---|
| 137 | * |
|---|
| 138 | * no parameters |
|---|
| 139 | */ |
|---|
| 140 | |
|---|
| 141 | |
|---|
| 142 | /*--------------------------------------------------------------------*/ |
|---|
