RubyMotion/lib/motion/project/template/ios-framework/config.rb

# encoding: utf-8

# Copyright (c) 2012, HipByte SPRL and contributors
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
#    list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

require 'motion/project/xcode_config'

module Motion; module Project;
  class IOSFrameworkConfig < XcodeConfig
    register :'ios-framework'

    # variable :device_family, :interface_orientations, :background_modes,
    #   :status_bar_style, :icons, :prerendered_icon, :fonts, :seed_id,
    #   :provisioning_profile, :manifest_assets

    variable :device_family, :manifest_assets

    def initialize(project_dir, build_mode)
      super
      @frameworks = ['UIKit', 'Foundation', 'CoreGraphics']
      @device_family = :iphone
      # @interface_orientations = [:portrait, :landscape_left, :landscape_right]
      # @background_modes = []
      # @status_bar_style = :default
      # @icons = []
      # @prerendered_icon = false
      @manifest_assets = []
    end

    def platforms; ['iPhoneSimulator', 'iPhoneOS']; end
    def local_platform; 'iPhoneSimulator'; end
    def deploy_platform; 'iPhoneOS'; end

    def archs
      @archs ||= begin
        # By default, do not build with 64-bit, as it's still experimental.
        archs = super
        archs['iPhoneSimulator'].delete('x86_64')
        archs['iPhoneOS'].delete('arm64')
        archs
      end
    end

    # TODO datadir should not depend on the template name
    def datadir(target=deployment_target)
      File.join(motiondir, 'data', 'ios', target)
    end

    # def app_icons_info_plist_path(platform)
    #   File.expand_path(File.join(versionized_build_dir(platform), 'AppIcon.plist'))
    # end

    # def configure_app_icons_from_asset_bundle(platform)
    #   path = app_icons_info_plist_path(platform)
    #   if File.exist?(path)
    #     content = `/usr/libexec/PlistBuddy -c 'Print :CFBundleIcons:CFBundlePrimaryIcon:CFBundleIconFiles' "#{path}"`.strip
    #     self.icons = content.split("\n")[1..-2].map(&:strip)
    #   end
    # end

    def validate
      # icons
      # if !(icons.is_a?(Array) and icons.all? { |x| x.is_a?(String) })
      #   App.fail "app.icons should be an array of strings."
      # end

      # manifest_assets
      if !(manifest_assets.is_a?(Array) and manifest_assets.all? { |x| x.is_a?(Hash) and x.keys.include?(:kind) and x.keys.include?(:url) })
        App.fail "app.manifest_assets should be an array of hashes with values for the :kind and :url keys"
      end

      super
    end

    def locate_compiler(platform, *execs)
      paths = [File.join(platform_dir(platform), 'Developer/usr/bin')]
      paths.unshift File.join(xcode_dir, 'Toolchains/XcodeDefault.xctoolchain/usr/bin')

      execs.each do |exec|
        paths.each do |path|
          cc = File.join(path, exec)
          return escape_path(cc) if File.exist?(cc)
        end
      end
      App.fail "Can't locate compilers for platform `#{platform}'"
    end

    # def archive_extension
    #   '.ipa'
    # end

    # def codesign_certificate
    #   super('iPhone')
    # end

    # def provisioning_profile(name = /iOS Team Provisioning Profile/)
    #   @provisioning_profile ||= begin
    #     paths = Dir.glob(File.expand_path("~/Library/MobileDevice/Provisioning\ Profiles/*.mobileprovision")).select do |path|
    #       text = File.read(path)
    #       text.force_encoding('binary') if RUBY_VERSION >= '1.9.0'
    #       text.scan(/<key>\s*Name\s*<\/key>\s*<string>\s*([^<]+)\s*<\/string>/)[0][0].match(name)
    #     end
    #     if paths.size == 0
    #       App.fail "Can't find a provisioning profile named `#{name}'"
    #     elsif paths.size > 1
    #       App.warn "Found #{paths.size} provisioning profiles named `#{name}'. Set the `provisioning_profile' project setting. Will use the first one: `#{paths[0]}'"
    #     end
    #     paths[0]
    #   end
    # end

    # def read_provisioned_profile_array(key)
    #   text = File.read(provisioning_profile)
    #   text.force_encoding('binary') if RUBY_VERSION >= '1.9.0'
    #   text.scan(/<key>\s*#{key}\s*<\/key>\s*<array>(.*?)\s*<\/array>/m)[0][0].scan(/<string>(.*?)<\/string>/).map { |str| str[0].strip }
    # end
    # private :read_provisioned_profile_array

    # def provisioned_devices
    #   @provisioned_devices ||= read_provisioned_profile_array('ProvisionedDevices')
    # end

    # def seed_id
    #   @seed_id ||= begin
    #     seed_ids = read_provisioned_profile_array('ApplicationIdentifierPrefix')
    #     if seed_ids.size == 0
    #       App.fail "Can't find an application seed ID in the provisioning profile `#{provisioning_profile}'"
    #     elsif seed_ids.size > 1
    #       App.warn "Found #{seed_ids.size} seed IDs in the provisioning profile. Set the `seed_id' project setting. Will use the last one: `#{seed_ids.last}'"
    #     end
    #     seed_ids.last
    #   end
    # end

    # def entitlements_data
    #   dict = entitlements
    #   if distribution_mode
    #     dict['application-identifier'] ||= seed_id + '.' + identifier
    #   else
    #     # Required for gdb.
    #     dict['get-task-allow'] = true if dict['get-task-allow'].nil?
    #   end
    #   Motion::PropertyList.to_s(dict)
    # end

    def common_flags(platform)
      simulator_version = begin
        flag = " -miphoneos-version-min=#{deployment_target}"
        if platform == "iPhoneSimulator"
          ver = xcode_version[0].match(/(\d+)/)
          if ver[0].to_i >= 5
            flag = " -mios-simulator-version-min=#{deployment_target}"
          end
        end
        flag
      end
      super + simulator_version
    end

    def cflags(platform, cplusplus)
      super + " -g -fobjc-legacy-dispatch -fobjc-abi-version=2"
    end

    def ldflags(platform)
      ldflags = super
      ldflags << " -fobjc-arc" if deployment_target < '5.0'
      ldflags
    end

    def bridgesupport_flags
      extra_flags = (OSX_VERSION >= 10.7 && sdk_version < '7.0') ? '--no-64-bit' : ''
      "--format complete #{extra_flags}"
    end

    def bridgesupport_cflags
      a = sdk_version.scan(/(\d+)\.(\d+)/)[0]
      sdk_version_headers = ((a[0].to_i * 10000) + (a[1].to_i * 100)).to_s
      "-miphoneos-version-min=#{sdk_version} -D__ENVIRONMENT_IPHONE_OS_VERSION_MIN_REQUIRED__=#{sdk_version_headers}"
    end

    def device_family_int(family)
      case family
        when :iphone then 1
        when :ipad then 2
        else
          App.fail "Unknown device_family value: `#{family}'"
      end
    end

    def device_family_string(device_name, family, target, retina)
      device = case family
        when :iphone, 1
          "iPhone"
        when :ipad, 2
          "iPad"
      end

      ver = xcode_version[0].match(/(\d+)/)
      case ver[0].to_i
      when 6
        (device_name.nil?) ? device + device_retina_xcode6_string(family, target, retina) : device_name
      when 5
        device + device_retina_xcode5_string(family, target, retina)
      else
        device + device_retina_xcode4_string(family, target, retina)
      end
    end

    # def device_retina_xcode4_string(family, target, retina)
    #   case retina
    #   when 'true'
    #     (family == 1 and target >= '6.0') ? ' (Retina 4-inch)' : ' (Retina)'
    #   when '3.5'
    #     ' (Retina 3.5-inch)'
    #   when '4'
    #     ' (Retina 4-inch)'
    #   else
    #     ''
    #   end
    # end

    # def device_retina_xcode5_string(family, target, retina)
    #   retina4_string = begin
    #     if (target >= '7.0' && App.config.archs['iPhoneSimulator'].include?("x86_64"))
    #       " Retina (4-inch 64-bit)"
    #     else
    #       " Retina (4-inch)"
    #     end
    #   end

    #   case retina
    #   when 'true'
    #     (family == 1 and target >= '6.0') ? retina4_string : ' Retina'
    #   when '3.5'
    #     ' Retina (3.5-inch)'
    #   when '4'
    #     ' Retina (4-inch)'
    #   else
    #     if target < '7.0'
    #       ''
    #     else
    #       (family == 1) ? retina4_string : ''
    #     end
    #   end
    # end

    # def device_retina_xcode6_string(family, target, retina)
    #   case retina
    #   when '3.5'
    #     ' 4s'
    #   when '4'
    #     ' 5s'
    #   else
    #     (family == 1) ? ' 5s' : ' Retina'
    #   end
    # end

    def device_family_ints
      ary = @device_family.is_a?(Array) ? @device_family : [@device_family]
      ary.map { |family| device_family_int(family) }
    end

    # def interface_orientations_consts
    #   @interface_orientations.map do |ori|
    #     case ori
    #       when :portrait then 'UIInterfaceOrientationPortrait'
    #       when :landscape_left then 'UIInterfaceOrientationLandscapeLeft'
    #       when :landscape_right then 'UIInterfaceOrientationLandscapeRight'
    #       when :portrait_upside_down then 'UIInterfaceOrientationPortraitUpsideDown'
    #       else
    #         App.fail "Unknown interface_orientation value: `#{ori}'"
    #     end
    #   end
    # end

    # def background_modes_consts
    #   @background_modes.map do |mode|
    #     case mode
    #       when :audio then 'audio'
    #       when :location then 'location'
    #       when :voip then 'voip'
    #       when :newsstand_content then 'newsstand-content'
    #       when :external_accessory then 'external-accessory'
    #       when :bluetooth_central then 'bluetooth-central'
    #       else
    #         App.fail "Unknown background_modes value: `#{mode}'"
    #     end
    #   end
    # end

    # def status_bar_style_const
    #   case @status_bar_style
    #     when :default then 'UIStatusBarStyleDefault'
    #     when :black_translucent then 'UIStatusBarStyleBlackTranslucent'
    #     when :black_opaque then 'UIStatusBarStyleBlackOpaque'
    #     when :light_content then 'UIStatusBarStyleLightContent'
    #     else
    #       App.fail "Unknown status_bar_style value: `#{@status_bar_style}'"
    #   end
    # end

    # def device_id
    #   @device_id ||= begin
    #     deploy = File.join(App.config.bindir, 'ios/deploy')
    #     device_id = `#{deploy} -D`.strip
    #     if device_id.empty?
    #       App.fail "Can't find an iOS device connected on USB"
    #     end
    #     device_id
    #   end
    # end

    def app_bundle(platform)
      File.join(versionized_build_dir(platform), bundle_name + '.framework')
    end

    def app_bundle_executable(platform)
      File.join(app_bundle(platform), name)
    end

    def app_resources_dir(platform)
      app_bundle(platform)
    end

    # def fonts
    #   @fonts ||= begin
    #     resources_dirs.flatten.inject([]) do |fonts, dir|
    #       if File.exist?(dir)
    #         Dir.chdir(dir) do
    #           fonts.concat(Dir.glob('*.{otf,ttf}'))
    #         end
    #       else
    #         fonts
    #       end
    #     end
    #   end
    # end

    def info_plist_data(platform)
      Motion::PropertyList.to_s({
        'MinimumOSVersion' => deployment_target,
        'CFBundleResourceSpecification' => 'ResourceRules.plist',
        # 'CFBundleSupportedPlatforms' => [deploy_platform],
        # 'CFBundleIconFiles' => icons,
        # 'CFBundleIcons' => {
        #   'CFBundlePrimaryIcon' => {
        #     'CFBundleIconFiles' => icons,
        #     'UIPrerenderedIcon' => prerendered_icon,
        #   }
        # },
        # 'UIAppFonts' => fonts,
        # TODO temp hack to get ints for Instruments, but strings for normal builds.
        'UIDeviceFamily' => device_family_ints.map { |x| ENV['__USE_DEVICE_INT__'] ? x.to_i : x.to_s },
        # 'UISupportedInterfaceOrientations' => interface_orientations_consts,
        # 'UIStatusBarStyle' => status_bar_style_const,
        # 'UIBackgroundModes' => background_modes_consts,
        'DTXcode' => begin
          vers = xcode_version[0].gsub(/\./, '')
          if vers.length == 2
            '0' + vers + '0'
          else
            '0' + vers
          end
        end,
        'DTXcodeBuild' => xcode_version[1],
        'DTSDKName' => "#{platform.downcase}#{sdk_version}",
        'DTSDKBuild' => sdk_build_version(platform),
        'DTPlatformName' => platform.downcase,
        'DTCompiler' => 'com.apple.compilers.llvm.clang.1_0',
        'DTPlatformVersion' => sdk_version,
        'DTPlatformBuild' => sdk_build_version(platform),
      }.merge(generic_info_plist).merge(dt_info_plist).merge(info_plist)
       .merge({ 'CFBundlePackageType' => 'FMWK' }))
    end

    def manifest_plist_data
      return nil if manifest_assets.empty?
      Motion::PropertyList.to_s({
        'items' => [
          { 'assets' => manifest_assets,
            'metadata' => {
              'bundle-identifier' => identifier,
              'bundle-version' => @version,
              'kind' => 'software',
              'title' => @name
            } }
        ]
      })
    end

    def supported_sdk_versions(versions)
      versions.reverse.find { |vers| File.exist?(datadir(vers)) }
    end

    def sdk_build_version(platform)
      @sdk_build_version ||= begin
        sdk_path = sdk(platform)
        `xcodebuild -version -sdk '#{sdk_path}' ProductBuildVersion`.strip
      end
    end

