/
Position.scala
59 lines (54 loc) · 2.14 KB
/
Position.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
/*
* 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
/**
* A source file position consisting of a simple source file name, the
* full path to the file, and a line number.
*
* <p>
* Class <code>Position</code> is used by ScalaTest assertions, matchers,
* and testing styles to provide locations for failures in test results.
* </p>
*
* <p>
* The <code>pathFilename<code> should always end with the <code>fileName</code>, which
* is the simple file name. For example, if the <code>filePathname</code> were <code>"/Users/this/is/a/class/Act.scala"</code>,
* the <code>fileName</code> would be <code>"Act.scala"</code>.
* </p>
*
* <p>
* <em>Note: Class <code>Position</code> is in part inspired by the <a href="https://github.com/lihaoyi/sourcecode" target="_blank"><code>sourcecode</code></a> library designed by Li Haoyi.</a></em>
* </p>
*
* @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 <code>Position</code> that defines an implicit
* method that uses a macro to grab the enclosing position.
*/
object Position {
import scala.language.experimental.macros
/**
* Implicit method, implemented with a macro, that returns the enclosing
* source position where it is invoked.
*
* @return the enclosing source position
*/
implicit def here: Position = macro PositionMacro.genPosition
}