Application.hpp

Go to the documentation of this file.

/*
# Copyright (c) 2014-2016, NVIDIA CORPORATION. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#  * Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#  * Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#  * Neither the name of NVIDIA CORPORATION nor the names of its
#    contributors may be used to endorse or promote products derived
#    from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef NVXIO_APPLICATION_HPP
#define NVXIO_APPLICATION_HPP

#include <initializer_list>
#include <limits>
#include <memory>
#include <string>
#include <vector>

#include "OptionHandler.hpp"

namespace nvxio
{
class NVXIO_EXPORT Application
{
public:
    enum ApplicationExitCode
    {
        APP_EXIT_CODE_SUCCESS               = 0,
        APP_EXIT_CODE_ERROR                 = 1,
        APP_EXIT_CODE_NO_MEMORY             = 2,
        APP_EXIT_CODE_NO_RESOURCE           = 3,
        APP_EXIT_CODE_NO_FRAMESOURCE        = 4,
        APP_EXIT_CODE_NO_RENDER             = 5,
        APP_EXIT_CODE_INVALID_GRAPH         = 6,
        APP_EXIT_CODE_INVALID_VALUE         = 7,
        APP_EXIT_CODE_INVALID_DIMENSIONS    = 8,
        APP_EXIT_CODE_INVALID_FORMAT        = 9,
        APP_EXIT_CODE_CAN_NOT_CREATE        = 10,
        // add new codes here
    };

    static Application &get();

    virtual ~Application();

    virtual void addBooleanOption(char shortName, const std::string &longName,
                                  const std::string &description,
                                  bool *result) = 0;

    virtual void addOption(char shortName, const std::string &longName,
                           const std::string &description,
                           OptionHandler::ptr handler) = 0;

    virtual void allowPositionalParameters(const std::string &placeholder,
                                           std::vector<std::string> *result) = 0;

    virtual void setDescription(const std::string &description) = 0;

    virtual void init(int &argc, char **argv) = 0;
    virtual bool initGui() = 0;

    virtual std::string getScenarioName() const = 0;
    virtual int getScenarioLoopCount() const = 0;
    virtual std::string getEventLogName() const = 0;
    virtual bool getEventLogDumpFramesFlag() const = 0;
    virtual bool getVerboseFlag() const = 0;
    virtual bool getFullScreenFlag() const = 0;
    virtual std::string getPreferredRenderName() const = 0;

    virtual std::string findSampleFilePath(const std::string& filename) const = 0;

    virtual std::string findLibraryFilePath(const std::string& filename) const = 0;

    virtual int getSourceDefaultTimeout() const = 0;
    virtual void setSourceDefaultTimeout(int timeout) = 0;

    virtual double getFPSLimit() const = 0;

#ifdef __GNUC__
    __attribute__((deprecated("use SyncTimer instead")))
#endif
    virtual bool sleepToLimitFPS(double totalProcessTimeMs, double fpsLimit = 0) = 0;
};

}

#endif // NVXIO_APPLICATION_HPP