Add full IO support for every global ProPresenter library file plus theme folders, and extend the existing Labels/Macros readers with exporters and editable accessors so every supported document is now a round-trippable, mutable object. New library readers/writers (each: FileReader, FileWriter, Library wrapper, element wrapper where applicable, CLI tool, tests, doc/api/*.md): - Groups (ProGroupsDocument) + GroupDefinition - ClearGroups (ClearGroupsDocument) + ClearGroupDefinition - CCLI (CCLIDocument) - Messages (MessageDocument) + Message - Timers (TimersDocument + Clock) + Timer - Stage (Stage.Document) + StageLayout - Workspace (ProPresenterWorkspace) + Screen - Props (PropDocument) + Prop - TestPatterns (TestPatternDocument) - Calendar (new CalendarDocument) + CalendarEvent - KeyMappings (new KeyMappingsDocument) + KeyMapping - CommunicationDevices (JSON file) + CommunicationDevice - Theme bundles (Template.Document folder + Assets/) + ThemeBundle/Slide/Asset Extensions to existing modules: - LabelsFileWriter; Label and LabelLibrary gain setters, addLabel, removeLabel, setColor / setColorHex helpers - MacrosFileWriter; Macro/MacroCollection/MacroLibrary gain UUID, name, color, image_type, image_data, trigger_on_startup setters plus add/remove for macros and collections Two new minimal proto schemas were defined for documents that lacked upstream definitions: - proto/calendar.proto - CalendarDocument with Event entries, raw bytes for the action/macro sub-messages so the schema can evolve - proto/keyMappings.proto - KeyMappingsDocument with ApplicationInfo and a forward-looking Mapping message (sample only carries the info) The Theme file turned out to be a regular Rv\Data\Template\Document, so no new proto was required for theme content; ThemeBundle layers folder + Assets/ handling on top in the same spirit as PresentationBundle. GroupDefinition is intentionally distinct from the existing Group class (which wraps song-level CueGroup) to avoid breaking song APIs. Verified with the full PHPUnit suite: 370 tests, 9200 assertions, all green; LSP diagnostics clean across src/. The unmodified reference samples for Labels, Groups, ClearGroups, TestPatterns, Calendar and KeyMappings round-trip byte-for-byte; the others round-trip with the same byte length (PHP protobuf is not canonically deterministic but re-write-after-write stabilises). doc/INDEX.md, doc/keywords.md and AGENTS.md updated so every new module is discoverable from the top level.
134 lines
2.7 KiB
PHP
134 lines
2.7 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace ProPresenter\Parser;
|
|
|
|
use Rv\Data\Color;
|
|
use Rv\Data\MacrosDocument\Macro as MacroProto;
|
|
use Rv\Data\UUID;
|
|
|
|
class Macro
|
|
{
|
|
public function __construct(
|
|
private readonly MacroProto $macro,
|
|
) {
|
|
}
|
|
|
|
public function getUuid(): string
|
|
{
|
|
return $this->macro->getUuid()?->getString() ?? '';
|
|
}
|
|
|
|
public function setUuid(string $uuid): self
|
|
{
|
|
$proto = new UUID();
|
|
$proto->setString($uuid);
|
|
$this->macro->setUuid($proto);
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getName(): string
|
|
{
|
|
return $this->macro->getName();
|
|
}
|
|
|
|
public function setName(string $name): self
|
|
{
|
|
$this->macro->setName($name);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return array{r: float, g: float, b: float, a: float}|null
|
|
*/
|
|
public function getColor(): ?array
|
|
{
|
|
if (!$this->macro->hasColor()) {
|
|
return null;
|
|
}
|
|
|
|
$color = $this->macro->getColor();
|
|
|
|
return [
|
|
'r' => $color->getRed(),
|
|
'g' => $color->getGreen(),
|
|
'b' => $color->getBlue(),
|
|
'a' => $color->getAlpha(),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @param array{r: float, g: float, b: float, a?: float}|null $color
|
|
*/
|
|
public function setColor(?array $color): self
|
|
{
|
|
if ($color === null) {
|
|
$this->macro->clearColor();
|
|
|
|
return $this;
|
|
}
|
|
|
|
$proto = new Color();
|
|
$proto->setRed((float) $color['r']);
|
|
$proto->setGreen((float) $color['g']);
|
|
$proto->setBlue((float) $color['b']);
|
|
$proto->setAlpha((float) ($color['a'] ?? 1.0));
|
|
$this->macro->setColor($proto);
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getTriggerOnStartup(): bool
|
|
{
|
|
return $this->macro->getTriggerOnStartup();
|
|
}
|
|
|
|
public function setTriggerOnStartup(bool $value): self
|
|
{
|
|
$this->macro->setTriggerOnStartup($value);
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getActionCount(): int
|
|
{
|
|
return count($this->macro->getActions());
|
|
}
|
|
|
|
public function getImageType(): int
|
|
{
|
|
return $this->macro->getImageType();
|
|
}
|
|
|
|
public function setImageType(int $value): self
|
|
{
|
|
$this->macro->setImageType($value);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Custom icon bytes (PNG/JPG). Empty when ProPresenter uses one of the
|
|
* built-in `image_type` icons.
|
|
*/
|
|
public function getImageData(): string
|
|
{
|
|
return $this->macro->getImageData();
|
|
}
|
|
|
|
public function setImageData(string $bytes): self
|
|
{
|
|
$this->macro->setImageData($bytes);
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getProto(): MacroProto
|
|
{
|
|
return $this->macro;
|
|
}
|
|
}
|