UI-neutral revisioned social graph authoring document. 更多...

#include <SocialDocument.h>

类 eve::social_editing::SocialDocumentTarget 继承关系图:

Public 成员函数
	SocialDocumentTarget (std::string id)
	Social document target.

TargetId	targetId () const override
	Target id.

TargetDescriptor	describe () const override
	Describe.

void *	queryCapability (const CapabilityId &capability) override
	Query an optional target capability.

Result< void >	applyDomainOperation (const DomainOperation &operation) override
	Applies domain operation.

std::unique_ptr< IDomainOperationTarget >	cloneDomainState () const override
	Clones domain state.

Result< void >	commitDomainState (std::unique_ptr< IDomainOperationTarget > candidate) override
	Commits domain state.

std::vector< SocialEntityRecord >	entities () const
	Enumerate entities in stable order.

std::vector< SocialEdgeRecord >	edges () const
	Enumerate edges in stable order.

Result< DomainOperation >	makeSetEntity (const SocialEntityRecord &entity) const
	Plan reversible entity creation or replacement.

Result< DomainOperation >	makeDeleteEntity (const StableId &id) const
	Plan deletion of an entity and reject it while edges reference it.

Result< DomainOperation >	makeSetEdge (const SocialEdgeRecord &edge) const
	Plan reversible edge creation or replacement.

Result< DomainOperation >	makeDeleteEdge (const StableId &id) const
	Plan reversible edge deletion.

std::vector< EditorDiagnostic >	validate () const
	Validate references, uniqueness constraints and finite weights.

EditorValue	snapshotValue () const
	Capture deterministic schema-version-one graph content.

Result< void >	loadSnapshot (const EditorValue &snapshot)
	Atomically load a validated graph snapshot.

Public 成员函数继承自 eve::editing::EditableTargetState
	EditableTargetState (Revision initial=1)
	Constructs the shared state with an explicit initial revision.

EditRegion	dirtyRegion () const override
	Return the accumulated dirty region.

void	clearDirtyRegion () override
	Discard the dirty region; the revision does not change.

std::uint64_t	revision () const override
	Return the current revision.

Revision	revisionValue () const noexcept
	Return the revision as the shared protocol revision type.

Public 成员函数继承自 eve::editing::IEditableTarget
virtual	~IEditableTarget ()=default
	Releases IEditableTarget resources.

template<class C >
eve::OptionalRef< C >	capability ()
	Query a capability through its interface-owned stable identity.

template<class C >
eve::OptionalRef< const C >	capability () const
	Capability.

template<class C >
C *	query ()
	Queries query.

template<class C >
const C *	query () const
	Queries query.

Public 成员函数继承自 eve::editing::IDomainOperationTarget
	~IDomainOperationTarget () override=default
	Releases IDomainOperationTarget resources.

Public 成员函数继承自 eve::editing::IDomainOperationTargetStaging
virtual	~IDomainOperationTargetStaging ()=default
	Releases IDomainOperationTargetStaging resources.

静态 Public 成员函数
static CapabilityId	editorCapabilityId ()
	Editor capability id.

额外继承的成员函数
Protected 成员函数继承自 eve::editing::EditableTargetState
void	widenDirty (int x, int y)
	Widen the dirty region without advancing the revision.

void	widenDirty (const EditRegion &region)
	Widen the dirty region without advancing the revision.

void	widenDirty ()
	Mark an unknown area dirty without advancing the revision.

void	bumpRevision ()
	Advance the revision without touching the dirty region.

void	setRevision (Revision revision)
	Adopt a revision observed elsewhere, without advancing it.

void	setDirtyRegion (const EditRegion &region)
	Replace the dirty region wholesale, without advancing the revision.

void	markDirty (int x, int y)
	Include one cell in the dirty region and advance the revision.

void	markDirty (const EditRegion &region)
	Include a whole region and advance the revision.

void	markDirty ()
	Mark an unknown area dirty and advance the revision.

详细描述

UI-neutral revisioned social graph authoring document.

在文件 SocialDocument.h 第 53 行定义.

构造及析构函数说明

◆ SocialDocumentTarget()

eve::social_editing::SocialDocumentTarget::SocialDocumentTarget ( std::string id )

explicit

Social document target.

在文件 SocialDocument.cpp 第 77 行定义.

成员函数说明

◆ applyDomainOperation()

Result< void > eve::social_editing::SocialDocumentTarget::applyDomainOperation ( const DomainOperation & operation )

overridevirtual

Applies domain operation.

实现了 eve::editing::IDomainOperationTarget.

在文件 SocialDocument.cpp 第 84 行定义.

引用了 eve::editing::EditableTargetState::bumpRevision(), eve::editing::Value::getIf(), eve::editing::DomainOperation::payload, eve::editing::DomainOperation::target, eve::editing::DomainOperation::type, v , 以及 eve::editing::EditableTargetState::widenDirty().

◆ cloneDomainState()

std::unique_ptr< IDomainOperationTarget > eve::social_editing::SocialDocumentTarget::cloneDomainState ( ) const

overridevirtual

Clones domain state.

实现了 eve::editing::IDomainOperationTargetStaging.

在文件 SocialDocument.cpp 第 128 行定义.

◆ commitDomainState()

Result< void > eve::social_editing::SocialDocumentTarget::commitDomainState ( std::unique_ptr< IDomainOperationTarget > candidate )

overridevirtual

Commits domain state.

实现了 eve::editing::IDomainOperationTargetStaging.

