org.eolang.jeo.representation.directives.DirectivesValue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jeo-maven-plugin Show documentation
Optimisation of Java Bytecode via EOLANG
There is a newer version: 0.6.0
/*
 * 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.jeo.representation.directives;

import java.util.Iterator;
import java.util.Optional;
import lombok.ToString;
import org.eolang.jeo.representation.bytecode.BytecodeValue;
import org.xembly.Directive;

/**
 * Data Object Directive in EO language.
 *
 * @since 0.1.0
 * @todo #627:90min Remove 'line' attribute usages.
 *  We add 'line' attribute in many places to be able print XMIR representation as PHI expressions.
 *  Actually we shouldn't add any artificial attributes to the representation.
 *  When the following issue will be solved we should remove 'line' attribute from all places
 *  where it used:
 *  https://github.com/objectionary/eo/issues/3189
 */
@ToString
public final class DirectivesValue implements Iterable {

    /**
     * Array of hexadecimal characters.
     * Used for converting bytes to hexadecimal.
     * See {@link #bytesToHex(byte[])}.
     */
    private static final char[] HEX_ARRAY = "0123456789ABCDEF".toCharArray();

    /**
     * Name.
     */
    private final String name;

    /**
     * Type.
     */
    private final String vtype;

    /**
     * Bytes.
     */
    private final byte[] bytes;

    /**
     * Constructor.
     * @param data Data.
     * @param  Data type.
     */
    public  DirectivesValue(final T data) {
        this("", data);
    }

    /**
     * Constructor.
     * @param name Name.
     * @param data Data.
     * @param  Data type.
     */
    public  DirectivesValue(final String name, final T data) {
        this(name, new BytecodeValue(data));
    }

    /**
     * Constructor.
     * @param name Name.
     * @param value Value.
     */
    public DirectivesValue(final String name, final BytecodeValue value) {
        this(name, value.type(), value.bytes());
    }

    /**
     * Constructor.
     * @param name Name.
     * @param type Type.
     * @param bytes Bytes.
     */
    public DirectivesValue(final String name, final String type, final byte[] bytes) {
        this.name = name;
        this.vtype = type;
        this.bytes = Optional.ofNullable(bytes).map(byte[]::clone).orElse(null);
    }

    @Override
    public Iterator iterator() {
        return new DirectivesJeoObject(
            this.type(),
            this.name,
            new DirectivesBytes(this.hex())
        ).iterator();
    }

    /**
     * Value of the data.
     * @return Value
     */
    String hex() {
        return DirectivesValue.bytesToHex(this.bytes);
    }

    /**
     * Type of the data.
     * @return Type
     */
    String type() {
        return this.vtype;
    }

    /**
     * Bytes to HEX.
     * The efficient way to convert bytes to hexadecimal.
     * ATTENTION!
     * Do not modify this method.
     * It is an optimized version that saves memory and CPU.
     * Actually, the solution is based on the following StackOverflow answer:
     * here
     * You can find the full explanation or any other examples there.
     *
     * @param bytes Bytes.
     * @return Hexadecimal value as string.
     */
    private static String bytesToHex(final byte[] bytes) {
        final String res;
        if (bytes == null || bytes.length == 0) {
            res = "";
        } else {
            final int length = bytes.length;
            final char[] hex = new char[length * 3];
            for (int index = 0; index < length; ++index) {
                final int value = bytes[index] & 0xFF;
                hex[index * 3] = DirectivesValue.HEX_ARRAY[value >>> 4];
                hex[index * 3 + 1] = DirectivesValue.HEX_ARRAY[value & 0x0F];
                hex[index * 3 + 2] = ' ';
            }
            res = new String(hex, 0, hex.length - 1);
        }
        return res;
    }
}