1 package org.simantics.spreadsheet.solver;
3 import java.io.Serializable;
4 import java.util.ArrayList;
5 import java.util.Arrays;
6 import java.util.Collection;
7 import java.util.Collections;
8 import java.util.HashMap;
9 import java.util.HashSet;
10 import java.util.List;
12 import java.util.Optional;
15 import org.simantics.databoard.Bindings;
16 import org.simantics.databoard.binding.Binding;
17 import org.simantics.databoard.binding.mutable.Variant;
18 import org.simantics.simulator.toolkit.StandardNodeManagerSupport;
19 import org.simantics.simulator.variable.exceptions.NodeManagerException;
20 import org.simantics.spreadsheet.ExternalRef;
21 import org.simantics.spreadsheet.ExternalRef.ExternalRefListener;
22 import org.simantics.spreadsheet.SpreadsheetCellStyle;
23 import org.simantics.spreadsheet.SpreadsheetVisitor;
24 import org.simantics.spreadsheet.solver.formula.SpreadsheetEvaluationEnvironment;
25 import org.simantics.spreadsheet.synchronization.LineNodeUpdater;
26 import org.simantics.spreadsheet.synchronization.LineUpdater;
27 import org.simantics.spreadsheet.synchronization.NullUpdater;
28 import org.simantics.spreadsheet.synchronization.StyleUpdater;
29 import org.simantics.structural.synchronization.base.ModuleUpdaterBase;
30 import org.simantics.structural.synchronization.base.ModuleUpdaterFactoryBase;
31 import org.simantics.structural.synchronization.base.SolverNameUtil;
32 import org.simantics.structural.synchronization.utils.ComponentFactory;
33 import org.simantics.structural.synchronization.utils.MappingBase;
34 import org.simantics.structural.synchronization.utils.Solver;
36 import it.unimi.dsi.fastutil.ints.Int2ObjectArrayMap;
37 import it.unimi.dsi.fastutil.longs.AbstractLongList;
38 import it.unimi.dsi.fastutil.longs.AbstractLongSet;
39 import it.unimi.dsi.fastutil.longs.Long2ObjectOpenHashMap;
40 import it.unimi.dsi.fastutil.longs.LongArraySet;
41 import it.unimi.dsi.fastutil.longs.LongLinkedOpenHashSet;
43 @SuppressWarnings("rawtypes")
44 public class SpreadsheetBook implements StandardNodeManagerSupport<SheetNode>, SpreadsheetElement<SpreadsheetElement, SpreadsheetElement>, Serializable, SheetNode<SpreadsheetEngine, SheetNode>, Solver, SolverNameUtil, ComponentFactory<SheetLineComponent>, ModuleUpdaterFactoryBase<SheetLineComponent> {
46 private static final long serialVersionUID = 7417208688311691396L;
48 public Serializable NotAvailableError = new Serializable() {
49 private static final long serialVersionUID = 2535371785498129460L;
52 public Long2ObjectOpenHashMap<AbstractLongSet> referenceMap = new Long2ObjectOpenHashMap<>();
54 private Int2ObjectArrayMap<SpreadsheetStyle> styles = new Int2ObjectArrayMap<>();
55 public ArrayList<SpreadsheetEngine> sheets = new ArrayList<SpreadsheetEngine>();
57 private SpreadsheetMapping mapping;
59 private String context;
61 private int idCounter = 1;
63 private transient boolean disposed = false;
65 public SpreadsheetBook(String context) {
67 mapping = new SpreadsheetMapping(new SheetLineComponent(""));
68 this.context = context;
71 public Map<Integer, SpreadsheetElement> children = new HashMap<>();
73 private boolean iterationEnabled;
75 public int getNewId(SpreadsheetElement element) {
76 int result = idCounter++;
77 children.put(result, element);
81 public long getEngineIndex(SpreadsheetEngine engine) {
82 for(int i=0;i<sheets.size();i++)
83 if(sheets.get(i) == engine) return i;
84 throw new IllegalStateException("Did not find sheet " + engine.getName());
87 public void registerReferences(long cell, AbstractLongList refs) {
88 for(int i=0;i<refs.size();i++) {
89 long key = refs.getLong(i);
90 AbstractLongSet set = referenceMap.get(key);
92 set = new LongArraySet();
93 referenceMap.put(key, set);
96 AbstractLongSet newSet = new LongLinkedOpenHashSet();
99 referenceMap.put(key, set);
106 public Binding getEngineBinding(SheetNode node) throws NodeManagerException {
107 Object value = getEngineValue(node);
108 if(value instanceof Variant) return Bindings.VARIANT;
109 if(value instanceof String) return Bindings.STRING;
110 if(value instanceof Boolean) return Bindings.BOOLEAN;
111 else return Bindings.getBindingUnchecked(value.getClass());
115 public Object getEngineValue(SheetNode node) {
116 if(node instanceof SpreadsheetCellContent) {
118 SpreadsheetCellContent scc = (SpreadsheetCellContent)node;
119 Object content = scc.cell.evaluate(SpreadsheetEvaluationEnvironment.getInstance(this));
120 if(content == null) return Variant.ofInstance("");
121 if(content instanceof Variant) return content;
122 else return Variant.ofInstance(content);
123 } catch (Throwable t) {
125 return Variant.ofInstance(t.toString());
127 } else if (node instanceof SpreadsheetCellContentExpression) {
128 SpreadsheetCellContentExpression scce = (SpreadsheetCellContentExpression)node;
129 if (scce.cell.content instanceof SpreadsheetFormula) {
130 SpreadsheetFormula formula = (SpreadsheetFormula)scce.cell.content;
131 return formula.expression;
132 } else if (scce.cell.content instanceof SpreadsheetSCLConstant) {
133 SpreadsheetSCLConstant sclConstant = (SpreadsheetSCLConstant) scce.cell.content;
134 return "=" + sclConstant.expression;
136 System.out.println("Broken SpreadsheetCellContentExpression possibly due to overwriting an existing expression with a constant or something else (current content is " + scce.cell.content + ")");
137 if (scce.cell.content instanceof Variant) {
138 return scce.cell.content;
140 return Variant.ofInstance(scce.cell.content);
143 } else if (node instanceof SpreadsheetTypeNode) {
144 SpreadsheetTypeNode stn = (SpreadsheetTypeNode)node;
146 } else if (node instanceof SpreadsheetCellStyle) {
147 int styleId = ((SpreadsheetCellStyle) node).cell.style;
148 SpreadsheetStyle style = getStyle(styleId);
150 style = SpreadsheetStyle.empty();
151 if (styleId != style.getStyleId())
152 new Exception("different style ids!" + styleId + " " + style.getStyleId()).printStackTrace();
156 } else if (node instanceof SpreadsheetCellEditable) {
157 boolean editable = ((SpreadsheetCellEditable) node).editable();
164 public void setEngineValue(SheetNode node, Object value) {
168 public String getName(SheetNode node) {
169 return node.getName();
172 @SuppressWarnings("unchecked")
174 public Map<String, SheetNode> getChildren(SheetNode node) {
175 return node.getChildren();
178 @SuppressWarnings("unchecked")
180 public Map<String, SheetNode> getProperties(SheetNode node) {
181 return node.getProperties();
185 public String getName() {
190 public Map<String, SpreadsheetEngine> getChildren() {
191 Map<String,SpreadsheetEngine> result = new HashMap<String,SpreadsheetEngine>();
192 for(SpreadsheetEngine engine : sheets)
193 result.put(engine.getName(), engine);
198 public Map<String, SheetNode> getProperties() {
199 return Collections.emptyMap();
202 public SpreadsheetCell get(String sheet, int row, int column) {
203 SpreadsheetEngine engine = getEngine(sheet);
204 if(engine == null) return null;
205 SpreadsheetLine line = engine.getLine(row);
206 if(line == null) return null;
207 if(line.cells.size() <= column) return null;
208 return line.cells.get(column);
211 public SpreadsheetCell get(SpreadsheetEngine engine, int row, int column) {
212 SpreadsheetLine line = engine.getLine(row);
213 if(line == null) return null;
214 if(line.cells.size() <= column) return null;
215 return line.cells.get(column);
218 public SpreadsheetEngine getEngine(String sheet) {
219 for(SpreadsheetEngine engine : sheets)
220 if(sheet.equals(engine.getName())) return engine;
225 public ModuleUpdaterBase<SheetLineComponent> createUpdater(String id) throws Exception {
226 if("http://www.simantics.org/Spreadsheet-1.2/Line".equals(id))
227 return new LineUpdater(id);
228 else if("http://www.simantics.org/Spreadsheet-1.2/LineNode".equals(id))
229 return new LineNodeUpdater(id);
230 else if ("http://www.simantics.org/Spreadsheet-1.2/Style".equals(id))
231 return new StyleUpdater(id);
232 else if("http://www.simantics.org/Spreadsheet-1.2/Lines".equals(id))
233 return new NullUpdater(id);
234 else if("http://www.simantics.org/Spreadsheet-1.2/Spreadsheet".equals(id))
235 return new NullUpdater(id);
236 else if("http://www.simantics.org/Spreadsheet-1.2/Book".equals(id))
237 return new NullUpdater(id);
239 throw new IllegalStateException("createUpdater " + id);
243 public SheetLineComponent create(String uid) {
244 return new SheetLineComponent(uid);
248 public String getFreshName(String parentName, String name) {
249 return parentName + "/" + name;
253 public String ensureNameIsVariationOf(String parentName, int id, String name) {
254 if (parentName.isEmpty())
256 return parentName + "/" + name;
259 final static int COMP_ROOT_POS = "COMP_ROOT/".length();
262 public int getId(String name) {
264 if("COMP_ROOT".equals(name)) return 1;
266 String path = name.substring(COMP_ROOT_POS);
267 String[] parts = path.split("/");
268 Object o = resolve(parts, 0);
269 if(o instanceof SpreadsheetLines) {
270 return ((SpreadsheetLines)o).getId();
271 } else if(o instanceof SpreadsheetLine) {
272 return ((SpreadsheetLine)o).getId();
273 } else if(o instanceof SpreadsheetEngine) {
274 return ((SpreadsheetEngine)o).getId();
275 } else if (o instanceof SpreadsheetStyle) {
276 return ((SpreadsheetStyle) o).getId();
279 throw new IllegalStateException("Resolved object for parts " + Arrays.toString(parts) + " is not the right type! It is " + o);
283 Object resolve(String[] parts, int index) {
284 String part = parts[index];
285 if (part.startsWith("Style")) {
286 for (SpreadsheetStyle style : styles.values()) {
287 if (style.name.equals(part)) {
292 SpreadsheetEngine engine = getEngine(part);
293 if(engine == null) return 0;
294 if(index == parts.length-1) return engine;
295 else return engine.resolve(parts, index+1);
299 public String getName(int id) {
300 if(id == -2) return "http://www.simantics.org/Spreadsheet-1.2/Book";
301 else if(id == -3) return "http://www.simantics.org/Spreadsheet-1.2/Spreadsheet";
302 else if(id == -4) return "http://www.simantics.org/Spreadsheet-1.2/Lines";
304 return "http://www.simantics.org/Spreadsheet-1.2/LineNode";
306 return "http://www.simantics.org/Spreadsheet-1.2/Line";
308 return "http://www.simantics.org/Spreadsheet-1.2/Style";
313 public int getModuleType(int id) {
314 Serializable s = children.get(id);
315 if(s instanceof SpreadsheetBook) return -2;
316 else if(s instanceof SpreadsheetEngine) return -3;
317 else if(s instanceof SpreadsheetLines) {
318 if("Lines".equals(((SpreadsheetLines) s).getName()))
323 else if(s instanceof SpreadsheetLine)
325 else if (s instanceof SpreadsheetStyle)
327 else throw new IllegalStateException();
330 @SuppressWarnings("unchecked")
332 public void remove(int id) {
334 SpreadsheetElement child = children.get(id);
335 Optional<SpreadsheetElement> parent = child.getParent();
337 if (parent.isPresent()) {
338 parent.get().remove(child);
344 public void addSubprocess(String name, String subprocessType) {
345 ensureSubprocess(name);
348 @SuppressWarnings("unchecked")
349 public <T> T ensureSubprocess(String name) {
350 String[] parts = name.split("/");
351 if(parts.length == 2) {
352 SpreadsheetEngine engine = getEngine(parts[1]);
354 engine = new SpreadsheetEngine(this, parts[1]);
358 } else if (parts.length > 2) {
359 SpreadsheetEngine engine = getEngine(parts[1]);
360 return (T)engine.ensureSubprocess(parts, 2);
362 throw new IllegalStateException();
367 public void includeSubprocess(String parentName, String subprocessName) {
371 @SuppressWarnings("unchecked")
373 public <T> T getConcreteSolver() {
378 public void accept(SpreadsheetVisitor v) {
382 private SpreadsheetCell cellByReferenceKey(long ref) {
383 long sheet = ref >> 40;
384 long row = (ref >> 20) & 0xFFFFF;
385 long col = (ref) & 0xFFFFF;
386 return get(sheets.get((int)sheet), (int)row, (int)col);
389 //Recursively find all SpreadsheetCells, invalidate them and return them all as a set
390 public Set<SpreadsheetCell> invalidate(SpreadsheetCell cell) {
391 Set<SpreadsheetCell> result = new HashSet<>();
394 long refKey = cell.makeReferenceKey();
395 AbstractLongSet refs = referenceMap.remove(refKey);
396 if(refs == null) return result;
397 for(long ref : refs) {
398 SpreadsheetCell referer = cellByReferenceKey(ref);
399 result.addAll(invalidate(referer));
405 public List<SpreadsheetCell> invalidateShallow(SpreadsheetCell cell) {
406 ArrayList<SpreadsheetCell> result = new ArrayList<>();
409 long refKey = cell.makeReferenceKey();
410 AbstractLongSet refs = referenceMap.remove(refKey);
411 if(refs == null) return result;
412 for(long ref : refs) {
413 SpreadsheetCell referer = cellByReferenceKey(ref);
420 public void addStyle(SpreadsheetStyle style) {
421 if (style.name == null) {
422 new Exception("Trying to add style to book without name!!").printStackTrace();
425 style.setSynchronizationId(getNewId(style));
426 styles.put(style.getStyleId(), style);
429 public SpreadsheetStyle getStyle(int styleId) {
430 return styles.get(styleId);
433 public MappingBase<SheetLineComponent> getMapping() {
438 public Optional<SpreadsheetElement> getParent() {
439 return Optional.empty();
443 public Collection<SpreadsheetElement> getSpreadsheetChildren() {
444 return children.values();
448 public void remove(SpreadsheetElement child) {
449 // TODO Auto-generated method stub
453 public void setIterationEnabled(boolean value) {
454 this.iterationEnabled = value;
457 public boolean isIterationEnabled() {
458 return iterationEnabled;
461 static Variant DEFAULT = Variant.ofInstance("Pending external reference");
463 class ExternalRefData {
464 private Variant value = DEFAULT;
465 public ExternalRefData(long referenceKey, ExternalRef ref) {
466 ref.listen(context, new ExternalRefListener() {
468 boolean isDisposed = false;
471 public void newValue(Variant newVariant) {
472 SpreadsheetCell cell = cellByReferenceKey(referenceKey);
473 if(cell.content instanceof SpreadsheetSCLConstant) {
474 SpreadsheetSCLConstant ssc = (SpreadsheetSCLConstant)cell.content;
475 if(ssc.content.equals(ref)) {
477 fireChanges(invalidate(cell));
484 public boolean isDisposed() {
487 return SpreadsheetBook.this.isDisposed();
493 private Map<ExternalRef,ExternalRefData> externalRefMap = new HashMap<>();
495 void registerListening(long referenceKey, ExternalRef ref) {
496 ExternalRefData data = externalRefMap.get(ref);
498 data = new ExternalRefData(referenceKey, ref);
499 externalRefMap.put(ref, data);
501 // Already registered
505 Variant getExternalRefValue(long referenceKey, ExternalRef ref) {
506 ExternalRefData data = externalRefMap.get(ref);
508 registerListening(referenceKey, ref);
514 public boolean isDisposed() {
518 public static interface SpreadsheetBookListener {
519 void cellsChanged(Collection<SpreadsheetCell> cells);
522 public void registerListener(SpreadsheetBookListener listener) {
523 listeners.add(listener);
526 private transient ArrayList<SpreadsheetBookListener> listeners = new ArrayList<>();
528 public void fireChanges(Collection<SpreadsheetCell> cells) {
529 for(SpreadsheetBookListener listener : listeners)
530 listener.cellsChanged(cells);