Трейт scala.reflect.macros.whitebox.Context

Укороченная запись для создания выражения.

В отличие от стандартного фабричного метода выражений, который требует scala.reflect.api.TreeCreator, этот принимает обычное дерево, но полученные выражения не могут быть перенесены в другие вселенные/зеркала (функциональность, обычно не требуемая для макросов, поскольку существует только одна вселенная во время компиляции и только одно зеркало во время компиляции).

Указывает, что аргумент для c.typecheck должен быть проверен как шаблон.

Указывает, что аргумент для c.typecheck должен быть проверен как терм. Это режим проверки по умолчанию в Scala 2.11 и единственный поддерживаемый режим в Scala 2.10.

Указывает, что аргумент для c.typecheck должен быть проверен как тип.

Укороченная запись для создания тега типа.

В отличие от стандартного фабричного метода тегов типа, который требует scala.reflect.api.TypeCreator, этот принимает обычный тип, но полученные теги типа не могут быть перенесены в другие вселенные/зеркала (функциональность, обычно не требуемая для макросов, поскольку существует только одна вселенная во время компиляции и только одно зеркало во время компиляции).

Укороченная запись для создания слабого тега типа.

В отличие от стандартного фабричного метода тегов типа, который требует scala.reflect.api.TypeCreator, этот принимает обычный тип, но полученные теги типа не могут быть перенесены в другие вселенные/зеркала (функциональность, обычно не требуемая для макросов, поскольку существует только одна вселенная во время компиляции и только одно зеркало во время компиляции).

Прерывает текущее расширение макроса, оставляя заметку о произошедшем. Используйте enclosingPosition, если вы не уверены, какую позицию передать в pos.

Предоставляет текущую классовую дорожку.

Предоставляет текущие настройки компилятора в виде списка параметров. Используйте scalac -help, scalac -X и scalac -Y, чтобы узнать о поддерживаемых параметрах.

Для отправки сообщения, которое не должно быть помечено как предупреждение/ошибка, но также не должно требовать -verbose, чтобы быть видимым. Используйте enclosingPosition, если вы не уверены, какую позицию передать в pos.

Информация об одном из рассматриваемых в настоящее время неявных кандидатов. Кандидаты используются во множественном числе, потому что неявные параметры могут сами иметь неявные параметры, поэтому неявные поиски могут рекурсивно запускать другие неявные поиски.

Может быть полезно получить информацию о приложении с неявным параметром, который материализуется во время текущей макрорасшивки. Если мы находимся в разворачиваемой неявной макросе, она включается в этот список.

В отличие от openImplicits, это значение, что означает, что оно инициализируется при создании контекста и всегда остается неизменным независимо от того, что происходит во время макрорасшивки.

Контексты, представляющие макросы в процессе выполнения, включая текущий. Очень похоже на стек вызовов, но только для макросов. Может быть полезно для взаимодействия с другими макросами и для наложения компилятору дружественных ограничений на макрорасшивку.

Также бесценно для выдачи осмысленных сообщений об ошибках для макросов, которые вызываются другими макросами на синтетических (т.е. не имеющих позиции) деревьях. В таком случае просмотрите стек enclosingMacros, и он, скорее всего, будет содержать по крайней мере один макрос с позиционно-полным применением макроса. См. enclosingPosition для реализации по умолчанию этой логики.

В отличие от openMacros, это значение, что означает, что оно инициализируется при создании контекста и всегда остается неизменным независимо от того, что происходит во время макрорасшивки.

Попытка угадать позицию для окружающего применения. Но это просто, не так ли? Просто разыменовать pos от macroApplication? Не совсем. Если мы находимся в синтетической макрорасшивки (нет позиций), мы должны сделать все возможное, чтобы вывести положение того, что спровоцировало это расширение. Удивительно, но часто мы можем сделать это, просматривая стек enclosingMacros.

