Merge pull request 'feat: Handling of private names' (#36) from library/catalog into dev

Reviewed-on: #36

Pantograph.lean

@@ -85,6 +85,7 @@ def execute (command: Protocol.Command): MainM Lean.Json := do
       return .ok {
         type := ← serialize_expression state.options info.type,
         value? := ← value?.mapM (λ v => serialize_expression state.options v),
+        publicName? := Lean.privateToUserName? name |>.map (·.toString),
         typeDependency? := if args.dependency?.getD false then .some <| info.type.getUsedConstants.map (λ n => name_to_ast n) else .none,
         valueDependency? := if args.dependency?.getD false then info.value?.map (·.getUsedConstants.map (λ n => name_to_ast n)) else .none,
         module? := module?

Pantograph/Protocol.lean

@@ -120,6 +120,8 @@ structure LibInspectResult where
   type: Expression
   value?: Option Expression := .none
   module?: Option String
+  -- If the name is private, displays the public facing name
+  publicName?: Option String := .none
   typeDependency?: Option (Array String) := .none
   valueDependency?: Option (Array String) := .none
   deriving Lean.ToJson

Pantograph/Symbol.lean

@@ -1,16 +1,13 @@
-import Lean.Declaration
+import Lean
 
 namespace Pantograph
 
 def is_symbol_unsafe_or_internal (n: Lean.Name) (info: Lean.ConstantInfo): Bool :=
-  let nameDeduce: Bool := match n.getRoot with
+  isLeanSymbol n ∨ (Lean.privateToUserName? n |>.map isLeanSymbol |>.getD false) ∨ info.isUnsafe
-  | .str _ name => name.startsWith "_" ∨ name == "Lean"
+  where
-  | _ => true
+  isLeanSymbol (name: Lean.Name): Bool := match name.getRoot with
-  let stemDeduce: Bool := match n with
+    | .str _ name => name == "Lean"
-  | .anonymous => true
+    | _ => true
-  | .str _ name => name.startsWith "_"
-  | .num _ _ => true
-  nameDeduce ∨ stemDeduce ∨ info.isUnsafe
 
 def to_compact_symbol_name (n: Lean.Name) (info: Lean.ConstantInfo): String :=
   let pref := match info with

Pantograph/Version.lean

@@ -1,5 +1,5 @@
 namespace Pantograph
 
-def version := "0.2.9"
+def version := "0.2.10"
 
 end Pantograph

Test/Catalog.lean

@@ -0,0 +1,33 @@
+import LSpec
+import Pantograph.Serial
+import Pantograph.Symbol
+
+namespace Pantograph.Test.Catalog
+
+open Pantograph
+open Lean
+
+def test_symbol_visibility (env: Environment): IO LSpec.TestSeq := do
+  let entries: List (Name × Bool) := [
+    ("Nat.add_comm".toName, false),
+    ("Lean.Name".toName, true),
+    ("_private.Init.0.Lean.Name".toName, true)
+  ]
+  let suite := entries.foldl (λ suites (symbol, target) =>
+    let constant := env.constants.find! symbol
+    let test := LSpec.check symbol.toString ((is_symbol_unsafe_or_internal symbol constant) == target)
+    LSpec.TestSeq.append suites test) LSpec.TestSeq.done
+  return suite
+
+
+
+def suite: IO LSpec.TestSeq := do
+  let env: Environment ← importModules
+    (imports := #["Init"].map (λ str => { module := str.toName, runtimeOnly := false }))
+    (opts := {})
+    (trustLevel := 1)
+
+  return LSpec.group "Catalog" $
+    (LSpec.group "Symbol visibility" (← test_symbol_visibility env))
+
+end Pantograph.Test.Catalog

Test/Main.lean

@@ -1,4 +1,5 @@
 import LSpec
+import Test.Catalog
 import Test.Holes
 import Test.Integration
 import Test.Proofs
@@ -13,7 +14,8 @@ def main := do
     Holes.suite,
     Integration.suite,
     Proofs.suite,
-    Serial.suite
+    Serial.suite,
+    Catalog.suite
   ]
   let all ← suites.foldlM (λ acc m => do pure $ acc ++ (← m)) LSpec.TestSeq.done
   LSpec.lspecIO $ all