libcamera/utils/ipc/generators/libcamera_templates/module_ipa_interface.h.tmpl
Laurent Pinchart 829acb3ab0 libcamera: Drop file name from header comment blocks in templates
Source files in libcamera start by a comment block header, which
includes the file name and a one-line description of the file contents.
While the latter is useful to get a quick overview of the file contents
at a glance, the former is mostly a source of inconvenience. The name in
the comments can easily get out of sync with the file name when files
are renamed, and copy & paste during development have often lead to
incorrect names being used to start with.

Readers of the source code are expected to know which file they're
looking it. Drop the file name from the header comment blocks in
template files and templates embedded in generator scripts.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
2024-05-09 23:31:14 +03:00

84 lines
1.9 KiB
Cheetah

{#-
# SPDX-License-Identifier: LGPL-2.1-or-later
# Copyright (C) 2020, Google Inc.
-#}
{%- import "definition_functions.tmpl" as funcs -%}
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2020, Google Inc.
*
* Image Processing Algorithm interface for {{module_name}}
*
* This file is auto-generated. Do not edit.
*/
#pragma once
#include <libcamera/ipa/core_ipa_interface.h>
#include <libcamera/ipa/ipa_interface.h>
{% if has_map %}#include <map>{% endif %}
{% if has_array %}#include <vector>{% endif %}
namespace libcamera {
{%- if has_namespace %}
{% for ns in namespace %}
namespace {{ns}} {
{% endfor %}
{%- endif %}
{% for const in consts %}
const {{const.kind|name}} {{const.mojom_name}} = {{const.value}};
{% endfor %}
enum class {{cmd_enum_name}} {
Exit = 0,
{%- for method in interface_main.methods %}
{{method.mojom_name|cap}} = {{loop.index}},
{%- endfor %}
};
enum class {{cmd_event_enum_name}} {
{%- for method in interface_event.methods %}
{{method.mojom_name|cap}} = {{loop.index}},
{%- endfor %}
};
{% for enum in enums %}
{{funcs.define_enum(enum)}}
{% endfor %}
{%- for struct in structs_nonempty %}
{{funcs.define_struct(struct)}}
{% endfor %}
{#-
Any consts or #defines should be moved to the mojom file.
#}
class {{interface_name}} : public IPAInterface
{
public:
{% for method in interface_main.methods %}
virtual {{method|method_return_value}} {{method.mojom_name}}(
{%- for param in method|method_parameters %}
{{param}}{{- "," if not loop.last}}
{%- endfor -%}
) = 0;
{% endfor %}
{%- for method in interface_event.methods %}
Signal<
{%- for param in method.parameters -%}
{{"const " if not param|is_pod}}{{param|name}}{{" &" if not param|is_pod and not param|is_enum}}
{{- ", " if not loop.last}}
{%- endfor -%}
> {{method.mojom_name}};
{% endfor -%}
};
{%- if has_namespace %}
{% for ns in namespace|reverse %}
} /* namespace {{ns}} */
{% endfor %}
{%- endif %}
} /* namespace libcamera */