Application.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2014  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   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; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_Application_hxx
#define __ccxx_Application_hxx

#include <commonc++/Common.h++>
#include <commonc++/String.h++>

#include <cstddef>

namespace ccxx {

class COMMONCPP_API Application
{
 private:

  class CommandOption
  {
    friend class Application;

   protected:

    char _opt;
    String _longOpt;
    bool _hasArg;
    String _argName;
    String _argDesc;

    CommandOption(char opt, const String& longOpt, const String& argName,
                  const String& argDesc);

    inline bool hasOpt() const
    { return(_opt != NUL); }

    inline bool hasLongOpt() const
    { return(! _longOpt.isNull()); }

    inline char getOpt() const
    { return (_opt); }

    inline String getLongOpt() const
    { return(_longOpt); }

    inline bool hasArg() const { return(_hasArg); }

    inline const String& getArgDesc() const { return(_argDesc); }
    inline const String& getArgName() const { return(_argName); }
  };

  class CommandOptionList; // fwd decl

 public:

  Application(int argc, char** argv, const String& version = "0.0",
              const String& compileDate = "",
              const String& compileTime = "");

  virtual ~Application();

 protected:

  virtual void shutdown();

  bool registerOption(char opt, const String& longOpt,
                      const String& argName, const String& desc);

  bool parseOptions(int argc, char** argv, int& index);

  virtual bool processOption(char opt, const String& longOpt,
                             const String& arg = String::null);

  virtual void printUsage();

  void printError(const char* message, ...);

  String _version;
  String _compileDate;
  String _compileTime;
  CommandOptionList* _options;
  int _numLongOpts;
 private:

  void buildUsageText();
  void doShutdown();

  bool _argsParsed;
  bool _useStyles;
  String _helpText;
  String _optString;

  static Application* _instance;

  static void _sighandler(int sig);
};

} // namespace ccxx

#endif // __ccxx_Application_hxx