Migrate generator/new_parser/ to core/parser/ (#228)

This change includes the following things:
  - Rename definition_info_map, definition_info with idl_type_map,
    idl_types
  - Sort IDL types matching with upstream (WebIDL2 parser) and add
    related links
  - Move generator/new_parser/ to core/parser/

ISSUE=#207

generator/index.ts → core/index.ts

@@ -14,18 +14,18 @@
  * limitations under the License.
  */
 
+import {IDLTypeMap} from 'core/parser/idl_type_map';
+import {DefinitionInfo} from 'core/parser/idl_types';
+import {Parser} from 'core/parser/parser';
 import * as file from 'generator/base/file';
-import {DefinitionInfo} from 'generator/new_parser/definition_info';
-import {DefinitionInfoMap} from 'generator/new_parser/definition_info_map';
-import {Parser} from 'generator/new_parser/parser';
 
 async function readAndParse(idlFilePath: string): Promise<void> {
   const idlFragment: string = await file.read(idlFilePath);
   const idlDefinitionInfos: DefinitionInfo[] = await Parser.parse(idlFragment);
-  DefinitionInfoMap.update(idlDefinitionInfos);
+  IDLTypeMap.update(idlDefinitionInfos);
 }
 
-async function buildDefinitionInfoMap(idlFilePaths: string[]): Promise<void> {
+async function buildIDLTypeMap(idlFilePaths: string[]): Promise<void> {
   const tasks: Promise<void>[] = [];
   idlFilePaths.forEach((idlFilePath) => {
     tasks.push(readAndParse(idlFilePath));
@@ -35,7 +35,7 @@ async function buildDefinitionInfoMap(idlFilePaths: string[]): Promise<void> {
 }
 
 export async function run(idlFilePaths: string[]): Promise<number> {
-  await buildDefinitionInfoMap(idlFilePaths);
+  await buildIDLTypeMap(idlFilePaths);
 
   return 0;
 }

generator/new_parser/definition_info_map.ts → core/parser/idl_type_map.ts

@@ -16,7 +16,7 @@
 
 import {
     DefinitionInfo, DictionaryInfo, EnumInfo, InterfaceInfo
-  } from 'generator/new_parser/definition_info';
+  } from 'core/parser/idl_types';
 
 interface DefinitionInfoStore {
   [index: string]: DefinitionInfo;
@@ -92,9 +92,9 @@ function updateDefinitionInfo(info: DefinitionInfo): void {
 }
 
 /**
- * Raw definition information mapping table (exposed to global scope)
+ * IDL Type information mapping table (exposed to global scope)
  */
-export class DefinitionInfoMap {
+export class IDLTypeMap {
   public static update(definitionInfos: DefinitionInfo[]): void {
     definitionInfos.forEach((info: DefinitionInfo) => {
       updateDefinitionInfo(info);

generator/new_parser/definition_info.ts → core/parser/idl_types.ts

@@ -14,6 +14,16 @@
  * limitations under the License.
  */
 
+/**
+ * IDL Definition Information
+ */
+export type DefinitionInfo = InterfaceInfo | DictionaryInfo | EnumInfo;
+
+/**
+ * IDL Type Information
+ *
+ * @see https://github.com/w3c/webidl2.js#idl-type
+ */
 export interface TypeInfo {
   readonly sequence: boolean;
   readonly generic?: string;
@@ -22,13 +32,11 @@ export interface TypeInfo {
   readonly union: boolean;
 }
 
-export interface ArgumentInfo {
-  readonly optional: boolean;
-  readonly variadic: boolean;
-  readonly idlType: TypeInfo;
-  readonly name: string;
-}
-
+/**
+ * IDL Interface Information
+ *
+ * @see https://github.com/w3c/webidl2.js#interface
+ */
 export interface InterfaceInfo {
   readonly type: 'interface';
   readonly name: string;
@@ -37,18 +45,18 @@ export interface InterfaceInfo {
   inheritance: string;
 }
 
-export interface OperationMemberInfo {
-  readonly type: 'operation';
-  readonly getter: boolean;
-  readonly setter: boolean;
-  readonly deleter: boolean;
-  readonly static: boolean;
-  readonly stringifier: boolean;
-  readonly idlType: TypeInfo;
-  readonly name: string;
-  readonly arguments: ArgumentInfo[];
-}
+/**
+ * IDL Interface Member Information
+ *
+ * @see https://github.com/w3c/webidl2.js#interface
+ */
+export type InterfaceMemberInfo = OperationMemberInfo;
 
+/**
+ * IDL Dictionary Information
+ *
+ * @see https://github.com/w3c/webidl2.js#dictionary
+ */
 export interface DictionaryInfo {
   readonly type: 'dictionary';
   readonly name: string;
@@ -57,6 +65,11 @@ export interface DictionaryInfo {
   inheritance: string;
 }
 
+/**
+ * IDL Dictionary Member Information
+ *
+ * @see @see https://github.com/w3c/webidl2.js#dictionary
+ */
 export interface DictionaryMemberInfo {
   readonly type: 'field';
   readonly name: string;
@@ -65,16 +78,52 @@ export interface DictionaryMemberInfo {
   readonly default: TypeValue;
 }
 
+/**
+ * IDL Enum Information
+ *
+ * @see https://github.com/w3c/webidl2.js#enum
+ */
 export interface EnumInfo {
   readonly type: 'enum';
   readonly name: string;
   readonly values: TypeValue[];
 }
 
+/**
+ * IDL Operation Member Information
+ *
+ * @see https://github.com/w3c/webidl2.js#enum
+ */
+export interface OperationMemberInfo {
+  readonly type: 'operation';
+  readonly getter: boolean;
+  readonly setter: boolean;
+  readonly deleter: boolean;
+  readonly static: boolean;
+  readonly stringifier: boolean;
+  readonly idlType: TypeInfo;
+  readonly name: string;
+  readonly arguments: ArgumentInfo[];
+}
+
+/**
+ * IDL Argument(e.g. for an operation) Information
+ *
+ * @see https://github.com/w3c/webidl2.js#arguments
+ */
+export interface ArgumentInfo {
+  readonly optional: boolean;
+  readonly variadic: boolean;
+  readonly idlType: TypeInfo;
+  readonly name: string;
+}
+
+/**
+ * IDL TypeValue Information
+ *
+ * @see https://github.com/w3c/webidl2.js#default-and-const-values
+ */
 export interface TypeValue {
   readonly type: string;
   readonly value: string;
 }
-
-export type InterfaceMemberInfo = OperationMemberInfo;
-export type DefinitionInfo = InterfaceInfo | DictionaryInfo | EnumInfo;

generator/new_parser/parser.ts → core/parser/parser.ts

@@ -14,8 +14,7 @@
  * limitations under the License.
  */
 
-import {DefinitionInfo} from 'generator/new_parser/definition_info';
-import {DefinitionInfoMap} from 'generator/new_parser/definition_info_map';
+import {DefinitionInfo} from 'core/parser/idl_types';
 import * as webidl from 'webidl2';
 
 /**

gulpfile.ts

@@ -15,7 +15,7 @@
  */
 
 import * as commandLineUsage from 'command-line-usage';
-import * as generator from 'generator';
+import * as core from 'core';
 import * as globs from 'globs';
 import * as gulp from 'gulp';
 import * as shell from 'gulp-shell';
@@ -61,7 +61,7 @@ gulp.task('default', () => {
  */
 gulp.task('build_webidl', (callback) => {
   globs(['examples/**/*.idl', 'test/**/*.idl'], async(error, files) => {
-    callback(await generator.run(files));
+    callback(await core.run(files));
   });
 });
 
@@ -138,9 +138,9 @@ gulp.task('lint_ts', () => {
 
   return gulp.src([
         'gulpfile.ts',
-        'generator/index.ts',
-        'generator/base/**/*.ts',
-        'generator/new_parser/**/*.ts'
+        'core/index.ts',
+        'core/parser/**/*.ts',
+        'generator/base/**/*.ts'
       ])
       .pipe(gulpTslint({
           formatter: 'codeFrame',