TreeDL: язык описания структуры деревьев

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

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

Декларативная информация задается в виде набора именованных свойств:

Имя свойства qid - квалифицированный идентификатор. Значение - булевская величина <BOOL_LITERAL>, целое число <INT_LITERAL> или строка <STRING_LITERAL>.

Пример:

[
  treedl.language = "java";
  has.key = true;
  max.length = 8;
]

Заданы три свойства, имеющие, соответственно, строковое, булевское и целое значения.

Для каждой сущности в описании структуры дерева возможно задать документационный комментарий. Документационные комментарии доступны инструменту обработки описания дерева. Формат документационного комментария зависит от целевого языка трансляции и используемого инструмента обработки. Например, при трансляции в язык программирования Java документационные комментарии в формате javadoc могут быть просто перенесены в исходный текст сгенерированных классов для последующей обработки инструментом javadoc.

Документационные комментарии <DOCOMMENT> могут быть расположены только в определенных синтаксической грамматикой языка TreeDL местах. Лексическая структура документационных комментариев описана в Приложение 1, Лексическая грамматика.

Пример:

/**
 * Documentation comment
 */

Язык TreeDL позволяет определять типы вершин и перечислимые типы. Тип имеет имя <type:ID>, которое необходимо указывать при использовании. Если тип используется не в том модуле, в котором определен, имя следует уточнять синонимом имени модуля <module:ID>, в котором определен тип.

Расширенным именем типа будем называть имя типа <type:ID> при необходимости уточнённое синонимом имени модуля <module:ID>.

Используемый тип может определяться следующим образом:

Тип может быть определен как:

с модификатором, определяющим количество элементов типа:

Пример:

Модули бывают двух типов - модули описания структуры и модули операций.

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

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

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

Пример:

tree com.unitesk.atp.treedl.TDL;

...

Модуль описания структуры дерева с именем com.unitesk.atp.treedl.TDL.

module com.unitesk.atp.treedl.Checker;

...

Модуль операций com.unitesk.atp.treedl.Checker.

Модуль может использовать типы, определенные в других модулях. Для этого необходимо указать полные имена используемых модулей.

При использовании типа, определённого в используемом модуле, имя типа необходимо уточнить синонимом имени модуля. По умолчанию синонимом имени модуля является самый правый идентификатор его полного имени. При наличии конфликтов или по другим причинам синоним имени модуля может быть введён явно с помощью <synonym:ID>. Полное имя определяемого модуля также вводит синоним. Областью видимости синонимов является модуль, в заголовке которого они определены.

Пример:

module com.unitesk.atp.treedl.Checker : TreeDL = com.unitesk.atp.treedl.TDL;

...

Модуль операций com.unitesk.atp.treedl.Checker использует модуль описания структуры com.unitesk.atp.treedl.TDL определяя для него синоним TreeDL.

Результат трансляции модуля в язык программирования может быть модифицирован с помощью пользовательского кода. Существует возможность указать базовые типы <TYPE>, вставить код <CODE> из конструкции header в начало и код из конструкции body внутрь результата трансляции. Подробно обработка этих конструкций описана в схеме трансляции для конкретного языка программирования.

Пример:

[ treedl.language = "java"; ]
module com.unitesk.atp.treedl.TDL;

header
{
    import java.util.Map;
}

body
{
    public static Map getTypes() { ... }
}

Код конструкций header и body вставлен в результат трансляции модуля в язык программирования:

package com.unitesk.atp.treedl;

// header code
import java.util.Map;

public class TDL
{
    // body code
    public static Map getTypes() { ... }

    ...
}

Имя типа вершины - это идентификатор <name:ID>, по которому можно ссылаться на тип вершины из любого определения типа вершины или операции в том же модуле.

При использовании типа из других модулей необходимо использовать расширенное имя типа.

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

Если тип вершины помечен модификатором root, то он и его наследники допустимы в качестве типа корневой вершины дерева.

Пример:

abstract node Statement { ... }

Абстрактный базовый тип вершин Statement.

root node CompilationUnit { ... }

Корневая вершина дерева.

Тип вершины может быть определён на основе другого - базового типа вершины. Если указано расширенное имя type_ref базового типа вершины, то все члены этого типа наследуются и могут быть использованы в определяемом типе вершины. По умолчанию тип вершины наследует абстрактный базовый тип всех вершин Node:

abstract node Node
{
    attribute late Node? parent;
}

Этот тип вершин определяет атрибут parent, который содержит ссылку на родительскую вершину или null, если вершина корневая.

Пример:

node IfStatement : Statement { ... }

Тип вершин IfStatement, унаследованный от Statement.

Результат трансляции типа вершины в язык программирования может быть модифицирован с помощью пользовательского кода. Существует возможность указать базовые типы <TYPE> типа вершины. Подробно обработка этой конструкции описана в схеме трансляции для конкретного языка программирования.

Кроме того, в результат трансляции типа вершины может быть добавлен код членов типа вершин constructor и body.

