def Lean.Elab.checkNotAlreadyDeclared {m : Type → Type} [Monad m] [MonadEnv m] [MonadError m] [MonadInfoTree m] (declName : Name) : m Unit

Ensure the environment does not contain a declaration with name declName. Recall that a private declaration cannot shadow a non-private one and vice-versa, although they internally have different names.

Equations

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

inductive Lean.Elab.Visibility : Type

Declaration visibility modifier. That is, whether a declaration is regular, protected or private.

• regular : Visibility
• protected : Visibility
• private : Visibility
• public : Visibility

instance Lean.Elab.instInhabitedVisibility : Inhabited Visibility

Equations

• Lean.Elab.instInhabitedVisibility = { default := Lean.Elab.Visibility.regular }

instance Lean.Elab.instToStringVisibility : ToString Visibility

Equations

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

def Lean.Elab.Visibility.isPrivate : Visibility → Bool

Equations

• Lean.Elab.Visibility.private.isPrivate = true
• x✝.isPrivate = false

def Lean.Elab.Visibility.isProtected : Visibility → Bool

Equations

• Lean.Elab.Visibility.protected.isProtected = true
• x✝.isProtected = false

def Lean.Elab.Visibility.isPublic : Visibility → Bool

Equations

• Lean.Elab.Visibility.public.isPublic = true
• x✝.isPublic = false

def Lean.Elab.Visibility.isInferredPublic (env : Environment) (v : Visibility) : Bool

Equations

• Lean.Elab.Visibility.isInferredPublic env v = if (env.isExporting || !env.header.isModule) = true then !v.isPrivate else v.isPublic

inductive Lean.Elab.RecKind : Type

Whether a declaration is default, partial or nonrec.

• partial : RecKind
• nonrec : RecKind
• default : RecKind

instance Lean.Elab.instInhabitedRecKind : Inhabited RecKind

Equations

• Lean.Elab.instInhabitedRecKind = { default := Lean.Elab.RecKind.partial }

inductive Lean.Elab.ComputeKind : Type

Codegen-relevant modifiers.

• regular : ComputeKind
• meta : ComputeKind
• noncomputable : ComputeKind

instance Lean.Elab.instInhabitedComputeKind : Inhabited ComputeKind

Equations

• Lean.Elab.instInhabitedComputeKind = { default := Lean.Elab.ComputeKind.regular }

structure Lean.Elab.Modifiers : Type

Flags and data added to declarations (eg docstrings, attributes, private, unsafe, partial, ...).

• stx : TSyntax `Lean.Parser.Command.declModifiers

  Input syntax, used for adjusting declaration range (unless missing)

• docString? : Option (TSyntax `Lean.Parser.Command.docComment)
• visibility : Visibility
• computeKind : ComputeKind
• recKind : RecKind
• isUnsafe : Bool
• attrs : Array Attribute

instance Lean.Elab.instInhabitedModifiers : Inhabited Modifiers

Equations

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

def Lean.Elab.Modifiers.isPrivate (m : Modifiers) : Bool

Equations

• m.isPrivate = m.visibility.isPrivate

def Lean.Elab.Modifiers.isProtected (m : Modifiers) : Bool

Equations

• m.isProtected = m.visibility.isProtected

def Lean.Elab.Modifiers.isPublic (m : Modifiers) : Bool

Equations

• m.isPublic = m.visibility.isPublic

def Lean.Elab.Modifiers.isInferredPublic (env : Environment) (m : Modifiers) : Bool

Equations

• Lean.Elab.Modifiers.isInferredPublic env m = Lean.Elab.Visibility.isInferredPublic env m.visibility

def Lean.Elab.Modifiers.isPartial : Modifiers → Bool

Equations

• { stx := stx, docString? := docString?, visibility := visibility, computeKind := computeKind, recKind := Lean.Elab.RecKind.partial, isUnsafe := isUnsafe, attrs := attrs }.isPartial = true
• x✝.isPartial = false

def Lean.Elab.Modifiers.isInferredPartial : Modifiers → Bool

Whether the declaration is explicitly partial or should be considered as such via meta. In the latter case, elaborators should not produce an error if partialty is unnecessary.

Equations

• One or more equations did not get rendered due to their size.
• x✝.isInferredPartial = false

def Lean.Elab.Modifiers.isNonrec : Modifiers → Bool

Equations

• { stx := stx, docString? := docString?, visibility := visibility, computeKind := computeKind, recKind := Lean.Elab.RecKind.nonrec, isUnsafe := isUnsafe, attrs := attrs }.isNonrec = true
• x✝.isNonrec = false

