OSDN Git Service

am cc889095: am d77b234a: Camera: Reduce maximum required ISO sensitivity to 800
[android-x86/system-media.git] / camera / docs / CameraMetadataKeys.mako
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 ## These sections of metadata Key definitions are inserted into the middle of
19 ## android.hardware.camera2.CameraCharacteristics, CaptureRequest, and CaptureResult.
20 <%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      *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/
26
27 ##
28 ## Generate a single key and docs
29 <%def name="generate_key(entry)">\
30     /**
31 <%
32     # Dedent fixes markdown not to generate code blocks. Then do the rest.
33     description = ""
34     if entry.description:
35         description = dedent(entry.description) + "\n\n"
36     details = ""
37     if entry.details:
38         details = dedent(entry.details)
39     # Unconditionally add extra information if necessary
40     extra_detail = generate_extra_javadoc_detail(entry)("")
41
42     concatenated_info = description + details + extra_detail
43 %>\
44 ## Glue description and details together before javadoc-izing. Otherwise @see in middle of javadoc.
45 ${concatenated_info | javadoc(metadata)}\
46   % if entry.enum and not (entry.typedef and entry.typedef.languages.get('java')):
47     % for value in entry.enum.values:
48      % if not value.hidden:
49      * @see #${jenum_value(entry, value)}
50      % endif
51     % endfor
52   % endif
53   % if entry.deprecated:
54      * @deprecated
55   % endif
56   % if entry.applied_visibility == 'hidden':
57      * @hide
58   % endif
59      */
60   % if entry.deprecated:
61     @Deprecated
62   % endif
63   % if entry.applied_visibility == 'public':
64     @PublicKey
65   % endif
66   % if entry.synthetic:
67     @SyntheticKey
68   % endif
69     public static final Key<${jtype_boxed(entry)}> ${entry.name | jkey_identifier} =
70             new Key<${jtype_boxed(entry)}>("${entry.name}", ${jkey_type_token(entry)});
71 </%def>\
72 ##
73 ## Generate a list of only Static, Controls, or Dynamic properties.
74 <%def name="single_kind_keys(java_name, xml_name)">\
75 % for outer_namespace in metadata.outer_namespaces: ## assumes single 'android' namespace
76   % for section in outer_namespace.sections:
77     % if section.find_first(lambda x: isinstance(x, metadata_model.Entry) and x.kind == xml_name) and \
78          any_visible(section, xml_name, ('public','hidden') ):
79       % for inner_namespace in get_children_by_filtering_kind(section, xml_name, 'namespaces'):
80 ## 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
81 ## If we need to support more, we should use a recursive function here instead.. but the indentation gets trickier.
82         % for entry in filter_visibility(inner_namespace.merged_entries, ('hidden','public')):
83 ${generate_key(entry)}
84        % endfor
85     % endfor
86     % for entry in filter_visibility( \
87         get_children_by_filtering_kind(section, xml_name, 'merged_entries'), \
88                                          ('hidden', 'public')):
89 ${generate_key(entry)}
90     % endfor
91     % endif
92   % endfor
93 % endfor
94 </%def>\
95 ##
96 ## Static properties only
97 ##${single_kind_keys('CameraCharacteristicsKeys', 'static')}
98 ##
99 ## Controls properties only
100 ##${single_kind_keys('CaptureRequestKeys', 'controls')}
101 ##
102 ## Dynamic properties only
103 ##${single_kind_keys('CaptureResultKeys', 'dynamic')}
104 ${single_kind_keys(java_class, xml_kind)}\
105     /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
106      * End generated code
107      *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/