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

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

Instance Attribute Details

#product_install_pathString

Returns the install path of the product.

Returns:

  • (String)

    the install path of the product.



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

attribute :product_install_path, String

#product_referencePBXFileReference

Returns the reference to the product file.

Returns:



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

has_one :product_reference, PBXFileReference

#product_typeString

Returns the build product type identifier.

Returns:

  • (String)

    the build product type identifier.



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

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 (Hash{String=>String}) (defaults to: {})

    the compiler flags for the source files.

Returns:



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/xcodeproj/project/object/native_target.rb', line 408

def add_file_references(file_references, compiler_flags = {})
  file_references.map do |file|
    build_file = project.new(PBXBuildFile)
    build_file.file_ref = file

    extension = File.extname(file.path).downcase
    header_extensions = Constants::HEADER_FILES_EXTENSIONS
    if header_extensions.include?(extension)
      headers_build_phase.files << build_file
    else
      if compiler_flags && !compiler_flags.empty?
        build_file.settings = { 'COMPILER_FLAGS' => compiler_flags }
      end
      source_build_phase.files << build_file
    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.



437
438
439
440
441
442
443
# File 'lib/xcodeproj/project/object/native_target.rb', line 437

def add_resources(resource_file_references)
  resource_file_references.each do |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:



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

has_many :build_phases, AbstractBuildPhase

#build_rulesPBXBuildRule

Returns the build rules of this target.

Returns:



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

has_many :build_rules, PBXBuildRule

#frameworks_build_phasePBXFrameworksBuildPhase

Note:

A target should have only one frameworks build phase.

Finds or creates the frameworks build phase of the target.

Returns:



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

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:



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

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:



481
482
483
# File 'lib/xcodeproj/project/object/native_target.rb', line 481

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.



515
516
517
518
519
520
521
522
523
# File 'lib/xcodeproj/project/object/native_target.rb', line 515

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:



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

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.



389
390
391
392
393
# File 'lib/xcodeproj/project/object/native_target.rb', line 389

def symbol_type
  pair = Constants::PRODUCT_TYPE_UTI.find { |_key, value| value == product_type }
  return nil if pair.nil?
  pair.first
end