• Home
• io.github.1c-syntax
• bsl-language-server
• 0.24.0-rc.1
• source code
• Regions.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github._1c_syntax.bsl.languageserver.utils.Regions Maven / Gradle / Ivy

/*
 * This file is a part of BSL Language Server.
 *
 * Copyright (c) 2018-2024
 * Alexey Sosnoviy , Nikita Fedkin  and contributors
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later
 *
 * BSL Language Server 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 Language Server 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 Language Server.
 */
package com.github._1c_syntax.bsl.languageserver.utils;

import com.github._1c_syntax.bsl.mdo.support.ScriptVariant;
import com.github._1c_syntax.bsl.types.ModuleType;
import com.github._1c_syntax.utils.CaseInsensitivePattern;
import lombok.experimental.UtilityClass;

import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.regex.Pattern;

/**
 * Вспомогательный класс, содержащий методы для работы с программными областями 1С
 */
@UtilityClass
public class Regions {

  private final Pattern PUBLIC_REGION_NAME =
    createPattern(Keywords.PUBLIC_REGION_RU, Keywords.PUBLIC_REGION_EN);

  private final Pattern INTERNAL_REGION_NAME =
    createPattern(Keywords.INTERNAL_REGION_RU, Keywords.INTERNAL_REGION_EN);

  private final Pattern PRIVATE_REGION_NAME =
    createPattern(Keywords.PRIVATE_REGION_RU, Keywords.PRIVATE_REGION_EN);

  private final Pattern EVENT_HANDLERS_REGION_NAME =
    createPattern(Keywords.EVENT_HANDLERS_REGION_RU, Keywords.EVENT_HANDLERS_REGION_EN);

  private final Pattern FORM_EVENT_HANDLERS_REGION_NAME =
    createPattern(Keywords.FORM_EVENT_HANDLERS_REGION_RU, Keywords.FORM_EVENT_HANDLERS_REGION_EN);

  private final Pattern FORM_HEADER_ITEMS_EVENT_HANDLERS_REGION_NAME =
    createPattern(Keywords.FORM_HEADER_ITEMS_EVENT_HANDLERS_REGION_RU,
      Keywords.FORM_HEADER_ITEMS_EVENT_HANDLERS_REGION_EN);

  private final Pattern FORM_TABLE_ITEMS_EVENT_HANDLERS_REGION_NAME =
    createPattern(Keywords.FORM_TABLE_ITEMS_EVENT_HANDLERS_REGION_START_RU,
      Keywords.FORM_TABLE_ITEMS_EVENT_HANDLERS_REGION_START_EN,
      "^(?:%s|%s)[\\wа-яёЁ]*$");

  private final Pattern FORM_COMMANDS_EVENT_HANDLERS_REGION_NAME =
    createPattern(Keywords.FORM_COMMANDS_EVENT_HANDLERS_REGION_RU, Keywords.FORM_COMMANDS_EVENT_HANDLERS_REGION_EN);

  private final Pattern VARIABLES_REGION_NAME =
    createPattern(Keywords.VARIABLES_REGION_RU,
      Keywords.VARIABLES_REGION_EN);

  private final Pattern INITIALIZE_REGION_NAME =
    createPattern(Keywords.INITIALIZE_REGION_RU, Keywords.INITIALIZE_REGION_EN);

  /**
   * Метод возвращает паттерны регулярных выражений
   * удовлетворяющих стандартным наименованиям областей 1С на русском и английском языках
   *
   * @param moduleType тип программного модуля 1С
   * @return множество паттернов имен областей 1С для конкретного типа модуля
   */
  public Set getStandardRegionsPatternsByModuleType(ModuleType moduleType) {

    if (moduleType == ModuleType.UNKNOWN) {
      return Collections.emptySet();
    }

    Set standardRegions = new HashSet<>();

    switch (moduleType) {
      case FormModule:
        addFormModuleRegions(standardRegions);
        break;
      case ObjectModule:
      case RecordSetModule:
        addRecordSetRegions(standardRegions);
        break;
      case ValueManagerModule:
        standardRegions.add(VARIABLES_REGION_NAME);
        standardRegions.add(PUBLIC_REGION_NAME);
        standardRegions.add(EVENT_HANDLERS_REGION_NAME);
        standardRegions.add(INTERNAL_REGION_NAME);
        break;
      case CommonModule:
        standardRegions.add(PUBLIC_REGION_NAME);
        standardRegions.add(INTERNAL_REGION_NAME);
        break;
      case ApplicationModule:
      case ManagedApplicationModule:
      case OrdinaryApplicationModule:
        standardRegions.add(VARIABLES_REGION_NAME);
        standardRegions.add(PUBLIC_REGION_NAME);
        standardRegions.add(EVENT_HANDLERS_REGION_NAME);
        break;
      case CommandModule:
      case SessionModule:
      case HTTPServiceModule:
      case WEBServiceModule:
        standardRegions.add(EVENT_HANDLERS_REGION_NAME);
        break;
      case ExternalConnectionModule:
        standardRegions.add(PUBLIC_REGION_NAME);
        standardRegions.add(EVENT_HANDLERS_REGION_NAME);
        break;
      case ManagerModule:
        standardRegions.add(PUBLIC_REGION_NAME);
        standardRegions.add(EVENT_HANDLERS_REGION_NAME);
        standardRegions.add(INTERNAL_REGION_NAME);
        break;
      default:
        // для Unknown ничего
    }

    // у всех типов модулей есть такая область
    standardRegions.add(PRIVATE_REGION_NAME);
    return standardRegions;
  }

