AutotileConstants.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorLayoutApi/GapKeys.h>
#include <QLatin1String>
#include <QMetaType>
#include <limits>
 
namespace PhosphorTiles {
 
namespace AutotileDefaults {
// Default values used by tiling primitives when no setting is supplied.
// The application config layer surfaces these as the user-facing defaults
// (see ConfigDefaults::autotile{SplitRatio,MasterCount,MaxWindows} in
// src/config/configdefaults.h, which delegate here).
constexpr qreal DefaultSplitRatio = 0.5; 
constexpr int DefaultMasterCount = 1; 
constexpr int DefaultMaxWindows = 5; 
constexpr int ScriptedDefaultMaxWindows = 6;
inline constexpr QLatin1String DefaultAlgorithmId{"bsp"}; 
constexpr qreal DefaultSplitRatioStep = 0.05;
constexpr qreal MinSplitRatioStep = 0.01;
constexpr qreal MaxSplitRatioStep = 0.25;
 
constexpr qreal MinSplitRatio = 0.1;
constexpr qreal MaxSplitRatio = 0.9;
constexpr int MinMasterCount = 1;
constexpr int MaxMasterCount = 5;
constexpr int DefaultInnerGap = 8;
constexpr int DefaultOuterGap = 8;
constexpr int MinGap = 0;
constexpr int MaxGap = 50;
constexpr int MinRectSizePx = 50;
constexpr int GapEdgeThresholdPx = 5;
constexpr int ResizeEdgeMoveThresholdPx = 5;
constexpr int MinMaxWindows = 1;
constexpr int MaxMaxWindows = 12;
// Sentinel returned by PerScreenConfigResolver::effectiveMaxWindows() when the
// user has selected AutotileOverflowBehavior::Unlimited. INT_MAX/2 — not
// INT_MAX — so any caller that does `effectiveMaxWindows(...) + 1` (e.g.
// growth-headroom calculations) can't overflow.
constexpr int UnlimitedMaxWindowsSentinel = std::numeric_limits<int>::max() / 2;
constexpr int MaxZones = 256;
constexpr int MaxRuntimeTreeDepth = 50; 
// Bounds for the opaque per-algorithm script-state bag (TilingState::scriptState).
// Enforced by TilingState::sanitizeScriptState at every script write-back, so a
// buggy or hostile algorithm can't bloat the bag or stall the code that walks it.
// A whole bag exceeding the byte cap is dropped (reset to empty). The bag is
// within-session only — nothing writes it to disk — so this is the sole boundary.
constexpr int ScriptStateMaxBytes = 64 * 1024; 
constexpr int ScriptStateMaxDepth = 16; 
constexpr int ScriptStateMaxKeys = 4096; 
constexpr qreal SplitRatioHysteresis = 0.05; 
constexpr int MinMetadataWindows = 1;
constexpr int MaxMetadataWindows = 100;
constexpr qint64 MaxScriptSizeBytes = 1024 * 1024;
inline constexpr QLatin1String ScriptIdPrefix{"script:"};
constexpr int MinInsertPosition = 0;
constexpr int MaxInsertPosition = 2;
// Bounds for AutotileOverflowBehavior (Float=0 .. Unlimited=1), defined below.
// Kept in lockstep with that enum so a per-screen override clamp has a named
// range like MinInsertPosition/MaxInsertPosition rather than a bare literal.
constexpr int MinOverflowBehavior = 0;
constexpr int MaxOverflowBehavior = 1;
// Animation duration + stagger limits previously lived here for
// historical reasons but are NOT autotile-specific — they bound every
// animation in the system. Moved to
// libs/phosphor-animation/include/PhosphorAnimation/AnimationLimits.h
// (PhosphorAnimation::Limits namespace). Consumers that need them
// should include that header directly; ConfigDefaults already does.
constexpr int ScriptWatchdogTimeoutMs = 100;
 
constexpr bool isNumericMetaType(int typeId)
{
    return typeId == QMetaType::Double || typeId == QMetaType::Float || typeId == QMetaType::Int
        || typeId == QMetaType::UInt || typeId == QMetaType::LongLong || typeId == QMetaType::ULongLong;
}
} // namespace AutotileDefaults
 
namespace AutotileJsonKeys {
// Per-algorithm layout keys
inline constexpr QLatin1String MasterCount{"masterCount"};
inline constexpr QLatin1String SplitRatio{"splitRatio"};
inline constexpr QLatin1String SplitRatioStep{"splitRatioStep"};
inline constexpr QLatin1String CustomParams{"customParams"};
 
// AutotileConfig keys
inline constexpr QLatin1String PerAlgorithmSettings{"perAlgorithmSettings"};
inline constexpr QLatin1String AlgorithmId{"algorithmId"};
inline constexpr QLatin1String InnerGap{"innerGap"};
inline constexpr QLatin1String OuterGap{"outerGap"};
 
// Per-side outer-gap keys — canonical definition in phosphor-layout-api's
// GapKeys.h (shared with phosphor-zones ZoneJsonKeys). Re-exported here so
// AutotileJsonKeys callers can keep their fully-qualified references
// unchanged while both libraries consume a single source of truth.
using PhosphorLayout::GapKeys::OuterGapBottom; 
using PhosphorLayout::GapKeys::OuterGapLeft; 
using PhosphorLayout::GapKeys::OuterGapRight; 
using PhosphorLayout::GapKeys::OuterGapTop; 
using PhosphorLayout::GapKeys::UsePerSideOuterGap; 
 
inline constexpr QLatin1String SmartGaps{"smartGaps"};
inline constexpr QLatin1String FocusNewWindows{"focusNewWindows"};
inline constexpr QLatin1String FocusFollowsMouse{"focusFollowsMouse"};
inline constexpr QLatin1String InsertPosition{"insertPosition"};
inline constexpr QLatin1String RespectMinimumSize{"respectMinimumSize"};
inline constexpr QLatin1String MaxWindows{"maxWindows"};
inline constexpr QLatin1String OverflowBehavior{"overflowBehavior"};
} // namespace AutotileJsonKeys
 
namespace AutotileJsonValues {
// OverflowBehavior values
inline constexpr QLatin1String OverflowFloat{"float"};
inline constexpr QLatin1String OverflowUnlimited{"unlimited"};
// InsertPosition values
inline constexpr QLatin1String InsertEnd{"end"};
inline constexpr QLatin1String InsertAfterFocused{"afterFocused"};
inline constexpr QLatin1String InsertAsMaster{"asMaster"};
} // namespace AutotileJsonValues
 
enum class AutotileOverflowBehavior {
    Float = 0,
    Unlimited = 1
};
 
enum class AutotileInsertPosition {
    End = 0,
    AfterFocused = 1,
    AsMaster = 2
};
 
enum class AutotileDragBehavior {
    Float = 0,
    Reorder = 1
};
 
} // namespace PhosphorTiles