diff options
| author | Roy Ben-Shabat <Roy@Twine-s.com> | 2019-04-08 19:19:16 +0300 |
|---|---|---|
| committer | Roy Ben-Shabat <Roy@Twine-s.com> | 2019-04-08 19:19:16 +0300 |
| commit | 14f6bcfe8debc163d8fe2f172c7e0555b83aeddb (patch) | |
| tree | 03cbfec93ccc3687f12fb4e747e4ef9225b0bc3b /Software/Visual_Studio/Scripting/Tango.Scripting.Editors/Search/ISearchStrategy.cs | |
| parent | f1733550ed159387831568ebee4a1fc1d73a62f2 (diff) | |
| parent | 46cdc21087d55e3bc5ca1d04b183f47bcfb3924f (diff) | |
| download | Tango-14f6bcfe8debc163d8fe2f172c7e0555b83aeddb.tar.gz Tango-14f6bcfe8debc163d8fe2f172c7e0555b83aeddb.zip | |
Merge branch 'master' of https://twinetfs.visualstudio.com/_git/Tango
Diffstat (limited to 'Software/Visual_Studio/Scripting/Tango.Scripting.Editors/Search/ISearchStrategy.cs')
| -rw-r--r-- | Software/Visual_Studio/Scripting/Tango.Scripting.Editors/Search/ISearchStrategy.cs | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/Software/Visual_Studio/Scripting/Tango.Scripting.Editors/Search/ISearchStrategy.cs b/Software/Visual_Studio/Scripting/Tango.Scripting.Editors/Search/ISearchStrategy.cs new file mode 100644 index 000000000..dd4942f33 --- /dev/null +++ b/Software/Visual_Studio/Scripting/Tango.Scripting.Editors/Search/ISearchStrategy.cs @@ -0,0 +1,88 @@ +// Copyright (c) AlphaSierraPapa for the SharpDevelop Team (for details please see \doc\copyright.txt) +// This code is distributed under the GNU LGPL (for details please see \doc\license.txt) + +using System; +using System.Collections.Generic; +using System.Runtime.Serialization; + +using Tango.Scripting.Editors.Document; + +namespace Tango.Scripting.Editors.Search +{ + /// <summary> + /// Basic interface for search algorithms. + /// </summary> + public interface ISearchStrategy : IEquatable<ISearchStrategy> + { + /// <summary> + /// Finds all matches in the given ITextSource and the given range. + /// </summary> + /// <remarks> + /// This method must be implemented thread-safe. + /// All segments in the result must be within the given range, and they must be returned in order + /// (e.g. if two results are returned, EndOffset of first result must be less than or equal StartOffset of second result). + /// </remarks> + IEnumerable<ISearchResult> FindAll(ITextSource document, int offset, int length); + + /// <summary> + /// Finds the next match in the given ITextSource and the given range. + /// </summary> + /// <remarks>This method must be implemented thread-safe.</remarks> + ISearchResult FindNext(ITextSource document, int offset, int length); + } + + /// <summary> + /// Represents a search result. + /// </summary> + public interface ISearchResult : ISegment + { + /// <summary> + /// Replaces parts of the replacement string with parts from the match. (e.g. $1) + /// </summary> + string ReplaceWith(string replacement); + } + + /// <summary> + /// Defines supported search modes. + /// </summary> + public enum SearchMode + { + /// <summary> + /// Standard search + /// </summary> + Normal, + /// <summary> + /// RegEx search + /// </summary> + RegEx, + /// <summary> + /// Wildcard search + /// </summary> + Wildcard + } + + /// <inheritdoc/> + public class SearchPatternException : Exception, ISerializable + { + /// <inheritdoc/> + public SearchPatternException() + { + } + + /// <inheritdoc/> + public SearchPatternException(string message) : base(message) + { + } + + /// <inheritdoc/> + public SearchPatternException(string message, Exception innerException) : base(message, innerException) + { + } + + // This constructor is needed for serialization. + /// <inheritdoc/> + protected SearchPatternException(SerializationInfo info, StreamingContext context) : base(info, context) + { + } + } +} |