  /**
   * Получает стандартные области OneScript, на основании языка
   *
   * @param configurationLanguage язык конфигурации, может быть русским или английским
   * @return множество имен стандартных областей OneSCript
   */
  public static Set getOneScriptStandardRegions(ScriptVariant configurationLanguage) {

    Set regionsName = new LinkedHashSet<>();

    if (configurationLanguage == ScriptVariant.ENGLISH) {
      regionsName.add(Keywords.VARIABLES_REGION_EN);
      regionsName.add(Keywords.PUBLIC_REGION_EN);
      regionsName.add(Keywords.INTERNAL_REGION_EN);
      regionsName.add(Keywords.PRIVATE_REGION_EN);
      return regionsName;
    }

    regionsName.add(Keywords.VARIABLES_REGION_RU);
    regionsName.add(Keywords.PUBLIC_REGION_RU);
    regionsName.add(Keywords.INTERNAL_REGION_RU);
    regionsName.add(Keywords.PRIVATE_REGION_RU);
    return regionsName;
  }

  /**
   * Получает стандартные имена областей 1С, на основании типа программного модуля
   * и языка конфигурации
   *
   * @param moduleType тип программного модуля 1С
   * @param language   язык конфигурации, может быть русским или английским
   * @return множество имен стандартных областей 1С
   */
  public Set getStandardRegionsNamesByModuleType(ModuleType moduleType, ScriptVariant language) {
    return getStandardRegionNames(moduleType, language);
  }

  private static Set getStandardRegionNames(ModuleType moduleType, ScriptVariant language) {
    Set regionsName = new LinkedHashSet<>();
    switch (moduleType) {
      case FormModule:
        addFormModuleRegionsNames(regionsName, language);
        break;
      case ObjectModule:
      case RecordSetModule:
        addObjectAndRecordSetRegionsName(regionsName, language);
        break;
      case ValueManagerModule:
        addValueManageRegionsName(regionsName, language);
        break;
      case CommonModule:
        addCommonModuleRegionNames(regionsName, language);
        break;
      case ApplicationModule:
      case ManagedApplicationModule:
      case OrdinaryApplicationModule:
        addApplicationModulesRegionsNames(regionsName, language);
        break;
      case CommandModule:
      case SessionModule:
      case HTTPServiceModule:
      case WEBServiceModule:
        addCommandAndSessionModulesRegionsNames(regionsName, language);
        break;
      case ExternalConnectionModule:
        addExternalConnectionRegionsNames(regionsName, language);
        break;
      case ManagerModule:
        addManagerModuleRegionsNames(regionsName, language);
        break;
      default:
        // для Unknown ничего
    }

    // у всех типов модулей есть такая область
    regionsName.add(language == ScriptVariant.ENGLISH ? Keywords.PRIVATE_REGION_EN : Keywords.PRIVATE_REGION_RU);

    return regionsName;
  }

  private static void addManagerModuleRegionsNames(Set regionsName, ScriptVariant language) {

    if (language == ScriptVariant.ENGLISH) {
      regionsName.add(Keywords.PUBLIC_REGION_EN);
      regionsName.add(Keywords.EVENT_HANDLERS_REGION_EN);
      regionsName.add(Keywords.INTERNAL_REGION_EN);
      return;
    }

    regionsName.add(Keywords.PUBLIC_REGION_RU);
    regionsName.add(Keywords.EVENT_HANDLERS_REGION_RU);
    regionsName.add(Keywords.INTERNAL_REGION_RU);
  }

  private static void addExternalConnectionRegionsNames(Set regionsName, ScriptVariant language) {

    if (language == ScriptVariant.ENGLISH) {
      regionsName.add(Keywords.PUBLIC_REGION_EN);
      regionsName.add(Keywords.EVENT_HANDLERS_REGION_EN);
      return;
    }

    regionsName.add(Keywords.PUBLIC_REGION_RU);
    regionsName.add(Keywords.EVENT_HANDLERS_REGION_RU);
  }

  private static void addCommandAndSessionModulesRegionsNames(Set regionsName, ScriptVariant language) {
    regionsName.add(language == ScriptVariant.ENGLISH ? Keywords.EVENT_HANDLERS_REGION_EN
      : Keywords.EVENT_HANDLERS_REGION_RU);
  }

  private static void addApplicationModulesRegionsNames(Set regionsName, ScriptVariant language) {

    if (language == ScriptVariant.ENGLISH) {
      regionsName.add(Keywords.VARIABLES_REGION_EN);
      regionsName.add(Keywords.PUBLIC_REGION_EN);
      regionsName.add(Keywords.EVENT_HANDLERS_REGION_EN);
      return;
    }

    regionsName.add(Keywords.VARIABLES_REGION_RU);
    regionsName.add(Keywords.PUBLIC_REGION_RU);
    regionsName.add(Keywords.EVENT_HANDLERS_REGION_RU);
  }

