org.jastadd.JastAddModule.groovy Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jastaddgradle Show documentation
A Gradle build plugin for building JastAdd projects.
There is a newer version: 1.13.3
package org.jastadd

import org.gradle.api.InvalidUserDataException
import org.gradle.api.logging.*

class JastAddModule {
  private static final Logger LOG = Logging.getLogger(JastAddModule.class)

  class Aspect {
    String basedir = "."
    List includes = []
    List excludes = []
    List excludeFroms = []
    def basedir(path) {
      basedir = path
    }
    def include(pattern) {
      include pattern, []
    }
    def include(pattern, prio) {
      includes << [ prio, pattern ]
    }
    def exclude(pattern) {
      excludes << pattern
    }
    def excludeFrom(module, pattern) {
      excludeFroms << [ module, pattern ]
    }
  }

  String basedir = "."
  String name
  String moduleName
  String moduleVariant
  Aspect javaAspect = new Aspect()
  Aspect jastaddAspect = new Aspect()
  Aspect scannerAspect = new Aspect()
  Aspect parserAspect = new Aspect()
  def imports = []
  ModuleLoader loader

  JastAddModule(name) {
    this.name = name
  }

  def imports(name) {
    imports += loader.get(name)
  }

  def "import"(name) {
    imports += loader.get(name)
  }

  def moduleName(version) {
    moduleName = version
  }

  def moduleVariant(version) {
    moduleVariant = version
  }

  def java(clos) {
    clos.delegate = javaAspect
    clos.resolveStrategy = Closure.DELEGATE_ONLY
    clos()
  }

  def jastadd(clos) {
    clos.delegate = jastaddAspect
    clos.resolveStrategy = Closure.DELEGATE_ONLY
    clos()
  }

  def scanner(clos) {
    clos.delegate = scannerAspect
    clos.resolveStrategy = Closure.DELEGATE_ONLY
    clos()
  }

  def parser(clos) {
    clos.delegate = parserAspect
    clos.resolveStrategy = Closure.DELEGATE_ONLY
    clos()
  }

  String moduleName() {
    if (moduleName) return moduleName
    for (JastAddModule imp : imports) {
      String value = imp.moduleName()
      if (value) return value
    }
    null
  }

  String moduleVariant() {
    if (moduleVariant) return moduleVariant
    for (JastAddModule imp : imports) {
      String value = imp.moduleVariant()
      if (value) return value
    }
    null
  }

  /**
   * Check if there is an include pattern that does not match anything.
   */
  void checkEmptyIncludes(project) {
    // TODO(joqvist): should include the line where the include pattern was defined in the warning.
    // I do not know how to do that right now.
    checkEmptyIncludes(project, [] as Set)
  }

  void checkEmptyIncludes(project, visited) {
    if (visited.contains(this)) {
      return
    } else {
      visited << this
    }
    imports.each{ it.checkEmptyIncludes(project, visited) }
    for (component in [ 'jastadd', 'parser', 'scanner' ]) {
      def includes = includes(component)
      if (includes) {
        for (include in includes) {
          File base = componentBasedir(component)
          def files = project.files(project.fileTree(
              dir: base,
              include: include[1]))
          if (files.isEmpty()) {
            LOG.warn("Include pattern does not match anything: \"${include[1]}\"")
          }
        }
      }
    }
  }

  def includes(component) {
    this."${component}Aspect".includes
  }

  def excludes(component) {
    this."${component}Aspect".excludes
  }

  def excludeFroms(component) {
    this."${component}Aspect".excludeFroms
  }

  File componentBasedir(component) {
    new File(basedir, this."${component}Aspect".basedir)
  }

  def gatherExcludes(component, visited) {
    if (visited.contains(this)) {
      return []
    } else {
      visited << this
    }
    def excludes = excludeFroms(component)
    imports.each{ excludes.addAll(it.gatherExcludes(component, visited)) }
    excludes
  }

  /** All files for the component in this module and all included modules. */
  def files(project, component) {
    def collection =
    findFiles(project, component, gatherExcludes(component, [] as Set), [] as Set)
      .sort{ a, b ->
        def aa = a[0]
        def bb = b[0]
        int la = aa.size()
        int lb = bb.size()
        for (int i = 0; i < la || i < lb; ++i) {
          int av = i < la ? aa[i] : 0
          int bv = i < lb ? bb[i] : 0
          if (av != bv) {
            return av <=> bv
          }
        }
        0
      }.collect{ it[1].collect{ it } }.flatten() as LinkedHashSet
    // TODO(joqvist): generate warning if there were duplicate files?
    return collection
  }

  private def findFiles(project, component, excludeFroms, visited) {
    if (visited.contains(this)) {
      return []
    } else {
      visited << this
    }
    def files = []
    imports.each{ files.addAll(it.findFiles(project, component, excludeFroms, visited)) }
    def includes = includes(component)
    def excludes = excludes(component)
    if (includes) {
      def excludeFromsLocal = excludeFroms.findAll{ it[0] == name }
      def localExcludes = excludes + excludeFromsLocal.collect{ it[1] }
      for (include in includes) {
        File base = componentBasedir(component)
        files << [
          include[0],
          project.files(project.fileTree(
            dir: base,
            include: include[1],
            excludes: localExcludes)
          )
        ]
      }
    }
    files
  }
}