sbt/main/SessionSettings.scala

/* sbt -- Simple Build Tool
 * Copyright 2011 Mark Harrah
 */
package sbt

	import java.io.File
	import java.net.URI
	import Project._
	import Types.Endo
	import compiler.Eval

	import SessionSettings._

final case class SessionSettings(currentBuild: URI, currentProject: Map[URI, String], original: Seq[Setting[_]], append: SessionMap, rawAppend: Seq[Setting[_]], currentEval: () => Eval)
{
	assert(currentProject contains currentBuild, "Current build (" + currentBuild + ") not associated with a current project.")
	def setCurrent(build: URI, project: String, eval: () => Eval): SessionSettings = copy(currentBuild = build, currentProject = currentProject.updated(build, project), currentEval = eval)
	def current: ProjectRef = ProjectRef(currentBuild, currentProject(currentBuild))
	def appendSettings(s: Seq[SessionSetting]): SessionSettings = copy(append = modify(append, _ ++ s))
	def appendRaw(ss: Seq[Setting[_]]): SessionSettings = copy(rawAppend = rawAppend ++ ss)
	def mergeSettings: Seq[Setting[_]] = original ++ merge(append) ++ rawAppend
	def clearExtraSettings: SessionSettings = copy(append = Map.empty, rawAppend = Nil)

	private[this] def merge(map: SessionMap): Seq[Setting[_]] = map.values.toSeq.flatten[SessionSetting].map(_._1)
	private[this] def modify(map: SessionMap, onSeq: Endo[Seq[SessionSetting]]): SessionMap =
	{
		val cur = current
		map.updated(cur, onSeq(map.getOrElse( cur, Nil)))
	}
}
object SessionSettings
{
	type SessionSetting = (Setting[_], List[String])
	type SessionMap = Map[ProjectRef, Seq[SessionSetting]]

	def reapply(session: SessionSettings, s: State): State =
		BuiltinCommands.reapply(session, Project.structure(s), s)

	def clearSettings(s: State): State =
		withSettings(s)(session => reapply(session.copy(append = session.append - session.current), s))
	def clearAllSettings(s: State): State =
		withSettings(s)(session => reapply(session.clearExtraSettings, s))

	def withSettings(s: State)(f: SessionSettings => State): State =
	{
		val extracted = Project extract s
		import extracted._
		if(session.append.isEmpty)
		{
			s.log.info("No session settings defined.")
			s
		}
		else
			f(session)
	}

	def pluralize(size: Int, of: String) = size.toString + (if(size == 1) of else (of + "s"))
	def checkSession(newSession: SessionSettings, oldState: State)
	{
		val oldSettings = (oldState get Keys.sessionSettings).toList.flatMap(_.append).flatMap(_._2)
		if(newSession.append.isEmpty && !oldSettings.isEmpty)
			oldState.log.warn("Discarding " + pluralize(oldSettings.size, " session setting") + ".  Use 'session save' to persist session settings.")
	}
	def removeRanges[T](in: Seq[T], ranges: Seq[(Int,Int)]): Seq[T] =
	{
		val asSet = (Set.empty[Int] /: ranges) { case (s, (hi,lo)) => s ++ (hi to lo) }
		in.zipWithIndex.flatMap { case (t, index) => if(asSet(index+1)) Nil else t :: Nil  }
	}
	def removeSettings(s: State, ranges: Seq[(Int,Int)]): State =
		withSettings(s) { session =>
			val current = session.current
			val newAppend = session.append.updated(current, removeRanges(session.append.getOrElse(current, Nil), ranges))
			reapply(session.copy( append = newAppend ), s)
		}
	def saveAllSettings(s: State): State = saveSomeSettings(s)(_ => true)
	def saveSettings(s: State): State =
	{
		val current = Project.session(s).current
		saveSomeSettings(s)( _ == current)
	}
	def saveSomeSettings(s: State)(include: ProjectRef => Boolean): State =
		withSettings(s){session =>
			val newSettings =
				for( (ref, settings) <- session.append if !settings.isEmpty && include(ref) ) yield {
					val (news, olds) = writeSettings(ref, settings.toList, session.original, Project.structure(s))
					(ref -> news, olds)
				}
      val (newAppend, newOriginal) = newSettings.unzip
      val newSession = session.copy(append = newAppend.toMap, original = newOriginal.flatten.toSeq)
			reapply(newSession.copy(original = newSession.mergeSettings, append = Map.empty), s)
		}
	def writeSettings(pref: ProjectRef, settings: List[SessionSetting], original: Seq[Setting[_]], structure: Load.BuildStructure): (Seq[SessionSetting], Seq[Setting[_]]) =
	{
		val project = Project.getProject(pref, structure).getOrElse(error("Invalid project reference " + pref))
		val writeTo: File = BuildPaths.configurationSources(project.base).headOption.getOrElse(new File(project.base, "build.sbt"))
		writeTo.createNewFile()

		val path = writeTo.getAbsolutePath
		val (inFile, other, _) = ((List[Setting[_]](), List[Setting[_]](), Set.empty[ScopedKey[_]]) /: original.reverse) {
			case ((in, oth, keys), s) =>
				s.pos match {
					case RangePosition(`path`, _) if !keys.contains(s.key) => (s::in, oth, keys + s.key)
					case _ => (in, s::oth, keys)
				}
		}

		val (_, oldShifted, replace, lineMap) = ((0, List[Setting[_]](), List[SessionSetting](), Map.empty[Int, (Int, List[String])]) /: inFile) {
			case ((offs, olds, repl, lineMap), s) =>
				val RangePosition(_, r@LineRange(start, end)) = s.pos
				settings find (_._1.key == s.key) match {
					case Some(ss@(ns, newLines)) if !ns.init.dependencies.contains(ns.key) =>
						val shifted = ns withPos RangePosition(path, LineRange(start - offs, start - offs + 1))
						(offs + end - start - newLines.size, shifted::olds, ss::repl, lineMap + (start -> (end, newLines)))
					case _ =>
						val shifted = s withPos RangePosition(path, r shift -offs)
						(offs, shifted::olds, repl, lineMap)
				}
		}
		val newSettings = settings diff replace
		val (tmpLines, _) = ((List[String](), 1) /: IO.readLines(writeTo).zipWithIndex) {
			case ((accLines,  n), (line, m)) if n == m + 1 =>
				lineMap.get(n) match {
					case Some(Pair(end, lines)) =>  (lines reverse_::: accLines, end)
					case None => (line::accLines, n + 1)
				}
			case (res,_) => res
		}
		val exist = tmpLines.reverse
		val adjusted = if(!newSettings.isEmpty && needsTrailingBlank(exist)) exist :+ "" else exist
		val lines = adjusted ++ newSettings.map(_._2).flatten.flatMap(_ :: "" :: Nil)
		IO.writeLines(writeTo, lines)
		val (newWithPos, _) = ((List[SessionSetting](), adjusted.size + 1) /: newSettings) {
			case ((acc, line), (s, newLines)) => 
				val endLine = line + newLines.size
				((s withPos RangePosition(path, LineRange(line, endLine)), newLines)::acc, endLine + 1)
 		}
		(newWithPos.reverse, other ++ oldShifted)
	}
	def needsTrailingBlank(lines: Seq[String]) = !lines.isEmpty && !lines.takeRight(1).exists(_.trim.isEmpty)
	def printAllSettings(s: State): State =
		withSettings(s){ session =>
			for( (ref, settings) <- session.append if !settings.isEmpty) {
				println("In " + Project.display(ref))
				printSettings(settings)
			}
			s
		}
	def printSettings(s: State): State =
		withSettings(s){ session =>
			printSettings(session.append.getOrElse(session.current, Nil))
			s
		}
	def printSettings(settings: Seq[SessionSetting]): Unit =
		for(((_,stringRep), index) <- settings.zipWithIndex)
			println("  " + (index+1) + ". " + stringRep.mkString("\n"))

