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.
108 lines
3.3 KiB
PHP
108 lines
3.3 KiB
PHP
<?php
|
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
|
# NO CHECKED-IN PROTOBUF GENCODE
|
|
# source: calendar.proto
|
|
|
|
namespace Rv\Data;
|
|
|
|
use Google\Protobuf\Internal\GPBType;
|
|
use Google\Protobuf\Internal\RepeatedField;
|
|
use Google\Protobuf\Internal\GPBUtil;
|
|
|
|
/**
|
|
* CalendarDocument is the global ProPresenter `Calendar` file. It holds
|
|
* scheduled events that fire macros at given times. The exact semantics of
|
|
* the inner sub-messages 8 and 9 (action and embedded macro reference) are
|
|
* preserved as raw bytes so the document round-trips byte-for-byte; clients
|
|
* that need to inspect them can decode them with `protoc --decode_raw` or
|
|
* reach for the raw protobuf message.
|
|
*
|
|
* Generated from protobuf message <code>rv.data.CalendarDocument</code>
|
|
*/
|
|
class CalendarDocument extends \Google\Protobuf\Internal\Message
|
|
{
|
|
/**
|
|
* Events scheduled in the calendar, in the order ProPresenter wrote them.
|
|
*
|
|
* Generated from protobuf field <code>repeated .rv.data.CalendarDocument.Event events = 1;</code>
|
|
*/
|
|
private $events;
|
|
/**
|
|
* Source / mode flag observed in samples (value `1`). Treated as opaque.
|
|
*
|
|
* Generated from protobuf field <code>uint32 mode = 2;</code>
|
|
*/
|
|
protected $mode = 0;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param array $data {
|
|
* Optional. Data for populating the Message object.
|
|
*
|
|
* @type array<\Rv\Data\CalendarDocument\Event>|\Google\Protobuf\Internal\RepeatedField $events
|
|
* Events scheduled in the calendar, in the order ProPresenter wrote them.
|
|
* @type int $mode
|
|
* Source / mode flag observed in samples (value `1`). Treated as opaque.
|
|
* }
|
|
*/
|
|
public function __construct($data = NULL) {
|
|
\GPBMetadata\Calendar::initOnce();
|
|
parent::__construct($data);
|
|
}
|
|
|
|
/**
|
|
* Events scheduled in the calendar, in the order ProPresenter wrote them.
|
|
*
|
|
* Generated from protobuf field <code>repeated .rv.data.CalendarDocument.Event events = 1;</code>
|
|
* @return \Google\Protobuf\Internal\RepeatedField
|
|
*/
|
|
public function getEvents()
|
|
{
|
|
return $this->events;
|
|
}
|
|
|
|
/**
|
|
* Events scheduled in the calendar, in the order ProPresenter wrote them.
|
|
*
|
|
* Generated from protobuf field <code>repeated .rv.data.CalendarDocument.Event events = 1;</code>
|
|
* @param array<\Rv\Data\CalendarDocument\Event>|\Google\Protobuf\Internal\RepeatedField $var
|
|
* @return $this
|
|
*/
|
|
public function setEvents($var)
|
|
{
|
|
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Rv\Data\CalendarDocument\Event::class);
|
|
$this->events = $arr;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Source / mode flag observed in samples (value `1`). Treated as opaque.
|
|
*
|
|
* Generated from protobuf field <code>uint32 mode = 2;</code>
|
|
* @return int
|
|
*/
|
|
public function getMode()
|
|
{
|
|
return $this->mode;
|
|
}
|
|
|
|
/**
|
|
* Source / mode flag observed in samples (value `1`). Treated as opaque.
|
|
*
|
|
* Generated from protobuf field <code>uint32 mode = 2;</code>
|
|
* @param int $var
|
|
* @return $this
|
|
*/
|
|
public function setMode($var)
|
|
{
|
|
GPBUtil::checkUint32($var);
|
|
$this->mode = $var;
|
|
|
|
return $this;
|
|
}
|
|
|
|
}
|
|
|