#import <FlutterDartProject.h>

Inheritance diagram for FlutterDartProject:

Instance Methods
(instancetype)	- initWithPrecompiledDartBundle:

("Use -init instead.")	- FLUTTER_UNAVAILABLE

(NSArray< NSString * > *dartEntrypointArguments)	- API_UNAVAILABLE

(instancetype)	- init `[implementation]`

(instancetype)	- initWithSettings: `[implementation]`

(const flutter::PlatformData)	- defaultPlatformData `[implementation]`

(const flutter::Settings &)	- settings `[implementation]`

(flutter::RunConfiguration)	- runConfiguration `[implementation]`

(flutter::RunConfiguration)	- runConfigurationForEntrypoint: `[implementation]`

(flutter::RunConfiguration)	- runConfigurationForEntrypoint:libraryOrNil: `[implementation]`

(flutter::RunConfiguration)	- runConfigurationForEntrypoint:libraryOrNil:entrypointArgs: `[implementation]`

(BOOL)	- isWideGamutEnabled `[implementation]`

(BOOL)	- isImpellerEnabled `[implementation]`

(instancetype)	- initWithPrecompiledDartBundle: `[implementation]`

(instancetype)	- initWithAssetsPath:ICUDataPath: `[implementation]`

(BOOL)	- enableImpeller `[implementation]`

(NSString *)	- assetsPath `[implementation]`

(NSString *)	- ICUDataPath `[implementation]`

Class Methods
(NSString *)	+ defaultBundleIdentifier

(NSString *)	+ lookupKeyForAsset:

(NSString *)	+ lookupKeyForAsset:fromBundle:

(NSString *)	+ lookupKeyForAsset:fromPackage:

(NSString *)	+ lookupKeyForAsset:fromPackage:fromBundle:

(NSString *)	+ flutterAssetsName: `[implementation]`

(NSString *)	+ domainNetworkPolicy: `[implementation]`

(bool)	+ allowsArbitraryLoads: `[implementation]`

(NSString *)	+ flutterAssetsNameWithBundle: `[implementation]`

Properties
void(*	rootIsolateCreateCallback )(void *_Nullable) `[implementation]`

Detailed Description

A set of Flutter and Dart assets used by a FlutterEngine to initialize execution.

Definition at line 19 of file FlutterDartProject.h.

Method Documentation

◆ allowsArbitraryLoads:

+ (bool) allowsArbitraryLoads: (NSDictionary*) appTransportSecurity

implementation

Definition at line 46 of file FlutterDartProject.mm.

                            :(NSDictionary*)appTransportSecurity {
  return [appTransportSecurity[@"NSAllowsArbitraryLoads"] boolValue];
}

◆ API_UNAVAILABLE

- (NSArray< NSString * > *dartEntrypointArguments) API_UNAVAILABLE (ios)

An NSArray of NSStrings to be passed as command line arguments to the Dart entrypoint.

If this is not explicitly set, this will default to the contents of [NSProcessInfo arguments], without the binary name.

Set this to nil to pass no arguments to the Dart entrypoint.

◆ assetsPath

- (NSString *) assetsPath

implementation

The path to the Flutter assets directory.

Definition at line 27 of file FlutterDartProject.mm.

                        {
  if (_assetsPath) {
    return _assetsPath;
  }
 
  // If there's no App.framework, fall back to checking the main bundle for assets.
  NSBundle* assetBundle = _dartBundle ?: [NSBundle mainBundle];
  NSString* flutterAssetsName = [assetBundle objectForInfoDictionaryKey:@"FLTAssetsPath"];
  if (flutterAssetsName == nil) {
    flutterAssetsName = @"flutter_assets";
  }
  NSString* path = [assetBundle pathForResource:flutterAssetsName ofType:@""];
  if (!path) {
    NSLog(@"Failed to find path for \"%@\"", flutterAssetsName);
  }
  return path;
}

◆ defaultBundleIdentifier

+ (NSString *) defaultBundleIdentifier

Returns the default identifier for the bundle where we expect to find the Flutter Dart application.

Definition at line 46 of file FlutterDartProject.mm.

                                     {
  return @"io.flutter.flutter.app";
}

◆ defaultPlatformData

- (const PlatformData) FlutterDartProject:

implementation

Definition at line 46 of file FlutterDartProject.mm.

                                                 {
  flutter::PlatformData PlatformData;
  PlatformData.lifecycle_state = std::string("AppLifecycleState.detached");
  return PlatformData;
}

◆ domainNetworkPolicy:

+ (NSString *) domainNetworkPolicy: (NSDictionary*) appTransportSecurity

implementation

