opaque Lean.Elab.Tactic.RCases.linter.unusedRCasesPattern : Lean.Option Bool

Enables the 'unused rcases pattern' linter. This will warn when a pattern is ignored by rcases, rintro, ext and similar tactics.

instance Lean.Elab.Tactic.RCases.instCoeIdentTSyntaxConsSyntaxNodeKindMkStr1Nil_lean : Coe Lean.Ident (Lean.TSyntax `rcasesPat)

Equations

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

instance Lean.Elab.Tactic.RCases.instCoeTSyntaxConsSyntaxNodeKindMkStr1NilMkStr4_lean : Coe (Lean.TSyntax `rcasesPat) (Lean.TSyntax `Lean.Parser.Tactic.rcasesPatMed)

Equations

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

instance Lean.Elab.Tactic.RCases.instCoeTSyntaxConsSyntaxNodeKindMkStr4Nil_lean : Coe (Lean.TSyntax `Lean.Parser.Tactic.rcasesPatMed) (Lean.TSyntax `Lean.Parser.Tactic.rcasesPatLo)

Equations

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

instance Lean.Elab.Tactic.RCases.instCoeTSyntaxConsSyntaxNodeKindMkStr1Nil_lean : Coe (Lean.TSyntax `rcasesPat) (Lean.TSyntax `rintroPat)

Equations

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

inductive Lean.Elab.Tactic.RCases.RCasesPatt : Type

An rcases pattern can be one of the following, in a nested combination:

• A name like foo
• The special keyword rfl (for pattern matching on equality using subst)
• A hyphen -, which clears the active hypothesis and any dependents.
• A type ascription like pat : ty (parentheses are optional)
• A tuple constructor like ⟨p1, p2, p3⟩
• An alternation / variant pattern p1 | p2 | p3

Parentheses can be used for grouping; alternation is higher precedence than type ascription, so p1 | p2 | p3 : ty means (p1 | p2 | p3) : ty.

N-ary alternations are treated as a group, so p1 | p2 | p3 is not the same as p1 | (p2 | p3), and similarly for tuples. However, note that an n-ary alternation or tuple can match an n-ary conjunction or disjunction, because if the number of patterns exceeds the number of constructors in the type being destructed, the extra patterns will match on the last element, meaning that p1 | p2 | p3 will act like p1 | (p2 | p3) when matching a1 ∨ a2 ∨ a3. If matching against a type with 3 constructors, p1 | (p2 | p3) will act like p1 | (p2 | p3) | _ instead.

• paren: Lean.Syntax → Lean.Elab.Tactic.RCases.RCasesPatt → Lean.Elab.Tactic.RCases.RCasesPatt

  A parenthesized expression, used for hovers

• one: Lean.Syntax → Lake.Name → Lean.Elab.Tactic.RCases.RCasesPatt

  A named pattern like foo

• clear: Lean.Syntax → Lean.Elab.Tactic.RCases.RCasesPatt

  A hyphen -, which clears the active hypothesis and any dependents.

• explicit: Lean.Syntax → Lean.Elab.Tactic.RCases.RCasesPatt → Lean.Elab.Tactic.RCases.RCasesPatt

  An explicit pattern @pat.

• typed: Lean.Syntax → Lean.Elab.Tactic.RCases.RCasesPatt → Lean.Term → Lean.Elab.Tactic.RCases.RCasesPatt

  A type ascription like pat : ty (parentheses are optional)

• tuple: Lean.Syntax → List Lean.Elab.Tactic.RCases.RCasesPatt → Lean.Elab.Tactic.RCases.RCasesPatt

  A tuple constructor like ⟨p1, p2, p3⟩

• alts: Lean.Syntax → List Lean.Elab.Tactic.RCases.RCasesPatt → Lean.Elab.Tactic.RCases.RCasesPatt

  An alternation / variant pattern p1 | p2 | p3

instance Lean.Elab.Tactic.RCases.instReprRCasesPatt : Repr Lean.Elab.Tactic.RCases.RCasesPatt

Equations

• Lean.Elab.Tactic.RCases.instReprRCasesPatt = { reprPrec := Lean.Elab.Tactic.RCases.reprRCasesPatt✝ }

instance Lean.Elab.Tactic.RCases.RCasesPatt.instInhabited : Inhabited Lean.Elab.Tactic.RCases.RCasesPatt

Equations

• Lean.Elab.Tactic.RCases.RCasesPatt.instInhabited = { default := Lean.Elab.Tactic.RCases.RCasesPatt.one Lean.Syntax.missing `_ }

