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.
197 lines
5 KiB
PHP
197 lines
5 KiB
PHP
<?php
|
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
|
# NO CHECKED-IN PROTOBUF GENCODE
|
|
# source: keyMappings.proto
|
|
|
|
namespace Rv\Data\KeyMappingsDocument;
|
|
|
|
use Google\Protobuf\Internal\GPBType;
|
|
use Google\Protobuf\Internal\RepeatedField;
|
|
use Google\Protobuf\Internal\GPBUtil;
|
|
|
|
/**
|
|
* Generated from protobuf message <code>rv.data.KeyMappingsDocument.Mapping</code>
|
|
*/
|
|
class Mapping extends \Google\Protobuf\Internal\Message
|
|
{
|
|
/**
|
|
* Optional stable identifier for the mapping.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.UUID uuid = 1;</code>
|
|
*/
|
|
protected $uuid = null;
|
|
/**
|
|
* The hot key combo that fires the action.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.HotKey hot_key = 2;</code>
|
|
*/
|
|
protected $hot_key = null;
|
|
/**
|
|
* Action target — typically a macro UUID, a control identifier, or any
|
|
* other reference ProPresenter chooses to encode. Kept as bytes so we
|
|
* round-trip cleanly while ProPresenter's internal schema evolves.
|
|
*
|
|
* Generated from protobuf field <code>bytes target = 3;</code>
|
|
*/
|
|
protected $target = '';
|
|
/**
|
|
* Display name (optional).
|
|
*
|
|
* Generated from protobuf field <code>string name = 4;</code>
|
|
*/
|
|
protected $name = '';
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param array $data {
|
|
* Optional. Data for populating the Message object.
|
|
*
|
|
* @type \Rv\Data\UUID $uuid
|
|
* Optional stable identifier for the mapping.
|
|
* @type \Rv\Data\HotKey $hot_key
|
|
* The hot key combo that fires the action.
|
|
* @type string $target
|
|
* Action target — typically a macro UUID, a control identifier, or any
|
|
* other reference ProPresenter chooses to encode. Kept as bytes so we
|
|
* round-trip cleanly while ProPresenter's internal schema evolves.
|
|
* @type string $name
|
|
* Display name (optional).
|
|
* }
|
|
*/
|
|
public function __construct($data = NULL) {
|
|
\GPBMetadata\KeyMappings::initOnce();
|
|
parent::__construct($data);
|
|
}
|
|
|
|
/**
|
|
* Optional stable identifier for the mapping.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.UUID uuid = 1;</code>
|
|
* @return \Rv\Data\UUID|null
|
|
*/
|
|
public function getUuid()
|
|
{
|
|
return $this->uuid;
|
|
}
|
|
|
|
public function hasUuid()
|
|
{
|
|
return isset($this->uuid);
|
|
}
|
|
|
|
public function clearUuid()
|
|
{
|
|
unset($this->uuid);
|
|
}
|
|
|
|
/**
|
|
* Optional stable identifier for the mapping.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.UUID uuid = 1;</code>
|
|
* @param \Rv\Data\UUID $var
|
|
* @return $this
|
|
*/
|
|
public function setUuid($var)
|
|
{
|
|
GPBUtil::checkMessage($var, \Rv\Data\UUID::class);
|
|
$this->uuid = $var;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* The hot key combo that fires the action.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.HotKey hot_key = 2;</code>
|
|
* @return \Rv\Data\HotKey|null
|
|
*/
|
|
public function getHotKey()
|
|
{
|
|
return $this->hot_key;
|
|
}
|
|
|
|
public function hasHotKey()
|
|
{
|
|
return isset($this->hot_key);
|
|
}
|
|
|
|
public function clearHotKey()
|
|
{
|
|
unset($this->hot_key);
|
|
}
|
|
|
|
/**
|
|
* The hot key combo that fires the action.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.HotKey hot_key = 2;</code>
|
|
* @param \Rv\Data\HotKey $var
|
|
* @return $this
|
|
*/
|
|
public function setHotKey($var)
|
|
{
|
|
GPBUtil::checkMessage($var, \Rv\Data\HotKey::class);
|
|
$this->hot_key = $var;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Action target — typically a macro UUID, a control identifier, or any
|
|
* other reference ProPresenter chooses to encode. Kept as bytes so we
|
|
* round-trip cleanly while ProPresenter's internal schema evolves.
|
|
*
|
|
* Generated from protobuf field <code>bytes target = 3;</code>
|
|
* @return string
|
|
*/
|
|
public function getTarget()
|
|
{
|
|
return $this->target;
|
|
}
|
|
|
|
/**
|
|
* Action target — typically a macro UUID, a control identifier, or any
|
|
* other reference ProPresenter chooses to encode. Kept as bytes so we
|
|
* round-trip cleanly while ProPresenter's internal schema evolves.
|
|
*
|
|
* Generated from protobuf field <code>bytes target = 3;</code>
|
|
* @param string $var
|
|
* @return $this
|
|
*/
|
|
public function setTarget($var)
|
|
{
|
|
GPBUtil::checkString($var, False);
|
|
$this->target = $var;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Display name (optional).
|
|
*
|
|
* Generated from protobuf field <code>string name = 4;</code>
|
|
* @return string
|
|
*/
|
|
public function getName()
|
|
{
|
|
return $this->name;
|
|
}
|
|
|
|
/**
|
|
* Display name (optional).
|
|
*
|
|
* Generated from protobuf field <code>string name = 4;</code>
|
|
* @param string $var
|
|
* @return $this
|
|
*/
|
|
public function setName($var)
|
|
{
|
|
GPBUtil::checkString($var, True);
|
|
$this->name = $var;
|
|
|
|
return $this;
|
|
}
|
|
|
|
}
|
|
|