1
0
mirror of https://github.com/golang/go synced 2024-11-20 10:54:49 -07:00
go/usr/gri/pretty/printer.go
Robert Griesemer 61d9a3c3b0 - stronger syntax checks
- fixed a bug with non-eof terminated //-style comments
- collecting comments
- first experiments with reproducing comments
  (works but not very pretty, disabled for now)
- idempotent for all correct .go files we have checked in

R=r
OCL=17333
CL=17333
2008-10-16 23:30:42 -07:00

536 lines
9.5 KiB
Go

// Copyright 2009 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package Printer
import Scanner "scanner"
import Node "node"
export type Printer struct {
// formatting control
level int; // true scope level
indent int; // indentation level
semi bool; // pending ";"
newl int; // pending "\n"'s
// comments
clist *Node.List;
cindex int;
cpos int;
}
func (P *Printer) String(pos int, s string) {
if P.semi && P.level > 0 { // no semicolons at level 0
print(";");
}
/*
for pos > P.cpos {
// we have a comment
c := P.clist.at(P.cindex).(*Node.Comment);
if c.text[1] == '/' {
print(" " + c.text);
if P.newl <= 0 {
P.newl = 1; // line comments must have a newline
}
} else {
print(c.text);
}
P.cindex++;
if P.cindex < P.clist.len() {
P.cpos = P.clist.at(P.cindex).(*Node.Comment).pos;
} else {
P.cpos = 1000000000; // infinite
}
}
*/
if P.newl > 0 {
for i := P.newl; i > 0; i-- {
print("\n");
}
for i := P.indent; i > 0; i-- {
print("\t");
}
}
print(s);
P.semi, P.newl = false, 0;
}
func (P *Printer) Blank() {
P.String(0, " ");
}
func (P *Printer) Token(pos int, tok int) {
P.String(pos, Scanner.TokenString(tok));
}
func (P *Printer) OpenScope(paren string) {
//P.semi, P.newl = false, 0;
P.String(0, paren);
P.level++;
P.indent++;
P.newl = 1;
}
func (P *Printer) CloseScope(paren string) {
P.indent--;
P.semi = false;
P.String(0, paren);
P.level--;
P.semi, P.newl = false, 1;
}
// ----------------------------------------------------------------------------
// Types
func (P *Printer) Type(t *Node.Type)
func (P *Printer) Expr(x *Node.Expr)
func (P *Printer) Parameters(pos int, list *Node.List) {
P.String(pos, "(");
var prev int;
for i, n := 0, list.len(); i < n; i++ {
x := list.at(i).(*Node.Expr);
if i > 0 {
if prev == x.tok || prev == Scanner.TYPE {
P.String(0, ", ");
} else {
P.Blank();
}
}
P.Expr(x);
prev = x.tok;
}
P.String(0, ")");
}
func (P *Printer) Fields(list *Node.List) {
P.OpenScope(" {");
var prev int;
for i, n := 0, list.len(); i < n; i++ {
x := list.at(i).(*Node.Expr);
if i > 0 {
if prev == Scanner.TYPE {
P.String(0, ";");
P.newl = 1;
} else if prev == x.tok {
P.String(0, ", ");
} else {
P.Blank();
}
}
P.Expr(x);
prev = x.tok;
}
P.newl = 1;
P.CloseScope("}");
}
func (P *Printer) Type(t *Node.Type) {
if t == nil { // TODO remove this check
P.String(0, "<nil type>");
return;
}
switch t.tok {
case Scanner.IDENT:
P.Expr(t.expr);
case Scanner.LBRACK:
P.String(t.pos, "[");
if t.expr != nil {
P.Expr(t.expr);
}
P.String(0, "]");
P.Type(t.elt);
case Scanner.STRUCT, Scanner.INTERFACE:
P.Token(t.pos, t.tok);
if t.list != nil {
P.Blank();
P.Fields(t.list);
}
case Scanner.MAP:
P.String(t.pos, "map [");
P.Type(t.key);
P.String(0, "]");
P.Type(t.elt);
case Scanner.CHAN:
var m string;
switch t.mode {
case Node.FULL: m = "chan ";
case Node.RECV: m = "<-chan ";
case Node.SEND: m = "chan <- ";
}
P.String(t.pos, m);
P.Type(t.elt);
case Scanner.MUL:
P.String(t.pos, "*");
P.Type(t.elt);
case Scanner.LPAREN:
P.Parameters(t.pos, t.list);
if t.elt != nil {
P.Blank();
P.Parameters(0, t.elt.list);
}
default:
panic("UNREACHABLE");
}
}
// ----------------------------------------------------------------------------
// Expressions
func (P *Printer) Expr1(x *Node.Expr, prec1 int) {
if x == nil {
return; // empty expression list
}
switch x.tok {
case Scanner.TYPE:
// type expr
P.Type(x.t);
case Scanner.IDENT, Scanner.INT, Scanner.STRING, Scanner.FLOAT:
// literal
P.String(x.pos, x.s);
case Scanner.COMMA:
// list
P.Expr1(x.x, 0);
P.String(x.pos, ", ");
P.Expr1(x.y, 0);
case Scanner.PERIOD:
// selector or type guard
P.Expr1(x.x, 8); // 8 == highest precedence
P.String(x.pos, ".");
if x.y != nil {
P.Expr1(x.y, 8);
} else {
P.String(0, "(");
P.Type(x.t);
P.String(0, ")");
}
case Scanner.LBRACK:
// index
P.Expr1(x.x, 8);
P.String(x.pos, "[");
P.Expr1(x.y, 0);
P.String(0, "]");
case Scanner.LPAREN:
// call
P.Expr1(x.x, 8);
P.String(x.pos, "(");
P.Expr1(x.y, 0);
P.String(0, ")");
case Scanner.LBRACE:
// composite
P.Type(x.t);
P.String(x.pos, "{");
P.Expr1(x.y, 0);
P.String(0, "}");
default:
// unary and binary expressions
if x.x == nil {
// unary expression
P.Token(x.pos, x.tok);
P.Expr1(x.y, 7); // 7 == unary operator precedence
} else {
// binary expression: print ()'s if necessary
prec := Scanner.Precedence(x.tok);
if prec < prec1 {
P.String(0, "(");
}
P.Expr1(x.x, prec);
P.Blank();
P.Token(x.pos, x.tok);
P.Blank();
P.Expr1(x.y, prec);
if prec < prec1 {
P.String(0, ")");
}
}
}
}
func (P *Printer) Expr(x *Node.Expr) {
P.Expr1(x, 0);
}
// ----------------------------------------------------------------------------
// Statements
func (P *Printer) Stat(s *Node.Stat)
func (P *Printer) StatementList(list *Node.List) {
for i, n := 0, list.len(); i < n; i++ {
P.Stat(list.at(i).(*Node.Stat));
P.newl = 1;
}
}
func (P *Printer) Block(list *Node.List, indent bool) {
P.OpenScope("{");
if !indent {
P.indent--;
}
P.StatementList(list);
if !indent {
P.indent++;
}
P.CloseScope("}");
}
func (P *Printer) ControlClause(s *Node.Stat) {
has_post := s.tok == Scanner.FOR && s.post != nil; // post also used by "if"
if s.init == nil && !has_post {
// no semicolons required
if s.expr != nil {
P.Blank();
P.Expr(s.expr);
}
} else {
// all semicolons required
P.Blank();
if s.init != nil {
P.Stat(s.init);
}
P.semi = true;
P.Blank();
if s.expr != nil {
P.Expr(s.expr);
}
if s.tok == Scanner.FOR {
P.semi = true;
if has_post {
P.Blank();
P.Stat(s.post);
P.semi = false
}
}
}
P.Blank();
}
func (P *Printer) Declaration(d *Node.Decl, parenthesized bool);
func (P *Printer) Stat(s *Node.Stat) {
if s == nil { // TODO remove this check
P.String(0, "<nil stat>");
return;
}
switch s.tok {
case 0: // TODO use a real token const
// expression statement
P.Expr(s.expr);
P.semi = true;
case Scanner.COLON:
// label declaration
P.indent--;
P.Expr(s.expr);
P.Token(s.pos, s.tok);
P.indent++;
P.semi = false;
case Scanner.CONST, Scanner.TYPE, Scanner.VAR:
// declaration
P.Declaration(s.decl, false);
case Scanner.DEFINE, Scanner.ASSIGN, Scanner.ADD_ASSIGN,
Scanner.SUB_ASSIGN, Scanner.MUL_ASSIGN, Scanner.QUO_ASSIGN,
Scanner.REM_ASSIGN, Scanner.AND_ASSIGN, Scanner.OR_ASSIGN,
Scanner.XOR_ASSIGN, Scanner.SHL_ASSIGN, Scanner.SHR_ASSIGN:
// assignment
P.Expr(s.lhs);
P.Blank();
P.Token(s.pos, s.tok);
P.Blank();
P.Expr(s.expr);
P.semi = true;
case Scanner.INC, Scanner.DEC:
P.Expr(s.expr);
P.Token(s.pos, s.tok);
P.semi = true;
case Scanner.LBRACE:
// block
P.Block(s.block, true);
case Scanner.IF:
P.String(s.pos, "if");
P.ControlClause(s);
P.Block(s.block, true);
if s.post != nil {
P.newl = 0;
P.String(0, " else ");
P.Stat(s.post);
}
case Scanner.FOR:
P.String(s.pos, "for");
P.ControlClause(s);
P.Block(s.block, true);
case Scanner.SWITCH, Scanner.SELECT:
P.Token(s.pos, s.tok);
P.ControlClause(s);
P.Block(s.block, false);
case Scanner.CASE, Scanner.DEFAULT:
P.Token(s.pos, s.tok);
if s.expr != nil {
P.Blank();
P.Expr(s.expr);
}
P.String(0, ":");
P.indent++;
P.newl = 1;
P.StatementList(s.block);
P.indent--;
P.newl = 1;
case Scanner.GO, Scanner.RETURN, Scanner.FALLTHROUGH, Scanner.BREAK, Scanner.CONTINUE, Scanner.GOTO:
P.Token(s.pos, s.tok);
if s.expr != nil {
P.Blank();
P.Expr(s.expr);
}
P.semi = true;
default:
P.String(s.pos, "<stat>");
P.semi = true;
}
}
// ----------------------------------------------------------------------------
// Declarations
func (P *Printer) Declaration(d *Node.Decl, parenthesized bool) {
if d == nil { // TODO remove this check
P.String(0, "<nil decl>");
return;
}
if !parenthesized {
if d.exported {
P.String(0, "export ");
}
P.Token(d.pos, d.tok);
P.Blank();
}
if d.tok != Scanner.FUNC && d.list != nil {
P.OpenScope("(");
for i := 0; i < d.list.len(); i++ {
P.Declaration(d.list.at(i).(*Node.Decl), true);
P.semi, P.newl = true, 1;
}
P.CloseScope(")");
} else {
if d.tok == Scanner.FUNC && d.typ.key != nil {
P.Parameters(0, d.typ.key.list);
P.Blank();
}
P.Expr(d.ident);
if d.typ != nil {
P.Blank();
P.Type(d.typ);
}
if d.val != nil {
if d.tok == Scanner.IMPORT {
P.Blank();
} else {
P.String(0, " = ");
}
P.Expr(d.val);
}
if d.list != nil {
if d.tok != Scanner.FUNC {
panic("must be a func declaration");
}
P.Blank();
P.Block(d.list, true);
}
if d.tok != Scanner.TYPE {
P.semi = true;
}
}
P.newl = 1;
// extra newline after a function declaration
if d.tok == Scanner.FUNC {
P.newl++;
}
// extra newline at the top level
if P.level == 0 {
P.newl++;
}
}
// ----------------------------------------------------------------------------
// Program
func (P *Printer) Program(p *Node.Program) {
// TODO should initialize all fields?
P.clist = p.comments;
P.cindex = 0;
if p.comments.len() > 0 {
P.cpos = p.comments.at(0).(*Node.Comment).pos;
} else {
P.cpos = 1000000000; // infinite
}
P.String(p.pos, "package ");
P.Expr(p.ident);
P.newl = 2;
for i := 0; i < p.decls.len(); i++ {
P.Declaration(p.decls.at(i), false);
}
P.newl = 1;
P.String(0, ""); // flush
}