chromium/src
0
Fork 0
Code Activity

[SublimeText] Get the clang flags with the same script that vim uses

Browse Source 
The sublime script to get the clang flags doesn't work for many files (e.g.,
those with $ line continuations in the ninja files). Rather than fix it, we
should merge with vim's ycm generator which has to do the same thing and has
been in use for quite some time.

BUG=626409

Review-Url: https://codereview.chromium.org/2129993002
Cr-Commit-Position: refs/heads/master@{#406480}
This commit is contained in:
jkarlin
2016-07-19 21:22:02 -07:00
committed by Commit bot
parent 3a9f8efd42
commit 51f4e51682
2 changed files with 29 additions and 128 deletions

4
docs/linux_sublime_dev.md

@ -286,7 +286,7 @@ page](https://github.com/quarnster/SublimeClang).
```
1. Edit your project file `Project > Edit Project` to call the script above
(replace `out/Debug` with your out directory):
(replace `/path/to/depot_tools` with your depot_tools directory):
```
{
@ -300,7 +300,7 @@ page](https://github.com/quarnster/SublimeClang).
[
"-Wno-attributes",
],
"sublimeclang_options_script": "python ${project_path}/src/tools/sublime/ninja_options_script.py ${project_path}/src ${project_path}/src/out/Debug",
"sublimeclang_options_script": "python ${project_path}/src/tools/sublime/ninja_options_script.py -d '/path/to/depot_tools'",
}
}
```

153
tools/sublime/ninja_options_script.py

@ -6,138 +6,39 @@
# Usage within SublimeClang:
# "sublimeclang_options_script": "python
# ${project_path}/src/tools/sublime/ninja_options_script.py \
# ${project_path}/src \
# ${project_path}/src/out/Debug"
# -d '/path/to/depot_tools'"
#
#
# NOTE: ${project_path} expands to the directory of the Sublime project file,
# and SublimgClang passes the absolute file path to the current file as an
# additional argument.
# and SublimeClang passes the absolute file path to the current file as an
# additional argument. You should change the -d argument to point to your
# depot_tools directory.
import fnmatch
import logging
import imp
import optparse
import os
import sys
# Change to an absolute reference if ninja is not on your path
path_to_ninja = 'ninja'
ycm_module_path = os.path.normpath(
os.path.join(os.path.dirname(os.path.abspath(__file__)),
'../vim/chromium.ycm_extra_conf.py'))
ycm_extra_conf = imp.load_source('ycm_extra_conf', ycm_module_path)
# Ninja file options to extract (add 'cflags' if you need the c flags too,
# although these usually break things)
ninja_file_options = ['defines', 'include_dirs', 'cflags_cc']
def main():
usage = "usage: %prog [options] file"
parser = optparse.OptionParser(usage)
parser.add_option("-d", "--depot_tools", dest="depot_path",
help="path to depot_tools")
(options, args) = parser.parse_args()
if options.depot_path:
os.environ["PATH"] += ":%s" % options.depot_path
if len(args) != 1:
parser.error("incorrect number of arguments")
def merge_options_dicts(options_dict_1, options_dict_2):
'''
Given two dictionaries of options, returns one dictionary with both sets of
options appended together.
path = os.path.realpath(args[0])
results = ycm_extra_conf.FlagsForFile(path)
Both dictionaries must have the same options, even if some of them are empty
lists.
'''
assert set(options_dict_1.keys()) == set(options_dict_2.keys()), \
"Both options dicts must have the same keys"
final_options_dict = {}
for key in options_dict_1:
final_options_dict[key] = options_dict_1[key] + options_dict_2[key]
return final_options_dict
for flag in results['flags']:
print flag
def extract_options_from_ninja_file(ninja_file_path, options_to_extract):
'''
Extracts the given options from the file at ninja_file_path and returns them
as a dictionary.
'''
extracted_options = dict((o, []) for o in options_to_extract)
for line in open(ninja_file_path):
for option in options_to_extract:
if line.strip().startswith(option):
extracted_options[option] += line.split('=', 1)[1].split()
return extracted_options
def find_ninja_file_options(ninja_root_path, relative_file_path_to_find,
options_to_extract):
'''
Returns a dictionary of the given extracted options for the ninja file for
relative_file_path_to_find.
The options are extracted from the first *.ninja file in ninja_root_path that
contains relative_file_path_to_find. Otherwise, the first *.ninja file that
contains relative_file_path_to_find without the file extension. Otherwise, the
script walks up directories until it finds ninja files and then concatenates
the found options from all of them.
'''
matches = []
for root, dirnames, filenames in os.walk(ninja_root_path):
for filename in fnmatch.filter(filenames, '*.ninja'):
matches.append(os.path.join(root, filename))
logging.debug("Found %d Ninja targets", len(matches))
# First, look for a *.ninja file containing the full filename.
for ninja_file in matches:
for line in open(ninja_file):
if relative_file_path_to_find in line:
return extract_options_from_ninja_file(ninja_file, options_to_extract)
# Next, look for a *.ninja file containing the basename (no extension).
# This is a fix for header files with a corresponding cpp file.
for ninja_file in matches:
for line in open(ninja_file):
if os.path.splitext(relative_file_path_to_find)[0] in line:
all_options = extract_options_from_ninja_file(ninja_file,
options_to_extract)
if all_options['include_dirs']:
return all_options
# Finally, open any *.ninja files in the directory or higher.
current_path = os.path.join(ninja_root_path, 'obj',
os.path.dirname(relative_file_path_to_find))
while current_path != ninja_root_path:
if os.path.exists(current_path):
matches = []
for root, dirnames, filenames in os.walk(ninja_root_path):
for filename in fnmatch.filter(filenames, '*.ninja'):
matches.append(os.path.join(root, filename))
logging.debug("Found %d Ninja targets", len(matches))
matches = []
for match in os.listdir(current_path):
if match.endswith('.ninja'):
matches.append(os.path.join(current_path, match))
all_options = dict((o, []) for o in options_to_extract)
for ninja_file in matches:
all_options = merge_options_dicts(all_options,
extract_options_from_ninja_file(ninja_file, options_to_extract))
# As soon as we have some include_dirs from the ninja files, return.
if all_options['include_dirs']:
return all_options
current_path = os.path.dirname(current_path)
return None
project_path = sys.argv[1]
build_path = sys.argv[2]
file_path = sys.argv[3]
logging.debug("Compiling file %s\n", file_path)
# The file must be somewhere under the project folder...
if not file_path.lower().startswith(project_path.lower()):
logging.error("File %s is not in current project folder %s\n",
file_path, project_path)
sys.exit(1)
file_relative_path = os.path.relpath(file_path, project_path)
# Look for a .ninja file that contains our current file, since the ninja
# project file name is needed to construct the full Ninja target path.
logging.debug("Searching for Ninja target")
options = find_ninja_file_options(build_path, file_relative_path,
ninja_file_options)
if not options:
logging.error("File %s is not in any Ninja file under %s",
file_relative_path, build_path)
sys.exit(2)
for option in ninja_file_options:
for piece in options[option]:
# Resolve relative includes
if piece.startswith('-I'):
print('-I' + os.path.join(build_path, piece[2:]))
else:
print(piece)
if __name__ == "__main__":
main()