def Lean.Elab.Tactic.elabSimpConfigCore : Syntax → TacticM Meta.Simp.Config

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.elabSimpConfigCtxCore : Syntax → TacticM Meta.Simp.ConfigCtx

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.elabDSimpConfigCore : Syntax → TacticM Meta.DSimp.Config

Equations

• One or more equations did not get rendered due to their size.

inductive Lean.Elab.Tactic.SimpKind : Type

• simp : SimpKind
• simpAll : SimpKind
• dsimp : SimpKind

instance Lean.Elab.Tactic.instInhabitedSimpKind : Inhabited SimpKind

Equations

• Lean.Elab.Tactic.instInhabitedSimpKind = { default := Lean.Elab.Tactic.SimpKind.simp }

instance Lean.Elab.Tactic.instBEqSimpKind : BEq SimpKind

Equations

• Lean.Elab.Tactic.instBEqSimpKind = { beq := Lean.Elab.Tactic.beqSimpKind✝ }

def Lean.Elab.Tactic.tacticToDischarge (tacticCode : Syntax) : TacticM (IO.Ref Term.State × Meta.Simp.Discharge)

Implement a simp discharge function using the given tactic syntax code. Recall that simp dischargers are in SimpM which does not have access to Term.State. We need access to Term.State to store messages and update the info tree. Thus, we create an IO.ref to track these changes at Term.State when we execute tacticCode. We must set this reference with the current Term.State before we execute simp using the generated Simp.Discharge.

Equations

• One or more equations did not get rendered due to their size.

inductive Lean.Elab.Tactic.Simp.DischargeWrapper : Type

• default : DischargeWrapper
• custom (ref : IO.Ref Term.State) (discharge : Meta.Simp.Discharge) : DischargeWrapper

def Lean.Elab.Tactic.Simp.DischargeWrapper.with {α : Type} (w : DischargeWrapper) (x : Option Meta.Simp.Discharge → TacticM α) : TacticM α

Equations

• One or more equations did not get rendered due to their size.
• Lean.Elab.Tactic.Simp.DischargeWrapper.default.with x = x none

def Lean.Elab.Tactic.elabSimpConfig (optConfig : Syntax) (kind : SimpKind) : TacticM Meta.Simp.Config

Equations

• One or more equations did not get rendered due to their size.
• Lean.Elab.Tactic.elabSimpConfig optConfig Lean.Elab.Tactic.SimpKind.simp = Lean.Elab.Tactic.elabSimpConfigCore optConfig
• Lean.Elab.Tactic.elabSimpConfig optConfig Lean.Elab.Tactic.SimpKind.simpAll = do let __do_lift ← Lean.Elab.Tactic.elabSimpConfigCtxCore optConfig pure __do_lift.toConfig

inductive Lean.Elab.Tactic.ResolveSimpIdResult : Type

• none : ResolveSimpIdResult
• expr (e : Expr) : ResolveSimpIdResult
• simproc (declName : Name) : ResolveSimpIdResult
• ext (ext₁? : Option Meta.SimpExtension) (ext₂? : Option Meta.Simp.SimprocExtension) (h : (ext₁?.isSome || ext₂?.isSome) = true) : ResolveSimpIdResult

  Recall that when we declare a simp attribute using register_simp_attr, we automatically create a simproc attribute. However, if the user creates simp and simproc attributes programmatically, then one of them may be missing. Moreover, when we write simp [seval], we want to retrieve both the simp and simproc sets. We want to hide from users that simp and simproc sets are stored in different data-structures.

inductive Lean.Elab.Tactic.ElabSimpArgResult : Type

The result of elaborating a single simp argument

• addEntries (entries : Array Meta.SimpEntry) : ElabSimpArgResult
• addSimproc («simproc» : Name) (post : Bool) : ElabSimpArgResult
• addLetToUnfold (fvarId : FVarId) : ElabSimpArgResult
• ext (ext₁? : Option Meta.SimpExtension) (ext₂? : Option Meta.Simp.SimprocExtension) (h : (ext₁?.isSome || ext₂?.isSome) = true) : ElabSimpArgResult
• erase (toErase : Meta.Origin) : ElabSimpArgResult
• eraseSimproc (toErase : Name) : ElabSimpArgResult
• star : ElabSimpArgResult
• none : ElabSimpArgResult

def Lean.Elab.Tactic.ElabSimpArgResult.simpTheorems : ElabSimpArgResult → Array Meta.SimpTheorem

Equations

• One or more equations did not get rendered due to their size.
• x✝.simpTheorems = #[]

structure Lean.Elab.Tactic.ElabSimpArgsResult : Type

