summaryrefslogtreecommitdiff
path: root/src/compiler/scala/tools/nsc/symtab/classfile/Pickler.scala
blob: 52cd9e768b8e59bb8641a552da0948976f066ebd (plain) (blame)
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
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
/* NSC -- new scala compiler
 * Copyright 2005 LAMP/EPFL
 * @author  Martin Odersky
 */
// $Id$
package scala.tools.nsc.symtab.classfile;

import java.io._;
import java.lang.{Float, Double}
import scala.collection.mutable.HashMap;
import scala.tools.nsc.util.Position;
import Flags._;
import PickleFormat._;



/**
 * Serialize a top-level module and/or class;
 *  @see EntryTags.scala    for symbol table attribute format.
 */
abstract class Pickler extends SubComponent {
  import global._;

  val phaseName = "pickler";
  def newPhase(prev: Phase): StdPhase = new PicklePhase(prev);

  class PicklePhase(prev: Phase) extends StdPhase(prev) {
    def apply(unit: CompilationUnit): unit = {
      def pickle(tree: Tree): unit = {

	def add(sym: Symbol, pickle: Pickle) = {
	  if (currentRun.compiles(sym) && !currentRun.symData.contains(sym)) {
	    if (settings.debug.value) log("pickling " + sym);
	    pickle.putSymbol(sym);
	    currentRun.symData(sym) = pickle;
	  }
	}

        tree match {
	  case PackageDef(_, stats) => stats foreach pickle;
	  case ClassDef(_, _, _, _, _) | ModuleDef(_, _, _) =>
	    val sym = tree.symbol;
	    val pickle = new Pickle(sym.name.toTermName, sym.owner);
	    add(sym, pickle);
	    add(sym.linkedSym, pickle);
	    pickle.finish
	  case _ =>
        }
      }
      pickle(unit.body);
    }
  }

  class Pickle(rootName: Name, rootOwner: Symbol) extends PickleBuffer(new Array[byte](4096), -1, 0) {
    private var entries = new Array[AnyRef](256);
    private var ep = 0;
    private val index = new HashMap[AnyRef, int];

    /** Is root in symbol.owner*? */
    private def isLocal(sym: Symbol): boolean = (
      sym.isRefinementClass ||
      sym.name.toTermName == rootName && sym.owner == rootOwner ||
      sym != NoSymbol && isLocal(sym.owner)
    );

    // Phase 1 methods: Populate entries/index ------------------------------------

    /** Store entry `e' in index at next available position unless it it
     *  already there. Return true iff entry is new. */
    private def putEntry(entry: AnyRef): boolean = index.get(entry) match {
      case Some(_) => false
      case None =>
	if (ep == entries.length) {
	  val entries1 = new Array[AnyRef](ep * 2);
	  System.arraycopy(entries, 0, entries1, 0, ep);
	  entries = entries1;
	}
	entries(ep) = entry;
	index(entry) = ep;
	ep = ep + 1;
	true
    }

    /** Store symbol in index. If symbol is local, also store everything it refers to. */
    def putSymbol(sym: Symbol): unit = if (putEntry(sym)) {
      if (isLocal(sym)) {
	putEntry(sym.name);
	putSymbol(sym.owner);
        putSymbol(sym.privateWithin);
	putType(sym.info);
	if (sym.thisSym != sym)
          putType(sym.typeOfThis);
	putSymbol(sym.alias);

        //for (val attr <- sym.attributes) putAttribute(sym, attr);
      } else if (sym != NoSymbol) {
	putEntry(if (sym.isModuleClass) sym.name.toTermName else sym.name);
	if (!sym.owner.isRoot) putSymbol(sym.owner);
      }
    }
    private def putSymbols(syms: List[Symbol]) = syms foreach putSymbol;

    /** Store type and everythig it refers to in index. */
    private def putType(tp: Type): unit = if (putEntry(tp)) {
      tp match {
	case NoType | NoPrefix =>
	  ;
	case ThisType(sym) =>
	  putSymbol(sym)
	case SingleType(pre, sym) =>
	  putType(pre); putSymbol(sym)
	case ConstantType(value) =>
	  putConstant(value)
	case TypeRef(pre, sym, args) =>
	  putType(pre); putSymbol(sym); putTypes(args)
	case TypeBounds(lo, hi) =>
	  putType(lo); putType(hi);
	case RefinedType(parents, decls) =>
	  putSymbol(tp.symbol); putTypes(parents); putSymbols(decls.toList)
	case ClassInfoType(parents, decls, clazz) =>
	  putSymbol(clazz); putTypes(parents); putSymbols(decls.toList)
	case MethodType(formals, restpe) =>
	  putType(restpe); putTypes(formals)
	case PolyType(tparams, restpe) =>
	  putType(restpe); putSymbols(tparams)
	case _ =>
	  throw new FatalError("bad type: " + tp + "(" + tp.getClass() + ")")
      }
    }
    private def putTypes(tps: List[Type]): unit = tps foreach putType;

    private def putConstant(c: Constant) =
      if (putEntry(c)) {
        if (c.tag == StringTag) putEntry(newTermName(c.stringValue))
        else if (c.tag == ClassTag) putEntry(c.typeValue)
      }

/*
    private def putAttribute(attr: AttrInfo): unit = if (putEntry(attr)) {
      putType(attr._1);
      for (val c <- attr._2) putConstant(c);
    }
*/
    // Phase 2 methods: Write all entries to byte array ------------------------------

