platform.hpp

Go to the documentation of this file.

/*
    Copyright 2021 natinusala
    Copyright 2023 xfangfang
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
        http://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/
 
#pragma once
 
#include <functional>
#include <string>
#include <vector>
#include <aurore/core/audio.hpp>
#include <aurore/core/font.hpp>
#include <aurore/core/i18n.hpp>
#include <aurore/core/ime.hpp>
#include <aurore/core/input.hpp>
#include <aurore/core/theme.hpp>
#include <aurore/core/video.hpp>
 
namespace aurore
{
 
// Interface to provide everything platform specific required to run Aurore: graphics context, inputs, audio...
// The best platform is automatically selected when the application starts, and cannot be changed by the user at the moment
class Platform
{
  public:
    virtual ~Platform() = default;
    ;
 
    virtual void createWindow(std::string title, uint32_t width, uint32_t height, float windowXPos = NAN, float windowYPos = NAN) = 0;
 
    virtual void restoreWindow() {};
 
    virtual void setWindowSize(uint32_t windowWidth, uint32_t windowHeight) {};
 
    virtual void setWindowSizeLimits(uint32_t windowMinWidth, uint32_t windowMinHeight, uint32_t windowMaxWidth, uint32_t windowMaxHeight) {};
 
    virtual void setWindowPosition(int windowXPos, int windowYPos) {};
 
    virtual void setWindowState(uint32_t windowWidth, uint32_t windowHeight, int windowXPos, int windowYPos) {};
 
    virtual std::string getName() = 0;
 
    virtual bool hasWirelessConnection() { return false; };
 
    virtual int getWirelessLevel() = 0;
 
    virtual bool hasEthernetConnection() { return false; };
 
    virtual std::string getIpAddress() = 0;
 
    virtual std::string getDnsServer() = 0;
 
    virtual bool canShowBatteryLevel() { return true; }
 
    virtual bool canShowWirelessLevel() { return true; }
 
    virtual int getBatteryLevel() = 0;
 
    virtual bool isBatteryCharging() = 0;
 
    virtual void disableScreenDimming(bool disable, const std::string& reason = "disable dimming", const std::string& app = "aurore") = 0;
 
    virtual bool isScreenDimmingDisabled() = 0;
 
    virtual void setBacklightBrightness(float brightness) = 0;
 
    virtual float getBacklightBrightness() = 0;
 
    virtual bool canSetBacklightBrightness() = 0;
 
    virtual void setWindowAlwaysOnTop(bool enable) { }
 
    virtual bool mainLoopIteration() = 0;
 
    virtual bool runLoop(const std::function<bool()>& runLoopImpl) { return runLoopImpl(); }
 
    virtual ThemeVariant getThemeVariant() = 0;
 
    virtual void setThemeVariant(ThemeVariant theme) = 0;
 
    virtual std::string getLocale() = 0;
 
    virtual AudioPlayer* getAudioPlayer() = 0;
 
    virtual VideoContext* getVideoContext() = 0;
 
    virtual InputManager* getInputManager() = 0;
 
    virtual ImeManager* getImeManager() = 0;
 
    virtual FontLoader* getFontLoader() = 0;
 
    virtual bool isApplicationMode() = 0;
 
    virtual void exitToHomeMode(bool value) = 0;
 
    virtual void forceEnableGamePlayRecording() = 0;
 
    virtual void openBrowser(std::string url) = 0;
 
    static bool isBrowserUrl(const std::string& url);
 
    static inline std::vector<std::string> BROWSER_URL_SCHEMES = { "http", "https" };
 
    virtual void pasteToClipboard(const std::string& text) {};
 
    virtual std::string pasteFromClipboard() { return ""; };
 
    static Platform* createPlatform();
 
    static void setFactory(std::function<Platform*()> factory) { Platform::factory = std::move(factory); }
 
    // From the text itself, not LOCALE_AUTO: that is another const string in
    // each file (internal linkage), not yet built when this inline one is.
    static inline std::string APP_LOCALE_DEFAULT = "auto";
 
  private:
    static inline std::function<Platform*()> factory;
};
 
} // namespace aurore