FeatJAR-Shell inital commit

src/main/java/de/featjar/base/FeatJAR.java

@@ -32,6 +32,7 @@
 import de.featjar.base.io.IO;
 import de.featjar.base.log.BufferedLog;
 import de.featjar.base.log.CallerFormatter;
+import de.featjar.base.log.ColorFormatter;
 import de.featjar.base.log.ConfigurableLog;
 import de.featjar.base.log.EmptyProgressBar;
 import de.featjar.base.log.IProgressBar;
@@ -204,6 +205,20 @@ public static Configuration testConfiguration() {
         return configuration;
     }
 
+    /**
+     * {@return a new FeatJAR configuration with values intended for shell settings}
+     */
+    public static Configuration shellConfiguration() {
+        final Configuration configuration = new Configuration();
+        configuration
+                .logConfig
+                .logToSystemOut(Log.Verbosity.MESSAGE, Log.Verbosity.INFO, Log.Verbosity.PROGRESS)
+                .logToSystemErr(Log.Verbosity.ERROR, Log.Verbosity.WARNING)
+                .addFormatter(new ColorFormatter());
+        configuration.cacheConfig.setCachePolicy(Cache.CachePolicy.CACHE_NONE);
+        return configuration;
+    }
+
     /**
      * {@return the current FeatJAR instance}
      *

src/main/java/de/featjar/base/cli/ACommand.java

@@ -20,6 +20,8 @@
  */
 package de.featjar.base.cli;
 
+import de.featjar.base.data.Result;
+import de.featjar.base.shell.ShellSession;
 import java.nio.file.Path;
 import java.util.List;
 
@@ -49,4 +51,26 @@ public abstract class ACommand implements ICommand {
     public final List<Option<?>> getOptions() {
         return Option.getAllOptions(getClass());
     }
+
+    /**
+     * {@return an option list with all parsed arguments and properties including a path variable from the session}
+     */
+    public OptionList getShellOptions(ShellSession session, List<String> cmdParams) {
+        OptionList optionList = new OptionList();
+
+        if (cmdParams.isEmpty()) {
+            throw new IllegalArgumentException("No path object specified");
+        }
+
+        Result<Path> path = session.get(cmdParams.get(0), Path.class);
+
+        if (path.isEmpty()) {
+            throw new IllegalArgumentException(String.format("'%s' is not a session object", cmdParams.get(0)));
+        }
+
+        optionList.parseArguments();
+        optionList.parseProperties(INPUT_OPTION, String.valueOf(path.get()));
+
+        return optionList;
+    }
 }

src/main/java/de/featjar/base/cli/Commands.java

@@ -72,6 +72,10 @@ public class Commands extends AExtensionPoint<ICommand> {
      */
     public static final Pattern STANDARD_INPUT_PATTERN = Pattern.compile(STANDARD_INPUT + "(\\.(.+))?");
 
+    public static Commands getInstance() {
+        return FeatJAR.extensionPoint(Commands.class);
+    }
+
     /**
      * Runs a given function in a new thread, aborting it when it is not done after a timeout expires.
      * If the entire process should be stopped afterwards, {@link System#exit(int)} must be called explicitly.

src/main/java/de/featjar/base/cli/ICommand.java

@@ -21,6 +21,7 @@
 package de.featjar.base.cli;
 
 import de.featjar.base.extension.IExtension;
+import de.featjar.base.shell.ShellSession;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
@@ -62,4 +63,19 @@ default Optional<String> getShortName() {
      * @return exit code
      */
     int run(OptionList optionParser);
+
+    /**
+     * Parses arguments into an option list.
+     *
+     * @param session the shell session
+     * @param cmdParams the given arguments for the command
+     * @return an option list containing parsed arguments
+     */
+    default OptionList getShellOptions(ShellSession session, List<String> cmdParams) {
+        OptionList optionList = new OptionList();
+
+        optionList.parseArguments();
+
+        return optionList;
+    }
 }

src/main/java/de/featjar/base/cli/OptionList.java

@@ -357,6 +357,16 @@ private void parseConfigurationFiles(List<Problem> problemList) {
             }
         }
     }
