com.google.api.tools.framework.model.ProtoLocation Maven / Gradle / Ivy

/*
 * Copyright (C) 2016 Google Inc.
 *
 * 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 com.google.api.tools.framework.model;

import com.google.protobuf.DescriptorProtos;

/** A simple location with a directly specified display string. */
public class ProtoLocation implements Location {

  public static final Location UNKNOWN = new SimpleLocation("unknown location");

  /**
   * Create new instance of {@link ProtoLocation} by converting from instance of {@link
   * com.google.protobuf.DescriptorProtos.SourceCodeInfo.Location}
   *
   * The Display String structure is "proto name:line number:column number".
   *
   * @param location Instance {@link com.google.protobuf.DescriptorProtos.SourceCodeInfo.Location}
   * @param element ProtoElement associated with the given location.
   */
  public static Location convertFrom(
      final DescriptorProtos.SourceCodeInfo.Location location, final ProtoElement element) {
    if (location == null) {
      return UNKNOWN;
    }
    return new ProtoLocation(location, element);
  }

  private final String displayString;
  private final ProtoElement element;

  public ProtoLocation(
      DescriptorProtos.SourceCodeInfo.Location location, final ProtoElement element) {
    // Spit out "?:?" for line:column if there's no "span" set in the location.  This can happen
    // when (for example) a proto transform tool synthesizes a field that doesn't appear in the
    // source *.proto files.
    if (location.getSpanCount() > 0) {
      this.displayString =
          String.format(
              "%s:%d:%d",
              element.getFile().getLocation().getDisplayString(),
              location.getSpan(0) + 1,
              location.getSpan(1) + 1);
    } else {
      this.displayString =
          String.format("%s:?:?", element.getFile().getLocation().getDisplayString());
    }
    this.element = element;
  }

  public ProtoLocation(ProtoFile fileElement) {
    this.displayString = fileElement.getSimpleName();
    this.element = fileElement;
  }

  public ProtoElement getElement() {
    return element;
  }

  @Override
  public String getDisplayString() {
    return displayString;
  }

  @Override
  public String getContainerName() {
    return element.getFile().getLocation().getDisplayString();
  }

  @Override
  public String toString() {
    return String.format("(%s)%s", element, displayString);
  }
}