The result of elaborating a full array of simp arguments and applying them to the simp context.

• ctx : Meta.Simp.Context
• simprocs : Meta.Simp.SimprocsArray
• simpArgs : Array (Syntax × ElabSimpArgResult)

  The elaborated simp arguments with syntax

def Lean.Elab.Tactic.elabSimpArgs (stx : Syntax) (ctx : Meta.Simp.Context) (simprocs : Meta.Simp.SimprocsArray) (eraseLocal : Bool) (kind : SimpKind) (ignoreStarArg : Bool := false) : TacticM ElabSimpArgsResult

Elaborate extra simp theorems provided to simp. stx is of the form "[" simpTheorem,* "]" If eraseLocal == true, then we consider local declarations when resolving names for erased theorems (- id), this option only makes sense for simp_all or * is used. When recover := true, try to recover from errors as much as possible so that users keep seeing the current goal.

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.elabSimpArgs.toZetaDeltaSet (stx : Syntax) (ctx : Meta.Simp.Context) : TacticM FVarIdSet

If zetaDelta := false, create a FVarId set with all local let declarations in the simp argument list.

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.simpParamsPos : Nat

Position for the [..] child syntax in the simp tactic.

Equations

• Lean.Elab.Tactic.simpParamsPos = 4

def Lean.Elab.Tactic.simpOnlyPos : Nat

Position for the only child syntax in the simp tactic.

Equations

• Lean.Elab.Tactic.simpOnlyPos = 3

def Lean.Elab.Tactic.isSimpOnly (stx : TSyntax `tactic) : Bool

Equations

• Lean.Elab.Tactic.isSimpOnly stx = (stx.raw.getKind == `Lean.Parser.Tactic.simp && !stx.raw[Lean.Elab.Tactic.simpOnlyPos].isNone)

