src/declaration-node/sourceFileElementsAssemply.ts

/*
 * Copyright (c) 2023 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import {
  isClassDeclaration, isEnumDeclaration, isExportAssignment, isExportDeclaration, isFunctionDeclaration,
  isImportDeclaration, isInterfaceDeclaration, isModuleDeclaration, isTypeAliasDeclaration, isVariableStatement,
  SyntaxKind
} from 'typescript';
import type { Node, SourceFile, ClassDeclaration, FunctionDeclaration } from 'typescript';
import { getClassDeclaration } from './classDeclaration';
import type { ClassEntity } from './classDeclaration';
import { getEnumDeclaration } from './enumDeclaration';
import type { EnumEntity } from './enumDeclaration';
import { getFunctionDeclaration } from './functionDeclaration';
import type { FunctionEntity } from './functionDeclaration';
import { getExportAssignment, getImportDeclaration } from './importAndExportDeclaration';
import type { ImportElementEntity } from './importAndExportDeclaration';
import { getInterfaceDeclaration } from './interfaceDeclaration';
import type { InterfaceEntity } from './interfaceDeclaration';
import type { StaticMethodEntity } from './methodDeclaration';
import { getModuleDeclaration } from './moduleDeclaration';
import type { ModuleBlockEntity } from './moduleDeclaration';
import { getTypeAliasDeclaration } from './typeAliasDeclaration';
import type { TypeAliasEntity } from './typeAliasDeclaration';
import { getVariableStatementDeclaration } from './variableStatementResolve';
import type { StatementEntity } from './variableStatementResolve';

interface SubstepClassParams {
  node: ClassDeclaration,
  sourceFile: SourceFile,
  classDeclarations: Array<ClassEntity>,
  staticMethods: Array<Array<StaticMethodEntity>>,
}

interface SubstepFuntionParams {
  node: FunctionDeclaration,
  sourceFile: SourceFile,
  functionDeclarations: Map<string, Array<FunctionEntity>>
}

export interface SourceFileEntity {
  importDeclarations: Array<ImportElementEntity>,
  moduleDeclarations: Array<ModuleBlockEntity>,
  typeAliasDeclarations: Array<TypeAliasEntity>,
  classDeclarations: Array<ClassEntity>,
  interfaceDeclarations: Array<InterfaceEntity>,
  enumDeclarations: Array<EnumEntity>,
  exportAssignment: Array<string>,
  staticMethods: Array<Array<StaticMethodEntity>>,
  exportDeclarations: Array<string>,
  functionDeclarations: Map<string, Array<FunctionEntity>>
}

/**
 * assembly all sourceFile node info
 * @param sourceFile
 * @param fileName
 * @returns
 */
export function getSourceFileAssembly(sourceFile: SourceFile, fileName: string): SourceFileEntity {
  const importDeclarations: Array<ImportElementEntity> = [];
  const moduleDeclarations: Array<ModuleBlockEntity> = [];
  const typeAliasDeclarations: Array<TypeAliasEntity> = [];
  let classDeclarations: Array<ClassEntity> = [];
  const interfaceDeclarations: Array<InterfaceEntity> = [];
  const enumDeclarations: Array<EnumEntity> = [];
  let exportAssignment: Array<string> = [];
  let staticMethods: Array<Array<StaticMethodEntity>> = [];
  const exportDeclarations: Array<string> = [];
  let functionDeclarations: Map<string, Array<FunctionEntity>> = new Map<string, Array<FunctionEntity>>();
  sourceFile.forEachChild(node => {
    if (isImportDeclaration(node)) {
      importDeclarations.push(getImportDeclaration(node, sourceFile));
    } else if (isModuleDeclaration(node)) {
      moduleDeclarations.push(getModuleDeclaration(node, sourceFile, fileName));
    } else if (isTypeAliasDeclaration(node)) {
      typeAliasDeclarations.push(getTypeAliasDeclaration(node, sourceFile));
    } else if (isClassDeclaration(node)) {
      const substepClassBack = substepClass({ node, sourceFile, classDeclarations, staticMethods });
      classDeclarations = substepClassBack.classDeclarations;
      staticMethods = substepClassBack.staticMethods;
    } else if (isInterfaceDeclaration(node)) {
      interfaceDeclarations.push(getInterfaceDeclaration(node, sourceFile));
    } else if (isExportAssignment(node)) {
      exportAssignment = getExportAssignment(node, sourceFile);
    } else if (isEnumDeclaration(node)) {
      enumDeclarations.push(getEnumDeclaration(node, sourceFile));
    } else if (isExportDeclaration(node)) {
      exportDeclarations.push(sourceFile.text.substring(node.pos, node.end).trimStart().trimEnd());
    } else if (isFunctionDeclaration(node)) {
      const classParams = substepFunction({ node, sourceFile, functionDeclarations });
      functionDeclarations = classParams.functionDeclarations;
    } else {
      substepConsole(node, fileName);
    }
  });
  return {
    importDeclarations,
    moduleDeclarations,
    typeAliasDeclarations,
    classDeclarations,
    interfaceDeclarations,
    enumDeclarations,
    exportAssignment,
    staticMethods,
    exportDeclarations,
    functionDeclarations
  };
}