#     def main_cpp_file_txt(spec_objs)
#       main_txt = <<EOS
# #import <UIKit/UIKit.h>

# extern "C" {
#     void rb_define_global_const(const char *, void *);
#     void rb_rb2oc_exc_handler(void);
#     void rb_exit(int);
#     void RubyMotionInit(int argc, char **argv);
# EOS
#       if spec_mode
#         spec_objs.each do |_, init_func|
#           main_txt << "void #{init_func}(void *, void *);\n"
#         end
#       end
#       main_txt << <<EOS
# }
# EOS

#       if spec_mode
#         main_txt << <<EOS
# @interface SpecLauncher : NSObject
# @end

# #include <dlfcn.h>

# @implementation SpecLauncher

# + (id)launcher
# {
#     [UIApplication sharedApplication];

#     // Enable simulator accessibility.
#     // Thanks http://www.stewgleadow.com/blog/2011/10/14/enabling-accessibility-for-ios-applications/
#     NSString *simulatorRoot = [[[NSProcessInfo processInfo] environment] objectForKey:@"IPHONE_SIMULATOR_ROOT"];
#     if (simulatorRoot != nil) {
#         void *appSupportLibrary = dlopen([[simulatorRoot stringByAppendingPathComponent:@"/System/Library/PrivateFrameworks/AppSupport.framework/AppSupport"] fileSystemRepresentation], RTLD_LAZY);
#         CFStringRef (*copySharedResourcesPreferencesDomainForDomain)(CFStringRef domain) = (CFStringRef (*)(CFStringRef)) dlsym(appSupportLibrary, "CPCopySharedResourcesPreferencesDomainForDomain");

