Skip to content

Commit

Permalink
GDScript: Implement get_dependencies()
Browse files Browse the repository at this point in the history
The parser and analyzer now track the dependencies of the script and
return the list when the resource loader ask for them.

What is considered a dependency:

- Any `preload()` call.
- The base script this one extends.
- Any identifier, including types, that refers to global scripts.
- Any autoload singleton reference.
  • Loading branch information
vnen committed Apr 18, 2024
1 parent 2efbc6b commit dc73440
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 7 deletions.
9 changes: 7 additions & 2 deletions modules/gdscript/gdscript.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2884,7 +2884,7 @@ String ResourceFormatLoaderGDScript::get_resource_type(const String &p_path) con
return "";
}

void ResourceFormatLoaderGDScript::get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types) {
void ResourceFormatLoaderGDScript::get_dependencies(const String &p_path, List<String> *r_dependencies, bool p_add_types) {
Ref<FileAccess> file = FileAccess::open(p_path, FileAccess::READ);
ERR_FAIL_COND_MSG(file.is_null(), "Cannot open file '" + p_path + "'.");

Expand All @@ -2898,8 +2898,13 @@ void ResourceFormatLoaderGDScript::get_dependencies(const String &p_path, List<S
return;
}

GDScriptAnalyzer analyzer(&parser);
if (OK != analyzer.analyze()) {
return;
}

for (const String &E : parser.get_dependencies()) {
p_dependencies->push_back(E);
r_dependencies->push_back(E);
}
}

Expand Down
2 changes: 1 addition & 1 deletion modules/gdscript/gdscript.h
Original file line number Diff line number Diff line change
Expand Up @@ -633,7 +633,7 @@ class ResourceFormatLoaderGDScript : public ResourceFormatLoader {
virtual void get_recognized_extensions(List<String> *p_extensions) const override;
virtual bool handles_type(const String &p_type) const override;
virtual String get_resource_type(const String &p_path) const override;
virtual void get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types = false) override;
virtual void get_dependencies(const String &p_path, List<String> *r_dependencies, bool p_add_types = false) override;
};

class ResourceFormatSaverGDScript : public ResourceFormatSaver {
Expand Down
15 changes: 14 additions & 1 deletion modules/gdscript/gdscript_analyzer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,11 @@ Error GDScriptAnalyzer::resolve_class_inheritance(GDScriptParser::ClassNode *p_c
class_type.native_type = result.native_type;
p_class->set_datatype(class_type);

// Add base class to the list of dependencies.
if (result.kind == GDScriptParser::DataType::CLASS) {
parser->add_dependency(result.script_path);
}

// Apply annotations.
for (GDScriptParser::AnnotationNode *&E : p_class->annotations) {
resolve_annotation(E);
Expand Down Expand Up @@ -849,6 +854,11 @@ GDScriptParser::DataType GDScriptAnalyzer::resolve_datatype(GDScriptParser::Type
}

p_type->set_datatype(result);

if (result.kind == GDScriptParser::DataType::CLASS || result.kind == GDScriptParser::DataType::SCRIPT) {
parser->add_dependency(result.script_path);
}

return result;
}

Expand Down Expand Up @@ -4063,6 +4073,7 @@ void GDScriptAnalyzer::reduce_identifier(GDScriptParser::IdentifierNode *p_ident

if (ScriptServer::is_global_class(name)) {
p_identifier->set_datatype(make_global_class_meta_type(name, p_identifier));
parser->add_dependency(p_identifier->get_datatype().script_path);
return;
}

Expand Down Expand Up @@ -4105,6 +4116,7 @@ void GDScriptAnalyzer::reduce_identifier(GDScriptParser::IdentifierNode *p_ident
}
result.is_constant = true;
p_identifier->set_datatype(result);
parser->add_dependency(autoload.path);
return;
}
}
Expand Down Expand Up @@ -4224,7 +4236,6 @@ void GDScriptAnalyzer::reduce_preload(GDScriptParser::PreloadNode *p_preload) {
push_error("Preloaded path must be a constant string.", p_preload->path);
} else {
p_preload->resolved_path = p_preload->path->reduced_value;
// TODO: Save this as script dependency.
if (p_preload->resolved_path.is_relative_path()) {
p_preload->resolved_path = parser->script_path.get_base_dir().path_join(p_preload->resolved_path);
}
Expand Down Expand Up @@ -4255,6 +4266,8 @@ void GDScriptAnalyzer::reduce_preload(GDScriptParser::PreloadNode *p_preload) {
push_error(vformat(R"(Could not preload resource file "%s".)", p_preload->resolved_path), p_preload->path);
}
}

parser->add_dependency(p_preload->resolved_path);
}
}

Expand Down
10 changes: 7 additions & 3 deletions modules/gdscript/gdscript_parser.h
Original file line number Diff line number Diff line change
Expand Up @@ -1427,6 +1427,8 @@ class GDScriptParser {
void reset_extents(Node *p_node, GDScriptTokenizer::Token p_token);
void reset_extents(Node *p_node, Node *p_from);

HashSet<String> dependencies;

template <typename T>
T *alloc_node() {
T *node = memnew(T);
Expand Down Expand Up @@ -1568,9 +1570,11 @@ class GDScriptParser {
bool annotation_exists(const String &p_annotation_name) const;

const List<ParserError> &get_errors() const { return errors; }
const List<String> get_dependencies() const {
// TODO: Keep track of deps.
return List<String>();
const HashSet<String> &get_dependencies() const {
return dependencies;
}
void add_dependency(const String &p_dependency) {
dependencies.insert(p_dependency);
}
#ifdef DEBUG_ENABLED
const List<GDScriptWarning> &get_warnings() const { return warnings; }
Expand Down

0 comments on commit dc73440

Please sign in to comment.