+    /**
+     * Adds a option with custom value to properties.
+     *
+     * @param option the option
+     * @param optionValue the command
+     */
+    public void parseProperties(Option<?> option, String optionValue) {
+        Result<?> parse = option.parse(optionValue);
+        properties.put(option.getName(), parse.get());
+    }
 
     private void parseRemainingArguments(List<Problem> problemList) {
         ListIterator<String> listIterator = arguments.listIterator();

src/main/java/de/featjar/base/env/Process.java

@@ -22,6 +22,7 @@
 
 import de.featjar.base.FeatJAR;
 import de.featjar.base.data.Problem;
+import de.featjar.base.data.Problem.Severity;
 import de.featjar.base.data.Result;
 import de.featjar.base.data.Void;
 import java.io.BufferedReader;
@@ -39,6 +40,7 @@
 import java.util.concurrent.TimeUnit;
 import java.util.function.Consumer;
 import java.util.function.Supplier;
+import java.util.stream.Collectors;
 
 /**
  * Executes an external executable in a process.
@@ -134,8 +136,19 @@ public java.lang.Process start() throws IOException {
     @Override
     public Result<List<String>> get() {
         List<String> output = new ArrayList<>();
-        Result<Void> result = run(output::add, output::add);
-        return result.map(r -> output);
+        List<String> error = new ArrayList<>();
+        Result<Void> result = run(output::add, error::add);
+
+        if (result.isPresent()) {
+            output.addAll(error);
+            return result.map(r -> output);
+        } else {
+            if (error.isEmpty()) {
+                return result.map(r -> null);
+            } else {
+                return Result.empty(new Problem(error.stream().collect(Collectors.joining("\n")), Severity.ERROR));
+            }
+        }
     }
 
     /**

src/main/java/de/featjar/base/log/ColorFormatter.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) 2025 FeatJAR-Development-Team
+ *
+ * This file is part of FeatJAR-base.
+ *
+ * base is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3.0 of the License,
+ * or (at your option) any later version.
+ *
+ * base is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with base. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * See <https://github.com/FeatureIDE/FeatJAR-base> for further information.
+ */
+package de.featjar.base.log;
+
+import de.featjar.base.log.Log.Verbosity;
+
+/**
+ * Prepends different colors to logs and appends a reset of the colors as suffix.
+ *
+ * @author Niclas Kleinert
+ */
+public class ColorFormatter implements IFormatter {
+
+    private static final String TERMINAL_COLOR_LIGHT_BLUE = "\033[38;2;173;236;255m";
+    private static final String TERMINAL_COLOR_YELLOW = "\033[38;2;255;255;0m";
+    private static final String TERMINAL_COLOR_RED = "\033[38;2;255;0;0m";
+    private static final String TERMINAL_COLOR_RESET = "\033[0m";
+
+    @Override
+    public String getPrefix(String message, Verbosity verbosity) {
+        switch (verbosity) {
+            case INFO:
+                return TERMINAL_COLOR_LIGHT_BLUE;
+            case WARNING:
+                return TERMINAL_COLOR_YELLOW;
+            case ERROR:
+                return TERMINAL_COLOR_RED;
+            case MESSAGE:
+            case PROGRESS:
+            case DEBUG:
+                break;
+            default:
+                throw new IllegalStateException(String.valueOf(verbosity));
+        }
+        return "";
+    }
+
+    @Override
+    public String getSuffix(String message, Verbosity verbosity) {
+        return TERMINAL_COLOR_RESET;
+    }
+}

src/main/java/de/featjar/base/log/Log.java

@@ -314,6 +314,18 @@ default void plainMessage(Object messageObject) {
         plainMessage(() -> String.valueOf(messageObject));
     }
 
+    default void noLineBreakMessage(Supplier<String> message) {
+        print(message, Verbosity.MESSAGE, false);
+    }
+
+    default void noLineBreakMessage(String formatMessage, Object... elements) {
+        noLineBreakMessage(() -> String.format(formatMessage, elements));
+    }
+
+    default void noLineBreakMessage(Object messageObject) {
+        noLineBreakMessage(() -> String.valueOf(messageObject));
+    }
+
     /**
      * Logs a debug message.
      *

src/main/java/de/featjar/base/shell/ClearShellCommand.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright (C) 2025 FeatJAR-Development-Team
+ *
+ * This file is part of FeatJAR-base.
+ *
+ * base is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3.0 of the License,
+ * or (at your option) any later version.
+ *
+ * base is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with base. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * See <https://github.com/FeatureIDE/FeatJAR-base> for further information.
+ */
+package de.featjar.base.shell;
+
+import de.featjar.base.FeatJAR;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+
+/**
+ * Deletes all variables from the entire shell session.
+ *
+ * @author Niclas Kleinert
+ */
+public class ClearShellCommand implements IShellCommand {
+
+    @Override
+    public void execute(ShellSession session, List<String> cmdParams) {
+        String choice = Shell.readCommand("Clearing the entire session. Proceed ? (y)es (n)o")
+                .orElse("")
+                .toLowerCase()
+                .trim();
+
+        if (Objects.equals("y", choice)) {
+            session.clear();
+            FeatJAR.log().message("Clearing successful");
+        } else if (Objects.equals("n", choice)) {
+            FeatJAR.log().message("Clearing aborted");
+        }
+    }
+
+    @Override
+    public Optional<String> getShortName() {
+        return Optional.of("clear");
+    }
+
+    @Override
+    public Optional<String> getDescription() {
+        return Optional.of("- delete the entire session");
+    }
+}

src/main/java/de/featjar/base/shell/DeleteShellCommand.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright (C) 2025 FeatJAR-Development-Team
+ *
+ * This file is part of FeatJAR-base.
+ *
+ * base is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3.0 of the License,
+ * or (at your option) any later version.
+ *
+ * base is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with base. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * See <https://github.com/FeatureIDE/FeatJAR-base> for further information.
+ */
+package de.featjar.base.shell;
+
+import de.featjar.base.FeatJAR;
+import de.featjar.base.log.Log.Verbosity;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+/**
+ * Deletes a given list of variables from the shell session.
+ *
+ * @author Niclas Kleinert
+ */
+public class DeleteShellCommand implements IShellCommand {
+
+    @Override
+    public void execute(ShellSession session, List<String> cmdParams) {
+
+        if (cmdParams.isEmpty()) {
+            session.printAll();
+            cmdParams = Shell.readCommand("Enter the variable names you want to delete or leave blank to abort:")
+                    .map(c -> Arrays.stream(c.split("\\s+")).collect(Collectors.toList()))
+                    .orElse(Collections.emptyList());
+        }
+
+        cmdParams.forEach(e -> {
+            session.remove(e)
+                    .ifPresent(a -> FeatJAR.log().message("Removing of " + e + " successful"))
+                    .orElseLog(Verbosity.ERROR);
+        });
+    }
+
+    @Override
+    public Optional<String> getShortName() {
+        return Optional.of("delete");
+    }
+
+    @Override
+    public Optional<String> getDescription() {
+        return Optional.of("- <var>... - delete session variables");
+    }
+}