OpenSpace/include/openspace/scene/profile.h

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2020                                                               *
 *                                                                                       *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this  *
 * software and associated documentation files (the "Software"), to deal in the Software *
 * without restriction, including without limitation the rights to use, copy, modify,    *
 * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to    *
 * permit persons to whom the Software is furnished to do so, subject to the following   *
 * conditions:                                                                           *
 *                                                                                       *
 * The above copyright notice and this permission notice shall be included in all copies *
 * or substantial portions of the Software.                                              *
 *                                                                                       *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,   *
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A         *
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT    *
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF  *
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE  *
 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                                         *
 ****************************************************************************************/

#ifndef __OPENSPACE_CORE___PROFILE___H__
#define __OPENSPACE_CORE___PROFILE___H__

#include <openspace/interaction/navigationhandler.h>
#include <openspace/scene/scenegraphnode.h>
#include <ghoul/misc/easing.h>
#include <ghoul/misc/exception.h>
#include <mutex>
#include <optional>
#include <set>
#include <unordered_map>
#include <variant>
#include <vector>

namespace ghoul { class Dictionary; }
namespace ghoul::opengl { class ProgramObject; }

namespace openspace {

namespace documentation { struct Documentation; }
namespace scripting { struct LuaLibrary; }

struct ProfileData {
    // Version
    struct Version {
        int major = 0;
        int minor = 0;
        int patch = 0;
    };
    Version version = { 1, 0, 0 };

    struct Module {
        std::string name;
        std::string loadedInstruction;
        std::string notLoadedInstruction;
    };
    std::vector<Module> modules;

    struct Asset {
        enum class Type {
            Require,
            Request
        };

        std::string path;
        Type type;
        std::string name;
    };
    std::vector<Asset> assets;

    struct Property {
        enum class SetType {
            SetPropertyValue,
            SetPropertyValueSingle
        };

        SetType setType;
        std::string name;
        std::string value;
    };
    std::vector<Property> properties;

    struct Keybinding {
        std::string key; // @TODO (abock, 2020-06-16) change to key+action
        std::string documentation;
        std::string name;
        std::string guiPath;
        bool isLocal;
        std::string script;
    };
    std::vector<Keybinding> keybindings;

    struct Time {
        enum class Type {
            Absolute,
            Relative
        };

        Type type;
        std::string time;
    };
    Time time;

    struct CameraNavState {
        static constexpr const char* Type = "setNavigationState";

        std::string anchor;
        std::string aim;
        std::string referenceFrame;
        std::string position; // @TODO (abock, 2020-06-17) change to vec3
        std::string up;// @TODO (abock, 2020-06-17) change to vec3
        std::string yaw;
        std::string pitch;
    };
    struct CameraGoToGeo {
        static constexpr const char* Type = "goToGeo";

        std::string anchor;
        double latitude;
        double longitude;
        std::optional<double> altitude;
    };
    using CameraType = std::variant<CameraNavState, CameraGoToGeo>;
    CameraType camera;

    std::vector<std::string> markNodes;
};

class Profile {
public:
    enum class AssetEventType {
        Add,
        Require,
        Request,
        Remove,
        Ignore
    };

    struct AssetEvent {
        std::string name;
        AssetEventType eventType;
    };

    Profile() = default;
    explicit Profile(const std::string& filename);

    virtual ~Profile() {};

    /**
     * Saves all current settings, starting from the profile that was loaded at startup,
     * and all of the property & asset changes that were made since startup.
     * \param filename The filename of the new profile to be saved
     */
    void saveCurrentSettingsToProfile(const std::string& filename);

    /**
     * Saves all current settings, similar to saveCurrentSettingsToProfile() except the
     * output is a string without writing to a file.
     */
    //std::string saveCurrentSettingsToProfile_string();

    /**
     * Returns the Lua library that contains all Lua functions available to provide
     * profile functionality.
     * \return The Lua library that contains all Lua functions available for profiles
     */
    static scripting::LuaLibrary luaLibrary();

    ProfileData profile;

protected:
    std::string _profileBaseDirectory = "${ASSETS}";

private:
    struct AllAssetDetails {
        std::vector<AssetEvent> base;
        std::vector<AssetEvent> changed;
    };
    virtual std::string initialProfile() const;
    virtual std::string profileBaseDirectory() const;
    virtual std::vector<AssetEvent> assetEvents() const;

    std::vector<AssetEvent> modifyAssetsToReflectChanges(ProfileData& ps);
    void parseAssetFileLines(std::vector<AssetEvent>& results, ProfileData& ps);

    void modifyPropertiesToReflectChanges(ProfileData& ps);
    virtual std::vector<openspace::properties::Property*> changedProperties();
    std::string getFullPropertyPath(openspace::properties::Property* prop);
    virtual std::string currentTimeUTC() const;
    virtual interaction::NavigationHandler::NavigationState currentCameraState() const;
};


std::string serialize(const ProfileData& ps);
ProfileData deserialize(const std::vector<std::string>& content);

std::string convertToSceneFile(const ProfileData& ps);

/**
 * Reads in a .profile file, converts it to scene/asset equivalent syntax, and
 * writes the result to the specified output path.
 * \param inProfilePath The .profile file to be converted
 * \param outFilePath The output file path that will be written with the converted
 *                       contents (in an .asset file)
 */
void convertProfileToScene(const std::string& inProfilePath,
    const std::string& outFilePath);


} // namespace openspace

#endif // __OPENSPACE_CORE___PROFILE___H__