[XCode] webkit-patch should run sort-Xcode-project-file
[WebKit-https.git] / Tools / Scripts / webkitpy / tool / steps / sortxcodeprojectfiles.py
1 # Copyright (C) 2017 Sony Interactive Entertainment
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions are
5 # met:
6 #
7 #     * Redistributions of source code must retain the above copyright
8 # notice, this list of conditions and the following disclaimer.
9 #     * Redistributions in binary form must reproduce the above
10 # copyright notice, this list of conditions and the following disclaimer
11 # in the documentation and/or other materials provided with the
12 # distribution.
13 #     * Neither the name of Sony Interactive Entertainment nor the names
14 # of its contributors may be used to endorse or promote products derived
15 # from this software without specific prior written permission.
16 #
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 import logging
30 import re
31 import sys
32
33 from webkitpy.common.system.executive import ScriptError
34 from webkitpy.tool.steps.abstractstep import AbstractStep
35 from webkitpy.tool.steps.options import Options
36
37 _log = logging.getLogger(__name__)
38
39
40 class SortXcodeProjectFiles(AbstractStep):
41     @classmethod
42     def options(cls):
43         return AbstractStep.options() + [
44             Options.sort_xcode_project,
45         ]
46
47     def run(self, state):
48         if self._options.sort_xcode_project:
49             changed_pbxproj = [file for file in self._changed_files(state) if file.endswith(".pbxproj")]
50             if (len(changed_pbxproj) > 0):
51                 args = self._tool.deprecated_port().run_sort_xcode_project_file_command()
52                 args = args + changed_pbxproj
53                 try:
54                     output = self._tool.executive.run_and_throw_if_fail(args, self._options.quiet, cwd=self._tool.scm().checkout_root)
55                     self.did_modify_checkout(state)
56                 except ScriptError, e:
57                     _log.error("Unable to sort modified xcode projects.")
58                     sys.exit(1)