Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /**
* @license Apache-2.0
*
* Copyright (c) 2022 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.
*/
/* eslint-disable no-underscore-dangle */
'use strict';
// MODULES //
var logger = require( 'debug' );
var maximum = require( './max.js' );
var state2enum = require( './state2enum.js' );
// VARIABLES //
var debug = logger( 'state:escape' );
// Possible transition states...
var ERROR = state2enum[ 'error' ];
var FIELD = state2enum[ 'field' ];
// MAIN //
/**
* Returns a function for processing an escape sequence.
*
* ## Notes
*
* - An escape sequence escapes the delimiter, newline, and escape sequences in **non-quoted** fields.
* - An escape sequence escapes comment and skip sequences in **non-quoted** fields when an escape sequence occurs at the beginning of a record.
* - In strict mode, if not immediately followed by a special character sequence, then the parser raises an exception.
* - In non-strict mode, if not immediately followed by a special character sequence, then the escape sequence has no special meaning and is considered a normal character sequence.
*
* @private
* @param {Parser} parser - parser instance
* @returns {Function} processing function
*/
function processor( parser ) {
var delimiterLastIndex;
var newlineLastIndex;
var commentLastIndex;
var escapeLastIndex;
var skipLastIndex;
var escapeLength;
var delimiter;
var newline;
var comment;
var escape;
var strict;
var skip;
var max;
delimiterLastIndex = parser._delimiterLastIndex;
delimiter = parser._delimiter;
newlineLastIndex = parser._newlineLastIndex;
newline = parser._newline;
commentLastIndex = parser._commentLastIndex;
comment = parser._comment;
skipLastIndex = parser._skipLastIndex;
skip = parser._skip;
escapeLastIndex = parser._escapeLastIndex;
escapeLength = parser._escapeLength;
escape = parser._escape;
strict = parser._strict;
max = maximum( maximum( delimiterLastIndex, newlineLastIndex ), escapeLastIndex ); // eslint-disable-line max-len
return next;
/**
* Processes a character.
*
* @private
* @param {string} ch - character
* @returns {void}
*/
function next( ch ) {
var cursor = parser._cursor;
var idx = parser._eidx; // position of last escape character
var d = cursor - idx;
debug( 'Char: %s', ch );
/*
* Check for a field delimiter.
*/
if (
d === delimiterLastIndex &&
ch === delimiter[ delimiterLastIndex ] &&
parser._scan( delimiter, delimiterLastIndex )
) {
debug( 'Delimiter.' );
parser._copyWithin( idx-escapeLastIndex, idx+1, delimiterLastIndex )
._rewind( escapeLength )
._push( ch )
._changeState( FIELD );
return;
}
/*
* Check for a row separator.
*/
if (
d === newlineLastIndex &&
ch === newline[ newlineLastIndex ] &&
parser._scan( newline, newlineLastIndex )
) {
debug( 'Newline.' );
parser._copyWithin( idx-escapeLastIndex, idx+1, newlineLastIndex )
._rewind( escapeLength )
._push( ch )
._changeState( FIELD );
return;
}
/*
* Check for an escape sequence.
*/
if (
d === escapeLastIndex &&
ch === escape[ escapeLastIndex ] &&
parser._scan( escape, escapeLastIndex )
) {
debug( 'Escape.' );
parser._copyWithin( idx-escapeLastIndex, idx+1, escapeLastIndex )
._rewind( escapeLength )
._push( ch )
._changeState( FIELD );
return;
}
/*
* Check for a comment sequence.
*
* ## Notes
*
* - Comment sequences only have special meaning when appearing at the beginning of a row.
*/
if (
comment && // user specified a comment character sequence, so should check for comments
cursor-commentLastIndex === 0 && // only search the first character(s) of the row
ch === comment[ commentLastIndex ] && // we have a potential match
parser._scan( comment, commentLastIndex ) // we found a match
) {
debug( 'Comment.' );
parser._copyWithin( idx-commentLastIndex, idx+1, commentLastIndex )
._rewind( escapeLength )
._push( ch )
._changeState( FIELD );
return;
}
/*
* Check for a skip sequence.
*
* ## Notes
*
* - Skip sequences only have special meaning when appearing at the beginning of a row.
*/
if (
skip && // user specified a skip character sequence, so should check for a skipped line
cursor-skipLastIndex === 0 && // only search the first character(s) of the row
ch === skip[ skipLastIndex ] && // we have a potential match
parser._scan( skip, skipLastIndex ) // we found a match
) {
debug( 'Skip.' );
parser._copyWithin( idx-skipLastIndex, idx+1, skipLastIndex )
._rewind( escapeLength )
._push( ch )
._changeState( FIELD );
return;
}
/*
* Check for a non-special character sequence.
*
* ## Notes
*
* - In strict mode, field separators, row separators, and escaped sequences must immediately follow an escape sequence. At some point, we'll have processed a greater number of characters than exists in any of the special character sequences, meaning that none of those sequences immediately follow the escape sequence which led to the current state. Once this happens, we're in an invalid state and must raise an exception, as not clear how the parser should interpret the preceding values (e.g., was the preceding escape sequence supposed to be escaped? was the preceding escape sequence a mistake and should be ignored? are we missing a delimiter or newline sequence? etc.).
* - In non-strict mode, we assume that the escape sequence is a normal character sequence.
*/
if ( d >= max ) {
if ( strict ) {
debug( 'Error.' );
parser._setErrorState( 'INVALID_ESCAPE' )._changeState( ERROR );
return;
}
// Return to normal field processing:
debug( 'Escape sequence is not followed by a special character sequence.' );
parser._raiseWarning( 'INVALID_ESCAPE' )._push( ch )._changeState( FIELD );
return;
}
// Continue processing until we can transition to a new state:
parser._push( ch );
}
}
// EXPORTS //
module.exports = processor;
|