Class ServerContext

java.lang.Object
com.github._1c_syntax.bsl.languageserver.context.ServerContext
@Component public class ServerContext extends Object
Контекст сервера - центральное хранилище информации о рабочей области.

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

  • Constructor Details

  • Method Details

    • populateContext

      public void populateContext()

    • populateContext

      public void populateContext(List<File> files)

    • getDocuments

      public Map<URI, DocumentContext> getDocuments()

    • getDocument

      public Optional<DocumentContext> getDocument(String mdoRef, com.github._1c_syntax.bsl.types.ModuleType moduleType)

    • getDocument

      public @Nullable DocumentContext getDocument(URI uri)
      Получить документ по URI.

      URI должен быть уже нормализован (например, получен из DocumentContext или через Absolute.uri).

      Parameters:
      uri - нормализованный URI документа
      Returns:
      Контекст документа или null, если документ не найден

    • getDocumentUnsafe

      public @Nullable DocumentContext getDocumentUnsafe(URI uri)
      Получить документ по URI с нормализацией.

      Используется для внешних вызовов (CLI, Service), где URI может быть не нормализован.

      Parameters:
      uri - URI документа (будет нормализован)
      Returns:
      Контекст документа или null, если документ не найден

    • getDocumentUnsafe

      public @Nullable DocumentContext getDocumentUnsafe(String uri)
      Получить документ по строковому URI с нормализацией.

      Используется для внешних вызовов (CLI, Service), где URI может быть не нормализован.

      Parameters:
      uri - строковый URI документа
      Returns:
      Контекст документа или null, если документ не найден

    • getDocuments

      public Map<com.github._1c_syntax.bsl.types.ModuleType, DocumentContext> getDocuments(String mdoRef)

    • addDocument

      public DocumentContext addDocument(URI uri)
      Добавить документ в контекст.

      URI должен быть уже нормализован.

      Parameters:
      uri - нормализованный URI документа
      Returns:
      Контекст документа

    • removeDocument

      public void removeDocument(URI uri)
      Удалить документ из контекста.

      URI должен быть уже нормализован.

      Parameters:
      uri - нормализованный URI документа

    • clear

      public void clear()

    • getDocumentLock

      public ReadWriteLock getDocumentLock(URI uri)
      Получить блокировку для выполнения операций над документом по URI.

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

      Parameters:
      uri - URI документа
      Returns:
      блокировка, связанная с URI документа.

    • openDocument

      public void openDocument(DocumentContext documentContext, String content, Integer version)
      Помечает документ как открытый и перестраивает его содержимое

      Документы, помеченные как открытые, не будут удаляться из контекста сервера при вызове removeDocument(URI), а так же не будут очищаться при вызове tryClearDocument(DocumentContext).

      Если вспомогательные данные документа был в "замороженном" состоянии, то перед перестроением документа они будут разморожены.

      Parameters:
      documentContext - документ, который необходимо открыть.
      content - новое содержимое документа.
      version - версия документа.

    • isDocumentOpened

      public boolean isDocumentOpened(DocumentContext documentContext)
      Проверяет, открыт ли документ в редакторе.

      Открытые документы управляются клиентом через события textDocument/didOpen, textDocument/didChange и textDocument/didClose. Для таких документов содержимое хранится в памяти сервера и может отличаться от содержимого файла на диске.

      Открытые документы не будут удалены при вызове removeDocument(URI) и не будут очищены при вызове tryClearDocument(DocumentContext).

      Parameters:
      documentContext - документ для проверки
      Returns:
      true, если документ открыт в редакторе, false в противном случае

    • rebuildDocument

      public void rebuildDocument(DocumentContext documentContext)
      Перестроить документ. В качестве содержимого будут использоваться данные, прочитанные из файла, с которым связан документ.
      Parameters:
      documentContext - документ, который необходимо перестроить.

    • rebuildDocument

      public void rebuildDocument(DocumentContext documentContext, String content, Integer version)
      Перестроить документ, используя новое содержимое.
      Parameters:
      documentContext - документ, который необходимо перестроить.
      content - новое содержимое документа.
      version - версия документа.

    • tryClearDocument

      public void tryClearDocument(DocumentContext documentContext)
      Попытаться очистить документ, если он не открыт.
      Parameters:
      documentContext - документ, который необходимо попытаться закрыть.

    • closeDocument

      public void closeDocument(DocumentContext documentContext)
      Закрыть документ и очистить его содержимое.
      Parameters:
      documentContext - документ, который необходимо закрыть.

    • getConfiguration

      public CF getConfiguration()

    • setConfigurationRoot

      public void setConfigurationRoot(@Nullable Path configurationRoot)

    • getConfigurationRoot

      public @Nullable Path getConfigurationRoot()