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;
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) => { };
183 void WacthDogPattern_Updated(object sender, EventArgs e)
185 this._LayoutLines.ClearLayoutCache();
189 /// DrawLineNumberの値が変わったときに通知される
191 public event EventHandler DrawLineNumberChanged;
196 public bool DrawLineNumber
198 get { return this._DrawLineNumber; }
201 this._DrawLineNumber = value;
202 this._LayoutLines.ClearLayoutCache();
203 this.DrawLineNumberChanged(this, null);
208 /// URLをハイパーリンクとして表示するなら真。そうでないなら偽
212 get { return this._UrlMark; }
215 this._UrlMark = value;
218 Regex regex = new Regex("(http|https|ftp)(:\\/\\/[-_.!~*\\'()a-zA-Z0-9;\\/?:\\@&=+\\$,%#]+)");
219 this.MarkerPatternSet.Add(MarkerIDs.URL, new RegexMarkerPattern(regex, HilightType.Url, new Color()));
223 this.MarkerPatternSet.Remove(MarkerIDs.URL);
229 /// LineBreakが変更されたときに通知される
231 public EventHandler LineBreakChanged;
237 /// 変更した場合、呼び出し側で再描写とレイアウトの再構築を行う必要があります
239 public LineBreakMethod LineBreak
243 return this._LineBreak;
247 this._LineBreak = value;
248 this.LineBreakChanged(this, null);
253 /// 折り返し行う文字数。実際に折り返しが行われる幅はem単位×この値となります
255 /// <remarks>この値を変えた場合、LineBreakChangedイベントが発生します</remarks>
256 public int LineBreakCharCount
260 return this._LineBreakCharCount;
264 this._LineBreakCharCount = value;
265 this.LineBreakChanged(this, null);
270 /// TabStopsの値が変わったことを通知する
272 public event EventHandler TabStopsChanged;
277 /// <remarks>変更した場合、呼び出し側で再描写する必要があります</remarks>
280 get { return this._TabStops; }
282 this._TabStops = value;
283 this.TabStopsChanged(this, null);
290 public MarkerPatternSet MarkerPatternSet
299 public LineToIndexTable LayoutLines
303 return this._LayoutLines;
310 /// <param name="index">開始インデックス</param>
311 /// <param name="length">長さ</param>
312 /// <param name="lineLimitLength">1行当たりの最大文字数。-1で無制限</param>
313 /// <returns>レイアウト行リスト</returns>
314 internal IList<LineToIndexTableData> CreateLineList(int index, int length, int lineLimitLength = -1)
316 int startIndex = index;
317 int endIndex = index + length - 1;
318 List<LineToIndexTableData> output = new List<LineToIndexTableData>();
320 foreach (Tuple<int, int> range in this.ForEachLines(startIndex, endIndex, lineLimitLength))
322 int lineHeadIndex = range.Item1;
323 int lineLength = range.Item2;
324 char c = this.buffer[lineHeadIndex + lineLength - 1];
325 bool hasNewLine = c == Document.NewLine;
326 output.Add(this.LayoutLines.CreateLineToIndexTableData(lineHeadIndex, lineLength, hasNewLine, null));
329 if (output.Count > 0)
330 output.Last().LineEnd = true;
335 internal void FireUpdate(DocumentUpdateEventArgs e)
337 this.buffer_Update(this.buffer, e);
341 /// ドキュメントが更新された時に呼ばれるイベント
343 public event DocumentUpdateEventHandler Update;
346 /// ドキュメントが更新された時に呼びされるイベント
349 /// FireUpdateEventの値に関わらず常に呼びされます
351 internal event DocumentUpdateEventHandler UpdateCalledAlways;
354 /// FireUpdateEventの値が変わったときに呼び出されるイベント
356 public event EventHandler ChangeFireUpdateEvent;
361 public const char NewLine = '\n';
366 public const char EndOfFile = '\u001a';
369 /// ロック中なら真を返し、そうでないなら偽を返す
375 return this.Semaphore.CurrentCount == 0;
382 public UndoManager UndoManager
395 return this.buffer.Length;
400 /// 変更のたびにUpdateイベントを発生させるかどうか
402 public bool FireUpdateEvent
406 return this._EnableFireUpdateEvent;
410 this._EnableFireUpdateEvent = value;
411 this.ChangeFireUpdateEvent(this, null);
418 /// <param name="i">インデックス(自然数でなければならない)</param>
419 /// <returns>Char型</returns>
420 public char this[int i]
424 return this.buffer[i];
431 public MarkerCollection Markers
437 internal StringBuffer StringBuffer
446 /// DocumentReaderを作成します
448 /// <returns>DocumentReaderオブジェクト</returns>
449 public DocumentReader CreateReader()
451 return new DocumentReader(this.buffer);
459 this.Semaphore.Release();
467 this.Semaphore.Wait();
473 /// <returns>Taskオブジェクト</returns>
474 public Task LockAsync()
476 return this.Semaphore.WaitAsync();
482 /// <param name="id">マーカーID</param>
483 /// <param name="m">設定したいマーカー</param>
484 public void SetMarker(int id,Marker m)
486 if (m.start < 0 || m.start + m.length > this.Length)
487 throw new ArgumentOutOfRangeException("startもしくはendが指定できる範囲を超えています");
489 this.Markers.Add(id,m);
495 /// <param name="id">マーカーID</param>
496 /// <param name="start">開始インデックス</param>
497 /// <param name="length">削除する長さ</param>
498 public void RemoveMarker(int id,int start, int length)
500 if (start < 0 || start + length > this.Length)
501 throw new ArgumentOutOfRangeException("startもしくはendが指定できる範囲を超えています");
503 this.Markers.RemoveAll(id,start, length);
509 /// <param name="id">マーカーID</param>
510 /// <param name="type">削除したいマーカーのタイプ</param>
511 public void RemoveMarker(int id, HilightType type)
513 this.Markers.RemoveAll(id,type);
517 /// インデックスに対応するマーカーを得る
519 /// <param name="id">マーカーID</param>
520 /// <param name="index">インデックス</param>
521 /// <returns>Marker構造体の列挙子</returns>
522 public IEnumerable<Marker> GetMarkers(int id, int index)
524 if (index < 0 || index > this.Length)
525 throw new ArgumentOutOfRangeException("indexが範囲を超えています");
526 return this.Markers.Get(id,index);
532 /// <param name="index">開始インデックス</param>
533 /// <param name="length">長さ</param>
534 /// <returns>Stringオブジェクト</returns>
535 public string ToString(int index, int length)
537 return this.buffer.ToString(index, length);
541 /// インデックスを開始位置とする文字列を返す
543 /// <param name="index">開始インデックス</param>
544 /// <returns>Stringオブジェクト</returns>
545 public string ToString(int index)
547 return this.ToString(index, this.buffer.Length - index);
553 /// <param name="startIndex">開始インデックス</param>
554 /// <param name="endIndex">終了インデックス</param>
555 /// <param name="maxCharCount">最大長</param>
556 /// <returns>行イテレーターが返される</returns>
557 public IEnumerable<string> GetLines(int startIndex, int endIndex, int maxCharCount = -1)
559 return this.buffer.GetLines(startIndex, endIndex, maxCharCount);
562 internal IEnumerable<Tuple<int, int>> ForEachLines(int startIndex, int endIndex, int maxCharCount = -1)
564 return this.buffer.ForEachLines(startIndex, endIndex, maxCharCount);
571 /// <param name="s">追加したい文字列</param>
572 /// <remarks>非同期操作中はこのメソッドを実行することはできません</remarks>
573 public void Append(string s)
575 this.Replace(this.buffer.Length, 0, s);
581 /// <param name="index">開始インデックス</param>
582 /// <param name="s">追加したい文字列</param>
583 /// <remarks>読み出し操作中はこのメソッドを実行することはできません</remarks>
584 public void Insert(int index, string s)
586 this.Replace(index, 0, s);
592 /// <param name="index">開始インデックス</param>
593 /// <param name="length">長さ</param>
594 /// <remarks>読み出し操作中はこのメソッドを実行することはできません</remarks>
595 public void Remove(int index, int length)
597 this.Replace(index, length, "");
603 /// <param name="index">開始インデックス</param>
604 /// <param name="length">長さ</param>
605 /// <param name="s">文字列</param>
606 /// <remarks>読み出し操作中はこのメソッドを実行することはできません</remarks>
607 public void Replace(int index, int length, string s)
609 if (index < 0 || index > this.buffer.Length || index + length > this.buffer.Length || length < 0)
610 throw new ArgumentOutOfRangeException();
611 if (length == 0 && (s == string.Empty || s == null))
614 foreach(int id in this.Markers.IDs)
615 this.RemoveMarker(id,index, length);
617 ReplaceCommand cmd = new ReplaceCommand(this.buffer, index, length, s);
618 this.UndoManager.push(cmd);
625 /// <remarks>Dirtyフラグも同時にクリアーされます</remarks>
626 /// <remarks>非同期操作中はこのメソッドを実行することはできません</remarks>
633 /// ストリームからドキュメントを非同期的に構築します
635 /// <param name="fs">IStreamReaderオブジェクト</param>
636 /// <param name="tokenSource">キャンセルトークン</param>
637 /// <returns>Taskオブジェクト</returns>
639 /// 読み取り操作は別スレッドで行われます。
640 /// また、非同期操作中はこのメソッドを実行することはできません。
642 internal async Task LoadAsync(IStreamReader fs, CancellationTokenSource tokenSource = null)
649 await this.LockAsync().ConfigureAwait(false);
651 this.FireUpdateEvent = false;
652 await this.buffer.LoadAsync(fs, tokenSource);
656 this.FireUpdateEvent = true;
662 /// ストリームに非同期モードで保存します
664 /// <param name="fs">IStreamWriterオブジェクト</param>
665 /// <param name="tokenSource">キャンセルトークン</param>
666 /// <returns>Taskオブジェクト</returns>
667 /// <remarks>非同期操作中はこのメソッドを実行することはできません</remarks>
668 internal async Task SaveAsync(IStreamWriter fs, CancellationTokenSource tokenSource = null)
672 await this.LockAsync().ConfigureAwait(false);
673 StringBuilder line = new StringBuilder();
674 for (int i = 0; i < this.Length; i++)
678 if (c == Document.NewLine || i == this.Length - 1)
680 string str = line.ToString();
681 str = str.Replace(Document.NewLine.ToString(), fs.NewLine);
682 await fs.WriteAsync(str).ConfigureAwait(false);
684 if (tokenSource != null)
685 tokenSource.Token.ThrowIfCancellationRequested();
687 System.Threading.Thread.Sleep(10);
699 /// Find()およびReplaceAll()で使用するパラメーターをセットします
701 /// <param name="pattern">検索したい文字列</param>
702 /// <param name="UseRegex">正規表現を使用するなら真</param>
703 /// <param name="opt">RegexOptions列挙体</param>
704 public void SetFindParam(string pattern, bool UseRegex, RegexOptions opt)
708 this.regex = new Regex(pattern, opt);
710 this.regex = new Regex(Regex.Escape(pattern), opt);
714 /// 現在の検索パラメーターでWatchDogを生成する
716 /// <param name="type">ハイライトタイプ</param>
717 /// <param name="color">色</param>
718 /// <returns>WatchDogオブジェクト</returns>
719 public RegexMarkerPattern CreateWatchDogByFindParam(HilightType type,Color color)
721 if (this.regex == null)
722 throw new InvalidOperationException("SetFindParam()を呼び出してください");
723 return new RegexMarkerPattern(this.regex,type,color);
729 /// <returns>見つかった場合はSearchResult列挙子を返却します</returns>
730 /// <remarks>見つかったパターン以外を置き換えた場合、正常に動作しないことがあります</remarks>
731 public IEnumerator<SearchResult> Find()
733 return this.Find(0, this.Length);
739 /// <returns>見つかった場合はSearchResult列挙子を返却します</returns>
740 /// <param name="start">開始インデックス</param>
741 /// <param name="length">検索する長さ</param>
742 /// <remarks>見つかったパターン以外を置き換えた場合、正常に動作しないことがあります</remarks>
743 public IEnumerator<SearchResult> Find(int start, int length)
745 if (this.regex == null)
746 throw new InvalidOperationException();
747 if (start < 0 || start >= this.Length)
748 throw new ArgumentOutOfRangeException();
750 int end = start + length - 1;
752 if(end > this.Length - 1)
753 throw new ArgumentOutOfRangeException();
755 StringBuilder line = new StringBuilder();
756 int oldLength = this.Length;
757 for (int i = start; i <= end; i++)
761 if (c == Document.NewLine || i == end)
763 this.match = this.regex.Match(line.ToString());
764 while (this.match.Success)
766 int startIndex = i - line.Length + 1 + this.match.Index;
767 int endIndex = startIndex + this.match.Length - 1;
769 yield return new SearchResult(this.match, startIndex, endIndex);
771 if (this.Length != oldLength) //長さが変わった場合は置き換え後のパターンの終点+1まで戻る
773 int delta = this.Length - oldLength;
774 i = endIndex + delta;
776 oldLength = this.Length;
780 this.match = this.match.NextMatch();
788 /// 任意のパターンですべて置き換えます
790 /// <param name="replacePattern">置き換え後のパターン</param>
791 /// <param name="groupReplace">グループ置き換えを行うなら真。そうでないなら偽</param>
792 public void ReplaceAll(string replacePattern,bool groupReplace)
794 if (this.regex == null)
795 throw new InvalidOperationException();
796 ReplaceAllCommand cmd = new ReplaceAllCommand(this.buffer, this.LayoutLines, this.regex, replacePattern, groupReplace);
797 this.UndoManager.push(cmd);
804 /// <param name="target">対象となる文字列</param>
805 /// <param name="pattern">置き換え後の文字列</param>
806 /// <param name="ci">大文字も文字を区別しないなら真。そうでないなら偽</param>
808 /// 検索時に大文字小文字を区別します。また、このメソッドでは正規表現を使用することはできません
810 public void ReplaceAll2(string target, string pattern,bool ci = false)
812 FastReplaceAllCommand cmd = new FastReplaceAllCommand(this.buffer, this.LayoutLines, target, pattern,ci);
813 this.UndoManager.push(cmd);
817 #region IEnumerable<char> メンバー
822 /// <returns>IEnumeratorオブジェクトを返す</returns>
823 public IEnumerator<char> GetEnumerator()
825 return this.buffer.GetEnumerator();
830 #region IEnumerable メンバー
832 System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
834 throw new NotImplementedException();
839 void buffer_Update(object sender, DocumentUpdateEventArgs e)
843 case UpdateType.Replace:
845 this._LayoutLines.UpdateAsReplace(e.startIndex, e.removeLength, e.insertLength);
847 this._LayoutLines.UpdateLineAsReplace(e.row.Value, e.removeLength, e.insertLength);
849 case UpdateType.Clear:
850 this._LayoutLines.Clear();
853 this.UpdateCalledAlways(this, e);
854 if(this.FireUpdateEvent)
855 this.Update(this, e);
859 public interface IStreamReader
867 /// ストリームから行を読み取った物を返す。LoadAsyncを呼び出す場合は必ず実装してください
869 Task<string> ReadLineAsync();
871 /// ストリームから指定した文字数だけ読み取る
873 /// <param name="buffer">書き込み先バッファー</param>
874 /// <param name="index">書き込み先バッファーのインデックス</param>
875 /// <param name="count">読み取る文字数</param>
876 /// <returns>読み取った文字数</returns>
877 Task<int> ReadAsync(char[] buffer, int index, int count);
880 public interface IStreamWriter
883 /// ストリームに書き込む。SaveAsyncを呼び出す場合は必ず実装してください
885 Task WriteAsync(string str);
900 public class SearchResult
919 get { return this.Match.Value; }
925 /// <param name="replacement">置き換える文字列</param>
926 /// <returns>置き換え後の文字列</returns>
927 public string Result(string replacement)
929 return this.Match.Result(replacement);
935 /// <param name="m">Matchオブジェクト</param>
936 /// <param name="start">開始インデックス</param>
937 /// <param name="end">終了インデックス</param>
938 public SearchResult(Match m, int start,int end)
949 public class DocumentReader : TextReader
951 StringBuffer document;
957 /// <param name="doc"></param>
958 internal DocumentReader(StringBuffer doc)
961 throw new ArgumentNullException();
968 /// <returns>文字。取得できない場合は-1</returns>
969 public override int Peek()
971 if (this.document == null)
972 throw new InvalidOperationException();
973 if (this.currentIndex >= this.document.Length)
975 return this.document[this.currentIndex];
979 /// 文字を取得し、イテレーターを一つ進める
981 /// <returns>文字。取得できない場合は-1</returns>
982 public override int Read()
991 /// 文字列を読み取りバッファーに書き込む
993 /// <param name="buffer">バッファー</param>
994 /// <param name="index">開始インデックス</param>
995 /// <param name="count">カウント</param>
996 /// <returns>読み取られた文字数</returns>
997 public override int Read(char[] buffer, int index, int count)
999 if (this.document == null)
1000 throw new InvalidOperationException();
1003 throw new ArgumentNullException();
1005 if (this.document.Length < count)
1006 throw new ArgumentException();
1008 if (index < 0 || count < 0)
1009 throw new ArgumentOutOfRangeException();
1011 if (this.document.Length == 0)
1014 int actualCount = count;
1015 if (index + count - 1 > this.document.Length - 1)
1016 actualCount = this.document.Length - index;
1018 string str = this.document.ToString(index, actualCount);
1020 for (int i = 0; i < str.Length; i++) //ToCharArray()だと戻った時に消えてしまう
1023 this.currentIndex = index + actualCount;
1031 /// <param name="disposing">真ならアンマネージドリソースを解放する</param>
1032 protected override void Dispose(bool disposing)
1034 this.document = null;