Существуют следующие виды членов типа вершин:

attribute string fullName;

attribute custom string name
get
{
    name = fullName.substring( fullName.lastIndexOf( '.' ) + 1 );
}
set { ... };

abstract node NamedNode
{
    abstract attribute string name;
}

node DefaultNamedNode : NamedNode
{
    attribute string name;
}

node CustomNamedNode : NamedNode
{
    attribute custom string name
    get { ... }
    set { ... };
}

node BaseNode
{
    attribute late int+ intList;
}

node MyNode : BaseNode
{
    attribute override int+ intList
    set { ... };
}

node IfStatement : Statement
{
    child Expression condition;
    child Statement thenStatement;
    child Statement elseStatement;
}

node TryStatement
{
    child Block block;
    child CatchClause* optCatchClauseList;
    child Block? optFinallyBlock;

    constructor
    {
        if( sizeOptCatchClauseList() == 0 && getOptFinallyBlock() == null )
        {
            throw new IllegalArgumentException("There is neither catch clause nor finally block");
        }
    }
}

Имя перечислимого типа - это идентификатор <name:ID>, по которому можно ссылаться на тип из любого определения типа в том же модуле.

При использовании типа из других модулей необходимо использовать расширенное имя типа.

Множество значений перечислимого типа определяется явно заданными константами. Множество этих констант является объединением множества констант для базового перечислимого типа type_ref, если он задан, и множества констант <const:ID>.

Существуют два вида перечислимых типов: перечисление и набор флагов. Вид перечислимого типа указывается ключевым словом enum и flags соответственно. Множество значений перечисления совпадает с набором констант. Множество значений набора флагов - это множество всех подмножеств набора констант.

Пример:

enum Color { RED, GREEN, BLUE }

Множество значений перечисления Color состоит из трех значений: RED, GREEN, BLUE.

enum ExtendedColor : Color { WHITE, BLACK }

Множество значений перечисления ExtendedColor состоит из пяти значений: трех значений базового перечислимого типа Color и двух дополнительно заданных WHITE и BLACK.

flags Modifiers { ABSTRACT, CUSTOM, LATE, OVERRIDE, NOSET, SETONCE }

Множество значений набора флагов Modifiers состоит из 64 комбинаций 6 флагов.

Сигнатура операции определяет:

Формальный параметр операции имеет имя и тип. Параметр перечислимого типа или типа вершина может быть помечен модификатором virtual. Виртуальные параметры операции определяют набор ветвей операции.

Ветвь операции case_signature

состоит из:

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

Для каждой комбинации вариантов виртуальных параметров должна быть определена ровно одна ветвь операции. При выполнении операции будет исполнен код <CODE>, относящийся к ветви операции, которой соответствует набор фактических параметров. Ветвь операции может быть определена либо в теле операции, либо в одной из унаследованных операций.

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

Пример:

tree P;

node A {}

tree Q : P;

abstract node X {}

node B {}

operation string F( virtual Node n )
{
    case( P.A n ): { return "A"; }
    case( B   n ): { return "B"; }
}

Операция F определена на всех типах вершин, определенных в модуле Q и используемым им модуле P. Для каждого неабстрактного типа вершин определена ветвь операции.

tree R : Q;

node C {}

operation string G( virtual Node n )
  : Q.F
{
    case ( C node ): { return "C"; }
}

Операция G определена на всех типах вершин, определенных в модуле R и используемых им модулях P и Q. Для типов вершин из модулей P и Q используется операция Q.F. Поэтому ветви операции определены только для типов вершин, определенных в модуле R.

Если существует ещё один модуль S, также использующий модуль P, и операция H, определенная на этих модулях:

tree S : P;

node D {}

operation string H( virtual Node n )
{
    case( P.A n ): { return "P.A"; }
    case( D   n ): { return "S.D"; }
}

То при попытке расширить определение операции R.G на модуль S с использованием операции H:

tree R : Q, S;

operation string G( virtual Node n )
 : Q.F, S.H
{
    case ( C node ): { return "C"; }
}

возникнет конфликт, поскольку операции Q.F и S.H используют разные ветви операции для типа P.A: результатом операции Q.F является "A", а результатом операции S.H - "P.A". Для его разрешения необходимо либо отказаться от использования одной из операции и определить её ветви заново, либо вынести реализацию операции для модуля P в отдельную операцию и использовать её обеими операциями:

tree P;

node A {}

operation string E( virtual Node n )
{
    case( A n ): { return "P.A"; }
}

tree Q : P;

abstract node X {}

node B {}

operation string F( virtual Node n ) : P.E
{
    case( B n ): { return "B"; }
}

tree S : P;

node D {}

operation string H( virtual Node n ) : P.E
{
    case( D n ): { return "S.D"; }
}

tree R : Q, S;

operation string G( virtual Node n )
 : Q.F, S.H
{
    case ( C node ): { return "C"; }
}

Такое определение операции R.G корректно, потому что обе используемые операции на модуле P используют реализацию операции P.E.