/**
 * get default export class
 * @param sourceFile
 * @returns
 */
export function getDefaultExportClassDeclaration(sourceFile: SourceFile): Array<ClassEntity> {
  const defaultExportClass: Array<ClassEntity> = [];
  sourceFile.forEachChild(node => {
    if (isClassDeclaration(node)) {
      defaultExportClass.push(getClassDeclaration(node, sourceFile));
    }
  });
  return defaultExportClass;
}

/**
 * get sourceFile const variable statement
 * @param sourceFile
 * @returns
 */
export function getSourceFileVariableStatements(sourceFile: SourceFile): Array<Array<StatementEntity>> {
  const variableStatements: Array<Array<StatementEntity>> = [];
  sourceFile.forEachChild(node => {
    if (isVariableStatement(node)) {
      variableStatements.push(getVariableStatementDeclaration(node, sourceFile));
    }
  });
  return variableStatements;
}

/**
 * get sourcefile functions
 * @param sourceFile
 * @returns
 */
export function getSourceFileFunctions(sourceFile: SourceFile): Map<string, Array<FunctionEntity>> {
  const functionDeclarations: Map<string, Array<FunctionEntity>> = new Map<string, Array<FunctionEntity>>();
  sourceFile.forEachChild(node => {
    if (isFunctionDeclaration(node)) {
      const functionEntity = getFunctionDeclaration(node, sourceFile);
      if (functionDeclarations.get(functionEntity.functionName) !== undefined) {
        functionDeclarations.get(functionEntity.functionName)?.push(functionEntity);
      } else {
        const functionArray: Array<FunctionEntity> = [];
        functionArray.push(functionEntity);
        functionDeclarations.set(functionEntity.functionName, functionArray);
      }
    }
  });
  return functionDeclarations;
}

/**
 * assembly some sourceFile node info
 * @param substepClassParams
 * @returns
 */
function substepClass(substepClassParams: SubstepClassParams): SubstepClassParams {
  let isDefaultExportClass = false;
  if (substepClassParams.node.modifiers !== undefined) {
    substepClassParams.node.modifiers.forEach(value => {
      if (value.kind === SyntaxKind.DefaultKeyword) {
        isDefaultExportClass = true;
      }
    });
  }
  if (isDefaultExportClass) {
    const classDeclarationEntity = getClassDeclaration(substepClassParams.node, substepClassParams.sourceFile);
    substepClassParams.classDeclarations.push(classDeclarationEntity);
    if (classDeclarationEntity.staticMethods.length > 0) {
      substepClassParams.staticMethods.push(classDeclarationEntity.staticMethods);
    }
  }
  return substepClassParams;
}

/**
 * assembly some sourceFile node info
 * @param substepClassParams
 * @returns
 */
function substepFunction(substepClassParams: SubstepFuntionParams): SubstepFuntionParams {
  const functionEntity = getFunctionDeclaration(substepClassParams.node, substepClassParams.sourceFile);
  if (substepClassParams.functionDeclarations.get(functionEntity.functionName) !== undefined) {
    substepClassParams.functionDeclarations.get(functionEntity.functionName)?.push(functionEntity);
  } else {
    const functionArray: Array<FunctionEntity> = [];
    functionArray.push(functionEntity);
    substepClassParams.functionDeclarations.set(functionEntity.functionName, functionArray);
  }
  return substepClassParams;
}

/**
 * assembly some sourceFile node info
 * @param substepClassParams
 * @returns
 */
function substepConsole(node: Node, fileName: string):void {
  if (node.kind !== SyntaxKind.EndOfFileToken && !isFunctionDeclaration(node) && !isVariableStatement(node)) {
    console.log('--------------------------- uncaught sourceFile type start -----------------------');
    console.log('fileName: ' + fileName);
    console.log(node);
    console.log('--------------------------- uncaught sourceFile type end -----------------------');
  }
  return;
}