Version

This module contains useful definitions for manipulating versions. It also defines a v!"<ver>" syntax for version literals.

structure Lake.SemVerCore : Type

The major-minor-patch triple of a SemVer.

• major : Nat
• minor : Nat
• patch : Nat

instance Lake.instInhabitedSemVerCore : Inhabited Lake.SemVerCore

Equations

• Lake.instInhabitedSemVerCore = { default := { major := default, minor := default, patch := default } }

instance Lake.instReprSemVerCore : Repr Lake.SemVerCore

Equations

• Lake.instReprSemVerCore = { reprPrec := Lake.reprSemVerCore✝ }

instance Lake.instDecidableEqSemVerCore : DecidableEq Lake.SemVerCore

Equations

• Lake.instDecidableEqSemVerCore = Lake.decEqSemVerCore✝

instance Lake.instOrdSemVerCore : Ord Lake.SemVerCore

Equations

• Lake.instOrdSemVerCore = { compare := Lake.ordSemVerCore✝ }

instance Lake.instLTSemVerCore : LT Lake.SemVerCore

Equations

• Lake.instLTSemVerCore = ltOfOrd

instance Lake.instLESemVerCore : LE Lake.SemVerCore

Equations

• Lake.instLESemVerCore = leOfOrd

instance Lake.instMinSemVerCore : Min Lake.SemVerCore

instance Lake.instMaxSemVerCore : Max Lake.SemVerCore

Equations

• Lake.instMaxSemVerCore = maxOfLe

def Lake.SemVerCore.parse (ver : String) : Except String Lake.SemVerCore

Equations

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

def Lake.SemVerCore.toString (ver : Lake.SemVerCore) : String

instance Lake.instToStringSemVerCore : ToString Lake.SemVerCore

instance Lake.instToJsonSemVerCore : Lean.ToJson Lake.SemVerCore

Equations

• Lake.instToJsonSemVerCore = { toJson := fun (x : Lake.SemVerCore) => Lean.Json.str x.toString }

instance Lake.instFromJsonSemVerCore : Lean.FromJson Lake.SemVerCore

instance Lake.instToExprSemVerCore : Lean.ToExpr Lake.SemVerCore

Equations

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

structure Lake.StdVerextends Lake.SemVerCore : Type

A Lean-style semantic version. A major-minor-patch triple with an optional arbitrary - suffix.

• major : Nat
• minor : Nat
• patch : Nat
• specialDescr : String

instance Lake.instInhabitedStdVer : Inhabited Lake.StdVer

Equations

• Lake.instInhabitedStdVer = { default := { toSemVerCore := default, specialDescr := default } }

instance Lake.instReprStdVer : Repr Lake.StdVer

Equations

• Lake.instReprStdVer = { reprPrec := Lake.reprStdVer✝ }

instance Lake.instDecidableEqStdVer : DecidableEq Lake.StdVer

Equations

• Lake.instDecidableEqStdVer = Lake.decEqStdVer✝

@[reducible, inline]

abbrev Lake.LeanVer : Type

A Lean version.

Equations

• Lake.LeanVer = Lake.StdVer

instance Lake.instCoeStdVerSemVerCore : Coe Lake.StdVer Lake.SemVerCore

@[inline]

def Lake.StdVer.ofSemVerCore (ver : Lake.SemVerCore) : Lake.StdVer

Equations

• Lake.StdVer.ofSemVerCore ver = { toSemVerCore := ver, specialDescr := "" }

instance Lake.instCoeSemVerCoreStdVer : Coe Lake.SemVerCore Lake.StdVer

Equations

• Lake.instCoeSemVerCoreStdVer = { coe := Lake.StdVer.ofSemVerCore }

def Lake.StdVer.compare (a b : Lake.StdVer) : Ordering

instance Lake.instOrdStdVer : Ord Lake.StdVer

Equations

• Lake.instOrdStdVer = { compare := Lake.StdVer.compare }

instance Lake.instLTStdVer : LT Lake.StdVer

instance Lake.instLEStdVer : LE Lake.StdVer

Equations

• Lake.instLEStdVer = leOfOrd

instance Lake.instMinStdVer : Min Lake.StdVer

Equations

• Lake.instMinStdVer = minOfLe

instance Lake.instMaxStdVer : Max Lake.StdVer

Equations

• Lake.instMaxStdVer = maxOfLe

def Lake.StdVer.parse (ver : String) : Except String Lake.StdVer

def Lake.StdVer.toString (ver : Lake.StdVer) : String

Equations

• ver.toString = if ver.specialDescr.isEmpty = true then ver.toString else toString "" ++ toString ver.toSemVerCore ++ toString "-" ++ toString ver.specialDescr ++ toString ""

instance Lake.instToStringStdVer : ToString Lake.StdVer

instance Lake.instToJsonStdVer : Lean.ToJson Lake.StdVer

Equations

• Lake.instToJsonStdVer = { toJson := fun (x : Lake.StdVer) => Lean.Json.str x.toString }

instance Lake.instFromJsonStdVer : Lean.FromJson Lake.StdVer

Equations

• Lake.instFromJsonStdVer = { fromJson? := fun (x : Lean.Json) => do let __do_lift ← Lean.fromJson? x Lake.StdVer.parse __do_lift }