Выводит ошибку компиляции. Используйте enclosingPosition, если вы сомневаетесь, какую позицию передать в pos.

Принимает типизированную оболочку для дерева типа T и вычисляет его в значение типа T.

Может использоваться для выполнения вычислений во время компиляции над аргументами макроса в той степени, в которой это разрешено формой аргументов.

Известные проблемы: из-за https://github.com/scala/bug/issues/5748 деревья, которые сначала вычисляются, должны пройти untypecheck. Перезагрузка символов и типов изменяет дерево на месте, поэтому общепринятым подходом является duplicate дерева сначала.

scala> def impl(c: Context)(x: c.Expr[String]) = {
     | val x1 = c.Expr[String](c.untypecheck(x.tree.duplicate))
     | println(s"compile-time value is: ${c.eval(x1)}")
     | x
     | }
impl: (c: Context)(x: c.Expr[String])c.Expr[String]

scala> def test(x: String) = macro impl
test: (x: String)String

scala> test("x")
compile-time value is: x
res0: String = x

scala> test("x" + "y")
compile-time value is: xy
res1: String = xy

scala> val x = "x"
x: String = x

scala> test(x + "y")
compile-time value is: xy
res2: String = xy

scala> { val x = "x"; test(x + "y") }
error: exception during macro expansion:
scala.tools.reflect.ToolBoxError: reflective compilation failed

Обратите внимание, что в последнем случае вычисление не удалось, потому что аргумент макроса ссылается на значение времени выполнения x, которое неизвестно во время компиляции.

Создаёт имя, которое более или менее уникально, имеющее заданное имя в качестве префикса и имеющее тот же тип (имя термина или имя типа) что и заданное имя. Обратитесь к scala.reflect.macros.Names для получения дополнительной информации об уникальности таких имён.

Создаёт строку, представляющую более или менее уникальное имя, имеющее заданный префикс. Обратитесь к scala.reflect.macros.Names для получения дополнительной информации об уникальности таких имён.

Создаёт строку, представляющую более или менее уникальное имя. Обратитесь к scala.reflect.macros.Names для получения дополнительной информации об уникальности таких имён.

Есть ли ошибки в сеансе компиляции?

Есть ли предупреждения в сеансе компиляции?

Выводит неявное значение ожидаемого типа pt в контексте вызова макроса. Необязательный параметр pos предоставляет позицию, которая будет связана с неявным поиском.

Если silent ложно, TypecheckException будет брошено в случае ошибки вывода. Если silent истинно, проверка типов выполняется молча и возвращает EmptyTree в случае ошибки. Такие ошибки не исчезают и могут быть проверены путем включения -Xlog-implicits. В отличие от typecheck, silent по умолчанию истинно.

Выводит неявный вид из предоставленного дерева tree типа from к типу to в контексте вызова макроса. Необязательный параметр pos предоставляет позицию, которая будет связана с неявным поиском.

Если silent ложно, TypecheckException будет брошено в случае ошибки вывода. Если silent истинно, проверка типов выполняется молча и возвращает EmptyTree в случае ошибки. Такие ошибки не исчезают и могут быть проверены путем включения -Xlog-implicits. В отличие от typecheck, silent по умолчанию истинно.

Выводит информационное сообщение, подавляемое, если -verbose или force=true. Используйте enclosingPosition, если вы не уверены, какую позицию передать в pos.

Дерево, которое подвергается макрорасширению. Может быть полезно для получения смещения или позиции диапазона всего дерева, которое обрабатывается.

Зеркало времени компиляции.

Информация об одном из рассматриваемых в настоящее время неявных кандидатов. Кандидаты используются во множественном числе, потому что неявные параметры могут сами иметь неявные параметры, поэтому неявные поиски могут рекурсивно запускать другие неявные поиски.

Может быть полезно для получения информации об применении с неявным параметром, который материализуется во время текущего макрорасширения. Если мы находимся в неявном макросе, который расширяется, он включён в этот список.

