/* sbt -- Simple Build Tool * Copyright 2008, 2009, 2010, 2011 Mark Harrah */ package sbt import complete.{DefaultParsers, Parser} import compiler.{CompilerCache,EvalImports} import Types.{const,idFun} import Aggregation.AnyKeys import Project.LoadAction import scala.annotation.tailrec import Path._ import StandardMain._ import java.io.File import java.net.URI /** This class is the entry point for sbt.*/ final class xMain extends xsbti.AppMain { def run(configuration: xsbti.AppConfiguration): xsbti.MainResult = { import BuiltinCommands.{initialize, defaults} import CommandStrings.{BootCommand, DefaultsCommand, InitCommand} MainLoop.runLogged( initialState(configuration, Seq(initialize, defaults), DefaultsCommand :: InitCommand :: BootCommand :: Nil) ) } } final class ScriptMain extends xsbti.AppMain { def run(configuration: xsbti.AppConfiguration): xsbti.MainResult = MainLoop.runLogged( initialState(configuration, BuiltinCommands.ScriptCommands, Script.Name :: Nil) ) } final class ConsoleMain extends xsbti.AppMain { def run(configuration: xsbti.AppConfiguration): xsbti.MainResult = MainLoop.runLogged( initialState(configuration, BuiltinCommands.ConsoleCommands, IvyConsole.Name :: Nil) ) } object StandardMain { /** The common interface to standard output, used for all built-in ConsoleLoggers. */ val console = ConsoleLogger.systemOutOverwrite(ConsoleLogger.overwriteContaining("Resolving ")) def initialState(configuration: xsbti.AppConfiguration, initialDefinitions: Seq[Command], preCommands: Seq[String]): State = { val commands = preCommands ++ configuration.arguments.map(_.trim) State( configuration, initialDefinitions, Set.empty, None, commands, State.newHistory, BuiltinCommands.initialAttributes, initialGlobalLogging, State.Continue ) } def initialGlobalLogging: GlobalLogging = GlobalLogging.initial((pw, glb) => MainLogging.globalDefault(pw,glb,console), File.createTempFile("sbt",".log"), console) } import DefaultParsers._ import CommandStrings._ import BasicCommands._ import CommandUtil._ object BuiltinCommands { def initialAttributes = AttributeMap.empty def ConsoleCommands: Seq[Command] = Seq(ignore, exit, IvyConsole.command, act, nop) def ScriptCommands: Seq[Command] = Seq(ignore, exit, Script.command, act, nop) def DefaultCommands: Seq[Command] = Seq(ignore, help, about, tasks, settingsCommand, loadProject, projects, project, reboot, read, history, set, sessionCommand, inspect, loadProjectImpl, loadFailed, Cross.crossBuild, Cross.switchVersion, setOnFailure, clearOnFailure, ifLast, multi, shell, continuous, eval, alias, append, last, lastGrep, boot, nop, call, exit, act) def DefaultBootCommands: Seq[String] = LoadProject :: (IfLast + " " + Shell) :: Nil def boot = Command.make(BootCommand)(bootParser) def about = Command.command(AboutCommand, aboutBrief, aboutDetailed) { s => s.log.info(aboutString(s)); s } // This parser schedules the default boot commands unless overridden by an alias def bootParser(s: State) = { val orElse = () => DefaultBootCommands ::: s delegateToAlias(BootCommand, success(orElse) )(s) } def sbtName(s: State): String = s.configuration.provider.id.name def sbtVersion(s: State): String = s.configuration.provider.id.version def scalaVersion(s: State): String = s.configuration.provider.scalaProvider.version def aboutProject(s: State): String = if(Project.isProjectLoaded(s)) { val e = Project.extract(s) val current = "The current project is " + Project.display(e.currentRef) + "\n" val sc = aboutScala(s, e) val built = if(sc.isEmpty) "" else "The current project is built against " + sc + "\n" current + built + aboutPlugins(e) } else "No project is currently loaded" def aboutPlugins(e: Extracted): String = { val allPluginNames = e.structure.units.values.flatMap(_.unit.plugins.pluginNames).toSeq.distinct if(allPluginNames.isEmpty) "" else allPluginNames.mkString("Available Plugins: ", ", ", "") } def aboutScala(s: State, e: Extracted): String = { val scalaVersion = e.getOpt(Keys.scalaVersion) val scalaHome = e.getOpt(Keys.scalaHome).flatMap(idFun) val instance = e.getOpt(Keys.scalaInstance.task).flatMap(_ => quiet(e.evalTask(Keys.scalaInstance, s))) (scalaVersion, scalaHome, instance) match { case (sv, Some(home), Some(si)) => "local Scala version " + selectScalaVersion(sv, si) + " at " + home.getAbsolutePath case (_, Some(home), None) => "a local Scala build at " + home.getAbsolutePath case (sv, None, Some(si)) => "Scala " + selectScalaVersion(sv, si) case (Some(sv), None, None) => "Scala " + sv case (None, None, None) => "" } } def aboutString(s: State): String = { val (name, ver, scalaVer, about) = (sbtName(s), sbtVersion(s), scalaVersion(s), aboutProject(s)) """This is %s %s |%s |%s, %s plugins, and build definitions are using Scala %s |""".stripMargin.format(name, ver, about, name, name, scalaVer) } private[this] def selectScalaVersion(sv: Option[String], si: ScalaInstance): String = sv match { case Some(si.version) => si.version; case _ => si.actualVersion } private[this] def quiet[T](t: => T): Option[T] = try { Some(t) } catch { case e: Exception => None } def settingsCommand = showSettingLike(SettingsCommand, settingsPreamble, KeyRanks.MainSettingCutoff, key => !isTask(key.manifest) ) def tasks = showSettingLike(TasksCommand, tasksPreamble, KeyRanks.MainTaskCutoff, key => isTask(key.manifest) ) def showSettingLike(command: String, preamble: String, cutoff: Int, keep: AttributeKey[_] => Boolean) = Command(command, settingsBrief(command), settingsDetailed(command))(showSettingParser(keep)) { case (s: State, (verbosity: Int, selected: Option[String])) => if(selected.isEmpty) System.out.println(preamble) val prominentOnly = verbosity <= 1 val verboseFilter = if(prominentOnly) highPass(cutoff) else topNRanked(25*verbosity) System.out.println(tasksHelp(s, keys => verboseFilter(keys filter keep), selected )) System.out.println() if(prominentOnly) System.out.println(moreAvailableMessage(command, selected.isDefined)) s } def showSettingParser(keepKeys: AttributeKey[_] => Boolean)(s: State): Parser[(Int, Option[String])] = verbosityParser ~ selectedParser(s, keepKeys).? def selectedParser(s: State, keepKeys: AttributeKey[_] => Boolean): Parser[String] = singleArgument( allTaskAndSettingKeys(s).filter(keepKeys).map(_.label).toSet ) def verbosityParser: Parser[Int] = success(1) | ((Space ~ "-") ~> ( 'v'.id.+.map(_.size + 1) | ("V" ^^^ Int.MaxValue) ) ) def taskDetail(keys: Seq[AttributeKey[_]]): Seq[(String,String)] = sortByLabel(withDescription(keys)) flatMap taskStrings def allTaskAndSettingKeys(s: State): Seq[AttributeKey[_]] = { val extracted = Project.extract(s) import extracted._ val index = structure.index index.keyIndex.keys(Some(currentRef)).toSeq map index.keyMap } def sortByLabel(keys: Seq[AttributeKey[_]]): Seq[AttributeKey[_]] = keys.sortBy(_.label) def sortByRank(keys: Seq[AttributeKey[_]]): Seq[AttributeKey[_]] = keys.sortBy(_.rank) def withDescription(keys: Seq[AttributeKey[_]]): Seq[AttributeKey[_]] = keys.filter(_.description.isDefined) def isTask(mf: Manifest[_])(implicit taskMF: Manifest[Task[_]], inputMF: Manifest[InputTask[_]]): Boolean = mf.erasure == taskMF.erasure || mf.erasure == inputMF.erasure def topNRanked(n: Int) = (keys: Seq[AttributeKey[_]]) => sortByRank(keys).take(n) def highPass(rankCutoff: Int) = (keys: Seq[AttributeKey[_]]) => sortByRank(keys).takeWhile(_.rank <= rankCutoff) def tasksHelp(s: State, filter: Seq[AttributeKey[_]] => Seq[AttributeKey[_]], arg: Option[String]): String = { val commandAndDescription = taskDetail(filter(allTaskAndSettingKeys(s))) arg match { case Some(selected) =>detail(selected, commandAndDescription.toMap) case None => aligned(" ", " ", commandAndDescription) mkString("\n", "\n", "") } } def taskStrings(key: AttributeKey[_]): Option[(String, String)] = key.description map { d => (key.label, d) } def defaults = Command.command(DefaultsCommand) { s => s ++ DefaultCommands } def initialize = Command.command(InitCommand) { s => /*"load-commands -base ~/.sbt/commands" :: */readLines( readable( sbtRCs(s) ) ) ::: s } def eval = Command.single(EvalCommand, Help.more(EvalCommand, evalDetailed)) { (s, arg) => val extracted = Project extract s import extracted._ val result = session.currentEval().eval(arg, srcName = "", imports = autoImports(extracted)) s.log.info("ans: " + result.tpe + " = " + result.getValue(currentLoader)) s } def sessionCommand = Command.make(SessionCommand, sessionBrief, SessionSettings.Help)(SessionSettings.command) def reapply(newSession: SessionSettings, structure: Load.BuildStructure, s: State): State = { s.log.info("Reapplying settings...") val newStructure = Load.reapply(newSession.mergeSettings, structure)( Project.showContextKey(newSession, structure) ) Project.setProject(newSession, newStructure, s) } def set = Command(SetCommand, setBrief, setDetailed)(setParser) { case (s, (all, arg)) => val extracted = Project extract s import extracted._ val settings = EvaluateConfigurations.evaluateSetting(session.currentEval(), "", imports(extracted), arg, LineRange(0,0))(currentLoader) val setResult = if(all) SettingCompletions.setAll(extracted, settings) else SettingCompletions.setThis(s, extracted, settings, arg) s.log.info(setResult.quietSummary) s.log.debug(setResult.verboseSummary) reapply(setResult.session, structure, s) } // @deprecated("Use SettingCompletions.setThis", "0.13.0") def setThis(s: State, extracted: Extracted, settings: Seq[Project.Setting[_]], arg: String) = SettingCompletions.setThis(s, extracted, settings, arg) def inspect = Command(InspectCommand, inspectBrief, inspectDetailed)(inspectParser) { case (s, (option, sk)) => s.log.info(inspectOutput(s, option, sk)) s } def inspectOutput(s: State, option: InspectOption, sk: Project.ScopedKey[_]): String = { val extracted = Project.extract(s) import extracted._ option match { case InspectOption.Details(actual) => Project.details(structure, actual, sk.scope, sk.key) case InspectOption.DependencyTree => val basedir = new File(Project.session(s).current.build) Project.settingGraph(structure, basedir, sk).dependsAscii case InspectOption.Uses => Project.showUses(Project.usedBy(structure, true, sk.key)) case InspectOption.Definitions => Project.showDefinitions(sk.key, Project.definitions(structure, true, sk.key)) } } def lastGrep = Command(LastGrepCommand, lastGrepBrief, lastGrepDetailed)(lastGrepParser) { case (s, (pattern,Some(sks))) => val (str, ref, display) = extractLast(s) Output.lastGrep(sks, str.streams(s), pattern, printLast(s))(display) keepLastLog(s) case (s, (pattern, None)) => for(logFile <- lastLogFile(s)) yield Output.lastGrep(logFile, pattern, printLast(s)) keepLastLog(s) } def extractLast(s: State) = { val ext = Project.extract(s) (ext.structure, Select(ext.currentRef), ext.showKey) } def setParser = (s: State) => { val extracted = Project.extract(s) import extracted._ token(Space ~> flag("every" ~ Space)) ~ SettingCompletions.settingParser(structure.data, structure.index.keyMap, currentProject ) } import InspectOption._ def inspectParser = (s: State) => spacedInspectOptionParser(s) flatMap { case opt @ (Uses | Definitions) => allKeyParser(s).map(key => (opt, Project.ScopedKey(Global, key))) case opt @ (DependencyTree | Details(_)) => spacedKeyParser(s).map(key => (opt, key)) } val spacedInspectOptionParser: (State => Parser[InspectOption]) = (s: State) => { val actual = "actual" ^^^ Details(true) val tree = "tree" ^^^ DependencyTree val uses = "uses" ^^^ Uses val definitions = "definitions" ^^^ Definitions token(Space ~> (tree | actual | uses | definitions)) ?? Details(false) } def allKeyParser(s: State): Parser[AttributeKey[_]] = { val keyMap = Project.structure(s).index.keyMap token(Space ~> (ID !!! "Expected key" examples keyMap.keySet)) flatMap { key => Act.getKey(keyMap, key, idFun) } } val spacedKeyParser = (s: State) => Act.requireSession(s, token(Space) ~> Act.scopedKeyParser(s)) val spacedAggregatedParser = (s: State) => Act.requireSession(s, token(Space) ~> Act.aggregatedKeyParser(s)) val aggregatedKeyValueParser: State => Parser[Option[AnyKeys]] = (s: State) => spacedAggregatedParser(s).map(x => Act.keyValues(s)(x) ).? def lastGrepParser(s: State) = Act.requireSession(s, (token(Space) ~> token(NotSpace, "")) ~ aggregatedKeyValueParser(s)) def last = Command(LastCommand, lastBrief, lastDetailed)(aggregatedKeyValueParser) { case (s,Some(sks)) => val (str, ref, display) = extractLast(s) Output.last(sks, str.streams(s), printLast(s))(display) keepLastLog(s) case (s, None) => for(logFile <- lastLogFile(s)) yield Output.last( logFile, printLast(s) ) keepLastLog(s) } /** Determines the log file that last* commands should operate on. See also isLastOnly. */ def lastLogFile(s: State) = { val backing = s.globalLogging.backing if(isLastOnly(s)) backing.last else Some(backing.file) } /** If false, shift the current log file to be the log file that 'last' will operate on. * If true, keep the previous log file as the one 'last' operates on because there is nothing useful in the current one.*/ def keepLastLog(s: State): State = if(isLastOnly(s)) s.keepLastLog else s /** The last* commands need to determine whether to read from the current log file or the previous log file * and whether to keep the previous log file or not. This is selected based on whether the previous command * was 'shell', which meant that the user directly entered the 'last' command. If it wasn't directly entered, * the last* commands operate on any output since the last 'shell' command and do shift the log file. * Otherwise, the output since the previous 'shell' command is used and the log file is not shifted.*/ def isLastOnly(s: State): Boolean = s.history.previous.forall(_ == Shell) def printLast(s: State): Seq[String] => Unit = _ foreach println def autoImports(extracted: Extracted): EvalImports = new EvalImports(imports(extracted), "") def imports(extracted: Extracted): Seq[(String,Int)] = { val curi = extracted.currentRef.build extracted.structure.units(curi).imports.map(s => (s, -1)) } def listBuild(uri: URI, build: Load.LoadedBuildUnit, current: Boolean, currentID: String, log: Logger) = { log.info("In " + uri) def prefix(id: String) = if(currentID != id) " " else if(current) " * " else "(*)" for(id <- build.defined.keys.toSeq.sorted) log.info("\t" + prefix(id) + id) } def act = Command.customHelp(Act.actParser, actHelp) def actHelp = (s: State) => CommandStrings.showHelp ++ keysHelp(s) def keysHelp(s: State): Help = if(Project.isProjectLoaded(s)) Help.detailOnly(taskDetail(allTaskAndSettingKeys(s))) else Help.empty def projects = Command(ProjectsCommand, (ProjectsCommand, projectsBrief), projectsDetailed )(s => projectsParser(s).?) { case (s, Some(modifyBuilds)) => transformExtraBuilds(s, modifyBuilds) case (s, None) => showProjects(s); s } def showProjects(s: State) { val extracted = Project extract s import extracted._ import currentRef.{build => curi, project => cid} listBuild(curi, structure.units(curi), true, cid, s.log) for( (uri, build) <- structure.units if curi != uri) listBuild(uri, build, false, cid, s.log) } def transformExtraBuilds(s: State, f: List[URI] => List[URI]): State = { val original = Project.extraBuilds(s) val extraUpdated = Project.updateExtraBuilds(s, f) try doLoadProject(extraUpdated, LoadAction.Current) catch { case e: Exception => s.log.error("Project loading failed: reverting to previous state.") Project.setExtraBuilds(s, original) } } def projectsParser(s: State): Parser[List[URI] => List[URI]] = { val addBase = token(Space ~> "add") ~> token(Space ~> basicUri, "").+ val removeBase = token(Space ~> "remove") ~> token(Space ~> Uri(Project.extraBuilds(s).toSet) ).+ addBase.map(toAdd => (xs: List[URI]) => (toAdd.toList ::: xs).removeDuplicates) | removeBase.map(toRemove => (xs: List[URI]) => xs.filterNot(toRemove.toSet)) } def project = Command.make(ProjectCommand, projectBrief, projectDetailed)(ProjectNavigation.command) def loadFailed = Command.command(LoadFailed)(handleLoadFailed) @tailrec def handleLoadFailed(s: State): State = { val result = (SimpleReader.readLine("Project loading failed: (r)etry, (q)uit, (l)ast, or (i)gnore? ") getOrElse Quit).toLowerCase def matches(s: String) = !result.isEmpty && (s startsWith result) if(result.isEmpty || matches("retry")) LoadProject :: s.clearGlobalLog else if(matches(Quit)) s.exit(ok = false) else if(matches("ignore")) { val hadPrevious = Project.isProjectLoaded(s) s.log.warn("Ignoring load failure: " + (if(hadPrevious) "using previously loaded project." else "no project loaded.")) s } else if(matches("last")) LastCommand :: LoadFailed :: s else { println("Invalid response.") handleLoadFailed(s) } } def loadProjectCommands(arg: String) = (OnFailure + " " + LoadFailed) :: (LoadProjectImpl + " " + arg).trim :: ClearOnFailure :: FailureWall :: Nil def loadProject = Command(LoadProject, LoadProjectBrief, LoadProjectDetailed)(_ => matched(Project.loadActionParser)) { (s,arg) => loadProjectCommands(arg) ::: s } def loadProjectImpl = Command(LoadProjectImpl)(_ => Project.loadActionParser)( doLoadProject ) def doLoadProject(s0: State, action: LoadAction.Value): State = { val (s1, base) = Project.loadAction(SessionVar.clear(s0), action) IO.createDirectory(base) val s = if(s1 has Keys.stateCompilerCache) s1 else registerCompilerCache(s1) val (eval, structure) = Load.defaultLoad(s, base, s.log, Project.inPluginProject(s), Project.extraBuilds(s)) val session = Load.initialSession(structure, eval, s0) SessionSettings.checkSession(session, s) Project.setProject(session, structure, s) } def registerCompilerCache(s: State): State = { val maxCompilers = System.getProperty("sbt.resident.limit") val cache = if(maxCompilers == null) CompilerCache.fresh else { val num = try maxCompilers.toInt catch { case e: NumberFormatException => throw new RuntimeException("Resident compiler limit must be an integer.", e) } if(num <= 0) CompilerCache.fresh else CompilerCache(num) } s.put(Keys.stateCompilerCache, cache) } }