This repository has been archived by the owner on Feb 22, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
[path_provider] Migrated path_provider_ios to pigeon. #5944
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
28 changes: 28 additions & 0 deletions
28
packages/path_provider/path_provider_ios/ios/Classes/messages.g.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
// Copyright 2013 The Flutter Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
// Autogenerated from Pigeon (v3.1.5), do not edit directly. | ||
// See also: https://pub.dev/packages/pigeon | ||
#import <Foundation/Foundation.h> | ||
@protocol FlutterBinaryMessenger; | ||
@protocol FlutterMessageCodec; | ||
@class FlutterError; | ||
@class FlutterStandardTypedData; | ||
|
||
NS_ASSUME_NONNULL_BEGIN | ||
|
||
/// The codec used by FLTPathProviderApi. | ||
NSObject<FlutterMessageCodec> *FLTPathProviderApiGetCodec(void); | ||
|
||
@protocol FLTPathProviderApi | ||
- (nullable NSString *)getTemporaryPathWithError:(FlutterError *_Nullable *_Nonnull)error; | ||
- (nullable NSString *)getApplicationSupportPathWithError:(FlutterError *_Nullable *_Nonnull)error; | ||
- (nullable NSString *)getLibraryPathWithError:(FlutterError *_Nullable *_Nonnull)error; | ||
- (nullable NSString *)getApplicationDocumentsPathWithError: | ||
(FlutterError *_Nullable *_Nonnull)error; | ||
@end | ||
|
||
extern void FLTPathProviderApiSetup(id<FlutterBinaryMessenger> binaryMessenger, | ||
NSObject<FLTPathProviderApi> *_Nullable api); | ||
|
||
NS_ASSUME_NONNULL_END |
138 changes: 138 additions & 0 deletions
138
packages/path_provider/path_provider_ios/ios/Classes/messages.g.m
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,138 @@ | ||
// Copyright 2013 The Flutter Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
// Autogenerated from Pigeon (v3.1.5), do not edit directly. | ||
// See also: https://pub.dev/packages/pigeon | ||
#import "messages.g.h" | ||
#import <Flutter/Flutter.h> | ||
|
||
#if !__has_feature(objc_arc) | ||
#error File requires ARC to be enabled. | ||
#endif | ||
|
||
static NSDictionary<NSString *, id> *wrapResult(id result, FlutterError *error) { | ||
NSDictionary *errorDict = (NSDictionary *)[NSNull null]; | ||
if (error) { | ||
errorDict = @{ | ||
@"code" : (error.code ?: [NSNull null]), | ||
@"message" : (error.message ?: [NSNull null]), | ||
@"details" : (error.details ?: [NSNull null]), | ||
}; | ||
} | ||
return @{ | ||
@"result" : (result ?: [NSNull null]), | ||
@"error" : errorDict, | ||
}; | ||
} | ||
|
||
@interface FLTPathProviderApiCodecReader : FlutterStandardReader | ||
@end | ||
@implementation FLTPathProviderApiCodecReader | ||
@end | ||
|
||
@interface FLTPathProviderApiCodecWriter : FlutterStandardWriter | ||
@end | ||
@implementation FLTPathProviderApiCodecWriter | ||
@end | ||
|
||
@interface FLTPathProviderApiCodecReaderWriter : FlutterStandardReaderWriter | ||
@end | ||
@implementation FLTPathProviderApiCodecReaderWriter | ||
- (FlutterStandardWriter *)writerWithData:(NSMutableData *)data { | ||
return [[FLTPathProviderApiCodecWriter alloc] initWithData:data]; | ||
} | ||
- (FlutterStandardReader *)readerWithData:(NSData *)data { | ||
return [[FLTPathProviderApiCodecReader alloc] initWithData:data]; | ||
} | ||
@end | ||
|
||
NSObject<FlutterMessageCodec> *FLTPathProviderApiGetCodec() { | ||
static dispatch_once_t sPred = 0; | ||
static FlutterStandardMessageCodec *sSharedObject = nil; | ||
dispatch_once(&sPred, ^{ | ||
FLTPathProviderApiCodecReaderWriter *readerWriter = | ||
[[FLTPathProviderApiCodecReaderWriter alloc] init]; | ||
sSharedObject = [FlutterStandardMessageCodec codecWithReaderWriter:readerWriter]; | ||
}); | ||
return sSharedObject; | ||
} | ||
|
||
void FLTPathProviderApiSetup(id<FlutterBinaryMessenger> binaryMessenger, | ||
NSObject<FLTPathProviderApi> *api) { | ||
{ | ||
FlutterBasicMessageChannel *channel = [[FlutterBasicMessageChannel alloc] | ||
initWithName:@"dev.flutter.pigeon.PathProviderApi.getTemporaryPath" | ||
binaryMessenger:binaryMessenger | ||
codec:FLTPathProviderApiGetCodec()]; | ||
if (api) { | ||
NSCAssert( | ||
[api respondsToSelector:@selector(getTemporaryPathWithError:)], | ||
@"FLTPathProviderApi api (%@) doesn't respond to @selector(getTemporaryPathWithError:)", | ||
api); | ||
[channel setMessageHandler:^(id _Nullable message, FlutterReply callback) { | ||
FlutterError *error; | ||
NSString *output = [api getTemporaryPathWithError:&error]; | ||
callback(wrapResult(output, error)); | ||
}]; | ||
} else { | ||
[channel setMessageHandler:nil]; | ||
} | ||
} | ||
{ | ||
FlutterBasicMessageChannel *channel = [[FlutterBasicMessageChannel alloc] | ||
initWithName:@"dev.flutter.pigeon.PathProviderApi.getApplicationSupportPath" | ||
binaryMessenger:binaryMessenger | ||
codec:FLTPathProviderApiGetCodec()]; | ||
if (api) { | ||
NSCAssert([api respondsToSelector:@selector(getApplicationSupportPathWithError:)], | ||
@"FLTPathProviderApi api (%@) doesn't respond to " | ||
@"@selector(getApplicationSupportPathWithError:)", | ||
api); | ||
[channel setMessageHandler:^(id _Nullable message, FlutterReply callback) { | ||
FlutterError *error; | ||
NSString *output = [api getApplicationSupportPathWithError:&error]; | ||
callback(wrapResult(output, error)); | ||
}]; | ||
} else { | ||
[channel setMessageHandler:nil]; | ||
} | ||
} | ||
{ | ||
FlutterBasicMessageChannel *channel = [[FlutterBasicMessageChannel alloc] | ||
initWithName:@"dev.flutter.pigeon.PathProviderApi.getLibraryPath" | ||
binaryMessenger:binaryMessenger | ||
codec:FLTPathProviderApiGetCodec()]; | ||
if (api) { | ||
NSCAssert( | ||
[api respondsToSelector:@selector(getLibraryPathWithError:)], | ||
@"FLTPathProviderApi api (%@) doesn't respond to @selector(getLibraryPathWithError:)", | ||
api); | ||
[channel setMessageHandler:^(id _Nullable message, FlutterReply callback) { | ||
FlutterError *error; | ||
NSString *output = [api getLibraryPathWithError:&error]; | ||
callback(wrapResult(output, error)); | ||
}]; | ||
} else { | ||
[channel setMessageHandler:nil]; | ||
} | ||
} | ||
{ | ||
FlutterBasicMessageChannel *channel = [[FlutterBasicMessageChannel alloc] | ||
initWithName:@"dev.flutter.pigeon.PathProviderApi.getApplicationDocumentsPath" | ||
binaryMessenger:binaryMessenger | ||
codec:FLTPathProviderApiGetCodec()]; | ||
if (api) { | ||
NSCAssert([api respondsToSelector:@selector(getApplicationDocumentsPathWithError:)], | ||
@"FLTPathProviderApi api (%@) doesn't respond to " | ||
@"@selector(getApplicationDocumentsPathWithError:)", | ||
api); | ||
[channel setMessageHandler:^(id _Nullable message, FlutterReply callback) { | ||
FlutterError *error; | ||
NSString *output = [api getApplicationDocumentsPathWithError:&error]; | ||
callback(wrapResult(output, error)); | ||
}]; | ||
} else { | ||
[channel setMessageHandler:nil]; | ||
} | ||
} | ||
} |
124 changes: 124 additions & 0 deletions
124
packages/path_provider/path_provider_ios/lib/messages.g.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
// Copyright 2013 The Flutter Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
// Autogenerated from Pigeon (v3.1.5), do not edit directly. | ||
// See also: https://pub.dev/packages/pigeon | ||
// ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name | ||
// @dart = 2.12 | ||
import 'dart:async'; | ||
import 'dart:typed_data' show Uint8List, Int32List, Int64List, Float64List; | ||
|
||
import 'package:flutter/foundation.dart' show WriteBuffer, ReadBuffer; | ||
import 'package:flutter/services.dart'; | ||
|
||
class _PathProviderApiCodec extends StandardMessageCodec { | ||
const _PathProviderApiCodec(); | ||
} | ||
|
||
class PathProviderApi { | ||
/// Constructor for [PathProviderApi]. The [binaryMessenger] named argument is | ||
/// available for dependency injection. If it is left null, the default | ||
/// BinaryMessenger will be used which routes to the host platform. | ||
PathProviderApi({BinaryMessenger? binaryMessenger}) | ||
: _binaryMessenger = binaryMessenger; | ||
|
||
final BinaryMessenger? _binaryMessenger; | ||
|
||
static const MessageCodec<Object?> codec = _PathProviderApiCodec(); | ||
|
||
Future<String?> getTemporaryPath() async { | ||
final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>( | ||
'dev.flutter.pigeon.PathProviderApi.getTemporaryPath', codec, | ||
binaryMessenger: _binaryMessenger); | ||
final Map<Object?, Object?>? replyMap = | ||
await channel.send(null) as Map<Object?, Object?>?; | ||
if (replyMap == null) { | ||
throw PlatformException( | ||
code: 'channel-error', | ||
message: 'Unable to establish connection on channel.', | ||
); | ||
} else if (replyMap['error'] != null) { | ||
final Map<Object?, Object?> error = | ||
(replyMap['error'] as Map<Object?, Object?>?)!; | ||
throw PlatformException( | ||
code: (error['code'] as String?)!, | ||
message: error['message'] as String?, | ||
details: error['details'], | ||
); | ||
} else { | ||
return (replyMap['result'] as String?); | ||
} | ||
} | ||
|
||
Future<String?> getApplicationSupportPath() async { | ||
final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>( | ||
'dev.flutter.pigeon.PathProviderApi.getApplicationSupportPath', codec, | ||
binaryMessenger: _binaryMessenger); | ||
final Map<Object?, Object?>? replyMap = | ||
await channel.send(null) as Map<Object?, Object?>?; | ||
if (replyMap == null) { | ||
throw PlatformException( | ||
code: 'channel-error', | ||
message: 'Unable to establish connection on channel.', | ||
); | ||
} else if (replyMap['error'] != null) { | ||
final Map<Object?, Object?> error = | ||
(replyMap['error'] as Map<Object?, Object?>?)!; | ||
throw PlatformException( | ||
code: (error['code'] as String?)!, | ||
message: error['message'] as String?, | ||
details: error['details'], | ||
); | ||
} else { | ||
return (replyMap['result'] as String?); | ||
} | ||
} | ||
|
||
Future<String?> getLibraryPath() async { | ||
final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>( | ||
'dev.flutter.pigeon.PathProviderApi.getLibraryPath', codec, | ||
binaryMessenger: _binaryMessenger); | ||
final Map<Object?, Object?>? replyMap = | ||
await channel.send(null) as Map<Object?, Object?>?; | ||
if (replyMap == null) { | ||
throw PlatformException( | ||
code: 'channel-error', | ||
message: 'Unable to establish connection on channel.', | ||
); | ||
} else if (replyMap['error'] != null) { | ||
final Map<Object?, Object?> error = | ||
(replyMap['error'] as Map<Object?, Object?>?)!; | ||
throw PlatformException( | ||
code: (error['code'] as String?)!, | ||
message: error['message'] as String?, | ||
details: error['details'], | ||
); | ||
} else { | ||
return (replyMap['result'] as String?); | ||
} | ||
} | ||
|
||
Future<String?> getApplicationDocumentsPath() async { | ||
final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>( | ||
'dev.flutter.pigeon.PathProviderApi.getApplicationDocumentsPath', codec, | ||
binaryMessenger: _binaryMessenger); | ||
final Map<Object?, Object?>? replyMap = | ||
await channel.send(null) as Map<Object?, Object?>?; | ||
if (replyMap == null) { | ||
throw PlatformException( | ||
code: 'channel-error', | ||
message: 'Unable to establish connection on channel.', | ||
); | ||
} else if (replyMap['error'] != null) { | ||
final Map<Object?, Object?> error = | ||
(replyMap['error'] as Map<Object?, Object?>?)!; | ||
throw PlatformException( | ||
code: (error['code'] as String?)!, | ||
message: error['message'] as String?, | ||
details: error['details'], | ||
); | ||
} else { | ||
return (replyMap['result'] as String?); | ||
} | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand if you don't want to mess with this in this PR, but if this is switched to the
NSFileManager
API then we actually could pass back a useful error:create:YES
because I see the comment:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea, sounds like a good idea. Since there is no issue with the current implementation and it isn't deprecated I think we shouldn't touch it though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FWIW I moved this logic to Dart when I switched macOS to an internal method channel; we could easily do the same for iOS.