phoenix/src/language/HTMLSimpleDOM.js at main · phcode-dev/phoenix · GitHub

History

589 lines (538 loc) · 22.6 KB

Raw

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

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

* GNU AGPL-3.0 License

* This program is free software: you can redistribute it and/or modify it

* under the terms of the GNU Affero General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

* This program is distributed in the hope that it will be useful, but WITHOUT

* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License

* for more details.

* You should have received a copy of the GNU Affero General Public License

* along with this program. If not, see https://opensource.org/licenses/AGPL-3.0.

// @INCLUDE_IN_API_DOCS

/*unittests: HTML Instrumentation*/

define(function (require, exports, module) {

var Tokenizer = require("language/HTMLTokenizer").Tokenizer,

MurmurHash3 = require("thirdparty/murmurhash3_gc"),

PerfUtils = require("utils/PerfUtils");

var seed = Math.floor(Math.random() * 65535);

var tagID = 1;

/**

* A list of tags whose start causes any of a given set of immediate parent

* tags to close. This mostly comes from the HTML5 spec section on omitted close tags:

* http://www.w3.org/html/wg/drafts/html/master/syntax.html#optional-tags

* This doesn't handle general content model violations.

* @private

var openImpliesClose = {

li: { li: true },

dt: { dd: true, dt: true },

dd: { dd: true, dt: true },

address: { p: true },

article: { p: true },

aside: { p: true },

blockquote: { p: true },

colgroup: { caption: true },

details: { p: true },

dir: { p: true },

div: { p: true },

dl: { p: true },

fieldset: { p: true },

figcaption: { p: true },

figure: { p: true },

footer: { p: true },

form: { p: true },

h1: { p: true },

h2: { p: true },

h3: { p: true },

h4: { p: true },

h5: { p: true },

h6: { p: true },

header: { p: true },

hgroup: { p: true },

hr: { p: true },

main: { p: true },

menu: { p: true },

nav: { p: true },

ol: { p: true },

p: { p: true },

pre: { p: true },

section: { p: true },

table: { p: true },

ul: { p: true },

rb: { rb: true, rt: true, rtc: true, rp: true },

rp: { rb: true, rt: true, rp: true },

rt: { rb: true, rt: true, rp: true },

rtc: { rb: true, rt: true, rtc: true, rp: true },

optgroup: { optgroup: true, option: true },

option: { option: true },

tbody: { caption: true, colgroup: true, thead: true, tbody: true, tfoot: true },

tfoot: { caption: true, colgroup: true, thead: true, tbody: true },

thead: { caption: true, colgroup: true },

tr: { tr: true, th: true, td: true, caption: true },

th: { th: true, td: true },

td: { th: true, td: true },

body: { head: true }

};

/**

* A list of elements which are automatically closed when their parent is closed:

* http://www.w3.org/html/wg/drafts/html/master/syntax.html#optional-tags

* @private

var optionalClose = {

html: true,

body: true,

li: true,

dd: true,

dt: true, // This is not actually correct, but showing a syntax error is not helpful

p: true,

rb: true,

rt: true,

rtc: true,

rp: true,

optgroup: true,

option: true,

colgroup: true,

caption: true,

tbody: true,

tfoot: true,

tr: true,

td: true,

th: true

};

// TODO: handle optional start tags

/**

* A list of tags that are self-closing (do not contain other elements).

* Mostly taken from http://www.w3.org/html/wg/drafts/html/master/syntax.html#void-elements

* @private

var voidElements = {

area: true,

base: true,

basefont: true,

br: true,

col: true,

command: true,

embed: true,

frame: true,

hr: true,

img: true,

input: true,

isindex: true,

keygen: true,

link: true,

menuitem: true,

meta: true,

param: true,

source: true,

track: true,

wbr: true

};

/**

* A SimpleNode represents one node in a SimpleDOM tree. Each node can have

* any set of properties on it, though there are a couple of assumptions made.

* Elements will have `children` and `attributes` properties. Text nodes will have a `content`

* property. All Elements will have a `tagID` and text nodes *can* have one.

* @constructor

* @param {Object} properties the properties provided will be set on the new object.

function SimpleNode(properties) {

$.extend(this, properties);

}

SimpleNode.prototype = {

/**

* Updates signatures used to optimize the number of comparisons done during

* diffing. This is important to call if you change:

* * children

* * child node attributes

* * text content of a text node

* * child node text

update: function () {

if (this.isElement()) {

var i,

subtreeHashes = "",

childHashes = "",

child;

for (i = 0; i < this.children.length; i++) {

child = this.children[i];

if (child.isElement()) {

childHashes += String(child.tagID);

subtreeHashes += String(child.tagID) + child.attributeSignature + child.subtreeSignature;

} else {

childHashes += child.textSignature;

subtreeHashes += child.textSignature;

}

this.childSignature = MurmurHash3.hashString(childHashes, childHashes.length, seed);

this.subtreeSignature = MurmurHash3.hashString(subtreeHashes, subtreeHashes.length, seed);

} else {

this.textSignature = MurmurHash3.hashString(this.content, this.content.length, seed);

}

/**

* Updates the signature of this node's attributes. Call this after making attribute changes.

updateAttributeSignature: function () {

var attributeString = JSON.stringify(this.attributes);

this.attributeSignature = MurmurHash3.hashString(attributeString, attributeString.length, seed);

/**

* Is this node an element node?

* @return {bool} true if it is an element

isElement: function () {

return !!this.children;

/**

* Is this node a text node?

* @return {bool} true if it is text

isText: function () {

return !this.children;

}

};

/**

* @private

* Generates a synthetic ID for text nodes. These IDs are only used

* for convenience when reading a SimpleDOM that is dumped to the console.

* @param {Object} textNode new node for which we are generating an ID

* @return {string} ID for the node

function getTextNodeID(textNode) {

var childIndex = textNode.parent.children.indexOf(textNode);

if (childIndex === 0) {

return textNode.parent.tagID + ".0";

}

return textNode.parent.children[childIndex - 1].tagID + "t";

}

/**

* @private

* Adds two {line, ch}-style positions, returning a new pos.

function _addPos(pos1, pos2) {

return {line: pos1.line + pos2.line, ch: (pos2.line === 0 ? pos1.ch + pos2.ch : pos2.ch)};

}

/**

* @private

* Offsets the character offset of the given {line, ch} pos by the given amount and returns a new

* pos. Not for general purpose use as it does not account for line boundaries.

function _offsetPos(pos, offset) {

return {line: pos.line, ch: pos.ch + offset};

}

/**

* A Builder creates a SimpleDOM tree of SimpleNode objects representing the

* "important" contents of an HTML document. It does not include things like comments.

* The nodes include information about their position in the text provided.

* @constructor

* @param {string} text The text to parse

* @param {?int} startOffset starting offset in the text

* @param {?{line: int, ch: int}} startOffsetPos line/ch position in the text

function Builder(text, startOffset, startOffsetPos) {

this.stack = [];

this.text = text;

this.t = new Tokenizer(text);

this.currentTag = null;

this.startOffset = startOffset || 0;

this.startOffsetPos = startOffsetPos || {line: 0, ch: 0};

}

Builder.prototype._logError = function (token) {

var error = { token: token },

startPos = token ? (token.startPos || token.endPos) : this.startOffsetPos,

endPos = token ? token.endPos : this.startOffsetPos;

error.startPos = _addPos(this.startOffsetPos, startPos);

error.endPos = _addPos(this.startOffsetPos, endPos);

if (!this.errors) {

this.errors = [];

}

this.errors.push(error);

};

/**

* Builds the SimpleDOM.

* @param {?bool} strict if errors are detected, halt and return null

* @param {?Object} markCache a cache that can be used in ID generation (is passed to `getID`)

* @return {SimpleNode} root of tree or null if parsing failed

Builder.prototype.build = function (strict, markCache) {

var self = this;

var token, lastClosedTag, lastTextNode;

var stack = this.stack;

var attributeName = null;

var nodeMap = {};

markCache = markCache || {};

// Start timers for building full and partial DOMs.

// Appropriate timer is used, and the other is discarded.

var timerBuildFull = "HTMLInstr. Build DOM Full";

var timerBuildPart = "HTMLInstr. Build DOM Partial";

var timers; // timer handles

timers = PerfUtils.markStart([timerBuildFull, timerBuildPart]);

timerBuildFull = timers[0];

timerBuildPart = timers[1];

function closeTag(endIndex, endPos) {

lastClosedTag = stack[stack.length - 1];

stack.pop();

lastClosedTag.update();

lastClosedTag.end = self.startOffset + endIndex;

lastClosedTag.endPos = _addPos(self.startOffsetPos, endPos);

}

while ((token = this.t.nextToken()) !== null) {

// lastTextNode is used to glue text nodes together

// If the last node we saw was text but this one is not, then we're done gluing.

// If this node is a comment, we might still encounter more text.

if (token.type !== "text" && token.type !== "comment" && lastTextNode) {

lastTextNode = null;

}

if (token.type === "error") {

PerfUtils.finalizeMeasurement(timerBuildFull); // discard

PerfUtils.addMeasurement(timerBuildPart); // use

this._logError(token);

return null;

} else if (token.type === "opentagname") {

var newTagName = token.contents.toLowerCase(),

newTag;

if (openImpliesClose.hasOwnProperty(newTagName)) {

var closable = openImpliesClose[newTagName];

while (stack.length > 0 && closable.hasOwnProperty(stack[stack.length - 1].tag)) {

// Close the previous tag at the start of this tag.

// Adjust backwards for the < before the tag name.

closeTag(token.start - 1, _offsetPos(token.startPos, -1));

}

newTag = new SimpleNode({

tag: token.contents.toLowerCase(),

children: [],

attributes: {},

parent: (stack.length ? stack[stack.length - 1] : null),

start: this.startOffset + token.start - 1,

startPos: _addPos(this.startOffsetPos, _offsetPos(token.startPos, -1)) // ok because we know the previous char was a "<"

});

newTag.tagID = this.getID(newTag, markCache);

// During undo in particular, it's possible that tag IDs may be reused and

// the marks in the document may be misleading. If a tag ID has been reused,

// we apply a new tag ID to ensure that our edits come out correctly.

if (nodeMap[newTag.tagID]) {

newTag.tagID = this.getNewID();

}

nodeMap[newTag.tagID] = newTag;

if (newTag.parent) {

newTag.parent.children.push(newTag);

}

this.currentTag = newTag;

if (voidElements.hasOwnProperty(newTag.tag)) {

// This is a self-closing element.

newTag.update();

} else {

stack.push(newTag);

}

} else if (token.type === "opentagend" || token.type === "selfclosingtag") {

// TODO: disallow <p/>?

if (this.currentTag) {

if (token.type === "selfclosingtag" && stack.length && stack[stack.length - 1] === this.currentTag) {

// This must have been a self-closing tag that we didn't identify as a void element

// (e.g. an SVG tag). Pop it off the stack as if we had encountered its close tag.

closeTag(token.end, token.endPos);

} else {

// We're ending an open tag. Record the end of the open tag as the end of the

// range. (If we later find a close tag for this tag, the end will get overwritten

// with the end of the close tag. In the case of a self-closing tag, we should never

// encounter that.)

// Note that we don't need to update the signature here because the signature only

// relies on the tag name and ID, and isn't affected by the tag's attributes, so

// the signature we calculated when creating the tag is still the same. If we later

// find a close tag for this tag, we'll update the signature to account for its

// children at that point (in the next "else" case).

this.currentTag.end = this.startOffset + token.end;

this.currentTag.endPos = _addPos(this.startOffsetPos, token.endPos);

lastClosedTag = this.currentTag;

this.currentTag.updateAttributeSignature();

this.currentTag = null;

}

} else if (token.type === "closetag") {

// If this is a self-closing element, ignore the close tag.

var closeTagName = token.contents.toLowerCase();

if (!voidElements.hasOwnProperty(closeTagName)) {

// Find the topmost item on the stack that matches. If we can't find one, assume

// this is just a dangling closing tag and ignore it.

var i;

for (i = stack.length - 1; i >= 0; i--) {

if (stack[i].tag === closeTagName) {

break;

}

if (i >= 0) {

do {

// For all tags we're implicitly closing (before we hit the matching tag), we want the

// implied end to be the beginning of the close tag (which is two characters, "</", before

// the start of the tagname). For the actual tag we're explicitly closing, we want the

// implied end to be the end of the close tag (which is one character, ">", after the end of

// the tagname).

if (stack.length === i + 1) {

closeTag(token.end + 1, _offsetPos(token.endPos, 1));

} else {

if (strict && !optionalClose.hasOwnProperty(stack[stack.length - 1].tag)) {

// If we're in strict mode, treat unbalanced tags as invalid.

PerfUtils.finalizeMeasurement(timerBuildFull);

PerfUtils.addMeasurement(timerBuildPart);

this._logError(token);

return null;

}

closeTag(token.start - 2, _offsetPos(token.startPos, -2));

}

} while (stack.length > i);

} else {

// If we're in strict mode, treat unmatched close tags as invalid. Otherwise

// we just silently ignore them.

if (strict) {

PerfUtils.finalizeMeasurement(timerBuildFull);

PerfUtils.addMeasurement(timerBuildPart);

this._logError(token);

return null;

}

} else if (token.type === "attribname") {

attributeName = token.contents.toLowerCase();

// Set the value to the empty string in case this is an empty attribute. If it's not,

// it will get overwritten by the attribvalue later.

this.currentTag.attributes[attributeName] = "";

} else if (token.type === "attribvalue" && attributeName !== null) {

this.currentTag.attributes[attributeName] = token.contents;

attributeName = null;

} else if (token.type === "text") {

if (stack.length) {

var parent = stack[stack.length - 1];

var newNode;

// Check to see if we're continuing a previous text.

if (lastTextNode) {

newNode = lastTextNode;

newNode.content += token.contents;

} else {

newNode = new SimpleNode({

parent: stack[stack.length - 1],

content: token.contents

});

parent.children.push(newNode);

newNode.tagID = getTextNodeID(newNode);

nodeMap[newNode.tagID] = newNode;

lastTextNode = newNode;

}

newNode.update();

}

// If we have any tags hanging open, fail the parse if we're in strict mode,

// otherwise close them at the end of the document.

while (stack.length) {

if (strict && !optionalClose.hasOwnProperty(stack[stack.length - 1].tag)) {

PerfUtils.finalizeMeasurement(timerBuildFull);

PerfUtils.addMeasurement(timerBuildPart);

this._logError(token);

return null;

}

closeTag(this.text.length, this.t._indexPos);

}

var dom = lastClosedTag;

if (!dom) {

// This can happen if the document has no nontrivial content, or if the user tries to

// have something at the root other than the HTML tag. In all such cases, we treat the

// document as invalid.

this._logError(token);

return null;

}

dom.nodeMap = nodeMap;

PerfUtils.addMeasurement(timerBuildFull); // use

PerfUtils.finalizeMeasurement(timerBuildPart); // discard

return dom;

};

/**

* Returns a new tag ID.

* @return {int} unique tag ID

Builder.prototype.getNewID = function () {

return tagID++;

};

/**

* Returns the best tag ID for the new tag object given.

* The default implementation just calls `getNewID`

* and returns a unique ID.

* @param {Object} newTag tag object to potentially inspect to choose an ID

* @return {int} unique tag ID

Builder.prototype.getID = Builder.prototype.getNewID;

/**

* Builds a SimpleDOM from the text provided. If `strict` mode is true, parsing

* will halt as soon as any error is seen and null will be returned.

* @param {string} text Text of document to parse

* @param {bool} strict True for strict parsing

* @return {SimpleNode} root of tree or null if strict failed

function build(text, strict) {

var builder = new Builder(text);

return builder.build(strict);

}

/**

* @private

* Generates a string version of a SimpleDOM for debugging purposes.

* @param {SimpleNode} root root of the tree

* @return {string} Text version of the tree.

function _dumpDOM(root) {

var result = "",

indent = "";

function walk(node) {

if (node.tag) {

result += indent + "TAG " + node.tagID + " " + node.tag + " " + JSON.stringify(node.attributes) + "\n";

} else {

result += indent + "TEXT " + (node.tagID || "- ") + node.content + "\n";

}

if (node.isElement()) {

indent += " ";

node.children.forEach(walk);

indent = indent.slice(2);

}

walk(root);

return result;

}

// Public API

exports.build = build;

exports.Builder = Builder;

exports.SimpleNode = SimpleNode;

// Private API

exports._dumpDOM = _dumpDOM;

exports._offsetPos = _offsetPos;

exports._getTextNodeID = getTextNodeID;

exports._seed = seed;

});

phoenix/src/language/HTMLSimpleDOM.js at main · phcode-dev/phoenix · GitHub

Uh oh!

Uh oh!

phoenix/src/language/HTMLSimpleDOM.js at main · phcode-dev/phoenix · GitHub

Uh oh!

Uh oh!

Expand file tree

Breadcrumbs

HTMLSimpleDOM.js

Latest commit

History

Breadcrumbs

HTMLSimpleDOM.js

File metadata and controls