Experiments/Attic/Rook/Castle.Rook.Compiler/Parser/antlr/TokenCreator.cs

   1 namespace antlr
   2 {
   3         using System;
   4
   5         /*ANTLR Translator Generator
   6         * Project led by Terence Parr at http://www.jGuru.com
   7         * Software rights: http://www.antlr.org/license.html
   8         *
   9         * $Id:$
  10         */
  11
  12         //
  13         // ANTLR C# Code Generator by Micheal Jordan
  14         //                            Kunle Odutola       : kunle UNDERSCORE odutola AT hotmail DOT com
  15         //                            Anthony Oguntimehin
  16         //
  17
  18         /// <summary>
  19         /// A creator of Token object instances.
  20         /// </summary>
  21         /// <remarks>
  22         /// <para>
  23         /// This class and it's sub-classes exists primarily as an optimization
  24         /// of the reflection-based mechanism(s) previously used exclusively to
  25         /// create instances of Token objects.
  26         /// </para>
  27         /// <para>
  28         /// Since Lexers in ANTLR use a single Token type, each TokenCreator can
  29         /// create one class of Token objects (that's why it's not called TokenFactory).
  30         /// </para>
  31         /// </remarks>
  32         public abstract class TokenCreator
  33         {
  34                 /// <summary>
  35                 /// Returns the fully qualified name of the Token type that this
  36                 /// class creates.
  37                 /// </summary>
  38                 public abstract string TokenTypeName
  39                 {
  40                         get;
  41                 }
  42
  43                 /// <summary>
  44                 /// Constructs a <see cref="Token"/> instance.
  45                 /// </summary>
  46                 public abstract IToken Create();
  47         }
  48 }