@dra2020/baseclient 1.0.0

package/lib/fsm/fsm.ts

@@ -0,0 +1,549 @@
+// Shared libraries
+import * as Util from '../util/all';
+
+// States
+export const FSM_STARTING: number = 0;
+export const FSM_PENDING: number  = 1<<0;
+export const FSM_DONE: number     = 1<<1;
+export const FSM_ERROR: number    = 1<<2;
+export const FSM_RELEASED: number = 1<<3;
+export const FSM_CUSTOM1: number  = 1<<4;
+export const FSM_CUSTOM2: number  = 1<<5;
+export const FSM_CUSTOM3: number  = 1<<6;
+export const FSM_CUSTOM4: number  = 1<<7;
+export const FSM_CUSTOM5: number  = 1<<8;
+export const FSM_CUSTOM6: number  = 1<<9;
+export const FSM_CUSTOM7: number  = 1<<10;
+export const FSM_CUSTOM8: number  = 1<<11;
+export const FSM_CUSTOM9: number  = 1<<12;
+
+// polyfill
+let doLater: any = global && global.setImmediate ? setImmediate : (cb: any) => { setTimeout(cb, 0) };
+
+function FsmDone(s: number): boolean
+{
+  return (s === FSM_DONE || s === FSM_ERROR || s === FSM_RELEASED);
+}
+
+function FsmStateToString(state: number): string
+{
+  let a: string[] = [];
+
+  if (state === FSM_STARTING)
+    return 'starting';
+  else
+  {
+    if (state === FSM_PENDING) a.push('pending');
+    if (state === FSM_DONE) a.push('done');
+    if (state === FSM_ERROR) a.push('error');
+    if (state === FSM_RELEASED) a.push('released');
+    if (state === FSM_CUSTOM1) a.push('custom1');
+    if (state === FSM_CUSTOM2) a.push('custom2');
+    if (state === FSM_CUSTOM3) a.push('custom3');
+    if (state === FSM_CUSTOM4) a.push('custom4');
+    if (state === FSM_CUSTOM5) a.push('custom5');
+    if (state === FSM_CUSTOM6) a.push('custom6');
+    if (state === FSM_CUSTOM7) a.push('custom7');
+    if (state === FSM_CUSTOM8) a.push('custom8');
+    if (state === FSM_CUSTOM9) a.push('custom9');
+    return a.join('|');
+  }
+}
+
+export type FsmIndex = { [key: number]: Fsm };
+
+export class FsmManager
+{
+  theId: number;
+  theEpoch: number;
+  bTickSet: boolean;
+  theTickList: FsmIndex;
+  theBusyLoopCount: number;
+
+  constructor()
+  {
+    this.theId = 0;
+    this.theEpoch = 0;
+    this.bTickSet = false;
+    this.theTickList = {};
+    this.theBusyLoopCount = 0;
+    this.doTick = this.doTick.bind(this);
+  }
+
+  forceTick(fsm: Fsm): void
+  {
+    this.theTickList[fsm.id] = fsm;
+    if (! this.bTickSet)
+    {
+      this.bTickSet = true;
+      doLater(this.doTick);
+    }
+  }
+
+  doTick(): void
+    {
+      this.bTickSet = false;
+      let nLoops: number = 0;
+
+      while (nLoops < 1 && !Util.isEmpty(this.theTickList))
+      {
+        nLoops++;
+        let thisTickList = this.theTickList;
+        this.theTickList = {};
+
+        for (let id in thisTickList) if (thisTickList.hasOwnProperty(id))
+        {
+          let f = thisTickList[id];
+          f.preTick();
+          f.tick();
+        }
+      }
+
+      if (Util.isEmpty(this.theTickList))
+        this.theBusyLoopCount = 0;
+      else
+        this.theBusyLoopCount++;
+
+      this.theEpoch++;
+    }
+
+}
+
+export interface FsmEnvironment
+{
+  fsmManager: FsmManager;
+}
+
+export class Fsm
+{
+  id: number;
+  state: number;
+  dependentError: boolean;
+  epochDone: number;
+  _env: FsmEnvironment;
+  _waitOn: FsmIndex;
+  _waitedOn: FsmIndex;
+
+  constructor(env: FsmEnvironment)
+    {
+      this._env = env;
+      this.id = this.manager.theId++;
+      this.state = FSM_STARTING;
+      this.dependentError = false;
+      this.epochDone = -1;
+      this._waitOn = null;
+      this._waitedOn = null;
+      this.manager.forceTick(this);
+    }
+
+  get env(): FsmEnvironment { return this._env; }
+  get manager(): FsmManager { return this.env.fsmManager; }
+
+  get done(): boolean
+    {
+      return FsmDone(this.state);
+    }
+
+  get ready(): boolean
+    {
+      return !this.done && this._waitOn == null;
+    }
+
+  get iserror(): boolean
+    {
+      return (this.state === FSM_ERROR);
+    }
+
+  get isDependentError(): boolean
+    {
+      return this.dependentError;
+    }
+
+  setDependentError(): void
+    {
+      this.dependentError = true;
+    }
+
+  clearDependentError(): void
+    {
+      this.dependentError = false;
+    }
+
+  get ticked(): boolean
+    {
+      return this.done && this.manager.theEpoch > this.epochDone;
+    }
+
+  get nWaitOn(): number
+    {
+      return Util.countKeys(this._waitOn);
+    }
+
+  get nWaitedOn(): number
+    {
+      return Util.countKeys(this._waitedOn);
+    }
+
+  waitOn(fsm: Fsm | Fsm[]): Fsm
+    {
+      if (fsm == null)
+        return this;
+      else if (Array.isArray(fsm))
+      {
+        for (let i: number = 0; i < fsm.length; i++)
+          this.waitOn(fsm[i]);
+      }
+      else
+      {
+        if (fsm.done)
+        {
+          // If dependency is already done, don't add to waitOn list but ensure that
+          // this Fsm gets ticked during next epoch. This is because the dependent tick
+          // only happens when the dependency state is changed.
+          this.manager.forceTick(this);
+          if (fsm.iserror)
+            this.setDependentError();
+        }
+        else
+        {
+          if (this._waitOn == null) this._waitOn = {};
+          this._waitOn[fsm.id] = fsm;
+          if (fsm._waitedOn == null) fsm._waitedOn = {};
+          fsm._waitedOn[this.id] = this;
+        }
+      }
+      return this;
+    }
+
+  setState(state: number): void
+    {
+      this.state = state;
+      if (this.done)
+      {
+        while (this._waitedOn)
+        {
+          let on = this._waitedOn;
+          this._waitedOn = null;
+          for (let id in on) if (on.hasOwnProperty(id))
+          {
+            let f = on[id];
+            if (this.iserror) f.setDependentError();
+            this.manager.forceTick(f);
+          }
+        }
+
+        this.epochDone = this.manager.theEpoch;
+      }
+      this.manager.forceTick(this);
+    }
+
+  // Can override if need to do more here
+  end(state: number = FSM_DONE): void
+    {
+      this.setState(state);
+    }
+
+  // Cleans up _waitOn
+  preTick(): void
+    {
+      if (this._waitOn == null) return;
+      let bMore: boolean = false;
+      for (let id in this._waitOn) if (this._waitOn.hasOwnProperty(id))
+      {
+        let fsm = this._waitOn[id];
+        if (fsm.done)
+          delete this._waitOn[id];
+        else
+          bMore = true;
+      }
+      if (!bMore) this._waitOn = null;
+    }
+
+  tick(): void
+    {
+    }
+}
+
+// Launches callback provided when the associated Fsm (or Fsm array) completes.
+export class FsmOnDone extends Fsm
+{
+  cb: any;
+  fsm: Fsm | Fsm[];
+
+  constructor(env: FsmEnvironment, fsm: Fsm | Fsm[], cb: any)
+    {
+      super(env);
+      this.waitOn(fsm);
+      this.fsm = fsm;
+      this.cb = cb;
+    }
+
+  tick(): void
+    {
+      if (this.ready && this.state == FSM_STARTING)
+      {
+        this.setState(this.isDependentError ? FSM_ERROR : FSM_DONE);
+        this.cb(this.fsm);
+      }
+    }
+}
+
+export class FsmSleep extends Fsm
+{
+  delay: number;
+
+  constructor(env: FsmEnvironment, delay: number)
+    {
+      super(env);
+      this.delay = delay;
+    }
+
+  tick(): void
+    {
+      if (this.ready && this.state === FSM_STARTING)
+      {
+        this.setState(FSM_PENDING);
+        setTimeout(() => { this.setState(FSM_DONE); }, this.delay);
+      }
+    }
+}
+
+export type SerializerIndex = { [key: string]: Fsm };
+
+export class FsmSerializer extends Fsm
+{
+  index: SerializerIndex;
+
+  constructor(env: FsmEnvironment)
+    {
+      super(env);
+      this.index = {};
+    }
+
+  serialize(id: string, fsm?: Fsm): Fsm
+    {
+      let prev = this.index[id];
+      if (prev && !fsm) return prev;
+      if (prev !== undefined)
+        fsm.waitOn(prev);
+      this.index[id] = fsm;
+      if (this.done)
+        this.setState(FSM_STARTING);
+      this.waitOn(fsm);
+      return prev;
+    }
+
+  tick(): void
+    {
+      // If fully quiescent, take advantage to clear the waiting cache.
+      if (this.ready && this.state == FSM_STARTING)
+      {
+        this.index = {};
+        this.setState(FSM_DONE);
+      }
+    }
+}
+
+// The FsmTracker class provides a mechanism for serializing a set of finite state
+// machines identified by a consistent unique identifier. A finite state machine is
+// "tracked" until completion. If any other finite state machine calls "maybeWait"
+// while any other are tracked and pending, that FSM will wait for the others to
+// complete.
+//
+
+class FsmTrackerWrap extends Fsm
+{
+  index: FsmTracker;
+  uid: string;
+  fsm: Fsm;
+
+  constructor(env: FsmEnvironment, index: FsmTracker, uid: string, fsm: Fsm)
+    {
+      super(env);
+      this.index = index;
+      this.uid = uid;
+      this.fsm = fsm;
+      index._track(uid, fsm);
+      this.waitOn(fsm);
+    }
+
+  tick(): void
+    {
+      if (this.ready && this.state == FSM_STARTING)
+      {
+        this.index._untrack(this.uid, this.fsm);
+        this.setState(FSM_DONE);
+      }
+    }
+}
+
+type FsmArrayMap = { [key: string]: Fsm[] };
+
+export class FsmTracker
+{
+  env: FsmEnvironment;
+  map: FsmArrayMap;
+
+  constructor(env: FsmEnvironment)
+    {
+      this.env = env;
+      this.map = {};
+    }
+
+  _track(uid: string, fsm: Fsm): void
+    {
+      let a = this.map[uid];
+      if (a === undefined)
+      {
+        a = [];
+        this.map[uid] = a;
+      }
+      a.push(fsm);
+    }
+
+  _untrack(uid: string, fsm: Fsm): void
+    {
+      let a = this.map[uid];
+      if (a)
+      {
+        for (let i: number = 0; i < a.length; i++)
+          if (a[i] === fsm)
+          {
+            if (a.length == 1)
+              delete this.map[uid];
+            else
+              a.splice(i, 1);
+            break;
+          }
+      }
+    }
+
+  track(uid: string, fsm: Fsm): Fsm
+    {
+      return new FsmTrackerWrap(this.env, this, uid, fsm);
+    }
+
+  maybeWait(uid: string, fsm: Fsm): void
+    {
+      fsm.waitOn(this.map[uid]);
+    }
+}
+
+
+// FsmLoop: repeat the Fsm passed in (resetting to STARTING state after finished) at some minimum interval.
+//  Assumes that the Fsm can be correctly reset and restarted by setting the state.
+//
+
+export interface LoopOptions
+{
+  minRepeatInterval?: number;
+  exitOnError?: boolean;
+}
+
+export const DefaultLoopOptions = { minRepeatInterval: 0, exitOnError: true };
+
+const FSM_DELAYING = FSM_CUSTOM1;
+
+export class FsmLoop extends Fsm
+{
+  fsm: Fsm;
+  options: LoopOptions;
+  elapsed: Util.Elapsed;
+
+  constructor(env: FsmEnvironment, fsm: Fsm, options?: LoopOptions)
+  {
+    super(env);
+    this.fsm = fsm;
+    this.elapsed = new Util.Elapsed();
+    this.options = Util.shallowAssignImmutable(DefaultLoopOptions, options);
+    this.waitOn(fsm);
+  }
+
+  tick(): void
+  {
+    if (this.ready && this.isDependentError)
+    {
+      if (this.options.exitOnError)
+        this.setState(FSM_ERROR);
+      else
+        this.clearDependentError();
+        // Fall through
+    }
+
+    if (this.ready)
+    {
+      switch (this.state)
+      {
+        case FSM_STARTING:
+          let msLeft = this.options.minRepeatInterval - this.elapsed.ms();
+          if (msLeft > 0)
+            this.waitOn(new FsmSleep(this.env, msLeft));
+          this.setState(FSM_DELAYING);
+          break;
+
+        case FSM_DELAYING:
+          this.elapsed.start();
+          this.fsm.setState(FSM_STARTING);
+          this.waitOn(this.fsm);
+          this.setState(FSM_STARTING);
+          break;
+      }
+    }
+  }
+}
+
+export interface ISet
+{
+  test: (o: any) => boolean;
+  reset: () => void;
+}
+
+export class FsmArray extends Fsm
+{
+  a: any[];
+  iset: ISet;
+
+  constructor(env: FsmEnvironment, iset?: ISet)
+  {
+    super(env);
+    this.iset = iset;
+    this.a = [];
+  }
+
+  push(o: any): void
+  {
+    if (this.iset == null || !this.iset.test(o))
+    {
+      if (! this.done) this.setState(FSM_DONE);
+      this.a.push(o);
+    }
+  }
+
+  concat(a: any[]): void
+  {
+    if (a)
+    {
+      for (let i: number = 0; i < a.length; i++)
+        this.push(a[i]);
+    }
+  }
+
+  splice(i?: number, n?: number): void
+  {
+    if (i === undefined)
+      this.reset();
+    else
+    {
+      this.a.splice(i, n);
+      if (this.a.length == 0)
+        this.reset();
+    }
+  }
+
+  reset(): void
+  {
+    this.a = [];
+    if (this.iset) this.iset.reset();
+    this.setState(FSM_STARTING);
+  }
+}

