2 * Copyright (C) 2013 FooProject
3 * * This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
6 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
7 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
9 You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
16 using System.Collections.Generic;
18 using System.Text.RegularExpressions;
19 using System.Threading;
20 using System.Threading.Tasks;
23 namespace FooEditEngine
28 public enum ProgressState
42 public sealed class ProgressEventArgs : EventArgs
47 public ProgressState state;
51 /// <param name="state">ProgressStateオブジェクト</param>
52 public ProgressEventArgs(ProgressState state)
61 /// <param name="sender">送信元クラス</param>
62 /// <param name="e">イベントデータ</param>
63 public delegate void ProgressEventHandler(object sender, ProgressEventArgs e);
68 public enum UpdateType
71 /// ドキュメントが置き換えられたことを表す
75 /// ドキュメント全体が削除されたことを表す
81 /// 更新タイプを通知するためのイベントデータ
83 public sealed class DocumentUpdateEventArgs : EventArgs
88 public UpdateType type;
92 public int startIndex;
96 public int removeLength;
100 public int insertLength;
102 /// 更新イベントが発生した行。行が不明な場合や行をまたぐ場合はnullを指定すること。
108 /// <param name="type">更新タイプ</param>
109 /// <param name="startIndex">開始インデックス</param>
110 /// <param name="removeLength">削除された長さ</param>
111 /// <param name="insertLength">追加された長さ</param>
112 /// <param name="row">開始行。nullを指定することができる</param>
113 public DocumentUpdateEventArgs(UpdateType type, int startIndex, int removeLength, int insertLength, int? row = null)
116 this.startIndex = startIndex;
117 this.removeLength = removeLength;
118 this.insertLength = insertLength;
124 /// ドキュメントに更新があったことを伝えるためのデリゲート
126 /// <param name="sender">送信元クラス</param>
127 /// <param name="e">イベントデータ</param>
128 public delegate void DocumentUpdateEventHandler(object sender, DocumentUpdateEventArgs e);
133 /// <remarks>この型のすべてのメソッド・プロパティはスレッドセーフです</remarks>
134 public sealed class Document : IEnumerable<char>, IRandomEnumrator<char>
136 const int MaxSemaphoreCount = 1;
140 LineToIndexTable _LayoutLines;
141 bool _EnableFireUpdateEvent = true,_UrlMark = false, _DrawLineNumber = false, _HideRuler = true;
142 SemaphoreSlim Semaphore = new SemaphoreSlim(MaxSemaphoreCount);
143 LineBreakMethod _LineBreak;
144 int _TabStops, _LineBreakCharCount = 80;
149 public const int MaximumLineLength = 1000;
159 internal Document(Document doc)
162 this.buffer = new StringBuffer();
164 this.buffer = new StringBuffer(doc.buffer);
165 this.buffer.Update = new DocumentUpdateEventHandler(buffer_Update);
166 this.UpdateCalledAlways += (s, e) => { };
167 this.Update += new DocumentUpdateEventHandler((s, e) => { });
168 this.ChangeFireUpdateEvent += new EventHandler((s, e) => { });
169 this.Markers = new MarkerCollection(this);
170 this.UndoManager = new UndoManager();
171 this._LayoutLines = new LineToIndexTable(this);
172 this._LayoutLines.SpilitString = (s,e)=> {
173 return this.CreateLineList(e.index, e.length, MaximumLineLength);
175 this._LayoutLines.Clear();
176 this.MarkerPatternSet = new MarkerPatternSet(this._LayoutLines, this.Markers);
177 this.MarkerPatternSet.Updated += WacthDogPattern_Updated;
178 this.LineBreakChanged += (s, e) => { };
179 this.TabStopsChanged += (s, e) => { };
180 this.DrawLineNumberChanged += (s, e) => { };
181 this.Selections = new SelectCollection();
182 this.HideLineMarker = true;
183 this.HideRulerChanged += (s, e) => { };
184 this.CaretPostion = TextPoint.Null;
187 void WacthDogPattern_Updated(object sender, EventArgs e)
189 this._LayoutLines.ClearLayoutCache();
193 /// ラインマーカーを描くなら偽。そうでなければ真
195 public bool HideLineMarker
202 /// キャレットを描くなら偽。そうでなければ真
204 public bool HideCaret
211 /// 挿入モードなら真を返し、上書きモードなら偽を返す
213 public bool InsertMode
220 /// HideRulerの値が変わったときに通知します
222 public event EventHandler HideRulerChanged;
225 /// ルーラーを表示しないなら真、そうでないなら偽
227 public bool HideRuler
229 get { return this._HideRuler; }
232 this._HideRuler = value;
233 this.LayoutLines.ClearLayoutCache();
234 this.HideRulerChanged(this, null);
239 /// レイアウト行のどこにキャレットがあるかを表す
241 /// <remarks>この値を変更しても反映されないので、EditView側でAdjustCaret()メソッドを呼び出す必要があります</remarks>
242 public TextPoint CaretPostion
251 internal SelectCollection Selections
258 /// DrawLineNumberの値が変わったときに通知される
260 public event EventHandler DrawLineNumberChanged;
265 public bool DrawLineNumber
267 get { return this._DrawLineNumber; }
270 this._DrawLineNumber = value;
271 this._LayoutLines.ClearLayoutCache();
272 this.DrawLineNumberChanged(this, null);
277 /// URLをハイパーリンクとして表示するなら真。そうでないなら偽
281 get { return this._UrlMark; }
284 this._UrlMark = value;
287 Regex regex = new Regex("(http|https|ftp)(:\\/\\/[-_.!~*\\'()a-zA-Z0-9;\\/?:\\@&=+\\$,%#]+)");
288 this.MarkerPatternSet.Add(MarkerIDs.URL, new RegexMarkerPattern(regex, HilightType.Url, new Color()));
292 this.MarkerPatternSet.Remove(MarkerIDs.URL);
298 /// LineBreakが変更されたときに通知される
300 public EventHandler LineBreakChanged;
306 /// 変更した場合、呼び出し側で再描写とレイアウトの再構築を行う必要があります
308 public LineBreakMethod LineBreak
312 return this._LineBreak;
316 this._LineBreak = value;
317 this.LineBreakChanged(this, null);
322 /// 折り返し行う文字数。実際に折り返しが行われる幅はem単位×この値となります
324 /// <remarks>この値を変えた場合、LineBreakChangedイベントが発生します</remarks>
325 public int LineBreakCharCount
329 return this._LineBreakCharCount;
333 this._LineBreakCharCount = value;
334 this.LineBreakChanged(this, null);
339 /// TabStopsの値が変わったことを通知する
341 public event EventHandler TabStopsChanged;
346 /// <remarks>変更した場合、呼び出し側で再描写する必要があります</remarks>
349 get { return this._TabStops; }
351 this._TabStops = value;
352 this.TabStopsChanged(this, null);
359 public MarkerPatternSet MarkerPatternSet
368 public LineToIndexTable LayoutLines
372 return this._LayoutLines;
379 /// <param name="index">開始インデックス</param>
380 /// <param name="length">長さ</param>
381 /// <param name="lineLimitLength">1行当たりの最大文字数。-1で無制限</param>
382 /// <returns>レイアウト行リスト</returns>
383 internal IList<LineToIndexTableData> CreateLineList(int index, int length, int lineLimitLength = -1)
385 int startIndex = index;
386 int endIndex = index + length - 1;
387 List<LineToIndexTableData> output = new List<LineToIndexTableData>();
389 foreach (Tuple<int, int> range in this.ForEachLines(startIndex, endIndex, lineLimitLength))
391 int lineHeadIndex = range.Item1;
392 int lineLength = range.Item2;
393 char c = this.buffer[lineHeadIndex + lineLength - 1];
394 bool hasNewLine = c == Document.NewLine;
395 output.Add(this.LayoutLines.CreateLineToIndexTableData(lineHeadIndex, lineLength, hasNewLine, null));
398 if (output.Count > 0)
399 output.Last().LineEnd = true;
404 internal void FireUpdate(DocumentUpdateEventArgs e)
406 this.buffer_Update(this.buffer, e);
410 /// ドキュメントが更新された時に呼ばれるイベント
412 public event DocumentUpdateEventHandler Update;
415 /// ドキュメントが更新された時に呼びされるイベント
418 /// FireUpdateEventの値に関わらず常に呼びされます
420 internal event DocumentUpdateEventHandler UpdateCalledAlways;
423 /// FireUpdateEventの値が変わったときに呼び出されるイベント
425 public event EventHandler ChangeFireUpdateEvent;
430 public const char NewLine = '\n';
435 public const char EndOfFile = '\u001a';
438 /// ロック中なら真を返し、そうでないなら偽を返す
444 return this.Semaphore.CurrentCount == 0;
451 public UndoManager UndoManager
464 return this.buffer.Length;
469 /// 変更のたびにUpdateイベントを発生させるかどうか
471 public bool FireUpdateEvent
475 return this._EnableFireUpdateEvent;
479 this._EnableFireUpdateEvent = value;
480 this.ChangeFireUpdateEvent(this, null);
487 /// <param name="i">インデックス(自然数でなければならない)</param>
488 /// <returns>Char型</returns>
489 public char this[int i]
493 return this.buffer[i];
500 public MarkerCollection Markers
506 internal StringBuffer StringBuffer
515 /// DocumentReaderを作成します
517 /// <returns>DocumentReaderオブジェクト</returns>
518 public DocumentReader CreateReader()
520 return new DocumentReader(this.buffer);
528 this.Semaphore.Release();
536 this.Semaphore.Wait();
542 /// <returns>Taskオブジェクト</returns>
543 public Task LockAsync()
545 return this.Semaphore.WaitAsync();
551 /// <param name="id">マーカーID</param>
552 /// <param name="m">設定したいマーカー</param>
553 public void SetMarker(int id,Marker m)
555 if (m.start < 0 || m.start + m.length > this.Length)
556 throw new ArgumentOutOfRangeException("startもしくはendが指定できる範囲を超えています");
558 this.Markers.Add(id,m);
564 /// <param name="id">マーカーID</param>
565 /// <param name="start">開始インデックス</param>
566 /// <param name="length">削除する長さ</param>
567 public void RemoveMarker(int id,int start, int length)
569 if (start < 0 || start + length > this.Length)
570 throw new ArgumentOutOfRangeException("startもしくはendが指定できる範囲を超えています");
572 this.Markers.RemoveAll(id,start, length);
578 /// <param name="id">マーカーID</param>
579 /// <param name="type">削除したいマーカーのタイプ</param>
580 public void RemoveMarker(int id, HilightType type)
582 this.Markers.RemoveAll(id,type);
586 /// インデックスに対応するマーカーを得る
588 /// <param name="id">マーカーID</param>
589 /// <param name="index">インデックス</param>
590 /// <returns>Marker構造体の列挙子</returns>
591 public IEnumerable<Marker> GetMarkers(int id, int index)
593 if (index < 0 || index > this.Length)
594 throw new ArgumentOutOfRangeException("indexが範囲を超えています");
595 return this.Markers.Get(id,index);
601 /// <param name="index">開始インデックス</param>
602 /// <param name="length">長さ</param>
603 /// <returns>Stringオブジェクト</returns>
604 public string ToString(int index, int length)
606 return this.buffer.ToString(index, length);
610 /// インデックスを開始位置とする文字列を返す
612 /// <param name="index">開始インデックス</param>
613 /// <returns>Stringオブジェクト</returns>
614 public string ToString(int index)
616 return this.ToString(index, this.buffer.Length - index);
622 /// <param name="startIndex">開始インデックス</param>
623 /// <param name="endIndex">終了インデックス</param>
624 /// <param name="maxCharCount">最大長</param>
625 /// <returns>行イテレーターが返される</returns>
626 public IEnumerable<string> GetLines(int startIndex, int endIndex, int maxCharCount = -1)
628 return this.buffer.GetLines(startIndex, endIndex, maxCharCount);
631 internal IEnumerable<Tuple<int, int>> ForEachLines(int startIndex, int endIndex, int maxCharCount = -1)
633 return this.buffer.ForEachLines(startIndex, endIndex, maxCharCount);
640 /// <param name="s">追加したい文字列</param>
641 /// <remarks>非同期操作中はこのメソッドを実行することはできません</remarks>
642 public void Append(string s)
644 this.Replace(this.buffer.Length, 0, s);
650 /// <param name="index">開始インデックス</param>
651 /// <param name="s">追加したい文字列</param>
652 /// <remarks>読み出し操作中はこのメソッドを実行することはできません</remarks>
653 public void Insert(int index, string s)
655 this.Replace(index, 0, s);
661 /// <param name="index">開始インデックス</param>
662 /// <param name="length">長さ</param>
663 /// <remarks>読み出し操作中はこのメソッドを実行することはできません</remarks>
664 public void Remove(int index, int length)
666 this.Replace(index, length, "");
672 /// <param name="index">開始インデックス</param>
673 /// <param name="length">長さ</param>
674 /// <param name="s">文字列</param>
675 /// <remarks>読み出し操作中はこのメソッドを実行することはできません</remarks>
676 public void Replace(int index, int length, string s)
678 if (index < 0 || index > this.buffer.Length || index + length > this.buffer.Length || length < 0)
679 throw new ArgumentOutOfRangeException();
680 if (length == 0 && (s == string.Empty || s == null))
683 foreach(int id in this.Markers.IDs)
684 this.RemoveMarker(id,index, length);
686 ReplaceCommand cmd = new ReplaceCommand(this.buffer, index, length, s);
687 this.UndoManager.push(cmd);
694 /// <remarks>Dirtyフラグも同時にクリアーされます</remarks>
695 /// <remarks>非同期操作中はこのメソッドを実行することはできません</remarks>
702 /// ストリームからドキュメントを非同期的に構築します
704 /// <param name="fs">IStreamReaderオブジェクト</param>
705 /// <param name="tokenSource">キャンセルトークン</param>
706 /// <returns>Taskオブジェクト</returns>
708 /// 読み取り操作は別スレッドで行われます。
709 /// また、非同期操作中はこのメソッドを実行することはできません。
711 internal async Task LoadAsync(IStreamReader fs, CancellationTokenSource tokenSource = null)
718 await this.LockAsync().ConfigureAwait(false);
720 this.FireUpdateEvent = false;
721 await this.buffer.LoadAsync(fs, tokenSource);
725 this.FireUpdateEvent = true;
731 /// ストリームに非同期モードで保存します
733 /// <param name="fs">IStreamWriterオブジェクト</param>
734 /// <param name="tokenSource">キャンセルトークン</param>
735 /// <returns>Taskオブジェクト</returns>
736 /// <remarks>非同期操作中はこのメソッドを実行することはできません</remarks>
737 internal async Task SaveAsync(IStreamWriter fs, CancellationTokenSource tokenSource = null)
741 await this.LockAsync().ConfigureAwait(false);
742 StringBuilder line = new StringBuilder();
743 for (int i = 0; i < this.Length; i++)
747 if (c == Document.NewLine || i == this.Length - 1)
749 string str = line.ToString();
750 str = str.Replace(Document.NewLine.ToString(), fs.NewLine);
751 await fs.WriteAsync(str).ConfigureAwait(false);
753 if (tokenSource != null)
754 tokenSource.Token.ThrowIfCancellationRequested();
756 System.Threading.Thread.Sleep(10);
768 /// Find()およびReplaceAll()で使用するパラメーターをセットします
770 /// <param name="pattern">検索したい文字列</param>
771 /// <param name="UseRegex">正規表現を使用するなら真</param>
772 /// <param name="opt">RegexOptions列挙体</param>
773 public void SetFindParam(string pattern, bool UseRegex, RegexOptions opt)
777 this.regex = new Regex(pattern, opt);
779 this.regex = new Regex(Regex.Escape(pattern), opt);
783 /// 現在の検索パラメーターでWatchDogを生成する
785 /// <param name="type">ハイライトタイプ</param>
786 /// <param name="color">色</param>
787 /// <returns>WatchDogオブジェクト</returns>
788 public RegexMarkerPattern CreateWatchDogByFindParam(HilightType type,Color color)
790 if (this.regex == null)
791 throw new InvalidOperationException("SetFindParam()を呼び出してください");
792 return new RegexMarkerPattern(this.regex,type,color);
798 /// <returns>見つかった場合はSearchResult列挙子を返却します</returns>
799 /// <remarks>見つかったパターン以外を置き換えた場合、正常に動作しないことがあります</remarks>
800 public IEnumerator<SearchResult> Find()
802 return this.Find(0, this.Length);
808 /// <returns>見つかった場合はSearchResult列挙子を返却します</returns>
809 /// <param name="start">開始インデックス</param>
810 /// <param name="length">検索する長さ</param>
811 /// <remarks>見つかったパターン以外を置き換えた場合、正常に動作しないことがあります</remarks>
812 public IEnumerator<SearchResult> Find(int start, int length)
814 if (this.regex == null)
815 throw new InvalidOperationException();
816 if (start < 0 || start >= this.Length)
817 throw new ArgumentOutOfRangeException();
819 int end = start + length - 1;
821 if(end > this.Length - 1)
822 throw new ArgumentOutOfRangeException();
824 StringBuilder line = new StringBuilder();
825 int oldLength = this.Length;
826 for (int i = start; i <= end; i++)
830 if (c == Document.NewLine || i == end)
832 this.match = this.regex.Match(line.ToString());
833 while (this.match.Success)
835 int startIndex = i - line.Length + 1 + this.match.Index;
836 int endIndex = startIndex + this.match.Length - 1;
838 yield return new SearchResult(this.match, startIndex, endIndex);
840 if (this.Length != oldLength) //長さが変わった場合は置き換え後のパターンの終点+1まで戻る
842 int delta = this.Length - oldLength;
843 i = endIndex + delta;
845 oldLength = this.Length;
849 this.match = this.match.NextMatch();
857 /// 任意のパターンですべて置き換えます
859 /// <param name="replacePattern">置き換え後のパターン</param>
860 /// <param name="groupReplace">グループ置き換えを行うなら真。そうでないなら偽</param>
861 public void ReplaceAll(string replacePattern,bool groupReplace)
863 if (this.regex == null)
864 throw new InvalidOperationException();
865 ReplaceAllCommand cmd = new ReplaceAllCommand(this.buffer, this.LayoutLines, this.regex, replacePattern, groupReplace);
866 this.UndoManager.push(cmd);
873 /// <param name="target">対象となる文字列</param>
874 /// <param name="pattern">置き換え後の文字列</param>
875 /// <param name="ci">大文字も文字を区別しないなら真。そうでないなら偽</param>
877 /// 検索時に大文字小文字を区別します。また、このメソッドでは正規表現を使用することはできません
879 public void ReplaceAll2(string target, string pattern,bool ci = false)
881 FastReplaceAllCommand cmd = new FastReplaceAllCommand(this.buffer, this.LayoutLines, target, pattern,ci);
882 this.UndoManager.push(cmd);
886 #region IEnumerable<char> メンバー
891 /// <returns>IEnumeratorオブジェクトを返す</returns>
892 public IEnumerator<char> GetEnumerator()
894 return this.buffer.GetEnumerator();
899 #region IEnumerable メンバー
901 System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
903 throw new NotImplementedException();
908 void buffer_Update(object sender, DocumentUpdateEventArgs e)
912 case UpdateType.Replace:
914 this._LayoutLines.UpdateAsReplace(e.startIndex, e.removeLength, e.insertLength);
916 this._LayoutLines.UpdateLineAsReplace(e.row.Value, e.removeLength, e.insertLength);
918 case UpdateType.Clear:
919 this._LayoutLines.Clear();
922 this.UpdateCalledAlways(this, e);
923 if(this.FireUpdateEvent)
924 this.Update(this, e);
928 public interface IStreamReader
936 /// ストリームから行を読み取った物を返す。LoadAsyncを呼び出す場合は必ず実装してください
938 Task<string> ReadLineAsync();
940 /// ストリームから指定した文字数だけ読み取る
942 /// <param name="buffer">書き込み先バッファー</param>
943 /// <param name="index">書き込み先バッファーのインデックス</param>
944 /// <param name="count">読み取る文字数</param>
945 /// <returns>読み取った文字数</returns>
946 Task<int> ReadAsync(char[] buffer, int index, int count);
949 public interface IStreamWriter
952 /// ストリームに書き込む。SaveAsyncを呼び出す場合は必ず実装してください
954 Task WriteAsync(string str);
969 public class SearchResult
988 get { return this.Match.Value; }
994 /// <param name="replacement">置き換える文字列</param>
995 /// <returns>置き換え後の文字列</returns>
996 public string Result(string replacement)
998 return this.Match.Result(replacement);
1004 /// <param name="m">Matchオブジェクト</param>
1005 /// <param name="start">開始インデックス</param>
1006 /// <param name="end">終了インデックス</param>
1007 public SearchResult(Match m, int start,int end)
1018 public class DocumentReader : TextReader
1020 StringBuffer document;
1026 /// <param name="doc"></param>
1027 internal DocumentReader(StringBuffer doc)
1030 throw new ArgumentNullException();
1031 this.document = doc;
1037 /// <returns>文字。取得できない場合は-1</returns>
1038 public override int Peek()
1040 if (this.document == null)
1041 throw new InvalidOperationException();
1042 if (this.currentIndex >= this.document.Length)
1044 return this.document[this.currentIndex];
1048 /// 文字を取得し、イテレーターを一つ進める
1050 /// <returns>文字。取得できない場合は-1</returns>
1051 public override int Read()
1053 int c = this.Peek();
1055 this.currentIndex++;
1060 /// 文字列を読み取りバッファーに書き込む
1062 /// <param name="buffer">バッファー</param>
1063 /// <param name="index">開始インデックス</param>
1064 /// <param name="count">カウント</param>
1065 /// <returns>読み取られた文字数</returns>
1066 public override int Read(char[] buffer, int index, int count)
1068 if (this.document == null)
1069 throw new InvalidOperationException();
1072 throw new ArgumentNullException();
1074 if (this.document.Length < count)
1075 throw new ArgumentException();
1077 if (index < 0 || count < 0)
1078 throw new ArgumentOutOfRangeException();
1080 if (this.document.Length == 0)
1083 int actualCount = count;
1084 if (index + count - 1 > this.document.Length - 1)
1085 actualCount = this.document.Length - index;
1087 string str = this.document.ToString(index, actualCount);
1089 for (int i = 0; i < str.Length; i++) //ToCharArray()だと戻った時に消えてしまう
1092 this.currentIndex = index + actualCount;
1100 /// <param name="disposing">真ならアンマネージドリソースを解放する</param>
1101 protected override void Dispose(bool disposing)
1103 this.document = null;