ParsingContext.java

/*
 * Copyright (c) 2001-2017, Zoltan Farkas All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Additionally licensed with:
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.spf4j.zel.vm;

import java.io.Serializable;
import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;
import org.spf4j.zel.instr.Instruction;

@ParametersAreNonnullByDefault
public interface ParsingContext {

  final class Location implements Serializable {

    private static final long serialVersionUID = 1L;
    private final int row;
    private final int column;

    public Location(final int row, final int column) {
      this.row = row - 1;
      this.column = column;
    }

    @Override
    public String toString() {
      return "Location{" + "row=" + row + ", column=" + column + '}';
    }

    public int getRow() {
      return row;
    }

    public int getColumn() {
      return column;
    }

  }

  /**
   * generate instruction code with argument
   *
   * @param instr Instruction
   * @param arg Object
   */
  void generateCode(Location[] loc, Instruction... args);

  void generateCode(Location loc, Instruction instr);

  void staticSymbol(String name, Object object);

  void staticSymbol(String name);

  /**
   * Add code to this context
   *
   * @param code Object[]
   */
  void generateCodeAll(ParsingContext parsingContext);

  /**
   * return the current code address
   *
   * @return
   */
  int getAddress();

  Instruction getLast();

  /**
   * get the code generated in this context
   *
   * @return Object[]
   */
  @Nullable
  ProgramBuilder getProgramBuilder();

  /**
   * clone this context
   *
   * @return
   */
  ParsingContext createSubContext();

}