Definition at line 46 of file FlutterDartProject.mm.

                                :(NSDictionary*)appTransportSecurity {
  // https://developer.apple.com/documentation/bundleresources/information_property_list/nsapptransportsecurity/nsexceptiondomains
  NSDictionary* exceptionDomains = appTransportSecurity[@"NSExceptionDomains"];
  if (exceptionDomains == nil) {
    return @"";
  }
  NSMutableArray* networkConfigArray = [[NSMutableArray alloc] init];
  for (NSString* domain in exceptionDomains) {
    NSDictionary* domainConfiguration = exceptionDomains[domain];
    // Default value is false.
    bool includesSubDomains = [domainConfiguration[@"NSIncludesSubdomains"] boolValue];
    bool allowsCleartextCommunication =
        [domainConfiguration[@"NSExceptionAllowsInsecureHTTPLoads"] boolValue];
    [networkConfigArray addObject:@[
      domain, includesSubDomains ? @YES : @NO, allowsCleartextCommunication ? @YES : @NO
    ]];
  }
  NSData* jsonData = [NSJSONSerialization dataWithJSONObject:networkConfigArray
                                                     options:0
                                                       error:NULL];
  return [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
}

◆ enableImpeller

- (BOOL) enableImpeller

implementation

Whether the Impeller rendering backend is enabled

Definition at line 27 of file FlutterDartProject.mm.

                       {
  NSNumber* enableImpeller =
      [[NSBundle mainBundle] objectForInfoDictionaryKey:@"FLTEnableImpeller"];
  if (enableImpeller != nil) {
    return enableImpeller.boolValue;
  }
  return NO;
}

◆ FLUTTER_UNAVAILABLE

- ("Use -init instead.") FLUTTER_UNAVAILABLE

Unavailable - use init instead.

◆ flutterAssetsName:

+ (NSString *) flutterAssetsName: (NSBundle*) bundle

implementation

Definition at line 46 of file FlutterDartProject.mm.

                              :(NSBundle*)bundle {
  if (bundle == nil) {
    bundle = FLTFrameworkBundleWithIdentifier([FlutterDartProject defaultBundleIdentifier]);
  }
  return FLTAssetPath(bundle);
}

◆ flutterAssetsNameWithBundle:

+ (NSString *) flutterAssetsNameWithBundle: (NSBundle*) bundle

implementation

Definition at line 27 of file FlutterDartProject.mm.

                                        :(NSBundle*)bundle {
  if (bundle == nil) {
    bundle = FLTFrameworkBundleWithIdentifier(kAppBundleIdentifier);
  }
  if (bundle == nil) {
    bundle = [NSBundle mainBundle];
  }
  NSString* flutterAssetsName = [bundle objectForInfoDictionaryKey:@"FLTAssetsPath"];
  if (flutterAssetsName == nil) {
    flutterAssetsName = @"Contents/Frameworks/App.framework/Resources/flutter_assets";
  }
  return flutterAssetsName;
}

◆ ICUDataPath

- (NSString *) ICUDataPath

implementation

The path to the ICU data file.

Definition at line 27 of file FlutterDartProject.mm.

                         {
  if (_ICUDataPath) {
    return _ICUDataPath;
  }
 
  NSString* path = [[NSBundle bundleForClass:[self class]] pathForResource:kICUBundlePath
                                                                    ofType:nil];
  if (!path) {
    NSLog(@"Failed to find path for \"%@\"", kICUBundlePath);
  }
  return path;
}

◆ init

- (instancetype) init

implementation

Definition at line 46 of file FlutterDartProject.mm.

                     {
  return [self initWithPrecompiledDartBundle:nil];
}

◆ initWithAssetsPath:ICUDataPath:

- (instancetype) initWithAssetsPath:	(NSString*)	assets
ICUDataPath:	(NSString*)	icuPath

implementation

Definition at line 27 of file FlutterDartProject.mm.

                                  :(NSString*)assets ICUDataPath:(NSString*)icuPath {
  self = [super init];
  NSAssert(self, @"Super init cannot be nil");
  _assetsPath = assets;
  _ICUDataPath = icuPath;
  return self;
}

◆ initWithPrecompiledDartBundle: [1/2]

- (instancetype) initWithPrecompiledDartBundle: (NSBundle*) bundle

implementation

Definition at line 27 of file FlutterDartProject.mm.

                                             :(NSBundle*)bundle {
  self = [super init];
  NSAssert(self, @"Super init cannot be nil");
 
  _dartBundle = bundle ?: FLTFrameworkBundleWithIdentifier(kAppBundleIdentifier);
  if (_dartBundle == nil) {
    // The bundle isn't loaded and can't be found by bundle ID. Find it by path.
    _dartBundle = [NSBundle bundleWithURL:[NSBundle.mainBundle.privateFrameworksURL
                                              URLByAppendingPathComponent:@"App.framework"]];
  }
  if (!_dartBundle.isLoaded) {
    [_dartBundle load];
  }
  _dartEntrypointArguments = [[NSProcessInfo processInfo] arguments];
  // Remove the first element as it's the binary name
  _dartEntrypointArguments = [_dartEntrypointArguments
      subarrayWithRange:NSMakeRange(1, _dartEntrypointArguments.count - 1)];
  return self;
}

◆ initWithPrecompiledDartBundle: [2/2]

- (instancetype) initWithPrecompiledDartBundle: (nullable NSBundle*) NS_DESIGNATED_INITIALIZER

Initializes a Flutter Dart project from a bundle.

The bundle must either contain a flutter_assets resource directory, or set the Info.plist key FLTAssetsPath to override that name (if you are doing a custom build using a different name).

Parameters

bundle The bundle containing the Flutter assets directory. If nil, the App framework created by Flutter will be used.

Definition at line 46 of file FlutterDartProject.mm.

                                             :(nullable NSBundle*)bundle {
  self = [super init];
 
  if (self) {
    _settings = FLTDefaultSettingsForBundle(bundle);
  }
 
  return self;
}

◆ initWithSettings:

- (instancetype) initWithSettings: (const flutter::Settings &) settings

implementation

This is currently used for only for tests to override settings.

Definition at line 46 of file FlutterDartProject.mm.

                                :(const flutter::Settings&)settings {
  self = [self initWithPrecompiledDartBundle:nil];
 
  if (self) {
    _settings = settings;
  }
 
  return self;
}

◆ isImpellerEnabled

- (BOOL) isImpellerEnabled

implementation

Definition at line 46 of file FlutterDartProject.mm.

                          {
  return _settings.enable_impeller;
}

◆ isWideGamutEnabled

- (BOOL) isWideGamutEnabled

implementation

Definition at line 46 of file FlutterDartProject.mm.

                           {
  return _settings.enable_wide_gamut;
}

◆ lookupKeyForAsset:

+ (NSString *) lookupKeyForAsset: (NSString*) asset

Returns the file name for the given asset. If the bundle with the identifier "io.flutter.flutter.app" exists, it will try use that bundle; otherwise, it will use the main bundle. To specify a different bundle, use +lookupKeyForAsset:fromBundle.

Parameters

asset The name of the asset. The name can be hierarchical.

Returns: the file name to be used for lookup in the main bundle.

Definition at line 46 of file FlutterDartProject.mm.

                              :(NSString*)asset {
  return [self lookupKeyForAsset:asset fromBundle:nil];
}

◆ lookupKeyForAsset:fromBundle:

+ (NSString *) lookupKeyForAsset:	(NSString*)	asset
fromBundle:	(nullable NSBundle*)	bundle

Returns the file name for the given asset. The returned file name can be used to access the asset in the supplied bundle.

Parameters

asset	The name of the asset. The name can be hierarchical.
bundle	The `NSBundle` to use for looking up the asset.

Returns: the file name to be used for lookup in the main bundle.

Definition at line 46 of file FlutterDartProject.mm.

                              :(NSString*)asset fromBundle:(nullable NSBundle*)bundle {
  NSString* flutterAssetsName = [FlutterDartProject flutterAssetsName:bundle];
  return [NSString stringWithFormat:@"%@/%@", flutterAssetsName, asset];
}

◆ lookupKeyForAsset:fromPackage:

+ (NSString *) lookupKeyForAsset:	(NSString*)	asset
fromPackage:	(NSString*)	package

Returns the file name for the given asset which originates from the specified package. The returned file name can be used to access the asset in the application's main bundle.

Parameters

asset	The name of the asset. The name can be hierarchical.
package	The name of the package from which the asset originates.

Returns: the file name to be used for lookup in the main bundle.

Definition at line 46 of file FlutterDartProject.mm.

                              :(NSString*)asset fromPackage:(NSString*)package {
  return [self lookupKeyForAsset:asset fromPackage:package fromBundle:nil];
}

◆ lookupKeyForAsset:fromPackage:fromBundle:

+ (NSString *) lookupKeyForAsset:	(NSString*)	asset
fromPackage:	(NSString*)	package
fromBundle:	(nullable NSBundle*)	bundle

Returns the file name for the given asset which originates from the specified package. The returned file name can be used to access the asset in the specified bundle.

Parameters

asset	The name of the asset. The name can be hierarchical.
package	The name of the package from which the asset originates.
bundle	The bundle to use when doing the lookup.

Returns: the file name to be used for lookup in the main bundle.

Definition at line 46 of file FlutterDartProject.mm.

                              :(NSString*)asset
                   fromPackage:(NSString*)package
                    fromBundle:(nullable NSBundle*)bundle {
  return [self lookupKeyForAsset:[NSString stringWithFormat:@"packages/%@/%@", package, asset]
                      fromBundle:bundle];
}

◆ runConfiguration

- (RunConfiguration) FlutterDartProject:

implementation

Definition at line 46 of file FlutterDartProject.mm.

                                            {
  return [self runConfigurationForEntrypoint:nil];
}

◆ runConfigurationForEntrypoint:

- (RunConfiguration) FlutterDartProject: (nullable NSString*) entrypointOrNil

implementation

Definition at line 46 of file FlutterDartProject.mm.

                                                        :(nullable NSString*)entrypointOrNil {
  return [self runConfigurationForEntrypoint:entrypointOrNil libraryOrNil:nil];
}

◆ runConfigurationForEntrypoint:libraryOrNil:

- (RunConfiguration) FlutterDartProject:	(nullable NSString*)	entrypointOrNil
libraryOrNil:	(nullable NSString*)	dartLibraryOrNil

implementation

Definition at line 46 of file FlutterDartProject.mm.

                                                        :(nullable NSString*)entrypointOrNil
                                              libraryOrNil:(nullable NSString*)dartLibraryOrNil {
  return [self runConfigurationForEntrypoint:entrypointOrNil
                                libraryOrNil:dartLibraryOrNil
                              entrypointArgs:nil];
}

◆ runConfigurationForEntrypoint:libraryOrNil:entrypointArgs:

- (RunConfiguration) FlutterDartProject:	(nullable NSString*)	entrypointOrNil
libraryOrNil:	(nullable NSString*)	dartLibraryOrNil
entrypointArgs:	(nullable NSArray<NSString>)	entrypointArgs

implementation

Definition at line 46 of file FlutterDartProject.mm.

                                                        :(nullable NSString*)entrypointOrNil
                                              libraryOrNil:(nullable NSString*)dartLibraryOrNil
                                            entrypointArgs:
                                                (nullable NSArray<NSString*>*)entrypointArgs {
  auto config = flutter::RunConfiguration::InferFromSettings(_settings);
  if (dartLibraryOrNil && entrypointOrNil) {
    config.SetEntrypointAndLibrary(std::string([entrypointOrNil UTF8String]),
                                   std::string([dartLibraryOrNil UTF8String]));
 
  } else if (entrypointOrNil) {
    config.SetEntrypoint(std::string([entrypointOrNil UTF8String]));
  }
 
  if (entrypointArgs.count) {
    std::vector<std::string> cppEntrypointArgs;
    for (NSString* arg in entrypointArgs) {
      cppEntrypointArgs.push_back(std::string([arg UTF8String]));
    }
    config.SetEntrypointArgs(std::move(cppEntrypointArgs));
  }
 
  return config;
}

◆ settings

- (const Settings &) FlutterDartProject:

implementation

Definition at line 46 of file FlutterDartProject.mm.

                                   {
  return _settings;
}

Property Documentation

◆ rootIsolateCreateCallback

- (void(* rootIsolateCreateCallback) (void *_Nullable))

readwritenonatomicassignimplementation

The callback invoked by the engine in root isolate scope.

Definition at line 32 of file FlutterDartProject_Internal.h.

The documentation for this class was generated from the following files:

shell/platform/darwin/common/framework/Headers/FlutterDartProject.h
shell/platform/darwin/ios/framework/Source/FlutterDartProject.mm
shell/platform/darwin/macos/framework/Source/FlutterDartProject.mm

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ allowsArbitraryLoads:

◆ API_UNAVAILABLE

◆ assetsPath

◆ defaultBundleIdentifier

◆ defaultPlatformData

◆ domainNetworkPolicy:

◆ enableImpeller

◆ FLUTTER_UNAVAILABLE

◆ flutterAssetsName:

◆ flutterAssetsNameWithBundle:

◆ ICUDataPath

◆ init

◆ initWithAssetsPath:ICUDataPath:

◆ initWithPrecompiledDartBundle: [1/2]

◆ initWithPrecompiledDartBundle: [2/2]

◆ initWithSettings:

◆ isImpellerEnabled

◆ isWideGamutEnabled

◆ lookupKeyForAsset:

◆ lookupKeyForAsset:fromBundle:

◆ lookupKeyForAsset:fromPackage:

◆ lookupKeyForAsset:fromPackage:fromBundle:

◆ runConfiguration

◆ runConfigurationForEntrypoint:

◆ runConfigurationForEntrypoint:libraryOrNil:

◆ runConfigurationForEntrypoint:libraryOrNil:entrypointArgs:

◆ settings

Property Documentation

◆ rootIsolateCreateCallback