ts2famix 1.3.0 → 1.4.0

package/dist/famix_functions/EntityDictionary.js

@@ -0,0 +1,798 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityDictionary = void 0;
+const ts_morph_1 = require("ts-morph");
+const Famix = __importStar(require("../lib/famix/src/model/famix"));
+const analyze_1 = require("../analyze");
+const grapheme_splitter_1 = __importDefault(require("grapheme-splitter"));
+const Helpers = __importStar(require("./helpers_creation"));
+const FQNFunctions = __importStar(require("../fqn"));
+const famix_repository_1 = require("../lib/famix/src/famix_repository");
+const path_1 = __importDefault(require("path"));
+class EntityDictionary {
+    constructor() {
+        this.famixRep = new famix_repository_1.FamixRepository();
+        this.fmxAliasMap = new Map(); // Maps the alias names to their Famix model
+        this.fmxClassMap = new Map(); // Maps the fully qualified class 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.fmxTypeMap = new Map(); // Maps the type names to their Famix model
+        this.UNKNOWN_VALUE = '(unknown due to parsing error)'; // The value to use when a name is not usable
+        this.fmxElementObjectMap = new Map();
+        this.famixRep.setFmxElementObjectMap(this.fmxElementObjectMap);
+    }
+    /**
+     * Makes a Famix index file anchor
+     * @param sourceElement A source element
+     * @param famixElement The Famix model of the source element
+     */
+    makeFamixIndexFileAnchor(sourceElement, famixElement) {
+        analyze_1.logger.debug("making index file anchor for '" + (sourceElement === null || sourceElement === void 0 ? void 0 : sourceElement.getText()) + "' with famixElement " + famixElement.getJSON());
+        const fmxIndexFileAnchor = new Famix.IndexedFileAnchor();
+        fmxIndexFileAnchor.setElement(famixElement);
+        this.fmxElementObjectMap.set(famixElement, sourceElement);
+        if (sourceElement !== null) {
+            const absolutePathProject = this.famixRep.getAbsolutePath();
+            const absolutePath = path_1.default.normalize(sourceElement.getSourceFile().getFilePath());
+            const positionNodeModules = absolutePath.indexOf('node_modules');
+            let pathInProject = "";
+            if (positionNodeModules !== -1) {
+                const pathFromNodeModules = absolutePath.substring(positionNodeModules);
+                pathInProject = pathFromNodeModules;
+            }
+            else {
+                pathInProject = this.convertToRelativePath(absolutePath, absolutePathProject);
+            }
+            // revert any backslashes to forward slashes (path.normalize on windows introduces them)
+            pathInProject = pathInProject.replace(/\\/g, "/");
+            fmxIndexFileAnchor.setFileName(pathInProject);
+            let sourceStart, sourceEnd, sourceLineStart, sourceLineEnd;
+            if (!(sourceElement instanceof ts_morph_1.CommentRange)) {
+                sourceStart = sourceElement.getStart();
+                sourceEnd = sourceElement.getEnd();
+                sourceLineStart = sourceElement.getStartLineNumber();
+                sourceLineEnd = sourceElement.getEndLineNumber();
+            }
+            else {
+                sourceStart = sourceElement.getPos();
+                sourceEnd = sourceElement.getEnd();
+            }
+            if (analyze_1.config.expectGraphemes) {
+                /**
+                 * The following logic handles the case of multi-code point characters (e.g. emoji) in the source text.
+                 * This is needed because Pharo/Smalltalk treats multi-code point characters as a single character,
+                 * but JavaScript treats them as multiple characters. This means that the start and end positions
+                 * of a source element in Pharo/Smalltalk will be different than the start and end positions of the
+                 * same source element in JavaScript. This logic finds the start and end positions of the source
+                 * element in JavaScript and then uses those positions to set the start and end positions of the
+                 * Famix index file anchor.
+                 * It depends on code in the 'grapheme-splitter' package in npm.
+                 */
+                const splitter = new grapheme_splitter_1.default();
+                const sourceFileText = sourceElement.getSourceFile().getFullText();
+                const hasGraphemeClusters = splitter.countGraphemes(sourceFileText) > 1;
+                if (hasGraphemeClusters) {
+                    const sourceElementText = sourceFileText.substring(sourceStart, sourceEnd);
+                    const sourceElementTextGraphemes = splitter.splitGraphemes(sourceElementText);
+                    const sourceFileTextGraphemes = splitter.splitGraphemes(sourceFileText);
+                    const numberOfGraphemeClustersBeforeStart = splitter.countGraphemes(sourceFileText.substring(0, sourceStart));
+                    // find the start of the sourceElementTextGraphemes array in the sourceFileTextGraphemes array
+                    sourceStart = Helpers.indexOfSplitArray({ searchArray: sourceFileTextGraphemes,
+                        targetArray: sourceElementTextGraphemes,
+                        start: sourceStart - numberOfGraphemeClustersBeforeStart });
+                    sourceEnd = sourceStart + sourceElementTextGraphemes.length;
+                }
+            }
+            // note: the +1 is because the source anchor is 1-based, but ts-morph is 0-based
+            fmxIndexFileAnchor.setStartPos(sourceStart + 1);
+            fmxIndexFileAnchor.setEndPos(sourceEnd + 1);
+            if (!(sourceElement instanceof ts_morph_1.CommentRange)) {
+                fmxIndexFileAnchor.setStartLine(sourceLineStart);
+                fmxIndexFileAnchor.setEndLine(sourceLineEnd);
+            }
+            if (!(famixElement instanceof Famix.Association) && !(famixElement instanceof Famix.Comment) && !(sourceElement instanceof ts_morph_1.CommentRange) && !(sourceElement instanceof ts_morph_1.Identifier) && !(sourceElement instanceof ts_morph_1.ImportSpecifier) && !(sourceElement instanceof ts_morph_1.ExpressionWithTypeArguments)) {
+                famixElement.setFullyQualifiedName(FQNFunctions.getFQN(sourceElement));
+            }
+        }
+        else {
+            // sourceElement is null
+            analyze_1.logger.warn("sourceElement is null for famixElement " + famixElement.getJSON());
+            fmxIndexFileAnchor.setFileName("unknown");
+            fmxIndexFileAnchor.setStartPos(0);
+            fmxIndexFileAnchor.setEndPos(0);
+        }
+        this.famixRep.addElement(fmxIndexFileAnchor);
+    }
+    /**
+     * 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();
+            }
+            else {
+                fmxFile = new Famix.ScriptEntity();
+            }
+            fmxFile.setName(fileName);
+            fmxFile.setNumberOfLinesOfText(f.getEndLineNumber() - f.getStartLineNumber());
+            fmxFile.setNumberOfCharacters(f.getFullText().length);
+            this.makeFamixIndexFileAnchor(f, fmxFile);
+            this.fmxFileMap.set(fullyQualifiedFilename, fmxFile);
+            this.famixRep.addElement(fmxFile);
+        }
+        else {
+            fmxFile = this.fmxFileMap.get(fullyQualifiedFilename);
+        }
+        this.fmxElementObjectMap.set(fmxFile, f);
+        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();
+            fmxNamespace.setName(namespaceName);
+            this.makeFamixIndexFileAnchor(m, fmxNamespace);
+            this.fmxNamespaceMap.set(namespaceName, fmxNamespace);
+            this.famixRep.addElement(fmxNamespace);
+        }
+        else {
+            fmxNamespace = this.fmxNamespaceMap.get(namespaceName);
+        }
+        this.fmxElementObjectMap.set(fmxNamespace, m);
+        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(); // FQNFunctions.getFQN(a);
+        if (!this.fmxAliasMap.has(aliasFullyQualifiedName)) {
+            fmxAlias = new Famix.Alias();
+            fmxAlias.setName(a.getName());
+            const aliasNameWithGenerics = aliasName + (a.getTypeParameters().length ? ("<" + a.getTypeParameters().map(tp => tp.getName()).join(", ") + ">") : "");
+            analyze_1.logger.debug(`> NOTE: alias ${aliasName} has fully qualified name ${aliasFullyQualifiedName} and name with generics ${aliasNameWithGenerics}.`);
+            const fmxType = this.createOrGetFamixType(aliasNameWithGenerics, a);
+            fmxAlias.setAliasedEntity(fmxType);
+            this.makeFamixIndexFileAnchor(a, fmxAlias);
+            this.fmxAliasMap.set(aliasFullyQualifiedName, fmxAlias);
+            this.famixRep.addElement(fmxAlias);
+        }
+        else {
+            fmxAlias = this.fmxAliasMap.get(aliasFullyQualifiedName);
+        }
+        this.fmxElementObjectMap.set(fmxAlias, a);
+        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 = FQNFunctions.getFQN(cls);
+        const clsName = cls.getName();
+        if (!this.fmxClassMap.has(classFullyQualifiedName)) {
+            const isGeneric = cls.getTypeParameters().length;
+            if (isGeneric) {
+                fmxClass = new Famix.ParameterizableClass();
+            }
+            else {
+                fmxClass = new Famix.Class();
+            }
+            fmxClass.setName(clsName);
+            fmxClass.setFullyQualifiedName(classFullyQualifiedName);
+            fmxClass.setIsAbstract(isAbstract);
+            this.makeFamixIndexFileAnchor(cls, fmxClass);
+            this.fmxClassMap.set(classFullyQualifiedName, fmxClass);
+            this.famixRep.addElement(fmxClass);
+        }
+        else {
+            fmxClass = this.fmxClassMap.get(classFullyQualifiedName);
+        }
+        this.fmxElementObjectMap.set(fmxClass, cls);
+        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 = FQNFunctions.getFQN(inter);
+        if (!this.fmxInterfaceMap.has(interName)) {
+            const isGeneric = inter.getTypeParameters().length;
+            if (isGeneric) {
+                fmxInterface = new Famix.ParameterizableInterface();
+            }
+            else {
+                fmxInterface = new Famix.Interface();
+            }
+            fmxInterface.setName(interName);
+            this.makeFamixIndexFileAnchor(inter, fmxInterface);
+            this.fmxInterfaceMap.set(interFullyQualifiedName, fmxInterface);
+            this.famixRep.addElement(fmxInterface);
+        }
+        else {
+            fmxInterface = this.fmxInterfaceMap.get(interName);
+        }
+        this.fmxElementObjectMap.set(fmxInterface, inter);
+        return fmxInterface;
+    }
+    /**
+     * Creates a Famix property
+     * @param property A property
+     * @returns The Famix model of the property
+     */
+    createFamixProperty(property) {
+        const fmxProperty = new Famix.Property();
+        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) {
+            analyze_1.logger.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.makeFamixIndexFileAnchor(property, fmxProperty);
+        this.famixRep.addElement(fmxProperty);
+        this.fmxElementObjectMap.set(fmxProperty, property);
+        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();
+            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");
+            }
+            this.famixRep.addElement(fmxMethod);
+        }
+        else {
+            fmxMethod = new Famix.Method();
+            this.famixRep.addElement(fmxMethod);
+        }
+        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(Helpers.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) {
+            analyze_1.logger.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.makeFamixIndexFileAnchor(method, fmxMethod);
+        this.fmxElementObjectMap.set(fmxMethod, method);
+        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();
+        if (func.getName()) {
+            fmxFunction.setName(func.getName());
+        }
+        else {
+            fmxFunction.setName("anonymous");
+        }
+        fmxFunction.setSignature(Helpers.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) {
+            analyze_1.logger.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.makeFamixIndexFileAnchor(func, fmxFunction);
+        this.famixRep.addElement(fmxFunction);
+        this.fmxElementObjectMap.set(fmxFunction, func);
+        return fmxFunction;
+    }
+    /**
+     * Creates a Famix parameter
+     * @param param A parameter
+     * @returns The Famix model of the parameter
+     */
+    createFamixParameter(param) {
+        const fmxParam = new Famix.Parameter();
+        let paramTypeName = this.UNKNOWN_VALUE;
+        try {
+            paramTypeName = param.getType().getText().trim();
+        }
+        catch (error) {
+            analyze_1.logger.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.makeFamixIndexFileAnchor(param, fmxParam);
+        this.famixRep.addElement(fmxParam);
+        this.fmxElementObjectMap.set(fmxParam, param);
+        return fmxParam;
+    }
+    /**
+     * Creates a Famix type parameter
+     * @param tp A type parameter
+     * @returns The Famix model of the type parameter
+     */
+    createFamixParameterType(tp) {
+        const fmxParameterType = new Famix.ParameterType();
+        fmxParameterType.setName(tp.getName());
+        this.makeFamixIndexFileAnchor(tp, fmxParameterType);
+        this.famixRep.addElement(fmxParameterType);
+        this.fmxElementObjectMap.set(fmxParameterType, tp);
+        return fmxParameterType;
+    }
+    /**
+     * Creates a Famix variable
+     * @param variable A variable
+     * @returns The Famix model of the variable
+     */
+    createFamixVariable(variable) {
+        const fmxVariable = new Famix.Variable();
+        let variableTypeName = this.UNKNOWN_VALUE;
+        try {
+            variableTypeName = variable.getType().getText().trim();
+        }
+        catch (error) {
+            analyze_1.logger.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.makeFamixIndexFileAnchor(variable, fmxVariable);
+        this.famixRep.addElement(fmxVariable);
+        this.fmxElementObjectMap.set(fmxVariable, variable);
+        return fmxVariable;
+    }
+    /**
+     * Creates a Famix enum
+     * @param enumEntity An enum
+     * @returns The Famix model of the enum
+     */
+    createFamixEnum(enumEntity) {
+        const fmxEnum = new Famix.Enum();
+        fmxEnum.setName(enumEntity.getName());
+        this.makeFamixIndexFileAnchor(enumEntity, fmxEnum);
+        this.famixRep.addElement(fmxEnum);
+        this.fmxElementObjectMap.set(fmxEnum, enumEntity);
+        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();
+        let enumValueTypeName = this.UNKNOWN_VALUE;
+        try {
+            enumValueTypeName = enumMember.getType().getText().trim();
+        }
+        catch (error) {
+            analyze_1.logger.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.makeFamixIndexFileAnchor(enumMember, fmxEnumValue);
+        this.famixRep.addElement(fmxEnumValue);
+        this.fmxElementObjectMap.set(fmxEnumValue, enumMember);
+        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();
+        const decoratorName = "@" + decorator.getName();
+        const decoratorExpression = decorator.getText().substring(1);
+        fmxDecorator.setName(decoratorName);
+        fmxDecorator.setDecoratorExpression(decoratorExpression);
+        const decoratedEntityFullyQualifiedName = FQNFunctions.getFQN(decoratedEntity);
+        const fmxDecoratedEntity = this.famixRep.getFamixEntityByFullyQualifiedName(decoratedEntityFullyQualifiedName);
+        fmxDecorator.setDecoratedEntity(fmxDecoratedEntity);
+        this.makeFamixIndexFileAnchor(decorator, fmxDecorator);
+        this.famixRep.addElement(fmxDecorator);
+        this.fmxElementObjectMap.set(fmxDecorator, decorator);
+        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) {
+        analyze_1.logger.debug(`> NOTE: creating comment ${comment.getText()} in scope ${fmxScope.getName()}.`);
+        const fmxComment = new Famix.Comment();
+        fmxComment.setContainer(fmxScope); // adds comment to the container's comments collection
+        fmxComment.setIsJSDoc(isJSDoc);
+        this.makeFamixIndexFileAnchor(comment, fmxComment);
+        this.famixRep.addElement(fmxComment);
+        this.fmxElementObjectMap.set(fmxComment, comment);
+        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) {
+        let fmxType;
+        let isPrimitiveType = false;
+        let isParameterizedType = false;
+        analyze_1.logger.debug("Creating (or getting) type: '" + typeName + "' of element: " + (element === null || element === void 0 ? void 0 : element.getText()) + " of kind: " + (element === null || element === void 0 ? void 0 : element.getKindName()));
+        let ancestor;
+        if (element !== undefined) {
+            const typeAncestor = Helpers.findTypeAncestor(element);
+            const ancestorFullyQualifiedName = FQNFunctions.getFQN(typeAncestor);
+            ancestor = this.famixRep.getFamixEntityByFullyQualifiedName(ancestorFullyQualifiedName);
+            if (!ancestor) {
+                throw new Error(`Ancestor ${ancestorFullyQualifiedName} not found.`);
+            }
+        }
+        if (typeName === "number" || typeName === "string" || typeName === "boolean" || typeName === "bigint" || typeName === "symbol" || typeName === "undefined" || typeName === "null" || typeName === "any" || typeName === "unknown" || typeName === "never" || typeName === "void") {
+            isPrimitiveType = true;
+        }
+        if (!isPrimitiveType && typeName.includes("<") && typeName.includes(">") && !(typeName.includes("=>"))) {
+            isParameterizedType = true;
+        }
+        if (!this.fmxTypeMap.has(typeName)) {
+            if (isPrimitiveType) {
+                fmxType = new Famix.PrimitiveType();
+                fmxType.setIsStub(true);
+            }
+            else if (isParameterizedType) {
+                fmxType = new Famix.ParameterizedType();
+                const parameterTypeNames = typeName.substring(typeName.indexOf("<") + 1, typeName.indexOf(">")).split(",").map(s => s.trim());
+                const baseTypeName = typeName.substring(0, typeName.indexOf("<")).trim();
+                parameterTypeNames.forEach(parameterTypeName => {
+                    const fmxParameterType = this.createOrGetFamixType(parameterTypeName, element);
+                    fmxType.addArgument(fmxParameterType);
+                });
+                const fmxBaseType = this.createOrGetFamixType(baseTypeName, element);
+                fmxType.setBaseType(fmxBaseType);
+            }
+            else {
+                fmxType = new Famix.Type();
+            }
+            fmxType.setName(typeName);
+            fmxType.setContainer(ancestor);
+            this.makeFamixIndexFileAnchor(element, fmxType);
+            this.famixRep.addElement(fmxType);
+            this.fmxTypeMap.set(typeName, fmxType);
+        }
+        else {
+            fmxType = this.fmxTypeMap.get(typeName);
+        }
+        this.fmxElementObjectMap.set(fmxType, element);
+        return fmxType;
+    }
+    /**
+     * 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) {
+        const fmxVar = this.famixRep.getFamixEntityById(id);
+        const nodeReferenceAncestor = Helpers.findAncestor(node);
+        const ancestorFullyQualifiedName = FQNFunctions.getFQN(nodeReferenceAncestor);
+        const accessor = this.famixRep.getFamixEntityByFullyQualifiedName(ancestorFullyQualifiedName);
+        const fmxAccess = new Famix.Access();
+        fmxAccess.setAccessor(accessor);
+        fmxAccess.setVariable(fmxVar);
+        this.makeFamixIndexFileAnchor(node, fmxAccess);
+        this.famixRep.addElement(fmxAccess);
+        this.fmxElementObjectMap.set(fmxAccess, node);
+    }
+    /**
+     * 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) {
+        const fmxMethodOrFunction = this.famixRep.getFamixEntityById(id);
+        const nodeReferenceAncestor = Helpers.findAncestor(node);
+        const ancestorFullyQualifiedName = FQNFunctions.getFQN(nodeReferenceAncestor);
+        const sender = this.famixRep.getFamixEntityByFullyQualifiedName(ancestorFullyQualifiedName);
+        const receiverFullyQualifiedName = FQNFunctions.getFQN(m.getParent());
+        const receiver = this.famixRep.getFamixEntityByFullyQualifiedName(receiverFullyQualifiedName);
+        const fmxInvocation = new Famix.Invocation();
+        fmxInvocation.setSender(sender);
+        fmxInvocation.setReceiver(receiver);
+        fmxInvocation.addCandidate(fmxMethodOrFunction);
+        fmxInvocation.setSignature(fmxMethodOrFunction.getSignature());
+        this.makeFamixIndexFileAnchor(node, fmxInvocation);
+        this.famixRep.addElement(fmxInvocation);
+        this.fmxElementObjectMap.set(fmxInvocation, node);
+    }
+    /**
+     * Creates a Famix inheritance
+     * @param cls A class or an interface (subclass)
+     * @param inhClass The inherited class or interface (superclass)
+     */
+    createFamixInheritance(cls, inhClass) {
+        const fmxInheritance = new Famix.Inheritance();
+        // const clsName = cls.getName();
+        const classFullyQualifiedName = FQNFunctions.getFQN(cls);
+        analyze_1.logger.debug(`createFamixInheritance: classFullyQualifiedName: class fqn = ${classFullyQualifiedName}`);
+        let subClass;
+        if (cls instanceof ts_morph_1.ClassDeclaration) {
+            subClass = this.fmxClassMap.get(classFullyQualifiedName);
+        }
+        else {
+            subClass = this.fmxInterfaceMap.get(classFullyQualifiedName);
+        }
+        let inhClassName;
+        let inhClassFullyQualifiedName;
+        let superClass;
+        if (inhClass instanceof ts_morph_1.ClassDeclaration || inhClass instanceof ts_morph_1.InterfaceDeclaration) {
+            inhClassName = inhClass.getName();
+            inhClassFullyQualifiedName = FQNFunctions.getFQN(inhClass);
+            if (inhClass instanceof ts_morph_1.ClassDeclaration) {
+                superClass = this.fmxClassMap.get(inhClassFullyQualifiedName);
+            }
+            else {
+                superClass = this.fmxInterfaceMap.get(inhClassFullyQualifiedName);
+            }
+        }
+        else {
+            // inhClass is an ExpressionWithTypeArguments
+            inhClassName = inhClass.getExpression().getText();
+            // what is inhClassFullyQualifiedName? TODO
+            inhClassFullyQualifiedName = 'Undefined_Scope_from_importer.' + inhClassName;
+        }
+        if (superClass === undefined) {
+            if (inhClass instanceof ts_morph_1.ClassDeclaration) {
+                superClass = new Famix.Class();
+                this.fmxClassMap.set(inhClassFullyQualifiedName, superClass);
+            }
+            else {
+                superClass = new Famix.Interface();
+                this.fmxInterfaceMap.set(inhClassFullyQualifiedName, superClass);
+            }
+            this.fmxElementObjectMap.set(superClass, inhClass);
+            superClass.setName(inhClassName);
+            superClass.setFullyQualifiedName(inhClassFullyQualifiedName);
+            superClass.setIsStub(true);
+            this.makeFamixIndexFileAnchor(inhClass, superClass);
+            this.famixRep.addElement(superClass);
+        }
+        fmxInheritance.setSubclass(subClass);
+        fmxInheritance.setSuperclass(superClass);
+        this.makeFamixIndexFileAnchor(null, fmxInheritance);
+        this.famixRep.addElement(fmxInheritance);
+        this.fmxElementObjectMap.set(fmxInheritance, null);
+    }
+    /**
+     * Creates a Famix import clause
+     * @param importClauseInfo The information needed to create a Famix import clause
+     * @param importDeclaration The import declaration
+     * @param importer A source file which is a module
+     * @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(importClauseInfo) {
+        var _a, _b;
+        const { importDeclaration, importer, moduleSpecifierFilePath, importElement, isInExports, isDefaultExport } = importClauseInfo;
+        analyze_1.logger.debug(`createFamixImportClause: Creating import clause:`);
+        const fmxImportClause = new Famix.ImportClause();
+        let importedEntity;
+        let importedEntityName;
+        const absolutePathProject = this.famixRep.getAbsolutePath();
+        const absolutePath = path_1.default.normalize(moduleSpecifierFilePath);
+        // convert the path and remove any windows backslashes introduced by path.normalize
+        const pathInProject = this.convertToRelativePath(absolutePath, absolutePathProject).replace(/\\/g, "/");
+        let pathName = "{" + pathInProject + "}.";
+        // Named imports, e.g. import { ClassW } from "./complexExportModule";
+        if (importDeclaration instanceof ts_morph_1.ImportDeclaration
+            && importElement instanceof ts_morph_1.ImportSpecifier) {
+            importedEntityName = importElement.getName();
+            pathName = pathName + importedEntityName;
+            if (isInExports) {
+                importedEntity = this.famixRep.getFamixEntityByFullyQualifiedName(pathName);
+            }
+            if (importedEntity === undefined) {
+                importedEntity = new Famix.NamedEntity();
+                importedEntity.setName(importedEntityName);
+                if (!isInExports) {
+                    importedEntity.setIsStub(true);
+                }
+                this.makeFamixIndexFileAnchor(importElement, importedEntity);
+                importedEntity.setFullyQualifiedName(pathName);
+            }
+        }
+        // handle import equals declarations, e.g. import myModule = require("./complexExportModule");
+        // TypeScript can't determine the type of the imported module, so we create a Module entity
+        else if (importDeclaration instanceof ts_morph_1.ImportEqualsDeclaration) {
+            importedEntityName = importDeclaration === null || importDeclaration === void 0 ? void 0 : importDeclaration.getName();
+            pathName = pathName + importedEntityName;
+            importedEntity = new Famix.StructuralEntity();
+            importedEntity.setName(importedEntityName);
+            this.makeFamixIndexFileAnchor(importElement, importedEntity);
+            importedEntity.setFullyQualifiedName(pathName);
+            const anyType = this.createOrGetFamixType('any', undefined);
+            importedEntity.setDeclaredType(anyType);
+        }
+        else { // default imports, e.g. import ClassW from "./complexExportModule";  
+            importedEntityName = importElement.getText();
+            pathName = pathName + (isDefaultExport ? "defaultExport" : "namespaceExport");
+            importedEntity = new Famix.NamedEntity();
+            importedEntity.setName(importedEntityName);
+            this.makeFamixIndexFileAnchor(importElement, importedEntity);
+            importedEntity.setFullyQualifiedName(pathName);
+        }
+        this.famixRep.addElement(importedEntity);
+        const importerFullyQualifiedName = FQNFunctions.getFQN(importer);
+        const fmxImporter = this.famixRep.getFamixEntityByFullyQualifiedName(importerFullyQualifiedName);
+        fmxImportClause.setImportingEntity(fmxImporter);
+        fmxImportClause.setImportedEntity(importedEntity);
+        if (importDeclaration instanceof ts_morph_1.ImportEqualsDeclaration) {
+            fmxImportClause.setModuleSpecifier(importDeclaration === null || importDeclaration === void 0 ? void 0 : importDeclaration.getModuleReference().getText());
+        }
+        else {
+            fmxImportClause.setModuleSpecifier(importDeclaration === null || importDeclaration === void 0 ? void 0 : importDeclaration.getModuleSpecifierValue());
+        }
+        analyze_1.logger.debug(`createFamixImportClause: ${(_a = fmxImportClause.getImportedEntity()) === null || _a === void 0 ? void 0 : _a.getName()} (of type ${Helpers.getSubTypeName(fmxImportClause.getImportedEntity())}) is imported by ${(_b = fmxImportClause.getImportingEntity()) === null || _b === void 0 ? void 0 : _b.getName()}`);
+        // make an index file anchor for the import clause
+        this.makeFamixIndexFileAnchor(importDeclaration, fmxImportClause);
+        fmxImporter.addOutgoingImport(fmxImportClause);
+        this.famixRep.addElement(fmxImportClause);
+        this.fmxElementObjectMap.set(fmxImportClause, importDeclaration);
+    }
+    convertToRelativePath(absolutePath, absolutePathProject) {
+        return absolutePath.replace(absolutePathProject, "").slice(1);
+    }
+}
+exports.EntityDictionary = EntityDictionary;