partial def Lean.Elab.Tactic.RCases.RCasesPatt.name? : Lean.Elab.Tactic.RCases.RCasesPatt → Option Lake.Name

Get the name from a pattern, if provided

def Lean.Elab.Tactic.RCases.RCasesPatt.ref : Lean.Elab.Tactic.RCases.RCasesPatt → Lean.Syntax

Get the syntax node from which this pattern was parsed. Used for error messages

Equations

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

def Lean.Elab.Tactic.RCases.RCasesPatt.asTuple : Lean.Elab.Tactic.RCases.RCasesPatt → Bool × List Lean.Elab.Tactic.RCases.RCasesPatt

Interpret an rcases pattern as a tuple, where p becomes ⟨p⟩ if p is not already a tuple.

Equations

• (Lean.Elab.Tactic.RCases.RCasesPatt.paren ref p).asTuple = p.asTuple
• (Lean.Elab.Tactic.RCases.RCasesPatt.explicit ref p).asTuple = (true, p.asTuple.snd)
• (Lean.Elab.Tactic.RCases.RCasesPatt.tuple ref ps).asTuple = (false, ps)
• x.asTuple = (false, [x])

def Lean.Elab.Tactic.RCases.RCasesPatt.asAlts : Lean.Elab.Tactic.RCases.RCasesPatt → List Lean.Elab.Tactic.RCases.RCasesPatt

Interpret an rcases pattern as an alternation, where non-alternations are treated as one alternative.

Equations

• (Lean.Elab.Tactic.RCases.RCasesPatt.paren ref p).asAlts = p.asAlts
• (Lean.Elab.Tactic.RCases.RCasesPatt.alts ref ps).asAlts = ps
• x.asAlts = [x]

def Lean.Elab.Tactic.RCases.RCasesPatt.typed? (ref : Lean.Syntax) : Lean.Elab.Tactic.RCases.RCasesPatt → Option Lean.Term → Lean.Elab.Tactic.RCases.RCasesPatt

Convert a list of patterns to a tuple pattern, but mapping [p] to p instead of ⟨p⟩.

Equations

• Lean.Elab.Tactic.RCases.RCasesPatt.typed? ref x✝ x = match x✝, x with | p, none => p | p, some ty => Lean.Elab.Tactic.RCases.RCasesPatt.typed ref p ty

def Lean.Elab.Tactic.RCases.RCasesPatt.tuple' : List Lean.Elab.Tactic.RCases.RCasesPatt → Lean.Elab.Tactic.RCases.RCasesPatt

Convert a list of patterns to a tuple pattern, but mapping [p] to p instead of ⟨p⟩.

Equations

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

def Lean.Elab.Tactic.RCases.RCasesPatt.alts' (ref : Lean.Syntax) : List Lean.Elab.Tactic.RCases.RCasesPatt → Lean.Elab.Tactic.RCases.RCasesPatt

Convert a list of patterns to an alternation pattern, but mapping [p] to p instead of a unary alternation |p.

Equations

• Lean.Elab.Tactic.RCases.RCasesPatt.alts' ref x = match x with | [p] => p | ps => Lean.Elab.Tactic.RCases.RCasesPatt.alts ref ps

def Lean.Elab.Tactic.RCases.RCasesPatt.tuple₁Core : List Lean.Elab.Tactic.RCases.RCasesPatt → List Lean.Elab.Tactic.RCases.RCasesPatt

This function is used for producing rcases patterns based on a case tree. Suppose that we have a list of patterns ps that will match correctly against the branches of the case tree for one constructor. This function will merge tuples at the end of the list, so that [a, b, ⟨c, d⟩] becomes ⟨a, b, c, d⟩ instead of ⟨a, b, ⟨c, d⟩⟩.

We must be careful to turn [a, ⟨⟩] into ⟨a, ⟨⟩⟩ instead of ⟨a⟩ (which will not perform the nested match).

Equations

• Lean.Elab.Tactic.RCases.RCasesPatt.tuple₁Core [] = []
• Lean.Elab.Tactic.RCases.RCasesPatt.tuple₁Core [Lean.Elab.Tactic.RCases.RCasesPatt.tuple ref []] = [Lean.Elab.Tactic.RCases.RCasesPatt.tuple ref []]
• Lean.Elab.Tactic.RCases.RCasesPatt.tuple₁Core [Lean.Elab.Tactic.RCases.RCasesPatt.tuple ref ps] = ps
• Lean.Elab.Tactic.RCases.RCasesPatt.tuple₁Core (p :: ps) = p :: Lean.Elab.Tactic.RCases.RCasesPatt.tuple₁Core ps

