def Lean.Elab.checkNotAlreadyDeclared {m : Type → Type} [Monad m] [Lean.MonadEnv m] [Lean.MonadError m] [Lean.Elab.MonadInfoTree m] (declName : Lake.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: Lean.Elab.Visibility
• protected: Lean.Elab.Visibility
• private: Lean.Elab.Visibility

instance Lean.Elab.instInhabitedVisibility : Inhabited Lean.Elab.Visibility

Equations

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

instance Lean.Elab.instToStringVisibility : ToString Lean.Elab.Visibility

Equations

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

inductive Lean.Elab.RecKind : Type

Whether a declaration is default, partial or nonrec.

• partial: Lean.Elab.RecKind
• nonrec: Lean.Elab.RecKind
• default: Lean.Elab.RecKind

instance Lean.Elab.instInhabitedRecKind : Inhabited Lean.Elab.RecKind

Equations

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

structure Lean.Elab.Modifiers : Type

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

• docString? : Option String
• visibility : Lean.Elab.Visibility
• isNoncomputable : Bool
• recKind : Lean.Elab.RecKind
• isUnsafe : Bool
• attrs : Array Lean.Elab.Attribute

instance Lean.Elab.instInhabitedModifiers : Inhabited Lean.Elab.Modifiers

Equations

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

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

Equations

• { docString? := docString?, visibility := Lean.Elab.Visibility.private, isNoncomputable := isNoncomputable, recKind := recKind, isUnsafe := isUnsafe, attrs := attrs }.isPrivate = true
• x.isPrivate = false

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

Equations

• { docString? := docString?, visibility := Lean.Elab.Visibility.protected, isNoncomputable := isNoncomputable, recKind := recKind, isUnsafe := isUnsafe, attrs := attrs }.isProtected = true
• x.isProtected = false

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

Equations

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

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

Equations

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

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

Adds attribute attr in modifiers

Equations

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

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

Filters attributes using p

Equations

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

instance Lean.Elab.instToFormatModifiers : Lean.ToFormat Lean.Elab.Modifiers

Equations

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

instance Lean.Elab.instToStringModifiers : ToString Lean.Elab.Modifiers

Equations

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

def Lean.Elab.expandOptDocComment? {m : Type → Type} [Monad m] [Lean.MonadError m] (optDocComment : Lean.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] [Lean.MonadEnv m] [Lean.MonadResolveName m] [Lean.MonadError m] [Lean.Elab.MonadMacroAdapter m] [Lean.MonadRecDepth m] [Lean.MonadTrace m] [Lean.MonadOptions m] [Lean.AddMessageContext m] [Lean.MonadLog m] [MonadLiftT IO m] (stx : Lean.Syntax) : m Lean.Elab.Modifiers

Elaborate declaration modifiers (i.e., attributes, partial, private, protected, unsafe, 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] [Lean.MonadEnv m] [Lean.MonadError m] [Lean.Elab.MonadInfoTree m] (visibility : Lean.Elab.Visibility) (declName : Lake.Name) : m Lake.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.
• Lean.Elab.applyVisibility visibility declName = do Lean.Elab.checkNotAlreadyDeclared declName pure declName

def Lean.Elab.checkIfShadowingStructureField {m : Type → Type} [Monad m] [Lean.MonadEnv m] [Lean.MonadError m] (declName : Lake.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] [Lean.MonadEnv m] [Lean.MonadError m] [Lean.Elab.MonadInfoTree m] (currNamespace : Lake.Name) (modifiers : Lean.Elab.Modifiers) (shortName : Lake.Name) : m (Lake.Name × Lake.Name)

Equations

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

def Lean.Elab.expandDeclIdCore (declId : Lean.Syntax) : Lake.Name × Lean.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

• Lean.Elab.expandDeclIdCore declId = if declId.isIdent = true then (declId.getId, Lean.mkNullNode) else let id := declId[0].getId; let optUnivDeclStx := declId[1]; (id, optUnivDeclStx)

structure Lean.Elab.ExpandDeclIdResult : Type

expandDeclId resulting type.

• shortName : Lake.Name

  Short name for recursively referring to the declaration.

• declName : Lake.Name

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

• levelNames : List Lake.Name

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

def Lean.Elab.expandDeclId {m : Type → Type} [Monad m] [Lean.MonadEnv m] [Lean.MonadError m] [Lean.Elab.MonadInfoTree m] (currNamespace : Lake.Name) (currLevelNames : List Lake.Name) (declId : Lean.Syntax) (modifiers : Lean.Elab.Modifiers) : m Lean.Elab.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.