[SB05-065] lkql: Add the introspection builtin "get_symbols"

Will be used by the documentation generator to get the symbols of the
stdlib/an imported module, in order to be able to get the doc for them.

Change-Id: I6d6696ad387fe55754868a679394c6de7a481acc

Author: raph-amiard

lkql/extensions/src/lkql-builtin_functions.adb

@@ -67,6 +67,9 @@ package body LKQL.Builtin_Functions is
    function Eval_Profile
      (Ctx : Eval_Context; Args : Primitive_Array) return Primitive;
 
+   function Eval_Get_Symbols
+     (Ctx : Eval_Context; Args : Primitive_Array) return Primitive;
+
    function Eval_Help
      (Ctx : Eval_Context; Args : Primitive_Array) return Primitive;
 
@@ -356,6 +359,53 @@ package body LKQL.Builtin_Functions is
       return Make_Unit_Primitive;
    end Eval_Help;
 
+   ----------------------------
+   -- Eval_Get_Local_Symbols --
+   ----------------------------
+
+   function Eval_Get_Symbols
+     (Ctx : Eval_Context; Args : Primitive_Array) return Primitive
+   is
+      procedure Get_Symbols_In_Frame
+        (C : Eval_Contexts.Environment_Access; Recurse : Boolean);
+
+      S : Symbol_Set;
+
+      procedure Get_Symbols_In_Frame
+        (C : Eval_Contexts.Environment_Access; Recurse : Boolean)
+      is
+      begin
+         if C = null then
+            return;
+         end if;
+         for I in Get_Env_Map (C).Iterate loop
+            S.Include (String_Value_Maps.Key (I));
+         end loop;
+
+         if Recurse then
+            Get_Symbols_In_Frame (Get_Parent (C), True);
+         end if;
+      end Get_Symbols_In_Frame;
+
+      Pkg : constant Primitive := Args (1);
+      Ret : constant Primitive := Make_Empty_List;
+   begin
+
+      if Booleanize (Pkg) then
+         Get_Symbols_In_Frame
+           (Eval_Contexts.Environment_Access (Pkg.Unchecked_Get.Namespace),
+            Recurse => False);
+      else
+         Get_Symbols_In_Frame (Ctx.Frames, Recurse => True);
+      end if;
+
+      for El of S loop
+         Ret.Get.List_Val.Elements.Append (To_Primitive (El.all));
+      end loop;
+      return Ret;
+
+   end Eval_Get_Symbols;
+
    -----------------------
    -- Builtin_Functions --
    -----------------------
@@ -424,6 +474,13 @@ package body LKQL.Builtin_Functions is
          Eval_Profile'Access,
          "Given any object, if it is a callable, return its profile as text"),
 
+      Create
+        ("get_symbols",
+         (1 => Param ("package", Kind_Namespace, Make_Unit_Primitive)),
+         Eval_Get_Symbols'Access,
+         "Given a module, return the symbols stored in it. If given no module"
+         & ", return the local symbols"),
+
         Create
           ("help",
            (1 => Param ("obj")),

lkql/extensions/src/lkql-eval_contexts.adb

@@ -498,4 +498,22 @@ package body LKQL.Eval_Contexts is
       Ctx.Kernel.LKQL_Path_List.Append (To_Unbounded_String (Path));
    end Add_LKQL_Path;
 
+   -----------------
+   -- Get_Env_Map --
+   -----------------
+
+   function Get_Env_Map (Self : Environment_Access) return Environment_Map is
+   begin
+      return Self.Local_Bindings;
+   end Get_Env_Map;
+
+   ----------------
+   -- Get_Parent --
+   ----------------
+
+   function Get_Parent (Self : Environment_Access) return Environment_Access is
+   begin
+      return Self.Parent;
+   end Get_Parent;
+
 end LKQL.Eval_Contexts;

lkql/extensions/src/lkql-eval_contexts.ads

@@ -79,6 +79,12 @@ package LKQL.Eval_Contexts is
    procedure Dec_Ref (Self : in out Environment_Access);
    function Env_Map_Image (Self : Environment_Map) return String;
 
+   function Get_Env_Map (Self : Environment_Access) return Environment_Map;
+   --  Get the env map for this env.
+
+   function Get_Parent (Self : Environment_Access) return Environment_Access;
+   --  Get the parent env for this env.
+
    function Env_Image (Env : Environment_Access) return String;
    --  Return a structured debug image of the env passed in parameter.