| /- | |
| Copyright (c) 2020 Microsoft Corporation. All rights reserved. | |
| Released under Apache 2.0 license as described in the file LICENSE. | |
| Author: Leonardo de Moura | |
| -/ | |
| module | |
| prelude | |
| public import Lean.Elab.InfoTree.Types | |
| import Init.Data.Format.Macro | |
| public section | |
| namespace Lean | |
| register_builtin_option pp.raw : Bool := { | |
| defValue := false | |
| descr := "(pretty printer) print raw expression/syntax tree" | |
| } | |
| register_builtin_option pp.raw.showInfo : Bool := { | |
| defValue := false | |
| descr := "(pretty printer) print `SourceInfo` metadata with raw printer" | |
| } | |
| register_builtin_option pp.raw.maxDepth : Nat := { | |
| defValue := 32 | |
| descr := "(pretty printer) maximum `Syntax` depth for raw printer" | |
| } | |
| register_builtin_option pp.rawOnError : Bool := { | |
| defValue := false | |
| descr := "(pretty printer) fallback to 'raw' printer when pretty printer fails" | |
| } | |
| structure PPContext where | |
| env : Environment | |
| mctx : MetavarContext := {} | |
| lctx : LocalContext := {} | |
| opts : Options := {} | |
| currNamespace : Name := Name.anonymous | |
| openDecls : List OpenDecl := [] | |
| abbrev PrettyPrinter.InfoPerPos := Std.TreeMap Nat Elab.Info | |
| /-- A format tree with `Elab.Info` annotations. | |
| Each `.tag n _` node is annotated with `infos[n]`. | |
| This is used to attach semantic data such as expressions | |
| to pretty-printer outputs. -/ | |
| structure FormatWithInfos where | |
| fmt : Format | |
| infos : PrettyPrinter.InfoPerPos | |
| instance : Coe Format FormatWithInfos where | |
| coe fmt := { fmt, infos := ∅ } | |
| structure PPFns where | |
| ppExprWithInfos : PPContext → Expr → IO FormatWithInfos | |
| ppConstNameWithInfos : PPContext → Name → IO FormatWithInfos | |
| ppTerm : PPContext → Term → IO Format | |
| ppLevel : PPContext → Level → BaseIO Format | |
| ppGoal : PPContext → MVarId → IO Format | |
| deriving Inhabited | |
| def formatRawTerm (ctx : PPContext) (stx : Term) : Format := | |
| stx.raw.formatStx (some <| pp.raw.maxDepth.get ctx.opts) (pp.raw.showInfo.get ctx.opts) | |
| def formatRawGoal (mvarId : MVarId) : Format := | |
| "goal " ++ format (mkMVar mvarId) | |
| builtin_initialize ppFnsRef : IO.Ref PPFns ← | |
| IO.mkRef { | |
| ppExprWithInfos := fun _ e => return format (toString e) | |
| ppConstNameWithInfos := fun _ n => return format n | |
| ppTerm := fun ctx stx => return formatRawTerm ctx stx | |
| ppLevel := fun _ l => return format l | |
| ppGoal := fun _ mvarId => return formatRawGoal mvarId | |
| } | |
| builtin_initialize ppExt : EnvExtension PPFns ← | |
| registerEnvExtension ppFnsRef.get | |
| def ppExprWithInfos (ctx : PPContext) (e : Expr) : BaseIO FormatWithInfos := do | |
| if pp.raw.get ctx.opts then | |
| let e := instantiateMVarsCore ctx.mctx e |>.1 | |
| return format (toString e) | |
| else | |
| match (← ppExt.getState ctx.env |>.ppExprWithInfos ctx e |>.toBaseIO) with | |
| | .ok fmt => return fmt | |
| | .error ex => | |
| if pp.rawOnError.get ctx.opts then | |
| pure f!"[Error pretty printing expression: {ex}. Falling back to raw printer.]{Format.line}{e}" | |
| else | |
| pure f!"failed to pretty print expression (use 'set_option pp.rawOnError true' for raw representation)" | |
| def ppConstNameWithInfos (ctx : PPContext) (n : Name) : BaseIO FormatWithInfos := do | |
| match (← ppExt.getState ctx.env |>.ppConstNameWithInfos ctx n |>.toBaseIO) with | |
| | .ok fmt => return fmt | |
| | .error ex => | |
| if pp.rawOnError.get ctx.opts then | |
| pure f!"[Error pretty printing constant: {ex}. Falling back to raw printer.]{Format.line}{format n}" | |
| else | |
| pure f!"failed to pretty print constant (use 'set_option pp.rawOnError true' for raw representation)" | |
| def ppTerm (ctx : PPContext) (stx : Term) : BaseIO Format := do | |
| if pp.raw.get ctx.opts then | |
| return formatRawTerm ctx stx | |
| else | |
| match (← ppExt.getState ctx.env |>.ppTerm ctx stx |>.toBaseIO) with | |
| | .ok fmt => return fmt | |
| | .error ex => | |
| if pp.rawOnError.get ctx.opts then | |
| pure f!"[Error pretty printing syntax: {ex}. Falling back to raw printer.]{Format.line}{formatRawTerm ctx stx}" | |
| else | |
| pure f!"failed to pretty print term (use 'set_option pp.rawOnError true' for raw representation)" | |
| def ppLevel (ctx : PPContext) (l : Level) : BaseIO Format := | |
| ppExt.getState ctx.env |>.ppLevel ctx l | |
| def ppGoal (ctx : PPContext) (mvarId : MVarId) : BaseIO Format := do | |
| match (← ppExt.getState ctx.env |>.ppGoal ctx mvarId |>.toBaseIO) with | |
| | .ok fmt => return fmt | |
| | .error ex => | |
| if pp.rawOnError.get ctx.opts then | |
| pure f!"[Error pretty printing goal: {ex}. Falling back to raw printer.]{Format.line}{formatRawGoal mvarId}" | |
| else | |
| pure f!"failed to pretty print goal (use 'set_option pp.rawOnError true' for raw representation)" | |
| end Lean |