Serene
/
include-what-you-use
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clean up handling of mapping file search paths. The current policy is to treat --mapping_file switches as relative to the current dir or absolute. Ref directives are evaluated relative to the current directory and then relative to the containing mapping file, and multiple levels of refs build up the mapping file search path incrementally. 

- Remove hard-coded mapping search path in iwyu_globals.cc
- Remove AddMappingFileSearchPath
- Add private AddMappingsFromFile to handle search path building
- Push search path scanning out into free function FindFileInSearchPath
- Less, but more focused logging.
- Fix indentation in iwyu_include_picker.cc
- Simplify parsing code by making current_node a Node* instead of a Node&
This commit is contained in:
Kim Gräsman 2013-02-26 21:32:24 +00:00
parent 15ca18b2b4
commit 04e3b75adb
3 changed files with 97 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
iwyu_globals.cc
View File

@ -200,9 +200,6 @@ void InitGlobals(clang::SourceManager* sm,
VERRS(6) << "Search path: " << it->path << " (" << path_type_name << ")\n";
}
// Set up mapping file search paths.
include_picker->AddMappingFileSearchPath(".");
// Add mappings.
for (Each<string> it(&GlobalFlags().mapping_files); !it.AtEnd(); ++it) {
include_picker->AddMappingsFromFile(*it);

166
iwyu_include_picker.cc
View File

@ -789,6 +789,50 @@ vector<string> GetSequenceValue(Node* node) {
return result;
}
// If new_path doesn't already exist in search_path, makes a copy of search_path
// and adds new_path to it.
// Returns the original or extended search path.
vector<string> ExtendMappingFileSearchPath(const vector<string>& search_path,
const string& new_path) {
CHECK_(IsAbsolutePath(new_path));
if (std::find(search_path.begin(),
search_path.end(),
new_path) == search_path.end()) {
vector<string> extended(search_path);
extended.push_back(new_path);
return extended;
}
return search_path;
}
// Scans search_path for existing files with filename.
// If filename is absolute and exists, return it.
// If filename is relative and exists based on cwd, return it in absolute form.
// If filename is relative and doesn't exist, try to find it along search_path.
// Returns an absolute filename if file is found, otherwise filename untouched.
string FindFileInSearchPath(const vector<string>& search_path,
const string& filename) {
if (llvm::sys::fs::exists(filename)) {
// If the file exists, no matter if its path is relative or absolute,
// return it in absolute form.
return MakeAbsolutePath(filename);
} else if (!IsAbsolutePath(filename)) {
// If it's relative, scan search path.
for (Each<string> it(&search_path); !it.AtEnd(); ++it) {
string candidate = MakeAbsolutePath(*it, filename);
if (llvm::sys::fs::exists(candidate)) {
return candidate;
}
}
}
// This is proven not to exist, so handle the error when
// we attempt to open it.
return filename;
}
} // namespace
IncludePicker::IncludePicker()
@ -873,16 +917,6 @@ void IncludePicker::AddDirectInclude(const string& includer_filepath,
}
}
void IncludePicker::AddMappingFileSearchPath(const string& path) {
string absolute_path = MakeAbsolutePath(path);
if (std::find(mapping_file_search_path_.begin(),
mapping_file_search_path_.end(),
absolute_path) == mapping_file_search_path_.end()) {
VERRS(6) << "Adding mapping file search path: " << absolute_path << "\n";
mapping_file_search_path_.push_back(absolute_path);
}
}
void IncludePicker::AddMapping(const string& map_from, const string& map_to) {
VERRS(4) << "Adding mapping from " << map_from << " to " << map_to << "\n";
CHECK_(!has_called_finalize_added_include_lines_ && "Can't mutate anymore");
@ -1114,33 +1148,6 @@ string IncludePicker::MaybeGetIncludeNameAsWritten(
return value ? *value : "";
}
error_code IncludePicker::TryReadMappingFile(
const string& filename,
OwningPtr<MemoryBuffer>& buffer) const {
string absolute_path;
if (IsAbsolutePath(filename)) {
VERRS(5) << "Absolute mapping filename: " << filename << ".\n";
absolute_path = filename;
} else {
VERRS(5) << "Relative mapping filename: " << filename << ". "
<< "Scanning search path.\n";
// Scan search path
for (Each<string> it(&mapping_file_search_path_); !it.AtEnd(); ++it) {
string candidate = MakeAbsolutePath(*it, filename);
if (llvm::sys::fs::exists(candidate)) {
absolute_path = candidate;
VERRS(5) << "Found mapping file: " << candidate << ".\n";
break;
}
}
}
error_code error = MemoryBuffer::getFile(absolute_path, buffer);
VERRS(5) << "Opened mapping file: " << filename << "? "
<< error.message() << "\n";
return error;
}
vector<string> IncludePicker::GetCandidateHeadersForSymbol(
const string& symbol) const {
CHECK_(has_called_finalize_added_include_lines_ && "Must finalize includes");
@ -1219,22 +1226,33 @@ bool IncludePicker::HasMapping(const string& map_from_filepath,
return quoted_to == quoted_from; // indentity mapping, why not?
}
// Parses a YAML/JSON file containing mapping directives of various types.
void IncludePicker::AddMappingsFromFile(const string& filename) {
vector<string> default_search_path;
return AddMappingsFromFile(filename, default_search_path);
}
// Parses a YAML/JSON file containing mapping directives of various types:
// symbol - symbol name -> quoted include
// include - private quoted include -> public quoted include
// ref - include mechanism for mapping files, to allow project-specific
// groupings
// We use this to maintain mappings externally, to make it easier
// to update/adjust to local circumstances.
void IncludePicker::AddMappingsFromFile(const string& filename) {
// This private implementation method is recursive and builds the search path
// incrementally.
void IncludePicker::AddMappingsFromFile(const string& filename,
const vector<string>& search_path) {
string absolute_path = FindFileInSearchPath(search_path, filename);
OwningPtr<MemoryBuffer> buffer;
error_code error = TryReadMappingFile(filename, buffer);
error_code error = MemoryBuffer::getFile(absolute_path, buffer);
if (error) {
errs() << "Cannot open mapping file '" << filename << "': "
<< error.message() << ".\n";
errs() << "Cannot open mapping file '" << absolute_path << "': "
<< error.message() << ".\n";
return;
}
VERRS(5) << "Adding mappings from file '" << absolute_path << "'.\n";
SourceMgr source_manager;
Stream json_stream(buffer.take(), source_manager);
@ -1251,18 +1269,18 @@ void IncludePicker::AddMappingsFromFile(const string& filename) {
}
for (SequenceNode::iterator it = array->begin(); it != array->end(); ++it) {
Node& current_node = *it;
Node* current_node = &(*it);
// Every item must be a JSON object ("mapping" in YAML terms.)
MappingNode* mapping = llvm::dyn_cast<MappingNode>(&current_node);
MappingNode* mapping = llvm::dyn_cast<MappingNode>(current_node);
if (mapping == NULL) {
json_stream.printError(&current_node,
"Mapping directives must be objects.");
json_stream.printError(current_node,
"Mapping directives must be objects.");
return;
}
for (MappingNode::iterator it = mapping->begin();
it != mapping->end(); ++it) {
it != mapping->end(); ++it) {
// General form is { directive: <data> }.
const string directive = GetScalarValue(it->getKey());
@ -1270,9 +1288,9 @@ void IncludePicker::AddMappingsFromFile(const string& filename) {
// Symbol mapping.
vector<string> mapping = GetSequenceValue(it->getValue());
if (mapping.size() != 4) {
json_stream.printError(&current_node,
"Symbol mapping expects a value on the form "
"'[from, visibility, to, visibility]'.");
json_stream.printError(current_node,
"Symbol mapping expects a value on the form "
"'[from, visibility, to, visibility]'.");
return;
}
@ -1281,62 +1299,60 @@ void IncludePicker::AddMappingsFromFile(const string& filename) {
IncludeVisibility to_visibility = ParseVisibility(mapping[3]);
if (to_visibility == kUnusedVisibility) {
json_stream.printError(&current_node,
"Unknown visibility '" + mapping[3] + "'.");
json_stream.printError(current_node,
"Unknown visibility '" + mapping[3] + "'.");
return;
}
AddSymbolMapping(
mapping[0],
mapping[2],
to_visibility);
AddSymbolMapping(mapping[0], mapping[2], to_visibility);
} else if (directive == "include") {
// Include mapping.
vector<string> mapping = GetSequenceValue(it->getValue());
if (mapping.size() != 4) {
json_stream.printError(&current_node,
"Include mapping expects a value on the form "
"'[from, visibility, to, visibility]'.");
json_stream.printError(current_node,
"Include mapping expects a value on the form "
"'[from, visibility, to, visibility]'.");
return;
}
IncludeVisibility from_visibility = ParseVisibility(mapping[1]);
if (from_visibility == kUnusedVisibility) {
json_stream.printError(&current_node,
"Unknown visibility '" + mapping[1] + "'.");
json_stream.printError(current_node,
"Unknown visibility '" + mapping[1] + "'.");
return;
}
IncludeVisibility to_visibility = ParseVisibility(mapping[3]);
if (to_visibility == kUnusedVisibility) {
json_stream.printError(&current_node,
"Unknown visibility '" + mapping[3] + "'.");
json_stream.printError(current_node,
"Unknown visibility '" + mapping[3] + "'.");
return;
}
AddIncludeMapping(
mapping[0],
from_visibility,
mapping[2],
to_visibility);
AddIncludeMapping(mapping[0],
from_visibility,
mapping[2],
to_visibility);
} else if (directive == "ref") {
// Mapping ref.
string ref_file = GetScalarValue(it->getValue());
if (ref_file.empty()) {
json_stream.printError(&current_node,
"Mapping ref expects a single filename value.");
json_stream.printError(current_node,
"Mapping ref expects a single filename value.");
return;
}
// Add the path of the file we're currently processing
// to the search path. Allows refs to be relative to referrer.
AddMappingFileSearchPath(GetParentPath(filename));
vector<string> extended_search_path =
ExtendMappingFileSearchPath(search_path,
GetParentPath(absolute_path));
// Recurse.
AddMappingsFromFile(ref_file);
AddMappingsFromFile(ref_file, extended_search_path);
} else {
json_stream.printError(&current_node,
"Unknown directive '" + directive + "'.");
json_stream.printError(current_node,
"Unknown directive '" + directive + "'.");
return;
}
}

16
iwyu_include_picker.h
View File

@ -89,9 +89,6 @@ class IncludePicker {
const string& includee_filepath,
const string& quoted_include_as_written);
// Add a mapping file search path.
void AddMappingFileSearchPath(const string& path);
// Add this to say "map_to re-exports everything in file map_from".
// Both map_to and map_from should be quoted includes.
void AddMapping(const string& map_from, const string& map_to);
@ -155,6 +152,12 @@ class IncludePicker {
void AddMappingsFromFile(const string& filename);
private:
// Private implementation of mapping file parser, which takes
// mapping file search path to allow recursion that builds up
// search path incrementally.
void AddMappingsFromFile(const string& filename,
const vector<string>& search_path);
// Adds a mapping from a one header to another, typically
// from a private to a public quoted include.
void AddIncludeMapping(
@ -203,11 +206,6 @@ class IncludePicker {
string MaybeGetIncludeNameAsWritten(const string& includer_filepath,
const string& includee_filepath) const;
// Scan the search paths for filename. If it exists, put file contents
// in buffer. If not, return the error code.
error_code TryReadMappingFile(const string& filename,
OwningPtr<MemoryBuffer>& buffer) const;
// From symbols to includes.
IncludeMap symbol_include_map_;
@ -243,8 +241,6 @@ class IncludePicker {
// contents of friend_to_headers_map_["@\"foo/bar/.*\""].
map<string, set<string> > friend_to_headers_map_;
vector<string> mapping_file_search_path_;
// Make sure we don't do any non-const operations after finalizing.
bool has_called_finalize_added_include_lines_;
}; // class IncludePicker