Application.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIBAPP_APPLICATION_H
#define __LIBAPP_APPLICATION_H
 
#include <Types.h>
#include <Macros.h>
#include <Log.h>
#include "ArgumentParser.h"
#include "ArgumentContainer.h"
 
class Application
{
  private:
 
    static const uint ExitSuccess = 0;
 
    static const uint ExitFailure = 1;
 
  public:
 
    enum Result
    {
        Success,
        NotFound,
        IOError,
        InvalidArgument,
        ShowUsage,
        TimedOut,
        OutOfMemory
    };
 
  public:
 
    Application(int argc, char **argv);
 
    virtual ~Application();
 
    virtual int run();
 
  protected:
 
    virtual Result initialize();
 
    virtual Result exec() = 0;
 
    virtual Result output(const char *string) const = 0;
 
    virtual Result output(String & string) const;
 
  protected:
 
    ArgumentParser & parser();
 
    const ArgumentParser & parser() const;
 
    const ArgumentContainer & arguments() const;
 
    void setVersion(const String & version);
 
  private:
 
    void usage() const;
 
  protected:
 
    int m_argc;
 
    char ** m_argv;
 
  private:
 
    ArgumentParser m_parser;
 
    ArgumentContainer m_arguments;
 
    String m_version;
};
 
#endif /* __LIBAPP_APPLICATION_H */