TypeScript/src/services/classifier.ts at main · unknownDev31/TypeScript · GitHub

Repository navigation

History

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

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

import {

__String,

arrayToNumericMap,

CancellationToken,

CharacterCodes,

ClassDeclaration,

ClassificationInfo,

ClassificationResult,

Classifications,

ClassificationType,

ClassificationTypeNames,

ClassifiedSpan,

Classifier,

commentPragmas,

couldStartTrivia,

createScanner,

createTextSpan,

Debug,

decodedTextSpanIntersectsWith,

EndOfLineState,

EnumDeclaration,

getMeaningFromLocation,

getModuleInstanceState,

getTypeArgumentOrTypeParameterList,

HasJSDoc,

InterfaceDeclaration,

isAccessibilityModifier,

isConstTypeReference,

isIdentifier,

isJSDoc,

isKeyword,

isLineBreak,

isModuleDeclaration,

isPunctuation,

isTemplateLiteralKind,

isThisIdentifier,

isToken,

isTrivia,

JSDoc,

JSDocAugmentsTag,

JSDocCallbackTag,

JSDocEnumTag,

JSDocImplementsTag,

JSDocParameterTag,

JSDocPropertyTag,

JSDocReturnTag,

JSDocSeeTag,

JSDocTemplateTag,

JSDocThisTag,

JSDocThrowsTag,

JSDocTypedefTag,

JSDocTypeTag,

JsxAttribute,

JsxClosingElement,

JsxOpeningElement,

JsxSelfClosingElement,

lastOrUndefined,

ModuleDeclaration,

ModuleInstanceState,

Node,

nodeIsMissing,

ParameterDeclaration,

parseIsolatedJSDocComment,

Scanner,

ScriptTarget,

SemanticMeaning,

setParent,

some,

SourceFile,

Symbol,

SymbolFlags,

SyntaxKind,

TextSpan,

textSpanIntersectsWith,

TokenClass,

TypeChecker,

TypeParameterDeclaration,

} from "./_namespaces/ts";

/** The classifier is used for syntactic highlighting in editors via the TSServer */

export function createClassifier(): Classifier {

const scanner = createScanner(ScriptTarget.Latest, /*skipTrivia*/ false);

function getClassificationsForLine(text: string, lexState: EndOfLineState, syntacticClassifierAbsent: boolean): ClassificationResult {

return convertClassificationsToResult(getEncodedLexicalClassifications(text, lexState, syntacticClassifierAbsent), text);

}

// If there is a syntactic classifier ('syntacticClassifierAbsent' is false),

// we will be more conservative in order to avoid conflicting with the syntactic classifier.

function getEncodedLexicalClassifications(text: string, lexState: EndOfLineState, syntacticClassifierAbsent: boolean): Classifications {

let token = SyntaxKind.Unknown;

let lastNonTriviaToken = SyntaxKind.Unknown;

// Just a stack of TemplateHeads and OpenCurlyBraces, used to perform rudimentary (inexact)

// classification on template strings. Because of the context free nature of templates,

// the only precise way to classify a template portion would be by propagating the stack across

// lines, just as we do with the end-of-line state. However, this is a burden for implementers,

// and the behavior is entirely subsumed by the syntactic classifier anyway, so we instead

// flatten any nesting when the template stack is non-empty and encode it in the end-of-line state.

// Situations in which this fails are

// 1) When template strings are nested across different lines:

// `hello ${ `world

// ` }`

// Where on the second line, you will get the closing of a template,

// a closing curly, and a new template.

// 2) When substitution expressions have curly braces and the curly brace falls on the next line:

// `hello ${ () => {

// return "world" } } `

// Where on the second line, you will get the 'return' keyword,

// a string literal, and a template end consisting of '} } `'.

const templateStack: SyntaxKind[] = [];

const { prefix, pushTemplate } = getPrefixFromLexState(lexState);

text = prefix + text;

const offset = prefix.length;

if (pushTemplate) {

templateStack.push(SyntaxKind.TemplateHead);

}

scanner.setText(text);

let endOfLineState = EndOfLineState.None;

const spans: number[] = [];

// We can run into an unfortunate interaction between the lexical and syntactic classifier

// when the user is typing something generic. Consider the case where the user types:

// Foo<number

// From the lexical classifier's perspective, 'number' is a keyword, and so the word will

// be classified as such. However, from the syntactic classifier's tree-based perspective

// this is simply an expression with the identifier 'number' on the RHS of the less than

// token. So the classification will go back to being an identifier. The moment the user

// types again, number will become a keyword, then an identifier, etc. etc.

// To try to avoid this problem, we avoid classifying contextual keywords as keywords

// when the user is potentially typing something generic. We just can't do a good enough

// job at the lexical level, and so well leave it up to the syntactic classifier to make

// the determination.

// In order to determine if the user is potentially typing something generic, we use a

// weak heuristic where we track < and > tokens. It's a weak heuristic, but should

// work well enough in practice.

let angleBracketStack = 0;

do {

token = scanner.scan();

if (!isTrivia(token)) {

handleToken();

lastNonTriviaToken = token;

}

const end = scanner.getTokenEnd();

pushEncodedClassification(scanner.getTokenStart(), end, offset, classFromKind(token), spans);

if (end >= text.length) {

const end = getNewEndOfLineState(scanner, token, lastOrUndefined(templateStack));

if (end !== undefined) {

endOfLineState = end;

}

} while (token !== SyntaxKind.EndOfFileToken);

function handleToken(): void {

switch (token) {

case SyntaxKind.SlashToken:

case SyntaxKind.SlashEqualsToken:

if (!noRegexTable[lastNonTriviaToken] && scanner.reScanSlashToken() === SyntaxKind.RegularExpressionLiteral) {

token = SyntaxKind.RegularExpressionLiteral;

}

break;

case SyntaxKind.LessThanToken:

if (lastNonTriviaToken === SyntaxKind.Identifier) {

// Could be the start of something generic. Keep track of that by bumping

// up the current count of generic contexts we may be in.

angleBracketStack++;

}

break;

case SyntaxKind.GreaterThanToken:

if (angleBracketStack > 0) {

// If we think we're currently in something generic, then mark that that

// generic entity is complete.

angleBracketStack--;

}

break;

case SyntaxKind.AnyKeyword:

case SyntaxKind.StringKeyword:

case SyntaxKind.NumberKeyword:

case SyntaxKind.BooleanKeyword:

case SyntaxKind.SymbolKeyword:

if (angleBracketStack > 0 && !syntacticClassifierAbsent) {

// If it looks like we're could be in something generic, don't classify this

// as a keyword. We may just get overwritten by the syntactic classifier,

// causing a noisy experience for the user.

token = SyntaxKind.Identifier;

}

break;

case SyntaxKind.TemplateHead:

templateStack.push(token);

break;

case SyntaxKind.OpenBraceToken:

// If we don't have anything on the template stack,

// then we aren't trying to keep track of a previously scanned template head.

if (templateStack.length > 0) {

templateStack.push(token);

}

break;

case SyntaxKind.CloseBraceToken:

// If we don't have anything on the template stack,

// then we aren't trying to keep track of a previously scanned template head.

if (templateStack.length > 0) {

const lastTemplateStackToken = lastOrUndefined(templateStack);

if (lastTemplateStackToken === SyntaxKind.TemplateHead) {

token = scanner.reScanTemplateToken(/*isTaggedTemplate*/ false);

// Only pop on a TemplateTail; a TemplateMiddle indicates there is more for us.

if (token === SyntaxKind.TemplateTail) {

templateStack.pop();

}

else {

Debug.assertEqual(token, SyntaxKind.TemplateMiddle, "Should have been a template middle.");

}

else {

Debug.assertEqual(lastTemplateStackToken, SyntaxKind.OpenBraceToken, "Should have been an open brace");

templateStack.pop();

}

break;

default:

if (!isKeyword(token)) {

break;

}

if (lastNonTriviaToken === SyntaxKind.DotToken) {

token = SyntaxKind.Identifier;

}

else if (isKeyword(lastNonTriviaToken) && isKeyword(token) && !canFollow(lastNonTriviaToken, token)) {

// We have two keywords in a row. Only treat the second as a keyword if

// it's a sequence that could legally occur in the language. Otherwise

// treat it as an identifier. This way, if someone writes "private var"

// we recognize that 'var' is actually an identifier here.

token = SyntaxKind.Identifier;

}

return { endOfLineState, spans };

}

return { getClassificationsForLine, getEncodedLexicalClassifications };

}

/// We do not have a full parser support to know when we should parse a regex or not

/// If we consider every slash token to be a regex, we could be missing cases like "1/2/3", where

/// we have a series of divide operator. this list allows us to be more accurate by ruling out

/// locations where a regexp cannot exist.

const noRegexTable: true[] = arrayToNumericMap<SyntaxKind, true>([

SyntaxKind.Identifier,

SyntaxKind.StringLiteral,

SyntaxKind.NumericLiteral,

SyntaxKind.BigIntLiteral,

SyntaxKind.RegularExpressionLiteral,

SyntaxKind.ThisKeyword,

SyntaxKind.PlusPlusToken,

SyntaxKind.MinusMinusToken,

SyntaxKind.CloseParenToken,

SyntaxKind.CloseBracketToken,

SyntaxKind.CloseBraceToken,

SyntaxKind.TrueKeyword,

SyntaxKind.FalseKeyword,

], token => token, () => true);

function getNewEndOfLineState(scanner: Scanner, token: SyntaxKind, lastOnTemplateStack: SyntaxKind | undefined): EndOfLineState | undefined {

switch (token) {

case SyntaxKind.StringLiteral: {

// Check to see if we finished up on a multiline string literal.

if (!scanner.isUnterminated()) return undefined;

const tokenText = scanner.getTokenText();

const lastCharIndex = tokenText.length - 1;

let numBackslashes = 0;

while (tokenText.charCodeAt(lastCharIndex - numBackslashes) === CharacterCodes.backslash) {

numBackslashes++;

}

// If we have an odd number of backslashes, then the multiline string is unclosed

if ((numBackslashes & 1) === 0) return undefined;

return tokenText.charCodeAt(0) === CharacterCodes.doubleQuote ? EndOfLineState.InDoubleQuoteStringLiteral : EndOfLineState.InSingleQuoteStringLiteral;

}

case SyntaxKind.MultiLineCommentTrivia:

// Check to see if the multiline comment was unclosed.

return scanner.isUnterminated() ? EndOfLineState.InMultiLineCommentTrivia : undefined;

default:

if (isTemplateLiteralKind(token)) {

if (!scanner.isUnterminated()) {

return undefined;

}

switch (token) {

case SyntaxKind.TemplateTail:

return EndOfLineState.InTemplateMiddleOrTail;

case SyntaxKind.NoSubstitutionTemplateLiteral:

return EndOfLineState.InTemplateHeadOrNoSubstitutionTemplate;

default:

return Debug.fail("Only 'NoSubstitutionTemplateLiteral's and 'TemplateTail's can be unterminated; got SyntaxKind #" + token);

}

return lastOnTemplateStack === SyntaxKind.TemplateHead ? EndOfLineState.InTemplateSubstitutionPosition : undefined;

}

function pushEncodedClassification(start: number, end: number, offset: number, classification: ClassificationType, result: number[]): void {

if (classification === ClassificationType.whiteSpace) {

// Don't bother with whitespace classifications. They're not needed.

return;

}

if (start === 0 && offset > 0) {

// We're classifying the first token, and this was a case where we prepended text.

// We should consider the start of this token to be at the start of the original text.

start += offset;

}

const length = end - start;

if (length > 0) {

// All our tokens are in relation to the augmented text. Move them back to be

// relative to the original text.

result.push(start - offset, length, classification);

}

function convertClassificationsToResult(classifications: Classifications, text: string): ClassificationResult {

const entries: ClassificationInfo[] = [];

const dense = classifications.spans;

let lastEnd = 0;

for (let i = 0; i < dense.length; i += 3) {

const start = dense[i];

const length = dense[i + 1];

const type = dense[i + 2] as ClassificationType;

// Make a whitespace entry between the last item and this one.

if (lastEnd >= 0) {

const whitespaceLength = start - lastEnd;

if (whitespaceLength > 0) {

entries.push({ length: whitespaceLength, classification: TokenClass.Whitespace });

}

entries.push({ length, classification: convertClassification(type) });

lastEnd = start + length;

}

const whitespaceLength = text.length - lastEnd;

if (whitespaceLength > 0) {

entries.push({ length: whitespaceLength, classification: TokenClass.Whitespace });

}

return { entries, finalLexState: classifications.endOfLineState };

}

function convertClassification(type: ClassificationType): TokenClass {

switch (type) {

case ClassificationType.comment: return TokenClass.Comment;

case ClassificationType.keyword: return TokenClass.Keyword;

case ClassificationType.numericLiteral: return TokenClass.NumberLiteral;

case ClassificationType.bigintLiteral: return TokenClass.BigIntLiteral;

case ClassificationType.operator: return TokenClass.Operator;

case ClassificationType.stringLiteral: return TokenClass.StringLiteral;

case ClassificationType.whiteSpace: return TokenClass.Whitespace;

case ClassificationType.punctuation: return TokenClass.Punctuation;

case ClassificationType.identifier:

case ClassificationType.className:

case ClassificationType.enumName:

case ClassificationType.interfaceName:

case ClassificationType.moduleName:

case ClassificationType.typeParameterName:

case ClassificationType.typeAliasName:

case ClassificationType.text:

case ClassificationType.parameterName:

return TokenClass.Identifier;

default:

return undefined!; // TODO: GH#18217 Debug.assertNever(type);

}

/** Returns true if 'keyword2' can legally follow 'keyword1' in any language construct. */

function canFollow(keyword1: SyntaxKind, keyword2: SyntaxKind): boolean {

if (!isAccessibilityModifier(keyword1)) {

// Assume any other keyword combination is legal.

// This can be refined in the future if there are more cases we want the classifier to be better at.

return true;

}

switch (keyword2) {

case SyntaxKind.GetKeyword:

case SyntaxKind.SetKeyword:

case SyntaxKind.ConstructorKeyword:

case SyntaxKind.StaticKeyword:

case SyntaxKind.AccessorKeyword:

return true; // Allow things like "public get", "public constructor" and "public static".

default:

return false; // Any other keyword following "public" is actually an identifier, not a real keyword.

}

function getPrefixFromLexState(lexState: EndOfLineState): { readonly prefix: string, readonly pushTemplate?: true } {

// If we're in a string literal, then prepend: "\

// (and a newline). That way when we lex we'll think we're still in a string literal.

// If we're in a multiline comment, then prepend: /*

// (and a newline). That way when we lex we'll think we're still in a multiline comment.

switch (lexState) {

case EndOfLineState.InDoubleQuoteStringLiteral:

return { prefix: "\"\\\n" };

case EndOfLineState.InSingleQuoteStringLiteral:

return { prefix: "'\\\n" };

case EndOfLineState.InMultiLineCommentTrivia:

return { prefix: "/*\n" };

case EndOfLineState.InTemplateHeadOrNoSubstitutionTemplate:

return { prefix: "`\n" };

case EndOfLineState.InTemplateMiddleOrTail:

return { prefix: "}\n", pushTemplate: true };

case EndOfLineState.InTemplateSubstitutionPosition:

return { prefix: "", pushTemplate: true };

case EndOfLineState.None:

return { prefix: "" };

default:

return Debug.assertNever(lexState);

}

function isBinaryExpressionOperatorToken(token: SyntaxKind): boolean {

switch (token) {

case SyntaxKind.AsteriskToken:

case SyntaxKind.SlashToken:

case SyntaxKind.PercentToken:

case SyntaxKind.PlusToken:

case SyntaxKind.MinusToken:

case SyntaxKind.LessThanLessThanToken:

case SyntaxKind.GreaterThanGreaterThanToken:

case SyntaxKind.GreaterThanGreaterThanGreaterThanToken:

case SyntaxKind.LessThanToken:

case SyntaxKind.GreaterThanToken:

case SyntaxKind.LessThanEqualsToken:

case SyntaxKind.GreaterThanEqualsToken:

case SyntaxKind.InstanceOfKeyword:

case SyntaxKind.InKeyword:

case SyntaxKind.AsKeyword:

case SyntaxKind.SatisfiesKeyword:

case SyntaxKind.EqualsEqualsToken:

case SyntaxKind.ExclamationEqualsToken:

case SyntaxKind.EqualsEqualsEqualsToken:

case SyntaxKind.ExclamationEqualsEqualsToken:

case SyntaxKind.AmpersandToken:

case SyntaxKind.CaretToken:

case SyntaxKind.BarToken:

case SyntaxKind.AmpersandAmpersandToken:

case SyntaxKind.BarBarToken:

case SyntaxKind.BarEqualsToken:

case SyntaxKind.AmpersandEqualsToken:

case SyntaxKind.CaretEqualsToken:

case SyntaxKind.LessThanLessThanEqualsToken:

case SyntaxKind.GreaterThanGreaterThanEqualsToken:

case SyntaxKind.GreaterThanGreaterThanGreaterThanEqualsToken:

case SyntaxKind.PlusEqualsToken:

case SyntaxKind.MinusEqualsToken:

case SyntaxKind.AsteriskEqualsToken:

case SyntaxKind.SlashEqualsToken:

case SyntaxKind.PercentEqualsToken:

case SyntaxKind.EqualsToken:

case SyntaxKind.CommaToken:

case SyntaxKind.QuestionQuestionToken:

case SyntaxKind.BarBarEqualsToken:

case SyntaxKind.AmpersandAmpersandEqualsToken:

case SyntaxKind.QuestionQuestionEqualsToken:

return true;

default:

return false;

}

function isPrefixUnaryExpressionOperatorToken(token: SyntaxKind): boolean {

switch (token) {

case SyntaxKind.PlusToken:

case SyntaxKind.MinusToken:

case SyntaxKind.TildeToken:

case SyntaxKind.ExclamationToken:

case SyntaxKind.PlusPlusToken:

case SyntaxKind.MinusMinusToken:

return true;

default:

return false;

}

function classFromKind(token: SyntaxKind): ClassificationType {

if (isKeyword(token)) {

return ClassificationType.keyword;

}

else if (isBinaryExpressionOperatorToken(token) || isPrefixUnaryExpressionOperatorToken(token)) {

return ClassificationType.operator;

}

else if (token >= SyntaxKind.FirstPunctuation && token <= SyntaxKind.LastPunctuation) {

return ClassificationType.punctuation;

}

switch (token) {

case SyntaxKind.NumericLiteral:

return ClassificationType.numericLiteral;

case SyntaxKind.BigIntLiteral:

return ClassificationType.bigintLiteral;

case SyntaxKind.StringLiteral:

return ClassificationType.stringLiteral;

case SyntaxKind.RegularExpressionLiteral:

return ClassificationType.regularExpressionLiteral;

case SyntaxKind.ConflictMarkerTrivia:

case SyntaxKind.MultiLineCommentTrivia:

case SyntaxKind.SingleLineCommentTrivia:

return ClassificationType.comment;

case SyntaxKind.WhitespaceTrivia:

case SyntaxKind.NewLineTrivia:

return ClassificationType.whiteSpace;

case SyntaxKind.Identifier:

default:

if (isTemplateLiteralKind(token)) {

return ClassificationType.stringLiteral;

}

return ClassificationType.identifier;

}

/** @internal */

export function getSemanticClassifications(typeChecker: TypeChecker, cancellationToken: CancellationToken, sourceFile: SourceFile, classifiableNames: ReadonlySet<__String>, span: TextSpan): ClassifiedSpan[] {

return convertClassificationsToSpans(getEncodedSemanticClassifications(typeChecker, cancellationToken, sourceFile, classifiableNames, span));

}

function checkForClassificationCancellation(cancellationToken: CancellationToken, kind: SyntaxKind) {

// We don't want to actually call back into our host on every node to find out if we've

// been canceled. That would be an enormous amount of chattyness, along with the all

// the overhead of marshalling the data to/from the host. So instead we pick a few

// reasonable node kinds to bother checking on. These node kinds represent high level

// constructs that we would expect to see commonly, but just at a far less frequent

// interval.

// For example, in checker.ts (around 750k) we only have around 600 of these constructs.

// That means we're calling back into the host around every 1.2k of the file we process.

// Lib.d.ts has similar numbers.

switch (kind) {

case SyntaxKind.ModuleDeclaration:

case SyntaxKind.ClassDeclaration:

case SyntaxKind.InterfaceDeclaration:

case SyntaxKind.FunctionDeclaration:

case SyntaxKind.ClassExpression:

case SyntaxKind.FunctionExpression:

case SyntaxKind.ArrowFunction:

cancellationToken.throwIfCancellationRequested();

}

/** @internal */

export function getEncodedSemanticClassifications(typeChecker: TypeChecker, cancellationToken: CancellationToken, sourceFile: SourceFile, classifiableNames: ReadonlySet<__String>, span: TextSpan): Classifications {

const spans: number[] = [];

sourceFile.forEachChild(function cb(node: Node): void {

// Only walk into nodes that intersect the requested span.

if (!node || !textSpanIntersectsWith(span, node.pos, node.getFullWidth())) {

return;

}

checkForClassificationCancellation(cancellationToken, node.kind);

// Only bother calling into the typechecker if this is an identifier that

// could possibly resolve to a type name. This makes classification run

// in a third of the time it would normally take.

if (isIdentifier(node) && !nodeIsMissing(node) && classifiableNames.has(node.escapedText)) {

const symbol = typeChecker.getSymbolAtLocation(node);

const type = symbol && classifySymbol(symbol, getMeaningFromLocation(node), typeChecker);

if (type) {

pushClassification(node.getStart(sourceFile), node.getEnd(), type);

}

node.forEachChild(cb);

});

return { spans, endOfLineState: EndOfLineState.None };

function pushClassification(start: number, end: number, type: ClassificationType): void {

const length = end - start;

Debug.assert(length > 0, `Classification had non-positive length of ${length}`);

spans.push(start);

spans.push(length);

spans.push(type);

}

function classifySymbol(symbol: Symbol, meaningAtPosition: SemanticMeaning, checker: TypeChecker): ClassificationType | undefined {

const flags = symbol.getFlags();

if ((flags & SymbolFlags.Classifiable) === SymbolFlags.None) {

return undefined;

}

else if (flags & SymbolFlags.Class) {

return ClassificationType.className;

}

else if (flags & SymbolFlags.Enum) {

return ClassificationType.enumName;

}

else if (flags & SymbolFlags.TypeAlias) {

return ClassificationType.typeAliasName;

}

else if (flags & SymbolFlags.Module) {

// Only classify a module as such if

// - It appears in a namespace context.

// - There exists a module declaration which actually impacts the value side.

return meaningAtPosition & SemanticMeaning.Namespace || meaningAtPosition & SemanticMeaning.Value && hasValueSideModule(symbol) ? ClassificationType.moduleName : undefined;

}

else if (flags & SymbolFlags.Alias) {

return classifySymbol(checker.getAliasedSymbol(symbol), meaningAtPosition, checker);

}

else if (meaningAtPosition & SemanticMeaning.Type) {

return flags & SymbolFlags.Interface ? ClassificationType.interfaceName : flags & SymbolFlags.TypeParameter ? ClassificationType.typeParameterName : undefined;

}

else {

return undefined;

}

/** Returns true if there exists a module that introduces entities on the value side. */

function hasValueSideModule(symbol: Symbol): boolean {

return some(symbol.declarations, declaration =>

isModuleDeclaration(declaration) && getModuleInstanceState(declaration) === ModuleInstanceState.Instantiated);

}

function getClassificationTypeName(type: ClassificationType): ClassificationTypeNames {

switch (type) {

case ClassificationType.comment: return ClassificationTypeNames.comment;

case ClassificationType.identifier: return ClassificationTypeNames.identifier;

case ClassificationType.keyword: return ClassificationTypeNames.keyword;

case ClassificationType.numericLiteral: return ClassificationTypeNames.numericLiteral;

case ClassificationType.bigintLiteral: return ClassificationTypeNames.bigintLiteral;

case ClassificationType.operator: return ClassificationTypeNames.operator;

case ClassificationType.stringLiteral: return ClassificationTypeNames.stringLiteral;

case ClassificationType.whiteSpace: return ClassificationTypeNames.whiteSpace;

case ClassificationType.text: return ClassificationTypeNames.text;

case ClassificationType.punctuation: return ClassificationTypeNames.punctuation;

case ClassificationType.className: return ClassificationTypeNames.className;

case ClassificationType.enumName: return ClassificationTypeNames.enumName;

case ClassificationType.interfaceName: return ClassificationTypeNames.interfaceName;

case ClassificationType.moduleName: return ClassificationTypeNames.moduleName;

case ClassificationType.typeParameterName: return ClassificationTypeNames.typeParameterName;

case ClassificationType.typeAliasName: return ClassificationTypeNames.typeAliasName;

case ClassificationType.parameterName: return ClassificationTypeNames.parameterName;

case ClassificationType.docCommentTagName: return ClassificationTypeNames.docCommentTagName;

case ClassificationType.jsxOpenTagName: return ClassificationTypeNames.jsxOpenTagName;

case ClassificationType.jsxCloseTagName: return ClassificationTypeNames.jsxCloseTagName;

case ClassificationType.jsxSelfClosingTagName: return ClassificationTypeNames.jsxSelfClosingTagName;

case ClassificationType.jsxAttribute: return ClassificationTypeNames.jsxAttribute;

case ClassificationType.jsxText: return ClassificationTypeNames.jsxText;

case ClassificationType.jsxAttributeStringLiteralValue: return ClassificationTypeNames.jsxAttributeStringLiteralValue;

default: return undefined!; // TODO: GH#18217 Debug.assertNever(type);

}

function convertClassificationsToSpans(classifications: Classifications): ClassifiedSpan[] {

Debug.assert(classifications.spans.length % 3 === 0);

const dense = classifications.spans;

const result: ClassifiedSpan[] = [];

for (let i = 0; i < dense.length; i += 3) {

result.push({

textSpan: createTextSpan(dense[i], dense[i + 1]),

classificationType: getClassificationTypeName(dense[i + 2])

});

}

return result;

}

/** @internal */

export function getSyntacticClassifications(cancellationToken: CancellationToken, sourceFile: SourceFile, span: TextSpan): ClassifiedSpan[] {

return convertClassificationsToSpans(getEncodedSyntacticClassifications(cancellationToken, sourceFile, span));

}

/** @internal */

export function getEncodedSyntacticClassifications(cancellationToken: CancellationToken, sourceFile: SourceFile, span: TextSpan): Classifications {

const spanStart = span.start;

const spanLength = span.length;

// Make a scanner we can get trivia from.

const triviaScanner = createScanner(ScriptTarget.Latest, /*skipTrivia*/ false, sourceFile.languageVariant, sourceFile.text);

const mergeConflictScanner = createScanner(ScriptTarget.Latest, /*skipTrivia*/ false, sourceFile.languageVariant, sourceFile.text);

const result: number[] = [];

processElement(sourceFile);

return { spans: result, endOfLineState: EndOfLineState.None };

function pushClassification(start: number, length: number, type: ClassificationType) {

result.push(start);

result.push(length);

result.push(type);

}

function classifyLeadingTriviaAndGetTokenStart(token: Node): number {

triviaScanner.resetTokenState(token.pos);

while (true) {

const start = triviaScanner.getTokenEnd();

// only bother scanning if we have something that could be trivia.

if (!couldStartTrivia(sourceFile.text, start)) {

return start;

}

const kind = triviaScanner.scan();

const end = triviaScanner.getTokenEnd();

const width = end - start;

// The moment we get something that isn't trivia, then stop processing.

if (!isTrivia(kind)) {

return start;

}

switch (kind) {

case SyntaxKind.NewLineTrivia:

case SyntaxKind.WhitespaceTrivia:

// Don't bother with newlines/whitespace.

continue;

case SyntaxKind.SingleLineCommentTrivia:

case SyntaxKind.MultiLineCommentTrivia:

// Only bother with the trivia if it at least intersects the span of interest.

classifyComment(token, kind, start, width);

// Classifying a comment might cause us to reuse the trivia scanner

// (because of jsdoc comments). So after we classify the comment make

// sure we set the scanner position back to where it needs to be.

triviaScanner.resetTokenState(end);

continue;

case SyntaxKind.ConflictMarkerTrivia:

const text = sourceFile.text;

const ch = text.charCodeAt(start);

// for the <<<<<<< and >>>>>>> markers, we just add them in as comments

// in the classification stream.

if (ch === CharacterCodes.lessThan || ch === CharacterCodes.greaterThan) {

pushClassification(start, width, ClassificationType.comment);

continue;

}

// for the ||||||| and ======== markers, add a comment for the first line,

// and then lex all subsequent lines up until the end of the conflict marker.

Debug.assert(ch === CharacterCodes.bar || ch === CharacterCodes.equals);

classifyDisabledMergeCode(text, start, end);

break;

case SyntaxKind.ShebangTrivia:

// TODO: Maybe we should classify these.

break;

default:

Debug.assertNever(kind);

}

function classifyComment(token: Node, kind: SyntaxKind, start: number, width: number) {

if (kind === SyntaxKind.MultiLineCommentTrivia) {

// See if this is a doc comment. If so, we'll classify certain portions of it

// specially.

const docCommentAndDiagnostics = parseIsolatedJSDocComment(sourceFile.text, start, width);

if (docCommentAndDiagnostics && docCommentAndDiagnostics.jsDoc) {

// TODO: This should be predicated on `token["kind"]` being compatible with `HasJSDoc["kind"]`

setParent(docCommentAndDiagnostics.jsDoc, token as HasJSDoc);

classifyJSDocComment(docCommentAndDiagnostics.jsDoc);

return;

}

else if (kind === SyntaxKind.SingleLineCommentTrivia) {

if (tryClassifyTripleSlashComment(start, width)) {

return;

}

// Simple comment. Just add as is.

pushCommentRange(start, width);

}

function pushCommentRange(start: number, width: number) {

pushClassification(start, width, ClassificationType.comment);

}

function classifyJSDocComment(docComment: JSDoc) {

let pos = docComment.pos;

if (docComment.tags) {

for (const tag of docComment.tags) {

// As we walk through each tag, classify the portion of text from the end of

// the last tag (or the start of the entire doc comment) as 'comment'.

if (tag.pos !== pos) {

pushCommentRange(pos, tag.pos - pos);

}

pushClassification(tag.pos, 1, ClassificationType.punctuation); // "@"

pushClassification(tag.tagName.pos, tag.tagName.end - tag.tagName.pos, ClassificationType.docCommentTagName); // e.g. "param"

pos = tag.tagName.end;

let commentStart = tag.tagName.end;

switch (tag.kind) {

case SyntaxKind.JSDocParameterTag:

const param = tag as JSDocParameterTag;

processJSDocParameterTag(param);

commentStart = param.isNameFirst && param.typeExpression?.end || param.name.end;

break;

case SyntaxKind.JSDocPropertyTag:

const prop = tag as JSDocPropertyTag;

commentStart = prop.isNameFirst && prop.typeExpression?.end || prop.name.end;

break;

case SyntaxKind.JSDocTemplateTag:

processJSDocTemplateTag(tag as JSDocTemplateTag);

pos = tag.end;

commentStart = (tag as JSDocTemplateTag).typeParameters.end;

break;

case SyntaxKind.JSDocTypedefTag:

const type = tag as JSDocTypedefTag;

commentStart = type.typeExpression?.kind === SyntaxKind.JSDocTypeExpression && type.fullName?.end || type.typeExpression?.end || commentStart;

break;

case SyntaxKind.JSDocCallbackTag:

commentStart = (tag as JSDocCallbackTag).typeExpression.end;

break;

case SyntaxKind.JSDocTypeTag:

processElement((tag as JSDocTypeTag).typeExpression);

pos = tag.end;

commentStart = (tag as JSDocTypeTag).typeExpression.end;

break;

case SyntaxKind.JSDocThisTag:

case SyntaxKind.JSDocEnumTag:

commentStart = (tag as JSDocThisTag | JSDocEnumTag).typeExpression.end;

break;

case SyntaxKind.JSDocReturnTag:

processElement((tag as JSDocReturnTag).typeExpression);

pos = tag.end;

commentStart = (tag as JSDocReturnTag).typeExpression?.end || commentStart;

break;

case SyntaxKind.JSDocSeeTag:

commentStart = (tag as JSDocSeeTag).name?.end || commentStart;

break;

case SyntaxKind.JSDocAugmentsTag:

case SyntaxKind.JSDocImplementsTag:

commentStart = (tag as JSDocImplementsTag | JSDocAugmentsTag).class.end;

break;

case SyntaxKind.JSDocThrowsTag:

processElement((tag as JSDocThrowsTag).typeExpression);

pos = tag.end;

commentStart = (tag as JSDocThrowsTag).typeExpression?.end || commentStart;

break;

}

if (typeof tag.comment === "object") {

pushCommentRange(tag.comment.pos, tag.comment.end - tag.comment.pos);

}

else if (typeof tag.comment === "string") {

pushCommentRange(commentStart, tag.end - commentStart);

}

if (pos !== docComment.end) {

pushCommentRange(pos, docComment.end - pos);

}

return;

function processJSDocParameterTag(tag: JSDocParameterTag) {

if (tag.isNameFirst) {

pushCommentRange(pos, tag.name.pos - pos);

pushClassification(tag.name.pos, tag.name.end - tag.name.pos, ClassificationType.parameterName);

pos = tag.name.end;

}

if (tag.typeExpression) {

pushCommentRange(pos, tag.typeExpression.pos - pos);

processElement(tag.typeExpression);

pos = tag.typeExpression.end;

}

if (!tag.isNameFirst) {

pushCommentRange(pos, tag.name.pos - pos);

pushClassification(tag.name.pos, tag.name.end - tag.name.pos, ClassificationType.parameterName);

pos = tag.name.end;

}

function tryClassifyTripleSlashComment(start: number, width: number): boolean {

const tripleSlashXMLCommentRegEx = /^(\/\/\/\s*)(<)(?:(\S+)((?:[^/]|\/[^>])*)(\/>)?)?/im;

// Require a leading whitespace character (the parser already does) to prevent terrible backtracking performance

const attributeRegex = /(\s)(\S+)(\s*)(=)(\s*)('[^']+'|"[^"]+")/img;

const text = sourceFile.text.substr(start, width);

const match = tripleSlashXMLCommentRegEx.exec(text);

if (!match) {

return false;

}

// Limiting classification to exactly the elements and attributes

// defined in `ts.commentPragmas` would be excessive, but we can avoid

// some obvious false positives (e.g. in XML-like doc comments) by

// checking the element name.

// eslint-disable-next-line local/no-in-operator

if (!match[3] || !(match[3] in commentPragmas)) {

return false;

}

let pos = start;

pushCommentRange(pos, match[1].length); // ///

pos += match[1].length;

pushClassification(pos, match[2].length, ClassificationType.punctuation); // <

pos += match[2].length;

pushClassification(pos, match[3].length, ClassificationType.jsxSelfClosingTagName); // element name

pos += match[3].length;

const attrText = match[4];

let attrPos = pos;

while (true) {

const attrMatch = attributeRegex.exec(attrText);

if (!attrMatch) {

break;

}

const newAttrPos = pos + attrMatch.index + attrMatch[1].length; // whitespace

if (newAttrPos > attrPos) {

pushCommentRange(attrPos, newAttrPos - attrPos);

attrPos = newAttrPos;

}

pushClassification(attrPos, attrMatch[2].length, ClassificationType.jsxAttribute); // attribute name

attrPos += attrMatch[2].length;

if (attrMatch[3].length) {

pushCommentRange(attrPos, attrMatch[3].length); // whitespace

attrPos += attrMatch[3].length;

}

pushClassification(attrPos, attrMatch[4].length, ClassificationType.operator); // =

attrPos += attrMatch[4].length;

if (attrMatch[5].length) {

pushCommentRange(attrPos, attrMatch[5].length); // whitespace

attrPos += attrMatch[5].length;

}

pushClassification(attrPos, attrMatch[6].length, ClassificationType.jsxAttributeStringLiteralValue); // attribute value

attrPos += attrMatch[6].length;

}

pos += match[4].length;

if (pos > attrPos) {

pushCommentRange(attrPos, pos - attrPos);

}

if (match[5]) {

pushClassification(pos, match[5].length, ClassificationType.punctuation); // />

pos += match[5].length;

}

const end = start + width;

if (pos < end) {

pushCommentRange(pos, end - pos);

}

return true;

}

function processJSDocTemplateTag(tag: JSDocTemplateTag) {

for (const child of tag.getChildren()) {

processElement(child);

}

function classifyDisabledMergeCode(text: string, start: number, end: number) {

// Classify the line that the ||||||| or ======= marker is on as a comment.

// Then just lex all further tokens and add them to the result.

let i: number;

for (i = start; i < end; i++) {

if (isLineBreak(text.charCodeAt(i))) {

break;

}

pushClassification(start, i - start, ClassificationType.comment);

mergeConflictScanner.resetTokenState(i);

while (mergeConflictScanner.getTokenEnd() < end) {

classifyDisabledCodeToken();

}

function classifyDisabledCodeToken() {

const start = mergeConflictScanner.getTokenEnd();

View remainder of file in raw view

TypeScript/src/services/classifier.ts at main · unknownDev31/TypeScript · GitHub

Repository navigation

Expand file tree

Breadcrumbs

classifier.ts

Latest commit

History

Breadcrumbs

classifier.ts

File metadata and controls