class Xcodeproj::XCScheme::LaunchAction

This class wraps the LaunchAction node of a .xcscheme XML file

Public Class Methods

new(node = nil) click to toggle source

@param [REXML::Element] node

The 'LaunchAction' XML node that this object will wrap.
If nil, will create a default XML node to use.
# File lib/xcodeproj/scheme/launch_action.rb, line 12
def initialize(node = nil)
  create_xml_element_with_fallback(node, 'LaunchAction') do
    self.build_configuration = 'Debug'

    # Add some attributes (that are not handled by this wrapper class yet but expected in the XML)
    @xml_element.attributes['selectedDebuggerIdentifier'] = 'Xcode.DebuggerFoundation.Debugger.LLDB'
    @xml_element.attributes['selectedLauncherIdentifier'] = 'Xcode.DebuggerFoundation.Launcher.LLDB'
    @xml_element.attributes['launchStyle'] = '0'
    @xml_element.attributes['useCustomWorkingDirectory'] = bool_to_string(false)
    @xml_element.attributes['ignoresPersistentStateOnLaunch'] = bool_to_string(false)
    @xml_element.attributes['debugDocumentVersioning'] = bool_to_string(true)
    @xml_element.attributes['debugServiceExtension'] = 'internal'

    # Setup default values for other (handled) attributes
    self.allow_location_simulation = true
  end
end

Public Instance Methods

add_macro_expansion(macro_expansion) click to toggle source

@param [MacroExpansion] macro_expansion

Add a MacroExpansion to this LaunchAction
# File lib/xcodeproj/scheme/launch_action.rb, line 174
def add_macro_expansion(macro_expansion)
  @xml_element.add_element(macro_expansion.xml_element)
end
allow_location_simulation=(flag) click to toggle source

@param [Bool] flag

Set whether or not to allow GPS location simulation when launching this target
# File lib/xcodeproj/scheme/launch_action.rb, line 46
def allow_location_simulation=(flag)
  @xml_element.attributes['allowLocationSimulation'] = bool_to_string(flag)
end
allow_location_simulation?() click to toggle source

@return [Bool]

Whether or not to allow GPS location simulation when launching this target
# File lib/xcodeproj/scheme/launch_action.rb, line 39
def allow_location_simulation?
  string_to_bool(@xml_element.attributes['allowLocationSimulation'])
end
buildable_product_runnable() click to toggle source

@return [BuildableProductRunnable]

The BuildReference to launch when executing the Launch Action
# File lib/xcodeproj/scheme/launch_action.rb, line 116
def buildable_product_runnable
  BuildableProductRunnable.new(@xml_element.elements['BuildableProductRunnable'], 0)
end
buildable_product_runnable=(runnable) click to toggle source

@param [BuildableProductRunnable] runnable

Set the BuildableProductRunnable referencing the target to launch
# File lib/xcodeproj/scheme/launch_action.rb, line 123
def buildable_product_runnable=(runnable)
  @xml_element.delete_element('BuildableProductRunnable')
  @xml_element.add_element(runnable.xml_element) if runnable
end
command_line_arguments() click to toggle source

@return [CommandLineArguments]

Returns the CommandLineArguments that will be passed at app launch
# File lib/xcodeproj/scheme/launch_action.rb, line 149
def command_line_arguments
  CommandLineArguments.new(@xml_element.elements[XCScheme::COMMAND_LINE_ARGS_NODE])
end
command_line_arguments=(arguments) click to toggle source

@return [CommandLineArguments] arguments

Sets the CommandLineArguments that will be passed at app launch
# File lib/xcodeproj/scheme/launch_action.rb, line 156
def command_line_arguments=(arguments)
  @xml_element.delete_element(XCScheme::COMMAND_LINE_ARGS_NODE)
  @xml_element.add_element(arguments.xml_element) if arguments
  arguments
end
disable_main_thread_checker=(flag) click to toggle source

@param [Bool] flag