  private static void addCommonModuleRegionNames(Set regionsName, ScriptVariant language) {

    if (language == ScriptVariant.ENGLISH) {
      regionsName.add(Keywords.PUBLIC_REGION_EN);
      regionsName.add(Keywords.INTERNAL_REGION_EN);
      return;
    }

    regionsName.add(Keywords.PUBLIC_REGION_RU);
    regionsName.add(Keywords.INTERNAL_REGION_RU);
  }

  private static void addValueManageRegionsName(Set regionsName, ScriptVariant language) {
    if (language == ScriptVariant.ENGLISH) {
      regionsName.add(Keywords.VARIABLES_REGION_EN);
      regionsName.add(Keywords.PUBLIC_REGION_EN);
      regionsName.add(Keywords.EVENT_HANDLERS_REGION_EN);
      regionsName.add(Keywords.INTERNAL_REGION_EN);
      return;
    }
    regionsName.add(Keywords.VARIABLES_REGION_RU);
    regionsName.add(Keywords.PUBLIC_REGION_RU);
    regionsName.add(Keywords.EVENT_HANDLERS_REGION_RU);
    regionsName.add(Keywords.INTERNAL_REGION_RU);
  }

  private static void addObjectAndRecordSetRegionsName(Set regionsName, ScriptVariant language) {

    if (language == ScriptVariant.ENGLISH) {
      regionsName.add(Keywords.VARIABLES_REGION_EN);
      regionsName.add(Keywords.PUBLIC_REGION_EN);
      regionsName.add(Keywords.EVENT_HANDLERS_REGION_EN);
      regionsName.add(Keywords.INTERNAL_REGION_EN);
      regionsName.add(Keywords.INITIALIZE_REGION_EN);
      return;
    }
    regionsName.add(Keywords.VARIABLES_REGION_RU);
    regionsName.add(Keywords.PUBLIC_REGION_RU);
    regionsName.add(Keywords.EVENT_HANDLERS_REGION_RU);
    regionsName.add(Keywords.INTERNAL_REGION_RU);
    regionsName.add(Keywords.INITIALIZE_REGION_RU);
  }

  private static void addFormModuleRegionsNames(Set regionsName, ScriptVariant language) {
    if (language == ScriptVariant.ENGLISH) {
      regionsName.add(Keywords.VARIABLES_REGION_EN);
      regionsName.add(Keywords.FORM_EVENT_HANDLERS_REGION_EN);
      regionsName.add(Keywords.FORM_HEADER_ITEMS_EVENT_HANDLERS_REGION_EN);
      regionsName.add(Keywords.FORM_TABLE_ITEMS_EVENT_HANDLERS_REGION_START_EN);
      regionsName.add(Keywords.FORM_COMMANDS_EVENT_HANDLERS_REGION_EN);
      regionsName.add(Keywords.INITIALIZE_REGION_EN);
      return;
    }
    regionsName.add(Keywords.VARIABLES_REGION_RU);
    regionsName.add(Keywords.FORM_EVENT_HANDLERS_REGION_RU);
    regionsName.add(Keywords.FORM_HEADER_ITEMS_EVENT_HANDLERS_REGION_RU);
    regionsName.add(Keywords.FORM_TABLE_ITEMS_EVENT_HANDLERS_REGION_START_RU);
    regionsName.add(Keywords.FORM_COMMANDS_EVENT_HANDLERS_REGION_RU);
    regionsName.add(Keywords.INITIALIZE_REGION_RU);
  }


  private void addRecordSetRegions(Set standardRegions) {
    standardRegions.add(VARIABLES_REGION_NAME);
    standardRegions.add(PUBLIC_REGION_NAME);
    standardRegions.add(EVENT_HANDLERS_REGION_NAME);
    standardRegions.add(INTERNAL_REGION_NAME);
    standardRegions.add(INITIALIZE_REGION_NAME);
  }

  private void addFormModuleRegions(Set standardRegions) {
    standardRegions.add(VARIABLES_REGION_NAME);
    standardRegions.add(FORM_EVENT_HANDLERS_REGION_NAME);
    standardRegions.add(FORM_HEADER_ITEMS_EVENT_HANDLERS_REGION_NAME);
    standardRegions.add(FORM_TABLE_ITEMS_EVENT_HANDLERS_REGION_NAME);
    standardRegions.add(FORM_COMMANDS_EVENT_HANDLERS_REGION_NAME);
    standardRegions.add(INITIALIZE_REGION_NAME);
  }

  private static Pattern createPattern(String keywordRu, String keywordEn) {
    return createPattern(keywordRu, keywordEn, "^(?:%s|%s)$");
  }

  private static Pattern createPattern(String keywordRu, String keywordEn, String template) {
    return CaseInsensitivePattern.compile(
      String.format(template, keywordRu, keywordEn)
    );
  }
}