annotate win64-msvc/include/capnp/dynamic.h @ 135:38d1c0e7850b

Headers for KJ/Capnp Win32
author Chris Cannam <cannam@all-day-breakfast.com>
date Wed, 26 Oct 2016 13:18:45 +0100
parents 42a73082be24
children 0f2d93caa50c
rev   line source
cannam@132 1 // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
cannam@132 2 // Licensed under the MIT License:
cannam@132 3 //
cannam@132 4 // Permission is hereby granted, free of charge, to any person obtaining a copy
cannam@132 5 // of this software and associated documentation files (the "Software"), to deal
cannam@132 6 // in the Software without restriction, including without limitation the rights
cannam@132 7 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
cannam@132 8 // copies of the Software, and to permit persons to whom the Software is
cannam@132 9 // furnished to do so, subject to the following conditions:
cannam@132 10 //
cannam@132 11 // The above copyright notice and this permission notice shall be included in
cannam@132 12 // all copies or substantial portions of the Software.
cannam@132 13 //
cannam@132 14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
cannam@132 15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
cannam@132 16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
cannam@132 17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
cannam@132 18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
cannam@132 19 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
cannam@132 20 // THE SOFTWARE.
cannam@132 21
cannam@132 22 // This file defines classes that can be used to manipulate messages based on schemas that are not
cannam@132 23 // known until runtime. This is also useful for writing generic code that uses schemas to handle
cannam@132 24 // arbitrary types in a generic way.
cannam@132 25 //
cannam@132 26 // Each of the classes defined here has a to() template method which converts an instance back to a
cannam@132 27 // native type. This method will throw an exception if the requested type does not match the
cannam@132 28 // schema. To convert native types to dynamic, use DynamicFactory.
cannam@132 29 //
cannam@132 30 // As always, underlying data is validated lazily, so you have to actually traverse the whole
cannam@132 31 // message if you want to validate all content.
cannam@132 32
cannam@132 33 #ifndef CAPNP_DYNAMIC_H_
cannam@132 34 #define CAPNP_DYNAMIC_H_
cannam@132 35
cannam@132 36 #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS)
cannam@132 37 #pragma GCC system_header
cannam@132 38 #endif
cannam@132 39
cannam@132 40 #include "schema.h"
cannam@132 41 #include "layout.h"
cannam@132 42 #include "message.h"
cannam@132 43 #include "any.h"
cannam@132 44 #include "capability.h"
cannam@132 45
cannam@132 46 namespace capnp {
cannam@132 47
cannam@132 48 class MessageReader;
cannam@132 49 class MessageBuilder;
cannam@132 50
cannam@132 51 struct DynamicValue {
cannam@132 52 DynamicValue() = delete;
cannam@132 53
cannam@132 54 enum Type {
cannam@132 55 UNKNOWN,
cannam@132 56 // Means that the value has unknown type and content because it comes from a newer version of
cannam@132 57 // the schema, or from a newer version of Cap'n Proto that has new features that this version
cannam@132 58 // doesn't understand.
cannam@132 59
cannam@132 60 VOID,
cannam@132 61 BOOL,
cannam@132 62 INT,
cannam@132 63 UINT,
cannam@132 64 FLOAT,
cannam@132 65 TEXT,
cannam@132 66 DATA,
cannam@132 67 LIST,
cannam@132 68 ENUM,
cannam@132 69 STRUCT,
cannam@132 70 CAPABILITY,
cannam@132 71 ANY_POINTER
cannam@132 72 };
cannam@132 73
cannam@132 74 class Reader;
cannam@132 75 class Builder;
cannam@132 76 class Pipeline;
cannam@132 77 };
cannam@132 78 class DynamicEnum;
cannam@132 79 struct DynamicStruct {
cannam@132 80 DynamicStruct() = delete;
cannam@132 81 class Reader;
cannam@132 82 class Builder;
cannam@132 83 class Pipeline;
cannam@132 84 };
cannam@132 85 struct DynamicList {
cannam@132 86 DynamicList() = delete;
cannam@132 87 class Reader;
cannam@132 88 class Builder;
cannam@132 89 };
cannam@132 90 struct DynamicCapability {
cannam@132 91 DynamicCapability() = delete;
cannam@132 92 class Client;
cannam@132 93 class Server;
cannam@132 94 };
cannam@132 95 template <> class Orphan<DynamicValue>;
cannam@132 96
cannam@132 97 template <Kind k> struct DynamicTypeFor_;
cannam@132 98 template <> struct DynamicTypeFor_<Kind::ENUM> { typedef DynamicEnum Type; };
cannam@132 99 template <> struct DynamicTypeFor_<Kind::STRUCT> { typedef DynamicStruct Type; };
cannam@132 100 template <> struct DynamicTypeFor_<Kind::LIST> { typedef DynamicList Type; };
cannam@132 101 template <> struct DynamicTypeFor_<Kind::INTERFACE> { typedef DynamicCapability Type; };
cannam@132 102
cannam@132 103 template <typename T>
cannam@132 104 using DynamicTypeFor = typename DynamicTypeFor_<kind<T>()>::Type;
cannam@132 105
cannam@132 106 template <typename T>
cannam@132 107 ReaderFor<DynamicTypeFor<FromReader<T>>> toDynamic(T&& value);
cannam@132 108 template <typename T>
cannam@132 109 BuilderFor<DynamicTypeFor<FromBuilder<T>>> toDynamic(T&& value);
cannam@132 110 template <typename T>
cannam@132 111 DynamicTypeFor<TypeIfEnum<T>> toDynamic(T&& value);
cannam@132 112 template <typename T>
cannam@132 113 typename DynamicTypeFor<FromServer<T>>::Client toDynamic(kj::Own<T>&& value);
cannam@132 114
cannam@132 115 namespace _ { // private
cannam@132 116
cannam@132 117 template <> struct Kind_<DynamicValue > { static constexpr Kind kind = Kind::OTHER; };
cannam@132 118 template <> struct Kind_<DynamicEnum > { static constexpr Kind kind = Kind::OTHER; };
cannam@132 119 template <> struct Kind_<DynamicStruct > { static constexpr Kind kind = Kind::OTHER; };
cannam@132 120 template <> struct Kind_<DynamicList > { static constexpr Kind kind = Kind::OTHER; };
cannam@132 121 template <> struct Kind_<DynamicCapability> { static constexpr Kind kind = Kind::OTHER; };
cannam@132 122
cannam@132 123 } // namespace _ (private)
cannam@132 124
cannam@132 125 template <> inline constexpr Style style<DynamicValue >() { return Style::POINTER; }
cannam@132 126 template <> inline constexpr Style style<DynamicEnum >() { return Style::PRIMITIVE; }
cannam@132 127 template <> inline constexpr Style style<DynamicStruct >() { return Style::STRUCT; }
cannam@132 128 template <> inline constexpr Style style<DynamicList >() { return Style::POINTER; }
cannam@132 129 template <> inline constexpr Style style<DynamicCapability>() { return Style::CAPABILITY; }
cannam@132 130
cannam@132 131 // -------------------------------------------------------------------
cannam@132 132
cannam@132 133 class DynamicEnum {
cannam@132 134 public:
cannam@132 135 DynamicEnum() = default;
cannam@132 136 inline DynamicEnum(EnumSchema::Enumerant enumerant)
cannam@132 137 : schema(enumerant.getContainingEnum()), value(enumerant.getOrdinal()) {}
cannam@132 138 inline DynamicEnum(EnumSchema schema, uint16_t value)
cannam@132 139 : schema(schema), value(value) {}
cannam@132 140
cannam@132 141 template <typename T, typename = kj::EnableIf<kind<T>() == Kind::ENUM>>
cannam@132 142 inline DynamicEnum(T&& value): DynamicEnum(toDynamic(value)) {}
cannam@132 143
cannam@132 144 template <typename T>
cannam@132 145 inline T as() const { return static_cast<T>(asImpl(typeId<T>())); }
cannam@132 146 // Cast to a native enum type.
cannam@132 147
cannam@132 148 inline EnumSchema getSchema() const { return schema; }
cannam@132 149
cannam@132 150 kj::Maybe<EnumSchema::Enumerant> getEnumerant() const;
cannam@132 151 // Get which enumerant this enum value represents. Returns nullptr if the numeric value does not
cannam@132 152 // correspond to any enumerant in the schema -- this can happen if the data was built using a
cannam@132 153 // newer schema that has more values defined.
cannam@132 154
cannam@132 155 inline uint16_t getRaw() const { return value; }
cannam@132 156 // Returns the raw underlying enum value.
cannam@132 157
cannam@132 158 private:
cannam@132 159 EnumSchema schema;
cannam@132 160 uint16_t value;
cannam@132 161
cannam@132 162 uint16_t asImpl(uint64_t requestedTypeId) const;
cannam@132 163
cannam@132 164 friend struct DynamicStruct;
cannam@132 165 friend struct DynamicList;
cannam@132 166 friend struct DynamicValue;
cannam@132 167 template <typename T>
cannam@132 168 friend DynamicTypeFor<TypeIfEnum<T>> toDynamic(T&& value);
cannam@132 169 };
cannam@132 170
cannam@132 171 // -------------------------------------------------------------------
cannam@132 172
cannam@132 173 class DynamicStruct::Reader {
cannam@132 174 public:
cannam@132 175 typedef DynamicStruct Reads;
cannam@132 176
cannam@132 177 Reader() = default;
cannam@132 178
cannam@132 179 template <typename T, typename = kj::EnableIf<kind<FromReader<T>>() == Kind::STRUCT>>
cannam@132 180 inline Reader(T&& value): Reader(toDynamic(value)) {}
cannam@132 181
cannam@132 182 inline MessageSize totalSize() const { return reader.totalSize().asPublic(); }
cannam@132 183
cannam@132 184 template <typename T>
cannam@132 185 typename T::Reader as() const;
cannam@132 186 // Convert the dynamic struct to its compiled-in type.
cannam@132 187
cannam@132 188 inline StructSchema getSchema() const { return schema; }
cannam@132 189
cannam@132 190 DynamicValue::Reader get(StructSchema::Field field) const;
cannam@132 191 // Read the given field value.
cannam@132 192
cannam@132 193 bool has(StructSchema::Field field) const;
cannam@132 194 // Tests whether the given field is set to its default value. For pointer values, this does
cannam@132 195 // not actually traverse the value comparing it with the default, but simply returns true if the
cannam@132 196 // pointer is non-null. For members of unions, has() returns false if the union member is not
cannam@132 197 // active, but does not necessarily return true if the member is active (depends on the field's
cannam@132 198 // value).
cannam@132 199
cannam@132 200 kj::Maybe<StructSchema::Field> which() const;
cannam@132 201 // If the struct contains an (unnamed) union, and the currently-active field within that union
cannam@132 202 // is known, this returns that field. Otherwise, it returns null. In other words, this returns
cannam@132 203 // null if there is no union present _or_ if the union's discriminant is set to an unrecognized
cannam@132 204 // value. This could happen in particular when receiving a message from a sender who has a
cannam@132 205 // newer version of the protocol and is using a field of the union that you don't know about yet.
cannam@132 206
cannam@132 207 DynamicValue::Reader get(kj::StringPtr name) const;
cannam@132 208 bool has(kj::StringPtr name) const;
cannam@132 209 // Shortcuts to access fields by name. These throw exceptions if no such field exists.
cannam@132 210
cannam@132 211 private:
cannam@132 212 StructSchema schema;
cannam@132 213 _::StructReader reader;
cannam@132 214
cannam@132 215 inline Reader(StructSchema schema, _::StructReader reader)
cannam@132 216 : schema(schema), reader(reader) {}
cannam@132 217
cannam@132 218 bool isSetInUnion(StructSchema::Field field) const;
cannam@132 219 void verifySetInUnion(StructSchema::Field field) const;
cannam@132 220 static DynamicValue::Reader getImpl(_::StructReader reader, StructSchema::Field field);
cannam@132 221
cannam@132 222 template <typename T, Kind K>
cannam@132 223 friend struct _::PointerHelpers;
cannam@132 224 friend class DynamicStruct::Builder;
cannam@132 225 friend struct DynamicList;
cannam@132 226 friend class MessageReader;
cannam@132 227 friend class MessageBuilder;
cannam@132 228 template <typename T, ::capnp::Kind k>
cannam@132 229 friend struct ::capnp::ToDynamic_;
cannam@132 230 friend kj::StringTree _::structString(
cannam@132 231 _::StructReader reader, const _::RawBrandedSchema& schema);
cannam@132 232 friend class Orphanage;
cannam@132 233 friend class Orphan<DynamicStruct>;
cannam@132 234 friend class Orphan<DynamicValue>;
cannam@132 235 friend class Orphan<AnyPointer>;
cannam@132 236 };
cannam@132 237
cannam@132 238 class DynamicStruct::Builder {
cannam@132 239 public:
cannam@132 240 typedef DynamicStruct Builds;
cannam@132 241
cannam@132 242 Builder() = default;
cannam@132 243 inline Builder(decltype(nullptr)) {}
cannam@132 244
cannam@132 245 template <typename T, typename = kj::EnableIf<kind<FromBuilder<T>>() == Kind::STRUCT>>
cannam@132 246 inline Builder(T&& value): Builder(toDynamic(value)) {}
cannam@132 247
cannam@132 248 inline MessageSize totalSize() const { return asReader().totalSize(); }
cannam@132 249
cannam@132 250 template <typename T>
cannam@132 251 typename T::Builder as();
cannam@132 252 // Cast to a particular struct type.
cannam@132 253
cannam@132 254 inline StructSchema getSchema() const { return schema; }
cannam@132 255
cannam@132 256 DynamicValue::Builder get(StructSchema::Field field);
cannam@132 257 // Read the given field value.
cannam@132 258
cannam@132 259 inline bool has(StructSchema::Field field) { return asReader().has(field); }
cannam@132 260 // Tests whether the given field is set to its default value. For pointer values, this does
cannam@132 261 // not actually traverse the value comparing it with the default, but simply returns true if the
cannam@132 262 // pointer is non-null. For members of unions, has() returns whether the field is currently
cannam@132 263 // active and the union as a whole is non-default -- so, the only time has() will return false
cannam@132 264 // for an active union field is if it is the default active field and it has its default value.
cannam@132 265
cannam@132 266 kj::Maybe<StructSchema::Field> which();
cannam@132 267 // If the struct contains an (unnamed) union, and the currently-active field within that union
cannam@132 268 // is known, this returns that field. Otherwise, it returns null. In other words, this returns
cannam@132 269 // null if there is no union present _or_ if the union's discriminant is set to an unrecognized
cannam@132 270 // value. This could happen in particular when receiving a message from a sender who has a
cannam@132 271 // newer version of the protocol and is using a field of the union that you don't know about yet.
cannam@132 272
cannam@132 273 void set(StructSchema::Field field, const DynamicValue::Reader& value);
cannam@132 274 // Set the given field value.
cannam@132 275
cannam@132 276 DynamicValue::Builder init(StructSchema::Field field);
cannam@132 277 DynamicValue::Builder init(StructSchema::Field field, uint size);
cannam@132 278 // Init a struct, list, or blob field.
cannam@132 279
cannam@132 280 void adopt(StructSchema::Field field, Orphan<DynamicValue>&& orphan);
cannam@132 281 Orphan<DynamicValue> disown(StructSchema::Field field);
cannam@132 282 // Adopt/disown. This works even for non-pointer fields: adopt() becomes equivalent to set()
cannam@132 283 // and disown() becomes like get() followed by clear().
cannam@132 284
cannam@132 285 void clear(StructSchema::Field field);
cannam@132 286 // Clear a field, setting it to its default value. For pointer fields, this actually makes the
cannam@132 287 // field null.
cannam@132 288
cannam@132 289 DynamicValue::Builder get(kj::StringPtr name);
cannam@132 290 bool has(kj::StringPtr name);
cannam@132 291 void set(kj::StringPtr name, const DynamicValue::Reader& value);
cannam@132 292 void set(kj::StringPtr name, std::initializer_list<DynamicValue::Reader> value);
cannam@132 293 DynamicValue::Builder init(kj::StringPtr name);
cannam@132 294 DynamicValue::Builder init(kj::StringPtr name, uint size);
cannam@132 295 void adopt(kj::StringPtr name, Orphan<DynamicValue>&& orphan);
cannam@132 296 Orphan<DynamicValue> disown(kj::StringPtr name);
cannam@132 297 void clear(kj::StringPtr name);
cannam@132 298 // Shortcuts to access fields by name. These throw exceptions if no such field exists.
cannam@132 299
cannam@132 300 Reader asReader() const;
cannam@132 301
cannam@132 302 private:
cannam@132 303 StructSchema schema;
cannam@132 304 _::StructBuilder builder;
cannam@132 305
cannam@132 306 inline Builder(StructSchema schema, _::StructBuilder builder)
cannam@132 307 : schema(schema), builder(builder) {}
cannam@132 308
cannam@132 309 bool isSetInUnion(StructSchema::Field field);
cannam@132 310 void verifySetInUnion(StructSchema::Field field);
cannam@132 311 void setInUnion(StructSchema::Field field);
cannam@132 312
cannam@132 313 template <typename T, Kind k>
cannam@132 314 friend struct _::PointerHelpers;
cannam@132 315 friend struct DynamicList;
cannam@132 316 friend class MessageReader;
cannam@132 317 friend class MessageBuilder;
cannam@132 318 template <typename T, ::capnp::Kind k>
cannam@132 319 friend struct ::capnp::ToDynamic_;
cannam@132 320 friend class Orphanage;
cannam@132 321 friend class Orphan<DynamicStruct>;
cannam@132 322 friend class Orphan<DynamicValue>;
cannam@132 323 friend class Orphan<AnyPointer>;
cannam@132 324 };
cannam@132 325
cannam@132 326 class DynamicStruct::Pipeline {
cannam@132 327 public:
cannam@132 328 typedef DynamicStruct Pipelines;
cannam@132 329
cannam@132 330 inline Pipeline(decltype(nullptr)): typeless(nullptr) {}
cannam@132 331
cannam@132 332 template <typename T>
cannam@132 333 typename T::Pipeline releaseAs();
cannam@132 334 // Convert the dynamic pipeline to its compiled-in type.
cannam@132 335
cannam@132 336 inline StructSchema getSchema() { return schema; }
cannam@132 337
cannam@132 338 DynamicValue::Pipeline get(StructSchema::Field field);
cannam@132 339 // Read the given field value.
cannam@132 340
cannam@132 341 DynamicValue::Pipeline get(kj::StringPtr name);
cannam@132 342 // Get by string name.
cannam@132 343
cannam@132 344 private:
cannam@132 345 StructSchema schema;
cannam@132 346 AnyPointer::Pipeline typeless;
cannam@132 347
cannam@132 348 inline explicit Pipeline(StructSchema schema, AnyPointer::Pipeline&& typeless)
cannam@132 349 : schema(schema), typeless(kj::mv(typeless)) {}
cannam@132 350
cannam@132 351 friend class Request<DynamicStruct, DynamicStruct>;
cannam@132 352 };
cannam@132 353
cannam@132 354 // -------------------------------------------------------------------
cannam@132 355
cannam@132 356 class DynamicList::Reader {
cannam@132 357 public:
cannam@132 358 typedef DynamicList Reads;
cannam@132 359
cannam@132 360 inline Reader(): reader(ElementSize::VOID) {}
cannam@132 361
cannam@132 362 template <typename T, typename = kj::EnableIf<kind<FromReader<T>>() == Kind::LIST>>
cannam@132 363 inline Reader(T&& value): Reader(toDynamic(value)) {}
cannam@132 364
cannam@132 365 template <typename T>
cannam@132 366 typename T::Reader as() const;
cannam@132 367 // Try to convert to any List<T>, Data, or Text. Throws an exception if the underlying data
cannam@132 368 // can't possibly represent the requested type.
cannam@132 369
cannam@132 370 inline ListSchema getSchema() const { return schema; }
cannam@132 371
cannam@132 372 inline uint size() const { return reader.size() / ELEMENTS; }
cannam@132 373 DynamicValue::Reader operator[](uint index) const;
cannam@132 374
cannam@132 375 typedef _::IndexingIterator<const Reader, DynamicValue::Reader> Iterator;
cannam@132 376 inline Iterator begin() const { return Iterator(this, 0); }
cannam@132 377 inline Iterator end() const { return Iterator(this, size()); }
cannam@132 378
cannam@132 379 private:
cannam@132 380 ListSchema schema;
cannam@132 381 _::ListReader reader;
cannam@132 382
cannam@132 383 Reader(ListSchema schema, _::ListReader reader): schema(schema), reader(reader) {}
cannam@132 384
cannam@132 385 template <typename T, Kind k>
cannam@132 386 friend struct _::PointerHelpers;
cannam@132 387 friend struct DynamicStruct;
cannam@132 388 friend class DynamicList::Builder;
cannam@132 389 template <typename T, ::capnp::Kind k>
cannam@132 390 friend struct ::capnp::ToDynamic_;
cannam@132 391 friend class Orphanage;
cannam@132 392 friend class Orphan<DynamicList>;
cannam@132 393 friend class Orphan<DynamicValue>;
cannam@132 394 friend class Orphan<AnyPointer>;
cannam@132 395 };
cannam@132 396
cannam@132 397 class DynamicList::Builder {
cannam@132 398 public:
cannam@132 399 typedef DynamicList Builds;
cannam@132 400
cannam@132 401 inline Builder(): builder(ElementSize::VOID) {}
cannam@132 402 inline Builder(decltype(nullptr)): builder(ElementSize::VOID) {}
cannam@132 403
cannam@132 404 template <typename T, typename = kj::EnableIf<kind<FromBuilder<T>>() == Kind::LIST>>
cannam@132 405 inline Builder(T&& value): Builder(toDynamic(value)) {}
cannam@132 406
cannam@132 407 template <typename T>
cannam@132 408 typename T::Builder as();
cannam@132 409 // Try to convert to any List<T>, Data, or Text. Throws an exception if the underlying data
cannam@132 410 // can't possibly represent the requested type.
cannam@132 411
cannam@132 412 inline ListSchema getSchema() const { return schema; }
cannam@132 413
cannam@132 414 inline uint size() const { return builder.size() / ELEMENTS; }
cannam@132 415 DynamicValue::Builder operator[](uint index);
cannam@132 416 void set(uint index, const DynamicValue::Reader& value);
cannam@132 417 DynamicValue::Builder init(uint index, uint size);
cannam@132 418 void adopt(uint index, Orphan<DynamicValue>&& orphan);
cannam@132 419 Orphan<DynamicValue> disown(uint index);
cannam@132 420
cannam@132 421 typedef _::IndexingIterator<Builder, DynamicStruct::Builder> Iterator;
cannam@132 422 inline Iterator begin() { return Iterator(this, 0); }
cannam@132 423 inline Iterator end() { return Iterator(this, size()); }
cannam@132 424
cannam@132 425 void copyFrom(std::initializer_list<DynamicValue::Reader> value);
cannam@132 426
cannam@132 427 Reader asReader() const;
cannam@132 428
cannam@132 429 private:
cannam@132 430 ListSchema schema;
cannam@132 431 _::ListBuilder builder;
cannam@132 432
cannam@132 433 Builder(ListSchema schema, _::ListBuilder builder): schema(schema), builder(builder) {}
cannam@132 434
cannam@132 435 template <typename T, Kind k>
cannam@132 436 friend struct _::PointerHelpers;
cannam@132 437 friend struct DynamicStruct;
cannam@132 438 template <typename T, ::capnp::Kind k>
cannam@132 439 friend struct ::capnp::ToDynamic_;
cannam@132 440 friend class Orphanage;
cannam@132 441 template <typename T, Kind k>
cannam@132 442 friend struct _::OrphanGetImpl;
cannam@132 443 friend class Orphan<DynamicList>;
cannam@132 444 friend class Orphan<DynamicValue>;
cannam@132 445 friend class Orphan<AnyPointer>;
cannam@132 446 };
cannam@132 447
cannam@132 448 // -------------------------------------------------------------------
cannam@132 449
cannam@132 450 class DynamicCapability::Client: public Capability::Client {
cannam@132 451 public:
cannam@132 452 typedef DynamicCapability Calls;
cannam@132 453 typedef DynamicCapability Reads;
cannam@132 454
cannam@132 455 Client() = default;
cannam@132 456
cannam@132 457 template <typename T, typename = kj::EnableIf<kind<FromClient<T>>() == Kind::INTERFACE>>
cannam@132 458 inline Client(T&& client);
cannam@132 459
cannam@132 460 template <typename T, typename = kj::EnableIf<kj::canConvert<T*, DynamicCapability::Server*>()>>
cannam@132 461 inline Client(kj::Own<T>&& server);
cannam@132 462
cannam@132 463 template <typename T, typename = kj::EnableIf<kind<T>() == Kind::INTERFACE>>
cannam@132 464 typename T::Client as();
cannam@132 465 template <typename T, typename = kj::EnableIf<kind<T>() == Kind::INTERFACE>>
cannam@132 466 typename T::Client releaseAs();
cannam@132 467 // Convert to any client type.
cannam@132 468
cannam@132 469 Client upcast(InterfaceSchema requestedSchema);
cannam@132 470 // Upcast to a superclass. Throws an exception if `schema` is not a superclass.
cannam@132 471
cannam@132 472 inline InterfaceSchema getSchema() { return schema; }
cannam@132 473
cannam@132 474 Request<DynamicStruct, DynamicStruct> newRequest(
cannam@132 475 InterfaceSchema::Method method, kj::Maybe<MessageSize> sizeHint = nullptr);
cannam@132 476 Request<DynamicStruct, DynamicStruct> newRequest(
cannam@132 477 kj::StringPtr methodName, kj::Maybe<MessageSize> sizeHint = nullptr);
cannam@132 478
cannam@132 479 private:
cannam@132 480 InterfaceSchema schema;
cannam@132 481
cannam@132 482 Client(InterfaceSchema schema, kj::Own<ClientHook>&& hook)
cannam@132 483 : Capability::Client(kj::mv(hook)), schema(schema) {}
cannam@132 484
cannam@132 485 template <typename T>
cannam@132 486 inline Client(InterfaceSchema schema, kj::Own<T>&& server);
cannam@132 487
cannam@132 488 friend struct Capability;
cannam@132 489 friend struct DynamicStruct;
cannam@132 490 friend struct DynamicList;
cannam@132 491 friend struct DynamicValue;
cannam@132 492 friend class Orphan<DynamicCapability>;
cannam@132 493 friend class Orphan<DynamicValue>;
cannam@132 494 friend class Orphan<AnyPointer>;
cannam@132 495 template <typename T, Kind k>
cannam@132 496 friend struct _::PointerHelpers;
cannam@132 497 };
cannam@132 498
cannam@132 499 class DynamicCapability::Server: public Capability::Server {
cannam@132 500 public:
cannam@132 501 typedef DynamicCapability Serves;
cannam@132 502
cannam@132 503 Server(InterfaceSchema schema): schema(schema) {}
cannam@132 504
cannam@132 505 virtual kj::Promise<void> call(InterfaceSchema::Method method,
cannam@132 506 CallContext<DynamicStruct, DynamicStruct> context) = 0;
cannam@132 507
cannam@132 508 kj::Promise<void> dispatchCall(uint64_t interfaceId, uint16_t methodId,
cannam@132 509 CallContext<AnyPointer, AnyPointer> context) override final;
cannam@132 510
cannam@132 511 inline InterfaceSchema getSchema() const { return schema; }
cannam@132 512
cannam@132 513 private:
cannam@132 514 InterfaceSchema schema;
cannam@132 515 };
cannam@132 516
cannam@132 517 template <>
cannam@132 518 class Request<DynamicStruct, DynamicStruct>: public DynamicStruct::Builder {
cannam@132 519 // Specialization of `Request<T, U>` for DynamicStruct.
cannam@132 520
cannam@132 521 public:
cannam@132 522 inline Request(DynamicStruct::Builder builder, kj::Own<RequestHook>&& hook,
cannam@132 523 StructSchema resultSchema)
cannam@132 524 : DynamicStruct::Builder(builder), hook(kj::mv(hook)), resultSchema(resultSchema) {}
cannam@132 525
cannam@132 526 RemotePromise<DynamicStruct> send();
cannam@132 527 // Send the call and return a promise for the results.
cannam@132 528
cannam@132 529 private:
cannam@132 530 kj::Own<RequestHook> hook;
cannam@132 531 StructSchema resultSchema;
cannam@132 532
cannam@132 533 friend class Capability::Client;
cannam@132 534 friend struct DynamicCapability;
cannam@132 535 template <typename, typename>
cannam@132 536 friend class CallContext;
cannam@132 537 friend class RequestHook;
cannam@132 538 };
cannam@132 539
cannam@132 540 template <>
cannam@132 541 class CallContext<DynamicStruct, DynamicStruct>: public kj::DisallowConstCopy {
cannam@132 542 // Wrapper around CallContextHook with a specific return type.
cannam@132 543 //
cannam@132 544 // Methods of this class may only be called from within the server's event loop, not from other
cannam@132 545 // threads.
cannam@132 546
cannam@132 547 public:
cannam@132 548 explicit CallContext(CallContextHook& hook, StructSchema paramType, StructSchema resultType);
cannam@132 549
cannam@132 550 DynamicStruct::Reader getParams();
cannam@132 551 void releaseParams();
cannam@132 552 DynamicStruct::Builder getResults(kj::Maybe<MessageSize> sizeHint = nullptr);
cannam@132 553 DynamicStruct::Builder initResults(kj::Maybe<MessageSize> sizeHint = nullptr);
cannam@132 554 void setResults(DynamicStruct::Reader value);
cannam@132 555 void adoptResults(Orphan<DynamicStruct>&& value);
cannam@132 556 Orphanage getResultsOrphanage(kj::Maybe<MessageSize> sizeHint = nullptr);
cannam@132 557 template <typename SubParams>
cannam@132 558 kj::Promise<void> tailCall(Request<SubParams, DynamicStruct>&& tailRequest);
cannam@132 559 void allowCancellation();
cannam@132 560
cannam@132 561 private:
cannam@132 562 CallContextHook* hook;
cannam@132 563 StructSchema paramType;
cannam@132 564 StructSchema resultType;
cannam@132 565
cannam@132 566 friend class DynamicCapability::Server;
cannam@132 567 };
cannam@132 568
cannam@132 569 // -------------------------------------------------------------------
cannam@132 570
cannam@132 571 // Make sure ReaderFor<T> and BuilderFor<T> work for DynamicEnum, DynamicStruct, and
cannam@132 572 // DynamicList, so that we can define DynamicValue::as().
cannam@132 573
cannam@132 574 template <> struct ReaderFor_ <DynamicEnum, Kind::OTHER> { typedef DynamicEnum Type; };
cannam@132 575 template <> struct BuilderFor_<DynamicEnum, Kind::OTHER> { typedef DynamicEnum Type; };
cannam@132 576 template <> struct ReaderFor_ <DynamicStruct, Kind::OTHER> { typedef DynamicStruct::Reader Type; };
cannam@132 577 template <> struct BuilderFor_<DynamicStruct, Kind::OTHER> { typedef DynamicStruct::Builder Type; };
cannam@132 578 template <> struct ReaderFor_ <DynamicList, Kind::OTHER> { typedef DynamicList::Reader Type; };
cannam@132 579 template <> struct BuilderFor_<DynamicList, Kind::OTHER> { typedef DynamicList::Builder Type; };
cannam@132 580 template <> struct ReaderFor_ <DynamicCapability, Kind::OTHER> { typedef DynamicCapability::Client Type; };
cannam@132 581 template <> struct BuilderFor_<DynamicCapability, Kind::OTHER> { typedef DynamicCapability::Client Type; };
cannam@132 582 template <> struct PipelineFor_<DynamicCapability, Kind::OTHER> { typedef DynamicCapability::Client Type; };
cannam@132 583
cannam@132 584 class DynamicValue::Reader {
cannam@132 585 public:
cannam@132 586 typedef DynamicValue Reads;
cannam@132 587
cannam@132 588 inline Reader(decltype(nullptr) n = nullptr); // UNKNOWN
cannam@132 589 inline Reader(Void value);
cannam@132 590 inline Reader(bool value);
cannam@132 591 inline Reader(char value);
cannam@132 592 inline Reader(signed char value);
cannam@132 593 inline Reader(short value);
cannam@132 594 inline Reader(int value);
cannam@132 595 inline Reader(long value);
cannam@132 596 inline Reader(long long value);
cannam@132 597 inline Reader(unsigned char value);
cannam@132 598 inline Reader(unsigned short value);
cannam@132 599 inline Reader(unsigned int value);
cannam@132 600 inline Reader(unsigned long value);
cannam@132 601 inline Reader(unsigned long long value);
cannam@132 602 inline Reader(float value);
cannam@132 603 inline Reader(double value);
cannam@132 604 inline Reader(const char* value); // Text
cannam@132 605 inline Reader(const Text::Reader& value);
cannam@132 606 inline Reader(const Data::Reader& value);
cannam@132 607 inline Reader(const DynamicList::Reader& value);
cannam@132 608 inline Reader(DynamicEnum value);
cannam@132 609 inline Reader(const DynamicStruct::Reader& value);
cannam@132 610 inline Reader(const AnyPointer::Reader& value);
cannam@132 611 inline Reader(DynamicCapability::Client& value);
cannam@132 612 inline Reader(DynamicCapability::Client&& value);
cannam@132 613 template <typename T, typename = kj::EnableIf<kj::canConvert<T*, DynamicCapability::Server*>()>>
cannam@132 614 inline Reader(kj::Own<T>&& value);
cannam@132 615 Reader(ConstSchema constant);
cannam@132 616
cannam@132 617 template <typename T, typename = decltype(toDynamic(kj::instance<T>()))>
cannam@132 618 inline Reader(T&& value): Reader(toDynamic(kj::mv(value))) {}
cannam@132 619
cannam@132 620 Reader(const Reader& other);
cannam@132 621 Reader(Reader&& other) noexcept;
cannam@132 622 ~Reader() noexcept(false);
cannam@132 623 Reader& operator=(const Reader& other);
cannam@132 624 Reader& operator=(Reader&& other);
cannam@132 625 // Unfortunately, we cannot use the implicit definitions of these since DynamicCapability is not
cannam@132 626 // trivially copyable.
cannam@132 627
cannam@132 628 template <typename T>
cannam@132 629 inline ReaderFor<T> as() const { return AsImpl<T>::apply(*this); }
cannam@132 630 // Use to interpret the value as some Cap'n Proto type. Allowed types are:
cannam@132 631 // - Void, bool, [u]int{8,16,32,64}_t, float, double, any enum: Returns the raw value.
cannam@132 632 // - Text, Data, AnyPointer, any struct type: Returns the corresponding Reader.
cannam@132 633 // - List<T> for any T listed above: Returns List<T>::Reader.
cannam@132 634 // - DynamicEnum: Returns the corresponding type.
cannam@132 635 // - DynamicStruct, DynamicList: Returns the corresponding Reader.
cannam@132 636 // - Any capability type, including DynamicCapability: Returns the corresponding Client.
cannam@132 637 // (TODO(perf): On GCC 4.8 / Clang 3.3, provide rvalue-qualified version that avoids
cannam@132 638 // refcounting.)
cannam@132 639 //
cannam@132 640 // DynamicValue allows various implicit conversions, mostly just to make the interface friendlier.
cannam@132 641 // - Any integer can be converted to any other integer type so long as the actual value is within
cannam@132 642 // the new type's range.
cannam@132 643 // - Floating-point types can be converted to integers as long as no information would be lost
cannam@132 644 // in the conversion.
cannam@132 645 // - Integers can be converted to floating points. This may lose information, but won't throw.
cannam@132 646 // - Float32/Float64 can be converted between each other. Converting Float64 -> Float32 may lose
cannam@132 647 // information, but won't throw.
cannam@132 648 // - Text can be converted to an enum, if the Text matches one of the enumerant names (but not
cannam@132 649 // vice-versa).
cannam@132 650 // - Capabilities can be upcast (cast to a supertype), but not downcast.
cannam@132 651 //
cannam@132 652 // Any other conversion attempt will throw an exception.
cannam@132 653
cannam@132 654 inline Type getType() const { return type; }
cannam@132 655 // Get the type of this value.
cannam@132 656
cannam@132 657 private:
cannam@132 658 Type type;
cannam@132 659
cannam@132 660 union {
cannam@132 661 Void voidValue;
cannam@132 662 bool boolValue;
cannam@132 663 int64_t intValue;
cannam@132 664 uint64_t uintValue;
cannam@132 665 double floatValue;
cannam@132 666 Text::Reader textValue;
cannam@132 667 Data::Reader dataValue;
cannam@132 668 DynamicList::Reader listValue;
cannam@132 669 DynamicEnum enumValue;
cannam@132 670 DynamicStruct::Reader structValue;
cannam@132 671 AnyPointer::Reader anyPointerValue;
cannam@132 672
cannam@132 673 mutable DynamicCapability::Client capabilityValue;
cannam@132 674 // Declared mutable because `Client`s normally cannot be const.
cannam@132 675
cannam@132 676 // Warning: Copy/move constructors assume all these types are trivially copyable except
cannam@132 677 // Capability.
cannam@132 678 };
cannam@132 679
cannam@132 680 template <typename T, Kind kind = kind<T>()> struct AsImpl;
cannam@132 681 // Implementation backing the as() method. Needs to be a struct to allow partial
cannam@132 682 // specialization. Has a method apply() which does the work.
cannam@132 683
cannam@132 684 friend class Orphanage; // to speed up newOrphanCopy(DynamicValue::Reader)
cannam@132 685 };
cannam@132 686
cannam@132 687 class DynamicValue::Builder {
cannam@132 688 public:
cannam@132 689 typedef DynamicValue Builds;
cannam@132 690
cannam@132 691 inline Builder(decltype(nullptr) n = nullptr); // UNKNOWN
cannam@132 692 inline Builder(Void value);
cannam@132 693 inline Builder(bool value);
cannam@132 694 inline Builder(char value);
cannam@132 695 inline Builder(signed char value);
cannam@132 696 inline Builder(short value);
cannam@132 697 inline Builder(int value);
cannam@132 698 inline Builder(long value);
cannam@132 699 inline Builder(long long value);
cannam@132 700 inline Builder(unsigned char value);
cannam@132 701 inline Builder(unsigned short value);
cannam@132 702 inline Builder(unsigned int value);
cannam@132 703 inline Builder(unsigned long value);
cannam@132 704 inline Builder(unsigned long long value);
cannam@132 705 inline Builder(float value);
cannam@132 706 inline Builder(double value);
cannam@132 707 inline Builder(Text::Builder value);
cannam@132 708 inline Builder(Data::Builder value);
cannam@132 709 inline Builder(DynamicList::Builder value);
cannam@132 710 inline Builder(DynamicEnum value);
cannam@132 711 inline Builder(DynamicStruct::Builder value);
cannam@132 712 inline Builder(AnyPointer::Builder value);
cannam@132 713 inline Builder(DynamicCapability::Client& value);
cannam@132 714 inline Builder(DynamicCapability::Client&& value);
cannam@132 715
cannam@132 716 template <typename T, typename = decltype(toDynamic(kj::instance<T>()))>
cannam@132 717 inline Builder(T value): Builder(toDynamic(value)) {}
cannam@132 718
cannam@132 719 Builder(Builder& other);
cannam@132 720 Builder(Builder&& other) noexcept;
cannam@132 721 ~Builder() noexcept(false);
cannam@132 722 Builder& operator=(Builder& other);
cannam@132 723 Builder& operator=(Builder&& other);
cannam@132 724 // Unfortunately, we cannot use the implicit definitions of these since DynamicCapability is not
cannam@132 725 // trivially copyable.
cannam@132 726
cannam@132 727 template <typename T>
cannam@132 728 inline BuilderFor<T> as() { return AsImpl<T>::apply(*this); }
cannam@132 729 // See DynamicValue::Reader::as().
cannam@132 730
cannam@132 731 inline Type getType() { return type; }
cannam@132 732 // Get the type of this value.
cannam@132 733
cannam@132 734 Reader asReader() const;
cannam@132 735
cannam@132 736 private:
cannam@132 737 Type type;
cannam@132 738
cannam@132 739 union {
cannam@132 740 Void voidValue;
cannam@132 741 bool boolValue;
cannam@132 742 int64_t intValue;
cannam@132 743 uint64_t uintValue;
cannam@132 744 double floatValue;
cannam@132 745 Text::Builder textValue;
cannam@132 746 Data::Builder dataValue;
cannam@132 747 DynamicList::Builder listValue;
cannam@132 748 DynamicEnum enumValue;
cannam@132 749 DynamicStruct::Builder structValue;
cannam@132 750 AnyPointer::Builder anyPointerValue;
cannam@132 751
cannam@132 752 mutable DynamicCapability::Client capabilityValue;
cannam@132 753 // Declared mutable because `Client`s normally cannot be const.
cannam@132 754 };
cannam@132 755
cannam@132 756 template <typename T, Kind kind = kind<T>()> struct AsImpl;
cannam@132 757 // Implementation backing the as() method. Needs to be a struct to allow partial
cannam@132 758 // specialization. Has a method apply() which does the work.
cannam@132 759
cannam@132 760 friend class Orphan<DynamicValue>;
cannam@132 761 };
cannam@132 762
cannam@132 763 class DynamicValue::Pipeline {
cannam@132 764 public:
cannam@132 765 typedef DynamicValue Pipelines;
cannam@132 766
cannam@132 767 inline Pipeline(decltype(nullptr) n = nullptr);
cannam@132 768 inline Pipeline(DynamicStruct::Pipeline&& value);
cannam@132 769 inline Pipeline(DynamicCapability::Client&& value);
cannam@132 770
cannam@132 771 Pipeline(Pipeline&& other) noexcept;
cannam@132 772 Pipeline& operator=(Pipeline&& other);
cannam@132 773 ~Pipeline() noexcept(false);
cannam@132 774
cannam@132 775 template <typename T>
cannam@132 776 inline PipelineFor<T> releaseAs() { return AsImpl<T>::apply(*this); }
cannam@132 777
cannam@132 778 inline Type getType() { return type; }
cannam@132 779 // Get the type of this value.
cannam@132 780
cannam@132 781 private:
cannam@132 782 Type type;
cannam@132 783 union {
cannam@132 784 DynamicStruct::Pipeline structValue;
cannam@132 785 DynamicCapability::Client capabilityValue;
cannam@132 786 };
cannam@132 787
cannam@132 788 template <typename T, Kind kind = kind<T>()> struct AsImpl;
cannam@132 789 // Implementation backing the releaseAs() method. Needs to be a struct to allow partial
cannam@132 790 // specialization. Has a method apply() which does the work.
cannam@132 791 };
cannam@132 792
cannam@132 793 kj::StringTree KJ_STRINGIFY(const DynamicValue::Reader& value);
cannam@132 794 kj::StringTree KJ_STRINGIFY(const DynamicValue::Builder& value);
cannam@132 795 kj::StringTree KJ_STRINGIFY(DynamicEnum value);
cannam@132 796 kj::StringTree KJ_STRINGIFY(const DynamicStruct::Reader& value);
cannam@132 797 kj::StringTree KJ_STRINGIFY(const DynamicStruct::Builder& value);
cannam@132 798 kj::StringTree KJ_STRINGIFY(const DynamicList::Reader& value);
cannam@132 799 kj::StringTree KJ_STRINGIFY(const DynamicList::Builder& value);
cannam@132 800
cannam@132 801 // -------------------------------------------------------------------
cannam@132 802 // Orphan <-> Dynamic glue
cannam@132 803
cannam@132 804 template <>
cannam@132 805 class Orphan<DynamicStruct> {
cannam@132 806 public:
cannam@132 807 Orphan() = default;
cannam@132 808 KJ_DISALLOW_COPY(Orphan);
cannam@132 809 Orphan(Orphan&&) = default;
cannam@132 810 Orphan& operator=(Orphan&&) = default;
cannam@132 811
cannam@132 812 template <typename T, typename = kj::EnableIf<kind<T>() == Kind::STRUCT>>
cannam@132 813 inline Orphan(Orphan<T>&& other): schema(Schema::from<T>()), builder(kj::mv(other.builder)) {}
cannam@132 814
cannam@132 815 DynamicStruct::Builder get();
cannam@132 816 DynamicStruct::Reader getReader() const;
cannam@132 817
cannam@132 818 template <typename T>
cannam@132 819 Orphan<T> releaseAs();
cannam@132 820 // Like DynamicStruct::Builder::as(), but coerces the Orphan type. Since Orphans are move-only,
cannam@132 821 // the original Orphan<DynamicStruct> is no longer valid after this call; ownership is
cannam@132 822 // transferred to the returned Orphan<T>.
cannam@132 823
cannam@132 824 inline bool operator==(decltype(nullptr)) const { return builder == nullptr; }
cannam@132 825 inline bool operator!=(decltype(nullptr)) const { return builder != nullptr; }
cannam@132 826
cannam@132 827 private:
cannam@132 828 StructSchema schema;
cannam@132 829 _::OrphanBuilder builder;
cannam@132 830
cannam@132 831 inline Orphan(StructSchema schema, _::OrphanBuilder&& builder)
cannam@132 832 : schema(schema), builder(kj::mv(builder)) {}
cannam@132 833
cannam@132 834 template <typename, Kind>
cannam@132 835 friend struct _::PointerHelpers;
cannam@132 836 friend struct DynamicList;
cannam@132 837 friend class Orphanage;
cannam@132 838 friend class Orphan<DynamicValue>;
cannam@132 839 friend class Orphan<AnyPointer>;
cannam@132 840 friend class MessageBuilder;
cannam@132 841 };
cannam@132 842
cannam@132 843 template <>
cannam@132 844 class Orphan<DynamicList> {
cannam@132 845 public:
cannam@132 846 Orphan() = default;
cannam@132 847 KJ_DISALLOW_COPY(Orphan);
cannam@132 848 Orphan(Orphan&&) = default;
cannam@132 849 Orphan& operator=(Orphan&&) = default;
cannam@132 850
cannam@132 851 template <typename T, typename = kj::EnableIf<kind<T>() == Kind::LIST>>
cannam@132 852 inline Orphan(Orphan<T>&& other): schema(Schema::from<T>()), builder(kj::mv(other.builder)) {}
cannam@132 853
cannam@132 854 DynamicList::Builder get();
cannam@132 855 DynamicList::Reader getReader() const;
cannam@132 856
cannam@132 857 template <typename T>
cannam@132 858 Orphan<T> releaseAs();
cannam@132 859 // Like DynamicList::Builder::as(), but coerces the Orphan type. Since Orphans are move-only,
cannam@132 860 // the original Orphan<DynamicStruct> is no longer valid after this call; ownership is
cannam@132 861 // transferred to the returned Orphan<T>.
cannam@132 862
cannam@132 863 // TODO(someday): Support truncate().
cannam@132 864
cannam@132 865 inline bool operator==(decltype(nullptr)) const { return builder == nullptr; }
cannam@132 866 inline bool operator!=(decltype(nullptr)) const { return builder != nullptr; }
cannam@132 867
cannam@132 868 private:
cannam@132 869 ListSchema schema;
cannam@132 870 _::OrphanBuilder builder;
cannam@132 871
cannam@132 872 inline Orphan(ListSchema schema, _::OrphanBuilder&& builder)
cannam@132 873 : schema(schema), builder(kj::mv(builder)) {}
cannam@132 874
cannam@132 875 template <typename, Kind>
cannam@132 876 friend struct _::PointerHelpers;
cannam@132 877 friend struct DynamicList;
cannam@132 878 friend class Orphanage;
cannam@132 879 friend class Orphan<DynamicValue>;
cannam@132 880 friend class Orphan<AnyPointer>;
cannam@132 881 };
cannam@132 882
cannam@132 883 template <>
cannam@132 884 class Orphan<DynamicCapability> {
cannam@132 885 public:
cannam@132 886 Orphan() = default;
cannam@132 887 KJ_DISALLOW_COPY(Orphan);
cannam@132 888 Orphan(Orphan&&) = default;
cannam@132 889 Orphan& operator=(Orphan&&) = default;
cannam@132 890
cannam@132 891 template <typename T, typename = kj::EnableIf<kind<T>() == Kind::INTERFACE>>
cannam@132 892 inline Orphan(Orphan<T>&& other): schema(Schema::from<T>()), builder(kj::mv(other.builder)) {}
cannam@132 893
cannam@132 894 DynamicCapability::Client get();
cannam@132 895 DynamicCapability::Client getReader() const;
cannam@132 896
cannam@132 897 template <typename T>
cannam@132 898 Orphan<T> releaseAs();
cannam@132 899 // Like DynamicCapability::Client::as(), but coerces the Orphan type. Since Orphans are move-only,
cannam@132 900 // the original Orphan<DynamicCapability> is no longer valid after this call; ownership is
cannam@132 901 // transferred to the returned Orphan<T>.
cannam@132 902
cannam@132 903 inline bool operator==(decltype(nullptr)) const { return builder == nullptr; }
cannam@132 904 inline bool operator!=(decltype(nullptr)) const { return builder != nullptr; }
cannam@132 905
cannam@132 906 private:
cannam@132 907 InterfaceSchema schema;
cannam@132 908 _::OrphanBuilder builder;
cannam@132 909
cannam@132 910 inline Orphan(InterfaceSchema schema, _::OrphanBuilder&& builder)
cannam@132 911 : schema(schema), builder(kj::mv(builder)) {}
cannam@132 912
cannam@132 913 template <typename, Kind>
cannam@132 914 friend struct _::PointerHelpers;
cannam@132 915 friend struct DynamicList;
cannam@132 916 friend class Orphanage;
cannam@132 917 friend class Orphan<DynamicValue>;
cannam@132 918 friend class Orphan<AnyPointer>;
cannam@132 919 };
cannam@132 920
cannam@132 921 template <>
cannam@132 922 class Orphan<DynamicValue> {
cannam@132 923 public:
cannam@132 924 inline Orphan(decltype(nullptr) n = nullptr): type(DynamicValue::UNKNOWN) {}
cannam@132 925 inline Orphan(Void value);
cannam@132 926 inline Orphan(bool value);
cannam@132 927 inline Orphan(char value);
cannam@132 928 inline Orphan(signed char value);
cannam@132 929 inline Orphan(short value);
cannam@132 930 inline Orphan(int value);
cannam@132 931 inline Orphan(long value);
cannam@132 932 inline Orphan(long long value);
cannam@132 933 inline Orphan(unsigned char value);
cannam@132 934 inline Orphan(unsigned short value);
cannam@132 935 inline Orphan(unsigned int value);
cannam@132 936 inline Orphan(unsigned long value);
cannam@132 937 inline Orphan(unsigned long long value);
cannam@132 938 inline Orphan(float value);
cannam@132 939 inline Orphan(double value);
cannam@132 940 inline Orphan(DynamicEnum value);
cannam@132 941 Orphan(Orphan&&) = default;
cannam@132 942 template <typename T>
cannam@132 943 Orphan(Orphan<T>&&);
cannam@132 944 Orphan(Orphan<AnyPointer>&&);
cannam@132 945 Orphan(void*) = delete; // So Orphan(bool) doesn't accept pointers.
cannam@132 946 KJ_DISALLOW_COPY(Orphan);
cannam@132 947
cannam@132 948 Orphan& operator=(Orphan&&) = default;
cannam@132 949
cannam@132 950 inline DynamicValue::Type getType() { return type; }
cannam@132 951
cannam@132 952 DynamicValue::Builder get();
cannam@132 953 DynamicValue::Reader getReader() const;
cannam@132 954
cannam@132 955 template <typename T>
cannam@132 956 Orphan<T> releaseAs();
cannam@132 957 // Like DynamicValue::Builder::as(), but coerces the Orphan type. Since Orphans are move-only,
cannam@132 958 // the original Orphan<DynamicStruct> is no longer valid after this call; ownership is
cannam@132 959 // transferred to the returned Orphan<T>.
cannam@132 960
cannam@132 961 private:
cannam@132 962 DynamicValue::Type type;
cannam@132 963 union {
cannam@132 964 Void voidValue;
cannam@132 965 bool boolValue;
cannam@132 966 int64_t intValue;
cannam@132 967 uint64_t uintValue;
cannam@132 968 double floatValue;
cannam@132 969 DynamicEnum enumValue;
cannam@132 970 StructSchema structSchema;
cannam@132 971 ListSchema listSchema;
cannam@132 972 InterfaceSchema interfaceSchema;
cannam@132 973 };
cannam@132 974
cannam@132 975 _::OrphanBuilder builder;
cannam@132 976 // Only used if `type` is a pointer type.
cannam@132 977
cannam@132 978 Orphan(DynamicValue::Builder value, _::OrphanBuilder&& builder);
cannam@132 979 Orphan(DynamicValue::Type type, _::OrphanBuilder&& builder)
cannam@132 980 : type(type), builder(kj::mv(builder)) {}
cannam@132 981 Orphan(StructSchema structSchema, _::OrphanBuilder&& builder)
cannam@132 982 : type(DynamicValue::STRUCT), structSchema(structSchema), builder(kj::mv(builder)) {}
cannam@132 983 Orphan(ListSchema listSchema, _::OrphanBuilder&& builder)
cannam@132 984 : type(DynamicValue::LIST), listSchema(listSchema), builder(kj::mv(builder)) {}
cannam@132 985
cannam@132 986 template <typename, Kind>
cannam@132 987 friend struct _::PointerHelpers;
cannam@132 988 friend struct DynamicStruct;
cannam@132 989 friend struct DynamicList;
cannam@132 990 friend struct AnyPointer;
cannam@132 991 friend class Orphanage;
cannam@132 992 };
cannam@132 993
cannam@132 994 template <typename T>
cannam@132 995 inline Orphan<DynamicValue>::Orphan(Orphan<T>&& other)
cannam@132 996 : Orphan(other.get(), kj::mv(other.builder)) {}
cannam@132 997
cannam@132 998 inline Orphan<DynamicValue>::Orphan(Orphan<AnyPointer>&& other)
cannam@132 999 : type(DynamicValue::ANY_POINTER), builder(kj::mv(other.builder)) {}
cannam@132 1000
cannam@132 1001 template <typename T>
cannam@132 1002 Orphan<T> Orphan<DynamicStruct>::releaseAs() {
cannam@132 1003 get().as<T>(); // type check
cannam@132 1004 return Orphan<T>(kj::mv(builder));
cannam@132 1005 }
cannam@132 1006
cannam@132 1007 template <typename T>
cannam@132 1008 Orphan<T> Orphan<DynamicList>::releaseAs() {
cannam@132 1009 get().as<T>(); // type check
cannam@132 1010 return Orphan<T>(kj::mv(builder));
cannam@132 1011 }
cannam@132 1012
cannam@132 1013 template <typename T>
cannam@132 1014 Orphan<T> Orphan<DynamicCapability>::releaseAs() {
cannam@132 1015 get().as<T>(); // type check
cannam@132 1016 return Orphan<T>(kj::mv(builder));
cannam@132 1017 }
cannam@132 1018
cannam@132 1019 template <typename T>
cannam@132 1020 Orphan<T> Orphan<DynamicValue>::releaseAs() {
cannam@132 1021 get().as<T>(); // type check
cannam@132 1022 type = DynamicValue::UNKNOWN;
cannam@132 1023 return Orphan<T>(kj::mv(builder));
cannam@132 1024 }
cannam@132 1025
cannam@132 1026 template <>
cannam@132 1027 Orphan<AnyPointer> Orphan<DynamicValue>::releaseAs<AnyPointer>();
cannam@132 1028 template <>
cannam@132 1029 Orphan<DynamicStruct> Orphan<DynamicValue>::releaseAs<DynamicStruct>();
cannam@132 1030 template <>
cannam@132 1031 Orphan<DynamicList> Orphan<DynamicValue>::releaseAs<DynamicList>();
cannam@132 1032 template <>
cannam@132 1033 Orphan<DynamicCapability> Orphan<DynamicValue>::releaseAs<DynamicCapability>();
cannam@132 1034
cannam@132 1035 template <>
cannam@132 1036 struct Orphanage::GetInnerBuilder<DynamicStruct, Kind::OTHER> {
cannam@132 1037 static inline _::StructBuilder apply(DynamicStruct::Builder& t) {
cannam@132 1038 return t.builder;
cannam@132 1039 }
cannam@132 1040 };
cannam@132 1041
cannam@132 1042 template <>
cannam@132 1043 struct Orphanage::GetInnerBuilder<DynamicList, Kind::OTHER> {
cannam@132 1044 static inline _::ListBuilder apply(DynamicList::Builder& t) {
cannam@132 1045 return t.builder;
cannam@132 1046 }
cannam@132 1047 };
cannam@132 1048
cannam@132 1049 template <>
cannam@132 1050 inline Orphan<DynamicStruct> Orphanage::newOrphanCopy<DynamicStruct::Reader>(
cannam@132 1051 DynamicStruct::Reader copyFrom) const {
cannam@132 1052 return Orphan<DynamicStruct>(
cannam@132 1053 copyFrom.getSchema(), _::OrphanBuilder::copy(arena, capTable, copyFrom.reader));
cannam@132 1054 }
cannam@132 1055
cannam@132 1056 template <>
cannam@132 1057 inline Orphan<DynamicList> Orphanage::newOrphanCopy<DynamicList::Reader>(
cannam@132 1058 DynamicList::Reader copyFrom) const {
cannam@132 1059 return Orphan<DynamicList>(copyFrom.getSchema(),
cannam@132 1060 _::OrphanBuilder::copy(arena, capTable, copyFrom.reader));
cannam@132 1061 }
cannam@132 1062
cannam@132 1063 template <>
cannam@132 1064 inline Orphan<DynamicCapability> Orphanage::newOrphanCopy<DynamicCapability::Client>(
cannam@132 1065 DynamicCapability::Client copyFrom) const {
cannam@132 1066 return Orphan<DynamicCapability>(
cannam@132 1067 copyFrom.getSchema(), _::OrphanBuilder::copy(arena, capTable, copyFrom.hook->addRef()));
cannam@132 1068 }
cannam@132 1069
cannam@132 1070 template <>
cannam@132 1071 Orphan<DynamicValue> Orphanage::newOrphanCopy<DynamicValue::Reader>(
cannam@132 1072 DynamicValue::Reader copyFrom) const;
cannam@132 1073
cannam@132 1074 namespace _ { // private
cannam@132 1075
cannam@132 1076 template <>
cannam@132 1077 struct PointerHelpers<DynamicStruct, Kind::OTHER> {
cannam@132 1078 // getDynamic() is used when an AnyPointer's get() accessor is passed arguments, because for
cannam@132 1079 // non-dynamic types PointerHelpers::get() takes a default value as the third argument, and we
cannam@132 1080 // don't want people to accidentally be able to provide their own default value.
cannam@132 1081 static DynamicStruct::Reader getDynamic(PointerReader reader, StructSchema schema);
cannam@132 1082 static DynamicStruct::Builder getDynamic(PointerBuilder builder, StructSchema schema);
cannam@132 1083 static void set(PointerBuilder builder, const DynamicStruct::Reader& value);
cannam@132 1084 static DynamicStruct::Builder init(PointerBuilder builder, StructSchema schema);
cannam@132 1085 static inline void adopt(PointerBuilder builder, Orphan<DynamicStruct>&& value) {
cannam@132 1086 builder.adopt(kj::mv(value.builder));
cannam@132 1087 }
cannam@132 1088 static inline Orphan<DynamicStruct> disown(PointerBuilder builder, StructSchema schema) {
cannam@132 1089 return Orphan<DynamicStruct>(schema, builder.disown());
cannam@132 1090 }
cannam@132 1091 };
cannam@132 1092
cannam@132 1093 template <>
cannam@132 1094 struct PointerHelpers<DynamicList, Kind::OTHER> {
cannam@132 1095 // getDynamic() is used when an AnyPointer's get() accessor is passed arguments, because for
cannam@132 1096 // non-dynamic types PointerHelpers::get() takes a default value as the third argument, and we
cannam@132 1097 // don't want people to accidentally be able to provide their own default value.
cannam@132 1098 static DynamicList::Reader getDynamic(PointerReader reader, ListSchema schema);
cannam@132 1099 static DynamicList::Builder getDynamic(PointerBuilder builder, ListSchema schema);
cannam@132 1100 static void set(PointerBuilder builder, const DynamicList::Reader& value);
cannam@132 1101 static DynamicList::Builder init(PointerBuilder builder, ListSchema schema, uint size);
cannam@132 1102 static inline void adopt(PointerBuilder builder, Orphan<DynamicList>&& value) {
cannam@132 1103 builder.adopt(kj::mv(value.builder));
cannam@132 1104 }
cannam@132 1105 static inline Orphan<DynamicList> disown(PointerBuilder builder, ListSchema schema) {
cannam@132 1106 return Orphan<DynamicList>(schema, builder.disown());
cannam@132 1107 }
cannam@132 1108 };
cannam@132 1109
cannam@132 1110 template <>
cannam@132 1111 struct PointerHelpers<DynamicCapability, Kind::OTHER> {
cannam@132 1112 // getDynamic() is used when an AnyPointer's get() accessor is passed arguments, because for
cannam@132 1113 // non-dynamic types PointerHelpers::get() takes a default value as the third argument, and we
cannam@132 1114 // don't want people to accidentally be able to provide their own default value.
cannam@132 1115 static DynamicCapability::Client getDynamic(PointerReader reader, InterfaceSchema schema);
cannam@132 1116 static DynamicCapability::Client getDynamic(PointerBuilder builder, InterfaceSchema schema);
cannam@132 1117 static void set(PointerBuilder builder, DynamicCapability::Client& value);
cannam@132 1118 static void set(PointerBuilder builder, DynamicCapability::Client&& value);
cannam@132 1119 static inline void adopt(PointerBuilder builder, Orphan<DynamicCapability>&& value) {
cannam@132 1120 builder.adopt(kj::mv(value.builder));
cannam@132 1121 }
cannam@132 1122 static inline Orphan<DynamicCapability> disown(PointerBuilder builder, InterfaceSchema schema) {
cannam@132 1123 return Orphan<DynamicCapability>(schema, builder.disown());
cannam@132 1124 }
cannam@132 1125 };
cannam@132 1126
cannam@132 1127 } // namespace _ (private)
cannam@132 1128
cannam@132 1129 template <typename T>
cannam@132 1130 inline ReaderFor<T> AnyPointer::Reader::getAs(StructSchema schema) const {
cannam@132 1131 return _::PointerHelpers<T>::getDynamic(reader, schema);
cannam@132 1132 }
cannam@132 1133 template <typename T>
cannam@132 1134 inline ReaderFor<T> AnyPointer::Reader::getAs(ListSchema schema) const {
cannam@132 1135 return _::PointerHelpers<T>::getDynamic(reader, schema);
cannam@132 1136 }
cannam@132 1137 template <typename T>
cannam@132 1138 inline ReaderFor<T> AnyPointer::Reader::getAs(InterfaceSchema schema) const {
cannam@132 1139 return _::PointerHelpers<T>::getDynamic(reader, schema);
cannam@132 1140 }
cannam@132 1141 template <typename T>
cannam@132 1142 inline BuilderFor<T> AnyPointer::Builder::getAs(StructSchema schema) {
cannam@132 1143 return _::PointerHelpers<T>::getDynamic(builder, schema);
cannam@132 1144 }
cannam@132 1145 template <typename T>
cannam@132 1146 inline BuilderFor<T> AnyPointer::Builder::getAs(ListSchema schema) {
cannam@132 1147 return _::PointerHelpers<T>::getDynamic(builder, schema);
cannam@132 1148 }
cannam@132 1149 template <typename T>
cannam@132 1150 inline BuilderFor<T> AnyPointer::Builder::getAs(InterfaceSchema schema) {
cannam@132 1151 return _::PointerHelpers<T>::getDynamic(builder, schema);
cannam@132 1152 }
cannam@132 1153 template <typename T>
cannam@132 1154 inline BuilderFor<T> AnyPointer::Builder::initAs(StructSchema schema) {
cannam@132 1155 return _::PointerHelpers<T>::init(builder, schema);
cannam@132 1156 }
cannam@132 1157 template <typename T>
cannam@132 1158 inline BuilderFor<T> AnyPointer::Builder::initAs(ListSchema schema, uint elementCount) {
cannam@132 1159 return _::PointerHelpers<T>::init(builder, schema, elementCount);
cannam@132 1160 }
cannam@132 1161 template <>
cannam@132 1162 inline void AnyPointer::Builder::setAs<DynamicStruct>(DynamicStruct::Reader value) {
cannam@132 1163 return _::PointerHelpers<DynamicStruct>::set(builder, value);
cannam@132 1164 }
cannam@132 1165 template <>
cannam@132 1166 inline void AnyPointer::Builder::setAs<DynamicList>(DynamicList::Reader value) {
cannam@132 1167 return _::PointerHelpers<DynamicList>::set(builder, value);
cannam@132 1168 }
cannam@132 1169 template <>
cannam@132 1170 inline void AnyPointer::Builder::setAs<DynamicCapability>(DynamicCapability::Client value) {
cannam@132 1171 return _::PointerHelpers<DynamicCapability>::set(builder, kj::mv(value));
cannam@132 1172 }
cannam@132 1173 template <>
cannam@132 1174 void AnyPointer::Builder::adopt<DynamicValue>(Orphan<DynamicValue>&& orphan);
cannam@132 1175 template <typename T>
cannam@132 1176 inline Orphan<T> AnyPointer::Builder::disownAs(StructSchema schema) {
cannam@132 1177 return _::PointerHelpers<T>::disown(builder, schema);
cannam@132 1178 }
cannam@132 1179 template <typename T>
cannam@132 1180 inline Orphan<T> AnyPointer::Builder::disownAs(ListSchema schema) {
cannam@132 1181 return _::PointerHelpers<T>::disown(builder, schema);
cannam@132 1182 }
cannam@132 1183 template <typename T>
cannam@132 1184 inline Orphan<T> AnyPointer::Builder::disownAs(InterfaceSchema schema) {
cannam@132 1185 return _::PointerHelpers<T>::disown(builder, schema);
cannam@132 1186 }
cannam@132 1187
cannam@132 1188 template <>
cannam@132 1189 DynamicStruct::Builder Orphan<AnyPointer>::getAs<DynamicStruct>(StructSchema schema);
cannam@132 1190 template <>
cannam@132 1191 DynamicList::Builder Orphan<AnyPointer>::getAs<DynamicList>(ListSchema schema);
cannam@132 1192 template <>
cannam@132 1193 DynamicCapability::Client Orphan<AnyPointer>::getAs<DynamicCapability>(InterfaceSchema schema);
cannam@132 1194 template <>
cannam@132 1195 DynamicStruct::Reader Orphan<AnyPointer>::getAsReader<DynamicStruct>(StructSchema schema) const;
cannam@132 1196 template <>
cannam@132 1197 DynamicList::Reader Orphan<AnyPointer>::getAsReader<DynamicList>(ListSchema schema) const;
cannam@132 1198 template <>
cannam@132 1199 DynamicCapability::Client Orphan<AnyPointer>::getAsReader<DynamicCapability>(
cannam@132 1200 InterfaceSchema schema) const;
cannam@132 1201 template <>
cannam@132 1202 Orphan<DynamicStruct> Orphan<AnyPointer>::releaseAs<DynamicStruct>(StructSchema schema);
cannam@132 1203 template <>
cannam@132 1204 Orphan<DynamicList> Orphan<AnyPointer>::releaseAs<DynamicList>(ListSchema schema);
cannam@132 1205 template <>
cannam@132 1206 Orphan<DynamicCapability> Orphan<AnyPointer>::releaseAs<DynamicCapability>(
cannam@132 1207 InterfaceSchema schema);
cannam@132 1208
cannam@132 1209 // =======================================================================================
cannam@132 1210 // Inline implementation details.
cannam@132 1211
cannam@132 1212 template <typename T>
cannam@132 1213 struct ToDynamic_<T, Kind::STRUCT> {
cannam@132 1214 static inline DynamicStruct::Reader apply(const typename T::Reader& value) {
cannam@132 1215 return DynamicStruct::Reader(Schema::from<T>(), value._reader);
cannam@132 1216 }
cannam@132 1217 static inline DynamicStruct::Builder apply(typename T::Builder& value) {
cannam@132 1218 return DynamicStruct::Builder(Schema::from<T>(), value._builder);
cannam@132 1219 }
cannam@132 1220 };
cannam@132 1221
cannam@132 1222 template <typename T>
cannam@132 1223 struct ToDynamic_<T, Kind::LIST> {
cannam@132 1224 static inline DynamicList::Reader apply(const typename T::Reader& value) {
cannam@132 1225 return DynamicList::Reader(Schema::from<T>(), value.reader);
cannam@132 1226 }
cannam@132 1227 static inline DynamicList::Builder apply(typename T::Builder& value) {
cannam@132 1228 return DynamicList::Builder(Schema::from<T>(), value.builder);
cannam@132 1229 }
cannam@132 1230 };
cannam@132 1231
cannam@132 1232 template <typename T>
cannam@132 1233 struct ToDynamic_<T, Kind::INTERFACE> {
cannam@132 1234 static inline DynamicCapability::Client apply(typename T::Client value) {
cannam@132 1235 return DynamicCapability::Client(kj::mv(value));
cannam@132 1236 }
cannam@132 1237 static inline DynamicCapability::Client apply(typename T::Client&& value) {
cannam@132 1238 return DynamicCapability::Client(kj::mv(value));
cannam@132 1239 }
cannam@132 1240 };
cannam@132 1241
cannam@132 1242 template <typename T>
cannam@132 1243 ReaderFor<DynamicTypeFor<FromReader<T>>> toDynamic(T&& value) {
cannam@132 1244 return ToDynamic_<FromReader<T>>::apply(value);
cannam@132 1245 }
cannam@132 1246 template <typename T>
cannam@132 1247 BuilderFor<DynamicTypeFor<FromBuilder<T>>> toDynamic(T&& value) {
cannam@132 1248 return ToDynamic_<FromBuilder<T>>::apply(value);
cannam@132 1249 }
cannam@132 1250 template <typename T>
cannam@132 1251 DynamicTypeFor<TypeIfEnum<T>> toDynamic(T&& value) {
cannam@132 1252 return DynamicEnum(Schema::from<kj::Decay<T>>(), static_cast<uint16_t>(value));
cannam@132 1253 }
cannam@132 1254 template <typename T>
cannam@132 1255 typename DynamicTypeFor<FromServer<T>>::Client toDynamic(kj::Own<T>&& value) {
cannam@132 1256 return typename FromServer<T>::Client(kj::mv(value));
cannam@132 1257 }
cannam@132 1258
cannam@132 1259 inline DynamicValue::Reader::Reader(std::nullptr_t n): type(UNKNOWN) {}
cannam@132 1260 inline DynamicValue::Builder::Builder(std::nullptr_t n): type(UNKNOWN) {}
cannam@132 1261
cannam@132 1262 #define CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(cppType, typeTag, fieldName) \
cannam@132 1263 inline DynamicValue::Reader::Reader(cppType value) \
cannam@132 1264 : type(typeTag), fieldName##Value(value) {} \
cannam@132 1265 inline DynamicValue::Builder::Builder(cppType value) \
cannam@132 1266 : type(typeTag), fieldName##Value(value) {} \
cannam@132 1267 inline Orphan<DynamicValue>::Orphan(cppType value) \
cannam@132 1268 : type(DynamicValue::typeTag), fieldName##Value(value) {}
cannam@132 1269
cannam@132 1270 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(Void, VOID, void);
cannam@132 1271 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(bool, BOOL, bool);
cannam@132 1272 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(char, INT, int);
cannam@132 1273 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(signed char, INT, int);
cannam@132 1274 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(short, INT, int);
cannam@132 1275 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(int, INT, int);
cannam@132 1276 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(long, INT, int);
cannam@132 1277 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(long long, INT, int);
cannam@132 1278 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(unsigned char, UINT, uint);
cannam@132 1279 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(unsigned short, UINT, uint);
cannam@132 1280 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(unsigned int, UINT, uint);
cannam@132 1281 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(unsigned long, UINT, uint);
cannam@132 1282 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(unsigned long long, UINT, uint);
cannam@132 1283 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(float, FLOAT, float);
cannam@132 1284 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(double, FLOAT, float);
cannam@132 1285 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(DynamicEnum, ENUM, enum);
cannam@132 1286 #undef CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR
cannam@132 1287
cannam@132 1288 #define CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(cppType, typeTag, fieldName) \
cannam@132 1289 inline DynamicValue::Reader::Reader(const cppType::Reader& value) \
cannam@132 1290 : type(typeTag), fieldName##Value(value) {} \
cannam@132 1291 inline DynamicValue::Builder::Builder(cppType::Builder value) \
cannam@132 1292 : type(typeTag), fieldName##Value(value) {}
cannam@132 1293
cannam@132 1294 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(Text, TEXT, text);
cannam@132 1295 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(Data, DATA, data);
cannam@132 1296 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(DynamicList, LIST, list);
cannam@132 1297 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(DynamicStruct, STRUCT, struct);
cannam@132 1298 CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(AnyPointer, ANY_POINTER, anyPointer);
cannam@132 1299
cannam@132 1300 #undef CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR
cannam@132 1301
cannam@132 1302 inline DynamicValue::Reader::Reader(DynamicCapability::Client& value)
cannam@132 1303 : type(CAPABILITY), capabilityValue(value) {}
cannam@132 1304 inline DynamicValue::Reader::Reader(DynamicCapability::Client&& value)
cannam@132 1305 : type(CAPABILITY), capabilityValue(kj::mv(value)) {}
cannam@132 1306 template <typename T, typename>
cannam@132 1307 inline DynamicValue::Reader::Reader(kj::Own<T>&& value)
cannam@132 1308 : type(CAPABILITY), capabilityValue(kj::mv(value)) {}
cannam@132 1309 inline DynamicValue::Builder::Builder(DynamicCapability::Client& value)
cannam@132 1310 : type(CAPABILITY), capabilityValue(value) {}
cannam@132 1311 inline DynamicValue::Builder::Builder(DynamicCapability::Client&& value)
cannam@132 1312 : type(CAPABILITY), capabilityValue(kj::mv(value)) {}
cannam@132 1313
cannam@132 1314 inline DynamicValue::Reader::Reader(const char* value): Reader(Text::Reader(value)) {}
cannam@132 1315
cannam@132 1316 #define CAPNP_DECLARE_TYPE(discrim, typeName) \
cannam@132 1317 template <> \
cannam@132 1318 struct DynamicValue::Reader::AsImpl<typeName> { \
cannam@132 1319 static ReaderFor<typeName> apply(const Reader& reader); \
cannam@132 1320 }; \
cannam@132 1321 template <> \
cannam@132 1322 struct DynamicValue::Builder::AsImpl<typeName> { \
cannam@132 1323 static BuilderFor<typeName> apply(Builder& builder); \
cannam@132 1324 };
cannam@132 1325
cannam@132 1326 //CAPNP_DECLARE_TYPE(VOID, Void)
cannam@132 1327 CAPNP_DECLARE_TYPE(BOOL, bool)
cannam@132 1328 CAPNP_DECLARE_TYPE(INT8, int8_t)
cannam@132 1329 CAPNP_DECLARE_TYPE(INT16, int16_t)
cannam@132 1330 CAPNP_DECLARE_TYPE(INT32, int32_t)
cannam@132 1331 CAPNP_DECLARE_TYPE(INT64, int64_t)
cannam@132 1332 CAPNP_DECLARE_TYPE(UINT8, uint8_t)
cannam@132 1333 CAPNP_DECLARE_TYPE(UINT16, uint16_t)
cannam@132 1334 CAPNP_DECLARE_TYPE(UINT32, uint32_t)
cannam@132 1335 CAPNP_DECLARE_TYPE(UINT64, uint64_t)
cannam@132 1336 CAPNP_DECLARE_TYPE(FLOAT32, float)
cannam@132 1337 CAPNP_DECLARE_TYPE(FLOAT64, double)
cannam@132 1338
cannam@132 1339 CAPNP_DECLARE_TYPE(TEXT, Text)
cannam@132 1340 CAPNP_DECLARE_TYPE(DATA, Data)
cannam@132 1341 CAPNP_DECLARE_TYPE(LIST, DynamicList)
cannam@132 1342 CAPNP_DECLARE_TYPE(STRUCT, DynamicStruct)
cannam@132 1343 CAPNP_DECLARE_TYPE(INTERFACE, DynamicCapability)
cannam@132 1344 CAPNP_DECLARE_TYPE(ENUM, DynamicEnum)
cannam@132 1345 CAPNP_DECLARE_TYPE(ANY_POINTER, AnyPointer)
cannam@132 1346 #undef CAPNP_DECLARE_TYPE
cannam@132 1347
cannam@132 1348 // CAPNP_DECLARE_TYPE(Void) causes gcc 4.7 to segfault. If I do it manually and remove the
cannam@132 1349 // ReaderFor<> and BuilderFor<> wrappers, it works.
cannam@132 1350 template <>
cannam@132 1351 struct DynamicValue::Reader::AsImpl<Void> {
cannam@132 1352 static Void apply(const Reader& reader);
cannam@132 1353 };
cannam@132 1354 template <>
cannam@132 1355 struct DynamicValue::Builder::AsImpl<Void> {
cannam@132 1356 static Void apply(Builder& builder);
cannam@132 1357 };
cannam@132 1358
cannam@132 1359 template <typename T>
cannam@132 1360 struct DynamicValue::Reader::AsImpl<T, Kind::ENUM> {
cannam@132 1361 static T apply(const Reader& reader) {
cannam@132 1362 return reader.as<DynamicEnum>().as<T>();
cannam@132 1363 }
cannam@132 1364 };
cannam@132 1365 template <typename T>
cannam@132 1366 struct DynamicValue::Builder::AsImpl<T, Kind::ENUM> {
cannam@132 1367 static T apply(Builder& builder) {
cannam@132 1368 return builder.as<DynamicEnum>().as<T>();
cannam@132 1369 }
cannam@132 1370 };
cannam@132 1371
cannam@132 1372 template <typename T>
cannam@132 1373 struct DynamicValue::Reader::AsImpl<T, Kind::STRUCT> {
cannam@132 1374 static typename T::Reader apply(const Reader& reader) {
cannam@132 1375 return reader.as<DynamicStruct>().as<T>();
cannam@132 1376 }
cannam@132 1377 };
cannam@132 1378 template <typename T>
cannam@132 1379 struct DynamicValue::Builder::AsImpl<T, Kind::STRUCT> {
cannam@132 1380 static typename T::Builder apply(Builder& builder) {
cannam@132 1381 return builder.as<DynamicStruct>().as<T>();
cannam@132 1382 }
cannam@132 1383 };
cannam@132 1384
cannam@132 1385 template <typename T>
cannam@132 1386 struct DynamicValue::Reader::AsImpl<T, Kind::LIST> {
cannam@132 1387 static typename T::Reader apply(const Reader& reader) {
cannam@132 1388 return reader.as<DynamicList>().as<T>();
cannam@132 1389 }
cannam@132 1390 };
cannam@132 1391 template <typename T>
cannam@132 1392 struct DynamicValue::Builder::AsImpl<T, Kind::LIST> {
cannam@132 1393 static typename T::Builder apply(Builder& builder) {
cannam@132 1394 return builder.as<DynamicList>().as<T>();
cannam@132 1395 }
cannam@132 1396 };
cannam@132 1397
cannam@132 1398 template <typename T>
cannam@132 1399 struct DynamicValue::Reader::AsImpl<T, Kind::INTERFACE> {
cannam@132 1400 static typename T::Client apply(const Reader& reader) {
cannam@132 1401 return reader.as<DynamicCapability>().as<T>();
cannam@132 1402 }
cannam@132 1403 };
cannam@132 1404 template <typename T>
cannam@132 1405 struct DynamicValue::Builder::AsImpl<T, Kind::INTERFACE> {
cannam@132 1406 static typename T::Client apply(Builder& builder) {
cannam@132 1407 return builder.as<DynamicCapability>().as<T>();
cannam@132 1408 }
cannam@132 1409 };
cannam@132 1410
cannam@132 1411 inline DynamicValue::Pipeline::Pipeline(std::nullptr_t n): type(UNKNOWN) {}
cannam@132 1412 inline DynamicValue::Pipeline::Pipeline(DynamicStruct::Pipeline&& value)
cannam@132 1413 : type(STRUCT), structValue(kj::mv(value)) {}
cannam@132 1414 inline DynamicValue::Pipeline::Pipeline(DynamicCapability::Client&& value)
cannam@132 1415 : type(CAPABILITY), capabilityValue(kj::mv(value)) {}
cannam@132 1416
cannam@132 1417 template <typename T>
cannam@132 1418 struct DynamicValue::Pipeline::AsImpl<T, Kind::STRUCT> {
cannam@132 1419 static typename T::Pipeline apply(Pipeline& pipeline) {
cannam@132 1420 return pipeline.releaseAs<DynamicStruct>().releaseAs<T>();
cannam@132 1421 }
cannam@132 1422 };
cannam@132 1423 template <typename T>
cannam@132 1424 struct DynamicValue::Pipeline::AsImpl<T, Kind::INTERFACE> {
cannam@132 1425 static typename T::Client apply(Pipeline& pipeline) {
cannam@132 1426 return pipeline.releaseAs<DynamicCapability>().releaseAs<T>();
cannam@132 1427 }
cannam@132 1428 };
cannam@132 1429 template <>
cannam@132 1430 struct DynamicValue::Pipeline::AsImpl<DynamicStruct, Kind::OTHER> {
cannam@132 1431 static PipelineFor<DynamicStruct> apply(Pipeline& pipeline);
cannam@132 1432 };
cannam@132 1433 template <>
cannam@132 1434 struct DynamicValue::Pipeline::AsImpl<DynamicCapability, Kind::OTHER> {
cannam@132 1435 static PipelineFor<DynamicCapability> apply(Pipeline& pipeline);
cannam@132 1436 };
cannam@132 1437
cannam@132 1438 // -------------------------------------------------------------------
cannam@132 1439
cannam@132 1440 template <typename T>
cannam@132 1441 typename T::Reader DynamicStruct::Reader::as() const {
cannam@132 1442 static_assert(kind<T>() == Kind::STRUCT,
cannam@132 1443 "DynamicStruct::Reader::as<T>() can only convert to struct types.");
cannam@132 1444 schema.requireUsableAs<T>();
cannam@132 1445 return typename T::Reader(reader);
cannam@132 1446 }
cannam@132 1447
cannam@132 1448 template <typename T>
cannam@132 1449 typename T::Builder DynamicStruct::Builder::as() {
cannam@132 1450 static_assert(kind<T>() == Kind::STRUCT,
cannam@132 1451 "DynamicStruct::Builder::as<T>() can only convert to struct types.");
cannam@132 1452 schema.requireUsableAs<T>();
cannam@132 1453 return typename T::Builder(builder);
cannam@132 1454 }
cannam@132 1455
cannam@132 1456 template <>
cannam@132 1457 inline DynamicStruct::Reader DynamicStruct::Reader::as<DynamicStruct>() const {
cannam@132 1458 return *this;
cannam@132 1459 }
cannam@132 1460 template <>
cannam@132 1461 inline DynamicStruct::Builder DynamicStruct::Builder::as<DynamicStruct>() {
cannam@132 1462 return *this;
cannam@132 1463 }
cannam@132 1464
cannam@132 1465 inline DynamicStruct::Reader DynamicStruct::Builder::asReader() const {
cannam@132 1466 return DynamicStruct::Reader(schema, builder.asReader());
cannam@132 1467 }
cannam@132 1468
cannam@132 1469 template <>
cannam@132 1470 inline AnyStruct::Reader DynamicStruct::Reader::as<AnyStruct>() const {
cannam@132 1471 return AnyStruct::Reader(reader);
cannam@132 1472 }
cannam@132 1473
cannam@132 1474 template <>
cannam@132 1475 inline AnyStruct::Builder DynamicStruct::Builder::as<AnyStruct>() {
cannam@132 1476 return AnyStruct::Builder(builder);
cannam@132 1477 }
cannam@132 1478
cannam@132 1479 template <typename T>
cannam@132 1480 typename T::Pipeline DynamicStruct::Pipeline::releaseAs() {
cannam@132 1481 static_assert(kind<T>() == Kind::STRUCT,
cannam@132 1482 "DynamicStruct::Pipeline::releaseAs<T>() can only convert to struct types.");
cannam@132 1483 schema.requireUsableAs<T>();
cannam@132 1484 return typename T::Pipeline(kj::mv(typeless));
cannam@132 1485 }
cannam@132 1486
cannam@132 1487 // -------------------------------------------------------------------
cannam@132 1488
cannam@132 1489 template <typename T>
cannam@132 1490 typename T::Reader DynamicList::Reader::as() const {
cannam@132 1491 static_assert(kind<T>() == Kind::LIST,
cannam@132 1492 "DynamicStruct::Reader::as<T>() can only convert to list types.");
cannam@132 1493 schema.requireUsableAs<T>();
cannam@132 1494 return typename T::Reader(reader);
cannam@132 1495 }
cannam@132 1496 template <typename T>
cannam@132 1497 typename T::Builder DynamicList::Builder::as() {
cannam@132 1498 static_assert(kind<T>() == Kind::LIST,
cannam@132 1499 "DynamicStruct::Builder::as<T>() can only convert to list types.");
cannam@132 1500 schema.requireUsableAs<T>();
cannam@132 1501 return typename T::Builder(builder);
cannam@132 1502 }
cannam@132 1503
cannam@132 1504 template <>
cannam@132 1505 inline DynamicList::Reader DynamicList::Reader::as<DynamicList>() const {
cannam@132 1506 return *this;
cannam@132 1507 }
cannam@132 1508 template <>
cannam@132 1509 inline DynamicList::Builder DynamicList::Builder::as<DynamicList>() {
cannam@132 1510 return *this;
cannam@132 1511 }
cannam@132 1512
cannam@132 1513 // -------------------------------------------------------------------
cannam@132 1514
cannam@132 1515 template <typename T, typename>
cannam@132 1516 inline DynamicCapability::Client::Client(T&& client)
cannam@132 1517 : Capability::Client(kj::mv(client)), schema(Schema::from<FromClient<T>>()) {}
cannam@132 1518
cannam@132 1519 template <typename T, typename>
cannam@132 1520 inline DynamicCapability::Client::Client(kj::Own<T>&& server)
cannam@132 1521 : Client(server->getSchema(), kj::mv(server)) {}
cannam@132 1522 template <typename T>
cannam@132 1523 inline DynamicCapability::Client::Client(InterfaceSchema schema, kj::Own<T>&& server)
cannam@132 1524 : Capability::Client(kj::mv(server)), schema(schema) {}
cannam@132 1525
cannam@132 1526 template <typename T, typename>
cannam@132 1527 typename T::Client DynamicCapability::Client::as() {
cannam@132 1528 static_assert(kind<T>() == Kind::INTERFACE,
cannam@132 1529 "DynamicCapability::Client::as<T>() can only convert to interface types.");
cannam@132 1530 schema.requireUsableAs<T>();
cannam@132 1531 return typename T::Client(hook->addRef());
cannam@132 1532 }
cannam@132 1533
cannam@132 1534 template <typename T, typename>
cannam@132 1535 typename T::Client DynamicCapability::Client::releaseAs() {
cannam@132 1536 static_assert(kind<T>() == Kind::INTERFACE,
cannam@132 1537 "DynamicCapability::Client::as<T>() can only convert to interface types.");
cannam@132 1538 schema.requireUsableAs<T>();
cannam@132 1539 return typename T::Client(kj::mv(hook));
cannam@132 1540 }
cannam@132 1541
cannam@132 1542 inline CallContext<DynamicStruct, DynamicStruct>::CallContext(
cannam@132 1543 CallContextHook& hook, StructSchema paramType, StructSchema resultType)
cannam@132 1544 : hook(&hook), paramType(paramType), resultType(resultType) {}
cannam@132 1545 inline DynamicStruct::Reader CallContext<DynamicStruct, DynamicStruct>::getParams() {
cannam@132 1546 return hook->getParams().getAs<DynamicStruct>(paramType);
cannam@132 1547 }
cannam@132 1548 inline void CallContext<DynamicStruct, DynamicStruct>::releaseParams() {
cannam@132 1549 hook->releaseParams();
cannam@132 1550 }
cannam@132 1551 inline DynamicStruct::Builder CallContext<DynamicStruct, DynamicStruct>::getResults(
cannam@132 1552 kj::Maybe<MessageSize> sizeHint) {
cannam@132 1553 return hook->getResults(sizeHint).getAs<DynamicStruct>(resultType);
cannam@132 1554 }
cannam@132 1555 inline DynamicStruct::Builder CallContext<DynamicStruct, DynamicStruct>::initResults(
cannam@132 1556 kj::Maybe<MessageSize> sizeHint) {
cannam@132 1557 return hook->getResults(sizeHint).initAs<DynamicStruct>(resultType);
cannam@132 1558 }
cannam@132 1559 inline void CallContext<DynamicStruct, DynamicStruct>::setResults(DynamicStruct::Reader value) {
cannam@132 1560 hook->getResults(value.totalSize()).setAs<DynamicStruct>(value);
cannam@132 1561 }
cannam@132 1562 inline void CallContext<DynamicStruct, DynamicStruct>::adoptResults(Orphan<DynamicStruct>&& value) {
cannam@132 1563 hook->getResults(MessageSize { 0, 0 }).adopt(kj::mv(value));
cannam@132 1564 }
cannam@132 1565 inline Orphanage CallContext<DynamicStruct, DynamicStruct>::getResultsOrphanage(
cannam@132 1566 kj::Maybe<MessageSize> sizeHint) {
cannam@132 1567 return Orphanage::getForMessageContaining(hook->getResults(sizeHint));
cannam@132 1568 }
cannam@132 1569 template <typename SubParams>
cannam@132 1570 inline kj::Promise<void> CallContext<DynamicStruct, DynamicStruct>::tailCall(
cannam@132 1571 Request<SubParams, DynamicStruct>&& tailRequest) {
cannam@132 1572 return hook->tailCall(kj::mv(tailRequest.hook));
cannam@132 1573 }
cannam@132 1574 inline void CallContext<DynamicStruct, DynamicStruct>::allowCancellation() {
cannam@132 1575 hook->allowCancellation();
cannam@132 1576 }
cannam@132 1577
cannam@132 1578 template <>
cannam@132 1579 inline DynamicCapability::Client Capability::Client::castAs<DynamicCapability>(
cannam@132 1580 InterfaceSchema schema) {
cannam@132 1581 return DynamicCapability::Client(schema, hook->addRef());
cannam@132 1582 }
cannam@132 1583
cannam@132 1584 // -------------------------------------------------------------------
cannam@132 1585
cannam@132 1586 template <typename T>
cannam@132 1587 ReaderFor<T> ConstSchema::as() const {
cannam@132 1588 return DynamicValue::Reader(*this).as<T>();
cannam@132 1589 }
cannam@132 1590
cannam@132 1591 } // namespace capnp
cannam@132 1592
cannam@132 1593 #endif // CAPNP_DYNAMIC_H_