def Lean.Elab.Tactic.RCases.RCasesPatt.tuple₁ : List Lean.Elab.Tactic.RCases.RCasesPatt → Lean.Elab.Tactic.RCases.RCasesPatt

This function is used for producing rcases patterns based on a case tree. This is like tuple₁Core but it produces a pattern instead of a tuple pattern list, converting [n] to n instead of ⟨n⟩ and [] to _, and otherwise just converting [a, b, c] to ⟨a, b, c⟩.

Equations

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

def Lean.Elab.Tactic.RCases.RCasesPatt.alts₁Core : List (List Lean.Elab.Tactic.RCases.RCasesPatt) → List Lean.Elab.Tactic.RCases.RCasesPatt

This function is used for producing rcases patterns based on a case tree. Here we are given the list of patterns to apply to each argument of each constructor after the main case, and must produce a list of alternatives with the same effect. This function calls tuple₁ to make the individual alternatives, and handles merging [a, b, c | d] to a | b | c | d instead of a | b | (c | d).

Equations

• Lean.Elab.Tactic.RCases.RCasesPatt.alts₁Core [] = []
• Lean.Elab.Tactic.RCases.RCasesPatt.alts₁Core [[Lean.Elab.Tactic.RCases.RCasesPatt.alts ref ps]] = ps
• Lean.Elab.Tactic.RCases.RCasesPatt.alts₁Core (p :: ps) = Lean.Elab.Tactic.RCases.RCasesPatt.tuple₁ p :: Lean.Elab.Tactic.RCases.RCasesPatt.alts₁Core ps

def Lean.Elab.Tactic.RCases.RCasesPatt.alts₁ (ref : Lean.Syntax) : List (List Lean.Elab.Tactic.RCases.RCasesPatt) → Lean.Elab.Tactic.RCases.RCasesPatt

