Be a bit more efficient when processing the active and inactive
[oota-llvm.git] / lib / VMCore / Type.cpp
1 //===-- Type.cpp - Implement the Type class -------------------------------===//
2 // 
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 // 
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the Type class for the VMCore library.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "llvm/AbstractTypeUser.h"
15 #include "llvm/DerivedTypes.h"
16 #include "llvm/SymbolTable.h"
17 #include "llvm/Constants.h"
18 #include "Support/DepthFirstIterator.h"
19 #include "Support/StringExtras.h"
20 #include "Support/STLExtras.h"
21 #include <algorithm>
22 #include <iostream>
23 using namespace llvm;
24
25 // DEBUG_MERGE_TYPES - Enable this #define to see how and when derived types are
26 // created and later destroyed, all in an effort to make sure that there is only
27 // a single canonical version of a type.
28 //
29 //#define DEBUG_MERGE_TYPES 1
30
31 AbstractTypeUser::~AbstractTypeUser() {}
32
33 //===----------------------------------------------------------------------===//
34 //                         Type Class Implementation
35 //===----------------------------------------------------------------------===//
36
37 // Concrete/Abstract TypeDescriptions - We lazily calculate type descriptions
38 // for types as they are needed.  Because resolution of types must invalidate
39 // all of the abstract type descriptions, we keep them in a seperate map to make
40 // this easy.
41 static std::map<const Type*, std::string> ConcreteTypeDescriptions;
42 static std::map<const Type*, std::string> AbstractTypeDescriptions;
43
44 Type::Type( const std::string& name, TypeID id )
45   : RefCount(0), ForwardType(0) {
46   if (!name.empty())
47     ConcreteTypeDescriptions[this] = name;
48   ID = id;
49   Abstract = false;
50 }
51
52 const Type *Type::getPrimitiveType(TypeID IDNumber) {
53   switch (IDNumber) {
54   case VoidTyID  : return VoidTy;
55   case BoolTyID  : return BoolTy;
56   case UByteTyID : return UByteTy;
57   case SByteTyID : return SByteTy;
58   case UShortTyID: return UShortTy;
59   case ShortTyID : return ShortTy;
60   case UIntTyID  : return UIntTy;
61   case IntTyID   : return IntTy;
62   case ULongTyID : return ULongTy;
63   case LongTyID  : return LongTy;
64   case FloatTyID : return FloatTy;
65   case DoubleTyID: return DoubleTy;
66   case LabelTyID : return LabelTy;
67   default:
68     return 0;
69   }
70 }
71
72 // isLosslesslyConvertibleTo - Return true if this type can be converted to
73 // 'Ty' without any reinterpretation of bits.  For example, uint to int.
74 //
75 bool Type::isLosslesslyConvertibleTo(const Type *Ty) const {
76   if (this == Ty) return true;
77   if ((!isPrimitiveType()    && !isa<PointerType>(this)) ||
78       (!isa<PointerType>(Ty) && !Ty->isPrimitiveType())) return false;
79
80   if (getTypeID() == Ty->getTypeID())
81     return true;  // Handles identity cast, and cast of differing pointer types
82
83   // Now we know that they are two differing primitive or pointer types
84   switch (getTypeID()) {
85   case Type::UByteTyID:   return Ty == Type::SByteTy;
86   case Type::SByteTyID:   return Ty == Type::UByteTy;
87   case Type::UShortTyID:  return Ty == Type::ShortTy;
88   case Type::ShortTyID:   return Ty == Type::UShortTy;
89   case Type::UIntTyID:    return Ty == Type::IntTy;
90   case Type::IntTyID:     return Ty == Type::UIntTy;
91   case Type::ULongTyID:   return Ty == Type::LongTy;
92   case Type::LongTyID:    return Ty == Type::ULongTy;
93   case Type::PointerTyID: return isa<PointerType>(Ty);
94   default:
95     return false;  // Other types have no identity values
96   }
97 }
98
99 /// getUnsignedVersion - If this is an integer type, return the unsigned
100 /// variant of this type.  For example int -> uint.
101 const Type *Type::getUnsignedVersion() const {
102   switch (getTypeID()) {
103   default:
104     assert(isInteger()&&"Type::getUnsignedVersion is only valid for integers!");
105   case Type::UByteTyID:   
106   case Type::SByteTyID:   return Type::UByteTy;
107   case Type::UShortTyID:  
108   case Type::ShortTyID:   return Type::UShortTy;
109   case Type::UIntTyID:    
110   case Type::IntTyID:     return Type::UIntTy;
111   case Type::ULongTyID:   
112   case Type::LongTyID:    return Type::ULongTy;
113   }
114 }
115
116 /// getSignedVersion - If this is an integer type, return the signed variant
117 /// of this type.  For example uint -> int.
118 const Type *Type::getSignedVersion() const {
119   switch (getTypeID()) {
120   default:
121     assert(isInteger() && "Type::getSignedVersion is only valid for integers!");
122   case Type::UByteTyID:   
123   case Type::SByteTyID:   return Type::SByteTy;
124   case Type::UShortTyID:  
125   case Type::ShortTyID:   return Type::ShortTy;
126   case Type::UIntTyID:    
127   case Type::IntTyID:     return Type::IntTy;
128   case Type::ULongTyID:   
129   case Type::LongTyID:    return Type::LongTy;
130   }
131 }
132
133
134 // getPrimitiveSize - Return the basic size of this type if it is a primitive
135 // type.  These are fixed by LLVM and are not target dependent.  This will
136 // return zero if the type does not have a size or is not a primitive type.
137 //
138 unsigned Type::getPrimitiveSize() const {
139   switch (getTypeID()) {
140 #define HANDLE_PRIM_TYPE(TY,SIZE)  case TY##TyID: return SIZE;
141 #include "llvm/Type.def"
142   default: return 0;
143   }
144 }
145
146 /// isSizedDerivedType - Derived types like structures and arrays are sized
147 /// iff all of the members of the type are sized as well.  Since asking for
148 /// their size is relatively uncommon, move this operation out of line.
149 bool Type::isSizedDerivedType() const {
150   if (const ArrayType *ATy = dyn_cast<ArrayType>(this))
151     return ATy->getElementType()->isSized();
152
153   if (!isa<StructType>(this)) return false;
154
155   // Okay, our struct is sized if all of the elements are...
156   for (subtype_iterator I = subtype_begin(), E = subtype_end(); I != E; ++I)
157     if (!(*I)->isSized()) return false;
158
159   return true;
160 }
161
162 /// getForwardedTypeInternal - This method is used to implement the union-find
163 /// algorithm for when a type is being forwarded to another type.
164 const Type *Type::getForwardedTypeInternal() const {
165   assert(ForwardType && "This type is not being forwarded to another type!");
166   
167   // Check to see if the forwarded type has been forwarded on.  If so, collapse
168   // the forwarding links.
169   const Type *RealForwardedType = ForwardType->getForwardedType();
170   if (!RealForwardedType)
171     return ForwardType;  // No it's not forwarded again
172
173   // Yes, it is forwarded again.  First thing, add the reference to the new
174   // forward type.
175   if (RealForwardedType->isAbstract())
176     cast<DerivedType>(RealForwardedType)->addRef();
177
178   // Now drop the old reference.  This could cause ForwardType to get deleted.
179   cast<DerivedType>(ForwardType)->dropRef();
180   
181   // Return the updated type.
182   ForwardType = RealForwardedType;
183   return ForwardType;
184 }
185
186 // getTypeDescription - This is a recursive function that walks a type hierarchy
187 // calculating the description for a type.
188 //
189 static std::string getTypeDescription(const Type *Ty,
190                                       std::vector<const Type *> &TypeStack) {
191   if (isa<OpaqueType>(Ty)) {                     // Base case for the recursion
192     std::map<const Type*, std::string>::iterator I =
193       AbstractTypeDescriptions.lower_bound(Ty);
194     if (I != AbstractTypeDescriptions.end() && I->first == Ty)
195       return I->second;
196     std::string Desc = "opaque";
197     AbstractTypeDescriptions.insert(std::make_pair(Ty, Desc));
198     return Desc;
199   }
200   
201   if (!Ty->isAbstract()) {                       // Base case for the recursion
202     std::map<const Type*, std::string>::iterator I =
203       ConcreteTypeDescriptions.find(Ty);
204     if (I != ConcreteTypeDescriptions.end()) return I->second;
205   }
206       
207   // Check to see if the Type is already on the stack...
208   unsigned Slot = 0, CurSize = TypeStack.size();
209   while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
210   
211   // This is another base case for the recursion.  In this case, we know 
212   // that we have looped back to a type that we have previously visited.
213   // Generate the appropriate upreference to handle this.
214   // 
215   if (Slot < CurSize)
216     return "\\" + utostr(CurSize-Slot);         // Here's the upreference
217
218   // Recursive case: derived types...
219   std::string Result;
220   TypeStack.push_back(Ty);    // Add us to the stack..
221       
222   switch (Ty->getTypeID()) {
223   case Type::FunctionTyID: {
224     const FunctionType *FTy = cast<FunctionType>(Ty);
225     Result = getTypeDescription(FTy->getReturnType(), TypeStack) + " (";
226     for (FunctionType::param_iterator I = FTy->param_begin(),
227            E = FTy->param_end(); I != E; ++I) {
228       if (I != FTy->param_begin())
229         Result += ", ";
230       Result += getTypeDescription(*I, TypeStack);
231     }
232     if (FTy->isVarArg()) {
233       if (FTy->getNumParams()) Result += ", ";
234       Result += "...";
235     }
236     Result += ")";
237     break;
238   }
239   case Type::StructTyID: {
240     const StructType *STy = cast<StructType>(Ty);
241     Result = "{ ";
242     for (StructType::element_iterator I = STy->element_begin(),
243            E = STy->element_end(); I != E; ++I) {
244       if (I != STy->element_begin())
245         Result += ", ";
246       Result += getTypeDescription(*I, TypeStack);
247     }
248     Result += " }";
249     break;
250   }
251   case Type::PointerTyID: {
252     const PointerType *PTy = cast<PointerType>(Ty);
253     Result = getTypeDescription(PTy->getElementType(), TypeStack) + " *";
254     break;
255   }
256   case Type::ArrayTyID: {
257     const ArrayType *ATy = cast<ArrayType>(Ty);
258     unsigned NumElements = ATy->getNumElements();
259     Result = "[";
260     Result += utostr(NumElements) + " x ";
261     Result += getTypeDescription(ATy->getElementType(), TypeStack) + "]";
262     break;
263   }
264   case Type::PackedTyID: {
265     const PackedType *PTy = cast<PackedType>(Ty);
266     unsigned NumElements = PTy->getNumElements();
267     Result = "<";
268     Result += utostr(NumElements) + " x ";
269     Result += getTypeDescription(PTy->getElementType(), TypeStack) + ">";
270     break;
271   }
272   default:
273     Result = "<error>";
274     assert(0 && "Unhandled type in getTypeDescription!");
275   }
276
277   TypeStack.pop_back();       // Remove self from stack...
278
279   return Result;
280 }
281
282
283
284 static const std::string &getOrCreateDesc(std::map<const Type*,std::string>&Map,
285                                           const Type *Ty) {
286   std::map<const Type*, std::string>::iterator I = Map.find(Ty);
287   if (I != Map.end()) return I->second;
288     
289   std::vector<const Type *> TypeStack;
290   return Map[Ty] = getTypeDescription(Ty, TypeStack);
291 }
292
293
294 const std::string &Type::getDescription() const {
295   if (isAbstract())
296     return getOrCreateDesc(AbstractTypeDescriptions, this);
297   else
298     return getOrCreateDesc(ConcreteTypeDescriptions, this);
299 }
300
301
302 bool StructType::indexValid(const Value *V) const {
303   // Structure indexes require unsigned integer constants.
304   if (V->getType() == Type::UIntTy)
305     if (const ConstantUInt *CU = dyn_cast<ConstantUInt>(V))
306       return CU->getValue() < ContainedTys.size();
307   return false;
308 }
309
310 // getTypeAtIndex - Given an index value into the type, return the type of the
311 // element.  For a structure type, this must be a constant value...
312 //
313 const Type *StructType::getTypeAtIndex(const Value *V) const {
314   assert(indexValid(V) && "Invalid structure index!");
315   unsigned Idx = (unsigned)cast<ConstantUInt>(V)->getValue();
316   return ContainedTys[Idx];
317 }
318
319
320 //===----------------------------------------------------------------------===//
321 //                           Static 'Type' data
322 //===----------------------------------------------------------------------===//
323
324 namespace {
325   struct PrimType : public Type {
326     PrimType(const char *S, TypeID ID) : Type(S, ID) {}
327   };
328 }
329
330 static PrimType TheVoidTy  ("void"  , Type::VoidTyID);
331 static PrimType TheBoolTy  ("bool"  , Type::BoolTyID);
332 static PrimType TheSByteTy ("sbyte" , Type::SByteTyID);
333 static PrimType TheUByteTy ("ubyte" , Type::UByteTyID);
334 static PrimType TheShortTy ("short" , Type::ShortTyID);
335 static PrimType TheUShortTy("ushort", Type::UShortTyID);
336 static PrimType TheIntTy   ("int"   , Type::IntTyID);
337 static PrimType TheUIntTy  ("uint"  , Type::UIntTyID);
338 static PrimType TheLongTy  ("long"  , Type::LongTyID);
339 static PrimType TheULongTy ("ulong" , Type::ULongTyID);
340 static PrimType TheFloatTy ("float" , Type::FloatTyID);
341 static PrimType TheDoubleTy("double", Type::DoubleTyID);
342 static PrimType TheLabelTy ("label" , Type::LabelTyID);
343
344 Type *Type::VoidTy   = &TheVoidTy;
345 Type *Type::BoolTy   = &TheBoolTy;
346 Type *Type::SByteTy  = &TheSByteTy;
347 Type *Type::UByteTy  = &TheUByteTy;
348 Type *Type::ShortTy  = &TheShortTy;
349 Type *Type::UShortTy = &TheUShortTy;
350 Type *Type::IntTy    = &TheIntTy;
351 Type *Type::UIntTy   = &TheUIntTy;
352 Type *Type::LongTy   = &TheLongTy;
353 Type *Type::ULongTy  = &TheULongTy;
354 Type *Type::FloatTy  = &TheFloatTy;
355 Type *Type::DoubleTy = &TheDoubleTy;
356 Type *Type::LabelTy  = &TheLabelTy;
357
358
359 //===----------------------------------------------------------------------===//
360 //                          Derived Type Constructors
361 //===----------------------------------------------------------------------===//
362
363 FunctionType::FunctionType(const Type *Result,
364                            const std::vector<const Type*> &Params, 
365                            bool IsVarArgs) : DerivedType(FunctionTyID), 
366                                              isVarArgs(IsVarArgs) {
367   assert((Result->isFirstClassType() || Result == Type::VoidTy ||
368          isa<OpaqueType>(Result)) && 
369          "LLVM functions cannot return aggregates");
370   bool isAbstract = Result->isAbstract();
371   ContainedTys.reserve(Params.size()+1);
372   ContainedTys.push_back(PATypeHandle(Result, this));
373
374   for (unsigned i = 0; i != Params.size(); ++i) {
375     assert((Params[i]->isFirstClassType() || isa<OpaqueType>(Params[i])) &&
376            "Function arguments must be value types!");
377
378     ContainedTys.push_back(PATypeHandle(Params[i], this));
379     isAbstract |= Params[i]->isAbstract();
380   }
381
382   // Calculate whether or not this type is abstract
383   setAbstract(isAbstract);
384 }
385
386 StructType::StructType(const std::vector<const Type*> &Types)
387   : CompositeType(StructTyID) {
388   ContainedTys.reserve(Types.size());
389   bool isAbstract = false;
390   for (unsigned i = 0; i < Types.size(); ++i) {
391     assert(Types[i] != Type::VoidTy && "Void type for structure field!!");
392     ContainedTys.push_back(PATypeHandle(Types[i], this));
393     isAbstract |= Types[i]->isAbstract();
394   }
395
396   // Calculate whether or not this type is abstract
397   setAbstract(isAbstract);
398 }
399
400 ArrayType::ArrayType(const Type *ElType, unsigned NumEl)
401   : SequentialType(ArrayTyID, ElType) {
402   NumElements = NumEl;
403
404   // Calculate whether or not this type is abstract
405   setAbstract(ElType->isAbstract());
406 }
407
408 PackedType::PackedType(const Type *ElType, unsigned NumEl)
409   : SequentialType(PackedTyID, ElType) {
410   NumElements = NumEl;
411
412   assert(NumEl > 0 && "NumEl of a PackedType must be greater than 0");
413   assert((ElType->isIntegral() || ElType->isFloatingPoint()) && 
414          "Elements of a PackedType must be a primitive type");
415 }
416
417
418 PointerType::PointerType(const Type *E) : SequentialType(PointerTyID, E) {
419   // Calculate whether or not this type is abstract
420   setAbstract(E->isAbstract());
421 }
422
423 OpaqueType::OpaqueType() : DerivedType(OpaqueTyID) {
424   setAbstract(true);
425 #ifdef DEBUG_MERGE_TYPES
426   std::cerr << "Derived new type: " << *this << "\n";
427 #endif
428 }
429
430 // dropAllTypeUses - When this (abstract) type is resolved to be equal to
431 // another (more concrete) type, we must eliminate all references to other
432 // types, to avoid some circular reference problems.
433 void DerivedType::dropAllTypeUses() {
434   if (!ContainedTys.empty()) {
435     while (ContainedTys.size() > 1)
436       ContainedTys.pop_back();
437     
438     // The type must stay abstract.  To do this, we insert a pointer to a type
439     // that will never get resolved, thus will always be abstract.
440     static Type *AlwaysOpaqueTy = OpaqueType::get();
441     static PATypeHolder Holder(AlwaysOpaqueTy);
442     ContainedTys[0] = AlwaysOpaqueTy;
443   }
444 }
445
446 // isTypeAbstract - This is a recursive function that walks a type hierarchy
447 // calculating whether or not a type is abstract.  Worst case it will have to do
448 // a lot of traversing if you have some whacko opaque types, but in most cases,
449 // it will do some simple stuff when it hits non-abstract types that aren't
450 // recursive.
451 //
452 bool Type::isTypeAbstract() {
453   if (!isAbstract())                           // Base case for the recursion
454     return false;                              // Primitive = leaf type
455   
456   if (isa<OpaqueType>(this))                   // Base case for the recursion
457     return true;                               // This whole type is abstract!
458
459   // We have to guard against recursion.  To do this, we temporarily mark this
460   // type as concrete, so that if we get back to here recursively we will think
461   // it's not abstract, and thus not scan it again.
462   setAbstract(false);
463
464   // Scan all of the sub-types.  If any of them are abstract, than so is this
465   // one!
466   for (Type::subtype_iterator I = subtype_begin(), E = subtype_end(); 
467        I != E; ++I)
468     if (const_cast<Type*>(I->get())->isTypeAbstract()) {
469       setAbstract(true);        // Restore the abstract bit.
470       return true;              // This type is abstract if subtype is abstract!
471     }
472   
473   // Restore the abstract bit.
474   setAbstract(true);
475
476   // Nothing looks abstract here...
477   return false;
478 }
479
480
481 //===----------------------------------------------------------------------===//
482 //                      Type Structural Equality Testing
483 //===----------------------------------------------------------------------===//
484
485 // TypesEqual - Two types are considered structurally equal if they have the
486 // same "shape": Every level and element of the types have identical primitive
487 // ID's, and the graphs have the same edges/nodes in them.  Nodes do not have to
488 // be pointer equals to be equivalent though.  This uses an optimistic algorithm
489 // that assumes that two graphs are the same until proven otherwise.
490 //
491 static bool TypesEqual(const Type *Ty, const Type *Ty2,
492                        std::map<const Type *, const Type *> &EqTypes) {
493   if (Ty == Ty2) return true;
494   if (Ty->getTypeID() != Ty2->getTypeID()) return false;
495   if (isa<OpaqueType>(Ty))
496     return false;  // Two unequal opaque types are never equal
497
498   std::map<const Type*, const Type*>::iterator It = EqTypes.lower_bound(Ty);
499   if (It != EqTypes.end() && It->first == Ty)
500     return It->second == Ty2;    // Looping back on a type, check for equality
501
502   // Otherwise, add the mapping to the table to make sure we don't get
503   // recursion on the types...
504   EqTypes.insert(It, std::make_pair(Ty, Ty2));
505
506   // Two really annoying special cases that breaks an otherwise nice simple
507   // algorithm is the fact that arraytypes have sizes that differentiates types,
508   // and that function types can be varargs or not.  Consider this now.
509   //
510   if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
511     return TypesEqual(PTy->getElementType(),
512                       cast<PointerType>(Ty2)->getElementType(), EqTypes);
513   } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
514     const StructType *STy2 = cast<StructType>(Ty2);
515     if (STy->getNumElements() != STy2->getNumElements()) return false;
516     for (unsigned i = 0, e = STy2->getNumElements(); i != e; ++i)
517       if (!TypesEqual(STy->getElementType(i), STy2->getElementType(i), EqTypes))
518         return false;
519     return true;
520   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
521     const ArrayType *ATy2 = cast<ArrayType>(Ty2);
522     return ATy->getNumElements() == ATy2->getNumElements() &&
523            TypesEqual(ATy->getElementType(), ATy2->getElementType(), EqTypes);
524   } else if (const PackedType *PTy = dyn_cast<PackedType>(Ty)) {
525     const PackedType *PTy2 = cast<PackedType>(Ty2);
526     return PTy->getNumElements() == PTy2->getNumElements() &&
527            TypesEqual(PTy->getElementType(), PTy2->getElementType(), EqTypes);
528   } else if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
529     const FunctionType *FTy2 = cast<FunctionType>(Ty2);
530     if (FTy->isVarArg() != FTy2->isVarArg() ||
531         FTy->getNumParams() != FTy2->getNumParams() ||
532         !TypesEqual(FTy->getReturnType(), FTy2->getReturnType(), EqTypes))
533       return false;
534     for (unsigned i = 0, e = FTy2->getNumParams(); i != e; ++i)
535       if (!TypesEqual(FTy->getParamType(i), FTy2->getParamType(i), EqTypes))
536         return false;
537     return true;
538   } else {
539     assert(0 && "Unknown derived type!");
540     return false;
541   }
542 }
543
544 static bool TypesEqual(const Type *Ty, const Type *Ty2) {
545   std::map<const Type *, const Type *> EqTypes;
546   return TypesEqual(Ty, Ty2, EqTypes);
547 }
548
549 // TypeHasCycleThrough - Return true there is a path from CurTy to TargetTy in
550 // the type graph.  We know that Ty is an abstract type, so if we ever reach a
551 // non-abstract type, we know that we don't need to search the subgraph.
552 static bool TypeHasCycleThrough(const Type *TargetTy, const Type *CurTy,
553                                 std::set<const Type*> &VisitedTypes) {
554   if (TargetTy == CurTy) return true;
555   if (!CurTy->isAbstract()) return false;
556
557   std::set<const Type*>::iterator VTI = VisitedTypes.lower_bound(CurTy);
558   if (VTI != VisitedTypes.end() && *VTI == CurTy)
559     return false;
560   VisitedTypes.insert(VTI, CurTy);
561
562   for (Type::subtype_iterator I = CurTy->subtype_begin(), 
563        E = CurTy->subtype_end(); I != E; ++I)
564     if (TypeHasCycleThrough(TargetTy, *I, VisitedTypes))
565       return true;
566   return false;
567 }
568
569
570 /// TypeHasCycleThroughItself - Return true if the specified type has a cycle
571 /// back to itself.
572 static bool TypeHasCycleThroughItself(const Type *Ty) {
573   assert(Ty->isAbstract() && "This code assumes that Ty was abstract!");
574   std::set<const Type*> VisitedTypes;
575   for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end(); 
576        I != E; ++I)
577     if (TypeHasCycleThrough(Ty, *I, VisitedTypes))
578       return true;
579   return false;
580 }
581
582
583 //===----------------------------------------------------------------------===//
584 //                       Derived Type Factory Functions
585 //===----------------------------------------------------------------------===//
586
587 // TypeMap - Make sure that only one instance of a particular type may be
588 // created on any given run of the compiler... note that this involves updating
589 // our map if an abstract type gets refined somehow.
590 //
591 namespace llvm {
592 template<class ValType, class TypeClass>
593 class TypeMap {
594   std::map<ValType, PATypeHolder> Map;
595
596   /// TypesByHash - Keep track of each type by its structure hash value.
597   ///
598   std::multimap<unsigned, PATypeHolder> TypesByHash;
599 public:
600   typedef typename std::map<ValType, PATypeHolder>::iterator iterator;
601   ~TypeMap() { print("ON EXIT"); }
602
603   inline TypeClass *get(const ValType &V) {
604     iterator I = Map.find(V);
605     return I != Map.end() ? cast<TypeClass>((Type*)I->second.get()) : 0;
606   }
607
608   inline void add(const ValType &V, TypeClass *Ty) {
609     Map.insert(std::make_pair(V, Ty));
610
611     // If this type has a cycle, remember it.
612     TypesByHash.insert(std::make_pair(ValType::hashTypeStructure(Ty), Ty));
613     print("add");
614   }
615
616   void RemoveFromTypesByHash(unsigned Hash, const Type *Ty) {
617     std::multimap<unsigned, PATypeHolder>::iterator I = 
618       TypesByHash.lower_bound(Hash);
619     while (I->second != Ty) {
620       ++I;
621       assert(I != TypesByHash.end() && I->first == Hash);
622     }
623     TypesByHash.erase(I);
624   }
625
626   /// finishRefinement - This method is called after we have updated an existing
627   /// type with its new components.  We must now either merge the type away with
628   /// some other type or reinstall it in the map with it's new configuration.
629   /// The specified iterator tells us what the type USED to look like.
630   void finishRefinement(TypeClass *Ty, const DerivedType *OldType,
631                         const Type *NewType) {
632     assert((Ty->isAbstract() || !OldType->isAbstract()) &&
633            "Refining a non-abstract type!");
634 #ifdef DEBUG_MERGE_TYPES
635     std::cerr << "refineAbstractTy(" << (void*)OldType << "[" << *OldType
636               << "], " << (void*)NewType << " [" << *NewType << "])\n";
637 #endif
638
639     // Make a temporary type holder for the type so that it doesn't disappear on
640     // us when we erase the entry from the map.
641     PATypeHolder TyHolder = Ty;
642
643     // The old record is now out-of-date, because one of the children has been
644     // updated.  Remove the obsolete entry from the map.
645     Map.erase(ValType::get(Ty));
646
647     // Remember the structural hash for the type before we start hacking on it,
648     // in case we need it later.  Also, check to see if the type HAD a cycle
649     // through it, if so, we know it will when we hack on it.
650     unsigned OldTypeHash = ValType::hashTypeStructure(Ty);
651
652     // Find the type element we are refining... and change it now!
653     for (unsigned i = 0, e = Ty->ContainedTys.size(); i != e; ++i)
654       if (Ty->ContainedTys[i] == OldType) {
655         Ty->ContainedTys[i].removeUserFromConcrete();
656         Ty->ContainedTys[i] = NewType;
657       }
658
659     unsigned TypeHash = ValType::hashTypeStructure(Ty);
660     
661     // If there are no cycles going through this node, we can do a simple,
662     // efficient lookup in the map, instead of an inefficient nasty linear
663     // lookup.
664     bool TypeHasCycle = Ty->isAbstract() && TypeHasCycleThroughItself(Ty);
665     if (!TypeHasCycle) {
666       iterator I = Map.find(ValType::get(Ty));
667       if (I != Map.end()) {
668         // We already have this type in the table.  Get rid of the newly refined
669         // type.
670         assert(Ty->isAbstract() && "Replacing a non-abstract type?");
671         TypeClass *NewTy = cast<TypeClass>((Type*)I->second.get());
672         
673         // Refined to a different type altogether?
674         RemoveFromTypesByHash(TypeHash, Ty);
675         Ty->refineAbstractTypeTo(NewTy);
676         return;
677       }
678       
679     } else {
680       // Now we check to see if there is an existing entry in the table which is
681       // structurally identical to the newly refined type.  If so, this type
682       // gets refined to the pre-existing type.
683       //
684       std::multimap<unsigned, PATypeHolder>::iterator I,E, Entry;
685       tie(I, E) = TypesByHash.equal_range(TypeHash);
686       Entry = E;
687       for (; I != E; ++I) {
688         if (I->second != Ty) {
689           if (TypesEqual(Ty, I->second)) {
690             assert(Ty->isAbstract() && "Replacing a non-abstract type?");
691             TypeClass *NewTy = cast<TypeClass>((Type*)I->second.get());
692             
693             if (Entry == E) {
694               // Find the location of Ty in the TypesByHash structure.
695               while (I->second != Ty) {
696                 ++I;
697                 assert(I != E && "Structure doesn't contain type??");
698               }
699               Entry = I;
700             }
701
702             TypesByHash.erase(Entry);
703             Ty->refineAbstractTypeTo(NewTy);
704             return;
705           }
706         } else {
707           // Remember the position of 
708           Entry = I;
709         }
710       }
711     }
712
713     // If we succeeded, we need to insert the type into the cycletypes table.
714     // There are several cases here, depending on whether the original type
715     // had the same hash code and was itself cyclic.
716     if (TypeHash != OldTypeHash) {
717       RemoveFromTypesByHash(OldTypeHash, Ty);
718       TypesByHash.insert(std::make_pair(TypeHash, Ty));
719     }
720
721     // If there is no existing type of the same structure, we reinsert an
722     // updated record into the map.
723     Map.insert(std::make_pair(ValType::get(Ty), Ty));
724
725     // If the type is currently thought to be abstract, rescan all of our
726     // subtypes to see if the type has just become concrete!
727     if (Ty->isAbstract()) {
728       Ty->setAbstract(Ty->isTypeAbstract());
729
730       // If the type just became concrete, notify all users!
731       if (!Ty->isAbstract())
732         Ty->notifyUsesThatTypeBecameConcrete();
733     }
734   }
735   
736   void print(const char *Arg) const {
737 #ifdef DEBUG_MERGE_TYPES
738     std::cerr << "TypeMap<>::" << Arg << " table contents:\n";
739     unsigned i = 0;
740     for (typename std::map<ValType, PATypeHolder>::const_iterator I
741            = Map.begin(), E = Map.end(); I != E; ++I)
742       std::cerr << " " << (++i) << ". " << (void*)I->second.get() << " " 
743                 << *I->second.get() << "\n";
744 #endif
745   }
746
747   void dump() const { print("dump output"); }
748 };
749 }
750
751
752 //===----------------------------------------------------------------------===//
753 // Function Type Factory and Value Class...
754 //
755
756 // FunctionValType - Define a class to hold the key that goes into the TypeMap
757 //
758 namespace llvm {
759 class FunctionValType {
760   const Type *RetTy;
761   std::vector<const Type*> ArgTypes;
762   bool isVarArg;
763 public:
764   FunctionValType(const Type *ret, const std::vector<const Type*> &args,
765                   bool IVA) : RetTy(ret), isVarArg(IVA) {
766     for (unsigned i = 0; i < args.size(); ++i)
767       ArgTypes.push_back(args[i]);
768   }
769
770   static FunctionValType get(const FunctionType *FT);
771
772   static unsigned hashTypeStructure(const FunctionType *FT) {
773     return FT->getNumParams()*2+FT->isVarArg();
774   }
775
776   // Subclass should override this... to update self as usual
777   void doRefinement(const DerivedType *OldType, const Type *NewType) {
778     if (RetTy == OldType) RetTy = NewType;
779     for (unsigned i = 0, e = ArgTypes.size(); i != e; ++i)
780       if (ArgTypes[i] == OldType) ArgTypes[i] = NewType;
781   }
782
783   inline bool operator<(const FunctionValType &MTV) const {
784     if (RetTy < MTV.RetTy) return true;
785     if (RetTy > MTV.RetTy) return false;
786
787     if (ArgTypes < MTV.ArgTypes) return true;
788     return ArgTypes == MTV.ArgTypes && isVarArg < MTV.isVarArg;
789   }
790 };
791 }
792
793 // Define the actual map itself now...
794 static TypeMap<FunctionValType, FunctionType> FunctionTypes;
795
796 FunctionValType FunctionValType::get(const FunctionType *FT) {
797   // Build up a FunctionValType
798   std::vector<const Type *> ParamTypes;
799   ParamTypes.reserve(FT->getNumParams());
800   for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i)
801     ParamTypes.push_back(FT->getParamType(i));
802   return FunctionValType(FT->getReturnType(), ParamTypes, FT->isVarArg());
803 }
804
805
806 // FunctionType::get - The factory function for the FunctionType class...
807 FunctionType *FunctionType::get(const Type *ReturnType, 
808                                 const std::vector<const Type*> &Params,
809                                 bool isVarArg) {
810   FunctionValType VT(ReturnType, Params, isVarArg);
811   FunctionType *MT = FunctionTypes.get(VT);
812   if (MT) return MT;
813
814   FunctionTypes.add(VT, MT = new FunctionType(ReturnType, Params, isVarArg));
815
816 #ifdef DEBUG_MERGE_TYPES
817   std::cerr << "Derived new type: " << MT << "\n";
818 #endif
819   return MT;
820 }
821
822 //===----------------------------------------------------------------------===//
823 // Array Type Factory...
824 //
825 namespace llvm {
826 class ArrayValType {
827   const Type *ValTy;
828   unsigned Size;
829 public:
830   ArrayValType(const Type *val, int sz) : ValTy(val), Size(sz) {}
831
832   static ArrayValType get(const ArrayType *AT) {
833     return ArrayValType(AT->getElementType(), AT->getNumElements());
834   }
835
836   static unsigned hashTypeStructure(const ArrayType *AT) {
837     return AT->getNumElements();
838   }
839
840   // Subclass should override this... to update self as usual
841   void doRefinement(const DerivedType *OldType, const Type *NewType) {
842     assert(ValTy == OldType);
843     ValTy = NewType;
844   }
845
846   inline bool operator<(const ArrayValType &MTV) const {
847     if (Size < MTV.Size) return true;
848     return Size == MTV.Size && ValTy < MTV.ValTy;
849   }
850 };
851 }
852 static TypeMap<ArrayValType, ArrayType> ArrayTypes;
853
854
855 ArrayType *ArrayType::get(const Type *ElementType, unsigned NumElements) {
856   assert(ElementType && "Can't get array of null types!");
857
858   ArrayValType AVT(ElementType, NumElements);
859   ArrayType *AT = ArrayTypes.get(AVT);
860   if (AT) return AT;           // Found a match, return it!
861
862   // Value not found.  Derive a new type!
863   ArrayTypes.add(AVT, AT = new ArrayType(ElementType, NumElements));
864
865 #ifdef DEBUG_MERGE_TYPES
866   std::cerr << "Derived new type: " << *AT << "\n";
867 #endif
868   return AT;
869 }
870
871
872 //===----------------------------------------------------------------------===//
873 // Packed Type Factory...
874 //
875 namespace llvm {
876 class PackedValType {
877   const Type *ValTy;
878   unsigned Size;
879 public:
880   PackedValType(const Type *val, int sz) : ValTy(val), Size(sz) {}
881
882   static PackedValType get(const PackedType *PT) {
883     return PackedValType(PT->getElementType(), PT->getNumElements());
884   }
885
886   static unsigned hashTypeStructure(const PackedType *PT) {
887     return PT->getNumElements();
888   }
889
890   // Subclass should override this... to update self as usual
891   void doRefinement(const DerivedType *OldType, const Type *NewType) {
892     assert(ValTy == OldType);
893     ValTy = NewType;
894   }
895
896   inline bool operator<(const PackedValType &MTV) const {
897     if (Size < MTV.Size) return true;
898     return Size == MTV.Size && ValTy < MTV.ValTy;
899   }
900 };
901 }
902 static TypeMap<PackedValType, PackedType> PackedTypes;
903
904
905 PackedType *PackedType::get(const Type *ElementType, unsigned NumElements) {
906   assert(ElementType && "Can't get packed of null types!");
907
908   PackedValType PVT(ElementType, NumElements);
909   PackedType *PT = PackedTypes.get(PVT);
910   if (PT) return PT;           // Found a match, return it!
911
912   // Value not found.  Derive a new type!
913   PackedTypes.add(PVT, PT = new PackedType(ElementType, NumElements));
914
915 #ifdef DEBUG_MERGE_TYPES
916   std::cerr << "Derived new type: " << *PT << "\n";
917 #endif
918   return PT;
919 }
920
921 //===----------------------------------------------------------------------===//
922 // Struct Type Factory...
923 //
924
925 namespace llvm {
926 // StructValType - Define a class to hold the key that goes into the TypeMap
927 //
928 class StructValType {
929   std::vector<const Type*> ElTypes;
930 public:
931   StructValType(const std::vector<const Type*> &args) : ElTypes(args) {}
932
933   static StructValType get(const StructType *ST) {
934     std::vector<const Type *> ElTypes;
935     ElTypes.reserve(ST->getNumElements());
936     for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i)
937       ElTypes.push_back(ST->getElementType(i));
938     
939     return StructValType(ElTypes);
940   }
941
942   static unsigned hashTypeStructure(const StructType *ST) {
943     return ST->getNumElements();
944   }
945
946   // Subclass should override this... to update self as usual
947   void doRefinement(const DerivedType *OldType, const Type *NewType) {
948     for (unsigned i = 0; i < ElTypes.size(); ++i)
949       if (ElTypes[i] == OldType) ElTypes[i] = NewType;
950   }
951
952   inline bool operator<(const StructValType &STV) const {
953     return ElTypes < STV.ElTypes;
954   }
955 };
956 }
957
958 static TypeMap<StructValType, StructType> StructTypes;
959
960 StructType *StructType::get(const std::vector<const Type*> &ETypes) {
961   StructValType STV(ETypes);
962   StructType *ST = StructTypes.get(STV);
963   if (ST) return ST;
964
965   // Value not found.  Derive a new type!
966   StructTypes.add(STV, ST = new StructType(ETypes));
967
968 #ifdef DEBUG_MERGE_TYPES
969   std::cerr << "Derived new type: " << *ST << "\n";
970 #endif
971   return ST;
972 }
973
974
975
976 //===----------------------------------------------------------------------===//
977 // Pointer Type Factory...
978 //
979
980 // PointerValType - Define a class to hold the key that goes into the TypeMap
981 //
982 namespace llvm {
983 class PointerValType {
984   const Type *ValTy;
985 public:
986   PointerValType(const Type *val) : ValTy(val) {}
987
988   static PointerValType get(const PointerType *PT) {
989     return PointerValType(PT->getElementType());
990   }
991
992   static unsigned hashTypeStructure(const PointerType *PT) {
993     return 0;
994   }
995
996   // Subclass should override this... to update self as usual
997   void doRefinement(const DerivedType *OldType, const Type *NewType) {
998     assert(ValTy == OldType);
999     ValTy = NewType;
1000   }
1001
1002   bool operator<(const PointerValType &MTV) const {
1003     return ValTy < MTV.ValTy;
1004   }
1005 };
1006 }
1007
1008 static TypeMap<PointerValType, PointerType> PointerTypes;
1009
1010 PointerType *PointerType::get(const Type *ValueType) {
1011   assert(ValueType && "Can't get a pointer to <null> type!");
1012   PointerValType PVT(ValueType);
1013
1014   PointerType *PT = PointerTypes.get(PVT);
1015   if (PT) return PT;
1016
1017   // Value not found.  Derive a new type!
1018   PointerTypes.add(PVT, PT = new PointerType(ValueType));
1019
1020 #ifdef DEBUG_MERGE_TYPES
1021   std::cerr << "Derived new type: " << *PT << "\n";
1022 #endif
1023   return PT;
1024 }
1025
1026
1027 //===----------------------------------------------------------------------===//
1028 //                     Derived Type Refinement Functions
1029 //===----------------------------------------------------------------------===//
1030
1031 // removeAbstractTypeUser - Notify an abstract type that a user of the class
1032 // no longer has a handle to the type.  This function is called primarily by
1033 // the PATypeHandle class.  When there are no users of the abstract type, it
1034 // is annihilated, because there is no way to get a reference to it ever again.
1035 //
1036 void DerivedType::removeAbstractTypeUser(AbstractTypeUser *U) const {
1037   // Search from back to front because we will notify users from back to
1038   // front.  Also, it is likely that there will be a stack like behavior to
1039   // users that register and unregister users.
1040   //
1041   unsigned i;
1042   for (i = AbstractTypeUsers.size(); AbstractTypeUsers[i-1] != U; --i)
1043     assert(i != 0 && "AbstractTypeUser not in user list!");
1044
1045   --i;  // Convert to be in range 0 <= i < size()
1046   assert(i < AbstractTypeUsers.size() && "Index out of range!");  // Wraparound?
1047
1048   AbstractTypeUsers.erase(AbstractTypeUsers.begin()+i);
1049       
1050 #ifdef DEBUG_MERGE_TYPES
1051   std::cerr << "  remAbstractTypeUser[" << (void*)this << ", "
1052             << *this << "][" << i << "] User = " << U << "\n";
1053 #endif
1054     
1055   if (AbstractTypeUsers.empty() && getRefCount() == 0 && isAbstract()) {
1056 #ifdef DEBUG_MERGE_TYPES
1057     std::cerr << "DELETEing unused abstract type: <" << *this
1058               << ">[" << (void*)this << "]" << "\n";
1059 #endif
1060     delete this;                  // No users of this abstract type!
1061   }
1062 }
1063
1064
1065 // refineAbstractTypeTo - This function is used to when it is discovered that
1066 // the 'this' abstract type is actually equivalent to the NewType specified.
1067 // This causes all users of 'this' to switch to reference the more concrete type
1068 // NewType and for 'this' to be deleted.
1069 //
1070 void DerivedType::refineAbstractTypeTo(const Type *NewType) {
1071   assert(isAbstract() && "refineAbstractTypeTo: Current type is not abstract!");
1072   assert(this != NewType && "Can't refine to myself!");
1073   assert(ForwardType == 0 && "This type has already been refined!");
1074
1075   // The descriptions may be out of date.  Conservatively clear them all!
1076   AbstractTypeDescriptions.clear();
1077
1078 #ifdef DEBUG_MERGE_TYPES
1079   std::cerr << "REFINING abstract type [" << (void*)this << " "
1080             << *this << "] to [" << (void*)NewType << " "
1081             << *NewType << "]!\n";
1082 #endif
1083
1084   // Make sure to put the type to be refined to into a holder so that if IT gets
1085   // refined, that we will not continue using a dead reference...
1086   //
1087   PATypeHolder NewTy(NewType);
1088
1089   // Any PATypeHolders referring to this type will now automatically forward to
1090   // the type we are resolved to.
1091   ForwardType = NewType;
1092   if (NewType->isAbstract())
1093     cast<DerivedType>(NewType)->addRef();
1094
1095   // Add a self use of the current type so that we don't delete ourself until
1096   // after the function exits.
1097   //
1098   PATypeHolder CurrentTy(this);
1099
1100   // To make the situation simpler, we ask the subclass to remove this type from
1101   // the type map, and to replace any type uses with uses of non-abstract types.
1102   // This dramatically limits the amount of recursive type trouble we can find
1103   // ourselves in.
1104   dropAllTypeUses();
1105
1106   // Iterate over all of the uses of this type, invoking callback.  Each user
1107   // should remove itself from our use list automatically.  We have to check to
1108   // make sure that NewTy doesn't _become_ 'this'.  If it does, resolving types
1109   // will not cause users to drop off of the use list.  If we resolve to ourself
1110   // we succeed!
1111   //
1112   while (!AbstractTypeUsers.empty() && NewTy != this) {
1113     AbstractTypeUser *User = AbstractTypeUsers.back();
1114
1115     unsigned OldSize = AbstractTypeUsers.size();
1116 #ifdef DEBUG_MERGE_TYPES
1117     std::cerr << " REFINING user " << OldSize-1 << "[" << (void*)User
1118               << "] of abstract type [" << (void*)this << " "
1119               << *this << "] to [" << (void*)NewTy.get() << " "
1120               << *NewTy << "]!\n";
1121 #endif
1122     User->refineAbstractType(this, NewTy);
1123
1124     assert(AbstractTypeUsers.size() != OldSize &&
1125            "AbsTyUser did not remove self from user list!");
1126   }
1127
1128   // If we were successful removing all users from the type, 'this' will be
1129   // deleted when the last PATypeHolder is destroyed or updated from this type.
1130   // This may occur on exit of this function, as the CurrentTy object is
1131   // destroyed.
1132 }
1133
1134 // notifyUsesThatTypeBecameConcrete - Notify AbstractTypeUsers of this type that
1135 // the current type has transitioned from being abstract to being concrete.
1136 //
1137 void DerivedType::notifyUsesThatTypeBecameConcrete() {
1138 #ifdef DEBUG_MERGE_TYPES
1139   std::cerr << "typeIsREFINED type: " << (void*)this << " " << *this << "\n";
1140 #endif
1141
1142   unsigned OldSize = AbstractTypeUsers.size();
1143   while (!AbstractTypeUsers.empty()) {
1144     AbstractTypeUser *ATU = AbstractTypeUsers.back();
1145     ATU->typeBecameConcrete(this);
1146
1147     assert(AbstractTypeUsers.size() < OldSize-- &&
1148            "AbstractTypeUser did not remove itself from the use list!");
1149   }
1150 }
1151   
1152
1153
1154
1155 // refineAbstractType - Called when a contained type is found to be more
1156 // concrete - this could potentially change us from an abstract type to a
1157 // concrete type.
1158 //
1159 void FunctionType::refineAbstractType(const DerivedType *OldType,
1160                                       const Type *NewType) {
1161   FunctionTypes.finishRefinement(this, OldType, NewType);
1162 }
1163
1164 void FunctionType::typeBecameConcrete(const DerivedType *AbsTy) {
1165   refineAbstractType(AbsTy, AbsTy);
1166 }
1167
1168
1169 // refineAbstractType - Called when a contained type is found to be more
1170 // concrete - this could potentially change us from an abstract type to a
1171 // concrete type.
1172 //
1173 void ArrayType::refineAbstractType(const DerivedType *OldType,
1174                                    const Type *NewType) {
1175   ArrayTypes.finishRefinement(this, OldType, NewType);
1176 }
1177
1178 void ArrayType::typeBecameConcrete(const DerivedType *AbsTy) {
1179   refineAbstractType(AbsTy, AbsTy);
1180 }
1181
1182 // refineAbstractType - Called when a contained type is found to be more
1183 // concrete - this could potentially change us from an abstract type to a
1184 // concrete type.
1185 //
1186 void PackedType::refineAbstractType(const DerivedType *OldType,
1187                                    const Type *NewType) {
1188   PackedTypes.finishRefinement(this, OldType, NewType);
1189 }
1190
1191 void PackedType::typeBecameConcrete(const DerivedType *AbsTy) {
1192   refineAbstractType(AbsTy, AbsTy);
1193 }
1194
1195 // refineAbstractType - Called when a contained type is found to be more
1196 // concrete - this could potentially change us from an abstract type to a
1197 // concrete type.
1198 //
1199 void StructType::refineAbstractType(const DerivedType *OldType,
1200                                     const Type *NewType) {
1201   StructTypes.finishRefinement(this, OldType, NewType);
1202 }
1203
1204 void StructType::typeBecameConcrete(const DerivedType *AbsTy) {
1205   refineAbstractType(AbsTy, AbsTy);
1206 }
1207
1208 // refineAbstractType - Called when a contained type is found to be more
1209 // concrete - this could potentially change us from an abstract type to a
1210 // concrete type.
1211 //
1212 void PointerType::refineAbstractType(const DerivedType *OldType,
1213                                      const Type *NewType) {
1214   PointerTypes.finishRefinement(this, OldType, NewType);
1215 }
1216
1217 void PointerType::typeBecameConcrete(const DerivedType *AbsTy) {
1218   refineAbstractType(AbsTy, AbsTy);
1219 }
1220
1221 bool SequentialType::indexValid(const Value *V) const {
1222   const Type *Ty = V->getType();
1223   switch (Ty->getTypeID()) {
1224   case Type::IntTyID:
1225   case Type::UIntTyID:
1226   case Type::LongTyID:
1227   case Type::ULongTyID:
1228     return true;
1229   default:
1230     return false;
1231   }
1232 }
1233
1234 namespace llvm {
1235 std::ostream &operator<<(std::ostream &OS, const Type *T) {
1236   if (T == 0)
1237     OS << "<null> value!\n";
1238   else
1239     T->print(OS);
1240   return OS;
1241 }
1242
1243 std::ostream &operator<<(std::ostream &OS, const Type &T) {
1244   T.print(OS);
1245   return OS;
1246 }
1247 }
1248
1249 // vim: sw=2