package/lib/logabstract/all.ts

@@ -0,0 +1 @@
+export * from './log';

package/lib/logabstract/log.ts

@@ -0,0 +1,55 @@
+import * as Util from '../util/all';
+import * as FSM from '../fsm/all';
+
+export interface ILog
+{
+  dump: () => FSM.Fsm;
+  stamp: (o: any) => void;
+  log: (o: any, verbosity?: number) => void;
+  event: (o: any, verbosity?: number) => void;
+  error: (o: any) => void;
+  value: (o: any, verbosity?: number) => void;
+  chatter: (s: string) => void;
+  chatters: () => string[];
+}
+
+export class Timer
+{
+  ilog: ILog;
+  o: any;
+  verbosity: number;
+  elapsed: Util.Elapsed;
+
+  constructor(ilog: ILog, kind: string, o: any, verbosity: number = 0)
+  {
+    this.ilog = ilog;
+    if (typeof o === 'string') o = { event: o };
+    this.o = o;
+    this.o.kind = kind;
+    this.verbosity = verbosity;
+    this.elapsed = new Util.Elapsed();
+  }
+
+  log(): void
+  {
+    this.elapsed.end();
+    this.o.ms = this.elapsed.ms();
+    this.ilog.log(this.o, this.verbosity);
+  }
+}
+
+export class AsyncTimer extends Timer
+{
+  constructor(ilog: ILog, o: any, verbosity: number = 0)
+  {
+    super(ilog, 'async', o, verbosity);
+  }
+}
+
+export class SyncTimer extends Timer
+{
+  constructor(ilog: ILog, o: any, verbosity: number = 0)
+  {
+    super(ilog, 'sync', o, verbosity);
+  }
+}

