Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Translate quint variable initialization as equality, not assignment #2864

Closed
wants to merge 3 commits into from
Closed

Translate quint variable initialization as equality, not assignment #2864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
efb30ea
Sanitize identifiers when pretty printing
Mar 13, 2024
078bbbc
Generalize NullaryOpReader into ContextReader
Mar 14, 2024
22b8270
Equate state variables in quint init predicates
Mar 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 27 additions & 6 deletions tla-io/src/main/scala/at/forsyte/apalache/io/lir/PrettyWriter.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,7 @@ class PrettyWriter(
prettyWriteDoc(declToDoc(decl) <> line <> line)
}

private def identity(x: String): String = x
def write(expr: TlaEx): Unit = prettyWriteDoc(exToDoc((0, 0), expr, identity))
def write(expr: TlaEx): Unit = prettyWriteDoc(exToDoc((0, 0), expr, sanatizeID))

def writeComment(commentStr: String): Unit = {
prettyWriteDoc(wrapWithComment(commentStr) <> line)
Expand All @@ -104,14 +103,14 @@ class PrettyWriter(
def writeFooter(): Unit = prettyWriteDoc(moduleTerminalDoc)

private def moduleNameDoc(name: String): Doc = {
val middle = s" MODULE $name "
val middle = s" MODULE ${sanatizeID(name)} "
val nDashes = math.max(5, (layout.textWidth - middle.length) / 2) // int div rounds down
s"${List.fill(nDashes)("-").mkString}$middle${List.fill(nDashes)("-").mkString}" <> line
}

private def moduleExtendsDoc(moduleNames: List[String]): Doc =
if (moduleNames.isEmpty) emptyDoc
else line <> text("EXTENDS") <> space <> hsep(moduleNames.map(text), comma) <> line
else line <> text("EXTENDS") <> space <> hsep(moduleNames.map(n => text(sanatizeID(n))), comma) <> line

private def moduleTerminalDoc: Doc =
s"${List.fill(layout.textWidth)("=").mkString}" <> line
Expand Down Expand Up @@ -539,7 +538,7 @@ class PrettyWriter(
}))
}

def declToDoc(decl: TlaDecl, nameResolver: String => String = (x: String) => x): Doc = {
def declToDoc(decl: TlaDecl, nameResolver: String => String = sanatizeID): Doc = {
val annotations = declAnnotator(layout)(decl)

decl match {
Expand Down Expand Up @@ -664,10 +663,32 @@ class PrettyWriter(
}
}

// A precompiled regex of patterns that are invalid in a TLA identifier
// Matches:
//
// - `::`, Used by apalache for "namespacing" and module imports
// - Anything that is not a TLA+2 "NameChar".
// See https://github.com/tlaplus/tlaplus-standard/blob/main/grammar/TLAPlus2Grammar.tla#L26
//
// We treat `::` special so that it will be replaced with a single `_`
private val invalidIdentifierParts = """(::|[^a-zA-Z0-9_])""".r

// In our tests, TLC will only accept identifiers that start with a prefix
// matching this pattern, even tho the spec of the grammar says numerals should
// also be valid following an underscore.
// See https://github.com/tlaplus/tlaplus-standard/blob/main/grammar/TLAPlus2Grammar.tla#L26
private val validIdentifierPrefix = """_*[a-zA-Z]""".r

// Sanitize an identifier to ensure it can be read by TLC
private def sanatizeID(s: String): String = {
val s0 = if (validIdentifierPrefix.findPrefixOf(s).isDefined) s else "id" + s
invalidIdentifierParts.replaceAllIn(s0, "_")
}

private def parseableName(name: String): String = {
// An operator name may contain '!' if it comes from an instance. Replace '!' with "_i_".
// Additionally, the name may contain '$', which is produced during preprocessing. Replace '$' with "_si_".
name.replaceAll("!", "_i_").replaceAll("\\$", "_si_")
sanatizeID(name.replaceAll("!", "_i_").replaceAll("\\$", "_si_"))
}

def close(): Unit = writer.close()
Expand Down
Loading
Loading