Parameter passthrough (#183)

* Parameter passthrough

There is a new feature of CodeChecker configuration. Now there is a
direct parameter passthrough to the CodeChecker package. It can be
configured in the preferences page.

There is also a live display of the analyze command right below the
passthrough specification Text widget. Uneditable, but can be copied
from. With this, an actual analyze run is more easily reproducible.

Author: vodorok

bundles/org.codechecker.eclipse.plugin/src/org/codechecker/eclipse/plugin/codechecker/CodeChecker.java

@@ -14,13 +14,15 @@
 import org.codechecker.eclipse.plugin.runtime.ShellExecutorHelper;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
 
 import com.google.common.base.Optional;
 
 /**
  * Internal representation of a CodeChecker package.
  */
 public class CodeChecker implements ICodeChecker {
+    private static final String OPTION_SEPARATOR = " ";
 
     private static final String LOCATION_KEY = "location";
     private static final String RESULTS_KEY = "results";
@@ -82,14 +84,40 @@ public String analyze(Path logFile, boolean logToConsole, IProgressMonitor monit
 
         subMap.put(RESULTS_KEY, logFile.getParent().toAbsolutePath().resolve(Paths.get(RESULTS_FOLDER)).toFile());
         subMap.put(LOGFILE_KEY, logFile.toAbsolutePath().toFile());
-        String cmd = LOCATION_SUB + " analyze " + config.get(ConfigTypes.CHECKER_LIST) + " -j "
-                + config.get(ConfigTypes.ANAL_THREADS) + " -n javarunner" + " -o "
-                + RESULTS_SUB + " " + LOGFILE_SUB;
+        String cmd = getSubstituteAnalyzeString(config);
 
         SLogger.log(LogI.INFO, "Running analyze Command: " + cmd);
         Optional<String> ccOutput = she.progressableWaitReturnOutput(cmd, subMap, logToConsole, monitor, taskCount);
 
         return ccOutput.or("");
     }
 
+    @Override
+    public String getAnalyzeString(CcConfigurationBase config, @Nullable Path logFile) {
+        if (logFile != null) {
+            subMap.put(RESULTS_KEY, logFile.getParent().toAbsolutePath().resolve(Paths.get(RESULTS_FOLDER)).toFile());
+            subMap.put(LOGFILE_KEY, logFile.toAbsolutePath().toFile());
+        }
+
+        String[] temp = getSubstituteAnalyzeString(config).split(OPTION_SEPARATOR);
+        StringBuilder cmd = new StringBuilder();
+        for (String s : temp) {
+            String tempString = s;
+            if (s.startsWith("${")) {
+                StringBuilder sb = new StringBuilder(tempString);
+                sb.delete(0, 2).deleteCharAt(sb.length() - 1);
+                if (subMap.containsKey(sb.toString()))
+                    tempString = subMap.get(sb.toString()).toString();
+            }
+            cmd.append(tempString);
+            cmd.append(OPTION_SEPARATOR);
+        }
+        return cmd.toString();
+    }
+
+    private String getSubstituteAnalyzeString(CcConfigurationBase config) {
+        return LOCATION_SUB + " analyze" + " -j "
+                + config.get(ConfigTypes.ANAL_THREADS) + " -n javarunner" + " -o " + RESULTS_SUB + OPTION_SEPARATOR
+                + LOGFILE_SUB + OPTION_SEPARATOR + config.get(ConfigTypes.ANAL_OPTIONS);
+    }
 }

bundles/org.codechecker.eclipse.plugin/src/org/codechecker/eclipse/plugin/codechecker/ICodeChecker.java

@@ -6,6 +6,7 @@
 import org.codechecker.eclipse.plugin.config.CcConfigurationBase;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
 
 /**
  * Interface representing a CodeChecker package.
@@ -38,6 +39,18 @@ public interface ICodeChecker {
      */
     public Path getLocation();
 
+    /**
+     * Returns the analyze command to be run, without extra parameters.
+     * 
+     * @param logFile
+     *            A Path to the build log in the following format:
+     *            http://clang.llvm.org/docs/JSONCompilationDatabase.html .
+     * @param config
+     *            The configuration being used.
+     * @return The analyze command as String.
+     */
+    public String getAnalyzeString(CcConfigurationBase config, @Nullable Path logFile);
+
     /**
      * Executes CodeChecker check command on the build log received in the logFile
      * parameter.

bundles/org.codechecker.eclipse.plugin/src/org/codechecker/eclipse/plugin/config/CcConfiguration.java

@@ -11,9 +11,7 @@
 import org.codechecker.eclipse.plugin.config.global.CcGlobalConfiguration;
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.ProjectScope;
-import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IStatus;
-import org.eclipse.core.runtime.preferences.IScopeContext;
 import org.osgi.service.prefs.BackingStoreException;
 
 import com.google.common.collect.Sets;
@@ -81,17 +79,6 @@ protected void validate() {
         }
     }
 
-    /**
-     * Returns preferences related to this project.
-     * @return The configuration which the objects internal boolean has chosen.
-     */
-    @Override
-    public Map<ConfigTypes, String> get() {
-        Map<ConfigTypes, String> retConfig = new HashMap<>();
-        retConfig.putAll(config);
-        return retConfig;
-    }
-
     /**
      * Updates the persistent configuration.
      * @param config The new configuration to be saved.

bundles/org.codechecker.eclipse.plugin/src/org/codechecker/eclipse/plugin/config/CcConfigurationBase.java

@@ -3,7 +3,6 @@
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
-import java.util.stream.Collectors;
 
 import org.codechecker.eclipse.plugin.codechecker.ICodeChecker;
 import org.codechecker.eclipse.plugin.config.Config.ConfigTypes;
@@ -27,14 +26,6 @@ public abstract class CcConfigurationBase {
      */
     public CcConfigurationBase() {}
 
-    /**
-     * Copy constructor for initializing.
-     * @param other The other instance.
-     */
-    public CcConfigurationBase(CcConfigurationBase other) {
-        this.config = other.get().entrySet().stream().collect(Collectors.toMap(e -> e.getKey(), e -> e.getValue()));
-    }
-
     /**
      * For Updates the configuration.
      * @param config The new configuration.

bundles/org.codechecker.eclipse.plugin/src/org/codechecker/eclipse/plugin/config/CommonGui.java

@@ -1,9 +1,8 @@
 package org.codechecker.eclipse.plugin.config;
 
+import java.nio.file.Path;
 import java.nio.file.Paths;
-import java.util.ArrayList;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 
 import org.codechecker.eclipse.plugin.Logger;
@@ -17,13 +16,9 @@
 import org.codechecker.eclipse.plugin.config.Config.ConfigTypes;
 import org.codechecker.eclipse.plugin.config.global.CcGlobalConfiguration;
 import org.codechecker.eclipse.plugin.config.project.CodeCheckerProject;
-import org.codechecker.eclipse.plugin.itemselector.CheckerView;
 import org.codechecker.eclipse.plugin.runtime.ShellExecutorHelperFactory;
-import org.codechecker.eclipse.plugin.utils.CheckerItem;
-import org.codechecker.eclipse.plugin.utils.CheckerItem.LAST_ACTION;
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.runtime.IStatus;
-import org.eclipse.jface.action.Action;
 import org.eclipse.jface.dialogs.IMessageProvider;
 import org.eclipse.jface.layout.GridDataFactory;
 import org.eclipse.jface.layout.GridLayoutFactory;
@@ -40,10 +35,8 @@
 import org.eclipse.swt.widgets.FileDialog;
 import org.eclipse.swt.widgets.Group;
 import org.eclipse.swt.widgets.Label;
-import org.eclipse.swt.widgets.Shell;
 import org.eclipse.swt.widgets.Text;
 import org.eclipse.ui.IWorkbench;
-import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.forms.widgets.ColumnLayout;
 import org.eclipse.ui.forms.widgets.ExpandableComposite;
 import org.eclipse.ui.forms.widgets.FormToolkit;
@@ -60,14 +53,14 @@ public class CommonGui {
 
     private static final String VALID_PACKAGE = "CodeChecker being used: ";
     private static final String BROSWE = "Browse";
-    private static final String CHECKER_ENABLED = " -e ";
-    private static final String CHECKER_DISABLED = " -d ";
-    private static final String CHECKER_SEPARATOR = " ";
 
     private static final int TEXTWIDTH = 200;
     private static final int FORM_COLUMNS = 3;
     private static final int FORM_ONE_ROW = 1;
 
+    private static final int AN_CMD_DISP_HGT = 300;
+    private static final int TRI_LINE_TEXT_HGT = 52;
+
     private boolean globalGui;// whether this class is for global or project
                               // specific preferences
     private boolean useGlobalSettings;// if this is project specific page,
@@ -94,6 +87,9 @@ public class CommonGui {
     private Button globalcc;
     private Button projectcc;
 
+    private Text analysisOptions;
+    private Text analysisCmdDisplay;
+
     /**
      * Constructor to be used, when only global preferences are to be set.
      */
@@ -181,32 +177,36 @@ public Control createContents(final Composite parent) {
         cLoggers = addTextField(toolkit, comp, "Compiler commands to log", "gcc:g++:clang:clang++");
         toolkit.createLabel(comp, "");
 
-        final Button checkers = toolkit.createButton(comp, "Toggle enabled checkers", SWT.PUSH);
-        checkers.addSelectionListener(new SelectionAdapter() {
-
-            public void widgetSelected(SelectionEvent e) {
-                Action action = new Action() {
-                    @Override
-                    public void run() {
-                        Shell activeShell = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell();
-                        //Map<ConfigTypes, String> config = getConfigFromFields();
-                        try {
-                            ArrayList<CheckerItem> checkersList = getCheckerList();
-                            CheckerView dialog = new CheckerView(activeShell, checkersList);
-
-                            int result = dialog.open();
-                            if (result == 0) {
-                                checkerListArg = checkerListToCheckerListArg(dialog.getCheckersList());
-                            }
-                        } catch (IllegalArgumentException e) {
-                            Logger.log(IStatus.INFO, "Codechecker environment is invalid" + e);
-                        }
-                    }
-                };
-                action.run();
+        toolkit.createLabel(comp, "Extra analysis options");
+        analysisOptions = toolkit.createText(comp, "", SWT.WRAP | SWT.BORDER | SWT.V_SCROLL);
+        GridDataFactory.fillDefaults().grab(false, true).hint(TEXTWIDTH, TRI_LINE_TEXT_HGT).applyTo(analysisOptions);
+        analysisOptions.addModifyListener(new ModifyListener() {
+
+            @Override
+            public void modifyText(ModifyEvent e) {
+                config.get().put(ConfigTypes.ANAL_OPTIONS, analysisOptions.getText());
+                Path originalLogFile = null;
+                if (!globalGui) {
+                    originalLogFile = cCProject.getLogFileLocation();
+                }
+                if (codeChecker != null)
+                    analysisCmdDisplay.setText(codeChecker.getAnalyzeString(config, originalLogFile));
+                checkerConfigSection.layout();
+                checkerConfigSection.getParent().layout();
+                comp.layout(true);
+                comp.getParent().layout(true);
             }
         });
-        checkers.setData("org.eclipse.swtbot.widget.checkersKey", "checkesButton");
+        analysisOptions.getVerticalBar().setEnabled(true);
+
+        toolkit.createLabel(comp, "");
+        toolkit.createLabel(comp, "Final analysis command");
+        analysisCmdDisplay = toolkit.createText(comp, "", SWT.MULTI | SWT.WRAP | SWT.V_SCROLL);
+        GridDataFactory.fillDefaults().grab(false, true).hint(TEXTWIDTH, AN_CMD_DISP_HGT).applyTo(analysisCmdDisplay);
+        analysisCmdDisplay.setEditable(false);
+        analysisCmdDisplay.getVerticalBar().setEnabled(true);
+        toolkit.createLabel(comp, "");
+
         if (!globalGui) {
             recursiveSetEnabled(form.getBody(), !useGlobalSettings);
             final Composite client3 = toolkit.createComposite(globalConfigSection);
@@ -382,61 +382,6 @@ public void recursiveSetEnabled(Control control, Boolean b) {
         }
     }
 
-    /**
-     * Returns The all checkers from CodeChecker.
-     * @return A list of all available checkers.
-     */
-    private ArrayList<CheckerItem> getCheckerList() {
-        // ArrayList<CheckerItem> defaultCheckersList = new ArrayList<>();
-        ArrayList<CheckerItem> checkersList = new ArrayList<>(); //
-        // new Checkers List
-        String s = codeChecker.getCheckers();
-        String[] newCheckersSplit = s.split("\n");
-        // old Checkers Command
-        //String[] checkersCommand = checkerListArg.split(CHECKER_SEPARATOR);
-        //List<String> oldCheckersCommand = Arrays.asList(checkersCommand);
-        for (String it : newCheckersSplit) {
-            // String checkerName = it.split(" ")[2];
-            String checkerName = it;
-            CheckerItem check = new CheckerItem(checkerName);
-            boolean defaultEnabled = false;
-
-            if (it.split(CHECKER_SEPARATOR)[1].equals("+"))
-                defaultEnabled = true;
-            if (defaultEnabled) {
-                if (checkerListArg.contains(CHECKER_DISABLED + checkerName)) {
-                    check.setLastAction(LAST_ACTION.DESELECTION);
-                } else {
-                    check.setLastAction(LAST_ACTION.SELECTION);
-                }
-            } else {
-                if (checkerListArg.contains(CHECKER_ENABLED + checkerName)) {
-                    check.setLastAction(LAST_ACTION.SELECTION);
-                } else {
-                    check.setLastAction(LAST_ACTION.DESELECTION);
-                }
-            }
-            checkersList.add(check);
-        }
-        return checkersList;
-    }
-
-    /**
-     * Returns Stringified checkerlist configuration.
-     * @param chl The internal list of checkers.
-     * @return The string list of checkers prefixed with state.
-     */
-    protected String checkerListToCheckerListArg(List<CheckerItem> chl) {
-        StringBuilder checkerListArg = new StringBuilder();
-        for (int i = 0; i < chl.size(); ++i) {
-            if (chl.get(i).getLastAction() == LAST_ACTION.SELECTION)
-                checkerListArg.append(CHECKER_ENABLED + chl.get(i).getText() + CHECKER_SEPARATOR);
-            else
-                checkerListArg.append(CHECKER_DISABLED + chl.get(i).getText() + CHECKER_SEPARATOR);
-        }
-        return checkerListArg.toString();
-    }
-
     /**
      * Loads config from {@link CcConfiguration}.
      * @param resetToDefault If set, the default config is used.
@@ -469,9 +414,9 @@ public void setFields() {
                 break;
         }
         codeCheckerDirectoryField.setText(config.get(ConfigTypes.CHECKER_PATH));
-        checkerListArg = config.get(ConfigTypes.CHECKER_LIST);
         cLoggers.setText(config.get(ConfigTypes.COMPILERS));
         numThreads.setText(config.get(ConfigTypes.ANAL_THREADS));
+        analysisOptions.setText(config.get(ConfigTypes.ANAL_OPTIONS));
     }
 
     /**
@@ -481,7 +426,6 @@ public void setFields() {
     public Map<ConfigTypes, String> getConfigFromFields() {
         Map<ConfigTypes, String> conf = new HashMap<>();
         conf.put(ConfigTypes.CHECKER_PATH, codeCheckerDirectoryField.getText());
-        conf.put(ConfigTypes.CHECKER_LIST, checkerListArg);
         conf.put(ConfigTypes.ANAL_THREADS, numThreads.getText());
         conf.put(ConfigTypes.COMPILERS, cLoggers.getText());
         return conf;
@@ -493,7 +437,7 @@ public Map<ConfigTypes, String> getConfigFromFields() {
     public void saveConfig() {
         Map<ConfigTypes, String> conf = new HashMap<ConfigTypes, String>();
         conf.put(ConfigTypes.CHECKER_PATH, codeCheckerDirectoryField.getText());
-        conf.put(ConfigTypes.CHECKER_LIST, checkerListArg);
+        conf.put(ConfigTypes.ANAL_OPTIONS, analysisOptions.getText());
         conf.put(ConfigTypes.ANAL_THREADS, numThreads.getText());
         conf.put(ConfigTypes.COMPILERS, cLoggers.getText());
         conf.put(ConfigTypes.RES_METHOD, currentResMethod.toString());

bundles/org.codechecker.eclipse.plugin/src/org/codechecker/eclipse/plugin/config/Config.java

@@ -25,12 +25,12 @@ public enum ConfigTypes {
         RES_METHOD("PATH"),
         COMPILERS("gcc:g++:clang:clang++"),
         ANAL_THREADS("4"),
-        CHECKER_LIST("enabled_checkers"),
+        ANAL_OPTIONS(""),
         // Project configuration values
         IS_GLOBAL("true"),
         CHECKER_WORKSPACE("codechecker_workdir");
 
-        public static Set<ConfigTypes> COMMON_TYPE = EnumSet.range(CHECKER_PATH, CHECKER_LIST);
+        public static Set<ConfigTypes> COMMON_TYPE = EnumSet.range(CHECKER_PATH, ANAL_OPTIONS);
         public static Set<ConfigTypes> PROJECT_TYPE = EnumSet.range(IS_GLOBAL, CHECKER_WORKSPACE);
         private String defaultValue;