diff options
Diffstat (limited to 'plugin/highlight/highlight.js')
| -rw-r--r-- | plugin/highlight/highlight.js | 155 |
1 files changed, 140 insertions, 15 deletions
diff --git a/plugin/highlight/highlight.js b/plugin/highlight/highlight.js index 83305e1..b271261 100644 --- a/plugin/highlight/highlight.js +++ b/plugin/highlight/highlight.js @@ -68,6 +68,11 @@ c:[{cN:"comment",b:/\(\*/,e:/\*\)/},e.ASM,e.QSM,e.CNM,{b:/\{/,e:/\}/,i:/:/}]}}); } var RevealHighlight = { + + HIGHLIGHT_STEP_DELIMITER: '|', + HIGHLIGHT_LINE_DELIMITER: ',', + HIGHLIGHT_LINE_RANGE_DELIMITER: '-', + init: function() { // Read the plugin config options and provide fallbacks @@ -103,6 +108,10 @@ c:[{cN:"comment",b:/\(\*/,e:/\*\)/},e.ASM,e.QSM,e.CNM,{b:/\{/,e:/\}/,i:/:/}]}}); * Highlights a code block. If the <code> node has the * 'data-line-numbers' attribute we also generate slide * numbers. + * + * If a code block contains multiple line highlight steps + * we duplicate the code block once per lines that should + * be highlighted. */ highlightBlock: function( block ) { @@ -113,7 +122,45 @@ c:[{cN:"comment",b:/\(\*/,e:/\*\)/},e.ASM,e.QSM,e.CNM,{b:/\{/,e:/\}/,i:/:/}]}}); // hljs.lineNumbersBlock runs async code on the next cycle, // so we need to do the same to execute after it's done - setTimeout( RevealHighlight.highlightLines.bind( this, block ), 0 ); + setTimeout( function() { + + var highlightSteps = RevealHighlight.deserializeHighlightSteps( block.getAttribute( 'data-line-numbers' ) ); + + // If there are at least two highlight steps, generate + // fragment clones for each + if( highlightSteps.length > 1 ) { + + // If the original code block has a fragment-index, + // each clone should increment from that index + var fragmentIndex = parseInt( block.getAttribute( 'data-fragment-index' ), 10 ); + if( typeof fragmentIndex !== 'number' || isNaN( fragmentIndex ) ) { + fragmentIndex = null; + } + + // Generate fragments for all except the first step/original block + highlightSteps.slice(1).forEach( function( highlight ) { + + var fragmentBlock = block.cloneNode( true ); + fragmentBlock.setAttribute( 'data-line-numbers', RevealHighlight.serializeHighlightSteps( [ highlight ] ) ); + fragmentBlock.classList.add( 'fragment' ); + block.parentNode.appendChild( fragmentBlock ); + RevealHighlight.highlightLines( fragmentBlock ); + + if( fragmentIndex ) { + fragmentBlock.setAttribute( 'data-fragment-index', fragmentIndex ); + fragmentIndex += 1; + } + + } ); + + block.setAttribute( 'data-line-numbers', RevealHighlight.serializeHighlightSteps( [ highlightSteps[0] ] ) ); + + } + + RevealHighlight.highlightLines( block ); + + }.bind( this ), 0 ); + } }, @@ -131,34 +178,112 @@ c:[{cN:"comment",b:/\(\*/,e:/\*\)/},e.ASM,e.QSM,e.CNM,{b:/\{/,e:/\}/,i:/:/}]}}); */ highlightLines: function( block, linesToHighlight ) { - linesToHighlight = linesToHighlight || block.getAttribute( 'data-line-numbers' ); + var highlightSteps = RevealHighlight.deserializeHighlightSteps( linesToHighlight || block.getAttribute( 'data-line-numbers' ) ); - if( typeof linesToHighlight === 'string' && linesToHighlight !== '' ) { + if( highlightSteps.length ) { - linesToHighlight.split( ',' ).forEach( function( lineNumbers ) { + highlightSteps[0].forEach( function( highlight ) { - // Avoid failures becase of whitespace - lineNumbers = lineNumbers.replace( /\s/g, '' ); + var elementsToHighlight = []; - // Ensure that we looking at a valid slide number (1 or 1-2) - if( /^[\d-]+$/.test( lineNumbers ) ) { + // Highlight a range + if( typeof highlight.end === 'number' ) { + elementsToHighlight = [].slice.call( block.querySelectorAll( 'table tr:nth-child(n+'+highlight.start+'):nth-child(-n+'+highlight.end+')' ) ); + } + // Highlight a single line + else if( typeof highlight.start === 'number' ) { + elementsToHighlight = [].slice.call( block.querySelectorAll( 'table tr:nth-child('+highlight.start+')' ) ); + } - lineNumbers = lineNumbers.split( '-' ); + elementsToHighlight.forEach( function( lineElement ) { + lineElement.classList.add( 'highlight-line' ); + } ); - var lineStart = lineNumbers[0]; - var lineEnd = lineNumbers[1] || lineStart; + } ); - [].slice.call( block.querySelectorAll( 'table tr:nth-child(n+'+lineStart+'):nth-child(-n+'+lineEnd+')' ) ).forEach( function( lineElement ) { - lineElement.classList.add( 'highlight-line' ); - } ); + } + + }, + + /** + * Parses and formats a user-defined string of line + * numbers to highlight. + * + * @example + * RevealHighlight.deserializeHighlightSteps( '1,2|3,5-10' ) + * // [ + * // [ { start: 1 }, { start: 2 } ], + * // [ { start: 3 }, { start: 5, end: 10 } ] + * // ] + */ + deserializeHighlightSteps: function( highlightSteps ) { + + // Remove whitespace + highlightSteps = highlightSteps.replace( /\s/g, '' ); + + // Divide up our line number groups + highlightSteps = highlightSteps.split( RevealHighlight.HIGHLIGHT_STEP_DELIMITER ); + + return highlightSteps.map( function( highlights ) { + + return highlights.split( RevealHighlight.HIGHLIGHT_LINE_DELIMITER ).map( function( highlight ) { + + // Parse valid line numbers + if( /^[\d-]+$/.test( highlight ) ) { + + highlight = highlight.split( RevealHighlight.HIGHLIGHT_LINE_RANGE_DELIMITER ); + + var lineStart = parseInt( highlight[0], 10 ), + lineEnd = parseInt( highlight[1], 10 ); + + if( isNaN( lineEnd ) ) { + return { + start: lineStart + }; + } + else { + return { + start: lineStart, + end: lineEnd + }; + } + + } + // If no line numbers are provided, no code will be highlighted + else { + + return {}; } } ); - } + } ); + + }, + + /** + * Serializes parsed line number data into a string so + * that we can store it in the DOM. + */ + serializeHighlightSteps: function( highlightSteps ) { + + return highlightSteps.map( function( highlights ) { + return highlights.map( function( highlight ) { + if( typeof highlight.end === 'number' ) { + return highlight.start + RevealHighlight.HIGHLIGHT_LINE_RANGE_DELIMITER + highlight.end; + } + else if( typeof highlight.start === 'number' ) { + return highlight.start; + } + else { + return ''; + } + } ).join( RevealHighlight.HIGHLIGHT_LINE_DELIMITER ); + } ).join( RevealHighlight.HIGHLIGHT_STEP_DELIMITER ); } + } Reveal.registerPlugin( 'highlight', RevealHighlight ); |