	def Help = """session <command>

Manipulates session settings, which are temporary settings that do not persist past the current sbt execution (that is, the current session).
Valid commands are:

clear, clear-all

	Removes temporary settings added using 'set' and re-evaluates all settings.
	For 'clear', only the settings defined for the current project are cleared.
	For 'clear-all', all settings in all projects are cleared.

list, list-all

	Prints a numbered list of session settings defined.
	The numbers may be used to remove individual settings or ranges of settings using 'remove'.
	For 'list', only the settings for the current project are printed.
	For 'list-all', all settings in all projets are printed.

remove <range-spec>

	<range-spec> is a comma-separated list of individual numbers or ranges of numbers.
	For example, 'remove 1,3,5-7'.
	The temporary settings at the given indices for the current project are removed and all settings are re-evaluated.
	Use the 'list' command to see a numbered list of settings for the current project.

save, save-all

	Makes the session settings permanent by writing them to a '.sbt' configuration file.
	For 'save', only the current project's settings are saved (the settings for other projects are left alone).
	For 'save-all', the session settings are saved for all projects.
	The session settings defined for a project are appended to the first '.sbt' configuration file in that project.
	If no '.sbt' configuration file exists, the settings are written to 'build.sbt' in the project's base directory."""

	sealed trait SessionCommand
	final class Print(val all: Boolean) extends SessionCommand
	final class Clear(val all: Boolean) extends SessionCommand
	final class Save(val all: Boolean) extends SessionCommand
	final class Remove(val ranges: Seq[(Int,Int)]) extends SessionCommand

	import complete._
	import DefaultParsers._

	lazy val parser =
		token(Space) ~>
		(token("list-all" ^^^ new Print(true)) | token("list" ^^^ new Print(false)) | token("clear" ^^^ new Clear(false)) |
		token("save-all" ^^^ new Save(true)) | token("save" ^^^ new Save(false)) | token("clear-all" ^^^ new Clear(true)) |
		remove)

	lazy val remove = token("remove") ~> token(Space) ~> natSelect.map(ranges => new Remove(ranges))
	def natSelect = rep1sep(token(range, "<range>"), ',')
	def range: Parser[(Int,Int)] = (NatBasic ~ ('-' ~> NatBasic).?).map { case lo ~ hi => (lo, hi getOrElse lo)}

	def command(s: State) = Command.applyEffect(parser){
		case p: Print => if(p.all) printAllSettings(s) else printSettings(s)
		case v: Save => if(v.all) saveAllSettings(s) else saveSettings(s)
		case c: Clear => if(c.all) clearAllSettings(s) else clearSettings(s)
		case r: Remove => removeSettings(s,r.ranges)
	}
}