docurium 0.4.1 → 0.7.0

data/site/js/docurium.js

@@ -12,46 +12,52 @@ $(function() {
 
       // Function groups
       var funs = _.map(data['groups'], function(group, i) {
-	var name = group[0]
-	var link = groupLink(name, version)
-	return {name: name, link: link, num: group[1].length}
+        var name = group[0]
+        var link = groupLink(name, version)
+        return {name: name, link: link, num: group[1].length}
+      })
+
+      // Callbacks
+      var callbacks = _.map(_.keys(data['callbacks']), function(name) {
+        var link = functionLink('callback', name, version)
+        return {name: name, link: link}
       })
 
       // Types
       var getName = function(type) {
-	var name = type[0];
-	var link = typeLink(name, version);
-	return {link: link, name: name};
+        var name = type[0];
+        var link = typeLink(name, version);
+        return {link: link, name: name};
       }
 
       var enums = _.filter(data['types'], function(type) {
-	return type[1]['block'] && type[1]['type'] == 'enum';
+        return type[1]['block'] && type[1]['type'] == 'enum';
       }).map(getName)
 
       var structs = _.filter(data['types'], function(type) {
-	return type[1]['block'] && type[1]['type'] != 'enum'
+        return type[1]['block'] && type[1]['type'] != 'enum'
       }).map(getName)
 
       var opaques = _.filter(data['types'], function(type) {
-	return !type[1]['block']
+        return !type[1]['block']
       }).map(getName)
 
       // File Listing
       var files = _.map(data['files'], function(file) {
-	var url = this.github_file(file['file'])
-	return {url: url, name: file['file']}
+        var url = this.github_file(file['file'])
+        return {url: url, name: file['file']}
       }, docurium)
 
       // Examples List
       var examples = []
       if(data['examples'] && (data['examples'].length > 0)) {
-	examples = _.map(data['examples'], function(file) {
-	  return {name: file[0], path: file[1]}
-	})
+        examples = _.map(data['examples'], function(file) {
+          return {name: file[0], path: file[1]}
+        })
       }
 
-      this.set('data', {funs: funs, enums: enums, structs: structs, opaques: opaques,
-			files: files, examples: examples})
+      this.set('data', {funs: funs, callbacks: callbacks, enums: enums, structs: structs,
+        opaques: opaques, files: files, examples: examples})
     },
   })
 
