com.igormaznitsa.jcp.exceptions.FilePositionInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jcp Show documentation

Powerful multi-pass preprocessor to process directives situated in C-styled commentaries

There is a newer version: 7.1.2

/*
 * Copyright 2002-2019 Igor Maznitsa (http://www.igormaznitsa.com)
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 com.igormaznitsa.jcp.exceptions;

import com.igormaznitsa.jcp.utils.PreprocessorUtils;
import java.io.File;
import java.util.Objects;

/**
 * The class implements a file data storage where an exception can store a
 * snapshot of the current preprocessing file data
 *
 * @author Igor Maznitsa ([email protected])
 */
public class FilePositionInfo {

  /**
   * The preprocessing file
   */
  private final File file;

  /**
   * The current string index in the file
   */
  private final int stringIndex;

  public FilePositionInfo(final File file, final int stringIndex) {
    Objects.requireNonNull(file, "File is null");
    this.file = file;
    this.stringIndex = stringIndex;
  }


  public File getFile() {
    return this.file;
  }

  /**
   * Get zero based line index
   *
   * @return zero based line index or -1 if there is no info
   */
  public int getStringIndex() {
    return this.stringIndex < 0 ? -1 : this.stringIndex;
  }

  /**
   * Get line number, starting position is one
   *
   * @return line number started from one, -1 if there is no info
   */
  public int getLineNumber() {
    return this.stringIndex < 0 ? -1 : this.stringIndex + 1;
  }

  @Override

  public String toString() {
    final String filePath = PreprocessorUtils.getFilePath(this.file);
    return filePath + ':' + this.getLineNumber();
  }
}