aboutsummaryrefslogtreecommitdiff
path: root/core/src/Model/Workflow/Workflow.hpp
blob: a7b2c31b374e47a88aad9303bf24b976f7dd3b5c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
#pragma once

#include "Value.hpp"
#include "cplt_fwd.hpp"

#include <cstddef>
#include <cstdint>
#include <limits>
#include <memory>
#include <span>
#include <string>
#include <vector>

class WorkflowConnection {
public:
	static constexpr auto kInvalidId = std::numeric_limits<size_t>::max();

	enum Direction {
		ManyToOne,
		OneToMany,
	};

	struct ConnectionPoint {
		size_t Node;
		int Pin;

		bool operator==(const ConnectionPoint&) const = default;
	};

	std::vector<ConnectionPoint> MultiConnections;
	ConnectionPoint SingleConnection;
	Direction ConnectionDirection;

public:
	WorkflowConnection();

	bool IsValid() const;
	std::span<ConnectionPoint> GetSourcePoints();
	std::span<const ConnectionPoint> GetSourcePoints() const;
	std::span<ConnectionPoint> GetDestinationPoints();
	std::span<const ConnectionPoint> GetDestinationPoints() const;
};

class WorkflowNode {
public:
	static constexpr auto kInvalidId = std::numeric_limits<size_t>::max();

	enum Type {
		InputType,
		TransformType,
		OutputType,
	};

	enum Kind {
		KD_NumericAddition,
		KD_NumericSubtraction,
		KD_NumericMultiplication,
		KD_NumericDivision,
		KD_NumericExpression,
		KD_TextFormatting,
		KD_DocumentTemplateExpansion,
		KD_FormInput,
		KD_DatabaseRowsInput,

		InvalidKind,
		KindCount = InvalidKind,
	};

protected:
	struct InputPin {
		size_t Connection = WorkflowConnection::kInvalidId;
		BaseValue::Kind MatchingType = BaseValue::KindInvalid;
		bool ConnectionToConst = false;
		bool AllowsMultipleConnections = false;

		/// A constant connection connects from a user-specified constant value, feeding to a valid \c Destination and \c DestinationPin (i.e. input pins).
		bool IsConstantConnection() const;
		bool IsConnected() const;
		BaseValue::Kind GetMatchingType() const;
		WorkflowConnection::Direction GetSupportedDirection() const;
	};

	struct OutputPin {
		size_t Connection = WorkflowConnection::kInvalidId;
		BaseValue::Kind MatchingType = BaseValue::KindInvalid;
		bool AllowsMultipleConnections = false;

		bool IsConnected() const;
		BaseValue::Kind GetMatchingType() const;
		WorkflowConnection::Direction GetSupportedDirection() const;
	};

	friend class Workflow;
	friend class WorkflowEvaluationContext;

	Workflow* mWorkflow;
	size_t mId;
	std::vector<InputPin> mInputs;
	std::vector<OutputPin> mOutputs;
	Type mType;
	Kind mKind;

public:
	WorkflowNode(Type type, Kind kind);
	virtual ~WorkflowNode() = default;

	WorkflowNode(const WorkflowNode&) = delete;
	WorkflowNode& operator=(const WorkflowNode&) = delete;
	WorkflowNode(WorkflowNode&&) = default;
	WorkflowNode& operator=(WorkflowNode&&) = default;

	size_t GetId() const;
	Type GetType() const;
	Kind GetKind() const;

	void ConnectInput(int nodeId, WorkflowNode& output, int outputNodeId);
	void DisconnectInput(int nodeId);
	bool IsInputConnected(int nodeId) const;

	void ConnectOutput(int nodeId, WorkflowNode& input, int inputNodeId);
	void DisconnectOutput(int nodeId);
	bool IsOutputConnected(int nodeId) const;

	virtual void Evaluate(WorkflowEvaluationContext& ctx) = 0;

protected:
	InputPin& InsertInputPin(int atIdx);
	void RemoveInputPin(int pin);
	void SwapInputPin(int a, int b);
	OutputPin& InsertOutputPin(int atIdx);
	void RemoveOutputPin(int pin);
	void SwapOutputPin(int a, int b);

	/* For \c Workflow to invoke, override by implementations */

	void OnAttach(Workflow& workflow, size_t newId) {}
	void OnDetach() {}
};

class Workflow {
private:
	friend class WorkflowEvaluationContext;

	std::vector<WorkflowConnection> mConnections;
	std::vector<std::unique_ptr<WorkflowNode>> mNodes;
	std::vector<std::unique_ptr<BaseValue>> mConstants;

public:
	WorkflowConnection* GetConnectionById(size_t id);
	WorkflowNode* GetStepById(size_t id);
	BaseValue* GetConstantById(size_t id);

	void AddStep(std::unique_ptr<WorkflowNode> step);
	void RemoveStep(size_t id);

	bool Connect(WorkflowNode& sourceNode, int sourcePin, WorkflowNode& destinationNode, int destinationPin);
	bool DisconnectBySource(WorkflowNode& sourceNode, int sourcePin);
	bool DisconnectByDestination(WorkflowNode& destinationNode, int destinationPin);

private:
	std::pair<WorkflowConnection&, size_t> AllocWorkflowConnection();
	std::pair<std::unique_ptr<WorkflowNode>&, size_t> AllocWorkflowStep();
};