def Lean.Elab.Modifiers.isMeta (m : Modifiers) : Bool

Equations

• m.isMeta = match m.computeKind with | Lean.Elab.ComputeKind.meta => true | x => false

def Lean.Elab.Modifiers.isNoncomputable (m : Modifiers) : Bool

Equations

• m.isNoncomputable = match m.computeKind with | Lean.Elab.ComputeKind.noncomputable => true | x => false

def Lean.Elab.Modifiers.addAttr (modifiers : Modifiers) (attr : Attribute) : Modifiers

Adds attribute attr in modifiers

Equations

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

def Lean.Elab.Modifiers.addFirstAttr (modifiers : Modifiers) (attr : Attribute) : Modifiers

Adds attribute attr in modifiers, at the beginning

Equations

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

def Lean.Elab.Modifiers.filterAttrs (modifiers : Modifiers) (p : Attribute → Bool) : Modifiers

Filters attributes using p

Equations

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

instance Lean.Elab.instToFormatModifiers : ToFormat Modifiers

Equations

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

instance Lean.Elab.instToStringModifiers : ToString Modifiers

Equations

• Lean.Elab.instToStringModifiers = { toString := toString ∘ Std.format }

def Lean.Elab.expandOptDocComment? {m : Type → Type} [Monad m] [MonadError m] (optDocComment : Syntax) : m (Option String)

Retrieve doc string from stx of the form (docComment)?.

Equations

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

def Lean.Elab.elabModifiers {m : Type → Type} [Monad m] [MonadEnv m] [MonadResolveName m] [MonadError m] [MonadMacroAdapter m] [MonadRecDepth m] [MonadTrace m] [MonadOptions m] [AddMessageContext m] [MonadLog m] [MonadLiftT IO m] (stx : TSyntax `Lean.Parser.Command.declModifiers) : m Modifiers

Elaborate declaration modifiers (i.e., attributes, partial, private, protected, unsafe, meta, noncomputable, doc string)

Equations

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

def Lean.Elab.applyVisibility {m : Type → Type} [Monad m] [MonadEnv m] [MonadError m] [MonadInfoTree m] (visibility : Visibility) (declName : Name) : m Name

Ensure the function has not already been declared, and apply the given visibility setting to declName. If private, return the updated name using our internal encoding for private names. If protected, register declName as protected in the environment.

Equations

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

def Lean.Elab.checkIfShadowingStructureField {m : Type → Type} [Monad m] [MonadEnv m] [MonadError m] (declName : Name) : m Unit

Equations

• One or more equations did not get rendered due to their size.
• Lean.Elab.checkIfShadowingStructureField declName = pure ()

def Lean.Elab.mkDeclName {m : Type → Type} [Monad m] [MonadEnv m] [MonadError m] [MonadInfoTree m] (currNamespace : Name) (modifiers : Modifiers) (shortName : Name) : m (Name × Name)

Equations

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

def Lean.Elab.expandDeclIdCore (declId : Syntax) : Name × Syntax

declId is of the form

leading_parser ident >> optional (".{" >> sepBy1 ident ", " >> "}")

but we also accept a single identifier to users to make macro writing more convenient .

Equations

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

structure Lean.Elab.ExpandDeclIdResult : Type

expandDeclId resulting type.

• shortName : Name

  Short name for recursively referring to the declaration.

• declName : Name

  Fully qualified name that will be used to name the declaration in the kernel.

• levelNames : List Name

  Universe parameter names provided using the universe command and .{...} notation.

def Lean.Elab.expandDeclId {m : Type → Type} [Monad m] [MonadEnv m] [MonadError m] [MonadOptions m] [AddMessageContext m] [MonadLog m] [MonadInfoTree m] [MonadLiftT IO m] (currNamespace : Name) (currLevelNames : List Name) (declId : Syntax) (modifiers : Modifiers) : m ExpandDeclIdResult

Given a declaration identifier (e.g., ident (".{" ident,+ "}")?) that may contain explicit universe parameters

• Ensure the new universe parameters do not shadow universe parameters declared using universe command.
• Create the fully qualified named for the declaration using the current namespace, and given modifiers
• Create a short version for recursively referring to the declaration. Recall that the protected modifier affects the generation of the short name.

The result also contains the universe parameters provided using universe command, and the .{...} notation.

This commands also stores the doc string stored in modifiers.

Equations

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