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 const int EmptyValue = -1;
92 public UpdateType type;
96 public int startIndex;
100 public int removeLength;
104 public int insertLength;
106 /// 更新イベントが発生した行。行が不明な場合や行をまたぐ場合はnullを指定すること。
112 /// <param name="type">更新タイプ</param>
113 /// <param name="startIndex">開始インデックス</param>
114 /// <param name="removeLength">削除された長さ</param>
115 /// <param name="insertLength">追加された長さ</param>
116 /// <param name="row">開始行。nullを指定することができる</param>
117 public DocumentUpdateEventArgs(UpdateType type, int startIndex = EmptyValue, int removeLength = EmptyValue, int insertLength = EmptyValue, int? row = null)
120 this.startIndex = startIndex;
121 this.removeLength = removeLength;
122 this.insertLength = insertLength;
128 /// ドキュメントに更新があったことを伝えるためのデリゲート
130 /// <param name="sender">送信元クラス</param>
131 /// <param name="e">イベントデータ</param>
132 public delegate void DocumentUpdateEventHandler(object sender, DocumentUpdateEventArgs e);
137 /// <remarks>この型のすべてのメソッド・プロパティはスレッドセーフです</remarks>
138 public sealed class Document : IEnumerable<char>, IRandomEnumrator<char>
140 const int MaxSemaphoreCount = 1;
144 LineToIndexTable _LayoutLines;
145 bool _EnableFireUpdateEvent = true,_UrlMark = false, _DrawLineNumber = false, _HideRuler = true, _RightToLeft = false;
146 SemaphoreSlim Semaphore = new SemaphoreSlim(MaxSemaphoreCount);
147 LineBreakMethod _LineBreak;
148 int _TabStops, _LineBreakCharCount = 80;
149 bool _ShowFullSpace, _ShowHalfSpace, _ShowTab, _ShowLineBreak;
154 public const int MaximumLineLength = 1000;
167 /// <param name="doc">ドキュメントオブジェクト</param>
168 /// <remarks>docが複製されますが、プロパティは引き継がれません</remarks>
169 internal Document(Document doc)
172 this.buffer = new StringBuffer();
174 this.buffer = new StringBuffer(doc.buffer);
175 this.buffer.Update = new DocumentUpdateEventHandler(buffer_Update);
176 this.UpdateCalledAlways += (s, e) => { };
177 this.Update += new DocumentUpdateEventHandler((s, e) => { });
178 this.ChangeFireUpdateEvent += new EventHandler((s, e) => { });
179 this.Markers = new MarkerCollection();
180 this.UndoManager = new UndoManager();
181 this._LayoutLines = new LineToIndexTable(this);
182 this._LayoutLines.SpilitString = (s,e)=> {
183 return this.CreateLineList(e.index, e.length, MaximumLineLength);
185 this._LayoutLines.Clear();
186 this.MarkerPatternSet = new MarkerPatternSet(this._LayoutLines, this.Markers);
187 this.MarkerPatternSet.Updated += WacthDogPattern_Updated;
188 this.Selections = new SelectCollection();
189 this.CaretPostion = TextPoint.Null;
190 this.HideLineMarker = true;
191 this.SelectGrippers = new GripperRectangle(new Gripper(), new Gripper());
194 void WacthDogPattern_Updated(object sender, EventArgs e)
196 this._LayoutLines.ClearLayoutCache();
209 /// ルーラーやキャレット・行番号などの表示すべきものが変化した場合に呼び出される。ドキュメントの内容が変化した通知を受け取り場合はUpdateを使用してください
211 public event EventHandler StatusUpdate;
216 public bool ShowFullSpace
218 get { return this._ShowFullSpace; }
221 this._ShowFullSpace = value;
222 this.StatusUpdate(this, null);
229 public bool ShowHalfSpace
231 get { return this._ShowHalfSpace; }
234 this._ShowHalfSpace = value;
235 this.StatusUpdate(this, null);
244 get { return this._ShowTab; }
247 this._ShowTab = value;
248 this.StatusUpdate(this, null);
255 public bool ShowLineBreak
257 get { return this._ShowLineBreak; }
260 this._ShowLineBreak = value;
261 this.StatusUpdate(this, null);
268 internal GripperRectangle SelectGrippers
277 public bool RightToLeft {
278 get { return this._RightToLeft; }
281 this._RightToLeft = value;
282 this.StatusUpdate(this, null);
287 /// 矩形選択モードなら真を返し、そうでない場合は偽を返す
289 public bool RectSelection
298 public IndentMode IndentMode
305 /// ラインマーカーを描くなら偽。そうでなければ真
307 public bool HideLineMarker
314 /// キャレットを描くなら偽。そうでなければ真
316 public bool HideCaret
323 /// 挿入モードなら真を返し、上書きモードなら偽を返す
325 public bool InsertMode
332 /// ルーラーを表示しないなら真、そうでないなら偽
334 public bool HideRuler
336 get { return this._HideRuler; }
339 this._HideRuler = value;
340 this.LayoutLines.ClearLayoutCache();
341 this.StatusUpdate(this, null);
346 /// レイアウト行のどこにキャレットがあるかを表す
348 /// <remarks>この値を変更しても反映されないので、EditView側でAdjustCaret()メソッドを呼び出す必要があります</remarks>
349 public TextPoint CaretPostion
358 internal SelectCollection Selections
367 public bool DrawLineNumber
369 get { return this._DrawLineNumber; }
372 this._DrawLineNumber = value;
373 this._LayoutLines.ClearLayoutCache();
374 this.StatusUpdate(this, null);
379 /// URLをハイパーリンクとして表示するなら真。そうでないなら偽
383 get { return this._UrlMark; }
386 this._UrlMark = value;
389 Regex regex = new Regex("(http|https|ftp)(:\\/\\/[-_.!~*\\'()a-zA-Z0-9;\\/?:\\@&=+\\$,%#]+)");
390 this.MarkerPatternSet.Add(MarkerIDs.URL, new RegexMarkerPattern(regex, HilightType.Url, new Color()));
394 this.MarkerPatternSet.Remove(MarkerIDs.URL);
399 public event EventHandler LineBreakChanged;
405 /// 変更した場合、呼び出し側で再描写とレイアウトの再構築を行う必要があります
406 /// また、StatusUpdatedではなく、LineBreakChangedイベントが発生します
408 public LineBreakMethod LineBreak
412 return this._LineBreak;
416 this._LineBreak = value;
417 this.LineBreakChanged(this, null);
422 /// 折り返し行う文字数。実際に折り返しが行われる幅はem単位×この値となります
424 /// <remarks>この値を変えた場合、LineBreakChangedイベントが発生します</remarks>
425 public int LineBreakCharCount
429 return this._LineBreakCharCount;
433 this._LineBreakCharCount = value;
434 this.LineBreakChanged(this, null);
441 /// <remarks>変更した場合、呼び出し側で再描写する必要があります</remarks>
444 get { return this._TabStops; }
446 this._TabStops = value;
447 this.StatusUpdate(this, null);
454 public MarkerPatternSet MarkerPatternSet
463 public LineToIndexTable LayoutLines
467 return this._LayoutLines;
474 /// <param name="index">開始インデックス</param>
475 /// <param name="length">長さ</param>
476 /// <param name="lineLimitLength">1行当たりの最大文字数。-1で無制限</param>
477 /// <returns>レイアウト行リスト</returns>
478 internal IList<LineToIndexTableData> CreateLineList(int index, int length, int lineLimitLength = -1)
480 int startIndex = index;
481 int endIndex = index + length - 1;
482 List<LineToIndexTableData> output = new List<LineToIndexTableData>();
484 foreach (Tuple<int, int> range in this.ForEachLines(startIndex, endIndex, lineLimitLength))
486 int lineHeadIndex = range.Item1;
487 int lineLength = range.Item2;
488 char c = this.buffer[lineHeadIndex + lineLength - 1];
489 bool hasNewLine = c == Document.NewLine;
490 output.Add(this.LayoutLines.CreateLineToIndexTableData(lineHeadIndex, lineLength, hasNewLine, null));
493 if (output.Count > 0)
494 output.Last().LineEnd = true;
499 internal void FireUpdate(DocumentUpdateEventArgs e)
501 this.buffer_Update(this.buffer, e);
505 /// ドキュメントが更新された時に呼ばれるイベント
507 public event DocumentUpdateEventHandler Update;
510 /// ドキュメントが更新された時に呼びされるイベント
513 /// FireUpdateEventの値に関わらず常に呼びされます
515 internal event DocumentUpdateEventHandler UpdateCalledAlways;
518 /// FireUpdateEventの値が変わったときに呼び出されるイベント
520 public event EventHandler ChangeFireUpdateEvent;
525 public const char NewLine = '\n';
530 public const char EndOfFile = '\u001a';
533 /// ロック中なら真を返し、そうでないなら偽を返す
539 return this.Semaphore.CurrentCount == 0;
546 public UndoManager UndoManager
559 return this.buffer.Length;
564 /// 変更のたびにUpdateイベントを発生させるかどうか
566 public bool FireUpdateEvent
570 return this._EnableFireUpdateEvent;
574 this._EnableFireUpdateEvent = value;
575 this.ChangeFireUpdateEvent(this, null);
582 /// <param name="i">インデックス(自然数でなければならない)</param>
583 /// <returns>Char型</returns>
584 public char this[int i]
588 return this.buffer[i];
595 public MarkerCollection Markers
601 internal StringBuffer StringBuffer
610 /// DocumentReaderを作成します
612 /// <returns>DocumentReaderオブジェクト</returns>
613 public DocumentReader CreateReader()
615 return new DocumentReader(this.buffer);
623 this.Semaphore.Release();
631 this.Semaphore.Wait();
637 /// <returns>Taskオブジェクト</returns>
638 public Task LockAsync()
640 return this.Semaphore.WaitAsync();
646 /// <param name="id">マーカーID</param>
647 /// <param name="m">設定したいマーカー</param>
648 public void SetMarker(int id,Marker m)
650 if (m.start < 0 || m.start + m.length > this.Length)
651 throw new ArgumentOutOfRangeException("startもしくはendが指定できる範囲を超えています");
653 this.Markers.Add(id,m);
659 /// <param name="id">マーカーID</param>
660 /// <param name="start">開始インデックス</param>
661 /// <param name="length">削除する長さ</param>
662 public void RemoveMarker(int id,int start, int length)
664 if (start < 0 || start + length > this.Length)
665 throw new ArgumentOutOfRangeException("startもしくはendが指定できる範囲を超えています");
667 this.Markers.RemoveAll(id,start, length);
673 /// <param name="id">マーカーID</param>
674 /// <param name="type">削除したいマーカーのタイプ</param>
675 public void RemoveMarker(int id, HilightType type)
677 this.Markers.RemoveAll(id,type);
681 /// インデックスに対応するマーカーを得る
683 /// <param name="id">マーカーID</param>
684 /// <param name="index">インデックス</param>
685 /// <returns>Marker構造体の列挙子</returns>
686 public IEnumerable<Marker> GetMarkers(int id, int index)
688 if (index < 0 || index > this.Length)
689 throw new ArgumentOutOfRangeException("indexが範囲を超えています");
690 return this.Markers.Get(id,index);
696 /// <param name="index">開始インデックス</param>
697 /// <param name="length">長さ</param>
698 /// <returns>Stringオブジェクト</returns>
699 public string ToString(int index, int length)
701 return this.buffer.ToString(index, length);
705 /// インデックスを開始位置とする文字列を返す
707 /// <param name="index">開始インデックス</param>
708 /// <returns>Stringオブジェクト</returns>
709 public string ToString(int index)
711 return this.ToString(index, this.buffer.Length - index);
717 /// <param name="startIndex">開始インデックス</param>
718 /// <param name="endIndex">終了インデックス</param>
719 /// <param name="maxCharCount">最大長</param>
720 /// <returns>行イテレーターが返される</returns>
721 public IEnumerable<string> GetLines(int startIndex, int endIndex, int maxCharCount = -1)
723 return this.buffer.GetLines(startIndex, endIndex, maxCharCount);
726 internal IEnumerable<Tuple<int, int>> ForEachLines(int startIndex, int endIndex, int maxCharCount = -1)
728 return this.buffer.ForEachLines(startIndex, endIndex, maxCharCount);
735 /// <param name="s">追加したい文字列</param>
736 /// <remarks>非同期操作中はこのメソッドを実行することはできません</remarks>
737 public void Append(string s)
739 this.Replace(this.buffer.Length, 0, s);
745 /// <param name="index">開始インデックス</param>
746 /// <param name="s">追加したい文字列</param>
747 /// <remarks>読み出し操作中はこのメソッドを実行することはできません</remarks>
748 public void Insert(int index, string s)
750 this.Replace(index, 0, s);
756 /// <param name="index">開始インデックス</param>
757 /// <param name="length">長さ</param>
758 /// <remarks>読み出し操作中はこのメソッドを実行することはできません</remarks>
759 public void Remove(int index, int length)
761 this.Replace(index, length, "");
767 /// <param name="index">開始インデックス</param>
768 /// <param name="length">長さ</param>
769 /// <param name="s">文字列</param>
770 /// <remarks>読み出し操作中はこのメソッドを実行することはできません</remarks>
771 public void Replace(int index, int length, string s)
773 if (index < 0 || index > this.buffer.Length || index + length > this.buffer.Length || length < 0)
774 throw new ArgumentOutOfRangeException();
775 if (length == 0 && (s == string.Empty || s == null))
778 foreach(int id in this.Markers.IDs)
779 this.RemoveMarker(id,index, length);
781 ReplaceCommand cmd = new ReplaceCommand(this.buffer, index, length, s);
782 this.UndoManager.push(cmd);
789 /// <remarks>Dirtyフラグも同時にクリアーされます</remarks>
790 /// <remarks>非同期操作中はこのメソッドを実行することはできません</remarks>
797 /// ストリームからドキュメントを非同期的に構築します
799 /// <param name="fs">IStreamReaderオブジェクト</param>
800 /// <param name="tokenSource">キャンセルトークン</param>
801 /// <returns>Taskオブジェクト</returns>
803 /// 読み取り操作は別スレッドで行われます。
804 /// また、非同期操作中はこのメソッドを実行することはできません。
806 internal async Task LoadAsync(IStreamReader fs, CancellationTokenSource tokenSource = null)
813 await this.LockAsync().ConfigureAwait(false);
815 this.FireUpdateEvent = false;
816 await this.buffer.LoadAsync(fs, tokenSource);
820 this.FireUpdateEvent = true;
826 /// ストリームに非同期モードで保存します
828 /// <param name="fs">IStreamWriterオブジェクト</param>
829 /// <param name="tokenSource">キャンセルトークン</param>
830 /// <returns>Taskオブジェクト</returns>
831 /// <remarks>非同期操作中はこのメソッドを実行することはできません</remarks>
832 internal async Task SaveAsync(IStreamWriter fs, CancellationTokenSource tokenSource = null)
836 await this.LockAsync().ConfigureAwait(false);
837 StringBuilder line = new StringBuilder();
838 for (int i = 0; i < this.Length; i++)
842 if (c == Document.NewLine || i == this.Length - 1)
844 string str = line.ToString();
845 str = str.Replace(Document.NewLine.ToString(), fs.NewLine);
846 await fs.WriteAsync(str).ConfigureAwait(false);
848 if (tokenSource != null)
849 tokenSource.Token.ThrowIfCancellationRequested();
851 System.Threading.Thread.Sleep(10);
863 /// Find()およびReplaceAll()で使用するパラメーターをセットします
865 /// <param name="pattern">検索したい文字列</param>
866 /// <param name="UseRegex">正規表現を使用するなら真</param>
867 /// <param name="opt">RegexOptions列挙体</param>
868 public void SetFindParam(string pattern, bool UseRegex, RegexOptions opt)
872 this.regex = new Regex(pattern, opt);
874 this.regex = new Regex(Regex.Escape(pattern), opt);
878 /// 現在の検索パラメーターでWatchDogを生成する
880 /// <param name="type">ハイライトタイプ</param>
881 /// <param name="color">色</param>
882 /// <returns>WatchDogオブジェクト</returns>
883 public RegexMarkerPattern CreateWatchDogByFindParam(HilightType type,Color color)
885 if (this.regex == null)
886 throw new InvalidOperationException("SetFindParam()を呼び出してください");
887 return new RegexMarkerPattern(this.regex,type,color);
893 /// <returns>見つかった場合はSearchResult列挙子を返却します</returns>
894 /// <remarks>見つかったパターン以外を置き換えた場合、正常に動作しないことがあります</remarks>
895 public IEnumerator<SearchResult> Find()
897 return this.Find(0, this.Length);
903 /// <returns>見つかった場合はSearchResult列挙子を返却します</returns>
904 /// <param name="start">開始インデックス</param>
905 /// <param name="length">検索する長さ</param>
906 /// <remarks>見つかったパターン以外を置き換えた場合、正常に動作しないことがあります</remarks>
907 public IEnumerator<SearchResult> Find(int start, int length)
909 if (this.regex == null)
910 throw new InvalidOperationException();
911 if (start < 0 || start >= this.Length)
912 throw new ArgumentOutOfRangeException();
914 int end = start + length - 1;
916 if(end > this.Length - 1)
917 throw new ArgumentOutOfRangeException();
919 StringBuilder line = new StringBuilder();
920 int oldLength = this.Length;
921 for (int i = start; i <= end; i++)
925 if (c == Document.NewLine || i == end)
927 this.match = this.regex.Match(line.ToString());
928 while (this.match.Success)
930 int startIndex = i - line.Length + 1 + this.match.Index;
931 int endIndex = startIndex + this.match.Length - 1;
933 yield return new SearchResult(this.match, startIndex, endIndex);
935 if (this.Length != oldLength) //長さが変わった場合は置き換え後のパターンの終点+1まで戻る
937 int delta = this.Length - oldLength;
938 i = endIndex + delta;
940 oldLength = this.Length;
944 this.match = this.match.NextMatch();
952 /// 任意のパターンですべて置き換えます
954 /// <param name="replacePattern">置き換え後のパターン</param>
955 /// <param name="groupReplace">グループ置き換えを行うなら真。そうでないなら偽</param>
956 public void ReplaceAll(string replacePattern,bool groupReplace)
958 if (this.regex == null)
959 throw new InvalidOperationException();
960 ReplaceAllCommand cmd = new ReplaceAllCommand(this.buffer, this.LayoutLines, this.regex, replacePattern, groupReplace);
961 this.UndoManager.push(cmd);
968 /// <param name="target">対象となる文字列</param>
969 /// <param name="pattern">置き換え後の文字列</param>
970 /// <param name="ci">大文字も文字を区別しないなら真。そうでないなら偽</param>
972 /// 検索時に大文字小文字を区別します。また、このメソッドでは正規表現を使用することはできません
974 public void ReplaceAll2(string target, string pattern,bool ci = false)
976 FastReplaceAllCommand cmd = new FastReplaceAllCommand(this.buffer, this.LayoutLines, target, pattern,ci);
977 this.UndoManager.push(cmd);
981 #region IEnumerable<char> メンバー
986 /// <returns>IEnumeratorオブジェクトを返す</returns>
987 public IEnumerator<char> GetEnumerator()
989 return this.buffer.GetEnumerator();
994 #region IEnumerable メンバー
996 System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
998 throw new NotImplementedException();
1003 void buffer_Update(object sender, DocumentUpdateEventArgs e)
1007 case UpdateType.Replace:
1010 this._LayoutLines.UpdateAsReplace(e.startIndex, e.removeLength, e.insertLength);
1011 this.Markers.UpdateMarkers(e.startIndex, e.insertLength, e.removeLength);
1015 this._LayoutLines.UpdateLineAsReplace(e.row.Value, e.removeLength, e.insertLength);
1016 this.Markers.UpdateMarkers(this.LayoutLines.GetIndexFromLineNumber(e.row.Value), e.insertLength, e.removeLength);
1019 case UpdateType.Clear:
1020 this._LayoutLines.Clear();
1023 this.UpdateCalledAlways(this, e);
1024 if(this.FireUpdateEvent)
1025 this.Update(this, e);
1029 public interface IStreamReader
1037 /// ストリームから行を読み取った物を返す。LoadAsyncを呼び出す場合は必ず実装してください
1039 Task<string> ReadLineAsync();
1041 /// ストリームから指定した文字数だけ読み取る
1043 /// <param name="buffer">書き込み先バッファー</param>
1044 /// <param name="index">書き込み先バッファーのインデックス</param>
1045 /// <param name="count">読み取る文字数</param>
1046 /// <returns>読み取った文字数</returns>
1047 Task<int> ReadAsync(char[] buffer, int index, int count);
1050 public interface IStreamWriter
1053 /// ストリームに書き込む。SaveAsyncを呼び出す場合は必ず実装してください
1055 Task WriteAsync(string str);
1070 public class SearchResult
1072 private Match Match;
1089 get { return this.Match.Value; }
1093 /// 指定したパターンを置き換えて返す
1095 /// <param name="replacement">置き換える文字列</param>
1096 /// <returns>置き換え後の文字列</returns>
1097 public string Result(string replacement)
1099 return this.Match.Result(replacement);
1105 /// <param name="m">Matchオブジェクト</param>
1106 /// <param name="start">開始インデックス</param>
1107 /// <param name="end">終了インデックス</param>
1108 public SearchResult(Match m, int start,int end)
1119 public class DocumentReader : TextReader
1121 StringBuffer document;
1127 /// <param name="doc"></param>
1128 internal DocumentReader(StringBuffer doc)
1131 throw new ArgumentNullException();
1132 this.document = doc;
1138 /// <returns>文字。取得できない場合は-1</returns>
1139 public override int Peek()
1141 if (this.document == null)
1142 throw new InvalidOperationException();
1143 if (this.currentIndex >= this.document.Length)
1145 return this.document[this.currentIndex];
1149 /// 文字を取得し、イテレーターを一つ進める
1151 /// <returns>文字。取得できない場合は-1</returns>
1152 public override int Read()
1154 int c = this.Peek();
1156 this.currentIndex++;
1161 /// 文字列を読み取りバッファーに書き込む
1163 /// <param name="buffer">バッファー</param>
1164 /// <param name="index">開始インデックス</param>
1165 /// <param name="count">カウント</param>
1166 /// <returns>読み取られた文字数</returns>
1167 public override int Read(char[] buffer, int index, int count)
1169 if (this.document == null)
1170 throw new InvalidOperationException();
1173 throw new ArgumentNullException();
1175 if (this.document.Length < count)
1176 throw new ArgumentException();
1178 if (index < 0 || count < 0)
1179 throw new ArgumentOutOfRangeException();
1181 if (this.document.Length == 0)
1184 int actualCount = count;
1185 if (index + count - 1 > this.document.Length - 1)
1186 actualCount = this.document.Length - index;
1188 string str = this.document.ToString(index, actualCount);
1190 for (int i = 0; i < str.Length; i++) //ToCharArray()だと戻った時に消えてしまう
1193 this.currentIndex = index + actualCount;
1201 /// <param name="disposing">真ならアンマネージドリソースを解放する</param>
1202 protected override void Dispose(bool disposing)
1204 this.document = null;