refactor: rename ArraySpecialMember to ArrayVariable

Author: ashenBlade

resources/properties.schema.json

@@ -5,7 +5,7 @@
     "description": "Configuration for PostgreSQL Hacker Helper VS Code extension",
     "type": "object",
     "definitions": {
-        "arraySpecialMember": {
+        "array": {
             "type": "object",
             "required": [
                 "typeName",
@@ -194,7 +194,7 @@
             "type": "array",
             "description": "Special members that represent arrays - separate fields for array and it's length",
             "items": {
-                "$ref": "#/definitions/arraySpecialMember"
+                "$ref": "#/definitions/array"
             }
         },
         "aliases": {

src/configuration.ts

@@ -9,7 +9,7 @@ import { WorkspaceNotOpenedError } from './error';
 
 export interface VariablesConfiguration {
     /* Array special members */
-    arrays?: vars.ArraySpecialMemberInfo[];
+    arrays?: vars.ArrayVariableInfo[];
     /* Information about type aliases */
     aliases?: vars.AliasInfo[];
     /* Custom List types */
@@ -30,7 +30,7 @@ export interface FormatterConfiguration {
 
 /* Schema of configuration file */
 interface ConfigurationFile {
-    arrays: vars.ArraySpecialMemberInfo[] | undefined;
+    arrays: vars.ArrayVariableInfo[] | undefined;
     aliases: vars.AliasInfo[] | undefined;
     customListTypes: vars.ListPtrSpecialMemberInfo[] | undefined;
     htab: vars.HtabEntryInfo[] | undefined;
@@ -68,7 +68,7 @@ function normalizeFuncName(name: string) {
 };
 
 function parseConfiguration(contents: unknown): ConfigurationFile | undefined {
-    const parseArrayMember = (obj: unknown): vars.ArraySpecialMemberInfo | undefined => {
+    const parseArrayMember = (obj: unknown): vars.ArrayVariableInfo | undefined => {
         /* 
          * {
          *     "typeName": "parentType",

src/constants.ts

@@ -1,4 +1,4 @@
-import { ArraySpecialMemberInfo, BitmaskMemberInfo,
+import { ArrayVariableInfo, BitmaskMemberInfo,
          HtabEntryInfo,
          ListPtrSpecialMemberInfo,
          SimplehashEntryInfo,
@@ -1386,13 +1386,7 @@ export function getDefaultAliases(): [string, string][] {
     ] as [string, string][];
 }
 
-export interface ArraySpecialMember {
-    typeName: string;
-    memberName: string;
-    lengthExpr: string
-}
-
-export function getArraySpecialMembers(): ArraySpecialMemberInfo[] {
+export function getArrays(): ArrayVariableInfo[] {
     const _ = (typeName: string, memberName: string, lengthExpression: string) => ({
         typeName,
         memberName,

src/variables.ts

@@ -75,7 +75,7 @@ export class NodeVarRegistry {
     }
 }
 
-export interface ArraySpecialMemberInfo {
+export interface ArrayVariableInfo {
     /* Parent type containing pointer to array */
     typeName: string;
     /* Name of member which stores array */
@@ -138,7 +138,7 @@ export class SpecialMemberRegistry {
     /**
      * Double map: Type name -> (Member Name -> Info Object).
      */
-    arraySpecialMembers = new Map<string, Map<string, ArraySpecialMemberInfo>>();
+    arrays = new Map<string, Map<string, ArrayVariableInfo>>();
 
     /**
      * Double map: Member/variable name -> (Struct/Function name -> Info object).
@@ -156,11 +156,11 @@ export class SpecialMemberRegistry {
      */
     bitmasks = new Map<string, Map<string, BitmaskMemberInfo>>();
 
-    addArraySpecialMembers(elements: ArraySpecialMemberInfo[]) {
+    addArrays(elements: ArrayVariableInfo[]) {
         for (const element of elements) {
-            const typeMap = this.arraySpecialMembers.get(element.typeName);
+            const typeMap = this.arrays.get(element.typeName);
             if (typeMap === undefined) {
-                this.arraySpecialMembers.set(element.typeName, new Map([
+                this.arrays.set(element.typeName, new Map([
                     [element.memberName, element],
                 ]));
             } else {
@@ -192,9 +192,9 @@ export class SpecialMemberRegistry {
         }
     }
 
-    getArraySpecialMember(parentType: string, memberName: string) {
+    getArray(parentType: string, memberName: string) {
         const parentTypeName = dbg.getStructNameFromType(parentType);
-        const membersMap = this.arraySpecialMembers.get(parentTypeName);
+        const membersMap = this.arrays.get(parentTypeName);
         if (membersMap === undefined) {
             return;
         }
@@ -1243,9 +1243,9 @@ export abstract class Variable {
                 if (parent) {
                     /* FLA can be expanded as array */
                     const specialMember = context.specialMemberRegistry
-                        .getArraySpecialMember(parent.type, debugVariable.name);
+                        .getArray(parent.type, debugVariable.name);
                     if (specialMember) {
-                        return new ArraySpecialMember(specialMember, args);
+                        return new ArrayVariable(specialMember, args);
                     }
                 }
 
@@ -1310,9 +1310,9 @@ export abstract class Variable {
          */
         if (parent) {
             const specialMember = context.specialMemberRegistry
-                .getArraySpecialMember(parent.type, debugVariable.name);
+                .getArray(parent.type, debugVariable.name);
             if (specialMember) {
-                return new ArraySpecialMember(specialMember, args);
+                return new ArrayVariable(specialMember, args);
             }
         }
 
@@ -1746,7 +1746,7 @@ export class RealVariable extends Variable {
         }
 
         if (prop.isFlexibleArray()) {
-            /* Flexible array is expandable only if it is a ArraySpecialMember */
+            /* Flexible array is expandable only if it is a ArrayVariable */
             return false;
         }
 
@@ -1976,7 +1976,7 @@ export class RealVariable extends Variable {
                     return `((${this.parent.type})${this.parent.getPointer()})[${index}]`;
                 }
             }
-        } else if (this.parent instanceof ArraySpecialMember) {
+        } else if (this.parent instanceof ArrayVariable) {
             if (this.getTypeProperties().pointerCanDeref()) {
                 return `(${this.type})${this.getPointer()}`;
             } else {
@@ -4385,16 +4385,16 @@ export class ListNodeVariable extends NodeVariable {
 }
 
 
-class ArraySpecialMember extends RealVariable {
+class ArrayVariable extends RealVariable {
     /**
      * Expression to evaluate to obtain array length.
      * Appended to target struct from right.
      * First element is length member name, but after
      * can be correction expressions i.e. '+ 1'.
      */
-    info: ArraySpecialMemberInfo;
+    info: ArrayVariableInfo;
 
-    constructor(info: ArraySpecialMemberInfo, args: RealVariableArgs) {
+    constructor(info: ArrayVariableInfo, args: RealVariableArgs) {
         super(args);
         this.info = info;
     }
@@ -4873,7 +4873,7 @@ class BitmapSetSpecialMember extends NodeVariable {
                 if (members && index < members.length) {
                     return members[index];
                 }
-            } else if (field instanceof ArraySpecialMember) {
+            } else if (field instanceof ArrayVariable) {
                 const members = await field.getChildren();
                 if (members && index < members.length) {
                     return members[index];
@@ -5877,7 +5877,7 @@ export class PgVariablesViewProvider implements vscode.TreeDataProvider<Variable
         if (config.arrays?.length) {
             logger.debug('adding', config.arrays.length, 'arrays from config file');
             try {
-                specialMembers.addArraySpecialMembers(config.arrays);
+                specialMembers.addArrays(config.arrays);
             } catch (err) {
                 logger.error(err, 'could not add custom array special members');
             }
@@ -5999,7 +5999,7 @@ export class PgVariablesViewProvider implements vscode.TreeDataProvider<Variable
 
     async createExecContext(pgversion: number | undefined): Promise<ExecContextData> {
         const specialMembers = new SpecialMemberRegistry();
-        specialMembers.addArraySpecialMembers(constants.getArraySpecialMembers());
+        specialMembers.addArrays(constants.getArrays());
         specialMembers.addListCustomPtrSpecialMembers(constants.getKnownCustomListPtrs());
 
         const hashTables = new HashTableTypes();