instance Lake.instToExprStdVer : Lean.ToExpr Lake.StdVer

Equations

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

inductive Lake.ToolchainVer : Type

A Lean toolchain version.

• release: Lake.LeanVer → Lake.ToolchainVer
• nightly: Lake.Date → Lake.ToolchainVer
• pr: Nat → Lake.ToolchainVer
• other: String → Lake.ToolchainVer

instance Lake.instReprToolchainVer : Repr Lake.ToolchainVer

instance Lake.instDecidableEqToolchainVer : DecidableEq Lake.ToolchainVer

instance Lake.instCoeLeanVerToolchainVer : Coe Lake.LeanVer Lake.ToolchainVer

def Lake.ToolchainVer.defaultOrigin : String

def Lake.ToolchainVer.prOrigin : String

Equations

• Lake.ToolchainVer.prOrigin = "leanprover/lean4-pr-releases"

def Lake.ToolchainVer.ofString (ver : String) : Lake.ToolchainVer

Equations

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

def Lake.ToolchainVer.ofFile? (toolchainFile : System.FilePath) : IO (Option Lake.ToolchainVer)

Parse a toolchain from a lean-toolchain file.

def Lake.toolchainFileName : System.FilePath

The elan toolchain file name (i.e., lean-toolchain).

@[inline]

def Lake.ToolchainVer.ofDir? (dir : System.FilePath) : IO (Option Lake.ToolchainVer)

Parse a toolchain from the lean-toolchain file of the directory dir.

Equations

• Lake.ToolchainVer.ofDir? dir = Lake.ToolchainVer.ofFile? (dir / Lake.toolchainFileName)

def Lake.ToolchainVer.toString (ver : Lake.ToolchainVer) : String

Equations

• (Lake.ToolchainVer.release a).toString = toString "" ++ toString Lake.ToolchainVer.defaultOrigin ++ toString ":v" ++ toString a ++ toString ""
• (Lake.ToolchainVer.nightly a).toString = toString "" ++ toString Lake.ToolchainVer.defaultOrigin ++ toString ":nightly-" ++ toString a ++ toString ""
• (Lake.ToolchainVer.pr a).toString = toString "" ++ toString Lake.ToolchainVer.prOrigin ++ toString ":pr-release-" ++ toString a ++ toString ""
• (Lake.ToolchainVer.other a).toString = a

instance Lake.instToStringToolchainVer : ToString Lake.ToolchainVer

Equations

• Lake.instToStringToolchainVer = { toString := Lake.ToolchainVer.toString }

instance Lake.instToJsonToolchainVer : Lean.ToJson Lake.ToolchainVer

instance Lake.instFromJsonToolchainVer : Lean.FromJson Lake.ToolchainVer

Equations

• Lake.instFromJsonToolchainVer = { fromJson? := fun (x : Lean.Json) => Lake.ToolchainVer.ofString <$> Lean.fromJson? x }

def Lake.ToolchainVer.lt (a b : Lake.ToolchainVer) : Prop

Equations

• (Lake.ToolchainVer.release v1).lt (Lake.ToolchainVer.release v2) = (v1 < v2)
• (Lake.ToolchainVer.nightly d1).lt (Lake.ToolchainVer.nightly d2) = (d1 < d2)
• a.lt b = False

instance Lake.instLTToolchainVer : LT Lake.ToolchainVer

instance Lake.ToolchainVer.decLt (a b : Lake.ToolchainVer) : Decidable (a < b)

def Lake.ToolchainVer.le (a b : Lake.ToolchainVer) : Prop

Equations

• (Lake.ToolchainVer.release v1).le (Lake.ToolchainVer.release v2) = (v1 ≤ v2)
• (Lake.ToolchainVer.nightly d1).le (Lake.ToolchainVer.nightly d2) = (d1 ≤ d2)
• (Lake.ToolchainVer.pr n1).le (Lake.ToolchainVer.pr n2) = (n1 = n2)
• (Lake.ToolchainVer.other v1).le (Lake.ToolchainVer.other v2) = (v1 = v2)
• a.le b = False

instance Lake.instLEToolchainVer : LE Lake.ToolchainVer

Equations

• Lake.instLEToolchainVer = { le := Lake.ToolchainVer.le }

instance Lake.ToolchainVer.decLe (a b : Lake.ToolchainVer) : Decidable (a ≤ b)

Version Literals

Defines the v!"<ver>" syntax for version literals. The elaborator attempts to synthesize an instance of ToVersion for the expected type and then applies it to the string literal.

class Lake.DecodeVersion (α : Type u) : Type u

Parses a version from a string.

• decodeVersion : String → Except String α

instance Lake.instDecodeVersionSemVerCore : Lake.DecodeVersion Lake.SemVerCore

@[defaultInstance 1000]

instance Lake.instDecodeVersionStdVer : Lake.DecodeVersion Lake.StdVer

instance Lake.instDecodeVersionToolchainVer : Lake.DecodeVersion Lake.ToolchainVer

def Lake.verLit : Lean.ParserDescr

A Lake version literal.

def Lake.elabVerLit : Lean.Elab.Term.TermElab