feat: button local variables

companion/lib/Controls/ControlTypes/Button/Base.ts

@@ -74,7 +74,8 @@ export abstract class ButtonControlBase<TJson, TOptions extends Record<string, a
 			{
 				controlId,
 				commitChange: this.commitChange.bind(this),
-				triggerRedraw: this.triggerRedraw.bind(this),
+				invalidateControl: this.triggerRedraw.bind(this),
+				localVariablesChanged: this.#onLocalVariablesChanged.bind(this),
 				instanceDefinitions: deps.instance.definitions,
 				internalModule: deps.internalModule,
 				moduleHost: deps.instance.moduleHost,
@@ -207,6 +208,15 @@ export abstract class ButtonControlBase<TJson, TOptions extends Record<string, a
 		return result
 	}
 
+	#onLocalVariablesChanged(allChangedVariables: Set<string>): void {
+		// Trigger the change after a short debounce, just in case we end up in an infinite loop
+		setImmediate(() => {
+			this.deps.variables.values.emit('local_variables_changed', allChangedVariables, this.controlId)
+		})
+	}
+
+	abstract onVariablesChanged(allChangedVariables: Set<string>): void
+
 	/**
 	 * Update an option field of this control
 	 */

companion/lib/Controls/ControlTypes/Button/Normal.ts

@@ -13,8 +13,8 @@ import type { ButtonStyleProperties, DrawStyleButtonModel } from '@companion-app
 import type { ControlDependencies } from '../../ControlDependencies.js'
 import { EntityModelType } from '@companion-app/shared/Model/EntityModel.js'
 import type { ControlActionSetAndStepsManager } from '../../Entities/ControlActionSetAndStepsManager.js'
-import type { CompanionVariableValues } from '@companion-module/base'
 import { GetButtonBitmapSize } from '../../../Resources/Util.js'
