1 files changed, 202 insertions, 0 deletions
diff --git a/src/js/fiveui/js/state.js b/src/js/fiveui/js/state.js
new file mode 100644
index 0000000..226a439
--- /dev/null
+++ b/src/js/fiveui/js/state.js
@@ -0,0 +1,202 @@
+/*
+ * Module     : state.js
+ * Copyright  : (c) 2011-2012, Galois, Inc.
+ *
+ * Maintainer :
+ * Stability  : Provisional
+ * Portability: Portable
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+var fiveui = fiveui || {};
+
+(function() {
+
+/**
+ * @constructor
+ * @param {!number} x The x-offset of the embedded dialog.
+ * @param {!number} y The y-offset the dialog.
+ * @param {!number} width The width of the dalog.
+ * @param {!number} height The width of the dalog.
+ * @param {!boolean} closed True if the window is closed, false if it is open.
+ */
+fiveui.WinState = function(x, y, width, height, closed) {
+  this.x = x;
+  this.y = y;
+  this.width = width;
+  this.height = height;
+  this.closed = closed;
+};
+
+/**
+ * @constructor
+ * @param {string} name The name of the rule that this problem represents.
+ * @param {string} descr Short description of the problem.
+ * @param {string} url The url that the problem occurred at.
+ * @param {number} severity The severity of the problem
+ */
+fiveui.Problem = function(name, descr, url, severity, hash) {
+  this.name = name || '';
+  this.descr = descr || '';
+  this.url = url || '';
+  this.severity = severity || 0;
+  this.hash = hash;
+};
+
+/**
+ * @param {!Object} obj The JSON object to use as a template for a problem.
+ * @return {!fiveui.Problem} The problem that the object represents.
+ */
+fiveui.Problem.fromJSON = function(obj) {
+  return new fiveui.Problem(obj.name, obj.descr, obj.url, obj.severity, obj.hash);
+};
+
+/**
+ * @constructor
+ * @param {fiveui.WinState} winState The location of the FiveUI windown in
+ *                                   the injected page.  Null if the window
+ *                                   is hidden.
+ * @param {fiveui.ChromePort} uiPort The port used to communicate with
+ *                                   the corresponding tab.
+ */
+fiveui.TabState = function(tabId, winState, uiPort) {
+  this.tabId = tabId;
+  this.winState = winState;
+  this.uiPort = uiPort;
+  this.computePorts = [];
+  this.problems = [];
+  this.seenProblems = new Set();
+  this.stats = {};
+};
+
+_.extend(fiveui.TabState.prototype, {
+
+  addProblem: function(prob) {
+    if(!this.seenProblems.contains(prob.hash)) {
+      this.problems.push(prob);
+      this.seenProblems.add(prob.hash);
+      return true;
+    }
+    else {
+      return false;
+    }
+  },
+
+  addStats: function (stats) {
+    this.stats = stats;
+    return true;
+  },
+
+  clearProblems: function() {
+    this.problems = [];
+    this.seenProblems = new Set();
+  },
+
+  clearStats: function() {
+    for (var p in fiveui.stats.zero) { this.stats[p] = fiveui.stats.zero[p]; }
+  },
+
+  /*
+   * Returns a copy of only the attributes in a TabState that are needed for
+   * interpage communication.
+   */
+  toEmit: function() {
+    return { winState: this.winState, problems: this.problems, stats: this.stats };
+  }
+
+});
+
+/**
+ * @constructor
+ * @param {!fiveui.Settings} settings The settings object to obtain
+ *                                    defaults from.
+ */
+fiveui.State = function(settings) {
+  this.tabs = {};
+  this.settings = settings;
+};
+
+_.extend(fiveui.State.prototype, {
+
+  /**
+   * @param {!number} tabId The id of the tab to retrieve state for.
+   *
+   * @return {?fiveui.TabState} The stored state of the tab, or null, if
+   *                            no state exists for the requested tab.
+   */
+  getTabState: function(tabId) {
+    return this.tabs[tabId] || null;
+  },
+
+  /**
+   * Like getTabState, but creates an initial tab state if none exists.
+   *
+   * @param {!number} tabId The id of the tab to retrieve state for.
+   * @param {!fiveui.ChromePort} port The port to use for communication
+   *                             with the corresponding tab.
+   * @return {!fiveui.TabState} Either an initial state if none existed, or the
+   *                            state that exists already.
+   */
+  acquireTabState: function(tabId, port) {
+    var ts = this.getTabState(tabId);
+
+    if(null == ts) {
+      var closed = ! this.settings.getDisplayDefault();
+
+      // in the future, get these defaults from the settings instance.
+      var ws = new fiveui.WinState(10, 10, 300, 300, closed);
+      ts = new fiveui.TabState(tabId, ws, port);
+      this.setTabState(ts);
+    }
+
+    return ts;
+  },
+
+  /**
+   * @param {!fiveui.TabState} ts The state to store.
+   * @return {void}
+   */
+  setTabState: function(ts) {
+    this.tabs[ts.tabId] = ts;
+  },
+
+  /**
+   * Update the state of a tab, if and only if the tabId exists in the state.
+   *
+   * @param {!number} tabId The id of the tab to store state for.
+   * @param {function(fiveui.TabState): fiveui.TabState} fn A function
+   *                                       that modifies the tab state.
+   *
+   * @return {void}
+   */
+  adjust: function(tabId, fn) {
+    var tState = this.getTabState(tabId);
+    if (tState) {
+      this.tabs[tabId] = fn(tState);
+    }
+  },
+
+  /**
+   * Remove the state of a tab.
+   *
+   * @param {!number} tabId The id of the tab to remove the state of.
+   * @return {void}
+   */
+  removeTabState: function(tabId) {
+    delete this.tabs[tabId];
+  }
+
+});
+
+})();