ts2famix 1.0.13 → 1.0.14

package/dist/famix_functions/famix_functions.js

@@ -0,0 +1,520 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FamixFunctions = void 0;
+const ts_morph_1 = require("ts-morph");
+const Famix = __importStar(require("../lib/famix/src/model/famix"));
+const famix_repository_1 = require("../lib/famix/src/famix_repository");
+const fqn_1 = require("../fqn");
+const famix_functions_index_1 = require("./famix_functions_index");
+const famix_functions_associations_1 = require("./famix_functions_associations");
+const famix_functions_types_1 = require("./famix_functions_types");
+/**
+ * This class contains all the functions needed to create Famix entities
+ */
+class FamixFunctions {
+    constructor() {
+        this.famixRep = new famix_repository_1.FamixRepository(); // The Famix repository
+        this.FQNFunctions = new fqn_1.FQNFunctions(); // The fully qualified name functions
+        this.fmxAliasMap = new Map(); // Maps the alias names to their Famix model
+        this.fmxClassMap = new Map(); // Maps the fully qualifiedclass names to their Famix model
+        this.fmxInterfaceMap = new Map(); // Maps the interface names to their Famix model
+        this.fmxNamespaceMap = new Map(); // Maps the namespace names to their Famix model
+        this.fmxFileMap = new Map(); // Maps the source file names to their Famix model
+        this.famixFunctionsIndex = new famix_functions_index_1.FamixFunctionsIndex(this.famixRep); // FamixFunctionsIndex object, it contains all the functions needed to create Famix index file anchors
+        this.famixFunctionsAssociations = new famix_functions_associations_1.FamixFunctionsAssociations(this.famixRep, this.fmxClassMap, this.fmxInterfaceMap); // FamixFunctionsAssociations object, it contains all the functions needed to create Famix associations
+        this.famixFunctionsTypes = new famix_functions_types_1.FamixFunctionsTypes(this.famixRep); // FamixFunctionsTypes object, it contains all the functions needed to create Famix types
+        this.UNKNOWN_VALUE = '(unknown due to parsing error)'; // The value to use when a name is not usable
+    }
+    /**
+     * Gets the Famix repository
+     * @returns The Famix repository
+     */
+    getFamixRepository() {
+        return this.famixRep;
+    }
+    /**
+     * Creates or gets a Famix script entity or module
+     * @param f A source file
+     * @param isModule A boolean indicating if the source file is a module
+     * @returns The Famix model of the source file
+     */
+    createOrGetFamixFile(f, isModule) {
+        let fmxFile;
+        const fileName = f.getBaseName();
+        const fullyQualifiedFilename = f.getFilePath();
+        if (!this.fmxFileMap.has(fullyQualifiedFilename)) {
+            if (isModule) {
+                fmxFile = new Famix.Module(this.famixRep);
+            }
+            else {
+                fmxFile = new Famix.ScriptEntity(this.famixRep);
+            }
+            fmxFile.setName(fileName);
+            fmxFile.setNumberOfLinesOfText(f.getEndLineNumber() - f.getStartLineNumber());
+            fmxFile.setNumberOfCharacters(f.getFullText().length);
+            this.famixFunctionsIndex.makeFamixIndexFileAnchor(f, fmxFile);
+            this.fmxFileMap.set(fullyQualifiedFilename, fmxFile);
+        }
+        else {
+            fmxFile = this.fmxFileMap.get(fullyQualifiedFilename);
+        }
+        return fmxFile;
+    }
+    /**
+     * Creates or gets a Famix namespace
+     * @param m A namespace
+     * @returns The Famix model of the namespace
+     */
+    createOrGetFamixNamespace(m) {
+        let fmxNamespace;
+        const namespaceName = m.getName();
+        if (!this.fmxNamespaceMap.has(namespaceName)) {
+            fmxNamespace = new Famix.Namespace(this.famixRep);
+            fmxNamespace.setName(namespaceName);
+            this.famixFunctionsIndex.makeFamixIndexFileAnchor(m, fmxNamespace);
+            this.fmxNamespaceMap.set(namespaceName, fmxNamespace);
+        }
+        else {
+            fmxNamespace = this.fmxNamespaceMap.get(namespaceName);
+        }
+        return fmxNamespace;
+    }
+    /**
+     * Creates a Famix alias
+     * @param a An alias
+     * @returns The Famix model of the alias
+     */
+    createFamixAlias(a) {
+        let fmxAlias;
+        const aliasName = a.getName();
+        const aliasFullyQualifiedName = a.getType().getText(); // this.FQNFunctions.getFQN(a);
+        if (!this.fmxAliasMap.has(aliasFullyQualifiedName)) {
+            fmxAlias = new Famix.Alias(this.famixRep);
+            fmxAlias.setName(a.getName());
+            const aliasNameWithGenerics = aliasName + (a.getTypeParameters().length ? ("<" + a.getTypeParameters().map(tp => tp.getName()).join(", ") + ">") : "");
+            console.info(`> NOTE: alias ${aliasName} has fully qualified name ${aliasFullyQualifiedName} and name with generics ${aliasNameWithGenerics}.`);
+            const fmxType = this.createOrGetFamixType(aliasNameWithGenerics, a);
+            fmxAlias.setAliasedEntity(fmxType);
+            this.famixFunctionsIndex.makeFamixIndexFileAnchor(a, fmxAlias);
+            this.fmxAliasMap.set(aliasFullyQualifiedName, fmxAlias);
+        }
+        else {
+            fmxAlias = this.fmxAliasMap.get(aliasFullyQualifiedName);
+        }
+        return fmxAlias;
+    }
+    /**
+     * Creates or gets a Famix class or parameterizable class
+     * @param cls A class
+     * @returns The Famix model of the class
+     */
+    createOrGetFamixClass(cls) {
+        let fmxClass;
+        const isAbstract = cls.isAbstract();
+        const classFullyQualifiedName = this.FQNFunctions.getFQN(cls);
+        const clsName = cls.getName();
+        if (!this.fmxClassMap.has(classFullyQualifiedName)) {
+            const isGeneric = cls.getTypeParameters().length;
+            if (isGeneric) {
+                fmxClass = new Famix.ParameterizableClass(this.famixRep);
+            }
+            else {
+                fmxClass = new Famix.Class(this.famixRep);
+            }
+            fmxClass.setName(clsName);
+            fmxClass.setFullyQualifiedName(classFullyQualifiedName);
+            fmxClass.setIsAbstract(isAbstract);
+            this.famixFunctionsIndex.makeFamixIndexFileAnchor(cls, fmxClass);
+            this.fmxClassMap.set(classFullyQualifiedName, fmxClass);
+        }
+        else {
+            fmxClass = this.fmxClassMap.get(classFullyQualifiedName);
+        }
+        return fmxClass;
+    }
+    /**
+     * Creates or gets a Famix interface or parameterizable interface
+     * @param inter An interface
+     * @returns The Famix model of the interface
+     */
+    createOrGetFamixInterface(inter) {
+        let fmxInterface;
+        const interName = inter.getName();
+        const interFullyQualifiedName = this.FQNFunctions.getFQN(inter);
+        if (!this.fmxInterfaceMap.has(interName)) {
+            const isGeneric = inter.getTypeParameters().length;
+            if (isGeneric) {
+                fmxInterface = new Famix.ParameterizableInterface(this.famixRep);
+            }
+            else {
+                fmxInterface = new Famix.Interface(this.famixRep);
+            }
+            fmxInterface.setName(interName);
+            this.famixFunctionsIndex.makeFamixIndexFileAnchor(inter, fmxInterface);
+            this.fmxInterfaceMap.set(interFullyQualifiedName, fmxInterface);
+        }
+        else {
+            fmxInterface = this.fmxInterfaceMap.get(interName);
+        }
+        return fmxInterface;
+    }
+    /**
+     * Creates a Famix property
+     * @param property A property
+     * @returns The Famix model of the property
+     */
+    createFamixProperty(property) {
+        const fmxProperty = new Famix.Property(this.famixRep);
+        const isSignature = property instanceof ts_morph_1.PropertySignature;
+        fmxProperty.setName(property.getName());
+        let propTypeName = this.UNKNOWN_VALUE;
+        try {
+            propTypeName = property.getType().getText().trim();
+        }
+        catch (error) {
+            console.error(`> WARNING: got exception ${error}. Failed to get usable name for property: ${property.getName()}. Continuing...`);
+        }
+        const fmxType = this.createOrGetFamixType(propTypeName, property);
+        fmxProperty.setDeclaredType(fmxType);
+        property.getModifiers().forEach(m => fmxProperty.addModifier(m.getText()));
+        if (!isSignature && property.getExclamationTokenNode()) {
+            fmxProperty.addModifier("!");
+        }
+        if (property.getQuestionTokenNode()) {
+            fmxProperty.addModifier("?");
+        }
+        if (property.getName().substring(0, 1) === "#") {
+            fmxProperty.addModifier("#");
+        }
+        if (fmxProperty.getModifiers().has("static")) {
+            fmxProperty.setIsClassSide(true);
+        }
+        else {
+            fmxProperty.setIsClassSide(false);
+        }
+        this.famixFunctionsIndex.makeFamixIndexFileAnchor(property, fmxProperty);
+        return fmxProperty;
+    }
+    /**
+     * Creates a Famix method or accessor
+     * @param method A method or an accessor
+     * @param currentCC The cyclomatic complexity metrics of the current source file
+     * @returns The Famix model of the method or the accessor
+     */
+    createFamixMethod(method, currentCC) {
+        let fmxMethod;
+        if (method instanceof ts_morph_1.GetAccessorDeclaration || method instanceof ts_morph_1.SetAccessorDeclaration) {
+            fmxMethod = new Famix.Accessor(this.famixRep);
+            const isGetter = method instanceof ts_morph_1.GetAccessorDeclaration;
+            const isSetter = method instanceof ts_morph_1.SetAccessorDeclaration;
+            if (isGetter) {
+                fmxMethod.setKind("getter");
+            }
+            if (isSetter) {
+                fmxMethod.setKind("setter");
+            }
+        }
+        else {
+            fmxMethod = new Famix.Method(this.famixRep);
+        }
+        const isConstructor = method instanceof ts_morph_1.ConstructorDeclaration;
+        const isSignature = method instanceof ts_morph_1.MethodSignature;
+        const isGeneric = method.getTypeParameters().length > 0;
+        fmxMethod.setIsGeneric(isGeneric);
+        let isAbstract = false;
+        let isStatic = false;
+        if (method instanceof ts_morph_1.MethodDeclaration || method instanceof ts_morph_1.GetAccessorDeclaration || method instanceof ts_morph_1.SetAccessorDeclaration) {
+            isAbstract = method.isAbstract();
+            isStatic = method.isStatic();
+        }
+        if (isConstructor) {
+            fmxMethod.setKind("constructor");
+        }
+        fmxMethod.setIsAbstract(isAbstract);
+        fmxMethod.setIsClassSide(isStatic);
+        fmxMethod.setIsPrivate((method instanceof ts_morph_1.MethodDeclaration || method instanceof ts_morph_1.GetAccessorDeclaration || method instanceof ts_morph_1.SetAccessorDeclaration) ? (method.getModifiers().find(x => x.getText() === 'private')) !== undefined : false);
+        fmxMethod.setIsProtected((method instanceof ts_morph_1.MethodDeclaration || method instanceof ts_morph_1.GetAccessorDeclaration || method instanceof ts_morph_1.SetAccessorDeclaration) ? (method.getModifiers().find(x => x.getText() === 'protected')) !== undefined : false);
+        fmxMethod.setSignature(this.computeSignature(method.getText()));
+        let methodName;
+        if (isConstructor) {
+            methodName = "constructor";
+        }
+        else {
+            methodName = method.getName();
+        }
+        fmxMethod.setName(methodName);
+        if (!isConstructor) {
+            if (method.getName().substring(0, 1) === "#") {
+                fmxMethod.setIsPrivate(true);
+            }
+        }
+        if (!fmxMethod.getIsPrivate() && !fmxMethod.getIsProtected()) {
+            fmxMethod.setIsPublic(true);
+        }
+        else {
+            fmxMethod.setIsPublic(false);
+        }
+        if (!isSignature) {
+            fmxMethod.setCyclomaticComplexity(currentCC[fmxMethod.getName()]);
+        }
+        else {
+            fmxMethod.setCyclomaticComplexity(0);
+        }
+        let methodTypeName = this.UNKNOWN_VALUE;
+        try {
+            methodTypeName = method.getReturnType().getText().trim();
+        }
+        catch (error) {
+            console.error(`> WARNING: got exception ${error}. Failed to get usable name for return type of method: ${fmxMethod.getName()}. Continuing...`);
+        }
+        const fmxType = this.createOrGetFamixType(methodTypeName, method);
+        fmxMethod.setDeclaredType(fmxType);
+        fmxMethod.setNumberOfLinesOfCode(method.getEndLineNumber() - method.getStartLineNumber());
+        const parameters = method.getParameters();
+        fmxMethod.setNumberOfParameters(parameters.length);
+        if (!isSignature) {
+            fmxMethod.setNumberOfStatements(method.getStatements().length);
+        }
+        else {
+            fmxMethod.setNumberOfStatements(0);
+        }
+        this.famixFunctionsIndex.makeFamixIndexFileAnchor(method, fmxMethod);
+        return fmxMethod;
+    }
+    /**
+     * Creates a Famix function
+     * @param func A function
+     * @param currentCC The cyclomatic complexity metrics of the current source file
+     * @returns The Famix model of the function
+     */
+    createFamixFunction(func, currentCC) {
+        const fmxFunction = new Famix.Function(this.famixRep);
+        if (func.getName()) {
+            fmxFunction.setName(func.getName());
+        }
+        else {
+            fmxFunction.setName("anonymous");
+        }
+        fmxFunction.setSignature(this.computeSignature(func.getText()));
+        fmxFunction.setCyclomaticComplexity(currentCC[fmxFunction.getName()]);
+        const isGeneric = func.getTypeParameters().length > 0;
+        fmxFunction.setIsGeneric(isGeneric);
+        let functionTypeName = this.UNKNOWN_VALUE;
+        try {
+            functionTypeName = func.getReturnType().getText().trim();
+        }
+        catch (error) {
+            console.error(`> WARNING: got exception ${error}. Failed to get usable name for return type of function: ${func.getName()}. Continuing...`);
+        }
+        const fmxType = this.createOrGetFamixType(functionTypeName, func);
+        fmxFunction.setDeclaredType(fmxType);
+        fmxFunction.setNumberOfLinesOfCode(func.getEndLineNumber() - func.getStartLineNumber());
+        const parameters = func.getParameters();
+        fmxFunction.setNumberOfParameters(parameters.length);
+        fmxFunction.setNumberOfStatements(func.getStatements().length);
+        this.famixFunctionsIndex.makeFamixIndexFileAnchor(func, fmxFunction);
+        return fmxFunction;
+    }
+    /**
+     * Creates a Famix parameter
+     * @param param A parameter
+     * @returns The Famix model of the parameter
+     */
+    createFamixParameter(param) {
+        const fmxParam = new Famix.Parameter(this.famixRep);
+        let paramTypeName = this.UNKNOWN_VALUE;
+        try {
+            paramTypeName = param.getType().getText().trim();
+        }
+        catch (error) {
+            console.error(`> WARNING: got exception ${error}. Failed to get usable name for parameter: ${param.getName()}. Continuing...`);
+        }
+        const fmxType = this.createOrGetFamixType(paramTypeName, param);
+        fmxParam.setDeclaredType(fmxType);
+        fmxParam.setName(param.getName());
+        this.famixFunctionsIndex.makeFamixIndexFileAnchor(param, fmxParam);
+        return fmxParam;
+    }
+    /**
+     * Creates a Famix type parameter
+     * @param tp A type parameter
+     * @returns The Famix model of the type parameter
+     */
+    createFamixTypeParameter(tp) {
+        const fmxTypeParameter = new Famix.TypeParameter(this.famixRep);
+        fmxTypeParameter.setName(tp.getName());
+        this.famixFunctionsIndex.makeFamixIndexFileAnchor(tp, fmxTypeParameter);
+        return fmxTypeParameter;
+    }
+    /**
+     * Creates a Famix variable
+     * @param variable A variable
+     * @returns The Famix model of the variable
+     */
+    createFamixVariable(variable) {
+        const fmxVariable = new Famix.Variable(this.famixRep);
+        let variableTypeName = this.UNKNOWN_VALUE;
+        try {
+            variableTypeName = variable.getType().getText().trim();
+        }
+        catch (error) {
+            console.error(`> WARNING: got exception ${error}. Failed to get usable name for variable: ${variable.getName()}. Continuing...`);
+        }
+        const fmxType = this.createOrGetFamixType(variableTypeName, variable);
+        fmxVariable.setDeclaredType(fmxType);
+        fmxVariable.setName(variable.getName());
+        this.famixFunctionsIndex.makeFamixIndexFileAnchor(variable, fmxVariable);
+        return fmxVariable;
+    }
+    /**
+     * Creates a Famix enum
+     * @param enumEntity An enum
+     * @returns The Famix model of the enum
+     */
+    createFamixEnum(enumEntity) {
+        const fmxEnum = new Famix.Enum(this.famixRep);
+        fmxEnum.setName(enumEntity.getName());
+        this.famixFunctionsIndex.makeFamixIndexFileAnchor(enumEntity, fmxEnum);
+        return fmxEnum;
+    }
+    /**
+     * Creates a Famix enum value
+     * @param enumMember An enum member
+     * @returns The Famix model of the enum member
+     */
+    createFamixEnumValue(enumMember) {
+        const fmxEnumValue = new Famix.EnumValue(this.famixRep);
+        let enumValueTypeName = this.UNKNOWN_VALUE;
+        try {
+            enumValueTypeName = enumMember.getType().getText().trim();
+        }
+        catch (error) {
+            console.error(`> WARNING: got exception ${error}. Failed to get usable name for enum value: ${enumMember.getName()}. Continuing...`);
+        }
+        const fmxType = this.createOrGetFamixType(enumValueTypeName, enumMember);
+        fmxEnumValue.setDeclaredType(fmxType);
+        fmxEnumValue.setName(enumMember.getName());
+        this.famixFunctionsIndex.makeFamixIndexFileAnchor(enumMember, fmxEnumValue);
+        return fmxEnumValue;
+    }
+    /**
+     * Creates or gets a Famix decorator
+     * @param decorator A decorator
+     * @param decoratedEntity A class, a method, a parameter or a property
+     * @returns The Famix model of the decorator
+     */
+    createOrGetFamixDecorator(decorator, decoratedEntity) {
+        const fmxDecorator = new Famix.Decorator(this.famixRep);
+        const decoratorName = "@" + decorator.getName();
+        const decoratorExpression = decorator.getText().substring(1);
+        fmxDecorator.setName(decoratorName);
+        fmxDecorator.setDecoratorExpression(decoratorExpression);
+        const decoratedEntityFullyQualifiedName = this.FQNFunctions.getFQN(decoratedEntity);
+        const fmxDecoratedEntity = this.getFamixEntityByFullyQualifiedName(decoratedEntityFullyQualifiedName);
+        fmxDecorator.setDecoratedEntity(fmxDecoratedEntity);
+        this.famixFunctionsIndex.makeFamixIndexFileAnchor(decorator, fmxDecorator);
+        return fmxDecorator;
+    }
+    /**
+     * Creates a Famix comment
+     * @param comment A comment
+     * @param fmxScope The Famix model of the comment's container
+     * @param isJSDoc A boolean indicating if the comment is a JSDoc
+     * @returns The Famix model of the comment
+     */
+    createFamixComment(comment, fmxScope, isJSDoc) {
+        const fmxComment = new Famix.Comment(this.famixRep);
+        fmxComment.setContent(comment.getText());
+        fmxComment.setContainer(fmxScope);
+        fmxComment.setIsJSDoc(isJSDoc);
+        this.famixFunctionsIndex.makeFamixIndexFileAnchor(comment, fmxComment);
+        return fmxComment;
+    }
+    /**
+     * Creates or gets a Famix type
+     * @param typeName A type name
+     * @param element A ts-morph element
+     * @returns The Famix model of the type
+     */
+    createOrGetFamixType(typeName, element) {
+        return this.famixFunctionsTypes.createOrGetFamixType(typeName, element);
+    }
+    /**
+     * Creates a Famix access
+     * @param node A node
+     * @param id An id of a parameter, a variable, a property or an enum member
+     */
+    createFamixAccess(node, id) {
+        this.famixFunctionsAssociations.createFamixAccess(node, id);
+    }
+    /**
+     * Creates a Famix invocation
+     * @param node A node
+     * @param m A method or a function
+     * @param id The id of the method or the function
+     */
+    createFamixInvocation(node, m, id) {
+        this.famixFunctionsAssociations.createFamixInvocation(node, m, id);
+    }
+    /**
+     * Creates a Famix inheritance
+     * @param cls A class or an interface (subclass)
+     * @param inhClass The inherited class or interface (superclass)
+     */
+    createFamixInheritance(cls, inhClass) {
+        this.famixFunctionsAssociations.createFamixInheritance(cls, inhClass);
+    }
+    /**
+     * Creates a Famix import clause
+     * @param importer A source file which is a module
+     * @param moduleSpecifier The name of the module where the export declaration is
+     * @param moduleSpecifierFilePath The path of the module where the export declaration is
+     * @param importElement The imported entity
+     * @param isInExports A boolean indicating if the imported entity is in the exports
+     * @param isDefaultExport A boolean indicating if the imported entity is a default export
+     */
+    createFamixImportClause(importer, moduleSpecifier, moduleSpecifierFilePath, importElement, isInExports, isDefaultExport) {
+        this.famixFunctionsAssociations.createFamixImportClause(importer, moduleSpecifier, moduleSpecifierFilePath, importElement, isInExports, isDefaultExport);
+    }
+    /**
+     * Gets a Famix entity by fully qualified name
+     * @param fullyQualifiedName A fully qualified name
+     * @returns The Famix entity corresponding to the fully qualified name
+     */
+    getFamixEntityByFullyQualifiedName(fullyQualifiedName) {
+        return this.famixRep.getFamixEntityByFullyQualifiedName(fullyQualifiedName);
+    }
+    /**
+     * Gets the signature of a method or a function
+     * @param text A method or a function source code
+     * @returns The signature of the method or the function
+     */
+    computeSignature(text) {
+        const endSignatureText = text.indexOf("{");
+        return text.substring(0, endSignatureText).trim();
+    }
+}
+exports.FamixFunctions = FamixFunctions;