@@ -78,12 +84,24 @@ $(function() {
     render: function() {
       var data = this.model.get('data')
 
-      var enumList = this.typeTemplate({title: 'Enums', elements: data.enums})
-      var structList = this.typeTemplate({title: 'Structs', elements: data.structs})
-      var opaquesList = this.typeTemplate({title: 'Opaque Structs', elements: data.opaques})
       var menu = $(this.template({funs: data.funs, files: data.files, examples: data.examples}))
 
-      $('#types-list', menu).append(enumList, structList, opaquesList)
+      if (data.enums.length) {
+          var enumList = this.typeTemplate({title: 'Enums', elements: data.enums})
+          $('#types-list', menu).append(enumList)
+      }
+      if (data.structs.length) {
+          var structList = this.typeTemplate({title: 'Structs', elements: data.structs})
+          $('#types-list', menu).append(structList)
+      }
+      if (data.opaques.length) {
+          var opaquesList = this.typeTemplate({title: 'Opaque Structs', elements: data.opaques})
+          $('#types-list', menu).append(opaquesList)
+      }
+      if (data.callbacks.length) {
+          var callbacksList = this.typeTemplate({title: 'Callbacks', elements: data.callbacks})
+          $('#types-list', menu).append(callbacksList)
+      }
 
       this.$el.html(menu)
       return this
@@ -169,34 +187,34 @@ $(function() {
 
       // figure out the adds, deletes and changes
       _.forEach(sigHist, function(func, fname) {
-	var lastv = _.last(func.exists)
-	var firstv = _.first(func.exists)
-	changelog[firstv]['adds'].push(fname)
-
-	// figure out where it was deleted or changed
-	if (lastv && (lastv != lastVer)) {
-	  var vi = _.indexOf(versions,lastv)
-	  var delv = versions[vi-1]
-	  changelog[delv]['deletes'].push(fname)
-
-	  _.forEach(func.changes, function(_, v) {
-	    changelog[v]['changes'].push(fname)
-	  })
-	}
+        var lastv = _.last(func.exists)
+        var firstv = _.first(func.exists)
+        changelog[firstv]['adds'].push(fname)
+
+        // figure out where it was deleted or changed
+        if (lastv && (lastv != lastVer)) {
+          var vi = _.indexOf(versions,lastv)
+          var delv = versions[vi-1]
+          changelog[delv]['deletes'].push(fname)
+
+          _.forEach(func.changes, function(_, v) {
+            changelog[v]['changes'].push(fname)
+          })
+        }
       })
 
       var vers = _.map(versions, function(version) {
-	var deletes = changelog[version]['deletes']
-	deletes.sort()
+        var deletes = changelog[version]['deletes']
+        deletes.sort()
 
-	var additions = changelog[version]['adds']
-	additions.sort()
-	var adds = _.map(additions, function(add) {
+        var additions = changelog[version]['adds']
+        additions.sort()
+        var adds = _.map(additions, function(add) {
           var gname = this.model.groupOf(add)
-	  return {link: functionLink(gname, add, version), text: add}
-	}, this)
+          return {link: functionLink(gname, add, version), text: add}
+        }, this)
 
-	return {title: version, listing: this.itemTemplate({dels: deletes, adds: adds})}
+        return {title: version, listing: this.itemTemplate({dels: deletes, adds: adds})}
       }, this)
 
       this.el = this.template({versions: vers})
@@ -220,15 +238,15 @@ $(function() {
 
       var ldata = fdata
       if (isCallback) {
-	var cdata = docurium.get('data')['callbacks']
-	ldata = cdata
+        var cdata = docurium.get('data')['callbacks']
+        ldata = cdata
       } else {
-	var functions = group[1]
+        var functions = _.filter(group[1], function(f){ return f != fname})
       }
 
       // Function Arguments
       var args = _.map(ldata[fname]['args'], function(arg) {
-	return {link: this.hotLink(arg.type), name: arg.name, comment: arg.comment}
+        return {link: this.hotLink(arg.type), name: arg.name, comment: arg.comment}
       }, docurium)
 
       var data = ldata[fname]
@@ -239,32 +257,32 @@ $(function() {
       var sig = docurium.hotLink(ret.type) + ' ' + fname + '(' + data['argline'] + ');'
       // version history
       if (!isCallback) {
-	var sigHist = docurium.get('signatures')[fname]
-	var version = docurium.get('version')
-	var sigs = _.map(sigHist.exists, function(ver) {
-	  var klass = []
-	  if (sigHist.changes[ver])
-	    klass.push('changed')
-	  if (ver == version)
-	    klass.push('current')
-
-	  return {url: '#' + functionLink(gname, fname, ver), name: ver, klass: klass.join(' ')}
-	})
+        var sigHist = docurium.get('signatures')[fname]
+        var version = docurium.get('version')
+        var sigs = _.map(sigHist.exists, function(ver) {
+          var klass = []
+          if (sigHist.changes[ver])
+            klass.push('changed')
+            if (ver == version)
+              klass.push('current')
+
+              return {url: '#' + functionLink(gname, fname, ver), name: ver, klass: klass.join(' ')}
+        })
       }
       // GitHub link
       var fileLink = docurium.github_file(data.file, data.line, data.lineto)
       // link to the group
       if (!isCallback) {
-	var version = docurium.get('version')
-	var alsoGroup = '#' + groupLink(group[0], version)
-	var alsoLinks = _.map(functions, function(f) {
-	  return {url: '#' + functionLink(gname, f, version), name: f}
-	})
+        var version = docurium.get('version')
+        var alsoGroup = '#' + groupLink(group[0], version)
+        var alsoLinks = _.map(functions, function(f) {
+          return {url: '#' + functionLink(gname, f, version), name: f}
+        })
       }
 
       this.set('data', {name: fname, data: data, args: args, returns: returns, sig: sig,
-			sigs: sigs, fileLink: fileLink, groupName: gname,
-			alsoGroup: alsoGroup, alsoLinks: alsoLinks})
+        sigs: sigs, fileLink: fileLink, groupName: gname,
+        alsoGroup: alsoGroup, alsoLinks: alsoLinks})
     }
   })
 
@@ -295,18 +313,18 @@ $(function() {
       var version = this.docurium.get('version')
 
       var groups = _.map(data.groups, function(group) {
-	var gname = group[0]
-	var funs = _.map(group[1], function(fun) {
-	  var klass = ''
-	  if (sigHist[fun].changes[version])
-	    klass = 'changed'
-
-	  if (version == _.first(sigHist[fun].exists))
-	    klass = 'introd'
-
-	  return {name: fun, url: '#' + functionLink(gname, fun, version), klass: klass}
-	})
-	return {name: gname, funs: funs}
+        var gname = group[0]
+        var funs = _.map(group[1], function(fun) {
+          var klass = ''
+          if (sigHist[fun].changes[version])
+            klass = 'changed'
+
+            if (version == _.first(sigHist[fun].exists))
+              klass = 'introd'
+
+              return {name: fun, url: '#' + functionLink(gname, fun, version), klass: klass}
+        })
+        return {name: gname, funs: funs}
       })
 
       this.reset(groups)
@@ -329,38 +347,33 @@ $(function() {
       var version = docurium.get('version')
       var types = docurium.get('data')['types']
       var tdata = _.find(types, function(g) {
-	return g[0] == typename
+        return g[0] == typename
       })
       var tname = tdata[0]
       var data = tdata[1]
 
-      var toPair = function(fun) {
-	var gname = this.groupOf(fun)
-	var url = '#' + functionLink(gname, fun, version)
-	return {name: fun, url: url}
+      var toFuncPair = function(fun) {
+        var gname = this.groupOf(fun)
+        var url = '#' + functionLink(gname, fun, version)
+        return {name: fun, url: url}
+      }
+
+      var toTypePair = function(type) {
+        var url = '#' + typeLink(type, version)
+        return {name: type, url: url}
       }
 
-      var returns = _.map(data.used.returns, toPair, docurium)
-      var needs = _.map(data.used.needs, toPair, docurium)
+      var returns = _.map(data.used.returns, toFuncPair, docurium)
+      var needs = _.map(data.used.needs, toFuncPair, docurium)
+      var fields = _.map(data.used.fields, toTypePair, docurium)
       var fileLink = {name: data.file, url: docurium.github_file(data.file, data.line, data.lineto)}
 
-      // so it doesn't look crap, we build up a block with fields
-      // without a comment
-      var had_comment = false
-      var blocks = []
-      var tmp = []
-      _.each(data.fields, function(f) {
-	if (had_comment) {
-	  blocks.push(tmp)
-	  tmp = []
-	}
-
-	tmp.push(f)
-	had_comment = f.comments
-      })
-      blocks.push(tmp)
+      // Hot link our field types
+      data.fields = _.map(data.fields, function(field) {
+        return {type: this.hotLink(field.type), name: field.name, comments: field.comments}
+      }, docurium)
 
-      this.set('data', {tname: tname, data: data, blocks: blocks, returns: returns, needs: needs, fileLink: fileLink})
+      this.set('data', {tname: tname, data: data, returns: returns, needs: needs, fields: fields, fileLink: fileLink})
     }
   })
 
@@ -391,11 +404,12 @@ $(function() {
       var cdata = o.callbacks
       var version = o.version
 
+      this.gname = gname.charAt(0).toUpperCase() + gname.substring(1).toLowerCase()
       this.functions = _.map(group[1], function(name) {
-	var url = '#' + functionLink(gname, name, version)
-	var d = fdata[name]
-	return {name: name, url: url, returns: d['return']['type'], argline: d['argline'],
-		description: d['description'], comments: d['comments'], args: d['args']}
+        var url = '#' + functionLink(gname, name, version)
+        var d = fdata[name]
+        return {name: name, url: url, returns: d['return']['type'], argline: d['argline'],
+        description: d['description'], comments: d['comments'], args: d['args']}
       })
     },
 
@@ -414,9 +428,9 @@ $(function() {
 
     events: {
       'keyup': function() {
-	this.trigger('keyup')
-	if (this.$el.val() == '')
-	  this.trigger('empty')
+        this.trigger('keyup')
+        if (this.$el.val() == '')
+          this.trigger('empty')
       }
     },
   })
@@ -436,7 +450,7 @@ $(function() {
     keyup: function() {
       var newValue = this.field.$el.val()
       if (this.value == newValue || newValue.length < 3)
-	return
+        return
 
       this.value = newValue
       this.refreshSearch()
@@ -452,19 +466,19 @@ $(function() {
       var version = docurium.get('version')
       // look for functions (name, comment, argline)
       _.forEach(data.functions, function(f, name) {
-	var gname = docurium.groupOf(name)
-	// look in the function name first
+        var gname = docurium.groupOf(name)
+        // look in the function name first
         if (name.search(value) > -1) {
-	  var gl = functionLink(gname, name, version)
-	  var url = '#' + gl
-	  searchResults.push({url: url, name: name, match: 'function', navigate: gl})
-	  return
+          var gl = functionLink(gname, name, version)
+          var url = '#' + gl
+          searchResults.push({url: url, name: name, match: 'function', navigate: gl})
+          return
         }
 
-	// if we didn't find it there, let's look in the argline
+        // if we didn't find it there, let's look in the argline
         if (f.argline && f.argline.search(value) > -1) {
-	  var gl = functionLink(gname, name, version)
-	  var url = '#' + gl
+          var gl = functionLink(gname, name, version)
+          var url = '#' + gl
           searchResults.push({url: url, name: name, match: f.argline, navigate: gl})
         }
       })
@@ -472,8 +486,8 @@ $(function() {
       // look for types
       data.types.forEach(function(type) {
         var name = type[0]
-	var tl = typeLink(name, version)
-	var url = '#' + tl
+        var tl = typeLink(name, version)
+        var url = '#' + tl
         if (name.search(value) > -1) {
           searchResults.push({url: url, name: name, match: type[1].type, navigate: tl})
         }
@@ -481,12 +495,12 @@ $(function() {
 
       // look for callbacks
       _.each(data.callbacks, function(f, name) {
-	if (name.search(value) > -1) {
-	  var gl = functionLink('callback', name, version)
-	  var url = '#' + gl
-	  searchResults.push({url: url, name: name, match: 'callback', navigate: gl})
-	  return
-	}
+        if (name.search(value) > -1) {
+          var gl = functionLink('callback', name, version)
+          var url = '#' + gl
+          searchResults.push({url: url, name: name, match: 'callback', navigate: gl})
+          return
+        }
       })
 
       this.reset(searchResults)
@@ -513,8 +527,8 @@ $(function() {
       view.render()
 
       if (this.activeView) {
-	this.stopListening()
-	this.activeView.remove()
+        this.stopListening()
+        this.activeView.remove()
       }
 
       this.activeView = view
@@ -556,15 +570,15 @@ $(function() {
 
       current = docurium.get('version')
       if (current == version) {
-	if (success)
-	  success();
-	return;
+        if (success)
+          success();
+        return;
       }
 
       docurium.set({version: version})
       p = this.loadDoc()
       if (success)
-	p.then(success)
+        p.then(success)
     },
 
     loadDoc: function() {
@@ -577,27 +591,26 @@ $(function() {
     getGroup: function(gname) {
       var groups = docurium.get('data')['groups']
       return _.find(groups, function(g) {
-	return g[0] == gname
+        return g[0] == gname
       })
     },
 
-    // look for structs and link them 
+    // look for structs and link them
     hotLink: function(text) {
       types = this.get('data')['types']
       var version = this.get('version')
 
-      for(var i=0; i<types.length; i++) {
-        type = types[i]
-        typeName = type[0]
-        typeData = type[1]
-        re = new RegExp(typeName + '\\s', 'gi');
+      _.each(types, function(type) {
+        var typeName = type[0];
+        var typeData = type[1];
+        var re = new RegExp('\\b' + typeName + '\\b', 'gi');
         var link = $('<a>').attr('href', '#' + typeLink(typeName, version)).append(typeName)[0]
         text = text.replace(re, link.outerHTML + ' ')
-      }
+      });
 
       var callbacks = this.get('data')['callbacks']
       _.each(callbacks, function(cb, typeName) {
-        re = new RegExp(typeName + '$', 'gi');
+        var re = new RegExp(typeName + '$', 'gi');
         var link = $('<a>').attr('href', '#' + functionLink('callback', typeName, version)).append(typeName)[0]
         text = text.replace(re, link.outerHTML + ' ')
       });
@@ -606,17 +619,20 @@ $(function() {
     },
 
     groupOf: function (func) {
-      return this.get('data')['functions'][func]['group']
+      if(func in this.get('data')['functions']) {
+        return this.get('data')['functions'][func]['group']
+      }
+      return 'callback'
     },
 
     github_file: function(file, line, lineto) {
       var data = this.get('data')
       url = ['https://github.com', docurium.get('github'),
-	     'blob', docurium.get('version'), data.prefix, file].join('/')
+        'blob', docurium.get('version'), data.prefix, file].join('/')
       if(line) {
         url += '#L' + line.toString()
         if(lineto) {
-          url += '-' + lineto.toString()
+          url += '-L' + lineto.toString()
         }
       } else {
         url += '#files'
@@ -655,47 +671,47 @@ $(function() {
     main: function(version) {
       var self = this
       this.doc.setVersion(version, function() {
-	var view = new MainListView({collection: self.groups})
-	self.mainView.setActive(view)
+        var view = new MainListView({collection: self.groups})
+        self.mainView.setActive(view)
       })
     },
 
     group: function(version, gname) {
       var self = this
       this.doc.setVersion(version, function() {
-	var group = self.doc.getGroup(gname)
-	var fdata = self.doc.get('data')['functions']
-	var cdata = self.doc.get('data')['callbacks']
-	var version = self.doc.get('version')
-	var view = new GroupView({group: group, functions: fdata, callbacks: cdata, version: version})
-	self.mainView.setActive(view)
+        var group = self.doc.getGroup(gname)
+        var fdata = self.doc.get('data')['functions']
+        var cdata = self.doc.get('data')['callbacks']
+        var version = self.doc.get('version')
+        var view = new GroupView({group: group, functions: fdata, callbacks: cdata, version: version})
+        self.mainView.setActive(view)
       });
     },
 
     groupFun: function(version, gname, fname) {
       var self = this
       this.doc.setVersion(version, function() {
-	var model = new FunctionModel({docurium: self.doc, gname: gname, fname: fname})
-	var view = new FunctionView({model: model})
-	self.mainView.setActive(view)
+        var model = new FunctionModel({docurium: self.doc, gname: gname, fname: fname})
+        var view = new FunctionView({model: model})
+        self.mainView.setActive(view)
       })
     },
 
     showtype: function(version, tname) {
       var self = this
       this.doc.setVersion(version, function() {
-	var model = new TypeModel({docurium: self.doc, typename: tname})
-	var view = new TypeView({model: model})
-	self.mainView.setActive(view)
+        var model = new TypeModel({docurium: self.doc, typename: tname})
+        var view = new TypeView({model: model})
+        self.mainView.setActive(view)
       })
     },
 
     search: function(version, query) {
       var self = this
       this.doc.setVersion(version, function() {
-	var view = new SearchView({collection: self.search})
-	$('#search-field').val(query).keyup()
-	self.mainView.setActive(view)
+        var view = new SearchView({collection: self.search})
+        $('#search-field').val(query).keyup()
+        self.mainView.setActive(view)
       })
     },
 
@@ -703,10 +719,10 @@ $(function() {
       // let's wait to process it until it's asked, and let's only do
       // it once
       if (this.changelogView == undefined) {
-	this.changelogView = new ChangelogView({model: this.doc})
+        this.changelogView = new ChangelogView({model: this.doc})
       }
       this.doc.setVersion(undefined, function() {
-	this.mainView.setActive(this.changelogView)
+        this.mainView.setActive(this.changelogView)
       })
     },
   });
@@ -738,7 +754,7 @@ $(function() {
   var mainView = new MainView()
 
   var router = new Workspace({docurium: docurium, search: searchCol, mainView: mainView,
-			      groups: groupCol})
+    groups: groupCol})
 
   searchField.on('empty', function() {
     router.navigate(docurium.get('version'), {trigger: true})