window.relearn = window.relearn || {}; var theme = true; var isIE = /*@cc_on!@*/false || !!document.documentMode; if( isIE ){ // we don't support sidebar flyout in IE document.querySelector( 'body' ).classList.remove( 'mobile-support' ); } else{ document.querySelector( 'body' ).classList.add( 'mobile-support' ); } var isPrint = document.querySelector( 'body' ).classList.contains( 'print' ); var isRtl = document.querySelector( 'html' ).getAttribute( 'dir' ) == 'rtl'; var lang = document.querySelector( 'html' ).getAttribute( 'lang' ); var dir_padding_start = 'padding-left'; var dir_padding_end = 'padding-right'; var dir_key_start = 37; var dir_key_end = 39; var dir_scroll = 1; if( isRtl && !isIE ){ dir_padding_start = 'padding-right'; dir_padding_end = 'padding-left'; dir_key_start = 39; dir_key_end = 37; dir_scroll = -1; } var touchsupport = ('ontouchstart' in window) || (navigator.maxTouchPoints > 0) || (navigator.msMaxTouchPoints > 0) var formelements = 'button, datalist, fieldset, input, label, legend, meter, optgroup, option, output, progress, select, textarea'; // PerfectScrollbar var psc; var psm; var pst; var elc = document.querySelector('#body-inner'); function documentFocus(){ elc.focus(); psc && psc.scrollbarY.focus(); } function scrollbarWidth(){ // https://davidwalsh.name/detect-scrollbar-width // Create the measurement node var scrollDiv = document.createElement("div"); scrollDiv.className = "scrollbar-measure"; document.body.appendChild(scrollDiv); // Get the scrollbar width var scrollbarWidth = scrollDiv.offsetWidth - scrollDiv.clientWidth; // Delete the DIV document.body.removeChild(scrollDiv); return scrollbarWidth; } var scrollbarSize = scrollbarWidth(); function adjustContentWidth(){ var start = parseFloat( getComputedStyle( elc ).getPropertyValue( dir_padding_start ) ); var end = start; if( elc.scrollHeight > elc.clientHeight ){ // if we have a scrollbar reduce the end margin by the scrollbar width end = Math.max( 0, start - scrollbarSize ); } elc.style[ dir_padding_end ] = '' + end + 'px'; } function fixCodeTabs(){ /* if only a single code block is contained in the tab and no style was selected, treat it like style=code */ var codeTabContents = Array.from( document.querySelectorAll( '.tab-content.tab-panel-style' ) ).filter( function( tabContent ){ return tabContent.querySelector( '*:scope > .tab-content-text > div.highlight:only-child, *:scope > .tab-content-text > pre.pre-code:only-child'); }); codeTabContents.forEach( function( tabContent ){ var tabId = tabContent.dataset.tabItem; var tabPanel = tabContent.parentNode.parentNode; var tabButton = tabPanel.querySelector( '.tab-nav-button.tab-panel-style[data-tab-item="'+tabId+'"]' ); if( tabContent.classList.contains( 'initial' ) ){ tabButton.classList.remove( 'initial' ); tabButton.classList.add( 'code' ); tabContent.classList.remove( 'initial' ); tabContent.classList.add( 'code' ); } // mark code blocks for FF without :has() tabContent.classList.add( 'codify' ); }); } function switchTab(tabGroup, tabId) { var tabs = Array.from( document.querySelectorAll( '.tab-panel[data-tab-group="'+tabGroup+'"]' ) ).filter( function( e ){ return !!e.querySelector( '[data-tab-item="'+tabId+'"]' ); }); var allTabItems = tabs && tabs.reduce( function( a, e ){ return a.concat( Array.from( e.querySelectorAll( '[data-tab-item]' ) ).filter( function( es ){ return es.parentNode.parentNode == e; }) ); }, [] ); var targetTabItems = tabs && tabs.reduce( function( a, e ){ return a.concat( Array.from( e.querySelectorAll( '[data-tab-item="'+tabId+'"]' ) ).filter( function( es ){ return es.parentNode.parentNode == e; }) ); }, [] ); // if event is undefined then switchTab was called from restoreTabSelection // so it's not a button event and we don't need to safe the selction or // prevent page jump var isButtonEvent = event && event.target && event.target.getBoundingClientRect; if(isButtonEvent){ // save button position relative to viewport var yposButton = event.target.getBoundingClientRect().top; } allTabItems && allTabItems.forEach( function( e ){ e.classList.remove( 'active' ); }); targetTabItems && targetTabItems.forEach( function( e ){ e.classList.add( 'active' ); }); if(isButtonEvent){ // reset screen to the same position relative to clicked button to prevent page jump var yposButtonDiff = event.target.getBoundingClientRect().top - yposButton; window.scrollTo(window.scrollX, window.scrollY+yposButtonDiff); // Store the selection to make it persistent if(window.localStorage){ var selectionsJSON = window.localStorage.getItem(baseUriFull+"tab-selections"); if(selectionsJSON){ var tabSelections = JSON.parse(selectionsJSON); }else{ var tabSelections = {}; } tabSelections[tabGroup] = tabId; window.localStorage.setItem(baseUriFull+"tab-selections", JSON.stringify(tabSelections)); } } } function restoreTabSelections() { if(window.localStorage){ var selectionsJSON = window.localStorage.getItem(baseUriFull+"tab-selections"); if(selectionsJSON){ var tabSelections = JSON.parse(selectionsJSON); }else{ var tabSelections = {}; } Object.keys(tabSelections).forEach(function(tabGroup) { var tabItem = tabSelections[tabGroup]; switchTab(tabGroup, tabItem); }); } } function initMermaid( update, attrs ) { // we are either in update or initialization mode; // during initialization, we want to edit the DOM; // during update we only want to execute if something changed var decodeHTML = function( html ){ var txt = document.createElement( 'textarea' ); txt.innerHTML = html; return txt.value; }; var parseGraph = function( graph ){ // See https://github.com/mermaid-js/mermaid/blob/9a080bb975b03b2b1d4ef6b7927d09e6b6b62760/packages/mermaid/src/diagram-api/frontmatter.ts#L10 // for reference on the regex originally taken from jekyll var YAML=1; var INIT=2; var GRAPH=3; var d = /^(?:\s*[\n\r])*(?:-{3}(\s*[\n\r](?:.*?)[\n\r])-{3}(?:\s*[\n\r]+)+)?(?:\s*(?:%%\s*\{\s*\w+\s*:([^%]*?)%%\s*[\n\r]?))?(.*)$/s var m = d.exec( graph ); var yaml = {}; var dir = {}; var content = graph; if( m && m.length == 4 ){ yaml = m[YAML] ? jsyaml.load( m[YAML] ) : yaml; dir = m[INIT] ? JSON.parse( '{ "init": ' + m[INIT] ).init : dir; content = m[GRAPH] ? m[GRAPH] : content; } var ret = { yaml: yaml, dir: dir, content: content.trim() } return ret; }; var serializeGraph = function( graph ){ var yamlPart = ''; if( Object.keys( graph.yaml ).length ){ yamlPart = '---\n' + jsyaml.dump( graph.yaml ) + '---\n'; } var dirPart = ''; if( Object.keys( graph.dir ).length ){ dirPart = '%%{init: ' + JSON.stringify( graph.dir ) + '}%%\n'; } return yamlPart + dirPart + graph.content; }; var init_func = function( attrs ){ var is_initialized = false; var theme = attrs.theme; document.querySelectorAll('.mermaid').forEach( function( element ){ var parse = parseGraph( decodeHTML( element.innerHTML ) ); if( parse.yaml.theme ){ parse.yaml.relearn_user_theme = true; } if( parse.dir.theme ){ parse.dir.relearn_user_theme = true; } if( !parse.yaml.relearn_user_theme && !parse.dir.relearn_user_theme ){ parse.yaml.theme = theme; } is_initialized = true; var graph = serializeGraph( parse ); element.innerHTML = graph; var new_element = document.createElement( 'div' ); new_element.classList.add( 'mermaid-container' ); new_element.innerHTML = '
' + graph + '
' + element.outerHTML; element.parentNode.replaceChild( new_element, element ); }); return is_initialized; } var update_func = function( attrs ){ var is_initialized = false; var theme = attrs.theme; document.querySelectorAll( '.mermaid-container' ).forEach( function( e ){ var element = e.querySelector( '.mermaid' ); var code = e.querySelector( '.mermaid-code' ); var parse = parseGraph( decodeHTML( code.innerHTML ) ); if( parse.yaml.relearn_user_theme || parse.dir.relearn_user_theme ){ return; } if( parse.yaml.theme == theme || parse.dir.theme == theme ){ return; } is_initialized = true; parse.yaml.theme = theme; var graph = serializeGraph( parse ); element.removeAttribute('data-processed'); element.innerHTML = graph; code.innerHTML = graph; }); return is_initialized; }; var state = this; if( update && !state.is_initialized ){ return; } if( typeof variants == 'undefined' ){ return; } if( typeof mermaid == 'undefined' || typeof mermaid.mermaidAPI == 'undefined' ){ return; } if( !state.is_initialized ){ state.is_initialized = true; window.addEventListener( 'beforeprint', function(){ initMermaid( true, { 'theme': variants.getColorValue( 'PRINT-MERMAID-theme' ), }); }.bind( this ) ); window.addEventListener( 'afterprint', function(){ initMermaid( true ); }.bind( this ) ); } attrs = attrs || { 'theme': variants.getColorValue( 'MERMAID-theme' ), }; var search; if( update ){ search = sessionStorage.getItem( baseUriFull+'search-value' ); unmark(); } var is_initialized = ( update ? update_func( attrs ) : init_func( attrs ) ); if( is_initialized ){ mermaid.initialize( Object.assign( { "securityLevel": "antiscript", "startOnLoad": false }, window.relearn.mermaidConfig, { theme: attrs.theme } ) ); mermaid.run({ postRenderCallback: function(){ // zoom for Mermaid // https://github.com/mermaid-js/mermaid/issues/1860#issuecomment-1345440607 var svgs = d3.selectAll( '.mermaid.zoom svg' ); svgs.each( function(){ var svg = d3.select( this ); svg.html( '' + svg.html() + '' ); var inner = svg.select( 'g' ); var zoom = d3.zoom().on( 'zoom', function( e ){ inner.attr( 'transform', e.transform); }); svg.call( zoom ); }); }, querySelector: '.mermaid', suppressErrors: true }); } if( update && search && search.length ){ sessionStorage.setItem( baseUriFull+'search-value', search ); mark(); } } function initOpenapi( update, attrs ){ if( isIE ){ return; } var state = this; if( update && !state.is_initialized ){ return; } if( typeof variants == 'undefined' ){ return; } if( !state.is_initialized ){ state.is_initialized = true; window.addEventListener( 'beforeprint', function(){ initOpenapi( true, { isPrintPreview: true } ); }.bind( this ) ); window.addEventListener( 'afterprint', function(){ initOpenapi( true, { isPrintPreview: false } ); }.bind( this ) ); } attrs = attrs || { isPrintPreview: false }; function addFunctionToResizeEvent(){ } function getFirstAncestorByClass(){ } function renderOpenAPI(oc) { var buster = window.themeUseOpenapi.assetsBuster ? '?' + window.themeUseOpenapi.assetsBuster : ''; var print = isPrint || attrs.isPrintPreview ? "PRINT-" : ""; var theme = print ? `${baseUri}/css/theme-relearn-light.css` : document.querySelector( '#variant-style' ).attributes.href.value var swagger_theme = variants.getColorValue( print + 'OPENAPI-theme' ); var swagger_code_theme = variants.getColorValue( print + 'OPENAPI-CODE-theme' ); const openapiId = 'relearn-swagger-ui'; const openapiIframeId = openapiId + "-iframe"; const openapiIframe = document.getElementById(openapiIframeId); if (openapiIframe) { openapiIframe.remove(); } const openapiErrorId = openapiId + '-error'; const openapiError = document.getElementById(openapiErrorId); if (openapiError) { openapiError.remove(); } const oi = document.createElement('iframe'); oi.id = openapiIframeId; oi.classList.toggle('sc-openapi-iframe', true); oi.srcdoc = '' + '' + '' + '' + '' + '' + '' + '' + '' + 'Collapse all' + 'Expand all' + '
' + '' + '' + ''; oi.height = '100%'; oi.width = '100%'; oi.onload = function(){ const openapiWrapper = getFirstAncestorByClass(oc, 'sc-openapi-wrapper'); const openapiPromise = new Promise( function(resolve){ resolve() }); openapiPromise .then( function(){ SwaggerUIBundle({ defaultModelsExpandDepth: 2, defaultModelExpandDepth: 2, docExpansion: isPrint || attrs.isPrintPreview ? 'full' : 'list', domNode: oi.contentWindow.document.getElementById(openapiId), filter: !( isPrint || attrs.isPrintPreview ), layout: 'BaseLayout', onComplete: function(){ if( isPrint || attrs.isPrintPreview ){ oi.contentWindow.document.querySelectorAll( '.model-container > .model-box > button[aria-expanded=false]' ).forEach( function(btn){ btn.click() }); setOpenAPIHeight(oi); } }, plugins: [ SwaggerUIBundle.plugins.DownloadUrl ], presets: [ SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset, ], syntaxHighlight: { activated: true, theme: swagger_code_theme, }, url: oc.getAttribute('openapi-url'), validatorUrl: 'none', }); }) .then( function(){ let observerCallback = function () { setOpenAPIHeight(oi); }; let observer = new MutationObserver(observerCallback); observer.observe(oi.contentWindow.document.documentElement, { childList: true, subtree: true, }); }) .then( function(){ if (openapiWrapper) { openapiWrapper.classList.toggle('is-loading', false); } setOpenAPIHeight(oi); }) .catch( function(error){ const ed = document.createElement('div'); ed.classList.add('sc-alert', 'sc-alert-error'); ed.innerHTML = error; ed.id = openapiErrorId; while (oc.lastChild) { oc.removeChild(oc.lastChild); } if (openapiWrapper) { openapiWrapper.classList.toggle('is-loading', false); openapiWrapper.insertAdjacentElement('afterbegin', ed); } }); }; oc.appendChild(oi); } function setOpenAPIHeight(oi) { // add empirical offset if in print preview (GC 103) oi.style.height = (oi.contentWindow.document.documentElement.getBoundingClientRect().height + (attrs.isPrintPreview ? 200 : 0) )+ 'px'; } function resizeOpenAPI() { let divi = document.getElementsByClassName('sc-openapi-iframe'); for (let i = 0; i < divi.length; i++) { setOpenAPIHeight(divi[i]); } }; let divo = document.getElementsByClassName('sc-openapi-container'); for (let i = 0; i < divo.length; i++) { renderOpenAPI(divo[i]); } if (divo.length) { addFunctionToResizeEvent(resizeOpenAPI); } } function initAnchorClipboard(){ document.querySelectorAll( 'h1~h2,h1~h3,h1~h4,h1~h5,h1~h6').forEach( function( element ){ var url = encodeURI( (document.location.origin == "null" ? (document.location.protocol + "//" + document.location.host) : document.location.origin )+ document.location.pathname); var link = url + "#" + element.id; var new_element = document.createElement( 'span' ); new_element.classList.add( 'anchor' ); new_element.setAttribute( 'title', window.T_Copy_link_to_clipboard ); new_element.setAttribute( 'data-clipboard-text', link ); new_element.innerHTML = ''; element.appendChild( new_element ); }); var anchors = document.querySelectorAll( '.anchor' ); for( var i = 0; i < anchors.length; i++ ) { anchors[i].addEventListener( 'mouseleave', function( e ){ this.removeAttribute( 'aria-label' ); this.classList.remove( 'tooltipped', 'tooltipped-se', 'tooltipped-sw' ); }); } var clip = new ClipboardJS( '.anchor' ); clip.on( 'success', function( e ){ e.clearSelection(); e.trigger.setAttribute( 'aria-label', window.T_Link_copied_to_clipboard ); e.trigger.classList.add( 'tooltipped', 'tooltipped-s'+(isRtl?'e':'w') ); }); } function initCodeClipboard(){ function getCodeText( node ){ // if highlight shortcode is used in inline lineno mode, remove lineno nodes before generating text, otherwise it doesn't hurt var code = node.cloneNode( true ); Array.from( code.querySelectorAll( '*:scope > span > span:first-child:not(:last-child)' ) ).forEach( function( lineno ){ lineno.remove(); }); var text = code.textContent; // remove a trailing line break, this may most likely // come from the browser / Hugo transformation text = text.replace( /\n$/, '' ); return text; } function fallbackMessage( action ){ var actionMsg = ''; var actionKey = (action === 'cut' ? 'X' : 'C'); if (/iPhone|iPad/i.test(navigator.userAgent)) { actionMsg = 'No support :('; } else if (/Mac/i.test(navigator.userAgent)) { actionMsg = 'Press ⌘-' + actionKey + ' to ' + action; } else { actionMsg = 'Press Ctrl-' + actionKey + ' to ' + action; } return actionMsg; } var codeElements = document.querySelectorAll( 'code' ); for( var i = 0; i < codeElements.length; i++ ){ var code = codeElements[i]; var text = getCodeText( code ); var inPre = code.parentNode.tagName.toLowerCase() == 'pre'; var inTable = inPre && code.parentNode.parentNode.tagName.toLowerCase() == 'td'; // avoid copy-to-clipboard for highlight shortcode in table lineno mode var isFirstLineCell = inTable && code.parentNode.parentNode.parentNode.querySelector( 'td:first-child > pre > code' ) == code; if( !isFirstLineCell && ( inPre || text.length > 5 ) ){ var clip = new ClipboardJS( '.copy-to-clipboard-button', { text: function( trigger ){ if( !trigger.previousElementSibling ){ return ''; } return trigger.previousElementSibling.dataset.code || ''; } }); clip.on( 'success', function( e ){ e.clearSelection(); var doBeside = e.trigger.parentNode.tagName.toLowerCase() == 'pre' || (e.trigger.previousElementSibling && e.trigger.previousElementSibling.tagName.toLowerCase() == 'table' ); e.trigger.setAttribute( 'aria-label', window.T_Copied_to_clipboard ); e.trigger.classList.add( 'tooltipped', 'tooltipped-' + (doBeside ? 'w' : 's'+(isRtl?'e':'w')) ); }); clip.on( 'error', function( e ){ var doBeside = e.trigger.parentNode.tagName.toLowerCase() == 'pre' || (e.trigger.previousElementSibling && e.trigger.previousElementSibling.tagName.toLowerCase() == 'table' ); e.trigger.setAttribute( 'aria-label', fallbackMessage(e.action) ); e.trigger.classList.add( 'tooltipped', 'tooltipped-' + (doBeside ? 'w' : 's'+(isRtl?'e':'w')) ); var f = function(){ e.trigger.setAttribute( 'aria-label', window.T_Copied_to_clipboard ); e.trigger.classList.add( 'tooltipped', 'tooltipped-' + (doBeside ? 'w' : 's'+(isRtl?'e':'w')) ); document.removeEventListener( 'copy', f ); }; document.addEventListener( 'copy', f ); }); code.classList.add( 'copy-to-clipboard-code' ); if( inPre ){ code.classList.add( 'copy-to-clipboard' ); code.parentNode.classList.add( 'pre-code' ); } else{ var clone = code.cloneNode( true ); var span = document.createElement( 'span' ); span.classList.add( 'copy-to-clipboard' ); span.appendChild( clone ); code.parentNode.replaceChild( span, code ); code = clone; } var button = document.createElement( 'span' ); button.classList.add( 'copy-to-clipboard-button' ); button.setAttribute( 'title', window.T_Copy_to_clipboard ); button.innerHTML = ''; button.addEventListener( 'mouseleave', function() { this.removeAttribute( 'aria-label' ); this.classList.remove( 'tooltipped', 'tooltipped-w', 'tooltipped-se', 'tooltipped-sw' ); }); if( inTable ){ var table = code.parentNode.parentNode.parentNode.parentNode.parentNode; table.dataset[ 'code' ] = text; table.parentNode.insertBefore( button, table.nextSibling ); } else if( inPre ){ var pre = code.parentNode; pre.dataset[ 'code' ] = text; var p = pre.parentNode; // indented code blocks are missing the div while( p != document && ( p.tagName.toLowerCase() != 'div' || !p.classList.contains( 'highlight' ) ) ){ p = p.parentNode; } if( p == document ){ var clone = pre.cloneNode( true ); var div = document.createElement( 'div' ); div.classList.add( 'highlight' ); div.appendChild( clone ); pre.parentNode.replaceChild( div, pre ); pre = clone; } pre.parentNode.insertBefore( button, pre.nextSibling ); } else{ code.dataset[ 'code' ] = text; code.parentNode.insertBefore( button, code.nextSibling ); } } } } function initArrowNav(){ if( isPrint ){ return; } // button navigation var prev = document.querySelector( 'a.nav-prev' ); prev && prev.addEventListener( 'click', navPrev ); var next = document.querySelector( 'a.nav-next' ); next && next.addEventListener( 'click', navNext ); // keyboard navigation // avoid prev/next navigation if we are not at the start/end of the // horizontal area var el = document.querySelector('#body-inner'); var scrollStart = 0; var scrollEnd = 0; document.addEventListener('keydown', function(event){ if( !event.shiftKey && !event.ctrlKey && !event.altKey && !event.metaKey ){ if( event.which == dir_key_start ){ if( !scrollStart && +el.scrollLeft.toFixed()*dir_scroll <= 0 ){ prev && prev.click(); } else if( scrollStart != -1 ){ clearTimeout( scrollStart ); } scrollStart = -1; } if( event.which == dir_key_end ){ if( !scrollEnd && +el.scrollLeft.toFixed()*dir_scroll + +el.clientWidth.toFixed() >= +el.scrollWidth.toFixed() ){ next && next.click(); } else if( scrollEnd != -1 ){ clearTimeout( scrollEnd ); } scrollEnd = -1; } } }); document.addEventListener('keyup', function(event){ if( !event.shiftKey && !event.ctrlKey && !event.altKey && !event.metaKey ){ if( event.which == dir_key_start ){ // check for false indication if keyup is delayed after navigation if( scrollStart == -1 ){ scrollStart = setTimeout( function(){ scrollStart = 0; }, 300 ); } } if( event.which == dir_key_end ){ if( scrollEnd == -1 ){ scrollEnd = setTimeout( function(){ scrollEnd = 0; }, 300 ); } } } }); // avoid keyboard navigation for input fields document.querySelectorAll( formelements ).forEach( function( e ){ e.addEventListener( 'keydown', function( event ){ if( event.which == dir_key_start || event.which == dir_key_end ){ event.stopPropagation(); } }); }); } function initMenuScrollbar(){ if( isPrint ){ return; } var elm = document.querySelector('#content-wrapper'); var elt = document.querySelector('#TableOfContents'); var autofocus = true; document.addEventListener('keydown', function(event){ // for initial keyboard scrolling support, no element // may be hovered, but we still want to react on // cursor/page up/down. because we can't hack // the scrollbars implementation, we try to trick // it and give focus to the scrollbar - only // to just remove the focus right after scrolling // happend autofocus = false; if( event.shiftKey || event.altKey || event.ctrlKey || event.metaKey || event.which < 32 || event.which > 40 ){ // if tab key was pressed, we are ended with our initial // focus job return; } var c = elc && elc.matches(':hover'); var m = elm && elm.matches(':hover'); var t = elt && elt.matches(':hover'); var f = event.target.matches( formelements ); if( !c && !m && !t && !f ){ // only do this hack if none of our scrollbars // is hovered // if we are showing the sidebar as a flyout we // want to scroll the content-wrapper, otherwise we want // to scroll the body var nt = document.querySelector('body').matches('.toc-flyout'); var nm = document.querySelector('body').matches('.sidebar-flyout'); if( nt ){ pst && pst.scrollbarY.focus(); } else if( nm ){ psm && psm.scrollbarY.focus(); } else{ document.querySelector('#body-inner').focus(); psc && psc.scrollbarY.focus(); } } }); // scrollbars will install their own keyboard handlers // that need to be executed inbetween our own handlers // PSC removed for #242 #243 #244 // psc = elc && new PerfectScrollbar('#body-inner'); psm = elm && new PerfectScrollbar('#content-wrapper'); pst = elt && new PerfectScrollbar('#TableOfContents'); document.addEventListener('keydown', function(){ // if we facked initial scrolling, we want to // remove the focus to not leave visual markers on // the scrollbar if( autofocus ){ psc && psc.scrollbarY.blur(); psm && psm.scrollbarY.blur(); pst && pst.scrollbarY.blur(); autofocus = false; } }); // on resize, we have to redraw the scrollbars to let new height // affect their size window.addEventListener('resize', function(){ pst && setTimeout( function(){ pst.update(); }, 10 ); psm && setTimeout( function(){ psm.update(); }, 10 ); psc && setTimeout( function(){ psc.update(); }, 10 ); }); // now that we may have collapsible menus, we need to call a resize // for the menu scrollbar if sections are expanded/collapsed document.querySelectorAll('#sidebar .collapsible-menu input').forEach( function(e){ e.addEventListener('change', function(){ psm && setTimeout( function(){ psm.update(); }, 10 ); }); }); // bugfix for PS in RTL mode: the initial scrollbar position is off; // calling update() once, fixes this pst && setTimeout( function(){ pst.update(); }, 10 ); psm && setTimeout( function(){ psm.update(); }, 10 ); psc && setTimeout( function(){ psc.update(); }, 10 ); // finally, we want to adjust the contents end padding if there is a scrollbar visible window.addEventListener('resize', adjustContentWidth ); adjustContentWidth(); } function imageEscapeHandler( event ){ if( event.key == "Escape" ){ var image = event.target; image.click(); } } function sidebarEscapeHandler( event ){ if( event.key == "Escape" ){ var b = document.querySelector( 'body' ); b.classList.remove( 'sidebar-flyout' ); document.removeEventListener( 'keydown', sidebarEscapeHandler ); documentFocus(); } } function tocEscapeHandler( event ){ if( event.key == "Escape" ){ var b = document.querySelector( 'body' ); b.classList.remove( 'toc-flyout' ); document.removeEventListener( 'keydown', tocEscapeHandler ); documentFocus(); } } function sidebarShortcutHandler( event ){ if( !event.shiftKey && event.altKey && event.ctrlKey && !event.metaKey && event.which == 78 /* n */ ){ showNav(); } } function searchShortcutHandler( event ){ if( !event.shiftKey && event.altKey && event.ctrlKey && !event.metaKey && event.which == 70 /* f */ ){ showSearch(); } } function tocShortcutHandler( event ){ if( !event.shiftKey && event.altKey && event.ctrlKey && !event.metaKey && event.which == 84 /* t */ ){ showToc(); } } function editShortcutHandler( event ){ if( !event.shiftKey && event.altKey && event.ctrlKey && !event.metaKey && event.which == 87 /* w */ ){ showEdit(); } } function printShortcutHandler( event ){ if( !event.shiftKey && event.altKey && event.ctrlKey && !event.metaKey && event.which == 80 /* p */ ){ showPrint(); } } function showSearch(){ var s = document.querySelector( '#search-by' ); if( !s ){ return; } var b = document.querySelector( 'body' ); if( s == document.activeElement ){ if( b.classList.contains( 'sidebar-flyout' ) ){ showNav(); } documentFocus(); } else { if( !b.classList.contains( 'sidebar-flyout' ) ){ showNav(); } s.focus(); } } function showNav(){ if( !document.querySelector( '#sidebar-overlay' ) ){ // we may not have a flyout return; } var b = document.querySelector( 'body' ); b.classList.toggle( 'sidebar-flyout' ); if( b.classList.contains( 'sidebar-flyout' ) ){ b.classList.remove( 'toc-flyout' ); document.removeEventListener( 'keydown', tocEscapeHandler ); document.addEventListener( 'keydown', sidebarEscapeHandler ); } else{ document.removeEventListener( 'keydown', sidebarEscapeHandler ); documentFocus(); } } function showToc(){ var t = document.querySelector( '#toc-menu' ); if( !t ){ // we may not have a toc return; } var b = document.querySelector( 'body' ); b.classList.toggle( 'toc-flyout' ); if( b.classList.contains( 'toc-flyout' ) ){ pst && setTimeout( function(){ pst.update(); }, 10 ); pst && pst.scrollbarY.focus(); document.querySelector( '.toc-wrapper ul a' ).focus(); document.addEventListener( 'keydown', tocEscapeHandler ); } else{ document.removeEventListener( 'keydown', tocEscapeHandler ); documentFocus(); } } function showEdit(){ var l = document.querySelector( '#top-github-link a' ); if( l ){ l.click(); } } function showPrint(){ var l = document.querySelector( '#top-print-link a' ); if( l ){ l.click(); } } function navPrev(){ var e = document.querySelector( 'a.nav-prev' ); location.href = e && e.getAttribute( 'href' ); }; function navNext(){ var e = document.querySelector( 'a.nav-next' ); location.href = e && e.getAttribute( 'href' ); }; function initToc(){ if( isPrint ){ return; } document.addEventListener( 'keydown', editShortcutHandler ); document.addEventListener( 'keydown', printShortcutHandler ); document.addEventListener( 'keydown', sidebarShortcutHandler ); document.addEventListener( 'keydown', searchShortcutHandler ); document.addEventListener( 'keydown', tocShortcutHandler ); document.querySelector( '#sidebar-overlay' ).addEventListener( 'click', showNav ); document.querySelector( '#sidebar-toggle' ).addEventListener( 'click', showNav ); document.querySelector( '#toc-overlay' ).addEventListener( 'click', showToc ); var t = document.querySelector( '#toc-menu' ); var p = document.querySelector( '.progress' ); if( t && p ){ // we may not have a toc t.addEventListener( 'click', showToc ); p.addEventListener( 'click', showToc ); } // finally give initial focus to allow keyboard scrolling in FF documentFocus(); } function initSwipeHandler(){ if( !touchsupport ){ return; } var startx = null; var starty = null; var handleStartX = function(evt) { startx = evt.touches[0].clientX; starty = evt.touches[0].clientY; return false; }; var handleMoveX = function(evt) { if( startx !== null ){ var diffx = startx - evt.touches[0].clientX; var diffy = starty - evt.touches[0].clientY || .1 ; if( diffx / Math.abs( diffy ) < 2 ){ // detect mostly vertical swipes and reset our starting pos // to not detect a horizontal move if vertical swipe is unprecise startx = evt.touches[0].clientX; } else if( diffx > 30 ){ startx = null; starty = null; var b = document.querySelector( 'body' ); b.classList.remove( 'sidebar-flyout' ); document.removeEventListener( 'keydown', sidebarEscapeHandler ); documentFocus(); } } return false; }; var handleEndX = function(evt) { startx = null; starty = null; return false; }; document.querySelector( '#sidebar-overlay' ).addEventListener("touchstart", handleStartX, false); document.querySelector( '#sidebar' ).addEventListener("touchstart", handleStartX, false); document.querySelectorAll( '#sidebar *' ).forEach( function(e){ e.addEventListener("touchstart", handleStartX); }, false); document.querySelector( '#sidebar-overlay' ).addEventListener("touchmove", handleMoveX, false); document.querySelector( '#sidebar' ).addEventListener("touchmove", handleMoveX, false); document.querySelectorAll( '#sidebar *' ).forEach( function(e){ e.addEventListener("touchmove", handleMoveX); }, false); document.querySelector( '#sidebar-overlay' ).addEventListener("touchend", handleEndX, false); document.querySelector( '#sidebar' ).addEventListener("touchend", handleEndX, false); document.querySelectorAll( '#sidebar *' ).forEach( function(e){ e.addEventListener("touchend", handleEndX); }, false); } function initImage(){ document.querySelectorAll( '.lightbox' ).forEach( function(e){ e.addEventListener("keydown", imageEscapeHandler); }, false); } function clearHistory() { var visitedItem = baseUriFull + 'visited-url/' for( var item in sessionStorage ){ if( item.substring( 0, visitedItem.length ) === visitedItem ){ sessionStorage.removeItem( item ); var url = item.substring( visitedItem.length ); // in case we have `relativeURLs=true` we have to strip the // relative path to root url = url.replace( /\.\.\//g, '/' ).replace( /^\/+\//, '/' ); document.querySelectorAll( '[data-nav-id="'+url+'"]' ).forEach( function( e ){ e.classList.remove( 'visited' ); }); } } } function initHistory() { var visitedItem = baseUriFull + 'visited-url/' sessionStorage.setItem( visitedItem+document.querySelector( 'body' ).dataset.url, 1); // loop through the sessionStorage and see if something should be marked as visited for( var item in sessionStorage ){ if( item.substring( 0, visitedItem.length ) === visitedItem && sessionStorage.getItem( item ) == 1 ){ var url = item.substring( visitedItem.length ); // in case we have `relativeURLs=true` we have to strip the // relative path to root url = url.replace( /\.\.\//g, '/' ).replace( /^\/+\//, '/' ); document.querySelectorAll( '[data-nav-id="'+url+'"]' ).forEach( function( e ){ e.classList.add( 'visited' ); }); } } } function initScrollPositionSaver(){ function savePosition( event ){ var state = window.history.state || {}; state = Object.assign( {}, ( typeof state === 'object' ) ? state : {} ); state.contentScrollTop = +elc.scrollTop; window.history.replaceState( state, '', window.location ); }; window.addEventListener( 'pagehide', savePosition ); } function scrollToPositions() { // show active menu entry window.setTimeout( function(){ var e = document.querySelector( '#sidebar li.active a' ); if( e && e.scrollIntoView ){ e.scrollIntoView({ block: 'center', }); } }, 10 ); // scroll the content to point of interest; // if we have a scroll position saved, the user was here // before in his history stack and we want to reposition // to the position he was when he left the page; // otherwise if he used page search before, we want to position // to its last outcome; // otherwise he may want to see a specific fragment var state = window.history.state || {}; state = ( typeof state === 'object') ? state : {}; if( state.hasOwnProperty( 'contentScrollTop' ) ){ window.setTimeout( function(){ elc.scrollTop = +state.contentScrollTop; }, 10 ); return; } var search = sessionStorage.getItem( baseUriFull+'search-value' ); if( search && search.length ){ var found = elementContains( search, elc ); var searchedElem = found.length && found[ 0 ]; if( searchedElem ){ searchedElem.scrollIntoView( true ); var scrolledY = window.scrollY; if( scrolledY ){ window.scroll( 0, scrolledY - 125 ); } } return; } if( window.location.hash && window.location.hash.length > 1 ){ window.setTimeout( function(){ try{ var e = document.querySelector( window.location.hash ); if( e && e.scrollIntoView ){ e.scrollIntoView({ block: 'start', }); } } catch( e ){} }, 10 ); return; } } function mark() { // mark some additional stuff as searchable var topbarLinks = document.querySelectorAll( '#topbar a:not(.topbar-link):not(.btn)' ); for( var i = 0; i < topbarLinks.length; i++ ){ topbarLinks[i].classList.add( 'highlight' ); } var bodyInnerLinks = document.querySelectorAll( '#body-inner a:not(.lightbox-link):not(.btn):not(.lightbox)' ); for( var i = 0; i < bodyInnerLinks.length; i++ ){ bodyInnerLinks[i].classList.add( 'highlight' ); } var value = sessionStorage.getItem( baseUriFull + 'search-value' ); var highlightableElements = document.querySelectorAll( '.highlightable' ); highlight( highlightableElements, value, { element: 'mark' } ); var markedElements = document.querySelectorAll( 'mark' ); for( var i = 0; i < markedElements.length; i++ ){ var parent = markedElements[i].parentNode; while( parent && parent.classList ){ if( parent.classList.contains( 'expand' ) ){ var expandInputs = parent.querySelectorAll( 'input:not(.expand-marked)' ); if( expandInputs.length ){ expandInputs[0].classList.add( 'expand-marked' ); expandInputs[0].dataset.checked = expandInputs[0].checked ? 'true' : 'false'; expandInputs[0].checked = true; } } if( parent.tagName.toLowerCase() === 'li' && parent.parentNode && parent.parentNode.tagName.toLowerCase() === 'ul' && parent.parentNode.classList.contains( 'collapsible-menu' )){ var toggleInputs = parent.querySelectorAll( 'input:not(.menu-marked)' ); if( toggleInputs.length ){ toggleInputs[0].classList.add( 'menu-marked' ); toggleInputs[0].dataset.checked = toggleInputs[0].checked ? 'true' : 'false'; toggleInputs[0].checked = true; } } parent = parent.parentNode; } } psm && setTimeout( function(){ psm.update(); }, 10 ); } window.relearn.markSearch = mark; function highlight( es, words, options ){ var settings = { className: 'highlight', element: 'span', caseSensitive: false, wordsOnly: false }; Object.assign( settings, options ); if( !words ){ return; } if( words.constructor === String ){ words = [ words ]; } words = words.filter( function( word, i ){ return word != ''; }); words = words.map( function( word, i ){ return word.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&"); }); if( words.length == 0 ){ return this; } var flag = settings.caseSensitive ? '' : 'i'; var pattern = "(" + words.join( '|' ) + ')'; if( settings.wordsOnly ){ pattern = '\\b' + pattern + '\\b'; } var re = new RegExp( pattern, flag ); for( var i = 0; i < es.length; i++ ){ highlightNode( es[i], re, settings.element, settings.className ); } }; function highlightNode( node, re, nodeName, className ){ if( node.nodeType === 3 && node.parentElement && node.parentElement.namespaceURI == 'http://www.w3.org/1999/xhtml' ) { // text nodes var match = node.data.match( re ); if( match ){ var highlight = document.createElement( nodeName || 'span' ); highlight.className = className || 'highlight'; var wordNode = node.splitText( match.index ); wordNode.splitText( match[0].length ); var wordClone = wordNode.cloneNode( true ); highlight.appendChild( wordClone ); wordNode.parentNode.replaceChild( highlight, wordNode ); return 1; //skip added node in parent } } else if( (node.nodeType === 1 && node.childNodes) && // only element nodes that have children !/(script|style)/i.test(node.tagName) && // ignore script and style nodes !(node.tagName === nodeName.toUpperCase() && node.className === className) ){ // skip if already highlighted for( var i = 0; i < node.childNodes.length; i++ ){ i += highlightNode( node.childNodes[i], re, nodeName, className ); } } return 0; }; function unmark() { sessionStorage.removeItem( baseUriFull + 'search-value' ); var markedElements = document.querySelectorAll( 'mark' ); for( var i = 0; i < markedElements.length; i++ ){ var parent = markedElements[i].parentNode; while( parent && parent.classList ){ if( parent.tagName.toLowerCase() === 'li' && parent.parentNode && parent.parentNode.tagName.toLowerCase() === 'ul' && parent.parentNode.classList.contains( 'collapsible-menu' )){ var toggleInputs = parent.querySelectorAll( 'input.menu-marked' ); if( toggleInputs.length ){ toggleInputs[0].checked = toggleInputs[0].dataset.checked === 'true'; toggleInputs[0].dataset.checked = null; toggleInputs[0].classList.remove( 'menu-marked' ); } } if( parent.classList.contains( 'expand' ) ){ var expandInputs = parent.querySelectorAll( 'input.expand-marked' ); if( expandInputs.length ){ expandInputs[0].checked = expandInputs[0].dataset.checked === 'true'; expandInputs[0].dataset.checked = null; expandInputs[0].classList.remove( 'expand-marked' ); } } parent = parent.parentNode; } } var highlighted = document.querySelectorAll( '.highlightable' ); unhighlight( highlighted, { element: 'mark' } ); psm && setTimeout( function(){ psm.update(); }, 10 ); } function unhighlight( es, options ){ var settings = { className: 'highlight', element: 'span' }; Object.assign( settings, options ); for( var i = 0; i < es.length; i++ ){ var highlightedElements = es[i].querySelectorAll( settings.element + '.' + settings.className ); for( var j = 0; j < highlightedElements.length; j++ ){ var parent = highlightedElements[j].parentNode; parent.replaceChild( highlightedElements[j].firstChild, highlightedElements[j] ); parent.normalize(); } } }; // replace jQuery.createPseudo with https://stackoverflow.com/a/66318392 function elementContains( txt, e ){ var regex = RegExp( txt, 'i' ); var nodes = []; if( e ){ var tree = document.createTreeWalker( e, 4 /* NodeFilter.SHOW_TEXT */, function( node ){ return regex.test( node.data ); }, false ); var node = null; while( node = tree.nextNode() ){ nodes.push( node.parentElement ); } } return nodes; } function searchInputHandler( value ){ unmark(); if( value.length ){ sessionStorage.setItem( baseUriFull+'search-value', value ); mark(); } } function initSearch() { // sync input/escape between searchbox and searchdetail var inputs = document.querySelectorAll( 'input.search-by' ); inputs.forEach( function( e ){ e.addEventListener( 'keydown', function( event ){ if( event.key == 'Escape' ){ var input = event.target; var search = sessionStorage.getItem( baseUriFull+'search-value' ); if( !search || !search.length ){ input.blur(); } searchInputHandler( '' ); inputs.forEach( function( e ){ e.value = ''; }); if( !search || !search.length ){ documentFocus(); } } }); e.addEventListener( 'input', function( event ){ var input = event.target; var value = input.value; searchInputHandler( value ); inputs.forEach( function( e ){ if( e != input ){ e.value = value; } }); }); }); document.querySelectorAll( '[data-search-clear]' ).forEach( function( e ){ e.addEventListener( 'click', function(){ inputs.forEach( function( e ){ e.value = ''; var event = document.createEvent( 'Event' ); event.initEvent( 'input', false, false ); e.dispatchEvent( event ); }); unmark(); }); }); var urlParams = new URLSearchParams( window.location.search ); var value = urlParams.get( 'search-by' ); if( value ){ sessionStorage.setItem( baseUriFull+'search-value', value ); } mark(); // set initial search value for inputs on page load if( sessionStorage.getItem( baseUriFull+'search-value' ) ){ var search = sessionStorage.getItem( baseUriFull+'search-value' ); inputs.forEach( function( e ){ e.value = search; var event = document.createEvent( 'Event' ); event.initEvent( 'input', false, false ); e.dispatchEvent( event ); }); } window.relearn.isSearchInit = true; window.relearn.runInitialSearch && window.relearn.runInitialSearch(); } function updateTheme( detail ){ if( window.relearn.lastVariant == detail.variant ){ return; } window.relearn.lastVariant = detail.variant; initMermaid( true ); initOpenapi( true ); document.dispatchEvent( new CustomEvent( 'themeVariantLoaded', { detail: detail })); } ready( function(){ initArrowNav(); initMermaid(); initOpenapi(); initMenuScrollbar(); initToc(); initAnchorClipboard(); initCodeClipboard(); fixCodeTabs(); restoreTabSelections(); initSwipeHandler(); initHistory(); initSearch(); initImage(); initScrollPositionSaver(); scrollToPositions(); }); function useMermaid( config ){ if( !Object.assign ){ // We don't support Mermaid for IE11 anyways, so bail out early return; } window.relearn.mermaidConfig = config; if (typeof mermaid != 'undefined' && typeof mermaid.mermaidAPI != 'undefined') { mermaid.initialize( Object.assign( { "securityLevel": "antiscript", "startOnLoad": false }, config ) ); if( config.theme && variants ){ var write_style = variants.findLoadedStylesheet( 'variant-style' ); write_style.setProperty( '--CONFIG-MERMAID-theme', config.theme ); } } } if( window.themeUseMermaid ){ useMermaid( window.themeUseMermaid ); } function useOpenapi( config ){ if( config.css && config.css.startsWith( '/' ) ){ config.css = baseUri + config.css; } } if( window.themeUseOpenapi ){ useOpenapi( window.themeUseOpenapi ); }