#         if (copySharedResourcesPreferencesDomainForDomain != NULL) {
#             CFStringRef accessibilityDomain = copySharedResourcesPreferencesDomainForDomain(CFSTR("com.apple.Accessibility"));

#             if (accessibilityDomain != NULL) {
#                 CFPreferencesSetValue(CFSTR("ApplicationAccessibilityEnabled"), kCFBooleanTrue, accessibilityDomain, kCFPreferencesAnyUser, kCFPreferencesAnyHost);
#                 CFRelease(accessibilityDomain);
#             }
#         }
#     }

#     // Load the UIAutomation framework.
#     dlopen("/Developer/Library/PrivateFrameworks/UIAutomation.framework/UIAutomation", RTLD_LOCAL);

#     SpecLauncher *launcher = [[self alloc] init];
#     [[NSNotificationCenter defaultCenter] addObserver:launcher selector:@selector(appLaunched:) name:UIApplicationDidBecomeActiveNotification object:nil];
#     return launcher;
# }

# - (void)appLaunched:(id)notification
# {
#     // unregister observer to avoid duplicate invocation
#     [[NSNotificationCenter defaultCenter] removeObserver:self name:UIApplicationDidBecomeActiveNotification object:nil];
#     // Give a bit of time for the simulator to attach...
#     [self performSelector:@selector(runSpecs) withObject:nil afterDelay:0.3];
# }

# - (void)runSpecs
# {
# EOS
#         spec_objs.each do |_, init_func|
#           main_txt << "#{init_func}(self, 0);\n"
#         end
#         main_txt << "[NSClassFromString(@\"Bacon\") performSelector:@selector(run)];\n"
#         main_txt << <<EOS
# }

# @end
# EOS
#       end
#       main_txt << <<EOS
# int
# main(int argc, char **argv)
# {
#     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
#     int retval = 0;
# EOS
#     if ENV['ARR_CYCLES_DISABLE']
#       main_txt << <<EOS
#     setenv("ARR_CYCLES_DISABLE", "1", true);
# EOS
#     end
#     main_txt << "[SpecLauncher launcher];\n" if spec_mode
#     main_txt << <<EOS
#     RubyMotionInit(argc, argv);
# EOS
#     main_txt << <<EOS
#     retval = UIApplicationMain(argc, argv, nil, @"#{delegate_class}");
#     rb_exit(retval);
#     [pool release];
#     return retval;
# }
# EOS
#     end
  end
end; end