plasmo_xcodeproj 1.21.1

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

@@ -0,0 +1,109 @@
+module Xcodeproj
+  class Project
+    module Object
+      # This class represents a custom build rule of a Target.
+      #
+      class PBXBuildRule < AbstractObject
+        # @!group Attributes
+
+        # @return [String] the name of the rule.
+        #
+        attribute :name, String
+
+        # @return [String] a string representing what compiler to use.
+        #
+        # @example
+        #   `com.apple.compilers.proxy.script`.
+        #
+        attribute :compiler_spec, String
+
+        # @return [String] the discovered dependency file to use.
+        #
+        # @example
+        #   `$(DERIVED_FILES_DIR)/$(INPUT_FILE_NAME).d`.
+        #
+        attribute :dependency_file, String
+
+        # @return [String] the type of the files that should be processed by
+        #         this rule.
+        #
+        # @example
+        #   `pattern.proxy`.
+        #
+        attribute :file_type, String
+
+        # @return [String] the pattern of the files that should be processed by
+        #         this rule. This attribute is an alternative to to
+        #         `file_type`.
+        #
+        # @example
+        #   `*.css`.
+        #
+        attribute :file_patterns, String
+
+        # @return [String] whether the rule is editable.
+        #
+        # @example
+        #   `1`.
+        #
+        attribute :is_editable, String, '1'
+
+        # @return [ObjectList<PBXFileReference>] the file references for the
+        #         input files files.
+        #
+        attribute :input_files, Array
+
+        # @return [ObjectList<PBXFileReference>] the file references for the
+        #         output files.
+        #
+        attribute :output_files, Array
+
+        # @return [ObjectList<String>] the compiler flags used when creating the
+        #         respective output files.
+        #
+        attribute :output_files_compiler_flags, Array
+
+        # @return [String] whether the rule should be run once per architecture.
+        #
+        # @example
+        #   `0`.
+        #
+        attribute :run_once_per_architecture, String
+
+        # @return [String] the content of the script to use for the build rule.
+        #
+        # @note   This attribute is present if the #{#compiler_spec} is
+        #         `com.apple.compilers.proxy.script`
+        #
+        attribute :script, String
+
+        # @!group Helpers
+
+        # Adds an output file with the specified compiler flags.
+        #
+        # @param  [PBXFileReference] file the file to add.
+        #
+        # @param  [String] compiler_flags the compiler flags for the file.
+        #
+        # @return [Void]
+        #
+        def add_output_file(file, compiler_flags = '')
+          (self.output_files ||= []) << file
+          (self.output_files_compiler_flags ||= []) << compiler_flags
+        end
+
+        # @return [Array<[PBXFileReference, String]>]
+        #         An array containing tuples of output files and their compiler
+        #         flags.
+        #
+        def output_files_and_flags
+          (output_files || []).zip(output_files_compiler_flags || [])
+        end
+
+        def ascii_plist_annotation
+          " #{isa} "
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+module Xcodeproj
+  class Project
+    module Object
+      # The primary purpose of this class is to maintain a collection of
+      # related build configurations of a {PBXProject} or a {PBXNativeTarget}.
+      #
+      class XCConfigurationList < AbstractObject
+        # @!group Attributes
+
+        # @return [String] whether the default configuration is visible.
+        #         Usually `0`. The purpose of this flag and how Xcode displays
+        #         it in the UI is unknown.
+        #
+        attribute :default_configuration_is_visible, String, '0'
+
+        # @return [String] the name of the default configuration.
+        #         Usually `Release`. Xcode exposes this attribute as the
+        #         configuration for the command line tools and only allows to
+        #         set it at the project level.
+        #
+        attribute :default_configuration_name, String, 'Release'
+
+        # @return [ObjectList<XCBuildConfiguration>] the build
+        #         configurations of the target.
+        #
+        has_many :build_configurations, XCBuildConfiguration
+
+        public
+
+        # @!group Helpers
+        # --------------------------------------------------------------------#
+
+        # Returns the build configuration with the given name.
+        #
+        # @param  [String] name
+        #         The name of the build configuration.
+        #
+        # @return [XCBuildConfiguration] The build configuration.
+        # @return [Nil] If not build configuration with the given name is found.
+        #
+        def [](name)
+          build_configurations.find { |bc| bc.name == name }
+        end
+
+        # Returns the build settings of the build configuration with
+        # the given name.
+        #
+        # @param [String] build_configuration_name
+        #        The name of the build configuration.
+        #
+        # @return [Hash {String=>String}] the build settings
+        #
+        def build_settings(build_configuration_name)
+          if config = self[build_configuration_name]
+            config.build_settings
+          end
+        end
+
+        # Gets the value for the given build setting in all the build
+        # configurations.
+        #
+        # @param [String] key
+        #        the key of the build setting.
+        #
+        # @param [Bool] resolve_against_xcconfig
+        #        wether the retrieved setting should take in consideration any
+        #        configuration file present.
+        #
+        # @param [PBXNativeTarget] root_target
+        #        use this to resolve complete recursion between project and targets
+        #
+        # @return [Hash{String => String}] The value of the build setting
+        #         grouped by the name of the build configuration.
+        #
+        def get_setting(key, resolve_against_xcconfig = false, root_target = nil)
+          result = {}
+          build_configurations.each do |bc|
+            result[bc.name] = resolve_against_xcconfig ? bc.resolve_build_setting(key, root_target) : bc.build_settings[key]
+          end
+          result
+        end
+
+        # Sets the given value for the build setting associated with the given
+        # key across all the build configurations.
+        #
+        # @param [String] key
+        #        the key of the build setting.
+        #
+        # @param [String] value
+        #        the value for the build setting.
+        #
+        # @return [void]
+        #
+        def set_setting(key, value)
+          build_configurations.each do |bc|
+            bc.build_settings[key] = value
+          end
+        end
+
+        def target
+          return project.root_object if project.build_configuration_list.uuid == uuid
+          project.targets.find { |t| t.build_configuration_list.uuid == uuid }
+        end
+
+        #---------------------------------------------------------------------#
+
+        def ascii_plist_annotation
+          if target.nil?
+            ' Build configuration list for <deleted target> '
+          else
+            " Build configuration list for #{target.isa} \"#{target}\" "
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+module Xcodeproj
+  class Project
+    module Object
+      # Apparently a proxy for another object which might belong another
+      # project contained in the same workspace of the project document.
+      #
+      # This class is referenced by {PBXTargetDependency} for information about
+      # it usage see the specs of that class.
+      #
+      # @note  This class references the other objects by UUID instead of
+      #        creating proper relationships because the other objects might be
+      #        part of another project. This implies that the references to
+      #        other objects should not increase the retain count of the
+      #        targets.
+      #
+      # @todo: This class needs some work to support targets across workspaces,
+      #        as the container portal might not be initialized leading
+      #        xcodeproj to raise because ti can't find the UUID.
+      #
+      class PBXContainerItemProxy < AbstractObject
+        # @!group Attributes
+
+        # @return [String] apparently the UUID of the root object
+        #         {PBXProject} of the project containing the represented
+        #         object.
+        #
+        # @todo   this is an attribute because a it is usually a reference to
+        #         the root object or to a file reference to another project.
+        #         The reference to the root object causes a retain cycle that
+        #         could cause issues (e.g. in to_tree_hash). Usually those
+        #         objects are retained by at least another object (the
+        #         {Project} for the root object and a {PBXGroup} for the
+        #         reference to another project) and so the referenced object
+        #         should be serialized.
+        #
+        #         If this assumption is incorrect, there could be loss of
+        #         information opening and saving an existing project.
+        #
+        # @todo   This is the external reference that 'contains' other proxy
+        #         items.
+        attribute :container_portal, String
+
+        # @return [String] the type of the proxy.
+        #
+        # @note   @see {Constants::PROXY_TYPE.values} for valid values.
+        #
+        attribute :proxy_type, String
+
+        # @return [String] apparently the UUID of the represented
+        #         object.
+        #
+        # @note   If the object is in another project the UUID would not be
+        #         present in the {Project#objects_by_uuid} hash. For this
+        #         reason this is not an `has_one` attribute. It is assumes that
+        #         if the object belongs to the project at least another object
+        #         should be retaining it. This assumption is reasonable because
+        #         this is a proxy class.
+        #
+        #         If this assumption is incorrect, there could be loss of
+        #         information opening and saving an existing project.
+        #
+        attribute :remote_global_id_string, String
+
+        # @return [String] apparently the name of the object represented by
+        #         the proxy.
+        #
+        attribute :remote_info, String
+
+        # Checks whether the reference points to a remote project.
+        #
+        # @return [Bool]
+        #
+        def remote?
+          project.root_object.uuid != container_portal
+        end
+
+        # Get the proxied object
+        #
+        # @return [AbstractObject]
+        #
+        def proxied_object
+          container_portal_object.objects_by_uuid[remote_global_id_string]
+        end
+
+        def container_portal_object
+          if remote?
+            container_portal_file_ref = project.objects_by_uuid[container_portal]
+            Project.open(container_portal_file_ref.real_path)
+          else
+            project
+          end
+        end
+
+        def container_portal_annotation
+          if remote?
+            " #{File.basename(project.objects_by_uuid[container_portal].real_path)} "
+          else
+            project.root_object.ascii_plist_annotation
+          end
+        end
+
+        def to_hash_as(method = :to_hash)
+          hash = super
+          if method == :to_ascii_plist
+            hash['containerPortal'] = Nanaimo::String.new(container_portal, container_portal_annotation)
+          end
+          hash
+        end
+
+        def ascii_plist_annotation
+          " #{isa} "
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,338 @@
+require 'xcodeproj/project/object/helpers/groupable_helper'
+
+module Xcodeproj
+  class Project
+    module Object
+      # This class represents a reference to a file in the file system.
+      #
+      class PBXFileReference < AbstractObject
+        # @!group Attributes
+
+        # @return [String] the name of the reference, often not present.
+        #
+        attribute :name, String
+
+        # @return [String] the path to the file relative to the source tree
+        #
+        attribute :path, String
+
+        # @return [String] the directory to which the path is relative.
+        #
+        # @note   The accepted values are:
+        #         - `<absolute>` for absolute paths
+        #         - `<group>` for paths relative to the group
+        #         - `SOURCE_ROOT` for paths relative to the project
+        #         - `DEVELOPER_DIR` for paths relative to the developer
+        #           directory.
+        #         - `BUILT_PRODUCTS_DIR` for paths relative to the build
+        #           products directory.
+        #         - `SDKROOT` for paths relative to the SDK directory.
+        #
+        attribute :source_tree, String, 'SOURCE_ROOT'
+
+        # @return [String] the file type (apparently) used for products
+        #         generated by Xcode (i.e. applications, libraries).
+        #
+        attribute :explicit_file_type, String
+
+        # @return [String] the file type guessed by Xcode.
+        #
+        # @note   This attribute is not present if there is an
+        #         `explicit_file_type`.
+        #
+        attribute :last_known_file_type, String
+
+        # @return [String] whether this file should be indexed. It can
+        #         be either `0` or `1`.
+        #
+        # @note   Apparently present only for products generated by Xcode with
+        #         a value of `0`.
+        #
+        attribute :include_in_index, String, '1'
+
+        # @return [String] a string containing a number which represents the
+        #         encoding format of the file.
+        #
+        attribute :fileEncoding, String
+
+        # @return [String] a string that specifies the UTI for the syntax
+        #         highlighting.
+        #
+        # @example
+        #   `xcode.lang.ruby`
+        #
+        attribute :xc_language_specification_identifier, String
+
+        # @return [String] a string that specifies the UTI for the structure of
+        #         a plist file.
+        #
+        # @example
+        #   `com.apple.xcode.plist.structure-definition.iphone.info-plist`
+        #
+        attribute :plist_structure_definition_identifier, String
+
+        # @return [String] Whether Xcode should use tabs for text alignment.
+        #
+        # @example
+        #   `1`
+        #
+        attribute :uses_tabs, String
+
+        # @return [String] The width of the indent.
+        #
+        # @example
+        #   `2`
+        #
+        attribute :indent_width, String
+
+        # @return [String] The width of the tabs.
+        #
+        # @example
+        #   `2`
+        #
+        attribute :tab_width, String
+
+        # @return [String] Whether Xcode should wrap lines.
+        #
+        # @example
+        #   `1`
+        #
+        attribute :wraps_lines, String
+
+        # @return [String] Apparently whether Xcode should add, if needed, a
+        #         new line feed before saving the file.
+        #
+        # @example
+        #   `0`
+        #
+        attribute :line_ending, String
+
+        # @return [String] Comments associated with this file.
+        #
+        # @note   This is apparently no longer used by Xcode.
+        #
+        attribute :comments, String
+
+        #---------------------------------------------------------------------#
+
+        public
+
+        # @!group Helpers
+
+        # @return [String] the name of the file taking into account the path if
+        #         needed.
+        #
+        def display_name
+          if name
+            name
+          elsif (class << GroupableHelper; self; end)::SOURCE_TREES_BY_KEY[:built_products] == source_tree
+            path
+          elsif path
+            File.basename(path)
+          end
+        end
+
+        # @return [PBXGroup, PBXProject] the parent of the file.
+        #
+        def parent
+          GroupableHelper.parent(self)
+        end
+
+        # @return [Array<PBXGroup, PBXProject>] The list of the parents of the
+        #         reference.
+        #
+        def parents
+          GroupableHelper.parents(self)
+        end
+
+        # @return [String] A representation of the reference hierarchy.
+        #
+        def hierarchy_path
+          GroupableHelper.hierarchy_path(self)
+        end
+
+        # Moves the reference to a new parent.
+        #
+        # @param  [PBXGroup] new_parent
+        #         The new parent.
+        #
+        # @return [void]
+        #
+        def move(new_parent)
+          GroupableHelper.move(self, new_parent)
+        end
+
+        # @return [Pathname] the absolute path of the file resolving the
+        # source tree.
+        #
+        def real_path
+          GroupableHelper.real_path(self)
+        end
+
+        # @return [Pathname] the path of the file without resolving the
+        # source tree.
+        #
+        def full_path
+          GroupableHelper.full_path(self)
+        end
+
+        # Sets the source tree of the reference.
+        #
+        # @param  [Symbol, String] source_tree
+        #         The source tree, either a string or a symbol.
+        #
+        # @return [void]
+        #
+        def set_source_tree(source_tree)
+          GroupableHelper.set_source_tree(self, source_tree)
+        end
+
+        # Allows to set the path according to the source tree of the reference.
+        #
+        # @param  [#to_s] the path for the reference.
+        #
+        # @return [void]
+        #
+        def set_path(path)
+          if path
+            GroupableHelper.set_path_with_source_tree(self, path, source_tree)
+          else
+            self.path = nil
+          end
+        end
+
+        # @return [Array<PBXBuildFile>] the build files associated with the
+        #         current file reference.
+        #
+        def build_files
+          referrers.grep(PBXBuildFile)
+        end
+
+        # Sets the last known file type according to the extension of the path.
+        #
+        # @return [void]
+        #
+        def set_last_known_file_type(type = nil)
+          if type
+            self.last_known_file_type = type
+          elsif path
+            extension = Pathname(path).extname[1..-1]
+            self.last_known_file_type = Constants::FILE_TYPES_BY_EXTENSION[extension]
+          end
+        end
+
+        # Sets the explicit file type according to the extension of the path,
+        # and clears the last known file type.
+        #
+        # @return [void]
+        #
+        def set_explicit_file_type(type = nil)
+          self.last_known_file_type = nil
+          if type
+            self.explicit_file_type = type
+          elsif path
+            extension = Pathname(path).extname[1..-1]
+            self.explicit_file_type = Constants::FILE_TYPES_BY_EXTENSION[extension]
+          end
+        end
+
+        #---------------------------------------------------------------------#
+
+        # Checks whether the reference is a proxy.
+        #
+        # @return [Bool] always false for this ISA.
+        #
+        def proxy?
+          false
+        end
+
+        # If this file reference represents an external Xcode project reference
+        # then this will return metadata about it which includes the reference
+        # to the 'Products' group that's created in this project (the project
+        # that includes the external project).
+        #
+        # @return [ObjectDictionary, nil] The external project metadata for
+        #         this file reference or `nil` if it's not an external project.
+        #
+        def project_reference_metadata
+          project.root_object.project_references.find do |project_reference|
+            project_reference[:project_ref] == self
+          end
+        end
+
+        # If this file reference represents an external Xcode project reference
+        # then this will return the objects that are 'containers' for items
+        # contained in the external Xcode project.
+        #
+        # @return [Array<PBXContainerItemProxy>] The containers for items in
+        #         the external Xcode project.
+        #
+        def proxy_containers
+          project.objects.select do |object|
+            object.isa == 'PBXContainerItemProxy' &&
+              object.container_portal == uuid
+          end
+        end
+
+        # If this file reference represents an external Xcode project reference
+        # then this will return proxies for file references contained in the
+        # external Xcode project.
+        #
+        # @return [Array<PBXReferenceProxy>] The file reference proxies for
+        #         items located in the external Xcode project.
+        #
+        def file_reference_proxies
+          containers = proxy_containers
+          if containers.empty?
+            []
+          else
+            project.objects.select do |object|
+              object.isa == 'PBXReferenceProxy' &&
+                containers.include?(object.remote_ref)
+            end
+          end
+        end
+
+        # If this file reference represents an external Xcode project reference
+        # then this will return dependencies on targets contained in the
+        # external Xcode project.
+        #
+        # @return [Array<PBXTargetDependency>] The dependencies on targets
+        #         located in the external Xcode project.
+        #
+        def target_dependency_proxies
+          containers = proxy_containers
+          if containers.empty?
+            []
+          else
+            project.objects.select do |object|
+              object.isa == 'PBXTargetDependency' &&
+                containers.include?(object.target_proxy)
+            end
+          end
+        end
+
+        # In addition to removing the file reference, this will also remove any
+        # items related to this reference.
+        #
+        # @see AbstractObject#remove_from_project
+        #
+        # @return [void]
+        #
+        def remove_from_project
+          if project_reference = project_reference_metadata
+            file_reference_proxies.each(&:remove_from_project)
+            target_dependency_proxies.each(&:remove_from_project)
+            project_reference[:product_group].remove_from_project
+            project.root_object.project_references.delete(project_reference)
+          end
+
+          build_files.each(&:remove_from_project)
+          super
+        end
+
+        #---------------------------------------------------------------------#
+      end
+    end
+  end
+end