Home

Libraries

Author

Links

---

getopts.h

Go to the documentation of this file.

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the SysToMath C Libraries package (LibStmC).
 *
 * The Initial Developer of the Original Code is
 * Tom Michaelis, SysToMath.
 * Portions created by the Initial Developer are Copyright (C) 1992-2006
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

/******************************************************************************
 *                       First Release 1992-10-17
 ******************************************************************************/


#ifndef STM_GETOPTS_H
#define STM_GETOPTS_H


#ifdef __cplusplus
   extern "C" {
#endif


#include <stdio.h>
#include <stm/basetype.h>


StmAbstractType (StmCmdLine)  /* CmdLine */



enum StmCmdOptSpecFlags
{
    StmCmdOptSpecHasArg         = 0x00000001,  
    StmCmdOptSpecRequiresArg    = 0x00000003,  
    StmCmdOptSpecArgsEnvOption  = 0x00000004,  
    StmCmdOptSpecArgsFromOption = 0x00000008,  
    StmCmdOptSpecFirstOption    = 0x00000010,  
    StmCmdOptSpecLastOption     = 0x00000020,  
    StmCmdOptSpecOnlyOption     = 0x00000030,  
};


typedef struct StmCmdOptSpec StmCmdOptSpec;


struct StmCmdOptSpec
{
    StmDword id;

    const char *names;

    StmDword flags;
};


StmDllSpec
StmCmdLine stmCmdLineCreate (int argc, const char **argv,
                             const StmCmdOptSpec *optSpec);


StmDllSpec
void stmCmdLineDestroy (StmCmdLine cmdLine);


enum StmCmdLineFlags
{
    StmCmdLineAllowDirectlyFollowingOptArgs = 0x00000001
};


StmDllSpec
StmDword stmCmdLineGetFlags (StmCmdLine cmdLine);


StmDllSpec
int stmCmdLineSetFlags (StmCmdLine cmdLine, StmDword flags);


enum StmCmdLineErrors
{
    StmCmdLineSystemError    = -1,   
    StmCmdLineOk             =  0,   
    StmCmdLineOptionError    =  1,   
    StmCmdLineOptionArgError =  2,   
    StmCmdLineArgumentError  =  3,   
    StmCmdLineWrongUsage     =  4    
};


#define stmCmdLineGetOpterr stmCmdLineGetError


StmDllSpec
int stmCmdLineGetError (StmCmdLine cmdLine);


#define stmCmdLineSetOpterr stmCmdLineSetError


StmDllSpec
int stmCmdLineSetError (StmCmdLine cmdLine, int error);


StmDllSpec
const char *stmCmdLineGetErrbuf (StmCmdLine cmdLine);


StmDllSpec
int stmCmdLinePrintfErrbuf (StmCmdLine cmdLine, const char *format, ...);


StmDllSpec
FILE *stmCmdLineGetErrfp (StmCmdLine cmdLine);


StmDllSpec
int stmCmdLineSetErrfp (StmCmdLine cmdLine, FILE *errfp);


StmDllSpec
StmDword stmCmdLineGetFirstOptionId (StmCmdLine cmdLine);


StmDllSpec
StmDword stmCmdLineGetCurrentOptionId (StmCmdLine cmdLine);


StmDllSpec
StmDword stmCmdLineGetNextOptionId (StmCmdLine cmdLine);


StmDllSpec
const char *stmCmdLineGetProg (StmCmdLine cmdLine);


StmDllSpec
size_t stmCmdLineGetCurrentArgIndex (StmCmdLine cmdLine);


StmDllSpec
size_t stmCmdLineGetCurrentOptionIndex (StmCmdLine cmdLine);


StmDllSpec
const char *stmCmdLineGetCurrentOptionName (StmCmdLine cmdLine);


StmDllSpec
const char *stmCmdLineGetCurrentOptionArg (StmCmdLine cmdLine);


StmDllSpec
size_t stmCmdLineGetArgCount (StmCmdLine cmdLine);


StmDllSpec
const char *stmCmdLineGetArg (StmCmdLine cmdLine, size_t argIndex);


StmDllSpec
int stmPrintManText (FILE *fp, int width, const char *text);


StmDllSpec
int stmPrintManualHeader (FILE *fp, int width,
                          const char *version,
                          int dim, const char **man);


StmDllSpec
int stmPrintManualFooter (FILE *fp, int width, int indent,
                          const char *copyRight);


StmDllSpec
int stmPrintOptionHelp (FILE *fp, int width,
                        const char *optionName,
                        int dim, const char **man);


StmDllSpec
int stmPrintManualSection (FILE *fp, int width,
                           const char *sectionName,
                           int dim, const char **man);


StmDllSpec
int stmPrintSynopsis (FILE *fp, int width, int dim, const char **man);


StmDllSpec
int stmPrintManual (FILE *fp, int width,
                    const char *version, const char *copyRight,
                    int dim, const char **man);


enum StmGetoptsErrnos
{
    StmGetoptsSystemError    = -1,   
    StmGetoptsOk             =  0,   
    StmGetoptsOptionError    =  1,   
    StmGetoptsOptionArgError =  2,   
    StmGetoptsArgumentError  =  3,   
    StmGetoptsWrongUsage     =  4    
};


enum StmGetoptsResults
{
    StmGetoptsQuestion = (int) '?',  
    StmGetoptsEnd      = EOF         
};


StmDllSpec
extern const char *stmGetoptsProg;


StmDllSpec
extern const char *stmGetoptsOptarg;


StmDllSpec
extern int stmGetoptsOptind;


StmDllSpec
extern int stmGetoptsOpterr;


StmDllSpec
extern char *stmGetoptsErrbuf;


StmDllSpec
extern FILE *stmGetoptsOptfp;


StmDllSpec
extern StmBool stmGetoptsStrict;


StmDllSpec
int stmGetopts (int argc, const char **argv, const char *optSpec);


StmDllSpec
int stmFprintfStrArray (FILE *fp, int width, int dim, const char **strArray);


#ifdef __cplusplus
  }
#endif


#endif

---

© Copyright Tom Michaelis 2002-2007

Distributed under the SysToMath Software License (See the accompanying file license.txt or a copy at www.SysToMath.com).