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

Pgn idempotency #10781

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from
Draft

Pgn idempotency #10781

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f15f01c
created gamebookComment function for formatting interactive study com…
johnboltum Apr 3, 2022
619f6ca
created concatComments function for loading the new gamebookComments …
johnboltum Apr 3, 2022
771175d
small touch ups to concatComments and gamebookComment
johnboltum Apr 4, 2022
bc4f6c2
renamed concatComments to combineComments, changed its parameters so …
johnboltum Apr 4, 2022
2971013
removed comment
johnboltum Apr 6, 2022
8903fd5
Merge branch 'master' of https://github.com/johnboltum/lila
johnboltum Apr 6, 2022
f22e3ba
Merge pull request #1 from johnboltum/Interactive_PGN_idempotency
johnboltum Apr 6, 2022
8fe8ec1
removed a comment that was written as a personal note
johnboltum Apr 6, 2022
689c9c8
Merge branch 'master' of https://github.com/johnboltum/lila
johnboltum Apr 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 27 additions & 6 deletions modules/study/src/main/PgnDump.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import scala.concurrent.duration._
import scala.concurrent.ExecutionContext

import lila.common.String.slugify
import lila.tree.Node.{ Shape, Shapes }
import lila.tree.Node.{ Shape, Shapes, Gamebook, Comments }

final class PgnDump(
chapterRepo: ChapterRepo,
Expand All @@ -32,7 +32,7 @@ final class PgnDump(
tags = makeTags(study, chapter),
turns = toTurns(chapter.root)(flags).toList,
initial = Initial(
chapter.root.comments.list.map(_.text.value) ::: shapeComment(chapter.root.shapes).toList
combineComments(chapter.root.comments, chapter.root.shapes, chapter.root.gamebook)
)
)
annotator toPgnString analysis.fold(pgn)(annotator.addEvals(pgn, _))
Expand Down Expand Up @@ -78,6 +78,7 @@ final class PgnDump(
Tag(_.ECO, opening.fold("?")(_.eco)),
Tag(_.Opening, opening.fold("?")(_.name)),
Tag(_.Result, "*") // required for SCID to import
// add an AnalysisMode tag here.
) ::: List(annotatorTag(study)) ::: (!chapter.root.fen.initial).??(
List(
Tag(_.FEN, chapter.root.fen.value),
Expand All @@ -104,9 +105,7 @@ object PgnDump {
chessPgn.Move(
san = node.move.san,
glyphs = if (flags.comments) node.glyphs else Glyphs.empty,
comments = flags.comments ?? {
node.comments.list.map(_.text.value) ::: shapeComment(node.shapes).toList
},
comments = flags.comments ?? combineComments(node.comments, node.shapes, node.gamebook),
opening = none,
result = none,
variations = flags.variations ?? {
Expand All @@ -117,7 +116,29 @@ object PgnDump {
secondsLeft = flags.clocks ?? node.clock.map(_.roundSeconds)
)

// [%csl Gb4,Yd5,Rf6][%cal Ge2e4,Ye2d4,Re2g4]
private def combineComments(comments: Comments, shapes: Shapes, gamebook: Option[Gamebook]): List[String] = {
val combinedComments = comments.list.map(_.text.value) ::: shapeComment(shapes).toList
gamebook match {
case None => combinedComments
case Some(Gamebook(_,_)) => combinedComments ::: gamebookComment(gamebook.get.cleanUp).toList
}
}

// [%hint Optional, on-demand hint for the player.] ...
// [%wrong When any other move played is wrong.] ...
private def gamebookComment(gamebook: Gamebook): Option[String] = {
def render(as: String)(gamebookEntry: Option[String]) = {
gamebookEntry match {
case None => ""
case Some(gamebookEntry) => s"[%$as ${gamebookEntry}]"
}
}
val hint = render("hint")(gamebook.hint)
val wrong = render("wrong")(gamebook.deviation)
s"$hint$wrong".trim.some.filter(_.nonEmpty)
}

// [%csl Gb4,Yd5,Rf6][%cal Ge2e4,Ye2d4,Re2g4] ...
private def shapeComment(shapes: Shapes): Option[String] = {
def render(as: String)(shapes: List[String]) =
shapes match {
Expand Down