1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
|
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_SERVICES_APP_SERVICE_PUBLIC_CPP_CAPABILITY_ACCESS_UPDATE_H_
#define COMPONENTS_SERVICES_APP_SERVICE_PUBLIC_CPP_CAPABILITY_ACCESS_UPDATE_H_
#include <optional>
#include <string>
#include "base/component_export.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/raw_ref.h"
#include "components/account_id/account_id.h"
#include "components/services/app_service/public/cpp/capability_access.h"
namespace apps {
// Wraps two apps::CapabilityAccessPtr's, a prior state and a delta on
// top of that state. The state is conceptually the "sum" of all of the previous
// deltas, with "addition" or "merging" simply being that the most recent
// version of each field "wins".
//
// The state may be nullptr, meaning that there are no previous deltas.
// Alternatively, the delta may be nullptr, meaning that there is no change in
// state. At least one of state and delta must be non-nullptr.
//
// The combination of the two (state and delta) can answer questions such as:
// - Whether the app is accessing the camera? If the delta knows, that's the
// answer. Otherwise, ask the state.
// - Whether the app is accessing the microphone? If the delta knows, that's
// the answer. Otherwise, ask the state.
//
// An CapabilityAccessUpdate is read-only once constructed. All of its fields
// and methods are const. The constructor caller must guarantee that the
// CapabilityAccessPtr references remain valid for the lifetime of the
// CapabilityAccessUpdate.
//
// See components/services/app_service/README.md for more details.
class COMPONENT_EXPORT(APP_UPDATE) CapabilityAccessUpdate {
public:
// Modifies |state| by copying over all of |delta|'s known fields: those
// fields whose values aren't "unknown". The |state| may not be nullptr.
static void Merge(CapabilityAccess* state, const CapabilityAccess* delta);
// At most one of |state| or |delta| may be nullptr.
CapabilityAccessUpdate(const CapabilityAccess* state,
const CapabilityAccess* delta,
const AccountId& account_id);
CapabilityAccessUpdate(const CapabilityAccessUpdate&) = delete;
CapabilityAccessUpdate& operator=(const CapabilityAccessUpdate&) = delete;
// Returns whether this is the first update for the given AppId.
// Equivalently, there are no previous deltas for the AppId.
bool StateIsNull() const;
const std::string& AppId() const;
std::optional<bool> Camera() const;
bool CameraChanged() const;
std::optional<bool> Microphone() const;
bool MicrophoneChanged() const;
const ::AccountId& AccountId() const;
// Returns true if this update is accessing any capability (i.e. Camera() or
// Microphone() returns true).
bool IsAccessingAnyCapability() const;
private:
raw_ptr<const CapabilityAccess> state_ = nullptr;
raw_ptr<const CapabilityAccess, DanglingUntriaged> delta_ = nullptr;
const raw_ref<const ::AccountId> account_id_;
};
// For logging and debug purposes.
COMPONENT_EXPORT(APP_UPDATE)
std::ostream& operator<<(std::ostream& out,
const CapabilityAccessUpdate& update);
} // namespace apps
#endif // COMPONENTS_SERVICES_APP_SERVICE_PUBLIC_CPP_CAPABILITY_ACCESS_UPDATE_H_
|