org.opendaylight.yangtools.yang2sources.plugin.YangToSourcesState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yang-maven-plugin Show documentation

This plugin is a wrapper for "yang to source code" generation. It can be configured by a set of third-party code generators and resource providers. For further info see available goals. Sample usage: TODO: add sample usage when finished

The newest version!

/*
 * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.yang2sources.plugin;

import static java.util.Objects.requireNonNull;

import com.google.common.collect.ImmutableMap;
import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Collection;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.concepts.WritableObject;

/**
 * State of the result of a {@link YangToSourcesMojo} execution run.
 */
// FIXME: rename to ExecutionState
record YangToSourcesState(
        @NonNull ImmutableMap fileGeneratorArgs,
        @NonNull FileStateSet projectYangs,
        @NonNull FileStateSet dependencyYangs,
        @NonNull FileStateSet outputFiles) implements WritableObject {
    // 'ymp' followed by a byte value '1'
    private static final int MAGIC = 0x796D7001;

    YangToSourcesState {
        requireNonNull(fileGeneratorArgs);
        requireNonNull(projectYangs);
        requireNonNull(dependencyYangs);
        requireNonNull(outputFiles);
    }

    static @NonNull YangToSourcesState readFrom(final DataInput in) throws IOException {
        final int magic = in.readInt();
        if (magic != MAGIC) {
            throw new IOException("Unrecognized magic " + Integer.toHexString(magic));
        }
        return new YangToSourcesState(readConfigurations(in),
            FileStateSet.readFrom(in), FileStateSet.readFrom(in), FileStateSet.readFrom(in));
    }

    @Override
    public void writeTo(final DataOutput out) throws IOException {
        out.writeInt(MAGIC);
        writeConfigurations(out, fileGeneratorArgs.values());
        projectYangs.writeTo(out);
        dependencyYangs.writeTo(out);
        outputFiles.writeTo(out);
    }

    /**
     * Delete all output files mentioned in {@link #outputFiles}.
     *
     * @throws IOException if any error occurs
     */
    void deleteOutputFiles() throws IOException {
        for (var file : outputFiles.fileStates().keySet()) {
            Files.deleteIfExists(Path.of(file));
        }
    }

    private static void writeConfigurations(final DataOutput out, final Collection configurations)
            throws IOException {
        out.writeInt(configurations.size());
        for (var arg : configurations) {
            arg.writeTo(out);
        }
    }

    private static @NonNull ImmutableMap readConfigurations(final DataInput in)
            throws IOException {
        final int size = in.readInt();
        if (size == 0) {
            return ImmutableMap.of();
        }
        final var configurations = ImmutableMap.builderWithExpectedSize(size);
        for (int i = 0; i < size; ++i) {
            final var arg = FileGeneratorArg.readFrom(in);
            configurations.put(arg.getIdentifier(), arg);
        }
        return configurations.build();
    }
}