def Lean.Elab.Tactic.getSimpParams (stx : TSyntax `tactic) : Array Syntax

Equations

• Lean.Elab.Tactic.getSimpParams stx = stx.raw[Lean.Elab.Tactic.simpParamsPos][1].getSepArgs

def Lean.Elab.Tactic.setSimpParams (stx : TSyntax `tactic) (params : Array Syntax) : TSyntax `tactic

Equations

• One or more equations did not get rendered due to their size.

@[inline]

def Lean.Elab.Tactic.simpOnlyBuiltins : List Name

Equations

• Lean.Elab.Tactic.simpOnlyBuiltins = [`eq_self, `iff_self]

structure Lean.Elab.Tactic.MkSimpContextResult : Type

• ctx : Meta.Simp.Context
• simprocs : Meta.Simp.SimprocsArray
• dischargeWrapper : Simp.DischargeWrapper
• simpArgs : Array (Syntax × ElabSimpArgResult)

  The elaborated simp arguments with syntax

def Lean.Elab.Tactic.mkSimpContext (stx : Syntax) (eraseLocal : Bool) (kind : SimpKind := SimpKind.simp) (ignoreStarArg : Bool := false) (simpTheorems : CoreM Meta.SimpTheorems := Meta.getSimpTheorems) : TacticM MkSimpContextResult

Create the Simp.Context for the simp, dsimp, and simp_all tactics. If kind != SimpKind.simp, the discharge option must be none

TODO: generate error message if non rfl theorems are provided as arguments to dsimp.

The argument simpTheorems defaults to getSimpTheorems, but allows overriding with an arbitrary mechanism to choose the simp theorems besides those specified in the syntax. Note that if the syntax includes simp only, the simpTheorems argument is ignored.

Equations

• One or more equations did not get rendered due to their size.

@[inline]

def Lean.Elab.Tactic.withLoopChecking {m : Type → Type} {α : Type} [Monad m] [MonadExcept Exception m] [MonadRuntimeException m] [MonadLiftT MetaM m] (r : MkSimpContextResult) (k : m α) : m α

Runs the given action. If it throws a maxRecDepth exception (nested or not), run the loop checking. If it does not throw, run the loop checking only if explicitly enabled.

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.withLoopChecking.go {m : Type → Type} [MonadLiftT MetaM m] (r : MkSimpContextResult) (force : Bool) : m Unit

Equations

• One or more equations did not get rendered due to their size.

opaque Lean.Elab.Tactic.tactic.simp.trace : Lean.Option Bool

def Lean.Elab.Tactic.mkSimpOnly (stx : Syntax) (usedSimps : Meta.Simp.UsedSimps) : MetaM Syntax

If stx is the syntax of a simp, simp_all or dsimp tactic invocation, and usedSimps is the set of simp lemmas used by this invocation, then mkSimpOnly creates the syntax of an equivalent simp only, simp_all only or dsimp only invocation.

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.traceSimpCall (stx : Syntax) (usedSimps : Meta.Simp.UsedSimps) : MetaM Unit

Equations

• One or more equations did not get rendered due to their size.

opaque Lean.Elab.Tactic.linter.unusedSimpArgs : Lean.Option Bool

structure Lean.Elab.Tactic.UnusedSimpArgsInfo : Type

• mask : Array Bool

instance Lean.Elab.Tactic.instTypeNameUnusedSimpArgsInfo : TypeName UnusedSimpArgsInfo

Equations

• Lean.Elab.Tactic.instTypeNameUnusedSimpArgsInfo = Lean.Elab.Tactic.inst✝

def Lean.Elab.Tactic.pushUnusedSimpArgsInfo {m : Type → Type} [Monad m] [MonadInfoTree m] (simpStx : Syntax) (mask : Array Bool) : m Unit

Equations

• Lean.Elab.Tactic.pushUnusedSimpArgsInfo simpStx mask = Lean.Elab.pushInfoLeaf (Lean.Elab.Info.ofCustomInfo { stx := simpStx, value := Dynamic.mk { mask := mask } })

def Lean.Elab.Tactic.warnUnusedSimpArgs (simpArgs : Array (Syntax × ElabSimpArgResult)) (usedSimps : Meta.Simp.UsedSimps) : MetaM Unit

Checks the simp arguments for unused ones, and stores a bitmask of unused ones in the info tree, to be picked up by the linter. (This indirection is necessary because the same simp syntax may be executed multiple times, and different simp arguments may be used in each step.)

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.warnUnusedSimpArgs.usedThmIdOfSimpTheorem (thm : Meta.SimpTheorem) : MetaM Meta.Origin

For equational theorems, usedTheorems record the declaration name. So if the user specified foo.eq_1, we get foo in usedTheores, but we still want to mark foo.eq_1 as used. (cf. recordSimpTheorem) This may lead to unused, explicitly given foo.eq_1 to not be warned about. Ok for now, eventually recordSimpTheorem could record the actual theorem, and the logic for treating foo.eq_1 as foo be moved to SimpTrace.lean

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.simpLocation (ctx : Meta.Simp.Context) (simprocs : Meta.Simp.SimprocsArray) (discharge? : Option Meta.Simp.Discharge := none) (loc : Location) : TacticM Meta.Simp.Stats

simpLocation ctx discharge? varIdToLemmaId loc runs the simplifier at locations specified by loc, using the simp theorems collected in ctx optionally running a discharger specified in discharge? on generated subgoals.

Its primary use is as the implementation of the simp [...] at ... and simp only [...] at ... syntaxes, but can also be used by other tactics when a Syntax is not available.

For many tactics other than the simplifier, one should use the withLocation tactic combinator when working with a location.

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.simpLocation.go (ctx : Meta.Simp.Context) (simprocs : Meta.Simp.SimprocsArray) (discharge? : Option Meta.Simp.Discharge := none) (fvarIdsToSimp : Array FVarId) (simplifyTarget : Bool) : TacticM Meta.Simp.Stats

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.withSimpDiagnostics (x : TacticM Meta.Simp.Diagnostics) : TacticM Unit

Equations

• Lean.Elab.Tactic.withSimpDiagnostics x = do let stats ← x liftM (Lean.Meta.Simp.reportDiag stats)

def Lean.Elab.Tactic.evalSimp : Tactic

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.evalSimpAll : Tactic

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.dsimpLocation (ctx : Meta.Simp.Context) (simprocs : Meta.Simp.SimprocsArray) (loc : Location) : TacticM Unit

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.dsimpLocation.go (ctx : Meta.Simp.Context) (simprocs : Meta.Simp.SimprocsArray) (fvarIdsToSimp : Array FVarId) (simplifyTarget : Bool) : TacticM Unit

Equations

• One or more equations did not get rendered due to their size.

def Lean.Elab.Tactic.evalDSimp : Tactic

Equations

• One or more equations did not get rendered due to their size.

The following parsers for simp arguments are not actually used at present in the implementation of simp above, but are useful for further tactics which need to parse simp arguments.

def Lean.Parser.Tactic.getSimpArgs? : Syntax → Option (Array Syntax)

Extract the arguments from a simpArgs syntax as an array of syntaxes

Equations

• One or more equations did not get rendered due to their size.

def Lean.Parser.Tactic.getDSimpArgs? : Syntax → Option (Array Syntax)

Extract the arguments from a dsimpArgs syntax as an array of syntaxes

Equations

• One or more equations did not get rendered due to their size.