Set whether this Build Action should disable detection of UI API misuse
from background threads
# File lib/xcodeproj/scheme/launch_action.rb, line 77
def disable_main_thread_checker=(flag)
  @xml_element.attributes['disableMainThreadChecker'] = bool_to_string(flag)
end
disable_main_thread_checker?() click to toggle source

@return [Bool]

Whether this Build Action should disable detection of UI API misuse
from background threads
# File lib/xcodeproj/scheme/launch_action.rb, line 69
def disable_main_thread_checker?
  string_to_bool(@xml_element.attributes['disableMainThreadChecker'])
end
environment_variables() click to toggle source

@return [EnvironmentVariables]

Returns the EnvironmentVariables that will be defined at app launch
# File lib/xcodeproj/scheme/launch_action.rb, line 131
def environment_variables
  EnvironmentVariables.new(@xml_element.elements[XCScheme::VARIABLES_NODE])
end
environment_variables=(env_vars) click to toggle source

@param [EnvironmentVariables,nil] env_vars

Sets the EnvironmentVariables that will be defined at app launch
# File lib/xcodeproj/scheme/launch_action.rb, line 138
def environment_variables=(env_vars)
  @xml_element.delete_element(XCScheme::VARIABLES_NODE)
  @xml_element.add_element(env_vars.xml_element) if env_vars
  env_vars
end
launch_automatically_substyle() click to toggle source

@return [String]

The launch automatically substyle
# File lib/xcodeproj/scheme/launch_action.rb, line 102
def launch_automatically_substyle
  @xml_element.attributes['launchAutomaticallySubstyle']
end
launch_automatically_substyle=(value) click to toggle source

@param [String] flag

Set the launch automatically substyle ('2' for extensions)
# File lib/xcodeproj/scheme/launch_action.rb, line 109
def launch_automatically_substyle=(value)
  @xml_element.attributes['launchAutomaticallySubstyle'] = value.to_s
end
location_scenario_reference=(reference) click to toggle source

@return [LocationScenarioReference]

Set the LocationScenarioReference which simulates a GPS location when executing the Launch Action
# File lib/xcodeproj/scheme/launch_action.rb, line 60
def location_scenario_reference=(reference)
  @xml_element.delete_element('LocationScenarioReference')
  @xml_element.add_element(reference.xml_element) if reference
end
location_scenario_reference?() click to toggle source

@return [LocationScenarioReference]

The LocationScenarioReference to simulate a GPS location when executing the Launch Action
# File lib/xcodeproj/scheme/launch_action.rb, line 53
def location_scenario_reference?
  LocationScenarioReference.new(@xml_element.elements['LocationScenarioReference'])
end
macro_expansions() click to toggle source

@return [Array<MacroExpansion>]

The list of MacroExpansion bound with this LaunchAction
# File lib/xcodeproj/scheme/launch_action.rb, line 165
def macro_expansions
  @xml_element.get_elements('MacroExpansion').map do |node|
    MacroExpansion.new(node)
  end
end
stop_on_every_main_thread_checker_issue=(flag) click to toggle source

@param [Bool] flag

Set whether UI API misuse from background threads detection should pause execution.
This flag is ignored when the thread checker disabled
([disable_main_thread_checker] flag).
# File lib/xcodeproj/scheme/launch_action.rb, line 95
def stop_on_every_main_thread_checker_issue=(flag)
  @xml_element.attributes['stopOnEveryMainThreadCheckerIssue'] = bool_to_string(flag)
end
stop_on_every_main_thread_checker_issue?() click to toggle source

@return [Bool]

Whether UI API misuse from background threads detection should pause execution.
This flag is ignored when the thread checker disabled
([disable_main_thread_checker] flag).
# File lib/xcodeproj/scheme/launch_action.rb, line 86
def stop_on_every_main_thread_checker_issue?
  string_to_bool(@xml_element.attributes['stopOnEveryMainThreadCheckerIssue'])
end