В отличие от enclosingImplicits, это def, что означает, что он пересчитывается при каждом вызове, поэтому он может меняться в зависимости от того, что происходит во время макрорасширения.

Контексты, которые представляют макросы в процессе выполнения, включая текущий. Очень похоже на стек вызовов, но только для макросов. Может быть полезно для взаимодействия с другими макросами и для наложения дружественных компилятору ограничений на расширение макросов.

Также бесценно для выдачи осмысленных сообщений об ошибках для макросов, которые вызываются другими макросами по синтетическим (т. е. без позиционных) деревьям. В этом случае просматривайте стек openMacros, и он, скорее всего, будет содержать по крайней мере один макрос с макроприменением с позицией. См. enclosingPosition для реализации по умолчанию этой логики.

В отличие от enclosingMacros, это def, что означает, что он пересчитывается при каждом вызове, поэтому он может меняться в зависимости от того, что происходит во время макрорасширения.

Парсит строку с выражением Scala в абстрактное синтаксическое дерево. Работает только для выражений, т. е. парсинг объявления пакета завершится ошибкой.

Префиксное дерево, из которого выбирается макрос.

Например, для макроса filter, определённого как метод экземпляра коллекции Coll, prefix представляет эквивалент this для обычных методов экземпляров:

scala> class Coll[T] {
     | def filter(p: T => Boolean): Coll[T] = macro M.filter[T]
     | }; object M {
     | def filter[T](c: Context { type PrefixType = Coll[T] })
     |              (p: c.Expr[T => Boolean]): c.Expr[Coll[T]] =
     |   {
     |     println(c.prefix.tree)
     |     c.prefix
     |   }
     | }
defined class Coll
defined module Macros

scala> new Coll[Int]().filter(_ % 2 == 0)
new Coll[Int]()
res0: Coll[Int] = ...

scala> val x = new Coll[String]()
x: Coll[String] = ...

scala> x.filter(_ != "")
$line11.$read.$iw.$iw.$iw.$iw.$iw.$iw.$iw.$iw.$iw.$iw.$iw.$iw.x
res1 @ 35563b4b: x.type = ...

Обратите внимание, как значение prefix меняется в зависимости от квалификатора вызова макроса (т.е. выражения, которое находится слева от точки).

Ещё одним примечательным аспектом фрагмента кода выше является тип Context { type PrefixType = Coll[T] }, используемый для акцентирования того, что реализация макроса работает с префиксами типа Coll[T].

Для заданного типа сгенерировать дерево, которое при компиляции и выполнении производит класс времени выполнения внешнего класса или модуля. Возвращает EmptyTree , если внешний класс или модуль не существуют.

Для заданного типа сгенерировать дерево, которое при компиляции и выполнении производит класс времени выполнения исходного типа. Если concrete равно true, то эта функция будет игнорировать типы, которые ссылаются на абстрактные типы (например, как ClassTag).

Для данного дерева создать дерево, которое при компиляции и выполнении воспроизводит исходное дерево. Для получения дополнительной информации и примеров обратитесь к документации для Universe.reify.

Созданное дерево будет связано с указанным universe и mirror. Возможные значения для universe включают universe.internal.gen.mkRuntimeUniverseRef . Возможные значения для mirror включают EmptyTree (в этом случае реифёр автоматически выберет подходящее зеркало).

Эта функция тесно связана с Universe.reify, макросом, который делает реификацию произвольных выражений в деревья времени выполнения. Они выполняют очень похожие действия (Universe.reify вызывает Context.reifyTree для своей реализации), но работают на разных метауровнях (см. ниже).

Рассмотрим различия между Context.reifyTree и Universe.reify на примере использования их внутри макроса fooMacro.

* Поскольку сам reify является макросом, он будет выполняться во время компиляции fooMacro (метауровень -1) и создаст дерево, которое при оценке во время расширения макроса fooMacro (метауровень 0) восстановит входное дерево.

