Commit 0ecf21d0 authored by Andrey Filippov's avatar Andrey Filippov

changed hadling settings to tolerate toool configs editing

parent c9ce9dff
...@@ -26,6 +26,8 @@ ...@@ -26,6 +26,8 @@
*******************************************************************************/ *******************************************************************************/
package com.elphel.vdt.core.options; package com.elphel.vdt.core.options;
import java.util.List;
import org.eclipse.jface.preference.IPreferenceStore; import org.eclipse.jface.preference.IPreferenceStore;
/** /**
...@@ -96,7 +98,25 @@ public abstract class Option { ...@@ -96,7 +98,25 @@ public abstract class Option {
} else if (store.contains(key)) { } else if (store.contains(key)) {
value = store.getString(key); value = store.getString(key);
setValue(value); setValue(value);
} else { } else {
// Trying to get with different index
//See TODO: 07/01/2016 in OptionUtils
// public static List<String> getStoreContext( final String contextID
// if (contextID.equals("cocotb")) {
if (!key.startsWith(OptionsUtils.KEY_CONTENT)){ // Otherwise will be infinite loop
List<String> context = OptionsUtils.getStoreContext(contextID,store);
String patt=contextID+"_[^_]*"+key.substring( key.indexOf("_",contextID.length()+1));
for (String skey:context){
if (skey.matches(patt)){
value = store.getString(skey);
setValue(value);
System.out.println("Option.doLoad(): in context "+contextID+" - found replacement for "+key+": "+skey);
return value;
}
}
}
value = doLoadDefault(); value = doLoadDefault();
} }
return value; return value;
......
...@@ -185,7 +185,8 @@ public class OptionsCore { ...@@ -185,7 +185,8 @@ public class OptionsCore {
doLoadContextOptions(context, store); doLoadContextOptions(context, store);
} }
public static void doLoadContextOptions(Context context, IPreferenceStore store) { public static void doLoadContextOptions(Context context, IPreferenceStore store) {
// System.out.println("doLoadContextOptions("+context.getName()+")");
List<Parameter> list = context.getParams(); List<Parameter> list = context.getParams();
if (list.isEmpty()) if (list.isEmpty())
return; return;
...@@ -194,10 +195,11 @@ public class OptionsCore { ...@@ -194,10 +195,11 @@ public class OptionsCore {
for (Parameter param : list) { for (Parameter param : list) {
Option option; Option option;
if (param.getType().isList()) /* Null pointer here on error */ if (param.getType().isList()) /* Null pointer here on error */
option = new ParamBasedListOption(param); option = new ParamBasedListOption(param);
else else
option = new ParamBasedOption(param); option = new ParamBasedOption(param);
option.setPreferenceStore(store); option.setPreferenceStore(store);
option.doLoad(); option.doLoad();
} }
...@@ -216,17 +218,27 @@ public class OptionsCore { ...@@ -216,17 +218,27 @@ public class OptionsCore {
finalizeDoStore(store); finalizeDoStore(store);
} }
public static void doStoreContextOptions(Context context, IProject project) { public static void doStoreContextOptions(Context context, IProject project) {
if ("cocotb".equals(context.getName())){
System.out.println("doStoreContextOptions('cocotb'), project="+project);
}
IPreferenceStore store = getPreferenceStore(context, project); IPreferenceStore store = getPreferenceStore(context, project);
doStoreContextOptions(context, store); doStoreContextOptions(context, store);
} }
public static void doStoreContextOptions(Context context) { public static void doStoreContextOptions(Context context) {
if ("cocotb".equals(context.getName())){
System.out.println("doStoreContextOptions('cocotb')");
}
IPreferenceStore store = VerilogPlugin.getDefault().getPreferenceStore(); IPreferenceStore store = VerilogPlugin.getDefault().getPreferenceStore();
doStoreContextOptions(context, store); doStoreContextOptions(context, store);
} }
public static void doStoreContextOptions(Context context, IPreferenceStore store) { public static void doStoreContextOptions(Context context, IPreferenceStore store) {
if ("cocotb".equals(context.getName())){
System.out.println("static doStoreContextOptions('cocotb')");
}
List<Parameter> list = context.getParams(); List<Parameter> list = context.getParams();
if (list.isEmpty()) if (list.isEmpty())
return; return;
...@@ -240,7 +252,7 @@ public class OptionsCore { ...@@ -240,7 +252,7 @@ public class OptionsCore {
option.setPreferenceStore(store); option.setPreferenceStore(store);
option.doStore(); option.doStore();
} }
OptionsUtils.setStoreVersion(context.getVersion(), context.getName(), store); OptionsUtils.setStoreVersion(context.getContextVersion(), context.getName(), store);
finalizeDoStore(store); finalizeDoStore(store);
} }
...@@ -249,7 +261,8 @@ public class OptionsCore { ...@@ -249,7 +261,8 @@ public class OptionsCore {
try { try {
if (store.needsSaving()) if (store.needsSaving())
((ScopedPreferenceStore)store).save(); ((ScopedPreferenceStore)store).save();
} catch (IOException e) { } catch (IOException e) {
System.out.println("finalizeDoStore() - out of sync (edited manually settings file?");
// Nothing do do, we don't need to bother the user // Nothing do do, we don't need to bother the user
} }
} }
...@@ -283,21 +296,30 @@ public class OptionsCore { ...@@ -283,21 +296,30 @@ public class OptionsCore {
finalizeDoStore(store); finalizeDoStore(store);
} }
private static void checkVersionCompatibility(Context context, IPreferenceStore store) { private static void checkVersionCompatibility(Context context, IPreferenceStore store) {
if (OptionsUtils.isVersionCompatible(context.getVersion(), context.getName(), store)) // Context Version is a version of the file, like <vdt-project version = "0.8">
if (OptionsUtils.isVersionCompatible(context.getContextVersion(), context.getName(), store))
return; return;
Shell shell = VerilogPlugin.getActiveWorkbenchShell(); Shell shell = VerilogPlugin.getActiveWorkbenchShell();
String message = "Version of TSL description has been changed.\nDo you wish to delete stored values?"; String message = "Version of TSL description for context '"+ context.getName()+"' has been changed.\n"+
"What do you wish to do with the stored values?\n"+
"'Delete' resets all context values to defaults\n"+
"'Update' tries to convert settings to newer format\n"+
"'Cancel' does nothing, keeping existing files (until saved).";
MessageDialog messageBox = new MessageDialog( shell, "Warning", null MessageDialog messageBox = new MessageDialog( shell, "Warning", null
, message , message
, MessageDialog.WARNING , MessageDialog.WARNING
, new String[]{"Yes", "No"} , new String[]{"Delete", "Update", "Cancel"}
, 1); , 1);
messageBox.open(); messageBox.open();
if (messageBox.getReturnCode() == 0) { int returnCode = messageBox.getReturnCode();
if (returnCode == 0) {
OptionsUtils.clearStore(context.getName(), store); OptionsUtils.clearStore(context.getName(), store);
finalizeDoStore(store); finalizeDoStore(store);
} else if (returnCode == 1) {
OptionsUtils.updateStore(context.getName(), store);
finalizeDoStore(store);
} }
} }
......
...@@ -27,9 +27,13 @@ ...@@ -27,9 +27,13 @@
package com.elphel.vdt.core.options; package com.elphel.vdt.core.options;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator; import java.util.Iterator;
import java.util.List; import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.eclipse.jface.preference.IPreferenceStore; import org.eclipse.jface.preference.IPreferenceStore;
...@@ -51,6 +55,7 @@ class OptionsUtils { ...@@ -51,6 +55,7 @@ class OptionsUtils {
public static final String KEY_VERSION = "com.elphel.store.version."; public static final String KEY_VERSION = "com.elphel.store.version.";
private static final String SEPARATOR = "<-@##@->"; private static final String SEPARATOR = "<-@##@->";
private static final String CONTEXT_SEPARATOR = "_@_";
public static String convertListToString(List<String> list) { public static String convertListToString(List<String> list) {
String value = ""; String value = "";
...@@ -94,9 +99,21 @@ class OptionsUtils { ...@@ -94,9 +99,21 @@ class OptionsUtils {
} }
public static String toKey(Parameter param) { public static String toKey(Parameter param) {
Context context = param.getContext(); // Context context = param.getContext();
int index = context.getParams().indexOf(param); // int index = context.getParams().indexOf(param);
return "" + param.getContext().getName() + "_" + index + "_" + param.getID(); // return "" + param.getContext().getName() + "_" + index + "_" + param.getID();
return "" + param.getContext().getName() + CONTEXT_SEPARATOR + param.getID();
/* TODO: 07/02/2016: Disabled using parameter index in the key - that was causing VDT to forget all settings
* when number of tool parameters was modified.
* ContextOptionsDialog */
//TODO: 07/01/2016: Understand why index is needed? It changes when xml files are edited (added/deleted parameters
// But each parameter ID + context should already be unique
// So meanwhile I'll add searching for same context/parameter with other indices if the exact match is not found
} }
...@@ -171,7 +188,50 @@ class OptionsUtils { ...@@ -171,7 +188,50 @@ class OptionsUtils {
store.setToDefault(getContentKey(contextID)); store.setToDefault(getContentKey(contextID));
store.setToDefault(getVersionKey(contextID)); store.setToDefault(getVersionKey(contextID));
} }
public static void updateStore(final String contextID, IPreferenceStore store) {
List<String> contextList = getStoreContext(contextID, store);
Map<String,String> newKeyValues= new HashMap<String,String>();
Pattern patt_new=Pattern.compile("[a-zA-Z0-9_]*"+CONTEXT_SEPARATOR);
Pattern patt_indx=Pattern.compile("([a-zA-Z0-9_]*)_[0-9]+_(.*)");
for (String key : contextList) {
if (patt_new.matcher(key).lookingAt()){
newKeyValues.put(key, store.getString(key)); // Found new <context>_@_<parameter>
} else {
Matcher matcher = patt_indx.matcher(key);
if (matcher.lookingAt()) {
String newKey = matcher.group(1)+CONTEXT_SEPARATOR+matcher.group(2);
if (!newKeyValues.containsKey(newKey)){ // Only if it is not yet set - not to overwrite the new value
newKeyValues.put(newKey, store.getString(key)); // Found new <context>_@_<parameter>
}
}
}
store.setToDefault(key);
}
// Save converted/filtered values, if they are not empty (will not be able to overwrite non-empty default)
for (String key :newKeyValues.keySet()){
store.putValue(key,newKeyValues.get(key));
}
// now regenerate context string
//Rebuild the list, getting rid of indexed entries
contextList = new ArrayList<String>();
for (String key :newKeyValues.keySet()){
contextList.add(key);
}
final String contentKey = getContentKey(contextID);
ValueBasedListOption option = new ValueBasedListOption(contentKey, contextID, contextList);
option.setPreferenceStore(store);
option.doStore(contextList);
// store.setToDefault(getContentKey(contextID));
store.setToDefault(getVersionKey(contextID));
}
public static void setStoreVersion( final String version public static void setStoreVersion( final String version
, final String contextID , final String contextID
, IPreferenceStore store) , IPreferenceStore store)
...@@ -189,7 +249,10 @@ class OptionsUtils { ...@@ -189,7 +249,10 @@ class OptionsUtils {
, IPreferenceStore store ) , IPreferenceStore store )
{ {
boolean compatible; boolean compatible;
final String versionKey = getVersionKey(contextID); final String versionKey = getVersionKey(contextID);
if (versionKey.endsWith("ocotb")){
System.out.println("isVersionCompatible(cocotb)");
}
if (version == null) { if (version == null) {
compatible = ! store.contains(versionKey); compatible = ! store.contains(versionKey);
} else if (store.contains(versionKey)) { } else if (store.contains(versionKey)) {
...@@ -200,7 +263,8 @@ class OptionsUtils { ...@@ -200,7 +263,8 @@ class OptionsUtils {
return compatible; return compatible;
} }
private static List<String> getStoreContext( final String contextID public static List<String> getStoreContext( final String contextID
// private static List<String> getStoreContext( final String contextID
, IPreferenceStore store ) { , IPreferenceStore store ) {
List<String> context = new ArrayList<String>(); List<String> context = new ArrayList<String>();
ValueBasedListOption option = new ValueBasedListOption(getContentKey(contextID), contextID, context); ValueBasedListOption option = new ValueBasedListOption(getContentKey(contextID), contextID, context);
......
...@@ -94,7 +94,7 @@ public class ValueBasedListOption extends Option { ...@@ -94,7 +94,7 @@ public class ValueBasedListOption extends Option {
/** /**
* Load the default option value from persistent storage * Load the default option value from persistent storage
* *
* @return the sequnce of the list items separated by SEPARATOR. * @return the sequence of the list items separated by SEPARATOR.
*/ */
public String doLoadDefault() { public String doLoadDefault() {
List<String> list = doLoadDefaultList(); List<String> list = doLoadDefaultList();
...@@ -110,7 +110,7 @@ public class ValueBasedListOption extends Option { ...@@ -110,7 +110,7 @@ public class ValueBasedListOption extends Option {
/** /**
* Save value to persistent storage * Save value to persistent storage
* *
* @param value the sequnce of the list items separated by SEPARATOR. * @param value the sequence of the list items separated by SEPARATOR.
*/ */
public boolean doStore(String value) { public boolean doStore(String value) {
List<String> list = OptionsUtils.convertStringToList(value); List<String> list = OptionsUtils.convertStringToList(value);
......
...@@ -37,7 +37,8 @@ import com.elphel.vdt.core.tools.contexts.Context; ...@@ -37,7 +37,8 @@ import com.elphel.vdt.core.tools.contexts.Context;
public class ParamNodeReader extends AbstractConditionNodeReader { public class ParamNodeReader extends AbstractConditionNodeReader {
private List<Parameter> paramList = new ArrayList<Parameter>(); private List<Parameter> paramList = new ArrayList<Parameter>();
private List<String> paramIdList = new ArrayList<String>();
public ParamNodeReader(XMLConfig config, Context context) { public ParamNodeReader(XMLConfig config, Context context) {
super(config, context); super(config, context);
...@@ -45,8 +46,15 @@ public class ParamNodeReader extends AbstractConditionNodeReader { ...@@ -45,8 +46,15 @@ public class ParamNodeReader extends AbstractConditionNodeReader {
public void readNode(Node node, Condition condition) throws ConfigException { public void readNode(Node node, Condition condition) throws ConfigException {
if(XMLConfig.isElemNode(node, XMLConfig.PARAMETER_TAG)) { if(XMLConfig.isElemNode(node, XMLConfig.PARAMETER_TAG)) {
try { try {
paramList.add(readParam(node, condition)); Parameter param = readParam(node, condition);
String id=param.getID();
if (paramIdList.contains(id)){
System.out.println("Warning: duplicate parameter ('" + id + "') in context '" + context + "' defined in "+param.getSourceXML());
// throw new ConfigException("Duplicate parameter ('" + id + "') in context '" + context + "' defined in "+param.getSourceXML());
}
paramIdList.add(id);
paramList.add(param);
} catch(ConfigException e) { } catch(ConfigException e) {
config.logError(e); config.logError(e);
} }
......
...@@ -774,7 +774,7 @@ public class XMLConfig extends Config { ...@@ -774,7 +774,7 @@ public class XMLConfig extends Config {
context.setInputDialogLabel(contextInputDefinition.getLabel()); context.setInputDialogLabel(contextInputDefinition.getLabel());
context.setCommandLinesBlocks(contextCommandLinesBlocks); context.setCommandLinesBlocks(contextCommandLinesBlocks);
context.setVersion(currentFileVersion); context.setContextVersion(currentFileVersion);
return context; return context;
} }
...@@ -1362,7 +1362,8 @@ public class XMLConfig extends Config { ...@@ -1362,7 +1362,8 @@ public class XMLConfig extends Config {
rootNode = node; rootNode = node;
currentFileVersion = getAttributeValue(node, ROOT_VERSION_ATTR); currentFileVersion = getAttributeValue(node, ROOT_VERSION_ATTR);
} }
} }
......
...@@ -72,7 +72,7 @@ public abstract class Context { ...@@ -72,7 +72,7 @@ public abstract class Context {
private List<String> createdControlFiles = new ArrayList<String>(); private List<String> createdControlFiles = new ArrayList<String>();
private boolean initialized = false; private boolean initialized = false;
private String workingDirectory; private String workingDirectory;
private String version; private String contextVersion;
// private Context context=null; // private Context context=null;
private int currentHash; // calculated during buildparam from non-parser command blocks and command files. private int currentHash; // calculated during buildparam from non-parser command blocks and command files.
protected Context(String name, protected Context(String name,
...@@ -127,12 +127,12 @@ public abstract class Context { ...@@ -127,12 +127,12 @@ public abstract class Context {
initialized = true; initialized = true;
} }
public void setVersion(String version) { public void setContextVersion(String version) {
this.version = version; this.contextVersion = version;
} }
public String getVersion() { public String getContextVersion() {
return version; return contextVersion;
} }
public void setParams(List<Parameter> params) throws ConfigException { public void setParams(List<Parameter> params) throws ConfigException {
......
...@@ -85,9 +85,20 @@ public class ContextOptionsDialog extends Dialog { ...@@ -85,9 +85,20 @@ public class ContextOptionsDialog extends Dialog {
// this.designFlowView=null; // Andrey // this.designFlowView=null; // Andrey
} }
protected void okPressed() { protected void okPressed() {
/* Currently multiple same-named parameters in the same context have warnings.
* What happens is that after parameters are changed in the dialog, the new value is
* applied only to the first entry, then the saecond (unmodified) entry is processed
* and overwrites the modified value (effectively disabling modification. Another
* option would be to partially restore name+index in the preference store - just
* instead of the index of all parameters, use index among those with the same ID.
* In that case rare use of multiple same-name parameters (as was used in the demo
* tools.xml - same name parameters where inside <if></if>) will not cause troubles
* as it was when every change of the number of tool parameters made VDT to forget
* tool settings */
optionsBlock.performApply(); optionsBlock.performApply();
OptionsCore.doStoreContextOptions(context, store); OptionsCore.doStoreContextOptions(context, store);
context.setWorkingDirectory(location); context.setWorkingDirectory(location);
try { try {
context.buildParams(); context.buildParams();
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment