processing/java/src/processing/mode/java/preproc/PdeEmitter.java at master · f3r/processing · 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

/* -*- mode: java; c-basic-offset: 2; indent-tabs-mode: nil -*- */

package processing.mode.java.preproc;

import java.io.PrintStream;

import java.io.PrintWriter;

import java.util.BitSet;

import java.util.Stack;

import processing.app.Preferences;

import processing.app.SketchException;

import processing.mode.java.preproc.PdeTokenTypes;

import antlr.CommonASTWithHiddenTokens;

import antlr.CommonHiddenStreamToken;

import antlr.collections.AST;

* shipped under GPL with permission.

/**

* PDEEmitter: A class that can take an ANTLR Java AST and produce

* reasonably formatted Java code from it. To use it, create a

* PDEEmitter object, call setOut() if you want to print to something

* other than System.out, and then call print(), passing the

* AST. Typically, the AST node that you pass would be the root of a

* tree - the ROOT_ID node that represents a Java file.

* Modified March 2010 to support Java 5 type arguments and for loops by

* @author Jonathan Feinberg <jdf@pobox.com>

@SuppressWarnings("serial")

public class PdeEmitter implements PdeTokenTypes {

private final PdePreprocessor pdePreprocessor;

private final PrintWriter out;

private final PrintStream debug = System.err;

private final Stack<AST> stack = new Stack<AST>();

private final static int ROOT_ID = 0;

public PdeEmitter(final PdePreprocessor pdePreprocessor, final PrintWriter out) {

this.pdePreprocessor = pdePreprocessor;

this.out = out;

}

/**

* Find a child of the given AST that has the given type

* @returns a child AST of the given type. If it can't find a child of the

* given type, return null.

static private AST getChild(final AST ast, final int childType) {

AST child = ast.getFirstChild();

while (child != null) {

if (child.getType() == childType) {

// debug.println("getChild: found:" + name(ast));

return child;

}

child = child.getNextSibling();

}

return null;

}

/**

* Dump the list of hidden tokens linked to after the AST node passed in.

* Most hidden tokens are dumped from this function.

private void dumpHiddenAfter(final AST ast) {

dumpHiddenTokens(((CommonASTWithHiddenTokens) ast).getHiddenAfter());

}

/**

* Dump the list of hidden tokens linked to before the AST node passed in.

* The only time hidden tokens need to be dumped with this function is when

* dealing parts of the tree where automatic tree construction was

* turned off with the ! operator in the grammar file and the nodes were

* manually constructed in such a way that the usual tokens don't have the

* necessary hiddenAfter links.

private void dumpHiddenBefore(final AST ast) {

antlr.CommonHiddenStreamToken child = null, parent = ((CommonASTWithHiddenTokens) ast)

.getHiddenBefore();

// if there aren't any hidden tokens here, quietly return

if (parent == null) {

return;

}

// traverse back to the head of the list of tokens before this node

do {

child = parent;

parent = child.getHiddenBefore();

} while (parent != null);

// dump that list

dumpHiddenTokens(child);

}

/**

* Dump the list of hidden tokens linked to from the token passed in.

private void dumpHiddenTokens(CommonHiddenStreamToken t) {

for (; t != null; t = pdePreprocessor.getHiddenAfter(t)) {

out.print(t.getText());

}

/**

* Print the children of the given AST

* @param ast The AST to print

* @returns true iff anything was printed

private boolean printChildren(final AST ast) throws SketchException {

boolean ret = false;

AST child = ast.getFirstChild();

while (child != null) {

ret = true;

print(child);

child = child.getNextSibling();

}

return ret;

}

/**

* Tells whether an AST has any children or not.

* @return true iff the AST has at least one child

static private boolean hasChildren(final AST ast) {

return (ast.getFirstChild() != null);

}

/**

* Gets the best node in the subtree for printing. This really means

* the next node which could potentially have hiddenBefore data. It's

* usually the first printable leaf, but not always.

* @param includeThisNode Should this node be included in the search?

* If false, only descendants are searched.

* @return the first printable leaf node in an AST

private AST getBestPrintableNode(final AST ast, final boolean includeThisNode) {

AST child;

if (includeThisNode) {

child = ast;

} else {

child = ast.getFirstChild();

}

if (child != null) {

switch (child.getType()) {

// the following node types are printing nodes that print before

// any children, but then also recurse over children. So they

// may have hiddenBefore chains that need to be printed first. Many

// statements and all unary expression types qualify. Return these

// nodes directly

case CLASS_DEF:

case ENUM_DEF:

case LITERAL_if:

case LITERAL_new:

case LITERAL_for:

case LITERAL_while:

case LITERAL_do:

case LITERAL_break:

case LITERAL_continue:

case LITERAL_return:

case LITERAL_switch:

case LITERAL_try:

case LITERAL_throw:

case LITERAL_synchronized:

case LITERAL_assert:

case BNOT:

case LNOT:

case INC:

case DEC:

case UNARY_MINUS:

case UNARY_PLUS:

return child;

// Some non-terminal node types (at the moment, I only know of

// MODIFIERS, but there may be other such types), can be

// leaves in the tree but not have any children. If this is

// such a node, move on to the next sibling.

case MODIFIERS:

if (child.getFirstChild() == null) {

return getBestPrintableNode(child.getNextSibling(), false);

}

// new jikes doesn't like fallthrough, so just duplicated here:

return getBestPrintableNode(child, false);

default:

return getBestPrintableNode(child, false);

}

return ast;

}

// Because the meanings of <, >, >>, and >>> are overloaded to support

// type arguments and type parameters, we have to treat them

// as copyable to hidden text (or else the following syntax,

// such as (); and what not gets lost under certain circumstances

// Since they are copied to the hidden stream, you don't want

// to print them explicitly; they come out in the dumpHiddenXXX methods.

// -- jdf

private static final BitSet OTHER_COPIED_TOKENS = new BitSet() {

{

set(LT);

set(GT);

set(SR);

set(BSR);

}

};

/**

* Prints a binary operator

private void printBinaryOperator(final AST ast) throws SketchException {

print(ast.getFirstChild());

if (!OTHER_COPIED_TOKENS.get(ast.getType())) {

out.print(ast.getText());

dumpHiddenAfter(ast);

}

print(ast.getFirstChild().getNextSibling());

}

private void printMethodDef(final AST ast) throws SketchException {

final AST modifiers = ast.getFirstChild();

final AST typeParameters, type;

if (modifiers.getNextSibling().getType() == TYPE_PARAMETERS) {

typeParameters = modifiers.getNextSibling();

type = typeParameters.getNextSibling();

} else {

typeParameters = null;

type = modifiers.getNextSibling();

}

final AST methodName = type.getNextSibling();

// if (methodName.getText().equals("main")) {

// pdePreprocessor.setFoundMain(true);

// }

pdePreprocessor.addMethod(methodName.getText());

printChildren(ast);

}

private void printIfThenElse(final AST literalIf) throws SketchException {

out.print(literalIf.getText());

dumpHiddenAfter(literalIf);

final AST condition = literalIf.getFirstChild();

print(condition); // the "if" condition: an EXPR

// the "then" clause is either an SLIST or an EXPR

final AST thenPath = condition.getNextSibling();

print(thenPath);

// optional "else" clause: an SLIST or an EXPR

// what could be simpler?

final AST elsePath = thenPath.getNextSibling();

if (elsePath != null) {

out.print("else");

final AST bestPrintableNode = getBestPrintableNode(elsePath, true);

dumpHiddenBefore(bestPrintableNode);

final CommonHiddenStreamToken hiddenBefore =

((CommonASTWithHiddenTokens) elsePath).getHiddenBefore();

if (elsePath.getType() == PdeTokenTypes.SLIST && elsePath.getNumberOfChildren() == 0 &&

hiddenBefore == null) {

out.print("{");

final CommonHiddenStreamToken hiddenAfter =

((CommonASTWithHiddenTokens) elsePath).getHiddenAfter();

if (hiddenAfter == null) {

out.print("}");

} else {

dumpHiddenTokens(hiddenAfter);

}

} else {

print(elsePath);

}

/**

* Print the given AST. Call this function to print your PDE code.

* It works by making recursive calls to print children.

* So the code below is one big "switch" statement on the passed AST type.

public void print(final AST ast) throws SketchException {

if (ast == null) {

return;

}

stack.push(ast);

final AST child1 = ast.getFirstChild();

AST child2 = null;

AST child3 = null;

if (child1 != null) {

child2 = child1.getNextSibling();

if (child2 != null) {

child3 = child2.getNextSibling();

}

switch (ast.getType()) {

// The top of the tree looks like this:

// ROOT_ID "Whatever.java"

// package

// imports

// class definition

case ROOT_ID:

dumpHiddenTokens(pdePreprocessor.getInitialHiddenToken());

printChildren(ast);

break;

// supporting a "package" statement in a PDE program has

// a bunch of issues with it that need to dealt in the compilation

// code too, so this isn't actually tested.

case PACKAGE_DEF:

out.print("package");

dumpHiddenAfter(ast);

print(ast.getFirstChild());

break;

// IMPORT has exactly one child

case IMPORT:

out.print("import");

dumpHiddenAfter(ast);

print(ast.getFirstChild());

break;

case STATIC_IMPORT:

out.print("import static");

dumpHiddenAfter(ast);

print(ast.getFirstChild());

break;

case CLASS_DEF:

case ENUM_DEF:

case INTERFACE_DEF:

print(getChild(ast, MODIFIERS));

if (ast.getType() == CLASS_DEF) {

out.print("class");

} else if (ast.getType() == ENUM_DEF) {

out.print("enum");

} else {

out.print("interface");

}

dumpHiddenBefore(getChild(ast, IDENT));

print(getChild(ast, IDENT));

print(getChild(ast, TYPE_PARAMETERS));

print(getChild(ast, EXTENDS_CLAUSE));

print(getChild(ast, IMPLEMENTS_CLAUSE));

print(getChild(ast, OBJBLOCK));

break;

case EXTENDS_CLAUSE:

if (hasChildren(ast)) {

out.print("extends");

dumpHiddenBefore(getBestPrintableNode(ast, false));

printChildren(ast);

}

break;

case IMPLEMENTS_CLAUSE:

if (hasChildren(ast)) {

out.print("implements");

dumpHiddenBefore(getBestPrintableNode(ast, false));

printChildren(ast);

}

break;

// DOT

case DOT:

print(child1);

out.print(".");

dumpHiddenAfter(ast);

print(child2);

if (child3 != null) {

print(child3);

}

break;

case MODIFIERS:

case OBJBLOCK:

case CTOR_DEF:

//case METHOD_DEF:

case PARAMETERS:

case PARAMETER_DEF:

case VARIABLE_PARAMETER_DEF:

case VARIABLE_DEF:

case ENUM_CONSTANT_DEF:

case TYPE:

case SLIST:

case ELIST:

case ARRAY_DECLARATOR:

case TYPECAST:

case EXPR:

case ARRAY_INIT:

case FOR_INIT:

case FOR_CONDITION:

case FOR_ITERATOR:

case METHOD_CALL:

case INSTANCE_INIT:

case INDEX_OP:

case SUPER_CTOR_CALL:

case CTOR_CALL:

printChildren(ast);

break;

case METHOD_DEF:

printMethodDef(ast);

break;

// if we have two children, it's of the form "a=0"

// if just one child, it's of the form "=0" (where the

// lhs is above this AST).

case ASSIGN:

if (child2 != null) {

print(child1);

out.print("=");

dumpHiddenAfter(ast);

print(child2);

} else {

out.print("=");

dumpHiddenAfter(ast);

print(child1);

}

break;

// binary operators:

case PLUS:

case MINUS:

case DIV:

case MOD:

case NOT_EQUAL:

case EQUAL:

case LE:

case GE:

case LOR:

case LAND:

case BOR:

case BXOR:

case BAND:

case SL:

case SR:

case BSR:

case LITERAL_instanceof:

case PLUS_ASSIGN:

case MINUS_ASSIGN:

case STAR_ASSIGN:

case DIV_ASSIGN:

case MOD_ASSIGN:

case SR_ASSIGN:

case BSR_ASSIGN:

case SL_ASSIGN:

case BAND_ASSIGN:

case BXOR_ASSIGN:

case BOR_ASSIGN:

case LT:

case GT:

printBinaryOperator(ast);

break;

case LITERAL_for:

out.print(ast.getText());

dumpHiddenAfter(ast);

if (child1.getType() == FOR_EACH_CLAUSE) {

printChildren(child1);

print(child2);

} else {

printChildren(ast);

}

break;

case POST_INC:

case POST_DEC:

print(child1);

out.print(ast.getText());

dumpHiddenAfter(ast);

break;

// unary operators:

case BNOT:

case LNOT:

case INC:

case DEC:

case UNARY_MINUS:

case UNARY_PLUS:

out.print(ast.getText());

dumpHiddenAfter(ast);

print(child1);

break;

case LITERAL_new:

out.print("new");

dumpHiddenAfter(ast);

printChildren(ast);

break;

case LITERAL_return:

out.print("return");

dumpHiddenAfter(ast);

print(child1);

break;

case STATIC_INIT:

out.print("static");

dumpHiddenBefore(getBestPrintableNode(ast, false));

print(child1);

break;

case LITERAL_switch:

out.print("switch");

dumpHiddenAfter(ast);

printChildren(ast);

break;

case LABELED_STAT:

case CASE_GROUP:

printChildren(ast);

break;

case LITERAL_case:

out.print("case");

dumpHiddenAfter(ast);

printChildren(ast);

break;

case LITERAL_default:

out.print("default");

dumpHiddenAfter(ast);

printChildren(ast);

break;

case NUM_INT:

case CHAR_LITERAL:

case STRING_LITERAL:

case NUM_FLOAT:

case NUM_LONG:

out.print(ast.getText());

dumpHiddenAfter(ast);

break;

case LITERAL_synchronized: // 0137 to fix bug #136

case LITERAL_assert:

out.print(ast.getText());

dumpHiddenAfter(ast);

printChildren(ast);

break;

case LITERAL_private:

case LITERAL_public:

case LITERAL_protected:

case LITERAL_static:

case LITERAL_transient:

case LITERAL_native:

case LITERAL_threadsafe:

//case LITERAL_synchronized: // 0137 to fix bug #136

case LITERAL_volatile:

case LITERAL_class: // 0176 to fix bug #1466

case FINAL:

case ABSTRACT:

case LITERAL_package:

case LITERAL_void:

case LITERAL_boolean:

case LITERAL_byte:

case LITERAL_char:

case LITERAL_short:

case LITERAL_int:

case LITERAL_float:

case LITERAL_long:

case LITERAL_double:

case LITERAL_true:

case LITERAL_false:

case LITERAL_null:

case SEMI:

case LITERAL_this:

case LITERAL_super:

out.print(ast.getText());

dumpHiddenAfter(ast);

break;

case EMPTY_STAT:

case EMPTY_FIELD:

break;

case LITERAL_continue:

case LITERAL_break:

out.print(ast.getText());

dumpHiddenAfter(ast);

if (child1 != null) {// maybe label

print(child1);

}

break;

// yuck: Distinguish between "import x.y.*" and "x = 1 * 3"

case STAR:

if (hasChildren(ast)) { // the binary mult. operator

printBinaryOperator(ast);

} else { // the special "*" in import:

out.print("*");

dumpHiddenAfter(ast);

}

break;

case LITERAL_throws:

out.print("throws");

dumpHiddenAfter(ast);

printChildren(ast);

break;

case LITERAL_if:

printIfThenElse(ast);

break;

case LITERAL_while:

out.print("while");

dumpHiddenAfter(ast);

printChildren(ast);

break;

case LITERAL_do:

out.print("do");

dumpHiddenAfter(ast);

print(child1); // an SLIST

out.print("while");

dumpHiddenBefore(getBestPrintableNode(child2, false));

print(child2); // an EXPR

break;

case LITERAL_try:

out.print("try");

dumpHiddenAfter(ast);

printChildren(ast);

break;

case LITERAL_catch:

out.print("catch");

dumpHiddenAfter(ast);

printChildren(ast);

break;

// the first child is the "try" and the second is the SLIST

case LITERAL_finally:

out.print("finally");

dumpHiddenAfter(ast);

printChildren(ast);

break;

case LITERAL_throw:

out.print("throw");

dumpHiddenAfter(ast);

print(child1);

break;

// the dreaded trinary operator

case QUESTION:

print(child1);

out.print("?");

dumpHiddenAfter(ast);

print(child2);

print(child3);

break;

// pde specific or modified tokens start here

// Image -> BImage, Font -> BFont as appropriate

case IDENT:

if (ast.getText().equals("Image") &&

Preferences.getBoolean("preproc.substitute_image")) { //, true)) {

out.print("BImage");

} else if (ast.getText().equals("Font") &&

Preferences.getBoolean("preproc.substitute_font")) { //, true)) {

out.print("BFont");

} else {

out.print(ast.getText());

//}

dumpHiddenAfter(ast);

break;

// the color datatype is just an alias for int

case LITERAL_color:

out.print("int");

dumpHiddenAfter(ast);

break;

case WEBCOLOR_LITERAL:

if (ast.getText().length() != 6) {

System.err.println("Internal error: incorrect length of webcolor "

+ "literal should have been detected sooner.");

break;

}

out.print("0xff" + ast.getText());

dumpHiddenAfter(ast);

break;

// allow for stuff like int(43.2).

case CONSTRUCTOR_CAST:

final AST terminalTypeNode = child1.getFirstChild();

final AST exprToCast = child2;

final String pooType = terminalTypeNode.getText();

out.print("PApplet.parse" + Character.toUpperCase(pooType.charAt(0))

+ pooType.substring(1));

dumpHiddenAfter(terminalTypeNode); // the left paren

print(exprToCast);

break;

// making floating point literals default to floats, not doubles

case NUM_DOUBLE:

final String literalDouble = ast.getText().toLowerCase();

out.print(literalDouble);

if (Preferences.getBoolean("preproc.substitute_floats")

&& literalDouble.indexOf('d') == -1) { // permit literal doubles

out.print("f");

}

dumpHiddenAfter(ast);

break;

case TYPE_ARGUMENTS:

case TYPE_PARAMETERS:

printChildren(ast);

break;

case TYPE_ARGUMENT:

case TYPE_PARAMETER:

printChildren(ast);

break;

case WILDCARD_TYPE:

out.print(ast.getText());

dumpHiddenAfter(ast);

print(ast.getFirstChild());

break;

case TYPE_LOWER_BOUNDS:

case TYPE_UPPER_BOUNDS:

out.print(ast.getType() == TYPE_LOWER_BOUNDS ? "super" : "extends");

dumpHiddenBefore(getBestPrintableNode(ast, false));

printChildren(ast);

break;

case ANNOTATION:

out.print("@");

printChildren(ast);

break;

case ANNOTATIONS:

case ANNOTATION_ARRAY_INIT:

printChildren(ast);

break;

case ANNOTATION_MEMBER_VALUE_PAIR:

print(ast.getFirstChild());

out.print("=");

dumpHiddenBefore(getBestPrintableNode(ast.getFirstChild().getNextSibling(), false));

print(ast.getFirstChild().getNextSibling());

break;

default:

debug.println("Unrecognized type:" + ast.getType() + " ("

+ TokenUtil.nameOf(ast) + ")");

break;

}

stack.pop();

}

processing/java/src/processing/mode/java/preproc/PdeEmitter.java at master · f3r/processing · GitHub

Repository navigation

Expand file tree

Breadcrumbs

PdeEmitter.java

Latest commit

History

Breadcrumbs

PdeEmitter.java

File metadata and controls