    private val buf = new PickleBuffer(new Array[byte](4096), -1, 0);

    /** Write a reference to object, i.e., the object's number in the index. */
    private def writeRef(ref: AnyRef): unit = writeNat(index(ref));
    private def writeRefs(refs: List[AnyRef]): unit = refs foreach writeRef;

    /** Write name, owner, flags, and info of a symbol */
    private def writeSymInfo(sym: Symbol): int = {
      var posOffset = 0;
      if (sym.pos != Position.NOPOS && sym.owner.isClass) {
        writeNat(sym.pos);
        posOffset = PosOffset
      }
      writeRef(sym.name);
      writeRef(sym.owner);
      writeNat((sym.flags & PickledFlags).asInstanceOf[int]);
      if (sym.privateWithin != NoSymbol) writeRef(sym.privateWithin);
      writeRef(sym.info);
      posOffset
    }

    /** Write a name in Utf8 format. */
    def writeName(name: Name): unit = {
      ensureCapacity(name.length * 3);
      writeIndex = name.copyUTF8(bytes, writeIndex);
    }

    /** Write an entry */
    private def writeEntry(entry: AnyRef): unit = {
      def writeBody: int = entry match {
	case name: Name =>
	  writeName(name);
	  if (name.isTermName) TERMname else TYPEname
	case NoSymbol =>
	  NONEsym
	case sym: Symbol if !isLocal(sym) =>
	  val tag =
	    if (sym.isModuleClass) {
	      writeRef(sym.name.toTermName); EXTMODCLASSref
	    } else {
	      writeRef(sym.name); EXTref
	    }
	  if (!sym.owner.isRoot) writeRef(sym.owner);
	  tag
	case sym: ClassSymbol =>
	  val posOffset = writeSymInfo(sym);
	  if (sym.thisSym != sym) writeRef(sym.typeOfThis);
	  CLASSsym + posOffset;
	case sym: TypeSymbol =>
	  val posOffset = writeSymInfo(sym);
	  (if (sym.isAbstractType) TYPEsym else ALIASsym) + posOffset
	case sym: TermSymbol =>
	  val posOffset = writeSymInfo(sym);
	  if (sym.alias != NoSymbol) writeRef(sym.alias);
          (if (sym.isModule) MODULEsym else VALsym) + posOffset
	case NoType =>
	  NOtpe
	case NoPrefix =>
	  NOPREFIXtpe
	case ThisType(sym) =>
	  writeRef(sym); THIStpe
	case SingleType(pre, sym) =>
	  writeRef(pre); writeRef(sym); SINGLEtpe
	case ConstantType(value) =>
	  writeRef(value);
	  CONSTANTtpe
	case TypeRef(pre, sym, args) =>
	  writeRef(pre); writeRef(sym); writeRefs(args); TYPEREFtpe
	case TypeBounds(lo, hi) =>
	  writeRef(lo); writeRef(hi); TYPEBOUNDStpe
	case tp @ RefinedType(parents, decls) =>
	  writeRef(tp.symbol); writeRefs(parents); REFINEDtpe
	case ClassInfoType(parents, decls, clazz) =>
	  writeRef(clazz); writeRefs(parents); CLASSINFOtpe
	case MethodType(formals, restpe) =>
	  writeRef(restpe); writeRefs(formals);
	  if (entry.isInstanceOf[ImplicitMethodType]) IMPLICITMETHODtpe
	  else METHODtpe
	case PolyType(tparams, restpe) =>
	  writeRef(restpe); writeRefs(tparams); POLYtpe
	case c @ Constant(_) =>
	  if (c.tag == BooleanTag) writeLong(if (c.booleanValue) 1 else 0)
          else if (ByteTag <= c.tag && c.tag <= LongTag) writeLong(c.longValue)
	  else if (c.tag == FloatTag) writeLong(Float.floatToIntBits(c.floatValue))
	  else if (c.tag == DoubleTag) writeLong(Double.doubleToLongBits(c.doubleValue));
	  else if (c.tag == StringTag) writeRef(newTermName(c.stringValue));
	  else if (c.tag == ClassTag) writeRef(c.typeValue);
	  LITERAL + c.tag
/*
        case Pair(tp, cs) =>
          writeRef(tp);
          for (val c <- cs) writeRef(cs);
          ATTRIBUTE
*/
	case _ =>
	  throw new FatalError("bad entry: " + entry + " " + entry.getClass());//debug
      }
      val startpos = writeIndex;
      writeByte(0); writeByte(0);
      patchNat(startpos, writeBody);
      patchNat(startpos + 1, writeIndex - (startpos + 2));
    }

    /** Write byte array */
    def finish = {
      assert(writeIndex == 0);
      writeNat(MajorVersion);
      writeNat(MinorVersion);
      writeNat(ep);
      if (settings.debug.value) log("" + ep + " entries");//debug
      for (val i <- 0 until ep) writeEntry(entries(i));
    }

    override def toString() = "" + rootName + " in " + rootOwner;
  }
}