iparser.cs

Fireball.CodeEditor is an source code editor control derived from the best compona SyntaxBox Control

using System;
using Fireball.Syntax;

namespace Fireball.Syntax.SyntaxDocumentParsers
{

	/// <summary>
	/// Parser interface.
	/// Implement this interface if you want to create your own parser.
	/// </summary>
	public interface IParser
	{
		/// <summary>
		/// Gets or Sets the Document object for this parser
		/// </summary>
		SyntaxDocument Document
		{
			get;
			set;
		}
		/// <summary>
		/// Gets or Sets the Language for this parser
		/// </summary>
		Language Language 
		{
			get;
			set;
		}

		string Separators
		{
			get;
			set;
		}

		/// <summary>
		/// Initializes the parser with a spcified SyntaxFile
		/// </summary>
		/// <param name="SyntaxFile">Filename of the SyntaxFile that should be used</param>
		void Init(string SyntaxFile);

		/// <summary>
		/// 
		/// </summary>
		/// <param name="SyntaxFile"></param>
		/// <param name="Separators"></param>
		void Init(string SyntaxFile,string Separators);

		/// <summary>
		/// Initializes the parser with a spcified Language object
		/// </summary>
		/// <param name="Language">The Language object to assign to the parser</param>
		void Init(Language Language);

		/// <summary>
		/// Called by the SyntaxDocument object when a row should be parsed
		/// </summary>
		/// <param name="RowIndex">The row index in the document</param>
		/// <param name="ParseKeywords">true if keywords and operators should be parsed , false if only a segment parse should be performed</param>
		void ParseLine(int RowIndex,bool ParseKeywords);		
		/// <summary>
		/// Called by the SyntaxDocument object when a row must be preview parsed.
		/// </summary>
		/// <param name="RowIndex">Row index in the document</param>
		void ParsePreviewLine(int RowIndex);		
	}
}