DearMQL5/Core/UIdStack.mqh
Alex David Hernandez Maturrano 78e7ae5145 feat: initial release of DearMQL5 v1.0.0 - Immediate-Mode GUI Engine for MetaTrader 5
DearMQL5 is an institutional-grade, immediate-mode graphical user interface
(GUI) engine designed from the ground up for MetaTrader 5 (MQL5), inspired by
the ergonomics and performance of Dear ImGui.

### Core Architecture & Execution Pipeline
- Immediate-Mode Paradigm: Declarative frame-based rendering pipeline with zero
  memory allocation churn during render loops and deterministic execution.
- Modular Per-Hub Canvas Surfaces (CUWindowSurface): Replaces full-screen canvas
  overlays with isolated, window-bounded CCanvas bitmaps, reducing memory usage
  by up to 93% (~570 KB vs 8.3 MB for 1080p) and preventing click-swallowing.
- 0-Cost Hardware Texture Drag Engine: Absolute-anchor drag mechanics update
  native MT5 OBJPROP_XDISTANCE and OBJPROP_YDISTANCE properties directly on
  the compositor, bypassing CPU rasterization completely (0.00% CPU usage).
- Chart Scroll Protection: Automatically suppresses chart history sliding
  (CHART_MOUSE_SCROLL) during active HUD dragging and safely restores it on release.
- Two-Phase Hit-Testing: Interactive controls (buttons, sliders, toggles) receive
  first-priority click focus, cleanly separating widget actions from window drags.

### Subsystems & Components
- Core State & Input (Core/):
  * UInputState: Mouse/keyboard tracking, deltas, and chart scroll lock.
  * UState: Retained state hash map in pure MQL5 with 64-bit FNV-1a hashing.
  * UIdStack: Hierarchical identifier scoping preventing widget ID collisions.
  * ULayout: Automatic cursor placement supporting SameLine, Indent, and Unindent.
  * UEventQueue: Non-blocking circular UI event queue for decoupled handling.
  * UTheme: Institutional OneDark/Nord dark color palette and typography metrics.
- Rendering Backends (Render/):
  * URendererCanvas: Isolated per-hub surfaces with 32-bit ARGB alpha transparency.
  * URendererNative: Native MT5 object pool (OBJ_RECTANGLE_LABEL) with diff caching.
  * UFont: Anti-aliased font metrics and width cache.
- Complete Widget Suite (Widgets/):
  * UButton: Click-on-release standard, accent, and emergency panic buttons.
  * UToggle: Smooth draggable/clickable iOS-style toggle switches.
  * USlider: Draggable horizontal float and integer sliders.
  * UProgressBar: Adaptive progress bars with dynamic green->amber->red color ramps.
  * UHeader: Collapsible section headers with immediate-mode state retention.
  * ULabel & USeparator: Formatted text, colored metrics, and horizontal dividers.
- Window Management (Windows/):
  * UWindow: Window container with titlebar, collapse toggle, and coordinate clipping.
  * UWindowManager: Multi-window coordinator with GlobalVariable persistence across
    chart timeframe changes and backward-compatible key resolution.

### Tooling, Documentation & Reference Implementation
- Examples/EA_DearMQL5_Demo.mq5: Complete reference Prop-Firm cockpit HUD.
- README.md: Comprehensive institutional English documentation for GitHub and Algo Forge.
- Docs/ARCHITECTURE.md: Technical architecture specification with Mermaid lifecycle.
2026-10-12 08:35:18 -03:00

73 lines
2.2 KiB
MQL5

//+------------------------------------------------------------------+
//| UIdStack.mqh |
//| Copyright 2026, DearMQL5 GUI Engine |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2026, DearMQL5 GUI Engine"
#property link "https://www.mql5.com"
#property strict
/// Hierarchical ID hashing stack for state retention and unambiguous widget identity.
class UIdStack
{
private:
static ulong s_stack[];
static int s_stack_size;
/// 64-bit FNV-1a string hashing algorithm.
static ulong HashString(const string str, const ulong seed = 0xcbf29ce484222325)
{
ulong hash = seed;
int len = StringLen(str);
for(int i = 0; i < len; i++)
{
hash ^= (ulong)StringGetCharacter(str, i);
hash *= 0x100000001b3;
}
return(hash);
}
public:
/// Resets the ID stack to baseline at the beginning of each frame.
static void Reset(void)
{
s_stack_size = 0;
if(ArraySize(s_stack) < 16)
ArrayResize(s_stack, 16);
}
/// Pushes a string namespace onto the ID stack.
static void Push(const string str_id)
{
ulong parent_hash = (s_stack_size > 0) ? s_stack[s_stack_size - 1] : 0xcbf29ce484222325;
ulong current_hash = HashString(str_id, parent_hash);
if(s_stack_size >= ArraySize(s_stack))
ArrayResize(s_stack, s_stack_size + 16);
s_stack[s_stack_size++] = current_hash;
}
/// Pushes an integer index onto the ID stack.
static void PushInt(const int int_id)
{
Push(IntegerToString(int_id));
}
/// Pops the topmost namespace from the ID stack.
static void Pop(void)
{
if(s_stack_size > 0)
s_stack_size--;
}
/// Computes the qualified unique ID hash for a widget label within current scope.
static ulong GetId(const string label)
{
ulong parent_hash = (s_stack_size > 0) ? s_stack[s_stack_size - 1] : 0xcbf29ce484222325;
return(HashString(label, parent_hash));
}
};
ulong UIdStack::s_stack[];
int UIdStack::s_stack_size = 0;