diff options
Diffstat (limited to 'platform/darwin/src/MGLSource_Private.h')
-rw-r--r-- | platform/darwin/src/MGLSource_Private.h | 89 |
1 files changed, 0 insertions, 89 deletions
diff --git a/platform/darwin/src/MGLSource_Private.h b/platform/darwin/src/MGLSource_Private.h deleted file mode 100644 index 4a7c31694d..0000000000 --- a/platform/darwin/src/MGLSource_Private.h +++ /dev/null @@ -1,89 +0,0 @@ -#import "MGLSource.h" - -#include <memory> - - -NS_ASSUME_NONNULL_BEGIN - -namespace mbgl { - namespace style { - class Source; - } -} - -// A struct to be stored in the `peer` member of mbgl::style::Source, in order to implement -// object identity. We don't store a MGLSource pointer directly because that doesn't -// interoperate with ARC. The inner pointer is weak in order to avoid a reference cycle for -// "pending" MGLSources, which have a strong owning pointer to the mbgl::style::Source. -struct SourceWrapper { - __weak MGLSource *source; -}; - -/** - Assert that the style source is valid. - - This macro should be used at the beginning of any public-facing instance method - of `MGLSource` and its subclasses. For private methods, an assertion is more appropriate. - */ -#define MGLAssertStyleSourceIsValid() \ -do { \ - if (!self.rawSource) { \ - [NSException raise:MGLInvalidStyleSourceException \ - format:@"This source got invalidated after the style change"]; \ - } \ -} while (NO); - -@class MGLMapView; - -@interface MGLSource (Private) - -/** - Initializes and returns a source with a raw pointer to the backing store, - associated with a style. - */ -- (instancetype)initWithRawSource:(mbgl::style::Source *)rawSource mapView:(nullable MGLMapView *)mapView; - -/** - Initializes and returns a source with an owning pointer to the backing store, - unassociated from a style. - */ -- (instancetype)initWithPendingSource:(std::unique_ptr<mbgl::style::Source>)pendingSource; - -/** - A raw pointer to the mbgl object, which is always initialized, either to the - value returned by `mbgl::Map getSource`, or for independently created objects, - to the pointer value held in `pendingSource`. In the latter case, this raw - pointer value stays even after ownership of the object is transferred via - `mbgl::Map addSource`. - */ -@property (nonatomic, readonly) mbgl::style::Source *rawSource; - -/** - The map view whose style currently contains the source. - If the source is not currently part of any map view’s style, this property is - set to `nil`. - */ -@property (nonatomic, readonly, weak) MGLMapView *mapView; - -/** - Adds the mbgl source that this object represents to the mbgl map. - Once a mbgl source is added, ownership of the object is transferred to the - `mbgl::Map` and this object no longer has an active unique_ptr reference to the - `mbgl::Source`. If this object's mbgl source is in that state, the mbgl source - can still be changed but the changes will not be visible until the `MGLSource` - is added back to the map via `-[MGLStyle addSource:]` and styled with a - `MGLLayer`. - */ -- (void)addToMapView:(MGLMapView *)mapView; - -/** - Removes the mbgl source that this object represents from the mbgl map. - When a mbgl source is removed, ownership of the object is transferred back - to the `MGLSource` instance and the unique_ptr reference is valid again. It is - safe to add the source back to the style after it is removed. - */ -- (BOOL)removeFromMapView:(MGLMapView *)mapView error:(NSError * __nullable * __nullable)outError; - -@end - -NS_ASSUME_NONNULL_END |