code: /*
   * Copyright (c) 2003 The Visigoth Software Society. All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowledgement:
   *       "This product includes software developed by the
   *        Visigoth Software Society (http://www.visigoths.org/)."
   *    Alternately, this acknowledgement may appear in the software
   *    itself, if and wherever such third-party acknowledgements
   *    normally appear.
   *
   * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names
   *    of the project contributors may be used to endorse or promote
   *    products derived from this software without prior written
   *    permission. For written permission, please contact
   *    visigoths@visigoths.org.
   *
   * 5. Products derived from this software may not be called
   *    "FreeMarker" or "Visigoth" nor may "FreeMarker" or "Visigoth"
   *    appear in their names without prior written permission of the
   *    Visigoth Software Society.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Visigoth Software Society. For more
   * information on the Visigoth Software Society, please see
   * http://www.visigoths.org/
   */
  
  package freemarker.eclipse.editors;
  
  import org.eclipse.jface.text.rules.ICharacterScanner;
  import org.eclipse.jface.text.rules.IToken;
  import org.eclipse.jface.text.rules.PatternRule;
  import org.eclipse.jface.text.rules.Token;
  
  /**
   * An XML comment rule. This class is used for partitioning XML
   * comments containing FreeMarker syntax correctly. In particular the
   * characters "-->" inside a FreeMarker construct are not interpreted
   * as an end of the XML comment.
   *
   * @author  <a href="mailto:per&#64;percederberg.net">Per Cederberg</a>
   * @version $Id: XmlCommentRule.java,v 1.1 2003/12/01 00:57:31 cederberg Exp $
   */
  public class XmlCommentRule extends PatternRule {
  
      /**
       * Creates a new XML comment rule.
       *
       * @param token      the token to use for this rule
       */
      public XmlCommentRule(IToken token) {
          super("<!--", "-->", token, (char) 0, false);
      }
  
      /* (non-Javadoc)
       * @see org.eclipse.jface.text.rules.PatternRule#doEvaluate(org.eclipse.jface.text.rules.ICharacterScanner, boolean)
       */
      protected IToken doEvaluate(ICharacterScanner scanner, boolean resume) {
          if (!resume && !FreemarkerTools.readXmlCommentStart(scanner)) {
              return Token.UNDEFINED;
          }
          FreemarkerTools.readXmlCommentEnd(scanner);
          return fToken;
      }
  }
  