meteor/packages/ui/render.js

var DomRange = UI.DomRange;

// RENDER BUFFER API
//
// Used on client (or server) to generate reactive DOM (or static HTML).
//
// `buf.write(thing1, thing2, thing3, ...)`
//
// Where things can be:
//
// - `null` or `undefined`, i.e. `== null` (ignored)
// - String (any raw HTML substring with no limitations)
// - Component (a kind to instantiate and insert)
// - function returning Component (reactive kind)
// - { kind: functionOrComponent, props: dict } (reactive kind, instantiated
//   with props
// - { attrs: functionOrDictionary } - reactive dictionary of attributes,
//   only allowed inside an HTML tag.  For example,
//   `buf.write("<div ", { attrs: { 'class': 'foo' } }, ">text</div>")`.

UI.insert = DomRange && DomRange.insert;

UI.render = function (kind, props, parentComp) {
  // XXX Handle case where kind is function reactively.
  // Reuse the same DomRange.
  if ((typeof kind) === 'function') {
    // XXX scope this autorun
    // XXXXXXX THIS IS NOT GOING TO WORK
    Deps.autorun(function (c) {
      if (c.firstRun) {
        kind = kind();
      } else {
        debugger; // XXX
      }
    });
  }

  if (kind === null)
    return null;
  if (! UI.isComponent(kind))
    throw new Error("Expected Component, function, or null");
  if (kind.isInited)
    throw new Error("Expected uninited Component");

  var comp = kind.extend(props);
  comp.isInited = true;
  comp.templateInstance = {
    findAll: function (selector) {
      return comp.dom.$(selector);
    },
    find: function (selector) {
      var result = this.findAll(selector);
      return result[0] || null;
    },
    firstNode: null,
    lastNode: null,
    data: null,
    __component__: comp
  };
  if (parentComp)
    comp.parent = parentComp;

  if (comp.init)
    comp.init();

  if (comp.created) {
    Deps.nonreactive(function () {
      updateTemplateInstance(comp);
      comp.created.call(comp.templateInstance);
    });
  }

  var range = new DomRange(comp);

  if (comp.render) {
    // XXX scope this autorun
    Deps.autorun(function (c) {
      if (! c.firstRun) {
        range.removeAll();
      }
      var buf = makeRenderBuffer();
      comp.render(buf);
      buf.build(comp);
    });
  }

  return comp;
};


/*
// Render an instance of a component kind directly into the DOM,
// optionally with a parentComp (for e.g. name resolution).
// `parentNode` must be an ELEMENT, not a fragment.
UI.renderTo = function (kind, props,
                        parentNode, beforeNode, parentComp) {
  // XXX too bad we don't validate arguments before mutating
  // the DOM
  var range = new DomRange;
  // Insert new DomRange's start/end markers
  DomRange.insert(range, parentNode, beforeNode);

//  var nodes = range.getNodes();
//  for (var i = 0, N = nodes.length; i < N; i++)
//    parentNode.insertBefore(nodes[i],
                            // IE needs null
//                            beforeNode || null);


  return UI.renderToRange(kind, props, range, parentComp, true);
};

UI.renderToRange = function (kind, props, range, parentComp, _XXXrenderTo) {

  // XXX Handle case where kind is function reactively.
  // Reuse the same DomRange.
  if ((typeof kind) === 'function') {
    // XXX scope this autorun
    Deps.autorun(function (c) {
      if (c.firstRun) {
        kind = kind();
      } else {
        debugger; // XXX
      }
    });
  }

  if (kind === null)
    return null;
  if (! UI.isComponent(kind))
    throw new Error("Expected Component, function, or null");
  if (kind.isInited)
    throw new Error("Expected uninited Component");

  var comp = kind.extend(props);

  comp.dom = range;
  // XXXXXX
  if (_XXXrenderTo) {
    range.component = comp;
    comp.parented();
  }
  // XXXXXX
  comp.isInited = true;
  if (parentComp)
    comp.parent = parentComp;

  if (comp.init)
    comp.init();

  if (comp.render) {
    // XXX scope this autorun
    Deps.autorun(function (c) {
      if (! c.firstRun) {
        range.removeAll();
      }
      var buf = makeRenderBuffer();
      comp.render(buf);
      buf.build(comp);
    });
  }

  // XXX think about this callback's semantics
  if (comp.rendered)
    comp.rendered();

  return comp;

};
*/

