FQLAst.java

/*
** Module   : FQLAst.java
** Abstract : An FQL-specific AST.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 OM  20190920 Created initial version. An FQL-specific AST.
**     CA  20221010 Avoid reflection when creating a new instance - added 'newInstance' method. Refs #6813
** 002 OM  20230428 Added [state] attribute for tracking and avoid double TRPL processing.
*/

/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.persist.orm;

import antlr.*;
import com.goldencode.ast.*;

/**
 * Provides symbolic token name lookups that are specific to the FQL AST.
 * All other function is implemented in the superclass.
 */
public final class FQLAst
extends AnnotatedAst
{
   /** Flag indicating this node was not processed. */
   static int NONE      = 0x00;
   
   /** Flag indicating this node was processed on TRPL descent. */
   static int DESCENDED = 0x01;
   
   /** Flag indicating this node was processed on TRPL ascent. */
   static int ASCENDED = 0x02;
   
   /** The current state of this node, indicating whether it was processed on TRPL traversal. */
   int state = NONE;
   
   /**
    * Default constructor.
    */
   public FQLAst()
   {
      super();
   }
   
   /**
    * Constructor which accepts and wrappers token.
    *
    * @param   token
    *          Token upon which this node is based.
    */
   public FQLAst(Token token)
   {
      super(token);
   }
   
   /**
    * Translates a text representation of a token type into the actual integer value.
    *
    * @param    tokenName
    *           The text representation of the token type.
    *
    * @return   A valid integer token type value or -1 if no match was found.
    */
   @Override
   public int lookupTokenType(String tokenName)
   {   
      return FQLParser.lookupTokenType(tokenName);
   }
   
   /**
    * Translates an integer value of a token type into the associated human readable text
    * representation.
    *
    * @param    type
    *           The integer token type.
    *
    * @return   A valid symbolic token type name or {@code null} if no match was found.
    */
   @Override
   public String lookupTokenName(int type)
   {   
      return FQLParser.lookupTokenName(type);
   }
   
   /**
    * Returns the symbolic representation of this AST's token type.
    *
    * @return  Symbolic token name for this AST's token type.
    */
   @Override
   public String getSymbolicTokenType()
   {
      return FQLParser.lookupTokenName(getType());
   }
   
   /**
    * Create a new instance of this AST implementation.
    * 
    * @return   A new {@link FQLAst} instance.
    */
   @Override
   protected AnnotatedAst newInstance()
   {
      return new FQLAst();
   }
}