noflo

# NoFlo - Flow-Based Programming for JavaScript # (c) 2013-2016 TheGrid (Rituwall Inc.) # (c) 2011-2012 Henri Bergius, Nemein # NoFlo may be freely distributed under the MIT license # # Baseclass for regular NoFlo components. {EventEmitter} = require 'events' ports = require './Ports' IP = require './IP' class Component extends EventEmitter description: '' icon: null constructor: (options) -> options = {} unless options options.inPorts = {} unless options.inPorts if options.inPorts instanceof ports.InPorts @inPorts = options.inPorts else @inPorts = new ports.InPorts options.inPorts options.outPorts = {} unless options.outPorts if options.outPorts instanceof ports.OutPorts @outPorts = options.outPorts else @outPorts = new ports.OutPorts options.outPorts @icon = options.icon if options.icon @description = options.description if options.description @started = false @load = 0 @ordered = false @autoOrdering = false @outputQ = [] @activateOnInput = true @forwardBrackets = in: ['out', 'error'] @bracketCounter = {} @dropEmptyBrackets = ['error'] @ordered = options.ordered if 'ordered' of options @activateOnInput = options.activateOnInput if 'activateOnInput' of options if 'forwardBrackets' of options @forwardBrackets = options.forwardBrackets if 'dropEmptyBrackets' of options @dropEmptyBrackets = options.dropEmptyBrackets if typeof options.process is 'function' @process options.process getDescription: -> @description isReady: -> true isSubgraph: -> false setIcon: (@icon) -> @emit 'icon', @icon getIcon: -> @icon error: (e, groups = [], errorPort = 'error') => if @outPorts[errorPort] and (@outPorts[errorPort].isAttached() or not @outPorts[errorPort].isRequired()) @outPorts[errorPort].beginGroup group for group in groups @outPorts[errorPort].send e @outPorts[errorPort].endGroup() for group in groups @outPorts[errorPort].disconnect() return throw e shutdown: -> @started = false # The startup function performs initialization for the component. start: -> @started = true @started isStarted: -> @started # Ensures braket forwarding map is correct for the existing ports prepareForwarding: -> for inPort, outPorts of @forwardBrackets unless inPort of @inPorts.ports delete @forwardBrackets[inPort] continue tmp = [] for outPort in outPorts tmp.push outPort if outPort of @outPorts.ports if tmp.length is 0 delete @forwardBrackets[inPort] else @forwardBrackets[inPort] = tmp @bracketCounter[inPort] = 0 tmp = [] for outPort in @dropEmptyBrackets tmp.push outPort if outPort of @outPorts.ports @dropEmptyBrackets = tmp # Sets process handler function process: (handle) -> unless typeof handle is 'function' throw new Error "Process handler must be a function" unless @inPorts throw new Error "Component ports must be defined before process function" @prepareForwarding() @handle = handle for name, port of @inPorts.ports do (name, port) => port.name = name unless port.name port.on 'ip', (ip) => @handleIP ip, port @ # Handles an incoming IP object handleIP: (ip, port) -> if ip.type is 'openBracket' @autoOrdering = true unless @autoOrdering @bracketCounter[port.name]++ if port.name of @forwardBrackets and (ip.type is 'openBracket' or ip.type is 'closeBracket') # Bracket forwarding outputEntry = __resolved: ip.type is 'closeBracket' or not @dropEmptyBrackets.length __forwarded: true __type: ip.type __scope: ip.scope for outPort in @forwardBrackets[port.name] outputEntry[outPort] = [] unless outPort of outputEntry outputEntry[outPort].push ip port.buffer.pop() # Drop empty brackets if needed if ip.type is 'closeBracket' and @dropEmptyBrackets.length haveData = [] for i in [@outputQ.length - 1..0] entry = @outputQ[i] if '__forwarded' of entry if entry.__type is 'openBracket' and not entry.__resolved and entry.__scope is ip.scope for port, ips of entry if haveData.indexOf(port) is -1 and @dropEmptyBrackets.indexOf(port) isnt -1 delete entry[port] delete outputEntry[port] entry.__resolved = true break else for port, ips of entry continue if port.indexOf('__') is 0 or haveData.indexOf(port) >= 0 for _ip in ips if _ip.scope is ip.scope haveData.push port break @outputQ.push outputEntry @processOutputQueue() return return unless port.options.triggering result = {} input = new ProcessInput @inPorts, ip, @, port, result output = new ProcessOutput @outPorts, ip, @, result @load++ @handle input, output, -> output.done() processOutputQueue: -> while @outputQ.length > 0 result = @outputQ[0] break unless result.__resolved for port, ips of result continue if port.indexOf('__') is 0 for ip in ips @bracketCounter[port]-- if ip.type is 'closeBracket' @outPorts[port].sendIP ip @outputQ.shift() bracketsClosed = true for name, port of @outPorts.ports if @bracketCounter[port] isnt 0 bracketsClosed = false break @autoOrdering = false if bracketsClosed exports.Component = Component class ProcessInput constructor: (@ports, @ip, @nodeInstance, @port, @result) -> @scope = @ip.scope # Sets component state to `activated` activate: -> @result.__resolved = false if @nodeInstance.ordered or @nodeInstance.autoOrdering @nodeInstance.outputQ.push @result # Returns true if a port (or ports joined by logical AND) has a new IP has: (port = 'in') -> args = if arguments.length is 0 then [port] else arguments res = true res and= @ports[port].ready @scope for port in args res # Fetches IP object(s) for port(s) get: (port = 'in') -> args = if arguments.length is 0 then [port] else arguments if (@nodeInstance.ordered or @nodeInstance.autoOrdering) and @nodeInstance.activateOnInput and not ('__resolved' of @result) @activate() res = (@ports[port].get @scope for port in args) if args.length is 1 then res[0] else res # Fetches `data` property of IP object(s) for given port(s) getData: (port = 'in') -> args = if arguments.length is 0 then [port] else arguments ips = @get.apply this, args if args.length is 1 return ips?.data ? undefined (ip?.data ? undefined for ip in ips) class ProcessOutput constructor: (@ports, @ip, @nodeInstance, @result) -> @scope = @ip.scope # Sets component state to `activated` activate: -> @result.__resolved = false if @nodeInstance.ordered or @nodeInstance.autoOrdering @nodeInstance.outputQ.push @result # Checks if a value is an Error isError: (err) -> err instanceof Error or Array.isArray(err) and err.length > 0 and err[0] instanceof Error # Sends an error object error: (err) -> multiple = Array.isArray err err = [err] unless multiple if 'error' of @ports and (@ports.error.isAttached() or not @ports.error.isRequired()) @sendIP 'error', new IP 'openBracket' if multiple @sendIP 'error', e for e in err @sendIP 'error', new IP 'closeBracket' if multiple else throw e for e in err # Sends a single IP object to a port sendIP: (port, packet) -> if typeof packet isnt 'object' or IP.types.indexOf(packet.type) is -1 ip = new IP 'data', packet else ip = packet ip.scope = @scope if @scope isnt null and ip.scope is null if @nodeInstance.ordered or @nodeInstance.autoOrdering @result[port] = [] unless port of @result @result[port].push ip else @nodeInstance.outPorts[port].sendIP ip # Sends packets for each port as a key in the map # or sends Error or a list of Errors if passed such send: (outputMap) -> if (@nodeInstance.ordered or @nodeInstance.autoOrdering) and not ('__resolved' of @result) @activate() return @error outputMap if @isError outputMap for port, packet of outputMap @sendIP port, packet # Sends the argument via `send()` and marks activation as `done()` sendDone: (outputMap) -> @send outputMap @done() # Makes a map-style component pass a result value to `out` # keeping all IP metadata received from `in`, # or modifying it if `options` is provided pass: (data, options = {}) -> unless 'out' of @ports throw new Error 'output.pass() requires port "out" to be present' for key, val of options @ip[key] = val @ip.data = data @sendIP 'out', @ip @done() # Finishes process activation gracefully done: (error) -> @error error if error if @nodeInstance.ordered or @nodeInstance.autoOrdering @result.__resolved = true @nodeInstance.processOutputQueue() @nodeInstance.load--