blob: dd641a036672b542c73331eb69fc420f97b9d0d2 [file] [log] [blame]
Igor Murashkinaa133d32013-06-28 17:27:49 -07001## -*- coding: utf-8 -*-
Igor Murashkinaa133d32013-06-28 17:27:49 -07002##
Eino-Ville Talvalad4e240a2013-08-08 12:56:37 -07003## 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## These sections of metadata Key definitions are inserted into the middle of
Igor Murashkin21d0f1a2013-09-10 12:25:56 -070019## android.hardware.camera2.CameraCharacteristics, CaptureRequest, and CaptureResult.
Eino-Ville Talvalad4e240a2013-08-08 12:56:37 -070020<%page args="java_class, xml_kind" />\
21 /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
22 * The key entries below this point are generated from metadata
23 * definitions in /system/media/camera/docs. Do not modify by hand or
24 * modify the comment blocks at the start or end.
25 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/
Igor Murashkinaa133d32013-06-28 17:27:49 -070026
Eino-Ville Talvala63c0fb22014-01-02 16:11:44 -080027<%!
28 ##
29 ## Generate extra text blocks for the details field
30 def generate_extra_detail(entry):
Igor Murashkin88b858d2014-01-14 14:57:46 -080031 def inner(text):
32 if entry.optional:
33 text += '\n\n<b>Optional</b> - This value may be {@code null} on some devices.\n'
34 if any(tag.name == 'FULL' for tag in entry.tags):
35 text += \
36 '\n<b>Full capability</b> - \n' + \
37 'Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the\n' + \
38 'android.info.supportedHardwareLevel key\n'
39 return text
40 return inner
Eino-Ville Talvala63c0fb22014-01-02 16:11:44 -080041%>
Eino-Ville Talvalad4e240a2013-08-08 12:56:37 -070042##
43## Generate a single key and docs
44<%def name="generate_key(entry)">\
45 /**
Igor Murashkin88b858d2014-01-14 14:57:46 -080046<%
47 # Dedent fixes markdown not to generate code blocks. Then do the rest.
48 description = ""
49 if entry.description:
50 description = dedent(entry.description) + "\n\n"
51 details = ""
52 if entry.details:
53 details = dedent(entry.details)
54 # Unconditionally add extra information if necessary
55 extra_detail = generate_extra_detail(entry)("")
56
57 concatenated_info = description + details + extra_detail
58%>\
59## Glue description and details together before javadoc-izing. Otherwise @see in middle of javadoc.
60${concatenated_info | javadoc(metadata)}\
Eino-Ville Talvalad4e240a2013-08-08 12:56:37 -070061 % if entry.enum and not (entry.typedef and entry.typedef.languages.get('java')):
62 % for value in entry.enum.values:
63 * @see #${jenum_value(entry, value)}
64 % endfor
65 % endif
Igor Murashkin6c936c12014-05-13 14:51:49 -070066 % if entry.deprecated:
67 * @deprecated
68 % endif
Eino-Ville Talvalad4e240a2013-08-08 12:56:37 -070069 % if entry.applied_visibility == 'hidden':
Eino-Ville Talvalad4e240a2013-08-08 12:56:37 -070070 * @hide
71 % endif
72 */
Igor Murashkin6c936c12014-05-13 14:51:49 -070073 % if entry.deprecated:
74 @Deprecated
75 % endif
Eino-Ville Talvalad4e240a2013-08-08 12:56:37 -070076 public static final Key<${jtype_boxed(entry)}> ${entry.name | jkey_identifier} =
77 new Key<${jtype_boxed(entry)}>("${entry.name}", ${jclass(entry)});
Igor Murashkinaa133d32013-06-28 17:27:49 -070078</%def>\
79##
80## Generate a list of only Static, Controls, or Dynamic properties.
81<%def name="single_kind_keys(java_name, xml_name)">\
Igor Murashkinaa133d32013-06-28 17:27:49 -070082% for outer_namespace in metadata.outer_namespaces: ## assumes single 'android' namespace
83 % for section in outer_namespace.sections:
Eino-Ville Talvalaf384f0a2013-07-12 17:02:27 -070084 % if section.find_first(lambda x: isinstance(x, metadata_model.Entry) and x.kind == xml_name) and \
85 any_visible(section, xml_name, ('public','hidden') ):
Igor Murashkinaa133d32013-06-28 17:27:49 -070086 % for inner_namespace in get_children_by_filtering_kind(section, xml_name, 'namespaces'):
87## 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
88## If we need to support more, we should use a recursive function here instead.. but the indentation gets trickier.
Eino-Ville Talvalad4e240a2013-08-08 12:56:37 -070089 % for entry in filter_visibility(inner_namespace.merged_entries, ('hidden','public')):
90${generate_key(entry)}
91 % endfor
92 % endfor
93 % for entry in filter_visibility( \
94 get_children_by_filtering_kind(section, xml_name, 'merged_entries'), \
Eino-Ville Talvalaf384f0a2013-07-12 17:02:27 -070095 ('hidden', 'public')):
Eino-Ville Talvalad4e240a2013-08-08 12:56:37 -070096${generate_key(entry)}
97 % endfor
Igor Murashkinaa133d32013-06-28 17:27:49 -070098 % endif
99 % endfor
100% endfor
Igor Murashkinaa133d32013-06-28 17:27:49 -0700101</%def>\
102##
103## Static properties only
Igor Murashkin21d0f1a2013-09-10 12:25:56 -0700104##${single_kind_keys('CameraCharacteristicsKeys', 'static')}
Igor Murashkinaa133d32013-06-28 17:27:49 -0700105##
106## Controls properties only
107##${single_kind_keys('CaptureRequestKeys', 'controls')}
108##
109## Dynamic properties only
110##${single_kind_keys('CaptureResultKeys', 'dynamic')}
Eino-Ville Talvalad4e240a2013-08-08 12:56:37 -0700111${single_kind_keys(java_class, xml_kind)}\
112 /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
113 * End generated code
Igor Murashkin6c936c12014-05-13 14:51:49 -0700114 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/