SynEdit/ru: what changed

Revision 0 to 1. Removed lines have a minus sign; added lines have a plus sign.

Title: SynEdit/ru

New		Line
1	+	SynEdit - пакет [[Syntax highlighting\|подсветки синтаксиса]] для edit/memo, доступный на [[SynEdit tab/ru\|вкладке SynEdit]] с поддержкой многих языков/синтаксиса.
2	+
3	+	SynEdit, содержащийся в Lazarus, был ответветлен от [SynEdit 1.0.3](https://sourceforge.net/projects/synedit/files/), адаптирован и довольно сильно расширен. Изменения перечислены ниже.
4	+
5	+	Пакет Lazarus содержит компонент редактора исходного кода под названием \[TSynEdit/ru\\|\[TSynEdit\]\], несколько подсветок синтаксиса и другие компоненты, используемые для редактирования исходного кода.
6	+
7	+	Лицензирован на тех же условиях, что и исходный SynEdit (MPL или GPL).
8	+
9	+	## Оригинальная версия против версии Lazarus
10	+
11	+	Версия Lazarus поддерживается в основном [[[User:Martin\|Martin Friebe]]. Martin написал на форуме, что было добавлено в версию Lazarus с момента появления fork:
12	+
13	+	Большие изменения, добавленные в версию Lazarus:
14	+
15	+	- сворачивание блоков кода
16	+	- настраиваемые боковое поле / части бокового поля
17	+	- общий текст между несколькими редакторами
18	+	- поддержка utf-8
19	+	- плагин для синхронизации
20	+	- базовая поддержка RTL/LTR
21	+	- настройка мыши через MouseActions
22	+	- переписаны различные модули подсветки/разметки
23	+
24	+	Кодовые базы версий Delphi / Lazarus были независимо переработаны. Осталось очень мало совпадений.
25	+
26	+	## SynEdit 2.0 port
27	+
28	+	Существует альтернативный порт оригинальной версии SynEdit версии 2.0.x. Активность не поддерживается, последний коммит (сейчас июнь 2014) был в 2011 году.
29	+
30	+	- [[SynEdit/port]]
31	+	- [Github page](https://github.com/rnapoles/)
32	+
33	+	## SynEdit в IDE
34	+
35	+	SynEdit в Lazarus - это встроенный пакет, потому что среда IDE использует его сама. Поэтому пакет не может быть удален из списка установки. Чтобы удалить записи из палитры компонентов, пакет SynEditDsgn можно удалить из установки.
36	+
37	+	## Использование SynEdit
38	+
39	+	### Подсветка
40	+
41	+	- Есть несколько стандартных маркеров подсветки (см. [[SynEdit tab/ru\|вкладку SynEdit]] в [[Component Palette/ru\|палитре компонентов]])
42	+	- Существуют сценарии подсветки, которые можно адаптировать ко многим другим форматам файлов:
43	+	- [[TSynAnySyn]] (стандартный, на палитре компонентов по умолчанию)
44	+	- [[TSynPositionHighlighter]] (стандартный, не на палитре компонентов)
45	+	- [[TSynUniHighlighter]] (стандартный, не на палитре компонентов)
46	+	- SynFacilSyn ([Github](https://github.com/t-edson/SynFacilSyn))
47	+	- Существуют и другие сторонние маркеры подсветки: SynCacheSyn, SynGeneralSyn, SynRCSyn, SynRubySyn, SynSDDSyn, SynSMLSyn, SynSTSyn, SynTclTkSyn, SynUnrealSyn, SynURISyn, SynVBScriptSyn, SynVrml97Syn, [см. здесь](http://bugs.freepascal.org/view.php?id=18248).
48	+	- Вы можете написать новый маркер подсветки, см. информацию в [[SynEdit Highlighter]].
49	+
50	+	### Изменение существующего маркера подсветки
51	+
52	+	Иногда у вас может появиться желание отредактировать существующие маркеры подсветки (как этого хотел я несколько дней назад), которые уже существуют. В этом примере мы собираемся отредактировать маркер подсветку для паскаль-подобного кода (classname: [[TSynPasSyn]]; package: SynEdit V1.0; unit: SynHighlighterPas.pas).
53	+
54	+	Скажем, мы хотим достичь того, чтобы наше приложение (в данном случае Lazarus) различало три типа комментариев, которые существуют в Pascal:
55	+
56	+	``` pascal
57	+	(* ansi *)
58	+	{ bor }
59	+	// Slash
60	+	```
61	+
62	+	Это может быть полезно, если вы хотите различать различные типы ваших комментариев (например, "Description", "Note", "Reference" и т.д.) и хотите, чтобы они были, например, окрашивались по-разному.
63	+
64	+	> Note: На случай, если вы что-то сломаете, я предлагаю сделать несколько "NEW" и "/NEW"-комментариев, но вам не нужно
65	+
66	+	- Сначала откройте модуль "SynHighlighterPas", который должен находиться в вашем SynEdit-каталоге.
67	+	- Поскольку мы не хотим создавать несовместимости, мы создаем новый перечислимый тип, который поможет нам позже идентифицировать наш комментарий:
68	+
69	+	Напр., под объявлением "tkTokenKind" напишите это:
70	+
71	+	``` pascal
72	+	{NEW}
73	+	TtckCommentKind = (tckAnsi, tckBor, tckSlash);
74	+	{/NEW}
75	+	```
76	+
77	+	- В объявлении "TSynPasSyn" найдите "FTokenID" и добавьте следующее между "FTokenID" и следующим полем
78	+
79	+	``` pascal
80	+	{NEW}
81	+	FCommentID: TtckCommentKind;
82	+	{/NEW}
83	+	//Это создает новое поле, где мы можем хранить информацию, какой у нас комментарий
84	+	```
85	+
86	+	- В объявлении "TSynPasSyn" найдите "fCommentAttri" и добавьте следующее между "fCommentAttri" и следующим полем
87	+
88	+	``` pascal
89	+	{NEW}
90	+	fCommentAttri_Ansi: TSynHighlighterAttributes;
91	+	fCommentAttri_Bor: TSynHighlighterAttributes;
92	+	fCommentAttri_Slash: TSynHighlighterAttributes;
93	+	{/NEW}
94	+	//Это позволяет нам возвращать различные атрибуты для каждого типа комментариев.
95	+	```
96	+
97	+	- Затем найдите определение конструктора "TSynPasSyn", которое должно быть "constructor TSynPasSyn.Create(AOwner: TComponent);"
98	+	- Нам нужно создать наши новые атрибуты, таким образом, мы добавляем наши атрибуты где-нибудь в конструкторе (я предлагаю после значения по умолчанию "fCommentAttri")
99	+
100	+	``` pascal
101	+	(...)
102	+	AddAttribute(fCommentAttri);
103	+	{NEW}
104	+	fCommentAttri_Ansi := TSynHighlighterAttributes.Create(SYNS_AttrComment+'_Ansi', SYNS_XML_AttrComment+'_Ansi'); // Последние две строки - это заголовок и сохраненное имя
105	+	//Если вы хотите иметь настройки по умолчанию для вашего атрибута, вы можете, например, добавить это:
106	+	//fCommentAttri_Ansi.Background := clBlack; //Установит "Background" в "clBlack" по умолчанию
107	+	AddAttribute(fCommentAttri_Ansi);
108	+	fCommentAttri_Bor := TSynHighlighterAttributes.Create(SYNS_AttrComment+'_Bor', SYNS_XML_AttrComment+'_Bor');
109	+	AddAttribute(fCommentAttri_Bor);
110	+	fCommentAttri_Slash := TSynHighlighterAttributes.Create(SYNS_AttrComment+'_Slash', SYNS_XML_AttrComment+'_Slash');
111	+	AddAttribute(fCommentAttri_Slash);
112	+	{/NEW}
113	+	(...)
114	+	```
115	+
116	+	- «Сложная» часть теперь состоит в том, чтобы найти места в коде, где "FTokenID" установлен в "tkComment", и установить наш «подтип» одинаково (конечно, я их уже поискал :)
117	+
118	+	``` pascal
119	+	procedure TSynPasSyn.BorProc;
120	+	(...)
121	+	fTokenID := tkComment;
122	+	{NEW}
123	+	FCommentID:=tckBor;
124	+	{/NEW}
125	+	if rsIDEDirective in fRange then
126	+	(...)
127	+	```
128	+
129	+	``` pascal
130	+	procedure TSynPasSyn.AnsiProc;
131	+	begin
132	+	fTokenID := tkComment;
133	+	{NEW}
134	+	FCommentID:=tckAnsi;
135	+	{/NEW}
136	+	(...)
137	+	```
138	+
139	+	``` pascal
140	+	procedure TSynPasSyn.RoundOpenProc;
141	+	(...)
142	+	fTokenID := tkComment;
143	+	{NEW}
144	+	FCommentID:=tckAnsi;
145	+	{/NEW}
146	+	fStringLen := 2; // length of "(*"
147	+	(...)
148	+	```
149	+
150	+	``` pascal
151	+	procedure TSynPasSyn.SlashProc;
152	+	begin
153	+	if fLine[Run+1] = '/' then begin
154	+	fTokenID := tkComment;
155	+	{NEW}
156	+	FCommentID:=tckSlash;
157	+	{/NEW}
158	+	if FAtLineStart then begin
159	+	(...)
160	+	```
161	+
162	+	``` pascal
163	+	procedure TSynPasSyn.SlashContinueProc;
164	+	(...)
165	+	fTokenID := tkComment;
166	+	{NEW}
167	+	FCommentID:=tckSlash;
168	+	{/NEW}
169	+	while not(fLine[Run] in [#0, #10, #13]) do
170	+	(...)
171	+	```
172	+
173	+	- Теперь нам просто нужно извлечь информацию при вызове "GetTokenAttribute" и вернуть правильный атрибут, поэтому мы отредактируем "GetTokenAttribute" следующим образом:
174	+
175	+	``` pascal
176	+	function TSynPasSyn.GetTokenAttribute: TSynHighlighterAttributes;
177	+	begin
178	+	case GetTokenID of
179	+	tkAsm: Result := fAsmAttri;
180	+	{OLD
181	+	tkComment: Result := fCommentAttri; //Это закомментировано и на всякий пожарный сохранено, поэтому оно будет игнорироваться
182	+	/OLD}
183	+	{NEW}
184	+	tkComment: begin
185	+	if (FCommentID=tckAnsi) then Result:=fCommentAttri_Ansi //Тип - AnsiComment
186	+	else
187	+	if (FCommentID=tckBor) then Result:=fCommentAttri_Bor //Тип - BorComment
188	+	else
189	+	if (FCommentID=tckSlash) then Result:=fCommentAttri_Slash //Тип - SlashComment
190	+	else
191	+	Result:=fCommentAttri //Если наш код каким-то образом упал, возврат к умолчанию
192	+	end;
193	+	{/NEW}
194	+	tkIDEDirective: begin
195	+	(...)
196	+	```
197	+
198	+	Если вы используете lazarus, просто переустановите SynEdit-Package, если нет, перекомпилируйте ваш проект/пакет/\<аналог\>.
199	+
200	+	ГОТОВО! Нет, серьезно, теперь вы готовы отличать различные типы комментариев.
201	+
202	+	Lazarus-IDE автоматически определяет, какие атрибуты существуют, и показывает их в опциях, например сохраняет их, если вы их изменяете. Если ваше приложение/IDE не делает этого, вам придется установить Color/Font/ и т.д. новых атрибутов где-то вручную (например, в конструкторе TSynPasSyn)
203	+
204	+	### Плагины для автозавершения кода
205	+
206	+	Для SynEdit есть 3 подключаемых плагина автозавершения кода:
207	+
208	+	[[TSynCompletion]]
209	+
210	+	- Предлагает список слов в раскрывающемся списке с помощью сочетания клавиш (по умолчанию: <span class="kbd">Ctrl</span>+<span class="kbd">space</span>).
211	+	- Используется в IDE для автозавершения идентификатора.
212	+	- Включен в примеры.
213	+	- Доступен в палитре компонентов (начиная с 0.9.3x).
214	+
215	+	Пример кода, чтобы вызвать автозавершение, всплывает программно (т.е. без нажатия сочетания клавиш):
216	+
217	+	``` pascal
218	+	YourSynEdit.CommandProcessor(YourSynCompletion.ExecCommandID, '', nil)
219	+	```
220	+
221	+	[[TSynAutoComplete]]
222	+
223	+	- Заменяет текущий токен фрагментом текста. Не интерактивный. Не выпадающий.
224	+	- Включен в примеры.
225	+	- Доступен в палитре компонентов.
226	+
227	+	[[TSynEditAutoComplete]]
228	+
229	+	- Основной шаблон модуля. Не выпадающий.
230	+	- Используется IDE для шаблонов кода. IDE содержит дополнительный код, расширяющий эту функцию (IDE добавляет макросы выпадающего списка и синхронизации).
231	+	- Не включен в примеры.
232	+
233	+	Todo: Различия между 2-м и 3-м должны быть задокументированы. Может быть, они могут быть объединены.
234	+
235	+	### Логическая/Физическая позиция каретки
236	+
237	+	SynEdit предлагает положение каретки (текстовый мигающий курсор) в 2 различных формах:
238	+
239	+	- Физический X/Y: соответствует визуальной (холст) позиции
240	+	- Логический X/Y: соответствует байтовому смещению текста
241	+
242	+	Оба основаны на 1 (отсчет начинается с 1). В настоящее время координаты Y всегда одинаковы. Это может измениться в будущем.
243	+
244	+	Физическая координата
245	+	это позиция в сетке дисплея (без учета прокрутки). То есть:
246	+
247	+	обе буквы "a" и "â" занимают ОДНУ ячейку в сетке, увеличивая физический x на 1. Несмотря на то, что в кодировке utf8 "a" занимает один байт, а "â" занимает несколько байтов.
248	+
249	+	однако символ табуляции (#9), помимо одного байта и одного символа, может занимать несколько ячеек в сетке, увеличивая физический x более, чем на одну позицию. Есть также некоторые символы в китайском и восточном языках, которые занимают 2 позиции в сетке (гуглите отличие full-width(полной ширины) от half-width (полуширины) символа).
250	+
251	+	Логическая координата
252	+	смещение байта в строчке, содержащей строку.
253	+
254	+	буква «а» имеет 1 байт и увеличивается на 1
255	+
256	+	буква "â" имеет 2 (или 3) байта и увеличивается на эту величину
257	+
258	+	символ tab имеет 1 байт и увеличивается на эту величину.
259	+
260	+	Ни один из 2 не дает позицию в символах/кодовых точках UTF8 (например, для Utf8Copy или Utf8Length).
261	+
262	+	Физический X всегда отсчитывается слева от текста, даже если он прокручивается. Чтобы получить grid-x текущего прокручиваемого элемента управления, выполните:
263	+
264	+
265	+	grid-X-in-visible-part-of-synedit := PhysicalX - SynEdit.LeftChar + 1
266	+
267	+	grid-y-in-visible-part-of-synedit := SynEdit.RowToScreenRow(PhysicalY); // включает в себя складывание (схлопывание) текста
268	+
269	+	используйте ScreenRowToRow для обратного процесса
270	+
271	+	### Изменение текста из кода
272	+
273	+	> Warning: Изменение текста с помощью свойства <i>SynEdit.Lines</i> <u>не работает с undo/redo.</u>
274	+
275	+	Доступ к тексту можно получить через SynEdit.Lines. Это свойство на основе TStrings, предлагающее доступ на чтение/запись к каждой строке. Основано на нумерации строк с 0.
276	+
277	+	``` pascal
278	+	SynEdit.Lines[0] := 'Text'; // первая строчка
279	+	```
280	+
281	+	SynEdit.Lines можно использовать для установки начальной версии текста (например, загруженного из файла). Обратите внимание, что методы SynEdit.Lines.Add/SynEdit.Lines.Append не поддерживают разрывы строк внутри добавленных строк. Вы должны добавлять строки одну за другой.
282	+
283	+	Чтобы изменить содержимое SynEdit и позволить пользователю отменить действие, используйте следующие методы:
284	+
285	+	``` pascal
286	+	procedure InsertTextAtCaret(aText: String; aCaretMode: TSynCaretAdjustMode = scamEnd);
287	+	property TextBetweenPoints[aStartPoint, aEndPoint: TPoint]: String // Логические точки
288	+	read GetTextBetweenPoints write SetTextBetweenPointsSimple;
289	+	property TextBetweenPointsEx[aStartPoint, aEndPoint: TPoint; CaretMode: TSynCaretAdjustMode]: String
290	+	write SetTextBetweenPointsEx;
291	+	procedure SetTextBetweenPoints(aStartPoint, aEndPoint: TPoint;
292	+	const AValue: String;
293	+	aFlags: TSynEditTextFlags = [];
294	+	aCaretMode: TSynCaretAdjustMode = scamIgnore;
295	+	aMarksMode: TSynMarksAdjustMode = smaMoveUp;
296	+	aSelectionMode: TSynSelectionMode = smNormal );
297	+	```
298	+
299	+	Примеры:
300	+
301	+	``` pascal
302	+	// Вставляем текст в позицию каретки
303	+	SynEdit.InsertTextAtCaret('Text');
304	+	// Заменяем текст с (x=2,y=10) на (x=4,y=20) с помощью Str
305	+	SynEdit.TextBetweenPoints[Point(2,10), Point(4,20)] := Str;
306	+	```
307	+
308	+	``` pascal
309	+	// Удаляем/заменяем один символ в позиции каретки
310	+	var p1, p2: TPoint;
311	+	begin
312	+	p1 := SynEdit.LogicalCaretXY;
313	+	p2 := p1;
314	+	// Высчитываем позицию байта следующего символа
315	+	p2.x := p2.x + UTF8CharacterLength(@SynEdit.LineText[p2.x]);
316	+	// p1 указывает на первый байт заменяемого символа
317	+	// p2 указывает на первый байт символа после последнего заменяемого символа
318	+	// Заменяем на "Text" (или используем пустую строку для удаления)
319	+	SynEdit.TextBetweenPoints[p1, p2] := 'Text';
320	+	```
321	+
322	+	### Сворачивание/Разворачивание текста из кода
323	+
324	+	- Это все еще находится в стадии разработки.
325	+	- Это работает, только если текущий маркер подсветки поддерживает сворачивание (подробности в [[SynEdit Highlighter]]).
326	+	- Также обратите внимание, что некоторые маркеры подсветки поддерживают несколько независимых сворачиваемых деревьев. Например, в Паскале у вас есть сворачивание по ключевым словам (`begin`, `end`, `class`, `procedure` и т.д.), которое является основным, и сворачивание по `$ifdef` или `$region`, которое является дополнительным.
327	+	- Сворачивание текущего выделения также отличается от сворачивания по ключевым словам.
328	+
329	+	Методы сворачивания:
330	+
331	+	1\) TSynEdit.CodeFoldAction
332	+
333	+	Сворачивание в данной строчке. Если их больше одной, сворачивается самая внутренняя (самая правая).
334	+
335	+	> Note: Это не работает ни с выделением, ни с блоком сворачиваемого кода, которые уже полностью скрыт/требуется тестирование для дополнительных блоков сворачиваемого кода.
336	+
337	+	2\) TSynEdit.FindNextUnfoldedLine
338	+
339	+	3\) TSynEdit.FoldAll / TSynEdit.UnfoldAll
340	+
341	+	### Закладки
342	+
343	+	- [Топик форума о добавлении меток и цветных линий](http://forum.lazarus.freepascal.org/index.php/topic,14948.msg79794.html)
344	+
345	+	### Дополнительная информация
346	+
347	+	Обсуждения на форуме, которые содержат информацию о SynEdit:
348	+
349	+	- [Search/replace; caret; position logical/physical](http://forum.lazarus.freepascal.org/index.php/topic,19520.msg111158.html#msg111158)
350	+	- [Diff between SynEdit/SynMemo](http://forum.lazarus.freepascal.org/index.php/topic,19645.msg111962.html#msg111962)
351	+	- [Mouse actions; disable paste on middle click](http://forum.lazarus.freepascal.org/index.php/topic,23997.msg144100.html#msg144100)
352	+	- [TSynEditMarkup info](http://forum.lazarus.freepascal.org/index.php?topic=24842)
353	+
354	+	### Примеры приложений
355	+
356	+	Примеры приложений можно найти в папке "lazarus/examples/synedit".
357	+
358	+	### Добавление горячих клавиш для Cut/Copy/Paste/и т.д.
359	+
360	+	Горячие клавиши могут быть реализованы с помощью команд SynEdit.
361	+
362	+	``` pascal
363	+	uses
364	+	SynEdit, SynEditKeyCmds;
365	+
366	+	procedure TForm1.SynEdit1KeyDown(Sender: TObject; var Key: Word;
367	+	Shift: TShiftState);
368	+	begin
369	+	if (Shift = [ssCtrl]) then
370	+	begin
371	+	case Key of
372	+	VK_C: SynEdit1.CommandProcessor(TSynEditorCommand(ecCopy), ' ', nil);
373	+	VK_V: SynEdit1.CommandProcessor(TSynEditorCommand(ecPaste), ' ', nil);
374	+	VK_X: SynEdit1.CommandProcessor(TSynEditorCommand(ecCut), ' ', nil);
375	+	end;
376	+	end;
377	+	end;
378	+	```
379	+
380	+	## Дальнейшее развитие, обсуждение
381	+
382	+	- RTL (справа налево): начат Mazen'ом (частично реализован в Windows)
383	+	- SynEdit использует только UTF8; версия ASCII/ANSI больше не существует. Шрифт предварительно выбирается в зависимости от системы. Пользователь может выбрать другой шрифт, но затем должен позаботиться о выборе моноширинного шрифта.
384	+	- автоматический выбор моноширинного шрифта: в данный момент SynEdit запускается со использованием шрифта 'courier'. На данный момент TFont LCL не предоставляет свойство для фильтрации моноширинных шрифтов.
385	+	- автоматический выбор шрифта UTF-8: по аналогии с выше описанным моноширинным шрифтом + также со шрифтом UTF-8, так что, например, умлауты отображаются правильно.
386	+	- "Немые" клавиши. Большинство клавиатур поддерживают ввод с использованием двух или более клавиш для создания одного специального символа (например, символы ударения или умлаута). (Это обрабатывается LCL widgedset)
387	+	- [[Redesign of the SynEdit component\|Редизайн компонента SynEdit]]. Основная задача - более надежное отображение и навигация по тексту. Более модульный подход также позволяет лучше интегрировать расширения и специализированные элементы управления для использования вне Lazarus.
388	+	- [Перенос слов](http://bugs.freepascal.org/view.php?id=30395). Это экспериментальная реализация, следующая идее классов TextTrimmer/TabExpansion. У связанной проблемы bugtraker есть класс и объяснение изменений, требуемых в других файлах для его работы.
389	+	- Хуки в обработке клавиши/команды SynEdit. На форуме:<http://forum.lazarus-ide.org/index.php/topic,35592.msg243316.html#msg243316>
390	+
391	+	## См. также
392	+
393	+	- [[SynEdit Highlighter]]
394	+	- ["Изменение существующего маркера подсветки": немецкая ветка форума на "lazarusforum.de"](http://www.lazarusforum.de/viewtopic.php?f=5&t=8723)
395	+	- [[ATSynEdit]]
396	+
397	+	---
398	+	From the Free Pascal wiki, page "SynEdit/ru", as it stood on 2019-09-04 after a change by Zoltanleo, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).
399	+	Category: Components/ru
400	+	Category: Lazarus/ru
401	+	Category: Russian
402	+	Category: Russian (unfinished translation)
403	+	Category: SynEdit/ru

Back to history