dev.equo.ide.gradle.EquoIdeExtension Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of equo-ide-gradle-plugin Show documentation
Generate a custom IDE as a repeatable build artifact
The newest version!
/*******************************************************************************
 * Copyright (c) 2022-2023 EquoTech, Inc. and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     EquoTech, Inc. - initial API and implementation
 *******************************************************************************/
package dev.equo.ide.gradle;

import dev.equo.ide.Catalog;
import dev.equo.ide.IdeHook;
import dev.equo.ide.IdeHookBranding;
import dev.equo.ide.IdeHookReflected;
import dev.equo.ide.IdeHookWelcome;
import dev.equo.ide.WorkspaceInit;
import dev.equo.solstice.p2.P2Model;
import java.util.ArrayList;
import java.util.List;
import org.gradle.api.Action;
import org.gradle.api.Project;

/** The DSL inside the equoIde block. */
public class EquoIdeExtension extends P2ModelDslWithCatalog {
	public boolean useAtomos = false;
	private final IdeHook.List ideHooks = new IdeHook.List();
	public final IdeHookBranding branding = new IdeHookBranding();

	public EquoIdeExtension(Project project) {
		super(project);
		ideHooks.add(branding);
	}

	@Deprecated
	public void useChromium() {
		project.getLogger().warn("useChromium() is deprecated, use equoChromium() instead");
		super.equoChromium();
	}

	public IdeHookBranding branding() {
		return branding;
	}

	private IdeHookWelcome welcome = null;

	public IdeHookWelcome welcome() {
		if (welcome == null) {
			welcome = new IdeHookWelcome();
			ideHooks.add(welcome);
		}
		return welcome;
	}

	public IdeHook.List getIdeHooks() {
		return ideHooks;
	}

	WorkspaceInit workspace = new WorkspaceInit();

	public class SetWorkspaceFile {
		private final String subpath;

		SetWorkspaceFile(String subpath) {
			this.subpath = subpath;
		}

		public void prop(String key, String value) {
			workspace.setProperty(subpath, key, value);
		}
	}

	public void workspaceInit(String subpath, Action action) {
		var setWorkspaceFile = new SetWorkspaceFile(subpath);
		action.execute(setWorkspaceFile);
	}

	P2Model prepareModel(WorkspaceInit workspaceInit) throws Exception {
		if (hasBeenPrepared) {
			return model;
		}
		hasBeenPrepared = true;
		catalog.putInto(model, ideHooks, workspaceInit);
		model.applyNativeFilterIfNoPlatformFilter();
		return model;
	}

	private boolean hasBeenPrepared = false;

	/** Add the jar of this project (and its dependencies) to the IDE. */
	public DogfoodDsl dogfood() {
		return dogfood(project);
	}

	/** Add the jar of the given project (and its dependencies) to the IDE. */
	public DogfoodDsl dogfood(Project project) {
		project
				.getTasks()
				.named(
						EquoIdeGradlePlugin.EQUO_IDE,
						task -> {
							task.dependsOn(project.getTasks().named("jar"));
						});
		return add(new DogfoodDsl(project));
	}

	private static class DogfoodCatalog extends Catalog.PureMaven {
		DogfoodCatalog(Project project) {
			super("dogfood", jre11(""), List.of(project.getPath()));
		}
	}

	public static class DogfoodDsl extends GradleCatalogDsl {
		final Project project;

		public DogfoodDsl(Project project) {
			super(new DogfoodCatalog(project), null);
			this.project = project;
		}

		final List ideHooks = new ArrayList<>();

		@Override
		protected List ideHooks() {
			return ideHooks;
		}

		/**
		 * Instantiates the given class (which must be an [IdeHook] with a no-arg constructor) and adds
		 * it to the IDE startup.
		 *
		 * Even better is to add a {@code Bundle-IdeHook} header to the manifest of the jar, then the
		 * hook will still work when the Eclipse plugin gets distributed via Maven.
		 */
		public DogfoodDsl ideHook(String hookClass) {
			ideHooks.add(new IdeHookReflected(hookClass));
			return this;
		}
	}
}