Это обеспечивает возможность, аналогичную квази-цитированию. Написание "reify{ expr }" сгенерирует AST, представляющий expr. После этого AST (или его части) можно использовать для построения возвращаемого значения fooMacro.

* reifyTree оценивается во время расширения макроса (метауровень 0) и создаст дерево, которое при оценке во время выполнения программы (метауровень 1) восстановит входное дерево.

Это обеспечивает способ сохранения определённых деревьев из времени расширения макроса для последующего анализа во время выполнения. Авторы DSL могут найти это полезным для захвата фрагментов DSL в AST, которые затем обрабатываются во время выполнения специфичным образом.

Также обратите внимание на разницу между вселенными деревьев времени выполнения, созданных двумя функциями reify:

* Результат компиляции и выполнения результата reify будет связан с Вселенной, которая вызвала reify. Это возможно, потому что это макрос, поэтому он может генерировать любой код, который пожелает.

* Результат компиляции и выполнения результата reifyTree будет prefix , который необходимо явно передать. Это происходит потому, что Вселенная оцениваемого результата находится на другом метауровне, чем Контекст, который вызвал reify.

Типичное использование этой функции - сохранение некоторых деревьев, полученных/созданных макросом, в форме, которую можно проанализировать (с помощью сопоставления с образцом) или скомпилировать/выполнить (с помощью рефлективного инструментария Toolbox) во время выполнения.

Для заданного типа сгенерировать дерево, которое при компиляции и выполнении создаст исходный тип. Созданное дерево будет связано с указанными universe и mirror. Для получения дополнительной информации и примеров обратитесь к документации для Context.reifyTree и Universe.reify.

Возвращает список строк, содержащих макро-специфические параметры. Эти параметры передаются компилятору через командную строку в формате "-Xmacro-settings:setting1,setting2...,settingN".

Проверяет предоставленное дерево на соответствие ожидаемому типу pt в контексте вызова макроса в режиме проверки типа, указанном в mode с TERMmode по умолчанию. Это заполняет символы и типы дерева и, возможно, преобразует его для отражения определенных десахарификаций.

Если silent ложно, TypecheckException будет брошено в случае ошибки проверки типа. Если silent истинно, проверка типа выполняется молча и вернет EmptyTree в случае ошибки. Такие ошибки не исчезают и могут быть проверены путем включения -Ymacro-debug-verbose. В отличие от inferImplicitValue и inferImplicitView, silent по умолчанию ложно.

Проверку типа можно настроить с помощью следующих необязательных параметров: withImplicitViewsDisabled рекурсивно запрещает неявные представления (хотя неявные значения все равно будут просматриваться и заполняться), значение по умолчанию — ложь withMacrosDisabled рекурсивно запрещает расширение макросов и неявные параметры на основе макросов, значение по умолчанию — ложь

Временная вселенная.

Отменяет реификацию дерева.

Эта реверсия не просто восстанавливает исходное дерево (при этом теряется контекст реификации), а выполняет более сложную операцию, которая соответствует следующим законам:

1) unreifyTree(reifyTree(tree)) != tree // деревыо после unreify - дерево + сохраненный контекст // в текущей реализации результат unreify является непрозрачным // то есть нет возможности проверить лежащее в основе дерево/контекст

2) reifyTree(unreifyTree(reifyTree(tree))) == reifyTree(tree) // результат реификации дерева в исходном контексте равен // результату реификации дерева вместе с сохраненным контекстом

3) compileAndEval(unreifyTree(reifyTree(tree))) ~ compileAndEval(tree) // во время выполнения исходные и деревы после unreify поведению эквивалентны

В текущей реализации API рефлексии Scala, нетипизированные деревья (также известные как парсерные деревья или деревья без атрибутов) наблюдательно отличаются от типизированных деревьев (также известных как типизированные деревья, деревья, прошедшие проверку типов или деревья с атрибутами),

