Namespace
+ -
+
+
- + MODULE + BitmaskAttributes::ClassMethods + + +
- + CLASS + BitmaskAttributes::Definition + + +
- + CLASS + BitmaskAttributes::ValueProxy + + +
Constants
+ | VERSION | += | +"0.2.3".freeze | +
| + | + | |
| VERSION | += | +"0.2.3".freeze | +
| + | + | |
+ Source: + show + +
+# File lib/bitmask_attributes.rb, line 8 +def bitmask(attribute, options={}, &extension) + unless options[:as] && options[:as].kind_of?(Array) + raise ArgumentError, "Must provide an Array :as option" + end + bitmask_definitions[attribute] = Definition.new(attribute, options[:as].to_a, &extension) + bitmask_definitions[attribute].install_on(self) +end+
+ Source: + show + +
+# File lib/bitmask_attributes.rb, line 16 +def bitmask_definitions + @bitmask_definitions ||= {} +end+
+ Source: + show + +
+# File lib/bitmask_attributes.rb, line 20 +def bitmasks + @bitmasks ||= {} +end+
| + [R] + | +attribute | ++ |
| + [R] + | +extension | ++ |
| + [R] + | +values | ++ |
+ Source: + show + +
+# File lib/bitmask_attributes/definition.rb, line 5 +def initialize(attribute, values=[], &extension) + @attribute = attribute + @values = values + @extension = extension +end+
+ Source: + show + +
+# File lib/bitmask_attributes/definition.rb, line 11 +def install_on(model) + validate_for model + generate_bitmasks_on model + override model + create_convenience_class_method_on model + create_convenience_instance_methods_on model + create_scopes_on model + create_attribute_methods_on model +end+
Returns the defined values as an Array.
++ Source: + show + +
+# File lib/bitmask_attributes/definition.rb, line 65 +def create_attribute_methods_on(model) + model.class_eval %Q( + def self.values_for_#{attribute} # def self.values_for_numbers + #{values} # [:one, :two, :three] + end # end + ) +end+
+ Source: + show + +
+# File lib/bitmask_attributes/definition.rb, line 73 +def create_convenience_class_method_on(model) + model.class_eval %Q( + def self.bitmask_for_#{attribute}(*values) + values.inject(0) do |bitmask, value| + unless (bit = bitmasks[:#{attribute}][value]) + raise ArgumentError, "Unsupported value for #{attribute}: \#{value.inspect}" + end + bitmask | bit + end + end + ) +end+
+ Source: + show + +
+# File lib/bitmask_attributes/definition.rb, line 86 +def create_convenience_instance_methods_on(model) + values.each do |value| + model.class_eval %Q( + def #{attribute}_for_#{value}? + self.#{attribute}?(:#{value}) + end + ) + end + model.class_eval %Q( + def #{attribute}?(*values) + if !values.blank? + values.all? do |value| + self.#{attribute}.include?(value) + end + else + self.#{attribute}.present? + end + end + ) +end+
+ Source: + show + +
+# File lib/bitmask_attributes/definition.rb, line 107 +def create_scopes_on(model) + model.class_eval %Q( + scope :with_#{attribute}, + proc { |*values| + if values.blank? + where('#{attribute} > 0 OR #{attribute} IS NOT NULL') + else + sets = values.map do |value| + mask = #{model}.bitmask_for_#{attribute}(value) + "#{attribute} & \#{mask} <> 0" + end + where(sets.join(' AND ')) + end + } + scope :without_#{attribute}, + proc { |value| + if value + mask = #{model}.bitmask_for_#{attribute}(value) + where("#{attribute} IS NULL OR #{attribute} & ? = 0", mask) + else + where("#{attribute} IS NULL OR #{attribute} = 0") + end + } + + scope :no_#{attribute}, where("#{attribute} = 0 OR #{attribute} IS NULL") + + scope :with_any_#{attribute}, + proc { |*values| + if values.blank? + where('#{attribute} > 0 OR #{attribute} IS NOT NULL') + else + sets = values.map do |value| + mask = #{model}.bitmask_for_#{attribute}(value) + "#{attribute} & \#{mask} <> 0" + end + where(sets.join(' OR ')) + end + } + ) + values.each do |value| + model.class_eval %Q( + scope :#{attribute}_for_#{value}, + where('#{attribute} & ? <> 0', #{model}.bitmask_for_#{attribute}(:#{value})) + ) + end +end+
+ Source: + show + +
+# File lib/bitmask_attributes/definition.rb, line 34 +def generate_bitmasks_on(model) + model.bitmasks[attribute] = HashWithIndifferentAccess.new.tap do |mapping| + values.each_with_index do |value, index| + mapping[value] = 0b1 << index + end + end +end+
+ Source: + show + +
+# File lib/bitmask_attributes/definition.rb, line 42 +def override(model) + override_getter_on(model) + override_setter_on(model) +end+
+ Source: + show + +
+# File lib/bitmask_attributes/definition.rb, line 47 +def override_getter_on(model) + model.class_eval %Q( + def #{attribute} + @#{attribute} ||= BitmaskAttributes::ValueProxy.new(self, :#{attribute}, &self.class.bitmask_definitions[:#{attribute}].extension) + end + ) +end+
+ Source: + show + +
+# File lib/bitmask_attributes/definition.rb, line 55 +def override_setter_on(model) + model.class_eval %Q( + def #{attribute}=(raw_value) + values = raw_value.kind_of?(Array) ? raw_value : [raw_value] + self.#{attribute}.replace(values.reject(&:blank?)) + end + ) +end+
+ Source: + show + +
+# File lib/bitmask_attributes/definition.rb, line 23 +def validate_for(model) + # The model cannot be validated if it is preloaded and the attribute/column is not in the + # database (the migration has not been run) or table doesn't exist. This usually + # occurs in the 'test' and 'production' environment or during migration. + return if defined?(Rails) && Rails.configuration.cache_classes || !model.table_exists? + + unless model.columns.detect { |col| col.name == attribute.to_s } + raise ArgumentError, "`#{attribute}' is not an attribute of `#{model}'" + end +end+
+ Source: + show + +
+# File lib/bitmask_attributes/value_proxy.rb, line 4 +def initialize(record, attribute, &extension) + @record = record + @attribute = attribute + find_mapping + instance_eval(&extension) if extension + super(extract_values) +end+
+ Source: + show + +
+# File lib/bitmask_attributes/value_proxy.rb, line 27 +def to_i + inject(0) { |memo, value| memo | @mapping[value] } +end+
+ Source: + show + +
+# File lib/bitmask_attributes/value_proxy.rb, line 58 +def extract_values + stored = [@record.send(:read_attribute, @attribute) || 0, 0].max + @mapping.inject([]) do |values, (value, bitmask)| + values.tap do + values << value.to_sym if (stored & bitmask > 0) + end + end +end+
+ Source: + show + +
+# File lib/bitmask_attributes/value_proxy.rb, line 67 +def find_mapping + unless (@mapping = @record.class.bitmasks[@attribute]) + raise ArgumentError, "Could not find mapping for bitmask attribute :#{@attribute}" + end +end+
+ Source: + show + +
+# File lib/bitmask_attributes/value_proxy.rb, line 54 +def serialize! + @record.send(:write_attribute, @attribute, to_i) +end+
+ Source: + show + +
+# File lib/bitmask_attributes/value_proxy.rb, line 43 +def symbolize! + orig_replace(map(&:to_sym)) +end+
+ Source: + show + +
+# File lib/bitmask_attributes/value_proxy.rb, line 47 +def updated! + validate! + symbolize! + uniq! + serialize! +end+
+ Source: + show + +
+# File lib/bitmask_attributes/value_proxy.rb, line 33 +def validate! + each do |value| + if @mapping.key? value + true + else + raise ArgumentError, "Unsupported value for `#{@attribute}': #{value.inspect}" + end + end +end+
Transparent manipulation of bitmask attributes for ActiveRecord, based on +the bitmask-attribute gem, which has been dormant since 2009. This updated +gem work with Rails 3 and up (including Rails 3.1).
+ +The best way to install is with RubyGems:
+ +$ [sudo] gem install bitmask_attributes+ +
Or better still, just add it to your Gemfile:
+ +gem 'bitmask_attributes'+ +
Simply declare an existing integer column as a bitmask with its possible +values.
+ +class User < ActiveRecord::Base + bitmask :roles, :as => [:writer, :publisher, :editor, :proofreader] +end ++ +
You can then modify the column using the declared values without resorting +to manual bitmasks.
+ +user = User.create(:name => "Bruce", :roles => [:publisher, :editor]) +user.roles +# => [:publisher, :editor] +user.roles << :writer +user.roles +# => [:publisher, :editor, :writer] ++ +
It’s easy to find out if a record has a given value:
+ +user.roles?(:editor) +# => true ++ +
You can check for multiple values (uses an `and` boolean):
+ +user.roles?(:editor, :publisher) +# => true +user.roles?(:editor, :proofreader) +# => false ++ +
Or, just check if any values are present:
+ +user.roles? +# => true ++ +
You can get the list of values for any given attribute:
+ +User.values_for_roles +# => [:writer, :publisher, :editor, :proofreader] ++ +
A couple useful named scopes are also generated when you use `bitmask`:
+ +User.with_roles +# => (all users with roles) +User.with_roles(:editor) +# => (all editors) +User.with_roles(:editor, :writer) +# => (all users who are BOTH editors and writers) +User.with_any_roles(:editor, :writer) +# => (all users who are editors OR writers) ++ +
Find records without any bitmask set:
+ +User.without_roles +# => (all users without a role) +User.no_roles +# => (all users without a role) ++ +
Find records without a specific attribute.
+ +User.without_roles(:editor) +# => (all users who are not editors) ++ +
Note that “without_” only supports a single attribute argument, and the +“no_” method does not support arguments.
+ +You can add your own methods to the bitmasked attributes (similar to named +scopes):
+ +bitmask :other_attribute, :as => [:value1, :value2] do + def worked? + true + end +end + +user = User.first +user.other_attribute.worked? +# => true ++ +
IMPORTANT: Once you have data using a bitmask, don’t change the order of +the values, remove any values, or insert any new values in the `:as` array +anywhere except at the end. You won’t like the results.
+ +Fork it.
+Create a branch (`git checkout -b new-feature`)
+Make your changes
+Run the tests (`bundle install` then `bundle exec rake`)
+Commit your changes (`git commit -am “Created new feature”`)
+Push to the branch (`git push origin new-feature`)
+Create a pull +request from your branch.
+Promote it. Get others to drop in and +1 it.
+Thanks to Bruce Williams and the +following contributors of the bitmask-attribute plugin:
+Copyright © 2007-2009 Bruce Williams & 2011 Joel Moss. See LICENSE for +details.
+ +"+w.value+"Returns the defined values as an Array.\n"],["create_convenience_class_method_on","BitmaskAttributes::Definition","classes/BitmaskAttributes/Definition.html#method-i-create_convenience_class_method_on","(model)",""],["create_convenience_instance_methods_on","BitmaskAttributes::Definition","classes/BitmaskAttributes/Definition.html#method-i-create_convenience_instance_methods_on","(model)",""],["create_scopes_on","BitmaskAttributes::Definition","classes/BitmaskAttributes/Definition.html#method-i-create_scopes_on","(model)",""],["extract_values","BitmaskAttributes::ValueProxy","classes/BitmaskAttributes/ValueProxy.html#method-i-extract_values","()",""],["find_mapping","BitmaskAttributes::ValueProxy","classes/BitmaskAttributes/ValueProxy.html#method-i-find_mapping","()",""],["generate_bitmasks_on","BitmaskAttributes::Definition","classes/BitmaskAttributes/Definition.html#method-i-generate_bitmasks_on","(model)",""],["install_on","BitmaskAttributes::Definition","classes/BitmaskAttributes/Definition.html#method-i-install_on","(model)",""],["new","BitmaskAttributes::Definition","classes/BitmaskAttributes/Definition.html#method-c-new","(attribute, values=[], &extension)",""],["new","BitmaskAttributes::ValueProxy","classes/BitmaskAttributes/ValueProxy.html#method-c-new","(record, attribute, &extension)",""],["override","BitmaskAttributes::Definition","classes/BitmaskAttributes/Definition.html#method-i-override","(model)",""],["override_getter_on","BitmaskAttributes::Definition","classes/BitmaskAttributes/Definition.html#method-i-override_getter_on","(model)",""],["override_setter_on","BitmaskAttributes::Definition","classes/BitmaskAttributes/Definition.html#method-i-override_setter_on","(model)",""],["serialize!","BitmaskAttributes::ValueProxy","classes/BitmaskAttributes/ValueProxy.html#method-i-serialize-21","()",""],["symbolize!","BitmaskAttributes::ValueProxy","classes/BitmaskAttributes/ValueProxy.html#method-i-symbolize-21","()",""],["to_i","BitmaskAttributes::ValueProxy","classes/BitmaskAttributes/ValueProxy.html#method-i-to_i","()",""],["updated!","BitmaskAttributes::ValueProxy","classes/BitmaskAttributes/ValueProxy.html#method-i-updated-21","()",""],["validate!","BitmaskAttributes::ValueProxy","classes/BitmaskAttributes/ValueProxy.html#method-i-validate-21","()",""],["validate_for","BitmaskAttributes::Definition","classes/BitmaskAttributes/Definition.html#method-i-validate_for","(model)",""],["CHANGELOG","","files/CHANGELOG_rdoc.html","",""],["README","","files/README_rdoc.html","","
BitmaskAttributes\n
Transparent manipulation of bitmask attributes for ActiveRecord, based on\nthe bitmask-attribute …\n"]]}} \ No newline at end of file diff --git a/doc/js/searchdoc.js b/doc/js/searchdoc.js new file mode 100755 index 0000000..0e74220 --- /dev/null +++ b/doc/js/searchdoc.js @@ -0,0 +1,442 @@ +Searchdoc = {}; + +// navigation.js ------------------------------------------ + +Searchdoc.Navigation = new function() { + this.initNavigation = function() { + var _this = this; + + $(document).keydown(function(e) { + _this.onkeydown(e); + }).keyup(function(e) { + _this.onkeyup(e); + }); + + this.navigationActive = true; + } + + this.setNavigationActive = function(state) { + this.navigationActive = state; + this.clearMoveTimeout(); + } + + + this.onkeyup = function(e) { + if (!this.navigationActive) return; + switch(e.keyCode) { + case 37: //Event.KEY_LEFT: + case 38: //Event.KEY_UP: + case 39: //Event.KEY_RIGHT: + case 40: //Event.KEY_DOWN: + case 73: // i - qwerty + case 74: // j + case 75: // k + case 76: // l + case 67: // c - dvorak + case 72: // h + case 84: // t + case 78: // n + this.clearMoveTimeout(); + break; + } + } + + this.onkeydown = function(e) { + if (!this.navigationActive) return; + switch(e.keyCode) { + case 37: //Event.KEY_LEFT: + case 74: // j (qwerty) + case 72: // h (dvorak) + if (this.moveLeft()) e.preventDefault(); + break; + case 38: //Event.KEY_UP: + case 73: // i (qwerty) + case 67: // c (dvorak) + if (e.keyCode == 38 || e.ctrlKey) { + if (this.moveUp()) e.preventDefault(); + this.startMoveTimeout(false); + } + break; + case 39: //Event.KEY_RIGHT: + case 76: // l (qwerty) + case 78: // n (dvorak) + if (this.moveRight()) e.preventDefault(); + break; + case 40: //Event.KEY_DOWN: + case 75: // k (qwerty) + case 84: // t (dvorak) + if (e.keyCode == 40 || e.ctrlKey) { + if (this.moveDown()) e.preventDefault(); + this.startMoveTimeout(true); + } + break; + case 9: //Event.KEY_TAB: + case 13: //Event.KEY_RETURN: + if (this.$current) this.select(this.$current); + break; + } + if (e.ctrlKey && e.shiftKey) this.select(this.$current); + } + + this.clearMoveTimeout = function() { + clearTimeout(this.moveTimeout); + this.moveTimeout = null; + } + + this.startMoveTimeout = function(isDown) { + if (!$.browser.mozilla && !$.browser.opera) return; + if (this.moveTimeout) this.clearMoveTimeout(); + var _this = this; + + var go = function() { + if (!_this.moveTimeout) return; + _this[isDown ? 'moveDown' : 'moveUp'](); + _this.moveTimout = setTimeout(go, 100); + } + this.moveTimeout = setTimeout(go, 200); + } + + this.moveRight = function() { + } + + this.moveLeft = function() { + } + + this.move = function(isDown) { + } + + this.moveUp = function() { + return this.move(false); + } + + this.moveDown = function() { + return this.move(true); + } +} + + +// scrollIntoView.js -------------------------------------- + +function scrollIntoView(element, view) { + var offset, viewHeight, viewScroll, height; + offset = element.offsetTop; + height = element.offsetHeight; + viewHeight = view.offsetHeight; + viewScroll = view.scrollTop; + if (offset - viewScroll + height > viewHeight) { + view.scrollTop = offset - viewHeight + height; + } + if (offset < viewScroll) { + view.scrollTop = offset; + } +} + +// panel.js ----------------------------------------------- + +Searchdoc.Panel = function(element, data, tree, frame) { + this.$element = $(element); + this.$input = $('input', element).eq(0); + this.$result = $('.result ul', element).eq(0); + this.frame = frame; + this.$current = null; + this.$view = this.$result.parent(); + this.data = data; + this.searcher = new Searcher(data.index); + + this.tree = new Searchdoc.Tree($('.tree', element), tree, this); + this.init(); +} + +Searchdoc.Panel.prototype = $.extend({}, Searchdoc.Navigation, new function() { + var suid = 1; + + this.init = function() { + var _this = this; + var observer = function() { + _this.search(_this.$input[0].value); + }; + this.$input.keyup(observer); + this.$input.click(observer); // mac's clear field + + this.searcher.ready(function(results, isLast) { + _this.addResults(results, isLast); + }) + + this.$result.click(function(e) { + _this.$current.removeClass('current'); + _this.$current = $(e.target).closest('li').addClass('current'); + _this.select(); + _this.$input.focus(); + }); + + this.initNavigation(); + this.setNavigationActive(false); + } + + this.search = function(value, selectFirstMatch) { + value = jQuery.trim(value).toLowerCase(); + this.selectFirstMatch = selectFirstMatch; + if (value) { + this.$element.removeClass('panel_tree').addClass('panel_results'); + this.tree.setNavigationActive(false); + this.setNavigationActive(true); + } else { + this.$element.addClass('panel_tree').removeClass('panel_results'); + this.tree.setNavigationActive(true); + this.setNavigationActive(false); + } + if (value != this.lastQuery) { + this.lastQuery = value; + this.firstRun = true; + this.searcher.find(value); + } + } + + this.addResults = function(results, isLast) { + var target = this.$result.get(0); + if (this.firstRun && (results.length > 0 || isLast)) { + this.$current = null; + this.$result.empty(); + } + for (var i=0, l = results.length; i < l; i++) { + target.appendChild(renderItem.call(this, results[i])); + }; + if (this.firstRun && results.length > 0) { + this.firstRun = false; + this.$current = $(target.firstChild); + this.$current.addClass('current'); + if (this.selectFirstMatch) this.select(); + scrollIntoView(this.$current[0], this.$view[0]) + } + if (jQuery.browser.msie) this.$element[0].className += ''; + } + + this.open = function(src) { + this.frame.location.href = '../' + src; + if (this.frame.highlight) this.frame.highlight(src); + } + + this.select = function() { + this.open(this.$current.data('path')); + } + + this.move = function(isDown) { + if (!this.$current) return; + var $next = this.$current[isDown ? 'next' : 'prev'](); + if ($next.length) { + this.$current.removeClass('current'); + $next.addClass('current'); + scrollIntoView($next[0], this.$view[0]); + this.$current = $next; + } + return true; + } + + function renderItem(result) { + var li = document.createElement('li'), + html = '', badge = result.badge; + html += '
'; + if (typeof badge != 'undefined') { + html += '' + escapeHTML(this.data.badges[badge] || 'unknown') + ''; + } + html += hlt(result.namespace) + '
'; + if (result.snippet) html += '' + escapeHTML(result.snippet) + '
'; + li.innerHTML = html; + jQuery.data(li, 'path', result.path); + return li; + } + + function hlt(html) { + return escapeHTML(html).replace(/\u0001/g, '').replace(/\u0002/g, '') + } + + function escapeHTML(html) { + return html.replace(/[&<>]/g, function(c) { + return '&#' + c.charCodeAt(0) + ';'; + }); + } + +}); + +// tree.js ------------------------------------------------ + +Searchdoc.Tree = function(element, tree, panel) { + this.$element = $(element); + this.$list = $('ul', element); + this.tree = tree; + this.panel = panel; + this.init(); +} + +Searchdoc.Tree.prototype = $.extend({}, Searchdoc.Navigation, new function() { + this.init = function() { + var stopper = document.createElement('li'); + stopper.className = 'stopper'; + this.$list[0].appendChild(stopper); + for (var i=0, l = this.tree.length; i < l; i++) { + buildAndAppendItem.call(this, this.tree[i], 0, stopper); + }; + var _this = this; + this.$list.click(function(e) { + var $target = $(e.target), + $li = $target.closest('li'); + if ($target.hasClass('icon')) { + _this.toggle($li); + } else { + _this.select($li); + } + }) + + this.initNavigation(); + if (jQuery.browser.msie) document.body.className += ''; + } + + this.select = function($li) { + this.highlight($li); + var path = $li[0].searchdoc_tree_data.path; + if (path) this.panel.open(path); + } + + this.highlight = function($li) { + if (this.$current) this.$current.removeClass('current'); + this.$current = $li.addClass('current'); + } + + this.toggle = function($li) { + var closed = !$li.hasClass('closed'), + children = $li[0].searchdoc_tree_data.children; + $li.toggleClass('closed'); + for (var i=0, l = children.length; i < l; i++) { + toggleVis.call(this, $(children[i].li), !closed); + }; + } + + this.moveRight = function() { + if (!this.$current) { + this.highlight(this.$list.find('li:first')); + return; + } + if (this.$current.hasClass('closed')) { + this.toggle(this.$current); + } + } + + this.moveLeft = function() { + if (!this.$current) { + this.highlight(this.$list.find('li:first')); + return; + } + if (!this.$current.hasClass('closed')) { + this.toggle(this.$current); + } else { + var level = this.$current[0].searchdoc_tree_data.level; + if (level == 0) return; + var $next = this.$current.prevAll('li.level_' + (level - 1) + ':visible:first'); + this.$current.removeClass('current'); + $next.addClass('current'); + scrollIntoView($next[0], this.$element[0]); + this.$current = $next; + } + } + + this.move = function(isDown) { + if (!this.$current) { + this.highlight(this.$list.find('li:first')); + return true; + } + var next = this.$current[0]; + if (isDown) { + do { + next = next.nextSibling; + if (next && next.style && next.style.display != 'none') break; + } while(next); + } else { + do { + next = next.previousSibling; + if (next && next.style && next.style.display != 'none') break; + } while(next); + } + if (next && next.className.indexOf('stopper') == -1) { + this.$current.removeClass('current'); + $(next).addClass('current'); + scrollIntoView(next, this.$element[0]); + this.$current = $(next); + } + return true; + } + + function toggleVis($li, show) { + var closed = $li.hasClass('closed'), + children = $li[0].searchdoc_tree_data.children; + $li.css('display', show ? '' : 'none') + if (!show && this.$current && $li[0] == this.$current[0]) { + this.$current.removeClass('current'); + this.$current = null; + } + for (var i=0, l = children.length; i < l; i++) { + toggleVis.call(this, $(children[i].li), show && !closed); + }; + } + + function buildAndAppendItem(item, level, before) { + var li = renderItem(item, level), + list = this.$list[0]; + item.li = li; + list.insertBefore(li, before); + for (var i=0, l = item[3].length; i < l; i++) { + buildAndAppendItem.call(this, item[3][i], level + 1, before); + }; + return li; + } + + function renderItem(item, level) { + var li = document.createElement('li'), + cnt = document.createElement('div'), + h1 = document.createElement('h1'), + p = document.createElement('p'), + icon, i; + + li.appendChild(cnt); + li.style.paddingLeft = getOffset(level); + cnt.className = 'content'; + if (!item[1]) li.className = 'empty '; + cnt.appendChild(h1); + // cnt.appendChild(p); + h1.appendChild(document.createTextNode(item[0])); + // p.appendChild(document.createTextNode(item[4])); + if (item[2]) { + i = document.createElement('i'); + i.appendChild(document.createTextNode(item[2])); + h1.appendChild(i); + } + if (item[3].length > 0) { + icon = document.createElement('div'); + icon.className = 'icon'; + cnt.appendChild(icon); + } + + // user direct assignement instead of $() + // it's 8x faster + // $(li).data('path', item[1]) + // .data('children', item[3]) + // .data('level', level) + // .css('display', level == 0 ? '' : 'none') + // .addClass('level_' + level) + // .addClass('closed'); + li.searchdoc_tree_data = { + path: item[1], + children: item[3], + level: level + } + li.style.display = level == 0 ? '' : 'none'; + li.className += 'level_' + level + ' closed'; + return li; + } + + function getOffset(level) { + return 5 + 18*level + 'px'; + } +}); diff --git a/doc/js/searcher.js b/doc/js/searcher.js new file mode 100644 index 0000000..f854b54 --- /dev/null +++ b/doc/js/searcher.js @@ -0,0 +1,228 @@ +Searcher = function(data) { + this.data = data; + this.handlers = []; +} + +Searcher.prototype = new function() { + // search is performed in chunks of 1000 for non-blocking user input + var CHUNK_SIZE = 1000; + // do not try to find more than 100 results + var MAX_RESULTS = 100; + var huid = 1; + var suid = 1; + var runs = 0; + + this.find = function(query) { + var queries = splitQuery(query); + var regexps = buildRegexps(queries); + var highlighters = buildHilighters(queries); + var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++}; + var _this = this; + + this.currentSuid = state.n; + + if (!query) return; + + var run = function() { + // stop current search thread if new search started + if (state.n != _this.currentSuid) return; + + var results = + performSearch(_this.data, regexps, queries, highlighters, state); + var hasMore = (state.limit > 0 && state.pass < 4); + + triggerResults.call(_this, results, !hasMore); + if (hasMore) { + setTimeout(run, 2); + } + runs++; + }; + runs = 0; + + // start search thread + run(); + } + + /* ----- Events ------ */ + this.ready = function(fn) { + fn.huid = huid; + this.handlers.push(fn); + } + + /* ----- Utilities ------ */ + function splitQuery(query) { + return jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) { + return string.match(/\S/) + }); + } + + function buildRegexps(queries) { + return jQuery.map(queries, function(query) { + return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i') + }); + } + + function buildHilighters(queries) { + return jQuery.map(queries, function(query) { + return jQuery.map(query.split(''), function(l, i) { + return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2); + }).join(''); + }); + } + + // function longMatchRegexp(index, longIndex, regexps) { + // for (var i = regexps.length - 1; i >= 0; i--){ + // if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false; + // }; + // return true; + // } + + + /* ----- Mathchers ------ */ + + /* + * This record matches if the index starts with queries[0] and the record + * matches all of the regexps + */ + function matchPassBeginning(index, longIndex, queries, regexps) { + if (index.indexOf(queries[0]) != 0) return false; + for (var i=1, l = regexps.length; i < l; i++) { + if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) + return false; + }; + return true; + } + + /* + * This record matches if the longIndex starts with queries[0] and the + * longIndex matches all of the regexps + */ + function matchPassLongIndex(index, longIndex, queries, regexps) { + if (longIndex.indexOf(queries[0]) != 0) return false; + for (var i=1, l = regexps.length; i < l; i++) { + if (!longIndex.match(regexps[i])) + return false; + }; + return true; + } + + /* + * This record matches if the index contains queries[0] and the record + * matches all of the regexps + */ + function matchPassContains(index, longIndex, queries, regexps) { + if (index.indexOf(queries[0]) == -1) return false; + for (var i=1, l = regexps.length; i < l; i++) { + if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) + return false; + }; + return true; + } + + /* + * This record matches if regexps[0] matches the index and the record + * matches all of the regexps + */ + function matchPassRegexp(index, longIndex, queries, regexps) { + if (!index.match(regexps[0])) return false; + for (var i=1, l = regexps.length; i < l; i++) { + if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) + return false; + }; + return true; + } + + + /* ----- Highlighters ------ */ + function highlightRegexp(info, queries, regexps, highlighters) { + var result = createResult(info); + for (var i=0, l = regexps.length; i < l; i++) { + result.title = result.title.replace(regexps[i], highlighters[i]); + result.namespace = result.namespace.replace(regexps[i], highlighters[i]); + }; + return result; + } + + function hltSubstring(string, pos, length) { + return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length); + } + + function highlightQuery(info, queries, regexps, highlighters) { + var result = createResult(info); + var pos = 0; + var lcTitle = result.title.toLowerCase(); + + pos = lcTitle.indexOf(queries[0]); + if (pos != -1) { + result.title = hltSubstring(result.title, pos, queries[0].length); + } + + result.namespace = result.namespace.replace(regexps[0], highlighters[0]); + for (var i=1, l = regexps.length; i < l; i++) { + result.title = result.title.replace(regexps[i], highlighters[i]); + result.namespace = result.namespace.replace(regexps[i], highlighters[i]); + }; + return result; + } + + function createResult(info) { + var result = {}; + result.title = info[0]; + result.namespace = info[1]; + result.path = info[2]; + result.params = info[3]; + result.snippet = info[4]; + return result; + } + + /* ----- Searching ------ */ + function performSearch(data, regexps, queries, highlighters, state) { + var searchIndex = data.searchIndex; + var longSearchIndex = data.longSearchIndex; + var info = data.info; + var result = []; + var i = state.from; + var l = searchIndex.length; + var togo = CHUNK_SIZE; + var matchFunc, hltFunc; + + while (state.pass < 4 && state.limit > 0 && togo > 0) { + if (state.pass == 0) { + matchFunc = matchPassBeginning; + hltFunc = highlightQuery; + } else if (state.pass == 1) { + matchFunc = matchPassLongIndex; + hltFunc = highlightQuery; + } else if (state.pass == 2) { + matchFunc = matchPassContains; + hltFunc = highlightQuery; + } else if (state.pass == 3) { + matchFunc = matchPassRegexp; + hltFunc = highlightRegexp; + } + + for (; togo > 0 && i < l && state.limit > 0; i++, togo--) { + if (info[i].n == state.n) continue; + if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) { + info[i].n = state.n; + result.push(hltFunc(info[i], queries, regexps, highlighters)); + state.limit--; + } + }; + if (searchIndex.length <= i) { + state.pass++; + i = state.from = 0; + } else { + state.from = i; + } + } + return result; + } + + function triggerResults(results, isLast) { + jQuery.each(this.handlers, function(i, fn) { + fn.call(this, results, isLast) + }) + } +} + diff --git a/doc/panel/index.html b/doc/panel/index.html new file mode 100755 index 0000000..fc53d95 --- /dev/null +++ b/doc/panel/index.html @@ -0,0 +1,73 @@ + + + + + +| + + |