Class: Pod::Target::BuildSettings::AggregateTargetSettings

Inherits:
Pod::Target::BuildSettings show all
Defined in:
lib/cocoapods/target/build_settings.rb

Overview

A subclass that generates build settings for a ‘PodTarget`

Since:

  • 1.5.0

Constant Summary

Constants inherited from Pod::Target::BuildSettings

CONFIGURATION_BUILD_DIR_VARIABLE, PLURAL_SETTINGS, XCFRAMEWORKS_BUILD_DIR_VARIABLE

Public API collapse

Attributes inherited from Pod::Target::BuildSettings

#target

Public API collapse

Paths collapse

Frameworks collapse

Libraries collapse

Clang collapse

Swift collapse

Linking collapse

Target Properties collapse

Methods inherited from Pod::Target::BuildSettings

#clang_warn_quoted_include_in_framework_header, #code_sign_identity, #framework_search_paths_to_import_developer_frameworks, #gcc_preprocessor_definitions, #initialize_copy, #other_ldflags, #other_swift_flags, #pods_build_dir, #pods_configuration_build_dir, #pods_xcframeworks_build_dir, #save_as, #use_recursive_script_inputs_in_script_phases, xcframework_intermediate_dir

Constructor Details

#initialize(target, configuration_name, configuration: nil) ⇒ AggregateTargetSettings

Initializes a new instance

Parameters:

Since:

  • 1.5.0



1124
1125
1126
1127
1128
 
# File 'lib/cocoapods/target/build_settings.rb', line 1124

def initialize(target, configuration_name, configuration: nil)
  super(target)
  @configuration_name = configuration_name
  (@configuration = configuration) || raise("No configuration for #{self}.")
end

Instance Attribute Details

#configuration_name ⇒ Symbol (readonly)

Returns The build configuration these settings will be used for.

Returns:

  • (Symbol) —

    The build configuration these settings will be used for

Since:

  • 1.5.0



1114
1115
1116
 
# File 'lib/cocoapods/target/build_settings.rb', line 1114

def configuration_name
  @configuration_name
end

Class Method Details

.build_settings_names ⇒ Object

See Also:

Since:

  • 1.5.0



1108
1109
1110
 
# File 'lib/cocoapods/target/build_settings.rb', line 1108

def self.build_settings_names
  @build_settings_names | BuildSettings.build_settings_names
end

Instance Method Details

#always_embed_swift_standard_libraries ⇒ String

The ‘always_embed_swift_standard_libraries` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘always_embed_swift_standard_libraries, build_setting, memoized`.

Returns:

  • (String) 


1256
1257
1258
1259
1260
1261
 
# File 'lib/cocoapods/target/build_settings.rb', line 1256

define_build_settings_method :always_embed_swift_standard_libraries, :build_setting => true, :memoized => true do
  return unless must_embed_swift?
  return if target_swift_version < EMBED_STANDARD_LIBRARIES_MINIMUM_VERSION

  'YES'
end

#any_vendored_dynamic_artifacts? ⇒ Boolean

The ‘any_vendored_dynamic_artifacts?` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘any_vendored_dynamic_artifacts?, memoized`.

Returns:

  • (Boolean) 


1290
1291
1292
1293
1294
1295
1296
 
# File 'lib/cocoapods/target/build_settings.rb', line 1290

define_build_settings_method :any_vendored_dynamic_artifacts?, :memoized => true do
  pod_targets.any? do |pt|
    pt.file_accessors.any? do |fa|
      !fa.vendored_dynamic_artifacts.empty? || !fa.vendored_dynamic_xcframeworks.empty?
    end
  end
end

#any_vendored_static_artifacts? ⇒ Boolean

The ‘any_vendored_static_artifacts?` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘any_vendored_static_artifacts?, memoized`.

Returns:

  • (Boolean) 


1299
1300
1301
1302
1303
1304
1305
 
# File 'lib/cocoapods/target/build_settings.rb', line 1299

define_build_settings_method :any_vendored_static_artifacts?, :memoized => true do
  pod_targets.any? do |pt|
    pt.file_accessors.any? do |fa|
      !fa.vendored_static_artifacts.empty?
    end
  end
end

#embedded_content_contains_swift ⇒ String

The ‘embedded_content_contains_swift` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘embedded_content_contains_swift, build_setting, memoized`.

Returns:

  • (String) 


1264
1265
1266
1267
1268
1269
 
# File 'lib/cocoapods/target/build_settings.rb', line 1264

define_build_settings_method :embedded_content_contains_swift, :build_setting => true, :memoized => true do
  return unless must_embed_swift?
  return if target_swift_version >= EMBED_STANDARD_LIBRARIES_MINIMUM_VERSION

  'YES'
end

#framework_search_paths ⇒ Array<String>

The ‘framework_search_paths` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘framework_search_paths, build_setting, memoized, sorted, uniqued, from_pod_targets_to_link, from_search_paths_aggregate_targets`.

Returns:

  • (Array<String>) 


1165
1166
1167
 
# File 'lib/cocoapods/target/build_settings.rb', line 1165

define_build_settings_method :framework_search_paths, :build_setting => true, :memoized => true, :sorted => true, :uniqued => true, :from_pod_targets_to_link => true, :from_search_paths_aggregate_targets => :framework_search_paths_to_import do
  []
end

#frameworks ⇒ Array<String>

The ‘frameworks` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘frameworks, memoized, sorted, uniqued, from_pod_targets_to_link, from_search_paths_aggregate_targets`.

Returns:

  • (Array<String>) 


1155
1156
1157
 
# File 'lib/cocoapods/target/build_settings.rb', line 1155

define_build_settings_method :frameworks, :memoized => true, :sorted => true, :uniqued => true, :from_pod_targets_to_link => true, :from_search_paths_aggregate_targets => :dynamic_frameworks_to_import do
  []
end

#header_search_paths ⇒ Array<String>

The ‘header_search_paths` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘header_search_paths, build_setting, memoized, sorted, uniqued`.

Returns:

  • (Array<String>) 


1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
 
# File 'lib/cocoapods/target/build_settings.rb', line 1188

define_build_settings_method :header_search_paths, :build_setting => true, :memoized => true, :sorted => true, :uniqued => true do
  paths = []

  if !target.build_as_framework? || !pod_targets.all?(&:should_build?)
    paths.concat target.sandbox.public_headers.search_paths(target.platform)
  end

  # Make frameworks headers discoverable with any syntax (quotes,
  # brackets, @import, etc.)
  paths.concat pod_targets.
    select { |pt| pt.build_as_framework? && pt.should_build? }.
    map { |pt| pt.build_settings[@configuration].framework_header_search_path }

  xcframework_library_headers = pod_targets.flat_map { |pt| pt.build_settings[@configuration].vendored_xcframeworks }.
                                select { |xcf| xcf.build_type.static_library? }.
                                map { |xcf| "#{BuildSettings.xcframework_intermediate_dir(xcf)}/Headers" }.
                                compact

  paths.concat xcframework_library_headers

  paths.concat target.search_paths_aggregate_targets.flat_map { |at| at.build_settings(configuration_name).header_search_paths }

  paths
end

#ld_runpath_search_paths ⇒ Array<String>

The ‘ld_runpath_search_paths` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘ld_runpath_search_paths, build_setting, memoized, uniqued`.

Returns:

  • (Array<String>) 


1281
1282
1283
1284
1285
1286
1287
 
# File 'lib/cocoapods/target/build_settings.rb', line 1281

define_build_settings_method :ld_runpath_search_paths, :build_setting => true, :memoized => true, :uniqued => true do
  return unless pod_targets.any?(&:build_as_dynamic?) || any_vendored_dynamic_artifacts?
  symbol_type = target.user_targets.map(&:symbol_type).uniq.first
  test_bundle = symbol_type == :octest_bundle || symbol_type == :unit_test_bundle || symbol_type == :ui_test_bundle
  _ld_runpath_search_paths(:requires_host_target => target.requires_host_target?, :test_bundle => test_bundle,
                           :uses_swift => pod_targets.any?(&:uses_swift?))
end

#libraries ⇒ Array<String>

The ‘libraries` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘libraries, memoized, sorted, uniqued, from_pod_targets_to_link, from_search_paths_aggregate_targets`.

Returns:

  • (Array<String>) 


1174
1175
1176
 
# File 'lib/cocoapods/target/build_settings.rb', line 1174

define_build_settings_method :libraries, :memoized => true, :sorted => true, :uniqued => true, :from_pod_targets_to_link => true, :from_search_paths_aggregate_targets => :dynamic_libraries_to_import do
  []
end

#library_search_paths ⇒ Array<String>

The ‘library_search_paths` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘library_search_paths, build_setting, memoized, sorted, uniqued, from_pod_targets_to_link, from_search_paths_aggregate_targets`.

Returns:

  • (Array<String>) 


1179
1180
1181
 
# File 'lib/cocoapods/target/build_settings.rb', line 1179

define_build_settings_method :library_search_paths, :build_setting => true, :memoized => true, :sorted => true, :uniqued => true, :from_pod_targets_to_link => true, :from_search_paths_aggregate_targets => :vendored_dynamic_library_search_paths do
  []
end

#merged_user_target_xcconfigs ⇒ Hash{String, String}

Merges the user_target_xcconfig for all pod targets into a single hash and warns on conflicting definitions.

The ‘merged_user_target_xcconfigs` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘merged_user_target_xcconfigs, memoized`.

Returns:

  • (Hash{String, String}) 


1382
1383
1384
 
# File 'lib/cocoapods/target/build_settings.rb', line 1382

define_build_settings_method :merged_user_target_xcconfigs, :memoized => true do
  merged_xcconfigs(user_target_xcconfig_values_by_consumer_by_key, :user_target_xcconfig)
end

#module_map_files ⇒ Array<String>

The ‘module_map_files` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘module_map_files, memoized, sorted, uniqued, compacted, from_search_paths_aggregate_targets`.

Returns:

  • (Array<String>) 


1237
1238
1239
 
# File 'lib/cocoapods/target/build_settings.rb', line 1237

define_build_settings_method :module_map_files, :memoized => true, :sorted => true, :uniqued => true, :compacted => true, :from_search_paths_aggregate_targets => :module_map_file_to_import do
  pod_targets.map { |pt| pt.build_settings[@configuration].module_map_file_to_import }
end

#must_embed_swift? ⇒ Boolean

The ‘must_embed_swift?` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘must_embed_swift?, memoized`.

Returns:

  • (Boolean) 


1272
1273
1274
 
# File 'lib/cocoapods/target/build_settings.rb', line 1272

define_build_settings_method :must_embed_swift?, :memoized => true do
  !target.requires_host_target? && pod_targets.any?(&:uses_swift?)
end

#other_cflags ⇒ Array<String>

The ‘other_cflags` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘other_cflags, build_setting, memoized`.

Returns:

  • (Array<String>) 


1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'lib/cocoapods/target/build_settings.rb', line 1214

define_build_settings_method :other_cflags, :build_setting => true, :memoized => true do
  flags = super()

  pod_targets_inhibiting_warnings = pod_targets.select(&:inhibit_warnings?)

  silenced_headers = []
  silenced_frameworks = []
  pod_targets_inhibiting_warnings.each do |pt|
    if pt.build_as_framework? && pt.should_build?
      silenced_headers.append pt.build_settings[@configuration].framework_header_search_path
    else
      silenced_headers.concat pt.build_settings[@configuration].public_header_search_paths
    end
    silenced_frameworks.concat pt.build_settings[@configuration].framework_search_paths_to_import
  end

  flags += silenced_headers.uniq.flat_map { |p| ['-isystem', p] }
  flags += silenced_frameworks.uniq.flat_map { |p| ['-iframework', p] }

  flags
end

#other_swift_flags_without_swift? ⇒ Boolean

Returns:

  • (Boolean)

See Also:

Since:

  • 1.5.0



1246
1247
1248
 
# File 'lib/cocoapods/target/build_settings.rb', line 1246

def other_swift_flags_without_swift?
  module_map_files.any?
end

#pod_targets ⇒ Array<PodTarget>

Returns the PodTargets which are active for the current configuration name.

The ‘pod_targets` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘pod_targets, memoized`.

Returns:



1339
1340
1341
 
# File 'lib/cocoapods/target/build_settings.rb', line 1339

define_build_settings_method :pod_targets, :memoized => true do
  target.pod_targets_for_build_configuration(configuration_name)
end

#pod_targets_to_link ⇒ Array<PodTarget>

The ‘pod_targets_to_link` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘pod_targets_to_link, memoized`.

Returns:



1344
1345
1346
1347
 
# File 'lib/cocoapods/target/build_settings.rb', line 1344

define_build_settings_method :pod_targets_to_link, :memoized => true do
  pod_targets -
    target.search_paths_aggregate_targets.flat_map { |at| at.build_settings(configuration_name).pod_targets_to_link }
end

#pods_podfile_dir_path ⇒ String

The ‘pods_podfile_dir_path` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘pods_podfile_dir_path, build_setting, memoized`.

Returns:

  • (String) 


1141
1142
1143
 
# File 'lib/cocoapods/target/build_settings.rb', line 1141

define_build_settings_method :pods_podfile_dir_path, :build_setting => true, :memoized => true do
  target.podfile_dir_relative_path
end

#pods_root ⇒ String

The ‘pods_root` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘pods_root, build_setting, memoized`.

Returns:

  • (String) 


1146
1147
1148
 
# File 'lib/cocoapods/target/build_settings.rb', line 1146

define_build_settings_method :pods_root, :build_setting => true, :memoized => true do
  target.relative_pods_root
end

#requires_fobjc_arc? ⇒ Boolean

The ‘requires_fobjc_arc?` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘requires_fobjc_arc?, memoized`.

Returns:

  • (Boolean) 


1314
1315
1316
1317
 
# File 'lib/cocoapods/target/build_settings.rb', line 1314

define_build_settings_method :requires_fobjc_arc?, :memoized => true do
  target.podfile.set_arc_compatibility_flag? &&
  target.spec_consumers.any?(&:requires_arc?)
end

#requires_objc_linker_flag? ⇒ Boolean

The ‘requires_objc_linker_flag?` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘requires_objc_linker_flag?, memoized`.

Returns:

  • (Boolean) 


1308
1309
1310
1311
 
# File 'lib/cocoapods/target/build_settings.rb', line 1308

define_build_settings_method :requires_objc_linker_flag?, :memoized => true do
  pod_targets.any?(&:build_as_static?) ||
    any_vendored_static_artifacts?
end

#search_paths_aggregate_target_pod_target_build_settings ⇒ Array<PodTarget>

The ‘search_paths_aggregate_target_pod_target_build_settings` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘search_paths_aggregate_target_pod_target_build_settings, memoized, uniqued`.

Returns:



1350
1351
1352
1353
1354
 
# File 'lib/cocoapods/target/build_settings.rb', line 1350

define_build_settings_method :search_paths_aggregate_target_pod_target_build_settings, :memoized => true, :uniqued => true do
  pod_targets = target.search_paths_aggregate_targets.flat_map { |at| at.build_settings(configuration_name).pod_targets }
  pod_targets = select_maximal_pod_targets(pod_targets)
  pod_targets.map { |pt| pt.build_settings[@configuration] }
end

#swift_include_paths ⇒ Array<String>

The ‘swift_include_paths` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘swift_include_paths, build_setting, memoized, sorted, uniqued, from_pod_targets_to_link, from_search_paths_aggregate_targets`.

Returns:

  • (Array<String>) 


1251
1252
1253
 
# File 'lib/cocoapods/target/build_settings.rb', line 1251

define_build_settings_method :swift_include_paths, :build_setting => true, :memoized => true, :sorted => true, :uniqued => true, :from_pod_targets_to_link => true, :from_search_paths_aggregate_targets => :swift_include_paths_to_import do
  []
end

#target_swift_version ⇒ Version

The ‘target_swift_version` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘target_swift_version, memoized, frozen`.

Returns:

  • (Version) —

    the SWIFT_VERSION of the target being integrated



1325
1326
1327
1328
1329
 
# File 'lib/cocoapods/target/build_settings.rb', line 1325

define_build_settings_method :target_swift_version, :memoized => true, :frozen => false do
  swift_version = target.target_definition.swift_version
  swift_version = nil if swift_version.blank?
  Version.new(swift_version)
end

#user_target_xcconfig_values_by_consumer_by_key ⇒ Hash{String,Hash{Target,String}]

Returns the user_target_xcconfig for all pod targets and their spec consumers grouped by keys

Returns:

  • (Hash{String,Hash{Target,String}]) —

    HashString,Hash{Target,String]

Since:

  • 1.5.0



1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
 
# File 'lib/cocoapods/target/build_settings.rb', line 1361

def user_target_xcconfig_values_by_consumer_by_key
  targets = (pod_targets + target.search_paths_aggregate_targets.flat_map(&:pod_targets)).uniq
  targets.each_with_object({}) do |target, hash|
    target.spec_consumers.each do |spec_consumer|
      spec_consumer.user_target_xcconfig.each do |k, v|
        # TODO: Need to decide how we are going to ensure settings like these
        # are always excluded from the user's project.
        #
        # See https://github.com/CocoaPods/CocoaPods/issues/1216
        next if k == 'USE_HEADERMAP'
        (hash[k] ||= {})[spec_consumer] = v
      end
    end
  end
end

#weak_frameworks ⇒ Array<String>

The ‘weak_frameworks` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘weak_frameworks, memoized, sorted, uniqued, from_pod_targets_to_link, from_search_paths_aggregate_targets`.

Returns:

  • (Array<String>) 


1160
1161
1162
 
# File 'lib/cocoapods/target/build_settings.rb', line 1160

define_build_settings_method :weak_frameworks, :memoized => true, :sorted => true, :uniqued => true, :from_pod_targets_to_link => true, :from_search_paths_aggregate_targets => :weak_frameworks do
  []
end

#xcconfig ⇒ Xcodeproj::Config

The ‘xcconfig` build setting for the Pod::Target::BuildSettings#target.

The return value from this method will be: ‘xcconfig, memoized`.

Returns:

  • (Xcodeproj::Config) —

    xcconfig



1131
1132
1133
1134
 
# File 'lib/cocoapods/target/build_settings.rb', line 1131

define_build_settings_method :xcconfig, :memoized => true do
  xcconfig = super()
  merge_spec_xcconfig_into_xcconfig(merged_user_target_xcconfigs, xcconfig)
end