在文件 SocialDocument.cpp 第 131 行定义.

引用了 t.

◆ describe()

TargetDescriptor eve::social_editing::SocialDocumentTarget::describe ( ) const

overridevirtual

Describe.

重载 eve::editing::IEditableTarget .

在文件 SocialDocument.cpp 第 78 行定义.

引用了 editorCapabilityId() , 以及 eve::editing::EditableTargetState::revisionValue().

◆ edges()

std::vector< SocialEdgeRecord > eve::social_editing::SocialDocumentTarget::edges ( ) const

Enumerate edges in stable order.

在文件 SocialDocument.cpp 第 140 行定义.

引用了 values.

被这些函数引用 eve::social_editing::SocialRuntimeApplier::apply(), loadSnapshot() , 以及 snapshotValue().

◆ editorCapabilityId()

static CapabilityId eve::social_editing::SocialDocumentTarget::editorCapabilityId ( )

inlinestatic

Editor capability id.

在文件 SocialDocument.h 第 59 行定义.

被这些函数引用 describe() , 以及 queryCapability().

◆ entities()

std::vector< SocialEntityRecord > eve::social_editing::SocialDocumentTarget::entities ( ) const

Enumerate entities in stable order.

在文件 SocialDocument.cpp 第 139 行定义.

引用了 values.

被这些函数引用 snapshotValue().

◆ loadSnapshot()

Result< void > eve::social_editing::SocialDocumentTarget::loadSnapshot ( const EditorValue & snapshot )

Atomically load a validated graph snapshot.

在文件 SocialDocument.cpp 第 226 行定义.

引用了 eve::editing::EditableTargetState::bumpRevision(), c, d, edges(), nodes, p, s, v , 以及 eve::editing::EditableTargetState::widenDirty().

◆ makeDeleteEdge()

Result< DomainOperation > eve::social_editing::SocialDocumentTarget::makeDeleteEdge ( const StableId & id ) const

Plan reversible edge deletion.

在文件 SocialDocument.cpp 第 181 行定义.

引用了 f , 以及 value.

◆ makeDeleteEntity()

Result< DomainOperation > eve::social_editing::SocialDocumentTarget::makeDeleteEntity ( const StableId & id ) const

Plan deletion of an entity and reject it while edges reference it.

在文件 SocialDocument.cpp 第 150 行定义.

引用了 f , 以及 value.

◆ makeSetEdge()

Result< DomainOperation > eve::social_editing::SocialDocumentTarget::makeSetEdge ( const SocialEdgeRecord & edge ) const

Plan reversible edge creation or replacement.

在文件 SocialDocument.cpp 第 164 行定义.

引用了 current, f, eve::social_editing::SocialEdgeRecord::id, eve::social_editing::SocialEdgeRecord::kind, ok, eve::social_editing::SocialEdgeRecord::source, eve::social_editing::SocialEdgeRecord::target, eve::social_editing::SocialEdgeRecord::type , 以及 eve::UuidIdAdapter< Tag >::value().

◆ makeSetEntity()

Result< DomainOperation > eve::social_editing::SocialDocumentTarget::makeSetEntity ( const SocialEntityRecord & entity ) const

Plan reversible entity creation or replacement.

在文件 SocialDocument.cpp 第 141 行定义.

引用了 f, eve::social_editing::SocialEntityRecord::id, ok , 以及 eve::UuidIdAdapter< Tag >::value().

◆ queryCapability()

void * eve::social_editing::SocialDocumentTarget::queryCapability ( const CapabilityId & capability )

overridevirtual

Query an optional target capability.

返回: Borrowed pointer owned by this target, or null. @lifetime Valid until this target is destroyed or mutated.

重载 eve::editing::IEditableTarget .

在文件 SocialDocument.cpp 第 81 行定义.

引用了 eve::editing::IEditableTarget::capability() , 以及 editorCapabilityId().

◆ snapshotValue()

EditorValue eve::social_editing::SocialDocumentTarget::snapshotValue ( ) const

Capture deterministic schema-version-one graph content.

在文件 SocialDocument.cpp 第 213 行定义.

引用了 edges(), entities() , 以及 v.

◆ targetId()

TargetId eve::social_editing::SocialDocumentTarget::targetId ( ) const

inlineoverridevirtual

Target id.

实现了 eve::editing::IEditableTarget.

在文件 SocialDocument.h 第 63 行定义.

◆ validate()

std::vector< EditorDiagnostic > eve::social_editing::SocialDocumentTarget::validate ( ) const

Validate references, uniqueness constraints and finite weights.

在文件 SocialDocument.cpp 第 189 行定义.

引用了 eve::Conflict, eve::NotFound, r, eve::editing::ruleDiagnostic() , 以及 value.

被这些函数引用 eve::social_editing::SocialRuntimeApplier::apply().

该类的文档由以下文件生成:

src/modules/social/editing/SocialDocument.h
src/modules/social/editing/SocialDocument.cpp

Public 成员函数

静态 Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ SocialDocumentTarget()

成员函数说明

◆ applyDomainOperation()

◆ cloneDomainState()

◆ commitDomainState()

◆ describe()

◆ edges()

◆ editorCapabilityId()

◆ entities()

◆ loadSnapshot()

◆ makeDeleteEdge()

◆ makeDeleteEntity()

◆ makeSetEdge()

◆ makeSetEntity()

◆ queryCapability()

◆ snapshotValue()

◆ targetId()

◆ validate()