sbt.internal.DslEntry.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of main_2.12 Show documentation
sbt is an interactive build tool
The newest version!
/*
 * sbt
 * Copyright 2023, Scala center
 * Copyright 2011 - 2022, Lightbend, Inc.
 * Copyright 2008 - 2010, Mark Harrah
 * Licensed under Apache License 2.0 (see LICENSE)
 */

package sbt
package internal

import sbt.internal.util.RangePosition

import sbt.librarymanagement.Configuration

import Def._

/** This represents a `Setting` expression configured by the sbt DSL. */
sealed trait DslEntry {

  /** Called by the parser.  Sets the position where this entry was defined in the build.sbt file. */
  def withPos(pos: RangePosition): DslEntry
}
object DslEntry {
  implicit def fromSettingsDef(inc: SettingsDefinition): DslEntry =
    DslSetting(inc)
  implicit def fromSettingsDef(inc: Seq[Setting[_]]): DslEntry =
    DslSetting(inc)

  /** Represents a DSL entry which adds settings to the current project. */
  sealed trait ProjectSettings extends DslEntry {
    def toSettings: Seq[Setting[_]]
  }
  object ProjectSettings {
    def unapply(e: DslEntry): Option[Seq[Setting[_]]] =
      e match {
        case e: ProjectSettings => Some(e.toSettings)
        case _                  => None
      }
  }

  /** Represents a DSL entry which manipulates the current project. */
  sealed trait ProjectManipulation extends DslEntry {
    def toFunction: Project => Project
    // TODO - Should we store this?
    final def withPos(pos: RangePosition): DslEntry = this
  }
  object ProjectManipulation {
    def unapply(e: DslEntry): Option[Project => Project] =
      e match {
        case e: ProjectManipulation => Some(e.toFunction)
        case _                      => None
      }
  }

  /** this represents an actually Setting[_] or Seq[Setting[_]] configured by the sbt DSL. */
  case class DslSetting(settings: SettingsDefinition) extends ProjectSettings {
    def toSettings = settings.settings
    final def withPos(pos: RangePosition): DslEntry =
      DslSetting(settings.settings.map(_.withPos(pos)))
  }

  /** this represents an `enablePlugins()` in the sbt DSL */
  case class DslEnablePlugins(plugins: Seq[AutoPlugin]) extends ProjectManipulation {
    override val toFunction: Project => Project = _.enablePlugins(plugins: _*)
  }

  /** this represents an `disablePlugins()` in the sbt DSL */
  case class DslDisablePlugins(plugins: Seq[AutoPlugin]) extends ProjectManipulation {
    override val toFunction: Project => Project = _.disablePlugins(plugins: _*)
  }

  /** Represents registering an internal dependency for the current project */
  case class DslDependsOn(cs: Seq[ClasspathDep[ProjectReference]]) extends ProjectManipulation {
    override val toFunction: Project => Project = _.dependsOn(cs: _*)
  }

  /** Represents registering a set of configurations with the current project. */
  case class DslConfigs(cs: Seq[Configuration]) extends ProjectManipulation {
    override val toFunction: Project => Project = _.configs(cs: _*)
  }

  /** this represents an `aggregateProjects()` in the sbt DSL */
  case class DslAggregate(refs: Seq[ProjectReference]) extends ProjectManipulation {
    override val toFunction: Project => Project = _.aggregate(refs: _*)
  }
}