1 // Search script generated by doxygen
2 // Copyright (C) 2009 by Dimitri van Heesch.
4 // The code in this file is loosly based on main.js, part of Natural Docs,
5 // which is Copyright (C) 2003-2008 Greg Valure
6 // Natural Docs is licensed under the GPL.
8 var indexSectionsWithContent
=
10 0: "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001101001001000101001010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
11 1: "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
12 2: "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
13 3: "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
14 4: "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001101001001000101001010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
15 5: "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
18 var indexSectionNames
=
28 function convertToId(search
)
31 for (i
=0;i
<search
.length
;i
++)
33 var c
= search
.charAt(i
);
34 var cn
= c
.charCodeAt(0);
35 if (c
.match(/[a-z0-9]/))
41 result
+="_0"+cn
.toString(16);
45 result
+="_"+cn
.toString(16);
51 function getXPos(item
)
56 while (item
&& item
!=document
.body
)
59 item
= item
.offsetParent
;
65 function getYPos(item
)
70 while (item
&& item
!=document
.body
)
73 item
= item
.offsetParent
;
79 /* A class handling everything associated with the search panel.
82 name - The name of the global variable that will be
83 storing this instance. Is needed to be able to set timeouts.
84 resultPath - path to use for external files
86 function SearchBox(name
, resultsPath
, inFrame
, label
)
88 if (!name
|| !resultsPath
) { alert("Missing parameters to SearchBox."); }
90 // ---------- Instance variables
92 this.resultsPath
= resultsPath
;
94 this.keyTimeoutLength
= 500;
95 this.closeSelectionTimeout
= 300;
96 this.lastSearchValue
= "";
97 this.lastResultsPage
= "";
100 this.searchActive
= false;
101 this.insideFrame
= inFrame
;
102 this.searchLabel
= label
;
104 // ----------- DOM Elements
106 this.DOMSearchField = function()
107 { return document
.getElementById("MSearchField"); }
109 this.DOMSearchSelect = function()
110 { return document
.getElementById("MSearchSelect"); }
112 this.DOMSearchSelectWindow = function()
113 { return document
.getElementById("MSearchSelectWindow"); }
115 this.DOMPopupSearchResults = function()
116 { return document
.getElementById("MSearchResults"); }
118 this.DOMPopupSearchResultsWindow = function()
119 { return document
.getElementById("MSearchResultsWindow"); }
121 this.DOMSearchClose = function()
122 { return document
.getElementById("MSearchClose"); }
124 this.DOMSearchBox = function()
125 { return document
.getElementById("MSearchBox"); }
127 // ------------ Event Handlers
129 // Called when focus is added or removed from the search field.
130 this.OnSearchFieldFocus = function(isActive
)
132 this.Activate(isActive
);
135 this.OnSearchSelectShow = function()
137 var searchSelectWindow
= this.DOMSearchSelectWindow();
138 var searchField
= this.DOMSearchSelect();
140 if (this.insideFrame
)
142 var left
= getXPos(searchField
);
143 var top
= getYPos(searchField
);
144 left
+= searchField
.offsetWidth
+ 6;
145 top
+= searchField
.offsetHeight
;
147 // show search selection popup
148 searchSelectWindow
.style
.display
='block';
149 left
-= searchSelectWindow
.offsetWidth
;
150 searchSelectWindow
.style
.left
= left
+ 'px';
151 searchSelectWindow
.style
.top
= top
+ 'px';
155 var left
= getXPos(searchField
);
156 var top
= getYPos(searchField
);
157 top
+= searchField
.offsetHeight
;
159 // show search selection popup
160 searchSelectWindow
.style
.display
='block';
161 searchSelectWindow
.style
.left
= left
+ 'px';
162 searchSelectWindow
.style
.top
= top
+ 'px';
165 // stop selection hide timer
166 if (this.hideTimeout
)
168 clearTimeout(this.hideTimeout
);
171 return false; // to avoid "image drag" default event
174 this.OnSearchSelectHide = function()
176 this.hideTimeout
= setTimeout(this.name
+".CloseSelectionWindow()",
177 this.closeSelectionTimeout
);
180 // Called when the content of the search field is changed.
181 this.OnSearchFieldChange = function(evt
)
183 if (this.keyTimeout
) // kill running timer
185 clearTimeout(this.keyTimeout
);
189 var e
= (evt
) ? evt
: window
.event
; // for IE
190 if (e
.keyCode
==40 || e
.keyCode
==13)
194 this.OnSearchSelectShow();
195 var win
=this.DOMSearchSelectWindow();
196 for (i
=0;i
<win
.childNodes
.length
;i
++)
198 var child
= win
.childNodes
[i
]; // get span within a
199 if (child
.className
=='SelectItem')
207 else if (window
.frames
.MSearchResults
.searchResults
)
209 var elem
= window
.frames
.MSearchResults
.searchResults
.NavNext(0);
210 if (elem
) elem
.focus();
213 else if (e
.keyCode
==27) // Escape out of the search field
215 this.DOMSearchField().blur();
216 this.DOMPopupSearchResultsWindow().style
.display
= 'none';
217 this.DOMSearchClose().style
.display
= 'none';
218 this.lastSearchValue
= '';
219 this.Activate(false);
224 var searchValue
= this.DOMSearchField().value
.replace(/ +/g
, "");
226 if (searchValue
!= this.lastSearchValue
) // search value has changed
228 if (searchValue
!= "") // non-empty search
230 // set timer for search update
231 this.keyTimeout
= setTimeout(this.name
+ '.Search()',
232 this.keyTimeoutLength
);
234 else // empty search field
236 this.DOMPopupSearchResultsWindow().style
.display
= 'none';
237 this.DOMSearchClose().style
.display
= 'none';
238 this.lastSearchValue
= '';
243 this.SelectItemCount = function(id
)
246 var win
=this.DOMSearchSelectWindow();
247 for (i
=0;i
<win
.childNodes
.length
;i
++)
249 var child
= win
.childNodes
[i
]; // get span within a
250 if (child
.className
=='SelectItem')
258 this.SelectItemSet = function(id
)
261 var win
=this.DOMSearchSelectWindow();
262 for (i
=0;i
<win
.childNodes
.length
;i
++)
264 var child
= win
.childNodes
[i
]; // get span within a
265 if (child
.className
=='SelectItem')
267 var node
= child
.firstChild
;
270 node
.innerHTML
='•';
274 node
.innerHTML
=' ';
281 // Called when an search filter selection is made.
282 // set item with index id as the active item
283 this.OnSelectItem = function(id
)
285 this.searchIndex
= id
;
286 this.SelectItemSet(id
);
287 var searchValue
= this.DOMSearchField().value
.replace(/ +/g
, "");
288 if (searchValue
!="" && this.searchActive
) // something was found -> do a search
294 this.OnSearchSelectKey = function(evt
)
296 var e
= (evt
) ? evt
: window
.event
; // for IE
297 if (e
.keyCode
==40 && this.searchIndex
<this.SelectItemCount()) // Down
300 this.OnSelectItem(this.searchIndex
);
302 else if (e
.keyCode
==38 && this.searchIndex
>0) // Up
305 this.OnSelectItem(this.searchIndex
);
307 else if (e
.keyCode
==13 || e
.keyCode
==27)
309 this.OnSelectItem(this.searchIndex
);
310 this.CloseSelectionWindow();
311 this.DOMSearchField().focus();
318 // Closes the results window.
319 this.CloseResultsWindow = function()
321 this.DOMPopupSearchResultsWindow().style
.display
= 'none';
322 this.DOMSearchClose().style
.display
= 'none';
323 this.Activate(false);
326 this.CloseSelectionWindow = function()
328 this.DOMSearchSelectWindow().style
.display
= 'none';
331 // Performs a search.
332 this.Search = function()
336 // strip leading whitespace
337 var searchValue
= this.DOMSearchField().value
.replace(/^ +/, "");
339 var code
= searchValue
.toLowerCase().charCodeAt(0);
343 hexCode
="0"+code
.toString(16);
347 hexCode
=code
.toString(16);
351 var resultsPageWithSearch
;
354 if (indexSectionsWithContent
[this.searchIndex
].charAt(code
) == '1')
356 resultsPage
= this.resultsPath
+ '/' + indexSectionNames
[this.searchIndex
] + '_' + hexCode
+ '.html';
357 resultsPageWithSearch
= resultsPage
+'?'+escape(searchValue
);
358 hasResultsPage
= true;
360 else // nothing available for this search term
362 resultsPage
= this.resultsPath
+ '/nomatches.html';
363 resultsPageWithSearch
= resultsPage
;
364 hasResultsPage
= false;
367 window
.frames
.MSearchResults
.location
= resultsPageWithSearch
;
368 var domPopupSearchResultsWindow
= this.DOMPopupSearchResultsWindow();
370 if (domPopupSearchResultsWindow
.style
.display
!='block')
372 var domSearchBox
= this.DOMSearchBox();
373 this.DOMSearchClose().style
.display
= 'inline';
374 if (this.insideFrame
)
376 var domPopupSearchResults
= this.DOMPopupSearchResults();
377 domPopupSearchResultsWindow
.style
.position
= 'relative';
378 domPopupSearchResultsWindow
.style
.display
= 'block';
379 var width
= document
.body
.clientWidth
- 8; // the -8 is for IE :-(
380 domPopupSearchResultsWindow
.style
.width
= width
+ 'px';
381 domPopupSearchResults
.style
.width
= width
+ 'px';
385 var domPopupSearchResults
= this.DOMPopupSearchResults();
386 var left
= getXPos(domSearchBox
) + 150; // domSearchBox.offsetWidth;
387 var top
= getYPos(domSearchBox
) + 20; // domSearchBox.offsetHeight + 1;
388 domPopupSearchResultsWindow
.style
.display
= 'block';
389 left
-= domPopupSearchResults
.offsetWidth
;
390 domPopupSearchResultsWindow
.style
.top
= top
+ 'px';
391 domPopupSearchResultsWindow
.style
.left
= left
+ 'px';
395 this.lastSearchValue
= searchValue
;
396 this.lastResultsPage
= resultsPage
;
399 // -------- Activation Functions
401 // Activates or deactivates the search panel, resetting things to
402 // their default values if necessary.
403 this.Activate = function(isActive
)
405 if (isActive
|| // open it
406 this.DOMPopupSearchResultsWindow().style
.display
== 'block'
409 this.DOMSearchBox().className
= 'MSearchBoxActive';
411 var searchField
= this.DOMSearchField();
413 if (searchField
.value
== this.searchLabel
) // clear "Search" term upon entry
415 searchField
.value
= '';
416 this.searchActive
= true;
419 else if (!isActive
) // directly remove the panel
421 this.DOMSearchBox().className
= 'MSearchBoxInactive';
422 this.DOMSearchField().value
= this.searchLabel
;
423 this.searchActive
= false;
424 this.lastSearchValue
= ''
425 this.lastResultsPage
= '';
430 // -----------------------------------------------------------------------
432 // The class that handles everything on the search results page.
433 function SearchResults(name
)
435 // The number of matches from the last run of <Search()>.
436 this.lastMatchCount
= 0;
438 this.repeatOn
= false;
440 // Toggles the visibility of the passed element ID.
441 this.FindChildElement = function(id
)
443 var parentElement
= document
.getElementById(id
);
444 var element
= parentElement
.firstChild
;
446 while (element
&& element
!=parentElement
)
448 if (element
.nodeName
== 'DIV' && element
.className
== 'SRChildren')
453 if (element
.nodeName
== 'DIV' && element
.hasChildNodes())
455 element
= element
.firstChild
;
457 else if (element
.nextSibling
)
459 element
= element
.nextSibling
;
465 element
= element
.parentNode
;
467 while (element
&& element
!=parentElement
&& !element
.nextSibling
);
469 if (element
&& element
!=parentElement
)
471 element
= element
.nextSibling
;
477 this.Toggle = function(id
)
479 var element
= this.FindChildElement(id
);
482 if (element
.style
.display
== 'block')
484 element
.style
.display
= 'none';
488 element
.style
.display
= 'block';
493 // Searches for the passed string. If there is no parameter,
494 // it takes it from the URL query.
496 // Always returns true, since other documents may try to call it
497 // and that may or may not be possible.
498 this.Search = function(search
)
500 if (!search
) // get search word from URL
502 search
= window
.location
.search
;
503 search
= search
.substring(1); // Remove the leading '?'
504 search
= unescape(search
);
507 search
= search
.replace(/^ +/, ""); // strip leading spaces
508 search
= search
.replace(/ +$/, ""); // strip trailing spaces
509 search
= search
.toLowerCase();
510 search
= convertToId(search
);
512 var resultRows
= document
.getElementsByTagName("div");
516 while (i
< resultRows
.length
)
518 var row
= resultRows
.item(i
);
519 if (row
.className
== "SRResult")
521 var rowMatchName
= row
.id
.toLowerCase();
522 rowMatchName
= rowMatchName
.replace(/^sr\d*_/, ''); // strip 'sr123_'
524 if (search
.length
<=rowMatchName
.length
&&
525 rowMatchName
.substr(0, search
.length
)==search
)
527 row
.style
.display
= 'block';
532 row
.style
.display
= 'none';
537 document
.getElementById("Searching").style
.display
='none';
538 if (matches
== 0) // no results
540 document
.getElementById("NoMatches").style
.display
='block';
542 else // at least one result
544 document
.getElementById("NoMatches").style
.display
='none';
546 this.lastMatchCount
= matches
;
550 // return the first item with index index or higher that is visible
551 this.NavNext = function(index
)
556 var focusName
= 'Item'+index
;
557 focusItem
= document
.getElementById(focusName
);
558 if (focusItem
&& focusItem
.parentNode
.parentNode
.style
.display
=='block')
562 else if (!focusItem
) // last element
572 this.NavPrev = function(index
)
577 var focusName
= 'Item'+index
;
578 focusItem
= document
.getElementById(focusName
);
579 if (focusItem
&& focusItem
.parentNode
.parentNode
.style
.display
=='block')
583 else if (!focusItem
) // last element
593 this.ProcessKeys = function(e
)
595 if (e
.type
== "keydown")
597 this.repeatOn
= false;
598 this.lastKey
= e
.keyCode
;
600 else if (e
.type
== "keypress")
604 if (this.lastKey
) this.repeatOn
= true;
605 return false; // ignore first keypress after keydown
608 else if (e
.type
== "keyup")
611 this.repeatOn
= false;
613 return this.lastKey
!=0;
616 this.Nav = function(evt
,itemIndex
)
618 var e
= (evt
) ? evt
: window
.event
; // for IE
619 if (e
.keyCode
==13) return true;
620 if (!this.ProcessKeys(e
)) return false;
622 if (this.lastKey
==38) // Up
624 var newIndex
= itemIndex
-1;
625 var focusItem
= this.NavPrev(newIndex
);
628 var child
= this.FindChildElement(focusItem
.parentNode
.parentNode
.id
);
629 if (child
&& child
.style
.display
== 'block') // children visible
633 while (1) // search for last child
635 tmpElem
= document
.getElementById('Item'+newIndex
+'_c'+n
);
652 else // return focus to search field
654 parent
.document
.getElementById("MSearchField").focus();
657 else if (this.lastKey
==40) // Down
659 var newIndex
= itemIndex
+1;
661 var item
= document
.getElementById('Item'+itemIndex
);
662 var elem
= this.FindChildElement(item
.parentNode
.parentNode
.id
);
663 if (elem
&& elem
.style
.display
== 'block') // children visible
665 focusItem
= document
.getElementById('Item'+itemIndex
+'_c0');
667 if (!focusItem
) focusItem
= this.NavNext(newIndex
);
668 if (focusItem
) focusItem
.focus();
670 else if (this.lastKey
==39) // Right
672 var item
= document
.getElementById('Item'+itemIndex
);
673 var elem
= this.FindChildElement(item
.parentNode
.parentNode
.id
);
674 if (elem
) elem
.style
.display
= 'block';
676 else if (this.lastKey
==37) // Left
678 var item
= document
.getElementById('Item'+itemIndex
);
679 var elem
= this.FindChildElement(item
.parentNode
.parentNode
.id
);
680 if (elem
) elem
.style
.display
= 'none';
682 else if (this.lastKey
==27) // Escape
684 parent
.searchBox
.CloseResultsWindow();
685 parent
.document
.getElementById("MSearchField").focus();
687 else if (this.lastKey
==13) // Enter
694 this.NavChild = function(evt
,itemIndex
,childIndex
)
696 var e
= (evt
) ? evt
: window
.event
; // for IE
697 if (e
.keyCode
==13) return true;
698 if (!this.ProcessKeys(e
)) return false;
700 if (this.lastKey
==38) // Up
704 var newIndex
= childIndex
-1;
705 document
.getElementById('Item'+itemIndex
+'_c'+newIndex
).focus();
707 else // already at first child, jump to parent
709 document
.getElementById('Item'+itemIndex
).focus();
712 else if (this.lastKey
==40) // Down
714 var newIndex
= childIndex
+1;
715 var elem
= document
.getElementById('Item'+itemIndex
+'_c'+newIndex
);
716 if (!elem
) // last child, jump to parent next parent
718 elem
= this.NavNext(itemIndex
+1);
725 else if (this.lastKey
==27) // Escape
727 parent
.searchBox
.CloseResultsWindow();
728 parent
.document
.getElementById("MSearchField").focus();
730 else if (this.lastKey
==13) // Enter
738 function setKeyActions(elem
,action
)
740 elem
.setAttribute('onkeydown',action
);
741 elem
.setAttribute('onkeypress',action
);
742 elem
.setAttribute('onkeyup',action
);
745 function setClassAttr(elem
,attr
)
747 elem
.setAttribute('class',attr
);
748 elem
.setAttribute('className',attr
);
751 function createResults()
753 var results
= document
.getElementById("SRResults");
754 for (var e
=0; e
<searchData
.length
; e
++)
756 var id
= searchData
[e
][0];
757 var srResult
= document
.createElement('div');
758 srResult
.setAttribute('id','SR_'+id
);
759 setClassAttr(srResult
,'SRResult');
760 var srEntry
= document
.createElement('div');
761 setClassAttr(srEntry
,'SREntry');
762 var srLink
= document
.createElement('a');
763 srLink
.setAttribute('id','Item'+e
);
764 setKeyActions(srLink
,'return searchResults.Nav(event,'+e
+')');
765 setClassAttr(srLink
,'SRSymbol');
766 srLink
.innerHTML
= searchData
[e
][1][0];
767 srEntry
.appendChild(srLink
);
768 if (searchData
[e
][1].length
==2) // single result
770 srLink
.setAttribute('href',searchData
[e
][1][1][0]);
771 if (searchData
[e
][1][1][1])
773 srLink
.setAttribute('target','_parent');
775 var srScope
= document
.createElement('span');
776 setClassAttr(srScope
,'SRScope');
777 srScope
.innerHTML
= searchData
[e
][1][1][2];
778 srEntry
.appendChild(srScope
);
780 else // multiple results
782 srLink
.setAttribute('href','javascript:searchResults.Toggle("SR_'+id
+'")');
783 var srChildren
= document
.createElement('div');
784 setClassAttr(srChildren
,'SRChildren');
785 for (var c
=0; c
<searchData
[e
][1].length
-1; c
++)
787 var srChild
= document
.createElement('a');
788 srChild
.setAttribute('id','Item'+e
+'_c'+c
);
789 setKeyActions(srChild
,'return searchResults.NavChild(event,'+e
+','+c
+')');
790 setClassAttr(srChild
,'SRScope');
791 srChild
.setAttribute('href',searchData
[e
][1][c
+1][0]);
792 if (searchData
[e
][1][c
+1][1])
794 srChild
.setAttribute('target','_parent');
796 srChild
.innerHTML
= searchData
[e
][1][c
+1][2];
797 srChildren
.appendChild(srChild
);
799 srEntry
.appendChild(srChildren
);
801 srResult
.appendChild(srEntry
);
802 results
.appendChild(srResult
);