+import { CompanionVariableValues } from '@companion-module/base'
 
 /**
  * Class for the stepped button control.
@@ -132,21 +132,23 @@ export class ControlButtonNormal
 
 		if (style.text) {
 			// Block out the button text
-			const injectedVariableValues: CompanionVariableValues = {}
+			const overrideVariableValues: CompanionVariableValues = {}
+
 			const location = this.deps.page.getLocationOfControlId(this.controlId)
 			if (location) {
 				// Ensure we don't enter into an infinite loop
-				// TODO - legacy location variables?
-				injectedVariableValues[`$(internal:b_text_${location.pageNumber}_${location.row}_${location.column})`] = '$RE'
+				overrideVariableValues[`$(internal:b_text_${location.pageNumber}_${location.row}_${location.column})`] = '$RE'
 			}
 
+			// Setup the parser
+			const parser = this.deps.variables.values.createVariablesAndExpressionParser(
+				location,
+				this.entities.getLocalVariableEntities(),
+				overrideVariableValues
+			)
+
 			if (style.textExpression) {
-				const parseResult = this.deps.variables.values.executeExpression(
-					style.text,
-					location,
-					undefined,
-					injectedVariableValues
-				)
+				const parseResult = parser.executeExpression(style.text, undefined)
 				if (parseResult.ok) {
 					style.text = parseResult.value + ''
 				} else {
@@ -155,9 +157,9 @@ export class ControlButtonNormal
 				}
 				this.#last_draw_variables = parseResult.variableIds.size > 0 ? parseResult.variableIds : null
 			} else {
-				const parseResult = this.deps.variables.values.parseVariables(style.text, location, injectedVariableValues)
+				const parseResult = parser.parseVariables(style.text)
 				style.text = parseResult.text
-				this.#last_draw_variables = parseResult.variableIds.length > 0 ? new Set(parseResult.variableIds) : null
+				this.#last_draw_variables = parseResult.variableIds.size > 0 ? parseResult.variableIds : null
 			}
 		}
 
@@ -218,6 +220,7 @@ export class ControlButtonNormal
 	 * @param allChangedVariables - variables with changes
 	 */
 	onVariablesChanged(allChangedVariables: Set<string>): void {
+		// console.log('change', allChangedVariables)
 		if (this.#last_draw_variables) {
 			for (const variable of allChangedVariables.values()) {
 				if (this.#last_draw_variables.has(variable)) {
@@ -276,6 +279,7 @@ export class ControlButtonNormal
 			options: this.options,
 			feedbacks: this.entities.getFeedbackEntities(),
 			steps: this.entities.asNormalButtonSteps(),
+			localVariables: this.entities.getLocalVariableEntities().map((ent) => ent.asEntityModel(true)),
 		}
 
 		return clone ? cloneDeep(obj) : obj

companion/lib/Controls/ControlTypes/Triggers/Events/Variable.ts

@@ -39,6 +39,11 @@ export class TriggersEventVariables {
 	 */
 	readonly #eventBus: TriggerEvents
 
+	/**
+	 * The control id of the parent trigger
+	 */
+	readonly #controlId: string
+
 	/**
 	 * Execute the actions of the parent trigger
 	 */
@@ -62,6 +67,7 @@ export class TriggersEventVariables {
 		this.#logger = LogController.createLogger(`Controls/Triggers/Events/Timer/${controlId}`)
 
 		this.#eventBus = eventBus
+		this.#controlId = controlId
 		this.#executeActions = executeActions
 
 		this.#eventBus.on('variables_changed', this.#onVariablesChanged)
@@ -85,7 +91,10 @@ export class TriggersEventVariables {
 	 * Handler for the variable_changed event
 	 * @param allChangedVariables Set of all the variables that have changed
 	 */
-	#onVariablesChanged = (allChangedVariables: Set<string>): void => {
+	#onVariablesChanged = (allChangedVariables: Set<string>, fromControlId: string | null): void => {
+		// If the event is from a control, but not the same control, ignore it
+		if (fromControlId && fromControlId !== this.#controlId) return
+
 		if (this.#enabled) {
 			let execute = false
 

companion/lib/Controls/ControlTypes/Triggers/Trigger.ts

@@ -151,7 +151,8 @@ export class ControlTrigger
 		this.entities = new ControlEntityListPoolTrigger({
 			controlId,
 			commitChange: this.commitChange.bind(this),
-			triggerRedraw: this.triggerRedraw.bind(this),
+			invalidateControl: this.triggerRedraw.bind(this),
+			localVariablesChanged: null,
 			instanceDefinitions: deps.instance.definitions,
 			internalModule: deps.internalModule,
 			moduleHost: deps.instance.moduleHost,

companion/lib/Controls/Controller.ts

@@ -25,6 +25,8 @@ import type { ControlLocation } from '@companion-app/shared/Model/Common.js'
 import { EventEmitter } from 'events'
 import type { ControlCommonEvents, ControlDependencies } from './ControlDependencies.js'
 import { TriggerExecutionSource } from './ControlTypes/Triggers/TriggerExecutionSource.js'
+import { CompanionVariableValues } from '@companion-module/base'
+import { VariablesAndExpressionParser } from '../Variables/VariablesAndExpressionParser.js'
 
 export const TriggersListRoom = 'triggers:list'
 const ActiveLearnRoom = 'learn:active'
@@ -428,6 +430,24 @@ export class ControlsController extends CoreBase {
 			return control.entities.entitySetInverted(entityLocation, id, isInverted)
 		})
 
+		client.onPromise('controls:entity:set-variable-name', (controlId, entityLocation, id, name) => {
+			const control = this.getControl(controlId)
+			if (!control) return false
+
+			if (!control.supportsEntities) throw new Error(`Control "${controlId}" does not support entities`)
+
+			return control.entities.entitySetVariableName(entityLocation, id, name)
+		})
+
+		client.onPromise('controls:entity:set-variable-value', (controlId, entityLocation, id, value) => {
+			const control = this.getControl(controlId)
+			if (!control) return false
+
+			if (!control.supportsEntities) throw new Error(`Control "${controlId}" does not support entities`)
+
+			return control.entities.entitySetVariableValue(entityLocation, id, value)
+		})
+
 		client.onPromise(
 			'controls:entity:move',
 			(controlId, moveEntityLocation, moveEntityId, newOwnerId, newEntityLocation, newIndex) => {
@@ -792,6 +812,15 @@ export class ControlsController extends CoreBase {
 		client.onPromise('controls:unsubscribe:learn', async () => {
 			client.leave(ActiveLearnRoom)
 		})
+
+		client.onPromise('controls:local-variables-values', (controlId) => {
+			const control = this.getControl(controlId)
+			if (!control) return {}
+
+			if (!control.supportsEntities) throw new Error(`Control "${controlId}" does not support entities`)
+
+			return control.entities.getLocalVariableValues()
+		})
 	}
 
 	/**
@@ -955,12 +984,15 @@ export class ControlsController extends CoreBase {
 	/**
 	 * Propagate variable changes to the controls
 	 */
-	onVariablesChanged(allChangedVariablesSet: Set<string>): void {
+	onVariablesChanged(allChangedVariablesSet: Set<string>, fromControlId: string | null): void {
 		// Inform triggers of the change
-		this.triggers.emit('variables_changed', allChangedVariablesSet)
+		this.triggers.emit('variables_changed', allChangedVariablesSet, fromControlId)
 
 		if (allChangedVariablesSet.size > 0) {
 			for (const control of this.#controls.values()) {
+				// If the changes are local variables and from another control, ignore them
+				if (fromControlId && fromControlId !== control.controlId) continue
+
 				if (control.supportsStyle) {
 					control.onVariablesChanged(allChangedVariablesSet)
 				}
@@ -1137,6 +1169,22 @@ export class ControlsController extends CoreBase {
 			control.entities.verifyConnectionIds(knownConnectionIds)
 		}
 	}
+
+	createVariablesAndExpressionParser(
+		controlLocation: ControlLocation | null | undefined,
+		overrideVariableValues: CompanionVariableValues | null
+	): VariablesAndExpressionParser {
+		const controlId = controlLocation && this.page.getControlIdAt(controlLocation)
+		const control = controlId && this.getControl(controlId)
+
+		const variableEntities = control && control.supportsEntities ? control.entities.getLocalVariableEntities() : []
+
+		return this.variablesController.values.createVariablesAndExpressionParser(
+			controlLocation,
+			variableEntities,
+			overrideVariableValues
+		)
+	}
 }
 
 export interface NewFeedbackValue {