Global macros related changes

Author: Chsudeepta

base/uk.ac.stfc.isis.ibex.configserver.tests/src/uk/ac/stfc/isis/ibex/configserver/tests/json/JsonConvertersTest.java

@@ -242,7 +242,7 @@ public void conversion_config_to_string() throws ConversionException {
 		//Arrange
 		Function<Configuration, String> conv = new JsonConverters().configToString();
 		Configuration testConfig = new Configuration(configName, configDescription);
-		String expected = "{\"name\":\"" + configName + "\",\"description\":\"" + configDescription + "\",\"isProtected\":false,\"isDynamic\":false,\"configuresBlockGWAndArchiver\":false,\"iocs\":[],\"blocks\":[],\"groups\":[],\"components\":[],\"history\":[]}";
+		String expected = "{\"name\":\"" + configName + "\",\"description\":\"" + configDescription + "\",\"isProtected\":false,\"isDynamic\":false,\"configuresBlockGWAndArchiver\":false,\"iocs\":[],\"blocks\":[],\"groups\":[],\"components\":[],\"history\":[],\"globalmacros\":[]}";
 
 		//Act
 		String test = conv.apply(testConfig);

base/uk.ac.stfc.isis.ibex.configserver/src/uk/ac/stfc/isis/ibex/configserver/Configurations.java

@@ -1,7 +1,7 @@
 
 /*
 * This file is part of the ISIS IBEX application.
-* Copyright (C) 2012-2015 Science & Technology Facilities Council.
+* Copyright (C) 2012-2025 Science & Technology Facilities Council.
 * All rights reserved.
 *
 * This program is distributed in the hope that it will be useful.

base/uk.ac.stfc.isis.ibex.configserver/src/uk/ac/stfc/isis/ibex/configserver/configuration/Configuration.java

@@ -50,7 +50,7 @@ public class Configuration extends ModelObject {
 	private List<Group> groups = new ArrayList<>();
 	private List<ComponentInfo> components = new ArrayList<>();
 	private List<String> history = new ArrayList<>();
-	private List<GlobalMacro> globalMacros = new ArrayList<>();
+	private List<GlobalMacro> globalmacros = new ArrayList<>();
 
 	/**
 	 * Create a new configuration.
@@ -82,12 +82,12 @@ public Configuration(String name, String description) {
 	 *                        automatically
 	 * @param configuresBlockGWAndArchiver  True this configuration includes the block gateway and archive files; 
 	 * 		          False these are generated by the block server
-	 * @param globalMacros    The global macros 
+	 * @param globalmacros    The global macros 
 	 */
 	public Configuration(String name, String description, String defaultSynoptic, Collection<Ioc> iocs,
 			Collection<Block> blocks, Collection<Group> groups, Collection<ComponentInfo> components,
 			Collection<String> history, boolean isProtected, boolean isDynamic,
-			boolean configuresBlockGWAndArchiver, Collection<GlobalMacro> globalMacros) {
+			boolean configuresBlockGWAndArchiver, Collection<GlobalMacro> globalmacros) {
 		this.name = name;
 		this.description = description;
 		this.synoptic = defaultSynoptic == null || defaultSynoptic.equals("") ? ConfigEditing.NONE_SYNOPTIC_NAME
@@ -117,9 +117,9 @@ public Configuration(String name, String description, String defaultSynoptic, Co
 			this.history.add(date);
 		}
 
-		if (null != globalMacros) {
-			for (GlobalMacro globalMacro : globalMacros) {
-                this.globalMacros.add(new GlobalMacro(globalMacro));
+		if (null != globalmacros) {
+			for (GlobalMacro globalMacro : globalmacros) {
+                this.globalmacros.add(new GlobalMacro(globalMacro));
             }
 		}
 	}
@@ -159,7 +159,7 @@ public Configuration(String name, String description, String defaultSynoptic, Co
 	public Configuration(Configuration other) {
 		this(other.name(), other.description(), other.synoptic(), other.getIocs(), other.getBlocks(), other.getGroups(),
 				other.getComponents(), other.getHistory(), other.isProtected, other.isDynamic,
-				other.configuresBlockGWAndArchiver, other.getGlobalMacros());
+				other.configuresBlockGWAndArchiver, other.getGlobalmacros());
 		this.pv = other.pv;
 	}
 
@@ -291,7 +291,7 @@ public String getName() {
 	/**
 	 * @return A collection of the configuration's blocks
 	 */
-	public List<GlobalMacro> getGlobalMacros() {
-		return globalMacros != null ? new ArrayList<>(globalMacros) : Collections.<GlobalMacro>emptyList();
+	public List<GlobalMacro> getGlobalmacros() {
+		return globalmacros != null ? new ArrayList<>(globalmacros) : Collections.<GlobalMacro>emptyList();
 	}
 }

base/uk.ac.stfc.isis.ibex.configserver/src/uk/ac/stfc/isis/ibex/configserver/configuration/GlobalMacro.java

@@ -18,8 +18,8 @@
 
 package uk.ac.stfc.isis.ibex.configserver.configuration;
 
-import java.util.ArrayList;
-import java.util.List;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.Optional;
 
 import uk.ac.stfc.isis.ibex.model.ModelObject;
@@ -30,11 +30,11 @@
  * Contains the IOC name, or none, and a list of associated macros
  * 
  */
-public class GlobalMacro extends ModelObject  {
+public class GlobalMacro extends ModelObject  implements Comparable<GlobalMacro> {
 
 	private final String name;	
 
-	private List<Macro> macros;
+	private Map<String, String> macros;
 
     /**
      * Create a Global Macro with a given name.
@@ -52,7 +52,8 @@ public GlobalMacro(String name) {
      */
 	public GlobalMacro(GlobalMacro globalMacro) {
 		this.name = globalMacro.getName();
-		this.macros = new ArrayList<>(globalMacro.getMacros());
+		//this.macros = new ArrayList<>(globalMacro.getMacros());
+		this.macros = new HashMap<String, String>(globalMacro.getMacros());
 	}
 
     /**
@@ -65,16 +66,19 @@ public String getName() {
     /**
      * @return A collection of  macros
      */
-	public List<Macro> getMacros() {
-		return Optional.ofNullable(macros).orElseGet(ArrayList::new);
+	public Map<String, String> getMacros() {
+		return Optional.ofNullable(macros).orElseGet(HashMap::new);
 	}
-	
-    /**
-     * @param macros
-     *            Set the IOC macros
-     */
-	public void setMacros(List<Macro> macros) {
-		firePropertyChange("macros", this.macros, this.macros = macros);
+
+	/**
+	 * Compares this GlobalMacro to another based on name. Used for sorting.
+	 */
+	@Override
+	public int compareTo(GlobalMacro other) {
+		if (this.name != null && other.name != null) {
+			return this.name.compareTo(other.name);
+		}
+		return 0;
 	}
 
 }

base/uk.ac.stfc.isis.ibex.configserver/src/uk/ac/stfc/isis/ibex/configserver/editing/EditableConfiguration.java

@@ -1,6 +1,6 @@
 
 /*
- * This file is part of the ISIS IBEX application. Copyright (C) 2012-2017
+ * This file is part of the ISIS IBEX application. Copyright (C) 2012-2025
  * Science & Technology Facilities Council. All rights reserved.
  *
  * This program is distributed in the hope that it will be useful. This program
@@ -36,6 +36,7 @@
 import uk.ac.stfc.isis.ibex.configserver.configuration.Block;
 import uk.ac.stfc.isis.ibex.configserver.configuration.ComponentInfo;
 import uk.ac.stfc.isis.ibex.configserver.configuration.Configuration;
+import uk.ac.stfc.isis.ibex.configserver.configuration.GlobalMacro;
 import uk.ac.stfc.isis.ibex.configserver.configuration.Group;
 import uk.ac.stfc.isis.ibex.configserver.configuration.Ioc;
 import uk.ac.stfc.isis.ibex.configserver.configuration.Macro;
@@ -142,7 +143,8 @@ public class EditableConfiguration extends ModelObject implements GroupNamesProv
     /** Current error message to be displayed **/
     private String currentErrorMessage = noError;
 
-
+    /** The global macros associated with any configuration. */
+    private List<GlobalMacro> globalmacros;
 
     /**
      * Listener for block renaming events.
@@ -180,69 +182,67 @@ public void propertyChange(PropertyChangeEvent evt) {
      * @param pvs
      *            The PVs available to the configuration
      */
-    public EditableConfiguration(
-	    Configuration config,
-	    Collection<EditableIoc> iocs,
-	    Collection<Configuration> components, 
-	    Collection<PV> pvs) {
-	this.name = config.name();
-	this.description = config.description();
-	this.synoptic = config.synoptic();
-	this.isProtected = config.isProtected();
-	this.isDynamic = config.isDynamic();
-	this.configuresBlockGWAndArchiver = config.configuresBlockGWAndArchiver();
-	originalProtectedFlag = this.isProtected;
-	this.allIocs = new ArrayList<>();
-	this.managerMode = ManagerModeModel.getInstance();
-	this.isSaveButtonEnabled = true;
-	this.enableSaveAsButton = true;
-	managerModePv = managerMode.getManagerModeObservable();
-
-	for (EditableIoc ioc : iocs) {
-	    EditableIoc newIoc = new EditableIoc(ioc, ioc.getDescription());
-	    newIoc.setAvailableMacros(new ArrayList<>(ioc.getAvailableMacros()));
-	    this.allIocs.add(newIoc);
-	}
+	public EditableConfiguration(Configuration config, Collection<EditableIoc> iocs,
+			Collection<Configuration> components, Collection<PV> pvs) {
+		this.name = config.name();
+		this.description = config.description();
+		this.synoptic = config.synoptic();
+		this.isProtected = config.isProtected();
+		this.isDynamic = config.isDynamic();
+		this.configuresBlockGWAndArchiver = config.configuresBlockGWAndArchiver();
+		originalProtectedFlag = this.isProtected;
+		this.allIocs = new ArrayList<>();
+		this.managerMode = ManagerModeModel.getInstance();
+		this.isSaveButtonEnabled = true;
+		this.enableSaveAsButton = true;
+		managerModePv = managerMode.getManagerModeObservable();
+
+		for (EditableIoc ioc : iocs) {
+			EditableIoc newIoc = new EditableIoc(ioc, ioc.getDescription());
+			newIoc.setAvailableMacros(new ArrayList<>(ioc.getAvailableMacros()));
+			this.allIocs.add(newIoc);
+		}
 
-	this.history = new ArrayList<>();
+		this.history = new ArrayList<>();
 
-	for (String date : config.getHistory()) {
-	    this.history.add(date);
-	}
+		for (String date : config.getHistory()) {
+			this.history.add(date);
+		}
 
-	this.pvs = new ArrayList<>(pvs);
+		this.pvs = new ArrayList<>(pvs);
 
-	for (Block block : config.getBlocks()) {
-	    EditableBlock eb = new EditableBlock(block);
-	    allBlocks.add(eb);
-	    addRenameListener(eb);
-	}
+		for (Block block : config.getBlocks()) {
+			EditableBlock eb = new EditableBlock(block);
+			allBlocks.add(eb);
+			addRenameListener(eb);
+		}
 
-	for (Group group : config.getGroups()) {
-		if (!group.hasComponent()) {
-			editableGroups.add(new EditableGroup(this, group));
+		for (Group group : config.getGroups()) {
+			if (!group.hasComponent()) {
+				editableGroups.add(new EditableGroup(this, group));
+			}
 		}
-	}
-	
-	editableGroups = new ArrayList<>(DisplayUtils.removeOtherGroup(editableGroups));
 
-	for (EditableIoc ioc : allIocs) {
-	    iocMap.put(ioc.getName(), ioc);
-	}
-	initMacros(iocMap);
+		editableGroups = new ArrayList<>(DisplayUtils.removeOtherGroup(editableGroups));
 
-	for (Ioc ioc : config.getIocs()) {
-	    addIoc(convertIoc(ioc));
-	}
+		for (EditableIoc ioc : allIocs) {
+			iocMap.put(ioc.getName(), ioc);
+		}
+		initMacros(iocMap);
+
+		for (Ioc ioc : config.getIocs()) {
+			addIoc(convertIoc(ioc));
+		}
 
-	Collection<Configuration> selectedComponents = getComponentDetails(config.getComponents(), components);
-	editableComponents = new EditableComponents(selectedComponents, components);
-	editableComponents.addPropertyChangeListener(evt -> updateComponents());
+		Collection<Configuration> selectedComponents = getComponentDetails(config.getComponents(), components);
+		editableComponents = new EditableComponents(selectedComponents, components);
+		editableComponents.addPropertyChangeListener(evt -> updateComponents());
 
-	updateComponents();
-	setEnableSaveAsButton();
-	addObserver();
-    }
+		updateComponents();
+		setEnableSaveAsButton();
+		addObserver();
+		this.globalmacros = config.getGlobalmacros();
+	}
 
     private EditableIoc convertIoc(Ioc ioc) {
 	final EditableIoc generalIOC = iocMap.get(ioc.getName());
@@ -666,28 +666,31 @@ public void removeGroup(EditableGroup group) {
 	firePropertyChange("groups", groupsBefore, transformGroups());
     }
 
-    /**
-     * Return in a form suitable for saving as a configuration.
-     * 
-     * @return the underlying configuration
-     */
-    public Configuration asConfiguration() {
-	Configuration config = new Configuration(getName(), getDescription(), getSynoptic(), transformIocs(), transformBlocks(),
-		transformGroups(), transformComponents(), getHistory(), getIsProtected(), getIsDynamic(), getIfconfiguresBlockGWAndArchiver());
-	return new ComponentFilteredConfiguration(config);
-    }
+	/**
+	 * Return in a form suitable for saving as a configuration.
+	 * 
+	 * @return the underlying configuration
+	 */
+	public Configuration asConfiguration() {
+		Configuration config = new Configuration(getName(), getDescription(), getSynoptic(), transformIocs(),
+				transformBlocks(), transformGroups(), transformComponents(), getHistory(), getIsProtected(),
+				getIsDynamic(), getIfconfiguresBlockGWAndArchiver(), getGlobalmacros());
+		return new ComponentFilteredConfiguration(config);
+	}
 
-    /**
-     * Return in a form suitable for saving as a component - ie without
-     * contained components.
-     * 
-     * @return the configuration as a component
-     */
-    public Configuration asComponent() {
-	Configuration config = asConfiguration();
-	return new Configuration(config.name(), config.description(), config.synoptic(), config.getIocs(),
-		config.getBlocks(), config.getGroups(), Collections.<ComponentInfo>emptyList(), config.getHistory(), config.isProtected(), config.isDynamic(), config.configuresBlockGWAndArchiver());
-    }
+	/**
+	 * Return in a form suitable for saving as a component - ie without contained
+	 * components.
+	 * 
+	 * @return the configuration as a component
+	 */
+	public Configuration asComponent() {
+		Configuration config = asConfiguration();
+		return new Configuration(config.name(), config.description(), config.synoptic(), config.getIocs(),
+				config.getBlocks(), config.getGroups(), Collections.<ComponentInfo>emptyList(), config.getHistory(),
+				config.isProtected(), config.isDynamic(), config.configuresBlockGWAndArchiver(),
+				config.getGlobalmacros());
+	}
 
     /**
      * Swaps the indices of two groups in the configuration (for moving them up
@@ -898,4 +901,11 @@ public void close() {
 	this.managerModeObservable.ifPresent(ManagerModeObserver::close);
 	this.managerModeObservable = Optional.empty();
     }
+
+	/**
+	 * @return the globalmacros
+	 */
+	public List<GlobalMacro> getGlobalmacros() {
+		return globalmacros;
+	}
 }

base/uk.ac.stfc.isis.ibex.configserver/src/uk/ac/stfc/isis/ibex/configserver/internal/ComponentFilteredConfiguration.java

@@ -1,7 +1,7 @@
 
 /*
 * This file is part of the ISIS IBEX application.
-* Copyright (C) 2012-2015 Science & Technology Facilities Council.
+* Copyright (C) 2012-2025 Science & Technology Facilities Council.
 * All rights reserved.
 *
 * This program is distributed in the hope that it will be useful.
@@ -41,9 +41,10 @@ public class ComponentFilteredConfiguration extends Configuration {
      *            The unfiltered configuration
      */
 	public ComponentFilteredConfiguration(Configuration other) {
-        super(other.name(), other.description(), other.synoptic(), filterIocs(other.getIocs()),
-                filterBlocks(other.getBlocks()), filterGroups(other.getGroups()), other.getComponents(),
-                other.getHistory(), other.isProtected(), other.isDynamic(), other.configuresBlockGWAndArchiver());
+		super(other.name(), other.description(), other.synoptic(), filterIocs(other.getIocs()),
+				filterBlocks(other.getBlocks()), filterGroups(other.getGroups()), other.getComponents(),
+				other.getHistory(), other.isProtected(), other.isDynamic(), other.configuresBlockGWAndArchiver(),
+				other.getGlobalmacros());
 	}
 
     /**

base/uk.ac.stfc.isis.ibex.targetplatform/targetplatform.target

@@ -91,8 +91,8 @@
 	</location>
 	<location includeAllPlatforms="false" includeConfigurePhase="false" includeMode="planner" includeSource="true" type="InstallableUnit">
 		<repository location="http://shadow.nd.rl.ac.uk/ICP_P2/Pydev/features/org.python.pydev.p2-repo/target/repository/"/>
-		<unit id="org.python.pydev.feature.feature.group" version="11.0.3.202408070859"/>
-		<unit id="org.python.pydev.feature.source.feature.group" version="11.0.3.202408070859"/>
+		<unit id="org.python.pydev.feature.feature.group" version="13.1.0.202511051529"/>
+		<unit id="org.python.pydev.feature.source.feature.group" version="13.1.0.202511051529"/>
 	</location>
 	<location includeDependencyDepth="none" includeDependencyScopes="compile" includeSource="true" missingManifest="generate" type="Maven">
 		<dependencies>