9e3e719806
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.
116 lines
3.4 KiB
PHP
116 lines
3.4 KiB
PHP
<?php
|
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
|
# NO CHECKED-IN PROTOBUF GENCODE
|
|
# source: keyMappings.proto
|
|
|
|
namespace Rv\Data;
|
|
|
|
use Google\Protobuf\Internal\GPBType;
|
|
use Google\Protobuf\Internal\RepeatedField;
|
|
use Google\Protobuf\Internal\GPBUtil;
|
|
|
|
/**
|
|
* KeyMappingsDocument is the global ProPresenter `KeyMappings` file. The
|
|
* reference sample on disk is just an `ApplicationInfo` envelope with an
|
|
* otherwise empty body — ProPresenter seeds the file at startup. Once the
|
|
* user binds hot keys we expect them in `mappings`.
|
|
*
|
|
* Generated from protobuf message <code>rv.data.KeyMappingsDocument</code>
|
|
*/
|
|
class KeyMappingsDocument extends \Google\Protobuf\Internal\Message
|
|
{
|
|
/**
|
|
* Application metadata of the writer.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.ApplicationInfo application_info = 1;</code>
|
|
*/
|
|
protected $application_info = null;
|
|
/**
|
|
* Configured key bindings. Empty in the reference sample.
|
|
*
|
|
* Generated from protobuf field <code>repeated .rv.data.KeyMappingsDocument.Mapping mappings = 2;</code>
|
|
*/
|
|
private $mappings;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param array $data {
|
|
* Optional. Data for populating the Message object.
|
|
*
|
|
* @type \Rv\Data\ApplicationInfo $application_info
|
|
* Application metadata of the writer.
|
|
* @type array<\Rv\Data\KeyMappingsDocument\Mapping>|\Google\Protobuf\Internal\RepeatedField $mappings
|
|
* Configured key bindings. Empty in the reference sample.
|
|
* }
|
|
*/
|
|
public function __construct($data = NULL) {
|
|
\GPBMetadata\KeyMappings::initOnce();
|
|
parent::__construct($data);
|
|
}
|
|
|
|
/**
|
|
* Application metadata of the writer.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.ApplicationInfo application_info = 1;</code>
|
|
* @return \Rv\Data\ApplicationInfo|null
|
|
*/
|
|
public function getApplicationInfo()
|
|
{
|
|
return $this->application_info;
|
|
}
|
|
|
|
public function hasApplicationInfo()
|
|
{
|
|
return isset($this->application_info);
|
|
}
|
|
|
|
public function clearApplicationInfo()
|
|
{
|
|
unset($this->application_info);
|
|
}
|
|
|
|
/**
|
|
* Application metadata of the writer.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.ApplicationInfo application_info = 1;</code>
|
|
* @param \Rv\Data\ApplicationInfo $var
|
|
* @return $this
|
|
*/
|
|
public function setApplicationInfo($var)
|
|
{
|
|
GPBUtil::checkMessage($var, \Rv\Data\ApplicationInfo::class);
|
|
$this->application_info = $var;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Configured key bindings. Empty in the reference sample.
|
|
*
|
|
* Generated from protobuf field <code>repeated .rv.data.KeyMappingsDocument.Mapping mappings = 2;</code>
|
|
* @return \Google\Protobuf\Internal\RepeatedField
|
|
*/
|
|
public function getMappings()
|
|
{
|
|
return $this->mappings;
|
|
}
|
|
|
|
/**
|
|
* Configured key bindings. Empty in the reference sample.
|
|
*
|
|
* Generated from protobuf field <code>repeated .rv.data.KeyMappingsDocument.Mapping mappings = 2;</code>
|
|
* @param array<\Rv\Data\KeyMappingsDocument\Mapping>|\Google\Protobuf\Internal\RepeatedField $var
|
|
* @return $this
|
|
*/
|
|
public function setMappings($var)
|
|
{
|
|
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Rv\Data\KeyMappingsDocument\Mapping::class);
|
|
$this->mappings = $arr;
|
|
|
|
return $this;
|
|
}
|
|
|
|
}
|
|
|