i_application_info.hpp

Go to the documentation of this file.

// i_application_info.hpp
/*
 *  Copyright (c) 2007 Leigh Johnston.
 *
 *  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 Leigh Johnston nor the names of any
 *       other contributors to this software 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 AND CONTRIBUTORS "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.
*/
 
#pragma once
 
#include <neolib/neolib.hpp>
#include <neolib/core/i_vector.hpp>
#include <neolib/core/i_string.hpp>
#include <neolib/app/i_version.hpp>
 
namespace neolib
{
    struct unknown_application_name : std::logic_error { unknown_application_name() : std::logic_error{ "neolib::unknown_application_name " } {} };
 
    class i_program_arguments
    {
    public:
        typedef i_program_arguments abstract_type;
    public:
        virtual ~i_program_arguments() = default;
    public:
        virtual int argc() const = 0;
        virtual char** argv() const = 0;
        virtual const i_vector<i_string>& as_vector() const = 0;
    };
 
    class i_application_info
    {
    public:
        virtual ~i_application_info() = default;
    public:
        virtual const i_program_arguments& arguments() const = 0;
        virtual const i_string& name() const = 0;
        virtual const i_string& company() const = 0;
        virtual const i_version& version() const = 0;
        virtual const i_string& copyright() const = 0;
        virtual const i_string& application_folder(bool aUseDefault = true) const = 0;
        virtual const i_string& settings_folder(bool aUseDefault = true) const = 0;
        virtual const i_string& data_folder(bool aUseDefault = true) const = 0;
        virtual const i_string& plugin_extension() const = 0;
        virtual bool removable() const = 0;
    };
}