safety check for include loops

Author: ZacLN

src/StaticLint.jl

@@ -45,6 +45,7 @@ bindingof(m::Meta) = m.binding
 mutable struct State{T}
     file::T
     targetfile::Union{Nothing,T}
+    included_files::Vector{String}
     scope::Scope
     delayed::Bool
     urefs::Vector{EXPR}
@@ -140,12 +141,18 @@ function followinclude(x, state::State)
             path = ""
         end
         if !isempty(path)
+            if path in state.included_files
+                seterror!(x, IncludeLoop)
+                return
+            end
             oldfile = state.file
             state.file = getfile(state.server, path)
+            push!(state.included_files, getpath(state.file))
             setroot(state.file, getroot(oldfile))
             setscope!(getcst(state.file), nothing)
             state(getcst(state.file))
             state.file = oldfile
+            pop!(state.included_files)
         else
             # (printstyled(">>>>Can't follow include", color = :red);printstyled(" $(Expr(x)) from $(dirname(state.path))\n"))
             # error handling for broken `include` here

src/linting/checks.jl

@@ -8,7 +8,8 @@ ConstIfCondition,
 PointlessOR,
 PointlessAND,
 UnusedBinding,
-InvalidTypeDeclaration)
+InvalidTypeDeclaration,
+IncludeLoop)
 
 const LintCodeDescriptions = Dict{LintCodes,String}(
     IncorrectCallNargs => "An incorrect number of function arguments has been passed.",
@@ -19,7 +20,8 @@ const LintCodeDescriptions = Dict{LintCodes,String}(
     PointlessOR => "The first argument of a `||` call is a boolean literal.",
     PointlessAND => "The first argument of a `&&` call is `false`.",
     UnusedBinding => "The variable name has been bound but not used.",
-    InvalidTypeDeclaration => "A non-DataType has been used in a type declaration statement."
+    InvalidTypeDeclaration => "A non-DataType has been used in a type declaration statement.",
+    IncludeLoop => "Loop detected, this file has already been included."
 )
 
 haserror(m::Meta) = m.error !== nothing

src/server.jl

@@ -39,7 +39,7 @@ getsymbolserver(server::FileServer) = server.symbolserver
 function scopepass(file, target = nothing)
     server = file.server
     setscope!(getcst(file), Scope(nothing, getcst(file), Dict(), Dict{String,Any}("Base" => getsymbolserver(server)["Base"], "Core" => getsymbolserver(server)["Core"]), false))
-    state = State(file, target, scopeof(getcst(file)), false, EXPR[], server)
+    state = State(file, target, [getpath(file)], scopeof(getcst(file)), false, EXPR[], server)
     state(getcst(file))
     for uref in state.urefs
         s = retrieve_delayed_scope(uref)