permissions.hpp

Go to the documentation of this file.

#pragma once
 
// Cross-platform runtime permission queries and requests.
//
// Mobile platforms (iOS, Android) require explicit user consent for
// microphone, camera, Bluetooth, and notifications. Desktop platforms
// usually don't gate these through an app-level permission prompt, so
// their backends treat most classes as `Granted` and some as
// `Restricted` (e.g. Android's `ForegroundService`).
//
// The contract deliberately stays small:
//   query(p)    — synchronous, never blocks, never prompts.
//   request(p)  — async, always invokes the callback exactly once.
//
// Tests can redirect the backend with `PermissionsOverride` without
// touching the platform implementation.
 
#include <functional>
 
namespace pulp::platform {
 
enum class Permission {
    Microphone,         // iOS mic, Android RECORD_AUDIO
    Camera,             // iOS/Android camera
    BluetoothMidi,      // iOS NSBluetoothAlwaysUsageDescription, Android BLUETOOTH_*
    LocalNetwork,       // iOS NSLocalNetworkUsageDescription (RTP-MIDI, bonjour)
    Notifications,      // iOS UNUserNotificationCenter, Android POST_NOTIFICATIONS
    BackgroundAudio,    // iOS UIBackgroundModes=audio capability
    ForegroundService,  // Android FOREGROUND_SERVICE / FOREGROUND_SERVICE_MICROPHONE
};
 
enum class PermissionState {
    NotDetermined,  // Never asked. On platforms without a prompt, backends use Granted instead.
    Granted,        // User (or OS policy) granted it.
    Denied,         // User denied; may be re-askable depending on platform.
    Restricted,     // Policy / parental-control / unsupported-on-platform.
};
 
using RequestCallback = std::function<void(PermissionState)>;

PermissionState query(Permission p);

void request(Permission p, RequestCallback cb);

bool has_platform_backend();

class PermissionsOverride {
public:
    PermissionsOverride();
    ~PermissionsOverride();
 
    PermissionsOverride(const PermissionsOverride&) = delete;
    PermissionsOverride& operator=(const PermissionsOverride&) = delete;

    void set(Permission p, PermissionState state);

    void clear(Permission p);
 
private:
    struct Impl;
    Impl* impl_;
};
 
}  // namespace pulp::platform