This function is used for producing rcases patterns based on a case tree. This is like alts₁Core, but it produces a cases pattern directly instead of a list of alternatives. We specially translate the empty alternation to ⟨⟩, and translate |(a | b) to ⟨a | b⟩ (because we don't have any syntax for unary alternation). Otherwise we can use the regular merging of alternations at the last argument so that a | b | (c | d) becomes a | b | c | d.

Equations

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

instance Lean.Elab.Tactic.RCases.RCasesPatt.instToMessageData : Lean.ToMessageData Lean.Elab.Tactic.RCases.RCasesPatt

Equations

• Lean.Elab.Tactic.RCases.RCasesPatt.instToMessageData = { toMessageData := Lean.Elab.Tactic.RCases.RCasesPatt.instToMessageData.fmt 0 }

def Lean.Elab.Tactic.RCases.RCasesPatt.instToMessageData.parenAbove (tgt : Nat) (p : Nat) (m : Lean.MessageData) : Lean.MessageData

parenthesize the message if the precedence is above tgt

Equations

• Lean.Elab.Tactic.RCases.RCasesPatt.instToMessageData.parenAbove tgt p m = if tgt < p then m.paren else m

partial def Lean.Elab.Tactic.RCases.RCasesPatt.instToMessageData.fmt : Nat → Lean.Elab.Tactic.RCases.RCasesPatt → Lean.MessageData

format an RCasesPatt with the given precedence: 0 = lo, 1 = med, 2 = hi

@[irreducible]

def Lean.Elab.Tactic.RCases.processConstructor (ref : Lean.Syntax) (info : Array Lean.Meta.ParamInfo) (explicit : Bool) (idx : Nat) (ps : List Lean.Elab.Tactic.RCases.RCasesPatt) : List Lake.Name × List Lean.Elab.Tactic.RCases.RCasesPatt

Takes the number of fields of a single constructor and patterns to match its fields against (not necessarily the same number). The returned lists each contain one element per field of the constructor. The name is the name which will be used in the top-level cases tactic, and the rcases_patt is the pattern which the field will be matched against by subsequent cases tactics.

Equations

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

def Lean.Elab.Tactic.RCases.processConstructors (ref : Lean.Syntax) (params : Nat) (altVarNames : optParam (Array Lean.Meta.AltVarNames) #[]) : List Lake.Name → List Lean.Elab.Tactic.RCases.RCasesPatt → Lean.MetaM (Array Lean.Meta.AltVarNames × List (Lake.Name × List Lean.Elab.Tactic.RCases.RCasesPatt))

Takes a list of constructor names, and an (alternation) list of patterns, and matches each pattern against its constructor. It returns the list of names that will be passed to cases, and the list of (constructor name, patterns) for each constructor, where patterns is the (conjunctive) list of patterns to apply to each constructor argument.

Equations

• One or more equations did not get rendered due to their size.
• Lean.Elab.Tactic.RCases.processConstructors ref params altVarNames [] x = pure (altVarNames, [])

def Lean.Elab.Tactic.RCases.subst' (goal : Lean.MVarId) (hFVarId : Lean.FVarId) (fvarSubst : optParam Lean.Meta.FVarSubst { map := ∅ }) : Lean.MetaM (Lean.Meta.FVarSubst × Lean.MVarId)

Like Lean.Meta.subst, but preserves the FVarSubst.

Equations

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

partial def Lean.Elab.Tactic.RCases.rcasesCore {α : Type} (g : Lean.MVarId) (fs : Lean.Meta.FVarSubst) (clears : Array Lean.FVarId) (e : Lean.Expr) (a : α) (pat : Lean.Elab.Tactic.RCases.RCasesPatt) (cont : Lean.MVarId → Lean.Meta.FVarSubst → Array Lean.FVarId → α → Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

This will match a pattern pat against a local hypothesis e.

• g: The initial subgoal
• fs: A running variable substitution, the result of cases operations upstream. The variable e must be run through this map before locating it in the context of g, and the output variable substitutions will be end extensions of this one.
• clears: The list of variables to clear in all subgoals generated from this point on. We defer clear operations because clearing too early can cause cases to fail. The actual clearing happens in RCases.finish.
• e: a local hypothesis, the scrutinee to match against.
• a: opaque "user data" which is passed through all the goal calls at the end.
• pat: the pattern to match against
• cont: A continuation. This is called on every goal generated by the result of the pattern match, with updated values for g , fs, clears, and a.

partial def Lean.Elab.Tactic.RCases.rcasesCore.align {α : Type} (fs : Lean.Meta.FVarSubst) (clears : Array Lean.FVarId) (cont : Lean.MVarId → Lean.Meta.FVarSubst → Array Lean.FVarId → α → Lean.Elab.TermElabM α) (a : α) (goal : Lean.Meta.InductionSubgoal) (ctorName : Lake.Name) : List (Lake.Name × List Lean.Elab.Tactic.RCases.RCasesPatt) → Lean.Elab.TermElabM (List (Lake.Name × List Lean.Elab.Tactic.RCases.RCasesPatt) × α)

Runs rcasesContinue on the first pattern in r with a matching ctorName. The unprocessed patterns (subsequent to the matching pattern) are returned.

partial def Lean.Elab.Tactic.RCases.rcasesContinue {α : Type} (g : Lean.MVarId) (fs : Lean.Meta.FVarSubst) (clears : Array Lean.FVarId) (a : α) (pats : List (Lean.Elab.Tactic.RCases.RCasesPatt × Lean.Expr)) (cont : Lean.MVarId → Lean.Meta.FVarSubst → Array Lean.FVarId → α → Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

This will match a list of patterns against a list of hypotheses e. The arguments are similar to rcasesCore, but the patterns and local variables are in pats. Because the calls are all nested in continuations, later arguments can be matched many times, once per goal produced by earlier arguments. For example ⟨a | b, ⟨c, d⟩⟩ performs the ⟨c, d⟩ match twice, once on the a branch and once on b.

def Lean.Elab.Tactic.RCases.tryClearMany' (goal : Lean.MVarId) (fvarIds : Array Lean.FVarId) : Lean.MetaM Lean.MVarId

Like tryClearMany, but also clears dependent hypotheses if possible

Equations

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

def Lean.Elab.Tactic.RCases.finish (toTag : optParam (Array (Lean.Ident × Lean.FVarId)) #[]) (g : Lean.MVarId) (fs : Lean.Meta.FVarSubst) (clears : Array Lean.FVarId) (gs : Array Lean.MVarId) : Lean.Elab.TermElabM (Array Lean.MVarId)

The terminating continuation used in rcasesCore and rcasesContinue. We specialize the type α to Array MVarId to collect the list of goals, and given the list of clears, it attempts to clear them from the goal and adds the goal to the list.

Equations

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

partial def Lean.Elab.Tactic.RCases.RCasesPatt.parse (stx : Lean.Syntax) : Lean.MetaM Lean.Elab.Tactic.RCases.RCasesPatt

Parses a Syntax into the RCasesPatt type used by the RCases tactic.

def Lean.Elab.Tactic.RCases.generalizeExceptFVar (goal : Lean.MVarId) (args : Array Lean.Meta.GeneralizeArg) : Lean.MetaM (Array Lean.Expr × Array Lean.FVarId × Lean.MVarId)

Generalize all the arguments as specified in args to fvars if they aren't already

Equations

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

def Lean.Elab.Tactic.RCases.rcases (tgts : Array (Option Lean.Ident × Lean.Syntax)) (pat : Lean.Elab.Tactic.RCases.RCasesPatt) (g : Lean.MVarId) : Lean.Elab.TermElabM (List Lean.MVarId)

Given a list of targets of the form e or h : e, and a pattern, match all the targets against the pattern. Returns the list of produced subgoals.

Equations

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

def Lean.Elab.Tactic.RCases.obtainNone (pat : Lean.Elab.Tactic.RCases.RCasesPatt) (ty : Lean.Syntax) (g : Lean.MVarId) : Lean.Elab.TermElabM (List Lean.MVarId)

The obtain tactic in the no-target case. Given a type T, create a goal |- T and and pattern match T against the given pattern. Returns the list of goals, with the assumed goal first followed by the goals produced by the pattern match.

Equations

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

partial def Lean.Elab.Tactic.RCases.expandRIntroPat (pat : Lean.TSyntax `rintroPat) (acc : optParam (Array (Lean.TSyntax `rcasesPat)) #[]) (ty? : optParam (Option Lean.Term) none) : Array (Lean.TSyntax `rcasesPat)

Expand a rintroPat into an equivalent list of rcasesPat patterns.

partial def Lean.Elab.Tactic.RCases.expandRIntroPats (pats : Array (Lean.TSyntax `rintroPat)) (acc : optParam (Array (Lean.TSyntax `rcasesPat)) #[]) (ty? : optParam (Option Lean.Term) none) : Array (Lean.TSyntax `rcasesPat)

Expand a list of rintroPat into an equivalent list of rcasesPat patterns.

partial def Lean.Elab.Tactic.RCases.rintroCore {α : Type} (g : Lean.MVarId) (fs : Lean.Meta.FVarSubst) (clears : Array Lean.FVarId) (a : α) (ref : Lean.Syntax) (pat : Lean.TSyntax `rintroPat) (ty? : Option Lean.Term) (cont : Lean.MVarId → Lean.Meta.FVarSubst → Array Lean.FVarId → α → Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

This introduces the pattern pat. It has the same arguments as rcasesCore, plus:

• ty?: the nearest enclosing type ascription on the current pattern

partial def Lean.Elab.Tactic.RCases.rintroContinue {α : Type} (g : Lean.MVarId) (fs : Lean.Meta.FVarSubst) (clears : Array Lean.FVarId) (ref : Lean.Syntax) (pats : Lean.TSyntaxArray `rintroPat) (ty? : Option Lean.Term) (a : α) (cont : Lean.MVarId → Lean.Meta.FVarSubst → Array Lean.FVarId → α → Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

This introduces the list of patterns pats. It has the same arguments as rcasesCore, plus:

• ty?: the nearest enclosing type ascription on the current pattern

partial def Lean.Elab.Tactic.RCases.rintroContinue.loop {α : Type} (ref : Lean.Syntax) (pats : Lean.TSyntaxArray `rintroPat) (ty? : Option Lean.Term) (cont : Lean.MVarId → Lean.Meta.FVarSubst → Array Lean.FVarId → α → Lean.Elab.TermElabM α) (i : Nat) (g : Lean.MVarId) (fs : Lean.Meta.FVarSubst) (clears : Array Lean.FVarId) (a : α) : Lean.Elab.TermElabM α

Runs rintroContinue on pats[i:]

def Lean.Elab.Tactic.RCases.rintro (pats : Lean.TSyntaxArray `rintroPat) (ty? : Option Lean.Term) (g : Lean.MVarId) : Lean.Elab.TermElabM (List Lean.MVarId)

The implementation of the rintro tactic. It takes a list of patterns pats and an optional type ascription ty? and introduces the patterns, resulting in zero or more goals.

Equations

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

def Lean.Elab.Tactic.RCases.evalRCases : Lean.Elab.Tactic.Tactic

Equations

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

def Lean.Elab.Tactic.RCases.evalObtain : Lean.Elab.Tactic.Tactic

Equations

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

def Lean.Elab.Tactic.RCases.evalRIntro : Lean.Elab.Tactic.Tactic

Equations

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