Documentation

Lean.Elab.DeclModifiers

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.

Instances For

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

    Instances For

      Whether a declaration is default, partial or nonrec.

      Instances For

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

        Instances For

          Store attr in modifiers

          Instances For

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

            Instances For

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

              Instances For

                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.

                Instances For
                  Instances For

                    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 .

                    Instances For
                      • 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.

                      expandDeclId resulting type.

                      Instances For

                        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.

                        Instances For