• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1## -*- coding: utf-8 -*-
2##
3## Copyright (C) 2013 The Android Open Source Project
4##
5## Licensed under the Apache License, Version 2.0 (the "License");
6## you may not use this file except in compliance with the License.
7## You may obtain a copy of the License at
8##
9##      http://www.apache.org/licenses/LICENSE-2.0
10##
11## Unless required by applicable law or agreed to in writing, software
12## distributed under the License is distributed on an "AS IS" BASIS,
13## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14## See the License for the specific language governing permissions and
15## limitations under the License.
16##
17\
18## This section of enum integer definitions is inserted into
19## android.hardware.camera2.CameraMetadata.
20    /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
21     * The enum values below this point are generated from metadata
22     * definitions in /system/media/camera/docs. Do not modify by hand or
23     * modify the comment blocks at the start or end.
24     *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/
25##
26## Generate an enum's integers
27<%def name="generate_enum(entry, target_class)">\
28    //
29    // Enumeration values for ${target_class}#${entry.name | jkey_identifier}
30    //
31
32  % for value in [v for v in entry.enum.values if v.visibility != 'system']:
33    /**
34    % if value.notes:
35${value.notes | javadoc(metadata)}\
36    % endif
37    % if value.sdk_notes:
38${value.sdk_notes | javadoc(metadata)}\
39    % endif
40     * @see ${target_class}#${entry.name | jkey_identifier}
41## TODO: Remove fwk_java_public
42    % if entry.applied_visibility in ('hidden', 'ndk_public', 'fwk_java_public') or value.hidden:
43     * @hide
44    %endif
45    % if value.deprecated:
46     * @deprecated Please refer to this API documentation to find the alternatives
47    % endif
48     */
49    % if value.deprecated:
50    @Deprecated
51    % endif
52    % if value.visibility == 'test':
53    @TestApi
54    % endif
55    public static final int ${jenum_value(entry, value)} = ${enum_calculate_value_string(value)};
56
57  % endfor
58</%def>\
59##
60## Generate a list of only Static, Controls, or Dynamic properties.
61<%def name="single_kind_keys(xml_name, target_class)">\
62% for outer_namespace in metadata.outer_namespaces: ## assumes single 'android' namespace
63  % for section in outer_namespace.sections:
64    % if section.find_first(lambda x: isinstance(x, metadata_model.Entry) and x.kind == xml_name) and \
65         any_visible(section, xml_name, ('public','hidden', 'ndk_public', 'java_public', \
66         'fwk_java_public') ):
67      % for inner_namespace in get_children_by_filtering_kind(section, xml_name, 'namespaces'):
68## We only support 1 level of inner namespace, i.e. android.a.b and android.a.b.c works, but not android.a.b.c.d
69## If we need to support more, we should use a recursive function here instead.. but the indentation gets trickier.
70        % for entry in filter_visibility(inner_namespace.entries, ('hidden','public', 'ndk_public', \
71        'java_public', 'fwk_pubic')):
72          % if entry.enum \
73              and not (entry.typedef and entry.typedef.languages.get('java')) \
74              and not entry.is_clone():
75${generate_enum(entry, target_class)}\
76          % endif
77        % endfor
78      % endfor
79      % for entry in filter_visibility( \
80          get_children_by_filtering_kind(section, xml_name, 'entries'), \
81              ('hidden', 'public', 'ndk_public', 'java_public', 'fwk_java_public')):
82        % if entry.enum \
83             and not (entry.typedef and entry.typedef.languages.get('java')) \
84             and not entry.is_clone():
85${generate_enum(entry, target_class)}\
86        % endif
87      % endfor
88    % endif
89  % endfor
90% endfor
91</%def>\
92
93##
94## Static properties only
95${single_kind_keys('static','CameraCharacteristics')}\
96##
97## Controls properties only
98${single_kind_keys('controls','CaptureRequest')}\
99##
100## Dynamic properties only
101${single_kind_keys('dynamic','CaptureResult')}\
102    /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
103     * End generated code
104     *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/
105