Milestone - June (六月) - 2022

[Bistard]

OverView

mark	Description
bullet	not started
checkmark	completed
⭐	important
🐄	on-going (Chris)
🐳	on-going (Jerry)
⚡️	on-going (Jody)
⛄	on-going (Cindy)
🚳	not for now
...	lots of unfinished

Folder Structure (2022.05.31)

├─base     # 基础代码
│  ├─browser       # 通用UI元件
│  │  ├─basic          # 基础UI元件
│  │  ├─icon
│  │  └─secondary      # 复合UI元件
│  ├─common        # 公用接口
│  ├─electron      # electron相关接口
│  └─node          # nodeJS相关接口
├─code     # 主入口
│  ├─browser       # 渲染模块主入口
│  │  ├─service
│  │  └─workbench     # UI框架
│  ├─common
│  │  ├─model
│  │  └─service
│  ├─electron-main # electron主入口
│  ├─platform
│  └─styles
├─editor   # 编辑器代码
│  ├─common
│  ├─styles
│  ├─model
│  ├─view
│  └─viewModel
└─styles   # css文件

Iteration Plan

Common Codes

• random - Random namespace.

User interface (UI)

• ExplorerTree - A wrapper class that presets behaviours relates to explorer.

Services

• FileService - FileService now able to read files in stream mode (readFileStream).
• KeyboardScreenCastService - brand new microservice.

Editor

• MVVM - foundamental framework.
• TextBufferBuilder - For essentially building a IPieceTable.
• PieceTable - Multiple buffer piece table with red-black tree, optimized for line model (HUGE WORK💦)
• EditorViewModelEmitter - Fires general event type from EditorModel.
• EditorViewEventHandler - Handling event fired from EditorViewModel.
• ViewComponent - Base class for any Views.
• ViewLineWidget & LineWidget - A place for storing the actual lines.
• ⛔ tokenizer - Using RegExp to split text into tokens (DEPRECATED).
• ⛔ lexer - Markdown lexer (DEPRECATED).

Workbench

• notebookManager - Refactor the old codes.

Unit Tests

• TextBufferBuilder - unit tests.
• PieceTable - unit tests.

Benchmark & Optimization

• benchmark - basic benchmark script (written in javascript and being placed in the new directory benchmark)

Code Review

• vscode - How does the Monaco editor achieve two-way data binding between View and ViewModel.
• vscode - How vscode renders lines (How vscode get a ViewLineData for each line) (high-level)
• marked - Basic Implementation (using RegExp)
• markdown-it - Basic Implementation (using Index Searching)

Others

• PieceTable
• MVVM
• Context Pattern

[Bistard]

Part1: How vscode renders lines (How vscode get a ViewLineData for each line):

This is more like a high-level wrapping process.

1. ViewLayerRenderer.render()
2. ViewLayerRenderer._finishRendering()
3. forEach: ViewLine.render()
4. ViewportData.getViewLineRenderingData()
5. ViewModel.getViewLineRenderingData()
6. ViewModelLinesFromProjectedModel.getViewLineData()
7. ModelLineProjection.getViewLineData()
8. ModelLineProjection.getViewLinesData()
   1. TextModel.tokenization.getLineTokens()
9. ModelLineProjection._getViewLineData()
   1. LineTokens.sliceAndInflate()
   2. SliceLineTokens.getLineContent()

[Bistard]

Part2: How vscode renders lines (How vscode get LineTokens given a line number):

This is a TextModel related data manipulation.

1. TextModel.tokenization.getLineTokens()
2. TokenizationTextModelPart.getLineTokens()
3. ContiguousTokensStore.getTokens()
   1.
4. SparseTokensStore.addSparseTokens()