org.scalactic.source.Position.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scalactic_0.27
scalacticDotty
The newest version!
/*
 * Copyright 2001-2013 Artima, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.scalactic.source

import scala.quoted._

/**
 * A source file position consisting of a simple source file name, the
 * full path to the file, and a line number.
 *
 * 
 * Class Position is used by ScalaTest assertions, matchers,
 * and testing styles to provide locations for failures in test results.
 * 
 *
 * 
 * The pathFilename should always end with the fileName, which
 * is the simple file name. For example, if the filePathname were "/Users/this/is/a/class/Act.scala",
 * the fileName would be "Act.scala".
 * 

 *
 * 
 * Note: Class Position is in part inspired by the sourcecode library designed by Li Haoyi.
 * 
 *
 * @param fileName the simple name of a source file
 * @param filePathname the fully qualified pathname of the source file
 * @param lineNumber a line number inside the source file with the given filePathname and fileNamae
 */
case class Position(fileName: String, filePathname: String, lineNumber: Int)

/**
 * Companion object for Position that defines an implicit
 * method that uses a macro to grab the enclosing position.
 */
object Position {

  import org.scalactic.Resources

  /**
   * Implicit method, implemented with a macro, that returns the enclosing
   * source position where it is invoked.
   *
   * @return the enclosing source position
   */
  implicit inline def here: Position = ${ genPosition }

  private[scalactic] lazy val showScalacticFillFilePathnames: Boolean = {
    val value = System.getenv("SCALACTIC_FILL_FILE_PATHNAMES")
    value != null && value == "yes"
  }

  /**
   * Helper method for Position macro.
   */
  private def genPosition(implicit qctx: QuoteContext): Expr[Position] = {
    import qctx.tasty.rootPosition

    val pos = rootPosition
    val file = pos.sourceFile
    val fileName: String = file.jpath.getFileName.toString
    val filePath: String = if (showScalacticFillFilePathnames) file.toString else Resources.pleaseDefineScalacticFillFilePathnameEnvVar
    // Need check `pos.exists` here because https://github.com/lampepfl/dotty/issues/8581
    val lineNo: Int = if (pos.exists) pos.startLine else -1
    '{ Position(${Expr(fileName)}, ${Expr(filePath)}, ${Expr(lineNo)}) }
  }

}