gui-cs.Terminal.Gui/Terminal.Gui/Text/Autocomplete/ISuggestionGenerator.cs

using System.Collections.Generic;
using Rune = System.Rune;

namespace Terminal.Gui {
	/// <summary>
	/// Generates autocomplete <see cref="Suggestion"/> based on a given cursor location within a string
	/// </summary>
	public interface ISuggestionGenerator {

		/// <summary>
		/// Generates autocomplete <see cref="Suggestion"/> based on a given <paramref name="context"/>
		/// </summary>
		IEnumerable<Suggestion> GenerateSuggestions (AutocompleteContext context);


		/// <summary>
		/// Returns <see langword="true"/> if <paramref name="rune"/> is a character that
		/// would continue autocomplete suggesting. Returns <see langword="false"/> if it
		/// is a 'breaking' character (i.e. terminating current word boundary)
		/// </summary>
		bool IsWordChar (Rune rune);

	}
}