cqfn/eo

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2016-2024 Objectionary.com
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package org.eolang;

/**
 * An object with coordinates (line and position).
 *
 * @since 0.21
 */
@SuppressWarnings("PMD.TooManyMethods")
@Versionized
public final class PhLocated implements Phi {

    /**
     * The original.
     */
    private final Phi origin;

    /**
     * The line number.
     */
    private final int line;

    /**
     * The position in the line.
     */
    private final int position;

    /**
     * The location.
     */
    private final String location;

    /**
     * Ctor.
     *
     * @param phi The object
     * @param lne Line
     * @param pos Position
     */
    public PhLocated(final Phi phi, final int lne, final int pos) {
        this(phi, lne, pos, "?");
    }

    /**
     * Ctor.
     *
     * @param phi The object
     * @param lne Line
     * @param pos Position
     * @param loc Location
     * @checkstyle ParameterNumberCheck (5 lines)
     */
    public PhLocated(final Phi phi, final int lne, final int pos, final String loc) {
        this.origin = phi;
        this.line = lne;
        this.position = pos;
        this.location = loc;
    }

    @Override
    public boolean equals(final Object obj) {
        return this.origin.equals(obj);
    }

    @Override
    public int hashCode() {
        return this.origin.hashCode();
    }

    @Override
    public String toString() {
        return String.format(
            "<%s>%s",
            this.locator(),
            this.origin.toString()
        );
    }

    @Override
    public String φTerm() {
        return this.origin.φTerm();
    }

    @Override
    public Phi copy() {
        return new PhLocated(this.origin.copy(), this.line, this.position, this.location);
    }

    @Override
    public Phi take(final String name) {
        return this.origin.take(name);
    }

    @Override
    public boolean put(final int pos, final Phi object) {
        return this.origin.put(pos, object);
    }

    @Override
    public boolean put(final String name, final Phi object) {
        return this.origin.put(name, object);
    }

    @Override
    public String locator() {
        return String.format("%s:%d:%d", this.location, this.line, this.position);
    }

    @Override
    public String forma() {
        return this.origin.forma();
    }

    @Override
    public void attach(final byte[] data) {
        this.origin.attach(data);
    }

    @Override
    public byte[] delta() {
        return this.origin.delta();
    }
}