FlutterNSBundleUtils.mm File Reference

#import "flutter/shell/platform/darwin/common/framework/Source/FlutterNSBundleUtils.h"
#include <Foundation/Foundation.h>
#import "flutter/shell/platform/darwin/common/framework/Headers/FlutterMacros.h"

Go to the source code of this file.

Functions
static NSString *	GetFlutterAssetsPathFromBundle (NSBundle *bundle, NSString *relativeAssetsPath)
NSBundle *	FLTFrameworkBundleInternal (NSString *flutterFrameworkBundleID, NSURL *searchURL)
NSBundle *	FLTGetApplicationBundle ()
NSBundle *	FLTFrameworkBundleWithIdentifier (NSString *flutterFrameworkBundleID)
NSString *	FLTAssetPath (NSBundle *bundle)
NSString *	FLTAssetsPathFromBundle (NSBundle *bundle)

Variables
FLUTTER_ASSERT_ARC NSString *const	kDefaultAssetPath = @"@"Frameworks/App.framework/flutter_assets"

Function Documentation

FLTAssetPath()

NSString* FLTAssetPath

(

NSBundle *

bundle

)

Definition at line 60 of file FlutterNSBundleUtils.mm.

                                         {
  return [bundle objectForInfoDictionaryKey:@"FLTAssetsPath"] ?: kDefaultAssetPath;
}

References kDefaultAssetPath.

Referenced by FLTAssetsPathFromBundle().

FLTAssetsPathFromBundle()

NSString* FLTAssetsPathFromBundle

(

NSBundle *

bundle

)

Definition at line 64 of file FlutterNSBundleUtils.mm.

                                                    {
  NSString* relativeAssetsPath = FLTAssetPath(bundle);
  NSString* flutterAssetsPath = GetFlutterAssetsPathFromBundle(bundle, relativeAssetsPath);
  if (flutterAssetsPath.length == 0) {
    flutterAssetsPath = GetFlutterAssetsPathFromBundle(NSBundle.mainBundle, relativeAssetsPath);
  }
  return flutterAssetsPath;
}

References FLTAssetPath(), and GetFlutterAssetsPathFromBundle().

FLTFrameworkBundleInternal()

NSBundle* FLTFrameworkBundleInternal	(	NSString *	flutterFrameworkBundleID,
		NSURL *	searchURL
	)

Definition at line 17 of file FlutterNSBundleUtils.mm.

                                                                                           {
  NSDirectoryEnumerator<NSURL*>* frameworkEnumerator = [NSFileManager.defaultManager
                 enumeratorAtURL:searchURL
      includingPropertiesForKeys:nil
                         options:NSDirectoryEnumerationSkipsSubdirectoryDescendants |
                                 NSDirectoryEnumerationSkipsHiddenFiles
                    // Skip directories where errors are encountered.
                    errorHandler:nil];
 
  for (NSURL* candidate in frameworkEnumerator) {
    NSBundle* flutterFrameworkBundle = [NSBundle bundleWithURL:candidate];
    if ([flutterFrameworkBundle.bundleIdentifier isEqualToString:flutterFrameworkBundleID]) {
      return flutterFrameworkBundle;
    }
  }
  return nil;
}

Referenced by FLTFrameworkBundleWithIdentifier().

FLTFrameworkBundleWithIdentifier()

NSBundle* FLTFrameworkBundleWithIdentifier

(

NSString *

flutterFrameworkBundleID

)

Definition at line 46 of file FlutterNSBundleUtils.mm.

                                                                               {
  NSBundle* appBundle = FLTGetApplicationBundle();
  NSBundle* flutterFrameworkBundle =
      FLTFrameworkBundleInternal(flutterFrameworkBundleID, appBundle.privateFrameworksURL);
  if (flutterFrameworkBundle == nil) {
    // Fallback to slow implementation.
    flutterFrameworkBundle = [NSBundle bundleWithIdentifier:flutterFrameworkBundleID];
  }
  if (flutterFrameworkBundle == nil) {
    flutterFrameworkBundle = NSBundle.mainBundle;
  }
  return flutterFrameworkBundle;
}

References FLTFrameworkBundleInternal(), and FLTGetApplicationBundle().

FLTGetApplicationBundle()

NSBundle* FLTGetApplicationBundle

(

)

Definition at line 35 of file FlutterNSBundleUtils.mm.

                                    {
  NSBundle* mainBundle = NSBundle.mainBundle;
  // App extension bundle is in <AppName>.app/PlugIns/Extension.appex.
  if ([mainBundle.bundleURL.pathExtension isEqualToString:@"appex"]) {
    // Up two levels.
    return [NSBundle bundleWithURL:mainBundle.bundleURL.URLByDeletingLastPathComponent
                                       .URLByDeletingLastPathComponent];
  }
  return mainBundle;
}

Referenced by FLTFrameworkBundleWithIdentifier().

GetFlutterAssetsPathFromBundle()

static NSString * GetFlutterAssetsPathFromBundle ( NSBundle *  bundle, NSString *  relativeAssetsPath  )

static

Definition at line 73 of file FlutterNSBundleUtils.mm.

                                                                                                {
  // Use the raw path solution so that asset path can be returned from unloaded bundles.
  // See https://github.com/flutter/engine/pull/46073
  NSString* assetsPath = [bundle pathForResource:relativeAssetsPath ofType:nil];
  if (assetsPath.length == 0) {
    // In app extension, using full relative path (kDefaultAssetPath)
    // returns nil when the app bundle is not loaded. Try to use
    // the sub folder name, which can successfully return a valid path.
    assetsPath = [bundle pathForResource:@"flutter_assets" ofType:nil];
  }
  return assetsPath;
}

Referenced by FLTAssetsPathFromBundle().

Variable Documentation

kDefaultAssetPath

FLUTTER_ASSERT_ARC NSString* const kDefaultAssetPath = @"@"Frameworks/App.framework/flutter_assets"

Definition at line 13 of file FlutterNSBundleUtils.mm.

Referenced by FLTAssetPath().