com.github._1c_syntax.bsl.parser.description.MethodDescription Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bsl-parser Show documentation
Collection of parsers for Language 1C (BSL) in ANTLR4 format.
The newest version!
/*
 * This file is a part of BSL Parser.
 *
 * Copyright (c) 2018-2024
 * Alexey Sosnoviy , Nikita Fedkin , Sergey Batanov 
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later
 *
 * BSL Parser is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3.0 of the License, or (at your option) any later version.
 *
 * BSL Parser is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with BSL Parser.
 */
package com.github._1c_syntax.bsl.parser.description;

import com.github._1c_syntax.bsl.parser.BSLMethodDescriptionTokenizer;
import com.github._1c_syntax.bsl.parser.description.support.DescriptionReader;
import com.github._1c_syntax.bsl.parser.description.support.ParameterDescription;
import com.github._1c_syntax.bsl.parser.description.support.SimpleRange;
import com.github._1c_syntax.bsl.parser.description.support.TypeDescription;
import org.antlr.v4.runtime.Token;

import java.util.List;
import java.util.stream.Collectors;

import static java.util.Objects.requireNonNull;

/**
 * Класс-описание метода (процедуры или функции).
 */
public final class MethodDescription implements SourceDefinedSymbolDescription {
  /**
   * Содержит полное описание метода (весь текст).
   */
  private final String description;
  /**
   * Содержит часть строки после ключевого слова, в которой должно быть
   * описание причины устаревания метода либо альтернативы.
   */
  private final String deprecationInfo;
  /**
   * Признак устаревания метода.
   */
  private final boolean deprecated;
  /**
   * Описание назначения метода.
   */
  private final String purposeDescription;
  /**
   * Примеры использования метода.
   */
  private final List examples;
  /**
   * Варианты вызова метода.
   */
  private final List callOptions;
  /**
   * Параметры метода с типами и описанием.
   */
  private final List parameters;
  /**
   * Возвращаемые значения (типы).
   */
  private final List returnedValue;
  /**
   * Если описание содержит только ссылку, то здесь будет ее значение.
   * 
   * TODO Временное решение, надо будет продумать в следующем релизе
   */
  private final String link;
  /**
   * Диапазон, в котором располагается описание.
   */
  private final SimpleRange range;

  MethodDescription(List comments) {
    description = comments.stream()
      .map(Token::getText)
      .collect(Collectors.joining("\n"));

    var tokenizer = new BSLMethodDescriptionTokenizer(description);
    var ast = requireNonNull(tokenizer.getAst());

    purposeDescription = DescriptionReader.readPurposeDescription(ast);
    link = DescriptionReader.readLink(ast);
    deprecated = ast.deprecate() != null;
    deprecationInfo = DescriptionReader.readDeprecationInfo(ast);
    callOptions = DescriptionReader.readCallOptions(ast);
    examples = DescriptionReader.readExamples(ast);
    parameters = DescriptionReader.readParameters(ast);
    returnedValue = DescriptionReader.readReturnedValue(ast);
    range = SimpleRange.create(comments);
  }

  @Override
  public String getDescription() {
    return description;
  }

  @Override
  public String getDeprecationInfo() {
    return deprecationInfo;
  }

  @Override
  public boolean isDeprecated() {
    return deprecated;
  }

  @Override
  public String getPurposeDescription() {
    return purposeDescription;
  }

  @Override
  public String getLink() {
    return link;
  }

  @Override
  public SimpleRange getSimpleRange() {
    return range;
  }

  public List getExamples() {
    return examples;
  }

  public List getCallOptions() {
    return callOptions;
  }

  public List getParameters() {
    return parameters;
  }

  public List getReturnedValue() {
    return returnedValue;
  }
}