plasmo_xcodeproj 1.21.1

data/lib/xcodeproj/project/object/build_configuration.rb

@@ -0,0 +1,255 @@
+module Xcodeproj
+  class Project
+    module Object
+      # Encapsulates the information a specific build configuration referenced
+      # by a {XCConfigurationList} which in turn might be referenced by a
+      # {PBXProject} or a {PBXNativeTarget}.
+      #
+      class XCBuildConfiguration < AbstractObject
+        MUTUAL_RECURSION_SENTINEL = 'xcodeproj.mutual_recursion_sentinel'.freeze
+
+        private_constant :MUTUAL_RECURSION_SENTINEL
+
+        # @!group Attributes
+
+        # @return [String] the name of the configuration.
+        #
+        attribute :name, String
+
+        # @return [Hash] the build settings to use for building the target.
+        #
+        attribute :build_settings, Hash, {}
+
+        # @return [PBXFileReference] an optional file reference to a
+        #         configuration file (`.xcconfig`).
+        #
+        has_one :base_configuration_reference, PBXFileReference
+
+        public
+
+        # @!group AbstractObject Hooks
+        #---------------------------------------------------------------------#
+
+        # @return [Hash{String => Hash}] A hash suitable to display the object
+        #         to the user.
+        #
+        def pretty_print
+          data = {}
+          data['Build Settings'] = sorted_build_settings
+          if base_configuration_reference
+            data['Base Configuration'] = base_configuration_reference.pretty_print
+          end
+          { name => data }
+        end
+
+        def to_hash_as(method = :to_hash)
+          super.tap do |hash|
+            normalize_array_settings(hash['buildSettings'])
+          end
+        end
+
+        # Sorts the build settings. Valid only in Ruby > 1.9.2 because in
+        # previous versions the hash are not sorted.
+        #
+        # @return [void]
+        #
+        def sort(_options = nil)
+          self.build_settings = sorted_build_settings
+        end
+
+        # @return [Boolean] Whether this configuration is configured for
+        #         debugging.
+        #
+        def debug?
+          gcc_preprocessor_definitions = resolve_build_setting('GCC_PREPROCESSOR_DEFINITIONS')
+          gcc_preprocessor_definitions && gcc_preprocessor_definitions.include?('DEBUG=1')
+        end
+
+        # @return [Symbol] The symbolic type of this configuration, either
+        #         `:debug` or `:release`.
+        #
+        def type
+          debug? ? :debug : :release
+        end
+
+        # @!group Helpers
+        #---------------------------------------------------------------------#
+
+        # Gets the value for the given build setting considering any configuration
+        # file present and resolving inheritance between them. It also takes in
+        # consideration environment variables.
+        #
+        # @param [String] key
+        #        the key of the build setting.
+        #
+        # @param [PBXNativeTarget] root_target
+        #        use this to resolve complete recursion between project and targets.
+        #
+        # @param [String] previous_key
+        #        use this to resolve complete recursion between different build settings.
+        #
+        # @return [String] The value of the build setting
+        #
+        def resolve_build_setting(key, root_target = nil, previous_key = nil)
+          setting = build_settings[key]
+          setting = resolve_variable_substitution(key, setting, root_target, previous_key)
+
+          config_setting = config[key]
+          config_setting = resolve_variable_substitution(key, config_setting, root_target, previous_key)
+
+          project_setting = project.build_configuration_list[name]
+          project_setting = nil if equal?(project_setting)
+          project_setting &&= project_setting.resolve_build_setting(key, root_target)
+
+          defaults = {
+            'CONFIGURATION' => name,
+            'SRCROOT' => project.project_dir.to_s,
+          }
+
+          # if previous_key is nil, it means that we're back at the first call, so we can replace our sentinel string
+          # used to prevent recursion with nil
+          if previous_key.nil? && setting == MUTUAL_RECURSION_SENTINEL
+            setting = nil
+          end
+
+          [defaults[key], project_setting, config_setting, setting, ENV[key]].compact.reduce(nil) do |inherited, value|
+            expand_build_setting(value, inherited)
+          end
+        end
+
+        #---------------------------------------------------------------------#
+
+        private
+
+        VARIABLE_NAME_PATTERN =
+          '( # capture block
+            [_a-zA-Z0-9]+? # non-greedy lookup for everything contained in this list
+          )'.freeze
+        private_constant :VARIABLE_NAME_PATTERN
+
+        CAPTURE_VARIABLE_IN_BUILD_CONFIG = /
+            \$ # matches dollar sign literally
+            (?: # non-capturing group
+              [{] # matches a single character on this list
+                #{VARIABLE_NAME_PATTERN}
+              [}] # matches a single character on this list
+              | # or
+              [(] # matches a single character on this list
+                #{VARIABLE_NAME_PATTERN}
+              [)] # matches a single character on this list
+            )
+          /x
+        private_constant :CAPTURE_VARIABLE_IN_BUILD_CONFIG
+
+        def expand_build_setting(build_setting_value, config_value)
+          if build_setting_value.is_a?(Array) && config_value.is_a?(String)
+            config_value = split_build_setting_array_to_string(config_value)
+          elsif build_setting_value.is_a?(String) && config_value.is_a?(Array)
+            build_setting_value = split_build_setting_array_to_string(build_setting_value)
+          end
+
+          default = build_setting_value.is_a?(String) ? '' : []
+          inherited = config_value || default
+
+          return build_setting_value.gsub(Regexp.union(Constants::INHERITED_KEYWORDS), inherited) if build_setting_value.is_a? String
+          build_setting_value.flat_map { |value| Constants::INHERITED_KEYWORDS.include?(value) ? inherited : value }
+        end
+
+        def resolve_variable_substitution(key, value, root_target, previous_key = nil)
+          case value
+          when Array
+            return value.map { |v| resolve_variable_substitution(key, v, root_target) }
+          when nil
+            return
+          when String
+            # we know how to resolve strings!
+            nil
+          else
+            raise ArgumentError, "Settings values can only be nil, string, or array, got #{value.inspect} for #{key}"
+          end
+
+          unless variable_match_data = value.match(CAPTURE_VARIABLE_IN_BUILD_CONFIG)
+            # no variables left, return the value unchanged
+            return value
+          end
+          variable_reference, variable = *variable_match_data.values_at(0, 1, 2).compact
+
+          case variable
+          when 'inherited'
+            # this is handled separately, after resolving all other variable references
+            value
+          when key
+            # to prevent infinite recursion
+            nil
+          when previous_key
+            # to prevent infinite recursion; we don't return nil as for the self recursion because it needs to be
+            # distinguished outside this method too
+            MUTUAL_RECURSION_SENTINEL
+          else
+            configuration_to_resolve_against = root_target ? root_target.build_configuration_list[name] : self
+            resolved_value_for_variable = configuration_to_resolve_against.resolve_build_setting(variable, root_target, key) || ''
+
+            # we use this sentinel string instead of nil, because, otherwise, it would be swallowed by the default empty
+            # string from the preceding line, and we want to distinguish between mutual recursion and other cases
+            if resolved_value_for_variable == MUTUAL_RECURSION_SENTINEL
+              return MUTUAL_RECURSION_SENTINEL
+            end
+
+            value = value.gsub(variable_reference, resolved_value_for_variable)
+            resolve_variable_substitution(key, value, root_target)
+          end
+        end
+
+        def sorted_build_settings
+          sorted = {}
+          build_settings.keys.sort.each do |key|
+            sorted[key] = build_settings[key]
+          end
+          sorted
+        end
+
+        def normalize_array_settings(settings)
+          return unless settings
+
+          array_settings = BuildSettingsArraySettingsByObjectVersion[project.object_version]
+
+          settings.keys.each do |key|
+            next unless value = settings[key]
+            stripped_key = key.sub(/\[[^\]]+\]$/, '')
+            case value
+            when String
+              next unless array_settings.include?(stripped_key)
+              array_value = split_build_setting_array_to_string(value)
+              next unless array_value.size > 1
+              settings[key] = array_value
+            when Array
+              next if value.size > 1 && array_settings.include?(stripped_key)
+              settings[key] = value.join(' ')
+            end
+          end
+        end
+
+        def split_build_setting_array_to_string(string)
+          regexp = / *((['"]?).*?[^\\]\2)(?=( |\z))/
+          string.scan(regexp).map(&:first)
+        end
+
+        def config
+          return {} unless base_configuration_reference
+          @config ||=
+            if base_configuration_reference.real_path.exist?
+              Xcodeproj::Config.new(base_configuration_reference.real_path).to_hash.tap do |hash|
+                normalize_array_settings(hash)
+              end
+            else
+              {}
+            end
+        end
+
+        #---------------------------------------------------------------------#
+      end
+    end
+  end
+end
+
+require 'xcodeproj/project/object/helpers/build_settings_array_settings_by_object_version'

data/lib/xcodeproj/project/object/build_file.rb

@@ -0,0 +1,84 @@
+module Xcodeproj
+  class Project
+    module Object
+      # Contains the information about the build settings of a file used by an
+      # {AbstractBuildPhase}.
+      #
+      class PBXBuildFile < AbstractObject
+        # @!group Attributes
+
+        # @return [Hash] the list of build settings for this file.
+        #
+        # @note   The contents of this array depend on the phase of the build
+        #         file.
+        #
+        #         For PBXHeadersBuildPhase is `{ "ATTRIBUTES" => [:value] }`
+        #         where `:value` can be `Public`, `Private`, or nil
+        #         (Protected).
+        #
+        attribute :settings, Hash
+
+        # @return [PBXFileReference] the file to build.
+        #
+        # @todo   I think that is possible to add any kind of group (for
+        #         example folders linked to a path).
+        #
+        has_one :file_ref, [
+          PBXFileReference,
+          PBXGroup,
+          PBXVariantGroup,
+          XCVersionGroup,
+          PBXReferenceProxy,
+        ]
+
+        # @return [XCSwiftPackageProductDependency] the Swift Package file to build.
+        #
+        has_one :product_ref, XCSwiftPackageProductDependency
+
+        # @return [String] the platform filter for this build file.
+        #
+        attribute :platform_filter, String
+
+        # @return [Array<String>] the platform filters for this build file.
+        #
+        attribute :platform_filters, Array
+
+        #---------------------------------------------------------------------#
+
+        public
+
+        # @!group AbstractObject Hooks
+
+        # @return [String] A name suitable for displaying the object to the
+        #         user.
+        #
+        def display_name
+          if product_ref
+            product_ref.display_name
+          elsif file_ref
+            file_ref.display_name
+          else
+            super
+          end
+        end
+
+        # @return [Hash{String => Hash}, String] A hash suitable to display the
+        #         object to the user.
+        #
+        def pretty_print
+          if settings.nil? || settings.empty?
+            display_name
+          else
+            { display_name => settings }
+          end
+        end
+
+        def ascii_plist_annotation
+          " #{display_name} in #{GroupableHelper.parent(self).display_name} "
+        end
+
+        #---------------------------------------------------------------------#
+      end
+    end
+  end
+end

data/lib/xcodeproj/project/object/build_phase.rb

@@ -0,0 +1,369 @@
+module Xcodeproj
+  class Project
+    module Object
+      # @abstract
+      #
+      # This class is abstract and it doesn't appear in the project document.
+      #
+      class AbstractBuildPhase < AbstractObject
+        # @!group Attributes
+
+        # @return [ObjectList<PBXBuildFile>] the files processed by this build
+        #         configuration.
+        #
+        has_many :files, PBXBuildFile
+
+        # @return [String] some kind of magic number which usually is
+        #         '2147483647' (can be also `8` and `12` in
+        #         PBXCopyFilesBuildPhase, one of the masks is
+        #         run_only_for_deployment_postprocessing).
+        #
+        attribute :build_action_mask, String, '2147483647'
+
+        # @return [String] whether or not this should only be processed before
+        #         deployment. Can be either '0', or '1'.
+        #
+        # @note   This option is exposed in Xcode in the UI of
+        #         PBXCopyFilesBuildPhase as `Copy only when installing` or in
+        #         PBXShellScriptBuildPhase as `Run script only when
+        #         installing`.
+        #
+        attribute :run_only_for_deployment_postprocessing, String, '0'
+
+        # @return [String] whether or not this run script will be forced to
+        #         run even on incremental builds. Can be either '1', or
+        #         missing. By default this option is disabled in Xcode.
+        #
+        # @note   This setting is exposed in Xcode in the UI of
+        #         PBXShellScriptBuildPhase as `Based on
+        #         dependency analysis` (selected by default).
+        #
+        attribute :always_out_of_date, String
+
+        # @return [String] Comments associated with this build phase.
+        #
+        # @note   This is apparently no longer used by Xcode.
+        #
+        attribute :comments, String
+
+        #--------------------------------------#
+
+        public
+
+        # @!group Helpers
+
+        # @return [Array<PBXFileReference>] the list of all the files
+        #         referenced by this build phase.
+        #
+        def files_references
+          files.map(&:file_ref)
+        end
+
+        # @return [Array<String>] The display name of the build files.
+        #
+        def file_display_names
+          files.map(&:display_name)
+        end
+
+        # @return [PBXBuildFile] the first build file associated with the given
+        #         file reference if one exists.
+        #
+        def build_file(file_ref)
+          (file_ref.referrers & files).first
+        end
+
+        # Returns whether a build file for the given file reference exists.
+        #
+        # @param  [PBXFileReference] file_ref
+        #
+        # @return [Bool] whether the reference is already present.
+        #
+        def include?(file_ref)
+          !build_file(file_ref).nil?
+        end
+
+        # Adds a new build file, initialized with the given file reference, to
+        # the phase.
+        #
+        # @param  [PBXFileReference] file_ref
+        #         The file reference that should be added to the build phase.
+        #
+        # @return [PBXBuildFile] the build file generated.
+        #
+        def add_file_reference(file_ref, avoid_duplicates = false)
+          if avoid_duplicates && existing = build_file(file_ref)
+            existing
+          else
+            build_file = project.new(PBXBuildFile)
+            build_file.file_ref = file_ref
+            files << build_file
+            build_file
+          end
+        end
+
+        # Removes the build file associated with the given file reference from
+        # the phase.
+        #
+        # @param  [PBXFileReference] file_ref
+        #         The file to remove
+        #
+        # @return [void]
+        #
+        def remove_file_reference(file_ref)
+          build_file = files.find { |bf| bf.file_ref == file_ref }
+          remove_build_file(build_file) if build_file
+        end
+
+        # Removes a build file from the phase and clears its relationship to
+        # the file reference.
+        #
+        # @param  [PBXBuildFile] build_file the file to remove
+        #
+        # @return [void]
+        #
+        def remove_build_file(build_file)
+          build_file.file_ref = nil
+          build_file.remove_from_project
+        end
+
+        # Removes all the build files from the phase and clears their
+        # relationship to the file reference.
+        #
+        # @return [void]
+        #
+        def clear
+          files.objects.each do |bf|
+            remove_build_file(bf)
+          end
+        end
+        alias_method :clear_build_files, :clear
+
+        def display_name
+          super.gsub(/BuildPhase$/, '')
+        end
+
+        def ascii_plist_annotation
+          " #{display_name} "
+        end
+
+        # Sorts the build files of the phase according to the display
+        # name or the path.
+        #
+        # @param  [Hash] _options
+        #         Not used.
+        #
+        # @return [void]
+        #
+        def sort(_options = nil)
+          files.sort! do |x, y|
+            result = File.basename(x.display_name.downcase, '.*') <=> File.basename(y.display_name.downcase, '.*')
+            if result.zero?
+              result = File.extname(x.display_name.downcase) <=> File.extname(y.display_name.downcase)
+              if result.zero? && x.file_ref.respond_to?(:full_path) && y.file_ref.respond_to?(:full_path)
+                result = x.file_ref.full_path.to_s.downcase <=> y.file_ref.full_path.to_s.downcase
+              end
+            end
+            result
+          end
+        end
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # The phase responsible of copying headers. Known as `Copy Headers` in
+      # the UI.
+      #
+      # @note This phase can appear only once in a target.
+      #
+      class PBXHeadersBuildPhase < AbstractBuildPhase
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # The phase responsible of compiling the files. Known as `Compile
+      # Sources` in the UI.
+      #
+      # @note This phase can appear only once in a target.
+      #
+      class PBXSourcesBuildPhase < AbstractBuildPhase
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # The phase responsible on linking with frameworks. Known as `Link Binary
+      # With Libraries` in the UI.
+      #
+      # @note This phase can appear only once in a target.
+      #
+      class PBXFrameworksBuildPhase < AbstractBuildPhase
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # The resources build phase apparently is a specialized copy build phase
+      # for resources. Known as `Copy Bundle Resources` in the UI. It is
+      # unclear if this is the only one capable of optimizing PNG.
+      #
+      # @note This phase can appear only once in a target.
+      #
+      class PBXResourcesBuildPhase < AbstractBuildPhase
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # Phase that copies the files to the bundle of the target (aka `Copy
+      # Files`).
+      #
+      # @note This phase can appear multiple times in a target.
+      #
+      class PBXCopyFilesBuildPhase < AbstractBuildPhase
+        # @!group Attributes
+
+        # @return [String] the name of the build phase.
+        #
+        attribute :name, String
+
+        # @return [String] the subpath of `dst_subfolder_spec` where this file
+        #         should be copied to.
+        #
+        # @note   Can accept environment variables like `$(PRODUCT_NAME)`.
+        #
+        attribute :dst_path, String, ''
+
+        # @return [String] the path (destination) where the files should be
+        #         copied to.
+        #
+        attribute :dst_subfolder_spec, String, Constants::COPY_FILES_BUILD_PHASE_DESTINATIONS[:resources]
+
+        # @return [Hash{String => Hash}] A hash suitable to display the build
+        #         phase to the user.
+        #
+        def pretty_print
+          {
+            display_name => {
+              'Destination Path' => dst_path,
+              'Destination Subfolder' => Constants::COPY_FILES_BUILD_PHASE_DESTINATIONS.key(dst_subfolder_spec).to_s,
+              'Files' => files.map(&:pretty_print),
+            },
+          }
+        end
+
+        # Alias method for #dst_subfolder_spec=, which accepts symbol values
+        # instead of numeric string values.
+        #
+        # @param [Symbol] value
+        #        one of `COPY_FILES_BUILD_PHASE_DESTINATIONS.keys`
+        #
+        # @raise [StandardError] if value is not a valid known key
+        #
+        def symbol_dst_subfolder_spec=(value)
+          numeric_value = Constants::COPY_FILES_BUILD_PHASE_DESTINATIONS[value]
+          raise "[Xcodeproj] Value checking error: got `#{value.inspect}` for" \
+              ' attribute: dst_subfolder_spec' if numeric_value.nil?
+          self.dst_subfolder_spec = numeric_value
+        end
+
+        # Alias method for #dst_subfolder_spec, which returns symbol values
+        # instead of numeric string values.
+        #
+        # @return [Symbol]
+        #
+        def symbol_dst_subfolder_spec
+          key = Constants::COPY_FILES_BUILD_PHASE_DESTINATIONS.find { |_, num| num == dst_subfolder_spec }
+          key ? key.first : nil
+        end
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # A phase responsible of running a shell script (aka `Run Script`).
+      #
+      # @note This phase can appear multiple times in a target.
+      #
+      class PBXShellScriptBuildPhase < AbstractBuildPhase
+        # @!group Attributes
+
+        # @return [String] the name of the build phase.
+        #
+        attribute :name, String
+
+        # @return [Array<String>] an array of the paths to pass to the script.
+        #
+        # @example
+        #   "$(SRCROOT)/myfile"
+        #
+        attribute :input_paths, Array, []
+
+        # @return [Array<String>] an array of input file list paths of the script.
+        #
+        # @example
+        #   "$(SRCROOT)/newInputFile.xcfilelist"
+        #
+        attribute :input_file_list_paths, Array, []
+
+        # @return [Array<String>] an array of output paths of the script.
+        #
+        # @example
+        #   "$(DERIVED_FILE_DIR)/myfile"
+        #
+        attribute :output_paths, Array, []
+
+        # @return [Array<String>] an array of output file list paths of the script.
+        #
+        # @example
+        #   "$(SRCROOT)/newOutputFile.xcfilelist"
+        #
+        attribute :output_file_list_paths, Array, []
+
+        # @return [String] the path to the script interpreter.
+        #
+        # @note   Defaults to `/bin/sh`.
+        #
+        attribute :shell_path, String, '/bin/sh'
+
+        # @return [String] the actual script to perform.
+        #
+        # @note   Defaults to a comment string.
+        #
+        attribute :shell_script, String, "# Type a script or drag a script file from your workspace to insert its path.\n"
+
+        # @return [String] whether or not the ENV variables should be shown in
+        #         the build log.
+        #
+        attribute :show_env_vars_in_log, String
+
+        # @return [String] the discovered dependency file to use.
+        #
+        attribute :dependency_file, String
+
+        # @return [Hash{String => Hash}] A hash suitable to display the build
+        #         phase to the user.
+        #
+        def pretty_print
+          {
+            display_name => {
+              'Input File List Paths' => input_file_list_paths || [],
+              'Input Paths' => input_paths || [],
+              'Output File List Paths' => output_file_list_paths || [],
+              'Output Paths' => output_paths || [],
+              'Shell Path' => shell_path,
+              'Shell Script' => shell_script,
+            },
+          }
+        end
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # Apparently a build phase named `Build Carbon Resources` (Observed for
+      # kernel extensions targets).
+      #
+      # @note This phase can appear multiple times in a target.
+      #
+      class PBXRezBuildPhase < AbstractBuildPhase
+      end
+
+      #-----------------------------------------------------------------------#
+    end
+  end
+end