diff options
Diffstat (limited to 'src/dotty/tools/dotc/core/pickling/PickleFormat.scala')
| -rw-r--r-- | src/dotty/tools/dotc/core/pickling/PickleFormat.scala | 317 |
1 files changed, 317 insertions, 0 deletions
diff --git a/src/dotty/tools/dotc/core/pickling/PickleFormat.scala b/src/dotty/tools/dotc/core/pickling/PickleFormat.scala new file mode 100644 index 000000000..16356718c --- /dev/null +++ b/src/dotty/tools/dotc/core/pickling/PickleFormat.scala @@ -0,0 +1,317 @@ +package dotty.tools.dotc +package core +package pickling + +/************************************************************ +Notation: + +We use BNF notation. Terminal symbols start with at least two +consecutive upper case letters. Each terminal is represented as a +single byte tag. Non-terminals are mixed case. Prefixes of the form +lower case letter*_ are for explanation of semantic content only, they +can be dropped without changing the grammar. + +Micro-syntax: + + LongNat = Digit* StopDigit // big endian, value fits in a Long without overflow + Nat = LongNat // value fits in an Int without overflow + Digit = 0 | ... | 127 + StopDigit = 128 | ... | 255 // value = digit - 128 + FullInt = Byte Byte Byte Byte + FullLong = Byte Byte Byte Byte Byte Byte Byte Byte + Byte - 0 | ... | 255 + +Macro-format: + + File = Header majorVersion_Nat minorVersion_Nat nameTable_Length Name* Section* + Header = "5CA1AB1F" + + Section = NameRef Length Bytes + Length = Nat // length of rest of entry in bytes + + Name = UTF8 Length UTF8-CodePoint* + QUALIFIED Length qualified_NameRef selector_NameRef + SIGNED Length original_NameRef resultSig_NameRef paramSig_NameRef* + EXPANDED Length original_NameRef + MODULECLASS Length module_NameRef + SUPERACCESSOR Length accessed_NameRef + DEFAULTGETTER Length method_NameRef paramNumber_Nat + ... + + NameRef = Nat // ordinal number of name in name table, starting from 1. + +Note: Unqualified names in the name table are strings. The context decides whether a name is +a type-name or a term-name. The same string can represent both. + +Standard-Section: "ASTs" Tree* + + Tree = PACKAGE Length Path Tree* + Stat + + Stat = Term + VALDEF Length NameRef Type rhs_Tree Modifier* + DEFDEF Length NameRef TypeParam* Params* return_Type rhs_Tree + Modifier* + TYPEDEF Length NameRef (Type | Template) Modifier* + IMPORT Length qual_Term Selector* + + TypeParam = TYPEPARAM Length NameRef Type Modifier* + Params = PARAMS Length Param* + Param = PARAM Length NameRef Type Modifier + Selector = IMPORTED Length name_NameRef + RENAMED Length from_NameRef to_NameRef + + Term = Path + SELECT qual_Term possiblySigned_NameRef + SUPER Length this_Term mixinTrait_Type? + APPLY Length fn_Term arg_Term* + TYPEAPPLY Length fn_Term arg_Term* + NEW Length cls_Type + PAIR Length left_Term right_Term + TYPED Length expr_Term ascription_Type + NAMEDARG Length paramName_NameRef arg_Term + ASSIGN Length lhs_Term rhs_Term + BLOCK Length expr_Term Stat* + IF Length cond_Term then_Term else_Term + CLOSURE Length meth_Term target_Type env_Term* + MATCH Length sel_Term CaseDef* + RETURN Length meth_ASTRef expr_Term? + TRY Length expr_Term CaseDef* finalizer_Term? + THROW Length expr_Term + SEQLITERAL Length elem_Term* + JSEQLITERAL Length elem_Term* + BIND Length boundName_NameRef pat_Type pat_Term + ALTERNATIVE Length alt_Term* + UNAPPLY Length fun_Term ImplicitArg* pat_Term* + ANNOTATED Length annot_Term underlying_Term + EMPTYTREE + + CaseDef = CASEDEF Length pat_Tree guard_Tree rhs_Tree + ImplicitArg = IMPLICITARG Length arg_Tree + Template = TEMPLATE Length parent_Tree* SelfDef? Stat* +// if there is a primary constructor, it is the first statement in Stat*.. + SelfDef = Param + ASTRef = Nat // byte position in AST payload + + Path = Constant + TERMREFdirect sym_ASTRef + TERMREFsymbol qual_Type sym_ASTRef + TERMREF qual_Type possiblySigned_NameRef + THIS Length clsRef_Type + SHARED path_ASTRef + + Constant = UNITconst + FALSEconst + TRUEconst + BYTEconst Nat + BYTEneg NegNat + SHORTconst Nat + SHORTneg NegNat + CHARconst Nat + INTconst Nat + INTneg NegNat + LONGconst LongNat + LONGneg NegLongNat + FLOATconst FullInt + DOUBLEconst FullLong + STRINGconst NameRef + NULLconst + CLASSconst Length Type + ENUMconst Length Path + NegNat = Nat // negValue = -natValue - 1 + NegLongNat = LongNat // negValue = -natValue - 1 + + Type = Path + TYPEREFdirect sym_ASTRef + TYPEREFsymbol qual_Type sym_ASTRef + TYPEREF qual_Type possiblySigned_NameRef + SUPERtype Length this_Type underlying_Type + SKOLEMtype Length underlying_Type + REFINEDtype Length refinement_NameRef info_Type + APPLIEDtype Length tycon_Type arg_Type* + TYPEBOUNDS Length low_Type high_Type + TYPEALIAS Length alias_Type + ANNOTATED Length annot_Tree underlying_Type + ANDtype Length left_Type right_Type + ORtype Length left_Type right_Type + BYNAMEtype Length underlying_Type + NOTYPE + NOPREFIX + SHARED type_ASTRef + + Modifier = PRIVATE + INTERNAL // package private + PROTECTED + PRIVATEqualified qualifier_ASTRef // will be dropped + PROTECTEDqualified qualifier_ASTRef // will be dropped + ABSTRACT + FINAL + SEALED + CASE + IMPLICIT + LAZY + OVERRIDE + INLINE + ABSOVERRIDE // abstract override + STATIC // mapped to static Java member + MODULE // an object or its class + LOCAL // private[this] or protected[this] + SYNTHETIC // generated by Scala compiler + ARTIFACT // to be tagged Java Synthetic + MUTABLE // a var + LABEL // method generated as a label + FIELDaccessor // getter or setter + PARAMaccessor // getter or setter for class param + CASEaccessor // getter for case class param + COVARIANT // type param marked “+” + CONTRAVARIANT // type param marked “-” + SCALA2X // Imported from Scala2.x + DEFAULTparameterized // Method with default params + DEFAULTinit // variable with “_” initializer + annotation_Term + +Note: Tree tags are grouped into 4 categories that determine what follows, and thus allow to compute the size of the tagged tree in a generic way. + + Category 1 (tags 0-95): tag + Category 2 (tags 96-127): tag Nat + Category 3 (tags 128-159): tag AST Nat + Category 4 (tags 160-255): tag Length <payload> + +Standard Section: "Positions" startPos_Index endPos_Index + + Index = Length Assoc* + Assoc = Delta ASTRef // largest tree starting/ending at offset + Delta = Nat // # chars from last offset or start of file + +**************************************************************************************/ + +object PickleFormat { + + final val header = "5CA1AB1F" + final val MajorVersion = 0 + final val MinorVersion = 1 + + // Name tags + + final val UTF8 = 1 + final val QUALIFIED = 2 + final val SIGNED = 3 + final val EXPANDED = 4 + final val MODULECLASS = 5 + final val SUPERACCESSOR = 6 + final val DEFAULTGETTER = 7 + +// AST tags + + final val EMPTYTREE = 0 + final val NOTYPE = 1 + final val NOPREFIX = 2 + final val UNITconst = 3 + final val FALSEconst = 4 + final val TRUEconst = 5 + final val NULLconst = 6 + final val PRIVATE = 7 + final val INTERNAL = 8 + final val PROTECTED = 9 + final val ABSTRACT = 10 + final val FINAL = 11 + final val SEALED = 12 + final val CASE = 13 + final val IMPLICIT = 14 + final val LAZY = 15 + final val OVERRIDE = 16 + final val INLINE = 17 + final val ABSOVERRIDE = 18 + final val STATIC = 19 + final val MODULE = 20 + final val LOCAL = 21 + final val SYNTHETIC = 22 + final val ARTIFACT = 23 + final val MUTABLE = 24 + final val LABEL = 25 + final val FIELDaccessor = 26 + final val PARAMaccessor = 27 + final val CASEaccessor = 28 + final val COVARIANT = 29 + final val CONTRAVARIANT = 30 + final val SCALA2X = 31 + final val DEFAULTparameterized = 32 + final val DEFAULTinit = 33 + + final val SHARED = 96 + final val TERMREFdirect = 97 + final val TYPEREFdirect = 98 + final val BYTEconst = 99 + final val BYTEneg = 100 + final val SHORTconst = 101 + final val SHORTneg = 102 + final val CHARconst = 103 + final val INTconst = 104 + final val INTneg = 105 + final val LONGconst = 106 + final val LONGneg = 107 + final val FLOATconst = 108 + final val DOUBLEconst = 109 + final val STRINGconst = 110 + final val PRIVATEqualified = 111 + final val PROTECTEDqualified = 112 + + final val SELECT = 128 + final val TERMREFsymbol = 129 + final val TERMREF = 130 + final val TYPEREFsymbol = 131 + final val TYPEREF = 132 + + final val PACKAGE = 160 + final val VALDEF = 161 + final val DEFDEF = 162 + final val TYPEDEF = 163 + final val IMPORT = 164 + final val TYPEPARAM = 165 + final val PARAMS = 166 + final val PARAM = 167 + final val IMPORTED = 168 + final val RENAMED = 169 + final val APPLY = 170 + final val TYPEAPPLY = 171 + final val NEW = 172 + final val PAIR = 173 + final val TYPED = 174 + final val NAMEDARG = 175 + final val ASSIGN = 176 + final val BLOCK = 177 + final val IF = 178 + final val CLOSURE = 179 + final val MATCH = 180 + final val RETURN = 181 + final val TRY = 182 + final val THROW = 183 + final val SEQLITERAL = 184 + final val JSEQLITERAL = 185 + final val BIND = 186 + final val ALTERNATIVE = 187 + final val UNAPPLY = 188 + final val ANNOTATED = 189 + final val CASEDEF = 190 + final val IMPLICITarg = 191 + final val TEMPLATE = 192 + final val THIS = 193 + final val SUPER = 194 + final val CLASSconst = 195 + final val ENUMconst = 196 + final val SUPERtype = 197 + final val SKOLEMtype = 198 + final val REFINEDtype = 199 + final val APPLIEDtype = 200 + final val TYPEBOUNDS = 201 + final val TYPEALIAS = 202 + final val ANDtype = 203 + final val ORtype = 204 + final val BYNAMEtype = 205 + final val IMPLICITARG = 206 + + final val firstSimpleTreeTag = EMPTYTREE + final val firstNatTreeTag = SHARED + final val firstTreeNatTreeTag = SELECT + final val firstLengthTreeTag = PACKAGE +} |