tdecmdlineargs.h

/* This file is part of the KDE project
   Copyright (C) 1999 Waldo Bastian <bastian@kde.org>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.
 
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
 
#ifndef _TDECMDLINEARGS_H_
#define _TDECMDLINEARGS_H_
 
#include "tdelibs_export.h"
#include <kurl.h>
 
#include <tqptrlist.h>
#include <tqstring.h>
#include <tqvaluelist.h>
 
typedef TQValueList<TQCString> QCStringList;

struct TDECORE_EXPORT TDECmdLineOptions
{
   const char *name;
   const char *description;
   const char *def; // Default
};
 
#define TDECmdLineLastOption { 0, 0, 0 }
 
class TDECmdLineArgsList;
class TDEApplication;
class KUniqueApplication;
class TDECmdLineParsedOptions;
class TDECmdLineParsedArgs;
class TDEAboutData;
class TDECmdLineArgsPrivate;

class TDECORE_EXPORT TDECmdLineArgs
{
  friend class TDEApplication;
  friend class KUniqueApplication;
  friend class TQPtrList<TDECmdLineArgs>;
public:
  // Static functions:

   static void init(int _argc, char **_argv, const char *_appname,
                    const char* programName, const char *_description,
                    const char *_version, bool noKApp = false);
  static void init(int _argc, char **_argv,
                   const char *_appname, const char *_description,
                   const char *_version, bool noKApp = false) TDE_DEPRECATED;

  static void init(int _argc, char **_argv,
                   const TDEAboutData *about, bool noKApp = false);

  static void init(const TDEAboutData *about);

  static void addCmdLineOptions( const TDECmdLineOptions *options,
                 const char *name=0, const char *id = 0,
                 const char *afterId=0);

  static TDECmdLineArgs *parsedArgs(const char *id=0);

  static TQString cwd();

  static const char *appName();

  static void usage(const char *id = 0);

  static void usage(const TQString &error);

  static void enable_i18n();
 
  // Member functions:
 

  TQCString getOption(const char *option) const;

  QCStringList getOptionList(const char *option) const;

  bool isSet(const char *option) const;

  int count() const;

  const char *arg(int n) const;

  KURL url(int n) const;

  static KURL makeURL( const char * urlArg );

  static void setCwd( char * cwd ) { mCwd = cwd; }

  void clear();

  static void reset();

  static void loadAppArgs( TQDataStream &);

  static void addTempFileOption();
 
  // this avoids having to know the "id" used by addTempFileOption
  // but this approach doesn't scale well, we can't have 50 standard options here...
  static bool isTempFileSet();
 
protected:
  TDECmdLineArgs( const TDECmdLineOptions *_options, const char *_name,
                const char *_id);

  ~TDECmdLineArgs();
 
private:
  static void findOption(const char *_opt, TQCString opt, int &i, bool enabled, bool &moreOptions);

  static void parseAllArgs();

  static int *tqt_argc();

 
  static char ***tqt_argv();

  static void removeArgs(const char *id);

  static void saveAppArgs( TQDataStream &);

  void setOption(const TQCString &option, bool enabled);

  void setOption(const TQCString &option, const char *value);

  void addArgument(const char *argument);

  void save( TQDataStream &) const;

  void load( TQDataStream &);

  static void initIgnore(int _argc, char **_argv, const char *_appname);
 
  static void printQ(const TQString &msg);
 
  const TDECmdLineOptions *options;
  const char *name;
  const char *id;
  TDECmdLineParsedOptions *parsedOptionList;
  TDECmdLineParsedArgs *parsedArgList;
  bool isQt;
 
  static TDECmdLineArgsList *argsList; // All options.
  static const TDEAboutData *about;
 
  static int argc; // The original argc
  static char **argv; // The original argv
  static bool parsed; // Whether we have parsed the arguments since calling init
  static bool ignoreUnknown; // Ignore unknown options and arguments
  static char *mCwd; // Current working directory. Important for KUnqiueApp!
  static bool parseArgs;
 
  TDECmdLineArgsPrivate *d;
};
 
#endif