"Label" attributes

Allow creating attributes using register_label_attr, and retrieving the array of Names of declarations which have been tagged with such an attribute.

These differ slightly from the built-in "tag attributes" which can be initialized with the syntax:

initialize someName : TagAttribute ← registerTagAttribute `tagName "description"

in that a "tag attribute" can only be put on a declaration at the moment it is declared, and can not be modified by scoping commands.

The "label attributes" constructed here support adding (or locally removing) the attribute either at the moment of declaration, or later.

@[reducible, inline]

abbrev Lean.LabelExtension : Type

An environment extension that just tracks an array of names.

Equations

• Lean.LabelExtension = Lean.SimpleScopedEnvExtension Lean.Name (Array Lean.Name)

@[reducible, inline]

abbrev Lean.LabelExtensionMap : Type

The collection of all current LabelExtensions, indexed by name.

Equations

• Lean.LabelExtensionMap = Std.HashMap Lean.Name Lean.LabelExtension

opaque Lean.labelExtensionMapRef : IO.Ref Lean.LabelExtensionMap

Store the current LabelExtensions.

def Lean.mkLabelExt (name : Lean.Name := by exact decl_name%) : IO Lean.LabelExtension

Helper function for registerLabelAttr.

def Lean.mkLabelAttr (attrName : Lean.Name) (attrDescr : String) (ext : Lean.LabelExtension) (ref : Lean.Name := by exact decl_name%) : IO Unit

Helper function for registerLabelAttr.

def Lean.registerLabelAttr (attrName : Lean.Name) (attrDescr : String) (ref : Lean.Name := by exact decl_name%) : IO Lean.LabelExtension

Construct a new "label attribute", which does nothing except keep track of the names of the declarations with that attribute.

Users will generally use the register_label_attr macro defined below.

Equations

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

def Lean.Parser.Command.registerLabelAttr : Lean.ParserDescr

Initialize a new "label" attribute. Declarations tagged with the attribute can be retrieved using Lean.labelled.

Equations

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

def Lean.labelled (attrName : Lean.Name) : Lean.CoreM (Array Lean.Name)

When attrName is an attribute created using register_labelled_attr, return the names of all declarations labelled using that attribute.

Equations

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