File: parse_slide.js

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (163 lines) | stat: -rw-r--r-- 3,685 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/**
* @license Apache-2.0
*
* Copyright (c) 2019 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var reEOL = require( '@stdlib/regexp/eol' );
var trim = require( '@stdlib/string/trim' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var max = require( '@stdlib/math/base/special/max' );
var style = require( './style_line.js' );
var emoji = require( './emoji.js' );


// VARIABLES //

var FRAGMENT_SEP = '--';
var NOTES_SEP = '~~~';
var RE_CODE_DELIMITER = /^(\s*)```\s*([a-z]+)?$/;
var CODE_INDENTATION = '    ';

// Hash for normalizing code block languages:
var LANGS = {
	'js': 'javascript',
	'javascript': 'javascript'
};


// MAIN //

/**
* Parses raw slide text.
*
* @private
* @param {string} text - raw slide text
* @returns {Object} slide object
*/
function parseSlide( text ) {
	var CODE_BLOCK_INDENTATION;
	var CODE_BLOCK;
	var lines;
	var frags;
	var line;
	var lang;
	var out;
	var f;
	var m;
	var j;
	var k;

	out = {
		'raw': text,
		'fragments': [],
		'code': [],
		'notes': '',
		'length': 0,   // number of lines
		'maxLength': 0 // maximum line length
	};

	// Extract speaker notes (if any)...
	text = text.split( NOTES_SEP );
	if ( text.length > 1 ) {
		out.notes += trim( text.slice( 1 ).join( NOTES_SEP ) );
	}
	text = text[ 0 ];

	// Process slide fragments...
	frags = text.split( FRAGMENT_SEP );
	for ( j = 0; j < frags.length; j++ ) {
		lines = trim( frags[ j ] ).split( reEOL.REGEXP );
		if ( j === 0 ) {
			f = [];
		} else {
			f = out.fragments[ j-1 ].slice();
		}
		CODE_BLOCK = false;
		for ( k = 0; k < lines.length; k++) {
			line = lines[ k ];

			// Handle code blocks...
			m = line.match( RE_CODE_DELIMITER );
			if ( m ) {
				if ( CODE_BLOCK === false ) {
					// Starting code delimiter:
					CODE_BLOCK = true;
					CODE_BLOCK_INDENTATION = m[ 1 ];

					// Determine the code block language...
					if ( m[ 2 ] ) {
						if ( hasOwnProp( LANGS, m[ 2 ] ) ) { // eslint-disable-line max-depth
							lang = LANGS[ m[ 2 ] ];
						} else {
							lang = 'unknown';
						}
					} else {
						// By default, we assume JavaScript is the code block language:
						lang = 'javascript';
					}
					out.code.push({
						'lang': lang,
						'src': []
					});
				} else {
					// Ending code delimiter:
					CODE_BLOCK = false;
				}
				continue;
			}
			if ( CODE_BLOCK ) {
				line = line.slice( CODE_BLOCK_INDENTATION.length );
				out.code[ out.code.length-1 ].src.push( line );
				line = CODE_INDENTATION + line;

				// TODO: apply syntax highlighting
			}
			// Create a line object for tracking a line's effective length:
			line = {
				'text': line,
				'length': line.length
			};

			// Apply styling:
			line = style( line );

			// Apply emojis:
			line = emoji( line );

			// Append the line to the fragment:
			f.push( line );
		}
		// A fragment includes the slide text of all prior fragments:
		out.fragments.push( f );
	}
	out.length = f.length;

	// Determine the maximum slide text line length...
	for ( j = 0; j < f.length; j++ ) {
		out.maxLength = max( out.maxLength, f[ j ].length );
	}

	return out;
}


// EXPORTS //

module.exports = parseSlide;