Class: Xcodeproj::Project::Object::PBXNativeTarget

Inherits:
AbstractTarget show all
Defined in:
lib/xcodeproj/project/object/native_target.rb

Overview

Represents a target handled by Xcode.

Attributes collapse

Attributes inherited from AbstractTarget

#build_configuration_list, #comments, #name, #product_name

Attributes inherited from AbstractObject

#isa, #project, #uuid

Attributes collapse

Helpers collapse

AbstractObject Hooks collapse

Methods inherited from AbstractTarget

#add_build_configuration, #add_dependency, #add_system_framework, #add_system_library, #add_system_library_tbd, #build_configurations, #build_settings, #common_resolved_build_setting, #copy_files_build_phases, #dependencies, #dependency_for_target, #deployment_target, #deployment_target=, #frameworks_build_phases, #new_copy_files_build_phase, #new_shell_script_build_phase, #platform_name, #pretty_print, #resolved_build_setting, #sdk, #sdk_version, #shell_script_build_phases

Methods inherited from AbstractObject

#<=>, #==, #ascii_plist_annotation, #display_name, #inspect, isa, #nested_object_for_hash, #pretty_print, #remove_from_project, #sort_recursively, #to_hash

Instance Attribute Details

#product_install_path ⇒ String

Returns the install path of the product.

Returns:

  • (String) —

    the install path of the product.



453
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 453

attribute :product_install_path, String

#product_reference ⇒ PBXFileReference

Returns the reference to the product file.

Returns:



444
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 444

has_one :product_reference, PBXFileReference

#product_type ⇒ String

Returns the build product type identifier.

Returns:

  • (String) —

    the build product type identifier.



440
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 440

attribute :product_type, String

Instance Method Details

#add_file_references(file_references, compiler_flags = {}) ⇒ Array<PBXBuildFile>

Adds source files to the target.

Parameters:

  • file_references (Array<PBXFileReference>) —

    the files references of the source files that should be added to the target.

  • compiler_flags (String) (defaults to: {}) —

    the compiler flags for the source files.

Returns:



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 521

def add_file_references(file_references, compiler_flags = {})
  file_references.map do |file|
    extension = File.extname(file.path).downcase
    header_extensions = Constants::HEADER_FILES_EXTENSIONS
    is_header_phase = header_extensions.include?(extension)
    phase = is_header_phase ? headers_build_phase : source_build_phase

    unless build_file = phase.build_file(file)
      build_file = project.new(PBXBuildFile)
      build_file.file_ref = file
      phase.files << build_file
    end

    if compiler_flags && !compiler_flags.empty? && !is_header_phase
      (build_file.settings ||= {}).merge!('COMPILER_FLAGS' => compiler_flags) do |_, old, new|
        [old, new].compact.join(' ')
      end
    end

    yield build_file if block_given?

    build_file
  end
end

#add_on_demand_resources(on_demand_resource_tag_files) ⇒ void

This method returns an undefined value.

Adds on demand resources to the resources build phase of the target.

Parameters:

  • on_demand_resource_tag_files (String => [Array<PBXFileReference>]) —

    the files references of the on demand resources to add to the target keyed by the tag.



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 569

def add_on_demand_resources(on_demand_resource_tag_files)
  on_demand_resource_tag_files.each do |tag, file_refs|
    file_refs.each do |file_ref|
      if resources_build_phase.include?(file_ref)
        existing_build_file = resources_build_phase.build_file(file_ref)
        existing_build_file.settings ||= {}
        existing_build_file.settings['ASSET_TAGS'] ||= []
        existing_build_file.settings['ASSET_TAGS'] << tag
        existing_build_file.settings['ASSET_TAGS'].uniq!
        next
      end
      build_file = resources_build_phase.add_file_reference(file_ref, true)
      build_file.settings = (build_file.settings ||= {}).merge('ASSET_TAGS' => [tag])
    end
  end
end

#add_resources(resource_file_references) ⇒ void

This method returns an undefined value.

Adds resource files to the resources build phase of the target.

Parameters:

  • resource_file_references (Array<PBXFileReference>) —

    the files references of the resources to the target.



553
554
555
556
557
558
559
560
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 553

def add_resources(resource_file_references)
  resource_file_references.each do |file|
    next if resources_build_phase.include?(file)
    build_file = project.new(PBXBuildFile)
    build_file.file_ref = file
    resources_build_phase.files << build_file
  end
end

#build_phases ⇒ ObjectList<AbstractBuildPhase>

Note:

Apparently only PBXCopyFilesBuildPhase and PBXShellScriptBuildPhase can appear multiple times in a target.

Returns the build phases of the target.

Returns:



462
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 462

has_many :build_phases, AbstractBuildPhase

#build_rules ⇒ PBXBuildRule

Returns the build rules of this target.

Returns:



436
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 436

has_many :build_rules, PBXBuildRule

#extension_target_type? ⇒ Boolean

Returns Whether the target is an extension.

Returns:

  • (Boolean) —

    Whether the target is an extension.



488
489
490
491
492
493
494
495
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 488

def extension_target_type?
  case symbol_type
  when :app_extension, :watch_extension, :watch2_extension, :tv_extension, :messages_extension
    true
  else
    false
  end
end

#frameworks_build_phase ⇒ PBXFrameworksBuildPhase

Note:

A target should have only one frameworks build phase.

Finds or creates the frameworks build phase of the target.

Returns:



631
632
633
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 631

def frameworks_build_phase
  find_or_create_build_phase_by_class(PBXFrameworksBuildPhase)
end

#headers_build_phase ⇒ PBXHeadersBuildPhase

Note:

A target should have only one headers build phase.

Finds or creates the headers build phase of the target.

Returns:



611
612
613
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 611

def headers_build_phase
  find_or_create_build_phase_by_class(PBXHeadersBuildPhase)
end

#launchable_target_type? ⇒ Boolean

Returns Whether the target is launchable.

Returns:

  • (Boolean) —

    Whether the target is launchable.



499
500
501
502
503
504
505
506
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 499

def launchable_target_type?
  case symbol_type
  when :application, :command_line_tool
    true
  else
    false
  end
end

#package_product_dependencies ⇒ ObjectList<XCSwiftPackageProductDependency>

Returns the Swift package products necessary to build this target.

Returns:



449
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 449

has_many :package_product_dependencies, XCSwiftPackageProductDependency

#remove_on_demand_resources(on_demand_resource_tag_files) ⇒ void

This method returns an undefined value.

Remove on demand resources from the resources build phase of the target.

Parameters:

  • on_demand_resource_tag_files (String => [Array<PBXFileReference>]) —

    the files references of the on demand resources to add to the target keyed by the tag.



593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 593

def remove_on_demand_resources(on_demand_resource_tag_files)
  on_demand_resource_tag_files.each do |tag, file_refs|
    file_refs.each do |file_ref|
      build_file = resources_build_phase.build_file(file_ref)
      next if build_file.nil?
      asset_tags = build_file.settings['ASSET_TAGS']
      asset_tags.delete(tag)
      resources_build_phase.remove_file_reference(file_ref) if asset_tags.empty?
    end
  end
end

#resources_build_phase ⇒ PBXResourcesBuildPhase

Note:

A target should have only one resources build phase.

Finds or creates the resources build phase of the target.

Returns:



641
642
643
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 641

def resources_build_phase
  find_or_create_build_phase_by_class(PBXResourcesBuildPhase)
end

#sort(_options = nil) ⇒ Object

Sorts the to many attributes of the object according to the display name.

Build phases are not sorted as they order is relevant.



675
676
677
678
679
680
681
682
683
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 675

def sort(_options = nil)
  attributes_to_sort = to_many_attributes.reject { |attr| attr.name == :build_phases }
  attributes_to_sort.each do |attrb|
    list = attrb.get_value(self)
    list.sort! do |x, y|
      x.display_name <=> y.display_name
    end
  end
end

#source_build_phase ⇒ PBXSourcesBuildPhase

Note:

A target should have only one source build phase.

Finds or creates the source build phase of the target.

Returns:



621
622
623
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 621

def source_build_phase
  find_or_create_build_phase_by_class(PBXSourcesBuildPhase)
end

#symbol_type ⇒ Symbol

Returns The type of the target expressed as a symbol.

Returns:

  • (Symbol) —

    The type of the target expressed as a symbol.



471
472
473
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 471

def symbol_type
  Constants::PRODUCT_TYPE_UTI.key(product_type)
end

#test_target_type? ⇒ Boolean

Returns Whether the target is a test target.

Returns:

  • (Boolean) —

    Whether the target is a test target.



477
478
479
480
481
482
483
484
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 477

def test_target_type?
  case symbol_type
  when :octest_bundle, :unit_test_bundle, :ui_test_bundle
    true
  else
    false
  end
end

#to_ascii_plist ⇒ Object 



693
694
695
696
697
698
699
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 693

def to_ascii_plist
  plist = super
  if !plist.value['packageProductDependencies'].nil? && plist.value['packageProductDependencies'].empty?
    plist.value.delete('packageProductDependencies')
  end
  plist
end

#to_hash_as(method = :to_hash) ⇒ Object 



685
686
687
688
689
690
691
 
# File 'lib/xcodeproj/project/object/native_target.rb', line 685

def to_hash_as(method = :to_hash)
  hash_as = super
  if !hash_as['packageProductDependencies'].nil? && hash_as['packageProductDependencies'].empty?
    hash_as.delete('packageProductDependencies')
  end
  hash_as
end