var ESCAPED_CHARS_UNQUOTED_REGEX = /[&<>]/g;
var ESCAPED_CHARS_QUOTED_REGEX = /[&<>"]/g;

var escapeMap = {
  "<": "&lt;",
  ">": "&gt;",
  "&": "&amp;",
  '"': "&quot;"
};
var escapeOne = function(c) {
  return escapeMap[c];
};

UI.encodeSpecialEntities = function (text, isQuoted) {
  // Encode Unicode characters to HTML entities.
  //
  // This implementation just encodes the characters that otherwise
  // wouldn't parse (like `<`) and passes the rest through.  You'd
  // need to do something different if you care about HTML entities as
  // a way to embed special characters in ASCII.
  return text.replace(isQuoted ? ESCAPED_CHARS_QUOTED_REGEX :
                      ESCAPED_CHARS_UNQUOTED_REGEX, escapeOne);
};


var GT_OR_QUOTE = /[>'"]/;

makeRenderBuffer = function (options) {
  var isPreview = !! options && options.preview;

  var strs = [];
  var componentsToRender = null; // {}
  var randomString = null; // Random.id()
  var commentUid = 1;
  var elementUid = 1;
  // Problem: In the template `<span {{foo}} {{bar}}>`, how do
  // we make foo and bar insert some HTML in the stream that
  // will allow us to find the element later?  Since we don't
  // tokenize the HTML here, we can't even be sure whether
  // they are in the same tag.  We can't emit a duplicate
  // extra attribute.  We can emit different attributes,
  // but if every attr tag emits a different attribute, it
  // won't be efficient to find them.
  //
  // Solution: Emit different attributes, data-meteorui-id1
  // and data-meteorui-id2, not knowing if they are on the
  // same element or not.  Reset the number, which is
  // `curDataAttrNumber`, if we can be absolutely sure a tag
  // has ended.  To detect if a tag has definitely ended,
  // we set `greaterThanEndsTag` to true after an attr tag,
  // and set it to false if we see a quote character.  If we
  // a greater-than (`>`) between the attrs and the next quote
  // character, we know the tag has ended and we can reset
  // `curDataAttrNumber` to 1.  When we look for these
  // attributes, we look for attribute names with numbers
  // between 1 and `maxDataAttrNumber` inclusive.
  var curDataAttrNumber = 1;
  var maxDataAttrNumber = 0;
  var dataAttrs = null; // []; names of all HTML attributes used
  var greaterThanEndsTag = false;

  var attrManagersToWire = null; // {}

  var push = function (/*stringsToPush*/) {
    for (var i = 0, N = arguments.length;
         greaterThanEndsTag && i < N;
         i++) {
      // find first greater-than or quote
      var match = arguments[i].match(GT_OR_QUOTE);
      if (match) {
        if (match[0] == '>')
          curDataAttrNumber = 1;
        // if it's a quote, missed our chance to
        // reset the count.  either way, stop looking.
        greaterThanEndsTag = false;
      }
    }
    strs.push.apply(strs, arguments);
  };

  var handle = function (arg) {
    if (arg == null) {
      // nothing to do
    } else if (typeof arg === 'string') {
      // "HTML"
      push(arg);
    } else if (UI.isComponent(arg) ||
               (typeof arg) === 'function' ||
               arg.kind) {
      // component kind, function returning kind-or-null,
      // or `{kind: componentOrFunction, [props]}`
      // XXX maybe check validity of the object now if `arg.kind`
      randomString = randomString || Random.id();
      var commentString = randomString + '_' + (commentUid++);
      push('<!--', commentString, '-->');
      componentsToRender = componentsToRender || {};
      componentsToRender[commentString] = arg;
    } else if (arg.attrs) {
      // `{attrs: functionOrDictionary }`
      // attrs object inserts zero or more `name="value"` items
      // into the HTML, and can reactively update them later.
      // You can have multiple attrs objects in a tag, but they
      // can't specify any of the same attributes (i.e. if `{{foo}}`
      // and `{{bar}}` in the same tag declare a same-named attribute,
      // they won't cooperate).
      var elemId = null;

      var manager = new AttributeManager(arg.attrs);

      if (manager.isReactive()) {
        var elemId = elementUid++;
        // don't call the `push` helper, go around it
        strs.push(' data-meteorui-id', curDataAttrNumber,
                  '="', elemId, '" ');
        if (curDataAttrNumber > maxDataAttrNumber) {
          if (! dataAttrs) {
            dataAttrs = [];
            attrManagersToWire = {};
          }
          dataAttrs[curDataAttrNumber-1] =
            'data-meteorui-id' + curDataAttrNumber;
          maxDataAttrNumber = curDataAttrNumber;
        }
        curDataAttrNumber++;
        greaterThanEndsTag = true;

        attrManagersToWire[elemId] = manager;
      }

      // don't call the `push` helper, go around it
      strs.push(' ', manager.getInitialHTML(), ' ');

    } else {
      throw new Error("Expected HTML string, Component, function, or attrs spec, found: " + arg);
    }
  };

  var buf = {};
  buf.write = function (/*args*/) {
    var ret;
    for (var i = 0; i < arguments.length; i++)
      ret = handle(arguments[i]);
    return ret;
  };

  buf.getHtml = function () {
    return strs.join('');
  };

  buf.build = function (component) {
    var html = buf.getHtml();

    var range = component.dom;
    // assert: range is empty.
    var start = range.startNode();
    var nextNode = start.nextSibling;
    // jQuery does fancy html-to-DOM compat stuff here:
    var newNodes = UI.DomBackend.parseHTML(html);

    var wire = function (n, atTopLevel) {
      // returns what ended up in the place of `n`:
      // component, node, or null
      if (n.nodeType === 8) { // COMMENT
        if (componentsToRender) {
          var spec = componentsToRender[n.nodeValue];
          if (! spec)
            return n;
          var kind, props;
          // (components and `{kind: ...}` specs both
          // have a `kind` property.  check for a spec)
          if (! UI.isComponent(spec) && spec.kind) {
            kind = spec.kind;
            props = spec.props;
          } else {
            kind = spec;
            props = null;
          }
          if (kind || kind === null) {
            // XXX ok, we should definitely catch exceptions
            // here and not totally screw everything up,
            // since we're walking the DOM and calling into
            // some potentially major app-dev code
            var comp = UI.render(kind, props, component);
            if (! atTopLevel)
              UI.insert(comp, n.parentNode, n);
            n.parentNode.removeChild(n);
            delete componentsToRender[n.nodeValue];
            return comp; // may be null
          }
        }
      } else if (n.nodeType === 1) { // ELEMENT
        if (attrManagersToWire) {
          // detect elements with reactive attributes
          for (var i = 0; i < maxDataAttrNumber; i++) {
            var attrName = dataAttrs[i];
            var elemId = n.getAttribute(attrName);
            if (elemId) {
              var mgr = attrManagersToWire[elemId];
              if (mgr) {
                mgr.wire(n);
                // XXX bad to do this immediately for
                // some reason?  in previous shark revs we
                // used to delay it using `onNextBuilt`
                mgr.start();
              }
              n.removeAttribute(attrName);
            }
          }
        }
      }
      return n;
    };

    // walk nodes and replace comments with Components
    var walk = function (element) {
      for (var n = element.firstChild, m;
           n; n = m) {
        m = n.nextSibling;
        var result = wire(n);
        // result is DOM node, component, or null.
        // skip components, only recurse on single element nodes.
        if (result && result.nodeType === 1 && result.firstChild)
          walk(result);
      }
    };

    // top level
    for (var i = 0; i < newNodes.length; i++) {
      var n = newNodes[i];
      var result = wire(n, true);
      // `result` is DOM node, component, or null
      if (result) {
        range.add(result);
        if (result.nodeType === 1 && result.firstChild)
          walk(result);
      }
    }

    // We should have attached all specified components, but
    // if the comments we generated somehow didn't turn into
    // comments (due to bad HTML) we won't have found them,
    // in which case we clean them up here just to be safe.
    //
    // XXXX revisit when there's "destroy" again
//    if (componentsToRender)
//      for (var k in componentsToRender)
//        componentsToRender[k].destroy();

    // aid GC
    componentsToRender = null;
    attrManagersToWire = null;
  };

  return buf;
};