kcmdlineargs.h

Go to the documentation of this file.

/* 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 KCMDLINEARGS_H
#define KCMDLINEARGS_H

#include <kdecore_export.h>
#include <QtCore/QBool>

#include <klocale.h>

template <class T> class QList;
class QString;
class QStringList;
class QByteArray;
class QDataStream;
class KUrl;

class KCmdLineArgs;
class KCmdLineArgsPrivate;
class KCmdLineArgsStatic;
class KCmdLineOptionsPrivate;

class KDECORE_EXPORT KCmdLineOptions
{
    friend class KCmdLineArgs;
    friend class KCmdLineArgsStatic;

    public:
    KCmdLineOptions ();

    KCmdLineOptions (const KCmdLineOptions &options);

    KCmdLineOptions& operator= (const KCmdLineOptions &options);

    ~KCmdLineOptions ();

    KCmdLineOptions &add (const QByteArray &name,
                          const KLocalizedString &description = KLocalizedString(),
                          const QByteArray &defaultValue = QByteArray());

    KCmdLineOptions &add (const KCmdLineOptions &options);

    private:

    KCmdLineOptionsPrivate *d; //krazy:exclude=dpointer (for operator=)
};

class KCmdLineArgsList;
class KApplication;
class KAboutData;

class KDECORE_EXPORT KCmdLineArgs
{
  friend class KApplication;
  friend class KCmdLineArgsList;
  friend class KCmdLineArgsStatic;
public:
  // Static functions:

  enum StdCmdLineArg {
    CmdLineArgQt = 0x01,
    CmdLineArgKDE = 0x02,
    CmdLineArgsMask=0x03,
    CmdLineArgNone = 0x00,
    Reserved = 0xff
  };
  Q_DECLARE_FLAGS(StdCmdLineArgs, StdCmdLineArg)
   static void init(int argc, char **argv,
                    const QByteArray &appname,
                    const QByteArray &catalog,
                    const KLocalizedString &programName,
                    const QByteArray &version,
                    const KLocalizedString &description = KLocalizedString(),
                    StdCmdLineArgs stdargs=StdCmdLineArgs(CmdLineArgQt|CmdLineArgKDE));

  static void init(int _argc,
                   char **_argv,
                   const KAboutData *about,
                   StdCmdLineArgs stdargs=StdCmdLineArgs(CmdLineArgQt|CmdLineArgKDE));
  static void init(const KAboutData *about);

  static void addStdCmdLineOptions(StdCmdLineArgs stdargs=StdCmdLineArgs(CmdLineArgQt|CmdLineArgKDE));

  static void addCmdLineOptions(const KCmdLineOptions &options,
                                const KLocalizedString &name = KLocalizedString(),
                                const QByteArray &id = QByteArray(),
                                const QByteArray &afterId = QByteArray());

  static KCmdLineArgs *parsedArgs(const QByteArray &id = QByteArray());

  static QString cwd();

  static QString appName();

  static void usage(const QByteArray &id = QByteArray());

  static void usageError(const QString &error);

  static void enable_i18n();

  // Member functions:


  QString getOption(const QByteArray &option) const;

  QStringList getOptionList(const QByteArray &option) const;

  bool isSet(const QByteArray &option) const;

  int count() const;

  QString arg(int n) const;

  KUrl url(int n) const;

  static KUrl makeURL( const QByteArray &urlArg );

  static void setCwd( const QByteArray &cwd );

  void clear();

  static void reset();

  static void loadAppArgs( QDataStream &);

  static void saveAppArgs( QDataStream &);

  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();

  static int &qtArgc();

  static char **qtArgv();

  static QStringList allArguments();

  static const KAboutData *aboutData();

protected:
  KCmdLineArgs( const KCmdLineOptions &_options, const KLocalizedString &_name,
                const QByteArray &_id);

  ~KCmdLineArgs();

private:

  static void initIgnore(int _argc, char **_argv, const QByteArray &_appname);

  KCmdLineArgsPrivate *const d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KCmdLineArgs::StdCmdLineArgs)

#endif