Обычно, если какой-либо API компилятора принимает дерево, то подойдут как нетипизированные, так и типизированные деревья. Однако в некоторых случаях подходят только нетипизированные или только типизированные деревья. Например, eval принимает только нетипизированные деревья, а вставлять типизированные деревья можно только в типизированные деревья. Поэтому в текущем API рефлексии необходимы функции для перехода между нетипизированными и типизированными деревьями. Для этого у нас есть typecheck и untypecheck.

Обратите внимание, что untypecheck в настоящее время страдает от https://github.com/scala/bug/issues/5464, что иногда приводит к повреждению деревьев, из-за чего они становятся бессмысленными. К сожалению, для этого нет решения. Мы планируем исправить эту проблему в ближайшее время, но пока имейте это в виду.

Выводит предупреждение. Используйте enclosingPosition если вы сомневаетесь в позиции, которую нужно передать в pos.

Дерево, соответствующее окружающему классу, или EmptyTree, если это неприменимо.

Дерево, соответствующее окружающему дереву DefDef. Бросает EnclosureException если такого окружающего дерева нет.

Дерево, соответствующее окружающему дереву ImplDef (т. е. либо ClassDef, либо ModuleDef). Бросает EnclosureException если такого окружающего дерева нет.

Узел дерева, соответствующий окружающему методу, или EmptyTree, если это неприменимо.

Узел дерева, соответствующий окружающему узлу PackageDef. Выбрасывает EnclosureException если нет такого окружающего узла.

Сеанс компиляции, содержащий это макроприложение.

Узел дерева, соответствующий окружающему узлу Template. Выбрасывает EnclosureException если нет такого окружающего узла.

Единица компиляции, содержащая это макроприложение.

Создает более или менее уникальное имя, имеющее заданное имя в качестве префикса и имеющее тот же тип (имя терма или имя типа), что и заданное имя. Обратитесь к scala.reflect.macros.Names для получения дополнительной информации об уникальности таких имен.

Создает строку, представляющую более или менее уникальное имя, имеющее заданный префикс. Обратитесь к scala.reflect.macros.Names для получения дополнительной информации об уникальности таких имен.

Создает строку, представляющую более или менее уникальное имя. Обратитесь к scala.reflect.macros.Names для получения дополнительной информации об уникальности таких имен.

Сокращение для Literal(Constant(x: Char)) в базовом universe.

Сокращенная запись для Literal(Constant(x: String)) в базовом universe.

Сокращенная запись для Literal(Constant(x: Double)) в базовом universe.

Сокращенная запись для Literal(Constant(x: Float)) в базовом universe.

Сокращенная запись для Literal(Constant(x: Long)) в базовом universe.

Сокращенная запись для Literal(Constant(x: Int)) в базовом universe.

Сокращенная запись для Literal(Constant(x: Short)) в базовом universe.

Сокращенная запись для Literal(Constant(x: Byte)) в базовом universe.

Сокращенная запись для Literal(Constant(x: Boolean)) в базовом universe.

Сокращенная запись для Literal(Constant(false)) в базовом universe.

Сокращенная запись для Literal(Constant(null)) в базовом universe.

Сокращённая форма для Literal(Constant(true)) в базовом universe.

Сокращённая форма для Literal(Constant(())) в базовом universe.

Рекурсивно сбрасывает локально определённые символы и типы в заданном дереве. ВНИМАНИЕ: Не используйте этот API, воспользуйтесь untypecheck вместо этого.

Конструктор/экстрактор для Expr.

Конструктор/экстрактор для TypeTag.

Конструктор/экстрактор для WeakTypeTag.

Символ типа x , полученный из тега типа.

Сокращение для implicitly[TypeTag[T]].tpe

Сокращение для implicitly[TypeTag[T]]

Сокращение для implicitly[WeakTypeTag[T]].tpe

Сокращение для implicitly[WeakTypeTag[T]]