org.prorefactor.treeparser.symbols.FieldContainer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proparse Show documentation
ABL code parser
There is a newer version: 2.29.1
/********************************************************************************
 * Copyright (c) 2003-2015 John Green
 * Copyright (c) 2015-2024 Riverside Software
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License, v. 2.0 are satisfied: GNU Lesser General Public License v3.0
 * which is available at https://www.gnu.org/licenses/lgpl-3.0.txt
 *
 * SPDX-License-Identifier: EPL-2.0 OR LGPL-3.0
 ********************************************************************************/
package org.prorefactor.treeparser.symbols;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.antlr.v4.runtime.tree.ParseTree;
import org.prorefactor.core.schema.Field;
import org.prorefactor.treeparser.TreeParserSymbolScope;

/**
 * Frame and Browse widgets are FieldContainers. This class provides the services for looking up fields/variables in a
 * Frame or Browse.
 */
public abstract class FieldContainer extends Widget {

  private List statementList = new ArrayList<>();
  private Set fieldSet = new HashSet<>();
  private Set enabledFields = new HashSet<>();
  private Set otherSymbols = new HashSet<>();
  private Set variableSet = new HashSet<>();

  public FieldContainer(String name, TreeParserSymbolScope scope) {
    super(name, scope);
  }

  /**
   * Add a statement node to the list of statements which operate on this FieldContainer. Intended to be used by the
   * tree parser only.
   */
  public void addStatement(ParseTree node) {
    statementList.add(node);
  }

  /**
   * Add a FieldBuffer or Variable to this Frame or Browse object. Intended to be used by the tree parser only. The tree
   * parser passes 'true' for ENABLE|UPDATE|PROMPT-FOR.
   */
  public void addSymbol(Symbol symbol, boolean statementIsEnabler) {
    if (symbol instanceof FieldBuffer)
      fieldSet.add((FieldBuffer) symbol);
    else if (symbol instanceof Variable) {
      ((Variable) symbol).referencedInFrame();
      variableSet.add((Variable) symbol);
    }
    else
      otherSymbols.add(symbol);
    if (statementIsEnabler)
      enabledFields.add(symbol);
  }

  /**
   * Get the fields and variables in the frame. The entries in the return list are of type Variable and/or FieldBuffer.
   */
  public List getAllFields() {
    List ret = new ArrayList<>();
    ret.addAll(variableSet);
    ret.addAll(fieldSet);
    return ret;
  }

  /**
   * Combines getAllFields() with all other widgets in the FieldContainer
   */
  public List getAllFieldsAndWidgets() {
    List ret = getAllFields();
    ret.addAll(otherSymbols);
    return ret;
  }

  /**
   * Get the enabled fields and variables in the frame. The entries in the return list are of type Variable and/or
   * FieldBuffer.
   */
  public List getEnabledFields() {
    List ret = new ArrayList<>();
    ret.addAll(enabledFields);
    return ret;
  }

  /**
   * Get the list of nodes for the statements which operate on this FieldContainer
   */
  public List getStatementList() {
    return statementList;
  }

  /**
   * Check to see if a name matches a Variable or a FieldBuffer in this FieldContainer. Used by the tree parser at the
   * INPUT function for resolving the name reference.
   */
  public Symbol lookupFieldOrVar(Field.Name name) {
    if (name.getTable() == null) {
      for (Variable v1 : variableSet) {
        if (v1.getName().equalsIgnoreCase(name.getField()))
          return v1;
      }
    }
    for (FieldBuffer fieldBuffer : fieldSet) {
      if (fieldBuffer.canMatch(name))
        return fieldBuffer;
    }

    // Lookup in sub-containers (e.g. browse in a frame)
    for (Symbol symbol : otherSymbols) {
      if (symbol instanceof FieldContainer) {
        Symbol s = ((FieldContainer) symbol).lookupFieldOrVar(name);
        if (s != null)
          return s;
      }
    }

    return null;
  }

}