summaryrefslogtreecommitdiff
path: root/utils/codegen/ipc/generators/libcamera_templates/definition_functions.tmpl
blob: 8b8509f3ded620d074dea4131426fd13f0a65376 (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
{#-
 # SPDX-License-Identifier: LGPL-2.1-or-later
 # Copyright (C) 2020, Google Inc.
-#}

{#
 # \brief Generate enum definition
 #
 # \param enum Enum object whose definition is to be generated
 #}
{%- macro define_enum(enum) -%}
enum{{" class" if enum|is_scoped}} {{enum.mojom_name}} {
{%- for field in enum.fields %}
	{{field.mojom_name}} = {{field.numeric_value}},
{%- endfor %}
};
{%- endmacro -%}

{#
 # \brief Generate struct definition
 #
 # \param struct Struct object whose definition is to be generated
 #}
{%- macro define_struct(struct) -%}
struct {{struct.mojom_name}}
{
public:
#ifndef __DOXYGEN__
	{{struct.mojom_name}}() {%- if struct|has_default_fields %}
		:{% endif %}
{%- for field in struct.fields|with_default_values -%}
{{" " if loop.first}}{{field.mojom_name}}({{field|default_value}}){{", " if not loop.last}}
{%- endfor %}
	{
	}

	{{struct.mojom_name}}(
{%- for field in struct.fields -%}
{{"const " if not field|is_pod}}{{field|name}} {{"&" if not field|is_pod}}_{{field.mojom_name}}{{", " if not loop.last}}
{%- endfor -%}
)
		:
{%- for field in struct.fields -%}
{{" " if loop.first}}{{field.mojom_name}}(_{{field.mojom_name}}){{", " if not loop.last}}
{%- endfor %}
	{
	}
#endif

{% for field in struct.fields %}
	{{field|name}} {{field.mojom_name}};
{%- endfor %}
};
{%- endmacro -%}


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 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
# Copyright 2013 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import copy
from mojom.generate import module as mojom

# This module provides a mechanism for determining the packed order and offsets
# of a mojom.Struct.
#
# ps = pack.PackedStruct(struct)
# ps.packed_fields will access a list of PackedField objects, each of which
# will have an offset, a size and a bit (for mojom.BOOLs).

# Size of struct header in bytes: num_bytes [4B] + version [4B].
HEADER_SIZE = 8


class PackedField:
  kind_to_size = {
      mojom.BOOL: 1,
      mojom.INT8: 1,
      mojom.UINT8: 1,
      mojom.INT16: 2,
      mojom.UINT16: 2,
      mojom.INT32: 4,
      mojom.UINT32: 4,
      mojom.FLOAT: 4,
      mojom.HANDLE: 4,
      mojom.MSGPIPE: 4,
      mojom.SHAREDBUFFER: 4,
      mojom.PLATFORMHANDLE: 4,
      mojom.DCPIPE: 4,
      mojom.DPPIPE: 4,
      mojom.NULLABLE_HANDLE: 4,
      mojom.NULLABLE_MSGPIPE: 4,
      mojom.NULLABLE_SHAREDBUFFER: 4,
      mojom.NULLABLE_PLATFORMHANDLE: 4,
      mojom.NULLABLE_DCPIPE: 4,
      mojom.NULLABLE_DPPIPE: 4,
      mojom.INT64: 8,
      mojom.UINT64: 8,
      mojom.DOUBLE: 8,
      mojom.STRING: 8,
      mojom.NULLABLE_STRING: 8
  }

  @classmethod
  def GetSizeForKind(cls, kind):
    if isinstance(kind, (mojom.Array, mojom.Map, mojom.Struct, mojom.Interface,
                         mojom.AssociatedInterface, mojom.PendingRemote,
                         mojom.PendingAssociatedRemote)):
      return 8
    if isinstance(kind, mojom.Union):
      return 16
    if isinstance(kind, (mojom.InterfaceRequest, mojom.PendingReceiver)):
      kind = mojom.MSGPIPE
    if isinstance(
        kind,
        (mojom.AssociatedInterfaceRequest, mojom.PendingAssociatedReceiver)):
      return 4
    if isinstance(kind, mojom.Enum):
      # TODO(mpcomplete): what about big enums?
      return cls.kind_to_size[mojom.INT32]
    if not kind in cls.kind_to_size:
      raise Exception("Undefined type: %s. Did you forget to import the file "
                      "containing the definition?" % kind.spec)
    return cls.kind_to_size[kind]

  @classmethod
  def GetAlignmentForKind(cls, kind):
    if isinstance(kind, (mojom.Interface, mojom.AssociatedInterface,
                         mojom.PendingRemote, mojom.PendingAssociatedRemote)):
      return 4
    if isinstance(kind, mojom.Union):
      return 8
    return cls.GetSizeForKind(kind)

  def __init__(self,
               field,
               index,
               ordinal,
               original_field=None,
               sub_ordinal=None,
               linked_value_packed_field=None):
    """
    Args:
      field: the original field.
      index: the position of the original field in the struct.
      ordinal: the ordinal of the field for serialization.
      original_field: See below.
      sub_ordinal: See below.
      linked_value_packed_field: See below.

    original_field, sub_ordinal, and linked_value_packed_field are used to
    support nullable ValueKind fields. For legacy reasons, nullable ValueKind
    fields actually generate two PackedFields. This allows:

    - backwards compatibility prior to Mojo support for nullable ValueKinds.
    - correct packing of fields for the aforementioned backwards compatibility.

    When translating Fields to PackedFields, the original field is turned into
    two PackedFields: the first PackedField always has type mojom.BOOL, while
    the second PackedField has the non-nullable version of the field's kind.