package/lib/logclient/all.ts

@@ -0,0 +1 @@
+export * from './log';

package/lib/logclient/log.ts

@@ -0,0 +1,105 @@
+import * as Context from '../context/all';
+import * as LogAbstract from '../logabstract/all';
+import * as Util from '../util/all';
+import * as FSM from '../fsm/all';
+
+export interface LogEnvironment
+{
+  context: Context.IContext;
+}
+
+class LogManager implements LogAbstract.ILog
+{
+  env: LogEnvironment;
+  count: number;
+
+  constructor(env: LogEnvironment)
+  {
+    this.env = env;
+    this.count = 0;
+  }
+
+  dump(): FSM.Fsm { return null; }
+
+  print(o: any): void
+  {
+    let sa: string[] = [];
+
+    if (o._count !== undefined)
+      sa.push(String(o._count));
+    if (o.kind === 'error')
+    {
+      sa.push('error');
+      sa.push(o.event);
+    }
+    else if (o.kind !== 'value')
+    {
+      sa.push('info');
+      sa.push(o.event);
+    }
+    else
+    {
+      sa.push('value');
+      sa.push(o.event);
+      sa.push(String(o.value));
+    }
+    if (o.detail !== undefined)
+      sa.push(o.detail);
+    console.log(sa.join(': '));
+  }
+
+  stamp(o: any): void
+  {
+    this.log(o);
+  }
+
+  log(o: any, verbosity: number = 0): void
+  {
+    // Show some restraint
+    if (verbosity > this.env.context.xnumber('verbosity'))
+      return;
+
+    // Inject some standard properties
+    o._time = Util.Now();
+    o._count = this.count++;
+    if (o.kind === undefined)
+      o.kind = 'misc';
+    this.print(o);
+  }
+
+
+  event(o: any, verbosity: number = 0): void
+  {
+    if (typeof o === 'string') o = { event: o };
+    o.kind = 'event';
+    this.log(o, verbosity);
+  }
+
+  error(o: any): void
+  {
+    if (typeof o === 'string') o = { event: o };
+    o.kind = 'error';
+    this.log(o);
+  }
+
+  value(o: any, verbosity: number = 0): void
+  {
+    o.kind = 'value';
+    this.log(o, verbosity);
+  }
+
+  chatter(s: string): void
+  {
+    console.log(s);
+  }
+
+  chatters(): string[]
+  {
+    return null;
+  }
+}
+
+export function create(env: LogEnvironment): LogAbstract.ILog
+{
+  return new LogManager(env);
+}

package/lib/ot-editutil/all.ts

@@ -0,0 +1,2 @@
+export * from "./oteditutil";
+export * from "./otmaputil";