Back to index

lightning-sunbird  0.9+nobinonly
plgetopt.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is the Netscape Portable Runtime (NSPR).
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998-2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 /*
00039 ** File:          plgetopt.h
00040 ** Description:   utilities to parse argc/argv
00041 */
00042 
00043 #if defined(PLGETOPT_H_)
00044 #else
00045 #define PLGETOPT_H_
00046 
00047 #include "prtypes.h"
00048 
00049 PR_BEGIN_EXTERN_C
00050 
00051 typedef struct PLOptionInternal PLOptionInternal; 
00052 
00053 typedef enum
00054 {
00055         PL_OPT_OK,              /* all's well with the option */
00056         PL_OPT_EOL,             /* end of options list */
00057         PL_OPT_BAD              /* invalid option (and value) */
00058 } PLOptStatus;
00059 
00060 typedef struct PLOptState
00061 {
00062     char option;                /* the name of the option */
00063     const char *value;          /* the value of that option | NULL */
00064 
00065     PLOptionInternal *internal; /* private processing state */
00066 
00067 } PLOptState;
00068 
00069 PR_EXTERN(PLOptState*) PL_CreateOptState(
00070         PRIntn argc, char **argv, const char *options);
00071 
00072 PR_EXTERN(void) PL_DestroyOptState(PLOptState *opt);
00073 
00074 PR_EXTERN(PLOptStatus) PL_GetNextOpt(PLOptState *opt);
00075 
00076 PR_END_EXTERN_C
00077 
00078 #endif /* defined(PLGETOPT_H_) */
00079 
00080 /* plgetopt.h */
00081