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



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

attribute :product_install_path, String

#product_referencePBXFileReference



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

has_one :product_reference, PBXFileReference

#product_typeString



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

attribute :product_type, String

Instance Method Details

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

Adds source files to the target.



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
# File 'lib/xcodeproj/project/object/native_target.rb', line 414

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.



446
447
448
449
450
451
452
453
# File 'lib/xcodeproj/project/object/native_target.rb', line 446

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.



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

has_many :build_phases, AbstractBuildPhase

#build_rulesPBXBuildRule



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

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.



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

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.



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

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.



491
492
493
# File 'lib/xcodeproj/project/object/native_target.rb', line 491

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.



525
526
527
528
529
530
531
532
533
# File 'lib/xcodeproj/project/object/native_target.rb', line 525

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.



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

def source_build_phase
  find_or_create_build_phase_by_class(PBXSourcesBuildPhase)
end

#symbol_typeSymbol



395
396
397
398
399
# File 'lib/xcodeproj/project/object/native_target.rb', line 395

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