def declarations_iter(n) -> Generator[Any, None, None]:
"""Iterate all declarations in node :obj:`n`."""
k = nodes.Get_Kind(n)
if nodes_meta.Has_Generic_Chain(k):
for n1 in chain_iter(nodes.Get_Generic_Chain(n)):
yield n1
if nodes_meta.Has_Port_Chain(k):
for n1 in chain_iter(nodes.Get_Port_Chain(n)):
yield n1
if nodes_meta.Has_Interface_Declaration_Chain(k):
for n1 in chain_iter(nodes.Get_Interface_Declaration_Chain(n)):
yield n1
if nodes_meta.Has_Declaration_Chain(k):
for n1 in chain_iter(nodes.Get_Declaration_Chain(n)):
k1 = nodes.Get_Kind(n1)
if k1 in nodes.Iir_Kinds.Specification or k1 == nodes.Iir_Kind.Use_Clause:
# Not a declaration
pass
elif k1 == nodes.Iir_Kind.Signal_Attribute_Declaration:
# Not a declaration
pass
elif k1 in (
nodes.Iir_Kind.Type_Declaration,
nodes.Iir_Kind.Anonymous_Type_Declaration,
):
yield n1
# Handle nested declarations: record elements, physical units,
# enumeration literals...
typ = nodes.Get_Type_Definition(n1)
for n2 in declarations_iter(n1):
yield n2
else:
yield n1
# There can be nested declarations (subprograms)
for n2 in declarations_iter(n1):
yield n2
if nodes_meta.Has_Concurrent_Statement_Chain(k):
for n1 in chain_iter(nodes.Get_Concurrent_Statement_Chain(n)):
for n2 in declarations_iter(n1):
yield n2
if nodes_meta.Has_Sequential_Statement_Chain(k):
for n1 in chain_iter(nodes.Get_Sequential_Statement_Chain(n)):
for n2 in declarations_iter(n1):
yield n2
if nodes_meta.Has_Parameter_Specification(k):
yield nodes.Get_Parameter_Specification(n)
if nodes_meta.Has_Generate_Statement_Body(k):
for n1 in declarations_iter(nodes.Get_Generate_Statement_Body(n)):
yield n1
if nodes_meta.Has_Else_Clause(k):
n1 = nodes.Get_Else_Clause(n)
if n1 != nodes.Null_Iir:
for n2 in declarations_iter(n1):
yield n2
if nodes_meta.Has_Generate_Else_Clause(k):
n1 = nodes.Get_Generate_Else_Clause(n)
if n1 != nodes.Null_Iir:
for n2 in declarations_iter(n1):
yield n2
if nodes_meta.Has_Block_Header(k):
n1 = nodes.Get_Block_Header(n)
if n1 != nodes.Null_Iir:
for n2 in declarations_iter(n1):
yield n2
# All these nodes are handled:
if k in (
nodes.Iir_Kind.Entity_Declaration,
nodes.Iir_Kind.Architecture_Body,
nodes.Iir_Kind.Package_Declaration,
nodes.Iir_Kind.Package_Body,
nodes.Iir_Kind.Process_Statement,
nodes.Iir_Kind.Sensitized_Process_Statement,
nodes.Iir_Kind.Concurrent_Assertion_Statement,
nodes.Iir_Kind.Concurrent_Simple_Signal_Assignment,
nodes.Iir_Kind.Concurrent_Selected_Signal_Assignment,
nodes.Iir_Kind.Concurrent_Conditional_Signal_Assignment,
nodes.Iir_Kind.Concurrent_Procedure_Call_Statement,
nodes.Iir_Kind.Block_Statement,
nodes.Iir_Kind.Block_Header,
nodes.Iir_Kind.For_Generate_Statement,
nodes.Iir_Kind.If_Generate_Statement,
nodes.Iir_Kind.Generate_Statement_Body,
nodes.Iir_Kind.Assertion_Statement,
nodes.Iir_Kind.Wait_Statement,
nodes.Iir_Kind.Simple_Signal_Assignment_Statement,
nodes.Iir_Kind.Variable_Assignment_Statement,
nodes.Iir_Kind.For_Loop_Statement,
nodes.Iir_Kind.While_Loop_Statement,
nodes.Iir_Kind.Case_Statement,
nodes.Iir_Kind.Null_Statement,
nodes.Iir_Kind.Exit_Statement,
nodes.Iir_Kind.Next_Statement,
nodes.Iir_Kind.Procedure_Call_Statement,
nodes.Iir_Kind.Signal_Declaration,
nodes.Iir_Kind.Constant_Declaration,
nodes.Iir_Kind.Variable_Declaration,
nodes.Iir_Kind.File_Declaration,
nodes.Iir_Kind.Object_Alias_Declaration,
nodes.Iir_Kind.Attribute_Declaration,
nodes.Iir_Kind.Component_Declaration,
nodes.Iir_Kind.Use_Clause,
nodes.Iir_Kind.If_Statement,
nodes.Iir_Kind.Elsif,
nodes.Iir_Kind.Return_Statement,
nodes.Iir_Kind.Type_Declaration,
nodes.Iir_Kind.Anonymous_Type_Declaration,
nodes.Iir_Kind.Subtype_Declaration,
nodes.Iir_Kind.Function_Declaration,
nodes.Iir_Kind.Function_Body,
nodes.Iir_Kind.Procedure_Declaration,
nodes.Iir_Kind.Procedure_Body,
nodes.Iir_Kind.Component_Instantiation_Statement,
):
return
raise Exception("Unknown node of kind {}".format(kind_image(k)))
def get_symbols(fe, n):
if n == nodes.Null_Iir:
return None
k = nodes.Get_Kind(n)
if k == nodes.Iir_Kind.Design_Unit:
return get_symbols(fe, nodes.Get_Library_Unit(n))
m = SYMBOLS_MAP.get(k, None)
if m is None:
raise AssertionError("get_symbol: unhandled {}".format(
pyutils.kind_image(k)))
kind = m["kind"]
if kind is None:
return None
if k in [
nodes.Iir_Kind.Procedure_Declaration,
nodes.Iir_Kind.Function_Declaration
]:
# Discard implicit declarations.
if nodes.Get_Implicit_Definition(n) < nodes.Iir_Predefined.PNone:
return None
if nodes.Get_Has_Body(n):
# Use the body instead.
# FIXME: but get interface from the spec!
return None
res = {"kind": kind}
detail = m.get("detail")
if detail is not None:
res["detail"] = detail
# Get the name
if k in [nodes.Iir_Kind.Function_Body, nodes.Iir_Kind.Procedure_Body]:
nid = nodes.Get_Identifier(nodes.Get_Subprogram_Specification(n))
else:
nid = nodes.Get_Identifier(n)
if nid == name_table.Null_Identifier:
name = None
else:
name = pyutils.name_image(nid)
# Get the range. Use elocations when possible.
if k in (
nodes.Iir_Kind.Architecture_Body,
nodes.Iir_Kind.Entity_Declaration,
nodes.Iir_Kind.Package_Declaration,
nodes.Iir_Kind.Package_Body,
nodes.Iir_Kind.Component_Declaration,
nodes.Iir_Kind.Process_Statement,
nodes.Iir_Kind.Sensitized_Process_Statement,
nodes.Iir_Kind.If_Generate_Statement,
nodes.Iir_Kind.For_Generate_Statement,
):
start_loc = elocations.Get_Start_Location(n)
end_loc = elocations.Get_End_Location(n)
if end_loc == files_map.No_Location:
# Can happen in case of parse error
end_loc = start_loc
else:
start_loc = nodes.Get_Location(n)
end_loc = start_loc + name_table.Get_Name_Length(nid)
res["range"] = {
"start": location_to_position(fe, start_loc),
"end": location_to_position(fe, end_loc),
}
# Gather children.
# FIXME: should we use a list of fields to inspect ?
children = []
# if nodes_meta.Has_Generic_Chain(k):
# children.extend(get_symbols_chain(fe, nodes.Get_Generic_Chain(n)))
# if nodes_meta.Has_Port_Chain(k):
# children.extend(get_symbols_chain(fe, nodes.Get_Port_Chain(n)))
# if nodes_meta.Has_Interface_Declaration_Chain(k):
# children.extend(get_symbols_chain(fe, nodes.Get_Interface_Declaration_Chain(n)))
if k in (nodes.Iir_Kind.Package_Declaration, nodes.Iir_Kind.Package_Body):
children.extend(get_symbols_chain(fe, nodes.Get_Declaration_Chain(n)))
if nodes_meta.Has_Concurrent_Statement_Chain(k):
children.extend(
get_symbols_chain(fe, nodes.Get_Concurrent_Statement_Chain(n)))
if nodes_meta.Has_Generate_Statement_Body(k):
children.extend(
get_symbols_chain(
fe,
nodes.Get_Concurrent_Statement_Chain(
nodes.Get_Generate_Statement_Body(n)),
))
if children:
res["children"] = children
else:
# Discard anonymous symbols without children.
if name is None:
return None
res["name"] = name if name is not None else "<anon>"
return res