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, #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_ascii_plist, #to_hash

Instance Attribute Details

#product_install_pathString

Returns the install path of the product.

Returns:

  • (String)

    the install path of the product.



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

attribute :product_install_path, String

#product_referencePBXFileReference

Returns the reference to the product file.

Returns:



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

has_one :product_reference, PBXFileReference

#product_typeString

Returns the build product type identifier.

Returns:

  • (String)

    the build product type identifier.



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

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:



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
# File 'lib/xcodeproj/project/object/native_target.rb', line 473

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_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.



505
506
507
508
509
510
511
512
# File 'lib/xcodeproj/project/object/native_target.rb', line 505

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_phasesObjectList<AbstractBuildPhase>

Note:

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

Returns the build phases of the target.

Returns:



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

has_many :build_phases, AbstractBuildPhase

#build_rulesPBXBuildRule

Returns the build rules of this target.

Returns:



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

has_many :build_rules, PBXBuildRule

#extension_target_type?Boolean

Returns Whether the target is an extension.

Returns:

  • (Boolean)

    Whether the target is an extension.



451
452
453
454
455
456
457
458
# File 'lib/xcodeproj/project/object/native_target.rb', line 451

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_phasePBXFrameworksBuildPhase

Note:

A target should have only one frameworks build phase.

Finds or creates the frameworks build phase of the target.

Returns:



540
541
542
# File 'lib/xcodeproj/project/object/native_target.rb', line 540

def frameworks_build_phase
  find_or_create_build_phase_by_class(PBXFrameworksBuildPhase)
end

#headers_build_phasePBXHeadersBuildPhase

Note:

A target should have only one headers build phase.

Finds or creates the headers build phase of the target.

Returns:



520
521
522
# File 'lib/xcodeproj/project/object/native_target.rb', line 520

def headers_build_phase
  find_or_create_build_phase_by_class(PBXHeadersBuildPhase)
end

#resources_build_phasePBXResourcesBuildPhase

Note:

A target should have only one resources build phase.

Finds or creates the resources build phase of the target.

Returns:



550
551
552
# File 'lib/xcodeproj/project/object/native_target.rb', line 550

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.



584
585
586
587
588
589
590
591
592
# File 'lib/xcodeproj/project/object/native_target.rb', line 584

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_phasePBXSourcesBuildPhase

Note:

A target should have only one source build phase.

Finds or creates the source build phase of the target.

Returns:



530
531
532
# File 'lib/xcodeproj/project/object/native_target.rb', line 530

def source_build_phase
  find_or_create_build_phase_by_class(PBXSourcesBuildPhase)
end

#symbol_typeSymbol

Returns The type of the target expressed as a symbol.

Returns:

  • (Symbol)

    The type of the target expressed as a symbol.



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

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.



440
441
442
443
444
445
446
447
# File 'lib/xcodeproj/project/object/native_target.rb', line 440

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