diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 7d9d4c7084..0000000000 --- a/.gitattributes +++ /dev/null @@ -1,7 +0,0 @@ -*.txt text -*.sh eol=lf -*.py eol=lf -*.py.template eol=lf -*.sh.template eol=lf -*.json text -*.bat eol=crlf \ No newline at end of file diff --git a/.gitignore b/.gitignore index 9e6e5752a4..adc38dcad7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,69 +1,6 @@ -output/** -*.class -*.iml -*/.idea/** -.idea/** -.idea -*.log -*.log.[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9] -*/.classpath -.classpath -*/.project -.project -.cache/** -target/ -tmp_deb_control/ -tmp_rpm_control/ -tmp_dao_resources/ -tmp_sh/ -.gwt/ -.settings/ -/bin -bin/ -**/dependency-reduced-pom.xml -server/common/server-shared/src/main/java/org/kaaproject/kaa/server/common/Version.java -server/admin/src/main/java/org/kaaproject/kaa/server/admin/shared/Version.java -sandbox/web/src/main/java/org/kaaproject/kaa/sandbox/web/shared/Version.java -pom.xml.versionsBackup -examples/*/source/lib/ -examples/*/source/java/lib/ -server/common/dao/src/main/resources/dao.properties -server/common/dao/src/main/resources/sql-dao.properties -server/node/src/main/resources/admin-dao.properties -build/ -DerivedData -Pods/ - -**/Podfile.lock -!Manifest.lock - -.DS_Store -*~ -*.swp -*.rbc - -*.pbxuser -!default.pbxuser -*.mode1v3 -!default.mode1v3 -*.mode2v3 -!default.mode2v3 -*.perspectivev3 -!default.perspectivev3 -!default.xcworkspace -xcuserdata -*.xccheckout -!scripts/profile -*.moved-aside -*.hmap -*.ipa -Tests/Pods -**/.toDelete -/test-gh-pages-current/ -doc/Programming-guide/Server-REST-APIs/swagger.json -/server/containers/docker/using-compose/kaa-nginx-config/kaa-nginx.conf -/server/containers/docker/using-compose/kaa-nginx-config/kaa-default.conf -/logs -/server/containers/docker/using-compose/kaa-docker-compose.yml -/server/containers/docker/kaa-node.deb -/keys \ No newline at end of file +*pages-current/ +tmp/ +**/*.*~ +**/#*.*# +.idea/ +.DS_store diff --git a/.jekver.yml b/.jekver.yml new file mode 100644 index 0000000000..4e24867906 --- /dev/null +++ b/.jekver.yml @@ -0,0 +1,10 @@ + +project: kaabb +latest: "current" + +jekdocs: + - md: + path: "" + target: "" + copy: + docs: doc diff --git a/.jenkinsfile b/.jenkinsfile new file mode 100644 index 0000000000..885189b983 --- /dev/null +++ b/.jenkinsfile @@ -0,0 +1,51 @@ +library 'kaaiot.shared-libraries@master' + +gitlabUtils.populateEnvVariables() + +pipeline { + environment { + TAG = gitlabUtils.getBuildTag() + SERVICE_NAME = "kaa" + SERVICE_NAME_UPPER = SERVICE_NAME.toUpperCase() + } + + options { + disableConcurrentBuilds() + timeout(time: 30, unit: 'MINUTES') + } + + agent none + + stages { + stage ('Docs') { + agent { label "docs-builder_v1" } + + steps { + // Workaround to prevent Jekver from building tags. + // Since doc generation flow will be changed really soon, I see no point + // in investing time in this right now + sh 'git tag | xargs git tag -d' + + container ('builder') { + script { + docs.publish(env.SERVICE_NAME_UPPER, (env.BRANCH_NAME == "master") ? "current" : env.TAG) + } + } + } + } + } + + post { + regression { + notification('regression', env.SERVICE_NAME) + } + + fixed { + notification('fixed', env.SERVICE_NAME) + } + + success { + notification('success', env.SERVICE_NAME) + } + } +} diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index d532d4d73e..0000000000 --- a/.travis.yml +++ /dev/null @@ -1,38 +0,0 @@ -# -# Copyright 2016 CyberVision, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -language: python -python: "3.4" -sudo: required -dist: trusty -install: - - ./scripts/setup_nix.sh - - . $HOME/.nix-profile/etc/profile.d/nix.sh - - - cd client/client-multi/client-c/ && travis_retry nix-shell -Q --pure --run true --arg cc3200Support false && cd ../../.. - - cd client/client-multi/client-cpp/ && travis_retry nix-shell -Q --pure --run true && cd ../../.. - - travis_retry nix-shell -Q --packages pkgs.maven --pure --run true - -script: - - nix-shell --pure --packages pkgs.maven --run 'mvn -q apache-rat:check' - - - cd client/client-multi/client-c - - nix-shell --arg cc3200Support false --pure --run ./scripts/build.sh - - cd ../../.. - - - cd client/client-multi/client-cpp - - nix-shell --pure --run './build.sh test' - - cd ../../.. diff --git a/LICENSE b/LICENSE deleted file mode 100644 index ad410e1130..0000000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ -Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md index 3cab8fd290..4f1f2fa640 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,3 @@ -

- - - -

+# Kaa Enterprise documentation -Kaa open-source IoT platform [![Build Status](https://travis-ci.org/kaaproject/kaa.svg?branch=master)](https://travis-ci.org/kaaproject/kaa) -============================ - -Kaa is a production-ready, multi-purpose middleware platform for building complete end-to-end IoT solutions, connected applications, and smart products. The Kaa platform provides an open, feature-rich toolkit for the IoT product development and thus dramatically reduces associated cost, risks, and time-to-market. For a quick start, Kaa offers a set of out-of-the-box enterprise-grade IoT features that can be easily plugged in and used to implement a large majority of the IoT use cases. - -# Getting started - -For the quick start with Kaa IoT platform check out [Getting started](http://www.kaaproject.org/getting-started/) guide. -Alternatively, you can [deploy Kaa into your own environment](http://kaaproject.github.io/kaa/docs/v0.10.0/Administration-guide/System-installation/Single-node-installation/). - -# Getting help - -If you face some troubles with Kaa platform check out [Troubleshooting guide](http://kaaproject.github.io/kaa/docs/v0.10.0/Administration-guide/Troubleshooting/) and [Frequently asked questions](http://docs.kaaproject.org/display/KAA/Frequently+asked+questions) first and if you can't find the solution we welcome you to post your questions at the Kaa project [Google group](http://www.kaaproject.org/forum/). - -# Documentation - -Kaa documentation is a part of Kaa source code and is located in the [`doc/`](doc) folder. You can find the web version [here](http://kaaproject.github.io/kaa/). - -# How to contribute - -To contribute to Kaa IoT platform, please visit [How to contribute](http://kaaproject.github.io/kaa/docs/v0.10.0/Customization-guide/How-to-contribute/) guide. - -# Where to report issues - -You can report an issue by creating a corresponding ticket in [Kaa task tracker](http://jira.kaaproject.org/browse/KAA/), check out [Jira guide](http://kaaproject.github.io/kaa/docs/v0.10.0/Customization-guide/How-to-contribute/Jira-guide/) before submitting one. - -# License - -Kaa IoT platform is licensed under [Apache Software License 2.0](http://www.apache.org/licenses/LICENSE-2.0). - -See [`LICENSE`](LICENSE) and [`copyright.txt`](copyright.txt) for details. +Documentation [site](https://docs.kaaiot.io). diff --git a/avrogen/pom.xml b/avrogen/pom.xml deleted file mode 100644 index bde419eb06..0000000000 --- a/avrogen/pom.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - 4.0.0 - - org.kaaproject - 0.10.0-SNAPSHOT - kaa - - - org.kaaproject.kaa.avrogen - avrogen - jar - - Kaa Avro Generator - http://kaaproject.org - - - UTF-8 - - - - - - org.apache.maven.plugins - maven-compiler-plugin - 2.5.1 - - 1.7 - 1.7 - - - - org.apache.maven.plugins - maven-jar-plugin - - - - true - lib/ - org.kaaproject.kaa.avro.avrogen.Main - - - - - - org.apache.rat - apache-rat-plugin - ${rat.version} - - - - - - - - junit - junit - test - - - org.apache.velocity - velocity - - - org.apache.avro - avro - - - diff --git a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/GenerationContext.java b/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/GenerationContext.java deleted file mode 100644 index f50f185efc..0000000000 --- a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/GenerationContext.java +++ /dev/null @@ -1,87 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.kaaproject.kaa.avro.avrogen; - -/* -* This feature never used, the value is always INOUT -* */ -@Deprecated -public class GenerationContext { - private final String parentName; - private final String fieldName; - private DirectionType direction; - - /** - * Instantiates a new GenerationContext. - * - * @param parentName the parent name - * @param fieldName the field name - * @param direction the direction - */ - public GenerationContext(String parentName, String fieldName, String direction) { - this.parentName = parentName; - this.fieldName = fieldName; - - this.direction = DirectionType.INOUT; - - if (direction != null) { - if (direction.equalsIgnoreCase("out")) { - this.direction = DirectionType.OUT; - } else if (direction.equalsIgnoreCase("in")) { - this.direction = DirectionType.IN; - } - - } - } - - /** - * Update direction type of GenerationContext. - * - * @param context the GenerationContext - */ - public void updateDirection(GenerationContext context) { - if (direction != DirectionType.INOUT && context != null && direction != context.direction) { - direction = DirectionType.INOUT; - } - } - - public String getParentName() { - return parentName; - } - - public String getFieldName() { - return fieldName; - } - - public boolean isTypeOut() { - return direction != DirectionType.IN; - } - - public boolean isTypeIn() { - return direction != DirectionType.OUT; - } - - public boolean isTypeInOut() { - return direction == DirectionType.INOUT; - } - - private enum DirectionType { - IN, - OUT, - INOUT - } -} diff --git a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/KaaGeneratorException.java b/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/KaaGeneratorException.java deleted file mode 100644 index 318bdde285..0000000000 --- a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/KaaGeneratorException.java +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.kaaproject.kaa.avro.avrogen; - -public class KaaGeneratorException extends Exception { - public KaaGeneratorException() { - super(); - } - - public KaaGeneratorException(String str) { - super(str); - } -} diff --git a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/Main.java b/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/Main.java deleted file mode 100644 index 126d794b86..0000000000 --- a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/Main.java +++ /dev/null @@ -1,43 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.kaaproject.kaa.avro.avrogen; - - -import org.kaaproject.kaa.avro.avrogen.compiler.Compiler; -import org.kaaproject.kaa.avro.avrogen.compiler.ObjectiveCCompiler; - -public class Main { - - /** - * The main method. - * - * @param args the input arguments - */ - public static void main(String[] args) { - try { - if (args.length < 3) { - throw new KaaGeneratorException("Not enough argument. " - + "Need {FULL_PATH_TO_SCHEMA} {OUTPUT_PATH} {SOURCE_NAME}"); - } - - Compiler compiler = new ObjectiveCCompiler(args[0], args[1], args[2]); - compiler.generate(); - } catch (Exception ex) { - System.err.println("Compilation failure: " + ex.toString()); - } - } -} diff --git a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/StyleUtils.java b/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/StyleUtils.java deleted file mode 100644 index a11be7bf77..0000000000 --- a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/StyleUtils.java +++ /dev/null @@ -1,96 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.kaaproject.kaa.avro.avrogen; - -public class StyleUtils { - - private StyleUtils() { - } - - /** - * Convert to lower underscore format. - * - * @param camelCaseName the name in camel case format - * @return the string in lower underscore format - */ - public static String toLowerUnderScore(String camelCaseName) { - StringBuilder convertedName = new StringBuilder(); - - for (int i = 0; i < camelCaseName.length(); ++i) { - char character = camelCaseName.charAt(i); - if (Character.isUpperCase(character)) { - character = Character.toLowerCase(character); - if (convertedName.length() > 0 && ((i + 1) < camelCaseName.length()) - && (Character.isLowerCase(camelCaseName.charAt(i + 1)) - || Character.isLowerCase(camelCaseName.charAt(i - 1)))) { - convertedName.append("_"); - } - convertedName.append(character); - } else { - convertedName.append(character); - } - } - - return convertedName.toString(); - } - - /** - * Convert to upper underscore format. - * - * @param camelCaseName the input name - * @return the string in upper underscore format - */ - public static String toUpperUnderScore(String camelCaseName) { - StringBuilder convertedName = new StringBuilder(); - - for (int i = 0; i < camelCaseName.length(); ++i) { - char character = camelCaseName.charAt(i); - if (Character.isUpperCase(character)) { - if (convertedName.length() > 0 && ((i + 1) < camelCaseName.length()) - && (Character.isLowerCase(camelCaseName.charAt(i + 1)) - || Character.isLowerCase(camelCaseName.charAt(i - 1)))) { - convertedName.append("_"); - } - convertedName.append(character); - } else { - convertedName.append(Character.toUpperCase(character)); - } - } - - return convertedName.toString(); - } - - /** - * Fix camel humps. - * @param name the input name - * @return the string with fixed camel humps - */ - public static String fixCamelHumps(String name) { - if (name == null || name.isEmpty()) { - throw new IllegalArgumentException("Name couldn't be null or empty"); - } - if (Character.isLowerCase(name.charAt(0))) { - return Character.toUpperCase(name.charAt(0)) + name.substring(1); - } - return name; - } - - public static String removePackageName(String fullClassName) { - int index = fullClassName.lastIndexOf('.'); - return index == -1 ? fullClassName : fullClassName.substring(index + 1); - } -} diff --git a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/TypeConverter.java b/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/TypeConverter.java deleted file mode 100644 index 977190fde3..0000000000 --- a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/TypeConverter.java +++ /dev/null @@ -1,293 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.kaaproject.kaa.avro.avrogen; - -import org.apache.avro.Schema; -import org.apache.avro.Schema.Field; -import org.apache.avro.Schema.Type; - -import java.util.List; - -public class TypeConverter { - private static final String DIRECTION_FIELD = "direction"; - - private TypeConverter() { - } - - public static String convertToCType(Schema schema) { - return convertToCType("kaa", schema); - } - - /** - * Convert schema type to the C type. - * - * @param namespace the namespace - * @param schema the schema - * @return the converted schema type - */ - public static String convertToCType(String namespace, Schema schema) { - String typeC = ""; - switch (schema.getType()) { - case BOOLEAN: - typeC = "int8_t"; - break; - case INT: - typeC = "int32_t"; - break; - case LONG: - typeC = "int64_t"; - break; - case FLOAT: - typeC = "float"; - break; - case DOUBLE: - typeC = "double"; - break; - case STRING: - typeC = "kaa_string_t *"; - break; - case BYTES: - case FIXED: - typeC = "kaa_bytes_t *"; - break; - case ARRAY: - typeC = "kaa_list_t *"; - break; - case UNION: - typeC = "kaa_union_t *"; - break; - case ENUM: - typeC = namespace + "_" + StyleUtils.toLowerUnderScore(schema.getName()) + "_t"; - break; - case RECORD: - typeC = namespace + "_" + StyleUtils.toLowerUnderScore(schema.getName()) + "_t *"; - break; - default: - // TODO: add handling - break; - } - - return typeC; - } - - /** - * Convert schema type to the object C type. - * - * @param schema the schema - * @return the converted schema type - */ - public static String convertToObjCType(Schema schema) { - String objCType = ""; - switch (schema.getType()) { - case BOOLEAN: - objCType = "BOOL"; - break; - case INT: - objCType = "int32_t"; - break; - case LONG: - objCType = "int64_t"; - break; - case FLOAT: - objCType = "float"; - break; - case DOUBLE: - objCType = "double"; - break; - case STRING: - objCType = "NSString *"; - break; - case BYTES: - case FIXED: - objCType = "NSData *"; - break; - case ARRAY: - objCType = "NSArray *"; - break; - case UNION: - objCType = "KAAUnion *"; - break; - case ENUM: - objCType = schema.getName(); - break; - case RECORD: - objCType = schema.getName() + " *"; - break; - default: - // TODO: add handling - break; - } - - return objCType; - } - - public static String generateUnionName(Schema schema) { - return generateUnionName("", schema); - } - - /** - * Generate union name. - * - * @param prefix the prefix to union name - * @param schema the schema - * @return generated union name - */ - public static String generateUnionName(String prefix, Schema schema) { - StringBuilder builder = new StringBuilder(prefix + "_UNION_"); - - List branches = schema.getTypes(); - int branchCounter = branches.size(); - - for (Schema branchSchema : branches) { - switch (branchSchema.getType()) { - case RECORD: - builder.append(StyleUtils.toUpperUnderScore(branchSchema.getName())); - break; - case ARRAY: - builder.append(branchSchema.getType().toString()); - builder.append('_'); - builder.append(StyleUtils.toUpperUnderScore(branchSchema.getElementType().getName())); - break; - case ENUM: - builder.append(StyleUtils.toUpperUnderScore(branchSchema.getName())); - break; - default: - builder.append(branchSchema.getType().toString()); - break; - } - - if (--branchCounter > 0) { - builder.append("_OR_"); - } - } - - return builder.toString(); - } - - /** - * Check is record need deal locator. - * - * @param schema the input schema - * @return boolean 'true' if record need deal locator - */ - public static boolean isRecordNeedDeallocator(Schema schema) { - if (schema.getType() == Type.RECORD) { - for (Field f : schema.getFields()) { - Type type = f.schema().getType(); - if (type == Type.ARRAY || type == Type.BYTES || type == Type.STRING - || type == Type.FIXED || type == Type.RECORD || type == Type.UNION) { - return true; - } - } - } - return false; - } - - /** - * Check is schema an Avro primitive. - * - * @param schema the schema - * @return boolean 'true' if schema is an Avro primitive - */ - public static boolean isAvroPrimitive(Schema schema) { - Type type = schema.getType(); - return type == Type.BOOLEAN || type == Type.INT || type == Type.LONG - || type == Type.ENUM || type == Type.FLOAT || type == Type.DOUBLE; - } - - public static boolean isAvroNull(Schema schema) { - return schema.getType() == Type.NULL; - } - - public static boolean isAvroFixed(Schema schema) { - return schema.getType() == Type.FIXED; - } - - public static boolean isAvroRecord(Schema schema) { - return schema.getType() == Type.RECORD; - } - - public static boolean isAvroUnion(Schema schema) { - return schema.getType() == Type.UNION; - } - - public static boolean isAvroArray(Schema schema) { - return schema.getType() == Type.ARRAY; - } - - public static boolean isAvroEnum(Schema schema) { - return schema.getType() == Type.ENUM; - } - - public static boolean isAvroString(Schema schema) { - return schema.getType() == Type.STRING; - } - - public static boolean isAvroBytes(Schema schema) { - return schema.getType() == Type.BYTES; - } - - public static boolean isAvroFloat(Schema schema) { - return schema.getType() == Type.FLOAT; - } - - public static boolean isAvroDouble(Schema schema) { - return schema.getType() == Type.DOUBLE; - } - - public static boolean isAvroInt(Schema schema) { - return schema.getType() == Type.INT; - } - - public static boolean isAvroLong(Schema schema) { - return schema.getType() == Type.LONG; - } - - public static boolean isAvroBoolean(Schema schema) { - return schema.getType() == Type.BOOLEAN; - } - - public static boolean isTypeOut(Schema schema) { - String prop = schema.getProp(DIRECTION_FIELD); - return prop == null || prop.equalsIgnoreCase("out"); - } - - public static boolean isTypeIn(Schema schema) { - String prop = schema.getProp(DIRECTION_FIELD); - return prop == null || prop.equalsIgnoreCase("in"); - } - - public static String getLastBranchNumber(Schema schema) { - return "" + (schema.getTypes().size() - 1); - } - - /** - * Check if the schema contains union. - * - * @param schema the schema - * @return boolean 'true' if the schema contains union - */ - public static boolean containsUnion(Schema schema) { - for (Field field : schema.getFields()) { - if (isAvroUnion(field.schema())) { - return true; - } - } - - return false; - } -} diff --git a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/compiler/CCompiler.java b/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/compiler/CCompiler.java deleted file mode 100644 index 248d42cb1d..0000000000 --- a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/compiler/CCompiler.java +++ /dev/null @@ -1,114 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.kaaproject.kaa.avro.avrogen.compiler; - -import org.apache.avro.Schema; -import org.apache.velocity.VelocityContext; -import org.kaaproject.kaa.avro.avrogen.GenerationContext; -import org.kaaproject.kaa.avro.avrogen.KaaGeneratorException; -import org.kaaproject.kaa.avro.avrogen.StyleUtils; -import org.kaaproject.kaa.avro.avrogen.TypeConverter; - -import java.io.OutputStream; -import java.io.StringWriter; -import java.util.List; -import java.util.Map; - -public class CCompiler extends Compiler { - - public CCompiler(String schemaPath, String outputPath, String sourceName) - throws KaaGeneratorException { - super(schemaPath, outputPath, sourceName); - } - - public CCompiler(Schema schema, String sourceName, OutputStream hdrS, OutputStream srcS) - throws KaaGeneratorException { - super(schema, sourceName, hdrS, srcS); - } - - public CCompiler(List schemas, String sourceName, OutputStream hdrS, OutputStream srcS) - throws KaaGeneratorException { - super(schemas, sourceName, hdrS, srcS); - } - - @Override - protected String headerTemplateGen() { - return "src/main/resources/header.tmpl.gen"; - } - - @Override - protected String sourceTemplateGen() { - return "src/main/resources/source.tmpl.gen"; - } - - @Override - protected String headerTemplate() { - return "header.tmpl"; - } - - @Override - protected String sourceTemplate() { - return "source.tmpl"; - } - - @Override - protected String getSourceExtension() { - return ".c"; - } - - @Override - protected void doGenerate() { - for (Map.Entry cursor : schemaGenerationQueue.entrySet()) { - switch (cursor.getKey().getType()) { - case RECORD: - processRecord(cursor.getKey(), "record.h.vm", "record.c.vm"); - break; - case UNION: - processUnion(cursor.getKey(), cursor.getValue()); - break; - case ENUM: - processEnum(cursor.getKey(), "enum.h.vm"); - break; - default: - break; - } - } - completeGeneration(); - } - - private void processUnion(Schema schema, GenerationContext genContext) { - VelocityContext context = new VelocityContext(); - - context.put("schema", schema); - context.put("generationContext", genContext); - context.put("StyleUtils", StyleUtils.class); - context.put("TypeConverter", TypeConverter.class); - context.put("namespacePrefix", namespacePrefix); - - StringWriter headerWriter = new StringWriter(); - engine.getTemplate("union.h.vm").merge(context, headerWriter); - appendResult(headerWriter.toString(), true); - - StringWriter sourceWriter = new StringWriter(); - engine.getTemplate("union.c.vm").merge(context, sourceWriter); - appendResult(sourceWriter.toString(), false); - } - - private void completeGeneration() { - headerWriter.write("#ifdef __cplusplus\n} /* extern \"C\" */\n#endif\n#endif"); - } -} diff --git a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/compiler/Compiler.java b/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/compiler/Compiler.java deleted file mode 100644 index 7cd3b9e630..0000000000 --- a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/compiler/Compiler.java +++ /dev/null @@ -1,331 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.kaaproject.kaa.avro.avrogen.compiler; - -import static org.apache.commons.lang.StringUtils.join; - -import org.apache.avro.Schema; -import org.apache.avro.Schema.Field; -import org.apache.avro.Schema.Type; -import org.apache.velocity.VelocityContext; -import org.apache.velocity.app.VelocityEngine; -import org.kaaproject.kaa.avro.avrogen.GenerationContext; -import org.kaaproject.kaa.avro.avrogen.KaaGeneratorException; -import org.kaaproject.kaa.avro.avrogen.StyleUtils; -import org.kaaproject.kaa.avro.avrogen.TypeConverter; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.BufferedWriter; -import java.io.File; -import java.io.FileOutputStream; -import java.io.FileWriter; -import java.io.OutputStream; -import java.io.PrintWriter; -import java.io.StringWriter; -import java.nio.file.Files; -import java.nio.file.StandardCopyOption; -import java.util.ArrayList; -import java.util.HashSet; -import java.util.LinkedHashMap; -import java.util.List; -import java.util.Map; -import java.util.Set; - -/** - * The type Compiler. - */ -public abstract class Compiler { - private static final String DIRECTION_PROP = "direction"; - - - private static final Logger LOG = LoggerFactory.getLogger(Compiler.class); - protected final Map schemaGenerationQueue; - private final String generatedSourceName; - protected VelocityEngine engine; - - protected PrintWriter headerWriter; - protected PrintWriter sourceWriter; - - protected String namespacePrefix; - // list of schemas that should be skipped during generation - protected Set generatedSchemas = new HashSet<>(); - private List schemas = new ArrayList<>(); - - - private Compiler(String sourceName) throws KaaGeneratorException { - this.namespacePrefix = "kaa"; - this.generatedSourceName = sourceName; - this.schemaGenerationQueue = new LinkedHashMap<>(); - initVelocityEngine(); - } - - - /** - * Instantiates a new Compiler. - * - * @param schema the schema that used to generate source files - * @param sourceName the name of source file - * @param hdrS the stream of header file - * @param srcS the stream of source file - */ - public Compiler(Schema schema, String sourceName, OutputStream hdrS, OutputStream srcS) - throws KaaGeneratorException { - this(sourceName); - this.schemas.add(schema); - this.headerWriter = new PrintWriter(hdrS); - this.sourceWriter = new PrintWriter(srcS); - prepareTemplates(false); - } - - - /** - * Instantiates a new Compiler. - * - * @param schemas list of schemas that used to generate source files - * @param sourceName name of source files - * @param hdrS stream of the header file - * @param srcS stream of the source file - */ - public Compiler(List schemas, String sourceName, OutputStream hdrS, OutputStream srcS) - throws KaaGeneratorException { - this(sourceName); - this.schemas.addAll(schemas); - this.headerWriter = new PrintWriter(hdrS); - this.sourceWriter = new PrintWriter(srcS); - prepareTemplates(false); - } - - - public Compiler(List schemas, String sourceName, OutputStream hdrS, OutputStream srcS, - Set generatedSchemas) throws KaaGeneratorException { - this(schemas, sourceName, hdrS, srcS); - this.generatedSchemas = new HashSet<>(generatedSchemas); - } - - - /** - * Instantiates a new Compiler. - * - * @param schemaPath path to file that contains schema - * @param outputPath destination path for generated sources - * @param sourceName name of source files - */ - public Compiler(String schemaPath, String outputPath, String sourceName) - throws KaaGeneratorException { - this(sourceName); - try { - this.schemas.add(new Schema.Parser().parse(new File(schemaPath))); - - prepareTemplates(true); - - File outputDir = new File(outputPath); - outputDir.mkdirs(); - - String headerPath = outputPath + File.separator + generatedSourceName + ".h"; - String sourcePath = outputPath + File.separator + generatedSourceName + getSourceExtension(); - - Files.move(new File(headerTemplateGen()).toPath(), - new File(headerPath).toPath(), StandardCopyOption.REPLACE_EXISTING); - Files.move(new File(sourceTemplateGen()).toPath(), - new File(sourcePath).toPath(), StandardCopyOption.REPLACE_EXISTING); - - this.headerWriter = new PrintWriter(new BufferedWriter(new FileWriter(headerPath, true))); - this.sourceWriter = new PrintWriter(new BufferedWriter(new FileWriter(sourcePath, true))); - } catch (Exception ex) { - LOG.error("Failed to create ouput path: ", ex); - throw new KaaGeneratorException("Failed to create output path: " + ex.toString()); - } - } - - private void initVelocityEngine() { - engine = new VelocityEngine(); - - engine.addProperty("resource.loader", "class, file"); - engine.addProperty("class.resource.loader.class", - "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader"); - engine.addProperty("file.resource.loader.class", - "org.apache.velocity.runtime.resource.loader.FileResourceLoader"); - engine.addProperty("file.resource.loader.path", "/, ."); - engine.setProperty("runtime.references.strict", true); - engine.setProperty("runtime.log.logsystem.class", - "org.apache.velocity.runtime.log.NullLogSystem"); - } - - protected abstract String headerTemplateGen(); - - protected abstract String sourceTemplateGen(); - - protected abstract String headerTemplate(); - - protected abstract String sourceTemplate(); - - protected abstract String getSourceExtension(); - - private void prepareTemplates(boolean toFile) throws KaaGeneratorException { - try { - VelocityContext context = new VelocityContext(); - context.put("headerName", generatedSourceName); - - StringWriter hdrWriter = new StringWriter(); - engine.getTemplate(headerTemplate()).merge(context, hdrWriter); - - StringWriter srcWriter = new StringWriter(); - engine.getTemplate(sourceTemplate()).merge(context, srcWriter); - - if (toFile) { - writeToFile(hdrWriter, srcWriter); - } else { - writeToStream(hdrWriter, srcWriter); - } - } catch (Exception ex) { - LOG.error("Failed to prepare source templates: ", ex); - throw new KaaGeneratorException("Failed to prepare source templates: " + ex.toString()); - } - } - - private void writeToStream(StringWriter hdrWriter, StringWriter srcWriter) { - headerWriter.write(hdrWriter.toString()); - sourceWriter.write(srcWriter.toString()); - } - - private void writeToFile(StringWriter hdrWriter, StringWriter srcWriter) throws Exception { - FileOutputStream hdrOs = new FileOutputStream(headerTemplateGen()); - hdrOs.write(hdrWriter.toString().getBytes()); - hdrOs.close(); - - FileOutputStream srcOs = new FileOutputStream(sourceTemplateGen()); - srcOs.write(srcWriter.toString().getBytes()); - srcOs.close(); - } - - - /** - * Generate source files using the schemas and write them to specified source file. - */ - public Set generate() throws KaaGeneratorException { - try { - LOG.debug("Processing schemas: [" + join(schemas, ", ") + "]"); - for (Schema schema : schemas) { - - if (schema.getType() == Type.UNION) { - for (Schema s : schema.getTypes()) { - addAllSchemasToQueue(s, null); - } - } else { - addAllSchemasToQueue(schema, null); - } - } - - - doGenerate(); - - LOG.debug("Sources were successfully generated"); - return schemaGenerationQueue.keySet(); - } catch (Exception ex) { - LOG.error("Failed to generate C sources: ", ex); - throw new KaaGeneratorException("Failed to generate sources: " + ex.toString()); - } finally { - headerWriter.close(); - sourceWriter.close(); - } - } - - /** - * Recursively add all unique dependencies of a passed schema and the one to generation queue, - * that used to generate sources. - */ - private void addAllSchemasToQueue(Schema schema, GenerationContext context) { - GenerationContext existingContext = schemaGenerationQueue.get(schema); - - if (existingContext != null) { - existingContext.updateDirection(context); - return; - } - - switch (schema.getType()) { - case RECORD: - for (Field f : schema.getFields()) { - addAllSchemasToQueue(f.schema(), new GenerationContext( - schema.getName(), f.name(), schema.getProp(DIRECTION_PROP))); - } - schemaGenerationQueue.put(schema, null); - break; - case UNION: - for (Schema branchSchema : schema.getTypes()) { - addAllSchemasToQueue(branchSchema, context); - } - schemaGenerationQueue.put(schema, context); - break; - case ARRAY: - addAllSchemasToQueue(schema.getElementType(), context); - break; - case ENUM: - schemaGenerationQueue.put(schema, null); - break; - default: - break; - } - } - - protected abstract void doGenerate(); - - protected void processRecord(Schema schema, String headerTemplate, String sourceTemplate) { - VelocityContext context = new VelocityContext(); - - context.put("schema", schema); - context.put("StyleUtils", StyleUtils.class); - context.put("TypeConverter", TypeConverter.class); - context.put("namespacePrefix", namespacePrefix); - - StringWriter hdrWriter = new StringWriter(); - engine.getTemplate(headerTemplate).merge(context, hdrWriter); - appendResult(hdrWriter.toString(), true); - - StringWriter srcWriter = new StringWriter(); - engine.getTemplate(sourceTemplate).merge(context, srcWriter); - appendResult(srcWriter.toString(), false); - } - - protected void processEnum(Schema schema, String template) { - VelocityContext context = new VelocityContext(); - - List symbols = schema.getEnumSymbols(); - - context.put("schema", schema); - context.put("symbols", symbols); - context.put("StyleUtils", StyleUtils.class); - context.put("namespacePrefix", namespacePrefix); - - StringWriter writer = new StringWriter(); - engine.getTemplate(template).merge(context, writer); - appendResult(writer.toString(), true); - } - - protected void appendResult(String str, boolean toHeader) { - if (toHeader) { - headerWriter.write(str); - } else { - sourceWriter.write(str); - } - } - - public void setNamespacePrefix(String namespacePrefix) { - this.namespacePrefix = namespacePrefix; - } - -} \ No newline at end of file diff --git a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/compiler/ObjectiveCCompiler.java b/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/compiler/ObjectiveCCompiler.java deleted file mode 100644 index ed52e6374a..0000000000 --- a/avrogen/src/main/java/org/kaaproject/kaa/avro/avrogen/compiler/ObjectiveCCompiler.java +++ /dev/null @@ -1,96 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.kaaproject.kaa.avro.avrogen.compiler; - -import org.apache.avro.Schema; -import org.kaaproject.kaa.avro.avrogen.GenerationContext; -import org.kaaproject.kaa.avro.avrogen.KaaGeneratorException; - -import java.io.OutputStream; -import java.util.List; -import java.util.Map; -import java.util.Set; - -public class ObjectiveCCompiler extends Compiler { - - public ObjectiveCCompiler(Schema schema, String sourceName, OutputStream hdrS, OutputStream srcS) - throws KaaGeneratorException { - super(schema, sourceName, hdrS, srcS); - setNamespacePrefix(""); - } - - public ObjectiveCCompiler(String schemaPath, String outputPath, String sourceName) - throws KaaGeneratorException { - super(schemaPath, outputPath, sourceName); - setNamespacePrefix(""); - } - - - public ObjectiveCCompiler(List schemas, String sourceName, OutputStream hdrS, - OutputStream srcS) throws KaaGeneratorException { - super(schemas, sourceName, hdrS, srcS); - } - - public ObjectiveCCompiler(List schemas, String sourceName, OutputStream hdrS, - OutputStream srcS, Set generatedSchemas) - throws KaaGeneratorException { - super(schemas, sourceName, hdrS, srcS, generatedSchemas); - } - - @Override - protected String headerTemplateGen() { - return "src/main/resources/ObjC/headerObjC.tmpl.gen"; - } - - @Override - protected String sourceTemplateGen() { - return "src/main/resources/ObjC/sourceObjC.tmpl.gen"; - } - - @Override - protected String headerTemplate() { - return "ObjC/headerObjC.tmpl"; - } - - @Override - protected String sourceTemplate() { - return "ObjC/sourceObjC.tmpl"; - } - - @Override - protected String getSourceExtension() { - return ".m"; - } - - @Override - protected void doGenerate() { - for (Map.Entry cursor : schemaGenerationQueue.entrySet()) { - if (!generatedSchemas.contains(cursor.getKey())) { // process only not generated schemas - switch (cursor.getKey().getType()) { - case RECORD: - processRecord(cursor.getKey(), "ObjC/recordObjC.h.vm", "ObjC/recordObjC.m.vm"); - break; - case ENUM: - processEnum(cursor.getKey(), "ObjC/enumObjC.h.vm"); - break; - default: - break; - } - } - } - } -} diff --git a/avrogen/src/main/resources/ObjC/enumObjC.h.vm b/avrogen/src/main/resources/ObjC/enumObjC.h.vm deleted file mode 100644 index 5953711559..0000000000 --- a/avrogen/src/main/resources/ObjC/enumObjC.h.vm +++ /dev/null @@ -1,24 +0,0 @@ -#* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - *# - -#set ($ENUM_NAME = $StyleUtils.toUpperUnderScore($schema.getName())) -#set ($enum_name = $schema.getName()) - -typedef enum { -#foreach ($symbol in $schema.getEnumSymbols()) - ${ENUM_NAME}_$symbol, -#end -} $namespacePrefix${enum_name}; diff --git a/avrogen/src/main/resources/ObjC/headerObjC.tmpl b/avrogen/src/main/resources/ObjC/headerObjC.tmpl deleted file mode 100644 index 78b00b6a4d..0000000000 --- a/avrogen/src/main/resources/ObjC/headerObjC.tmpl +++ /dev/null @@ -1,24 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/* - * AUTO-GENERATED CODE - */ - -#import -#import "AvroUtils.h" -#import "AvroBased.h" -#import "KAAUnion.h" diff --git a/avrogen/src/main/resources/ObjC/recordObjC.h.vm b/avrogen/src/main/resources/ObjC/recordObjC.h.vm deleted file mode 100644 index 552b9c755f..0000000000 --- a/avrogen/src/main/resources/ObjC/recordObjC.h.vm +++ /dev/null @@ -1,72 +0,0 @@ -#* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - *# - -#set ($record_name = $schema.getName()) - -@interface $namespacePrefix${record_name} : AvroBased - -#foreach ($field in $schema.getFields()) -#set ($field_type = $TypeConverter.convertToObjCType($field.schema())) -#set ($field_name = $field.name()) -#if ($TypeConverter.isAvroEnum($field.schema())) -@property(nonatomic) $namespacePrefix${field_type} ${field_name}; -#elseif ($TypeConverter.isAvroPrimitive($field.schema())) -@property(nonatomic) ${field_type} ${field_name}; -#elseif ($TypeConverter.isAvroRecord($field.schema())) -@property(nonatomic, strong) $namespacePrefix${field_type}${field_name}; -#else -@property(nonatomic, strong) ${field_type}${field_name}; -#end -#end - -#if ($schema.getFields().size() > 0) -#set ($string = '- (instancetype)initWith') -#set ($initstring = '') -#foreach ($field in $schema.getFields()) -#if ($TypeConverter.isAvroEnum($field.schema()) || $TypeConverter.isAvroRecord($field.schema())) -#set ($field_type = "$namespacePrefix$TypeConverter.convertToObjCType($field.schema())") -#else -#set ($field_type = $TypeConverter.convertToObjCType($field.schema())) -#end -#set ($field_name = $field.name()) -#if ($field == $schema.getFields().get(0)) -#set ($initstring = "$string$StyleUtils.fixCamelHumps($field_name):(${field_type})$field_name") -#else -#set ($initstring = "$initstring $field_name:(${field_type})$field_name") -#end -#end -$initstring; -#end - -#foreach ($field in $schema.getFields()) -#set ($field_name = $field.name()) -#if ($TypeConverter.isAvroUnion($field.schema())) - -#set ($UNION_NAME = $TypeConverter.generateUnionName("KAA", $field.schema())) -#set ($branch_number = 0) -# ifndef ${UNION_NAME}_H_ -# define ${UNION_NAME}_H_ - -#foreach ($branch_schema in $field.schema().getTypes()) -# define ${UNION_NAME}_BRANCH_${branch_number} ${branch_number} -#set ($branch_number = $branch_number + 1) -#end - -# endif // ${UNION_NAME}_H_ - -#end -#end -@end diff --git a/avrogen/src/main/resources/ObjC/recordObjC.m.vm b/avrogen/src/main/resources/ObjC/recordObjC.m.vm deleted file mode 100644 index a9ea5442a5..0000000000 --- a/avrogen/src/main/resources/ObjC/recordObjC.m.vm +++ /dev/null @@ -1,494 +0,0 @@ -#* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - *# - -@implementation $namespacePrefix$schema.getName() - -#if ($TypeConverter.containsUnion($schema)) -- (instancetype)init { - self = [super init]; - if (self) { - #foreach ($field in $schema.getFields()) - #if ($TypeConverter.isAvroUnion($field.schema())) - #set ($UNION_NAME = $TypeConverter.generateUnionName("KAA", $field.schema())) - self.$field.name() = [KAAUnion unionWithBranch:${UNION_NAME}_BRANCH_$TypeConverter.getLastBranchNumber($field.schema())]; - #end - #end -} - return self; -} -#end - -#if ($schema.getFields().size() > 0) -#set ($string = '- (instancetype)initWith') -#set ($initstring = '') -#foreach ($field in $schema.getFields()) -#if ($TypeConverter.isAvroEnum($field.schema()) || $TypeConverter.isAvroRecord($field.schema())) -#set ($field_type = "$namespacePrefix$TypeConverter.convertToObjCType($field.schema())") -#else -#set ($field_type = $TypeConverter.convertToObjCType($field.schema())) -#end -#set ($field_name = $field.name()) -#if ($field == $schema.getFields().get(0)) -#set ($initstring = "$string$StyleUtils.fixCamelHumps($field_name):(${field_type})$field_name") -#else -#set ($initstring = "$initstring $field_name:(${field_type})$field_name") -#end -#end -$initstring { - self = [super init]; - if (self) { - #foreach ($field in $schema.getFields()) - self.$field.name() = $field.name(); - #end -} - return self; -} -#end - -+ (NSString *)FQN { - return @"$schema.getFullName()"; -} - -###if ($TypeConverter.isTypeOut($schema)) -- (void)serialize:(avro_writer_t)writer { -#foreach ($field in $schema.getFields()) -#set ($field_name = $field.name()) -#set ($field_schema = $field.schema()) -#if ($TypeConverter.isAvroRecord($field_schema) && $field_schema.getFields().size() > 0) - [self.${field_name} serialize:writer]; -#elseif ($TypeConverter.isAvroUnion($field_schema)) -#set ($union_element_name = $StyleUtils.fixCamelHumps($field_name)) - [self serialize${union_element_name}:self.${field_name} to:writer]; -#elseif ($TypeConverter.isAvroBytes($field_schema)) - [self.utils serializeBytes:self.${field_name} to:writer]; -#elseif ($TypeConverter.isAvroFixed($field_schema)) - [self.utils serializeFixed:self.${field_name} to:writer]; -#elseif ($TypeConverter.isAvroString($field_schema)) - [self.utils serializeString:self.${field_name} to:writer]; -#elseif ($TypeConverter.isAvroBoolean($field_schema)) - [self.utils serializeBoolean:@(self.${field_name}) to:writer]; -#elseif ($TypeConverter.isAvroInt($field_schema)) - [self.utils serializeInt:@(self.${field_name}) to:writer]; -#elseif ($TypeConverter.isAvroLong($field_schema)) - [self.utils serializeLong:@(self.${field_name}) to:writer]; -#elseif ($TypeConverter.isAvroEnum($field_schema)) - [self.utils serializeEnum:@(self.${field_name}) to:writer]; -#elseif ($TypeConverter.isAvroFloat($field_schema)) - [self.utils serializeFloat:@((float)self.${field_name}) to:writer]; -#elseif ($TypeConverter.isAvroDouble($field_schema)) - [self.utils serializeDouble:@(self.${field_name}) to:writer]; -#elseif ($TypeConverter.isAvroArray($field_schema)) -#set ($array_element_schema = $field_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - [self.utils serializeArray:self.${field_name} to:writer withSelector:@selector(serializeRecord:to:) target:nil]; - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - #set ($union_element_name = $StyleUtils.fixCamelHumps($field_name)) - [self serialize${union_element_name}:self.${field_name} to:writer]; - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - [self.utils serializeArray:self.${field_name} to:writer withSelector:@selector(serializeBytes:to:) target:nil]; - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - [self.utils serializeArray:self.${field_name} to:writer withSelector:@selector(serializeFixed:to:) target:nil]; - #elseif ($TypeConverter.isAvroString($array_element_schema)) - [self.utils serializeArray:self.${field_name} to:writer withSelector:@selector(serializeString:to:) target:nil]; - #elseif ($TypeConverter.isAvroBoolean($array_element_schema)) - [self.utils serializeArray:self.${field_name} to:writer withSelector:@selector(serializeBoolean:to:) target:nil]; - #elseif ($TypeConverter.isAvroInt($array_element_schema)) - [self.utils serializeArray:self.${field_name} to:writer withSelector:@selector(serializeInt:to:) target:nil]; - #elseif ($TypeConverter.isAvroLong($array_element_schema)) - [self.utils serializeArray:self.${field_name} to:writer withSelector:@selector(serializeLong:to:) target:nil]; - #elseif ($TypeConverter.isAvroEnum($array_element_schema)) - [self.utils serializeArray:self.${field_name} to:writer withSelector:@selector(serializeEnum:to:) target:nil]; - #elseif ($TypeConverter.isAvroFloat($array_element_schema)) - [self.utils serializeArray:self.${field_name} to:writer withSelector:@selector(serializeFloat:to:) target:nil]; - #elseif ($TypeConverter.isAvroDouble($array_element_schema)) - [self.utils serializeArray:self.${field_name} to:writer withSelector:@selector(serializeDouble:to:) target:nil]; - #end -#end -#end -#if ($schema.getFields().size() == 0) - #pragma unused(writer) -#end -} - -- (size_t)getSize { - size_t recordSize = 0; -#foreach ($field in $schema.getFields()) -#set ($field_name = $field.name()) -#set ($field_schema = $field.schema()) -#if ($TypeConverter.isAvroRecord($field_schema) && $field_schema.getFields().size() > 0) - recordSize += [self.${field_name} getSize]; -#elseif ($TypeConverter.isAvroUnion($field_schema)) -#set ($union_element_name = $StyleUtils.fixCamelHumps($field_name)) - recordSize += [self get${union_element_name}Size:self.${field_name}]; -#elseif ($TypeConverter.isAvroBytes($field_schema)) - recordSize += [self.utils getBytesSize:self.${field_name}]; -#elseif ($TypeConverter.isAvroFixed($field_schema)) - recordSize += [self.utils getFixedSize:self.${field_name}]; -#elseif ($TypeConverter.isAvroString($field_schema)) - recordSize += [self.utils getStringSize:self.${field_name}]; -#elseif ($TypeConverter.isAvroFloat($field_schema)) - recordSize += [self.utils getFloatSize]; -#elseif ($TypeConverter.isAvroDouble($field_schema)) - recordSize += [self.utils getDoubleSize]; -#elseif ($TypeConverter.isAvroBoolean($field_schema)) - recordSize += [self.utils getBooleanSize:@(self.${field_name})]; -#elseif ($TypeConverter.isAvroInt($field_schema)) - recordSize += [self.utils getIntSize:@(self.${field_name})]; -#elseif ($TypeConverter.isAvroLong($field_schema)) - recordSize += [self.utils getLongSize:@(self.${field_name})]; -#elseif ($TypeConverter.isAvroEnum($field_schema)) - recordSize += [self.utils getEnumSize:@(self.${field_name})]; -#elseif ($TypeConverter.isAvroArray($field_schema)) -#set ($array_element_schema = $field_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - recordSize += [self.utils getArraySize:self.${field_name} withSelector:@selector(getSize) parameterized:NO target:nil]; - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - #set ($union_element_name = $StyleUtils.fixCamelHumps($field_name)) - recordSize += [self.utils getArraySize:self.${field_name} withSelector:@selector(get${union_element_name}Size:) parameterized:YES target:self]; - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - recordSize += [self.utils getArraySize:self.${field_name} withSelector:@selector(getBytesSize:) parameterized:YES target:self.utils]; - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - recordSize += [self.utils getArraySize:self.${field_name} withSelector:@selector(getFixedSize:) parameterized:YES target:self.utils]; - #elseif ($TypeConverter.isAvroString($array_element_schema)) - recordSize += [self.utils getArraySize:self.${field_name} withSelector:@selector(getStringSize:) parameterized:YES target:self.utils]; - #elseif ($TypeConverter.isAvroFloat($array_element_schema)) - recordSize += [self.utils getArraySize:self.${field_name} withSelector:@selector(getFloatSize) parameterized:NO target:self.utils]; - #elseif ($TypeConverter.isAvroDouble($array_element_schema)) - recordSize += [self.utils getArraySize:self.${field_name} withSelector:@selector(getDoubleSize) parameterized:NO target:self.utils]; - #elseif ($TypeConverter.isAvroBoolean($array_element_schema)) - recordSize += [self.utils getArraySize:self.${field_name} withSelector:@selector(getBooleanSize:) parameterized:YES target:self.utils]; - #elseif ($TypeConverter.isAvroInt($array_element_schema)) - recordSize += [self.utils getArraySize:self.${field_name} withSelector:@selector(getIntSize:) parameterized:YES target:self.utils]; - #elseif ($TypeConverter.isAvroLong($array_element_schema)) - recordSize += [self.utils getArraySize:self.${field_name} withSelector:@selector(getLongSize:) parameterized:YES target:self.utils]; - #elseif ($TypeConverter.isAvroEnum($array_element_schema)) - recordSize += [self.utils getArraySize:self.${field_name} withSelector:@selector(getEnumSize:) parameterized:YES target:self.utils]; - #end -#end -#end - return recordSize; -} -###end - -###if ($TypeConverter.isTypeIn($schema)) -- (void)deserialize:(avro_reader_t)reader { -#foreach ($field in $schema.getFields()) -#set ($field_name = $field.name()) -#set ($field_schema = $field.schema()) -#if ($TypeConverter.isAvroRecord($field_schema)) -#set ($record_field_name = $field_schema.getName()) - self.${field_name} = ($namespacePrefix${record_field_name} *)[self.utils deserializeRecord:reader as:[$namespacePrefix${record_field_name} class]]; -#elseif ($TypeConverter.isAvroUnion($field_schema)) -#set ($union_element_name = $StyleUtils.fixCamelHumps($field_name)) - self.${field_name} = [self deserialize${union_element_name}:reader]; -#elseif ($TypeConverter.isAvroBytes($field_schema)) - self.${field_name} = [self.utils deserializeBytes:reader]; -#elseif ($TypeConverter.isAvroFixed($field_schema)) - NSNumber *size = @($field_schema.getFixedSize()); - self.${field_name} = [self.utils deserializeFixed:reader size:size]; -#elseif ($TypeConverter.isAvroString($field_schema)) - self.${field_name} = [self.utils deserializeString:reader]; -#elseif ($TypeConverter.isAvroEnum($field_schema)) - self.${field_name} = [[self.utils deserializeEnum:reader] intValue]; -#elseif ($TypeConverter.isAvroBoolean($field_schema)) - self.${field_name} = [[self.utils deserializeBoolean:reader] boolValue]; -#elseif ($TypeConverter.isAvroInt($field_schema)) - self.${field_name} = [[self.utils deserializeInt:reader] intValue]; -#elseif ($TypeConverter.isAvroLong($field_schema)) - self.${field_name} = [[self.utils deserializeLong:reader] longLongValue]; -#elseif ($TypeConverter.isAvroFloat($field_schema)) - self.${field_name} = [[self.utils deserializeFloat:reader] floatValue]; -#elseif ($TypeConverter.isAvroDouble($field_schema)) - self.${field_name} = [[self.utils deserializeDouble:reader] doubleValue]; - -#elseif ($TypeConverter.isAvroArray($field_schema)) -#set ($array_element_schema = $field_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - #set ($record_element_name = $array_element_schema.getName()) - Class recClass = [$namespacePrefix${record_element_name} class]; - self.${field_name} = [self.utils deserializeArray:reader withSelector:@selector(deserializeRecord:as:) andParam:recClass target:nil]; - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - #set ($union_element_name = $StyleUtils.fixCamelHumps($field_name)) - self.${field_name} = [self deserialize${union_element_name}:reader]; - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - self.${field_name} = [self.utils deserializeArray:reader withSelector:@selector(deserializeBytes:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - NSNumber *size = @($array_element_schema.getFixedSize()); - self.${field_name} = [self.utils deserializeArray:reader withSelector:@selector(deserializeFixed:size:) andParam:size target:nil]; - #elseif ($TypeConverter.isAvroString($array_element_schema)) - self.${field_name} = [self.utils deserializeArray:reader withSelector:@selector(deserializeString:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroEnum($array_element_schema)) - self.${field_name} = [self.utils deserializeArray:reader withSelector:@selector(deserializeEnum:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroBoolean($array_element_schema)) - self.${field_name} = [self.utils deserializeArray:reader withSelector:@selector(deserializeBoolean:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroInt($array_element_schema)) - self.${field_name} = [self.utils deserializeArray:reader withSelector:@selector(deserializeInt:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroLong($array_element_schema)) - self.${field_name} = [self.utils deserializeArray:reader withSelector:@selector(deserializeLong:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroFloat($array_element_schema)) - self.${field_name} = [self.utils deserializeArray:reader withSelector:@selector(deserializeFloat:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroDouble($array_element_schema)) - self.${field_name} = [self.utils deserializeArray:reader withSelector:@selector(deserializeDouble:) andParam:nil target:nil]; - #end -#end -#end -#if ($schema.getFields().size() == 0) - #pragma unused(reader) -#end -} - -## Generating serialize/deserialize/getSize methods for Unions - -#if ($schema.getFields().size() > 0) -#foreach ($field in $schema.getFields()) -#if ($TypeConverter.isAvroUnion($field.schema())) -#set ($field_name = $StyleUtils.fixCamelHumps($field.name())) -#set ($UNION_NAME = $TypeConverter.generateUnionName("KAA", $field.schema())) -#set ($union_name = $UNION_NAME.toLowerCase()) -###if ($generationContext.isTypeOut()) -- (void)serialize${field_name}:(KAAUnion *)kaaUnion to:(avro_writer_t)writer { - - if (kaaUnion) { - avro_binary_encoding.write_long(writer, kaaUnion.branch); - - switch (kaaUnion.branch) { -#set ($branch_number = 0) -#foreach ($branch_schema in $field.schema().getTypes()) -#if (!$TypeConverter.isAvroNull($branch_schema) && !($TypeConverter.isAvroRecord($branch_schema) && $branch_schema.getFields().size() == 0)) - case ${UNION_NAME}_BRANCH_${branch_number}: - { - if (kaaUnion.data) { -#if ($TypeConverter.isAvroRecord($branch_schema)) - [self.utils serializeRecord:kaaUnion.data to:writer]; -#elseif ($TypeConverter.isAvroUnion($branch_schema)) - [self serialize${field_name}:kaaUnion.data to:writer]; -#elseif ($TypeConverter.isAvroBytes($branch_schema)) - [self.utils serializeBytes:kaaUnion.data to:writer]; -#elseif ($TypeConverter.isAvroFixed($branch_schema)) - [self.utils serializeFixed:kaaUnion.data to:writer]; -#elseif ($TypeConverter.isAvroString($branch_schema)) - [self.utils serializeString:kaaUnion.data to:writer]; -#elseif ($TypeConverter.isAvroBoolean($branch_schema)) - [self.utils serializeBoolean:kaaUnion.data to:writer]; -#elseif ($TypeConverter.isAvroInt($branch_schema)) - [self.utils serializeInt:kaaUnion.data to:writer]; -#elseif ($TypeConverter.isAvroLong($branch_schema)) - [self.utils serializeLong:kaaUnion.data to:writer]; -#elseif ($TypeConverter.isAvroEnum($branch_schema)) - [self.utils serializeEnum:kaaUnion.data to:writer]; -#elseif ($TypeConverter.isAvroFloat($branch_schema)) - [self.utils serializeFloat:kaaUnion.data to:writer]; -#elseif ($TypeConverter.isAvroDouble($branch_schema)) - [self.utils serializeDouble:kaaUnion.data to:writer]; -#elseif ($TypeConverter.isAvroArray($branch_schema)) -#set ($array_element_schema = $branch_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - #if ($array_element_schema.getFields().size() > 0) - [self.utils serializeArray:kaaUnion.data to:writer withSelector:@selector(serializeRecord:to:) target:nil]; - #end - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - [self.utils serializeArray:kaaUnion.data to:writer withSelector:@selector(serialize${field_name}:to:) target:self]; - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - [self.utils serializeArray:kaaUnion.data to:writer withSelector:@selector(serializeBytes:to:) target:nil]; - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - [self.utils serializeArray:kaaUnion.data to:writer withSelector:@selector(serializeFixed:to:) target:nil]; - #elseif ($TypeConverter.isAvroString($array_element_schema)) - [self.utils serializeArray:kaaUnion.data to:writer withSelector:@selector(serializeString:to:) target:nil]; - #elseif ($TypeConverter.isAvroBoolean($array_element_schema)) - [self.utils serializeArray:kaaUnion.data to:writer withSelector:@selector(serializeBoolean:to:) target:nil]; - #elseif ($TypeConverter.isAvroInt($array_element_schema)) - [self.utils serializeArray:kaaUnion.data to:writer withSelector:@selector(serializeInt:to:) target:nil]; - #elseif ($TypeConverter.isAvroLong($array_element_schema)) - [self.utils serializeArray:kaaUnion.data to:writer withSelector:@selector(serializeLong:to:) target:nil]; - #elseif ($TypeConverter.isAvroEnum($array_element_schema)) - [self.utils serializeArray:kaaUnion.data to:writer withSelector:@selector(serializeEnum:to:) target:nil]; - #elseif ($TypeConverter.isAvroFloat($array_element_schema)) - [self.utils serializeArray:kaaUnion.data to:writer withSelector:@selector(serializeFloat:to:) target:nil]; - #elseif ($TypeConverter.isAvroDouble($array_element_schema)) - [self.utils serializeArray:kaaUnion.data to:writer withSelector:@selector(serializeDouble:to:) target:nil]; - #end -#end - } - break; - } -#end -#set ($branch_number = $branch_number + 1) -#end - default: - break; - } - } -} -###end - -- (size_t)get${field_name}Size:(KAAUnion *)kaaUnion { - size_t unionSize = [self.utils getLongSize:@(kaaUnion.branch)]; - if (kaaUnion) { - switch (kaaUnion.branch) { -#set ($branch_number = 0) -#foreach ($branch_schema in $field.schema().getTypes()) -#if (!$TypeConverter.isAvroNull($branch_schema) && !($TypeConverter.isAvroRecord($branch_schema) && $branch_schema.getFields().size() == 0)) - case ${UNION_NAME}_BRANCH_${branch_number}: - { - if (kaaUnion.data) { -#if ($TypeConverter.isAvroRecord($branch_schema)) - unionSize += [((id)kaaUnion.data) getSize]; -#elseif ($TypeConverter.isAvroUnion($branch_schema)) - unionSize += [self get${field_name}:kaaUnion.data]; -#elseif ($TypeConverter.isAvroBytes($branch_schema)) - unionSize += [self.utils getBytesSize:kaaUnion.data]; -#elseif ($TypeConverter.isAvroFixed($branch_schema)) - unionSize += [self.utils getFixedSize:kaaUnion.data]; -#elseif ($TypeConverter.isAvroString($branch_schema)) - unionSize += [self.utils getStringSize:kaaUnion.data]; -#elseif ($TypeConverter.isAvroBoolean($branch_schema)) - unionSize += [self.utils getBooleanSize:kaaUnion.data]; -#elseif ($TypeConverter.isAvroInt($branch_schema)) - unionSize += [self.utils getIntSize:kaaUnion.data]; -#elseif ($TypeConverter.isAvroLong($branch_schema)) - unionSize += [self.utils getLongSize:kaaUnion.data]; -#elseif ($TypeConverter.isAvroEnum($branch_schema)) - unionSize += [self.utils getEnumSize:kaaUnion.data]; -#elseif ($TypeConverter.isAvroFloat($branch_schema)) - unionSize += [self.utils getFloatSize]; -#elseif ($TypeConverter.isAvroDouble($branch_schema)) - unionSize += [self.utils getDoubleSize]; -#elseif ($TypeConverter.isAvroArray($branch_schema)) -#set ($array_element_schema = $branch_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - #if ($array_element_schema.getFields().size() > 0) - unionSize += [self.utils getArraySize:kaaUnion.data withSelector:@selector(getSize) parameterized:NO target:nil]; - #end - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - unionSize += [self.utils getArraySize:kaaUnion.data withSelector:@selector(get${field_name}Size:) parameterized:YES target:self]; - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - unionSize += [self.utils getArraySize:kaaUnion.data withSelector:@selector(getBytesSize:) parameterized:YES target:self.utils]; - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - unionSize += [self.utils getArraySize:kaaUnion.data withSelector:@selector(getFixedSize:) parameterized:YES target:self.utils]; - #elseif ($TypeConverter.isAvroString($array_element_schema)) - unionSize += [self.utils getArraySize:kaaUnion.data withSelector:@selector(getStringSize:) parameterized:YES target:self.utils]; - #elseif ($TypeConverter.isAvroBoolean($array_element_schema)) - unionSize += [self.utils getArraySize:kaaUnion.data withSelector:@selector(getBooleanSize:) parameterized:YES target:self.utils]; - #elseif ($TypeConverter.isAvroInt($array_element_schema)) - unionSize += [self.utils getArraySize:kaaUnion.data withSelector:@selector(getIntSize:) parameterized:YES target:self.utils]; - #elseif ($TypeConverter.isAvroLong($array_element_schema)) - unionSize += [self.utils getArraySize:kaaUnion.data withSelector:@selector(getLongSize:) parameterized:YES target:self.utils]; - #elseif ($TypeConverter.isAvroEnum($array_element_schema)) - unionSize += [self.utils getArraySize:kaaUnion.data withSelector:@selector(getEnumSize:) parameterized:YES target:self.utils]; - #elseif ($TypeConverter.isAvroFloat($array_element_schema)) - unionSize += [self.utils getArraySize:kaaUnion.data withSelector:@selector(getFloatSize) parameterized:NO target:self.utils]; - #elseif ($TypeConverter.isAvroDouble($array_element_schema)) - unionSize += [self.utils getArraySize:kaaUnion.data withSelector:@selector(getDoubleSize) parameterized:NO target:self.utils]; - #end -#end - } - break; - } -#end -#set ($branch_number = $branch_number + 1) -#end - default: - break; - } - } - return unionSize; -} - -###if ($generationContext.isTypeIn()) -- (KAAUnion *)deserialize${field_name}:(avro_reader_t)reader { - - KAAUnion *kaaUnion = [[KAAUnion alloc] init]; - - int64_t branch; - avro_binary_encoding.read_long(reader, &branch); - kaaUnion.branch = (int)branch; - - switch (kaaUnion.branch) { -#set ($branch_number = 0) -#foreach ($branch_schema in $field.schema().getTypes()) -#if (!$TypeConverter.isAvroNull($branch_schema)) - case ${UNION_NAME}_BRANCH_${branch_number}: { -#if ($TypeConverter.isAvroRecord($branch_schema)) -#set ($sub_record_name = $branch_schema.getName()) - kaaUnion.data = [self.utils deserializeRecord:reader as:[$namespacePrefix${sub_record_name} class]]; -#elseif ($TypeConverter.isAvroUnion($branch_schema)) - kaaUnion.data = [self deserialize${field_name}:reader]; -#elseif ($TypeConverter.isAvroBytes($branch_schema)) - kaaUnion.data = [self.utils deserializeBytes:reader]; -#elseif ($TypeConverter.isAvroFixed($branch_schema)) - NSNumber *size = @($branch_schema.getFixedSize()); - kaaUnion.data = [self.utils deserializeFixed:reader size:size]; -#elseif ($TypeConverter.isAvroString($branch_schema)) - kaaUnion.data = [self.utils deserializeString:reader]; -#elseif ($TypeConverter.isAvroEnum($branch_schema)) - kaaUnion.data = [self.utils deserializeEnum:reader]; -#elseif ($TypeConverter.isAvroBoolean($branch_schema)) - kaaUnion.data = [self.utils deserializeBoolean:reader]; -#elseif ($TypeConverter.isAvroInt($branch_schema)) - kaaUnion.data = [self.utils deserializeInt:reader]; -#elseif ($TypeConverter.isAvroLong($branch_schema)) - kaaUnion.data = [self.utils deserializeLong:reader]; -#elseif ($TypeConverter.isAvroFloat($branch_schema)) - kaaUnion.data = [self.utils deserializeFloat:reader]; -#elseif ($TypeConverter.isAvroDouble($branch_schema)) - kaaUnion.data = [self.utils deserializeDouble:reader]; -#elseif ($TypeConverter.isAvroArray($branch_schema)) -#set ($array_element_schema = $branch_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - #set ($record_element_name = $array_element_schema.getName()) - Class dataClass = [$namespacePrefix${record_element_name} class]; - kaaUnion.data = [self.utils deserializeArray:reader withSelector:@selector(deserializeRecord:as:) andParam:dataClass target:nil]; - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - kaaUnion.data = [self.utils deserializeArray:reader withSelector:@selector(deserialize${field_name}:) andParam:nil target:self]; - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - kaaUnion.data = [self.utils deserializeArray:reader withSelector:@selector(deserializeBytes:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - NSNumber *size = @($branch_schema.getFixedSize()); - kaaUnion.data = [self.utils deserializeArray:reader withSelector:@selector(deserializeFixed:size:) andParam:size target:nil]; - #elseif ($TypeConverter.isAvroString($array_element_schema)) - kaaUnion.data = [self.utils deserializeArray:reader withSelector:@selector(deserializeString:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroEnum($array_element_schema)) - kaaUnion.data = [self.utils deserializeArray:reader withSelector:@selector(deserializeEnum:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroBoolean($array_element_schema)) - kaaUnion.data = [self.utils deserializeArray:reader withSelector:@selector(deserializeBoolean:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroInt($array_element_schema)) - kaaUnion.data = [self.utils deserializeArray:reader withSelector:@selector(deserializeInt:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroLong($array_element_schema)) - kaaUnion.data = [self.utils deserializeArray:reader withSelector:@selector(deserializeLong:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroFloat($array_element_schema)) - kaaUnion.data = [self.utils deserializeArray:reader withSelector:@selector(deserializeFloat:) andParam:nil target:nil]; - #elseif ($TypeConverter.isAvroDouble($array_element_schema)) - kaaUnion.data = [self.utils deserializeArray:reader withSelector:@selector(deserializeDouble:) andParam:nil target:nil]; - #end -#end - break; - } -#end -#set ($branch_number = $branch_number + 1) -#end - default: - break; - } - - return kaaUnion; -} -###end - -#end -#end -#end -@end -###end \ No newline at end of file diff --git a/avrogen/src/main/resources/ObjC/sourceObjC.tmpl b/avrogen/src/main/resources/ObjC/sourceObjC.tmpl deleted file mode 100644 index e97dd775f6..0000000000 --- a/avrogen/src/main/resources/ObjC/sourceObjC.tmpl +++ /dev/null @@ -1,21 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#import "${headerName}.h" - -/* - * AUTO-GENERATED CODE - */ \ No newline at end of file diff --git a/avrogen/src/main/resources/enum.h.vm b/avrogen/src/main/resources/enum.h.vm deleted file mode 100644 index bb32e4a286..0000000000 --- a/avrogen/src/main/resources/enum.h.vm +++ /dev/null @@ -1,43 +0,0 @@ -#* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - *# - -#set ($ENUM_NAME = $StyleUtils.toUpperUnderScore($schema.getName())) -#set ($enum_name = $StyleUtils.toLowerUnderScore($schema.getName())) - -#set ($PREFIX = $StyleUtils.toUpperUnderScore($namespacePrefix)) -#set ($prefix = $StyleUtils.toLowerUnderScore($namespacePrefix)) -typedef enum { -#foreach ($symbol in $symbols) - ENUM_${ENUM_NAME}_$symbol, -#end -} ${prefix}_${enum_name}_t; - -#ifdef GENC_ENUM_DEFINE_ALIASES -#foreach ($symbol in $symbols) -\#define $symbol ENUM_${ENUM_NAME}_$symbol -#end -# endif // GENC_ENUM_DEFINE_ALIASES - -#ifdef GENC_ENUM_STRING_LITERALS -#set($sym_count = $symbols.size()) -const char* ${PREFIX}_${ENUM_NAME}_SYMBOLS[$sym_count] = { -#foreach ($symbol in $symbols) - "${symbol}"#set($sym_count = $sym_count - 1)#if ($sym_count > 0), -#end -#end -}; -# endif // GENC_ENUM_STRING_LITERALS - diff --git a/avrogen/src/main/resources/header.tmpl b/avrogen/src/main/resources/header.tmpl deleted file mode 100644 index 9042a6a655..0000000000 --- a/avrogen/src/main/resources/header.tmpl +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#set ($headerGuard = $headerName.toUpperCase()) -# ifndef ${headerGuard}_H_ -# define ${headerGuard}_H_ - -# include "kaa_common_schema.h" -# include "collections/kaa_list.h" - -# ifdef __cplusplus -extern "C" { -# endif - diff --git a/avrogen/src/main/resources/record.c.vm b/avrogen/src/main/resources/record.c.vm deleted file mode 100644 index ff4701196c..0000000000 --- a/avrogen/src/main/resources/record.c.vm +++ /dev/null @@ -1,271 +0,0 @@ -#* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - *# - -#set ($PREFIX = $StyleUtils.toUpperUnderScore($namespacePrefix)) -#set ($prefix = $StyleUtils.toLowerUnderScore($namespacePrefix)) -#set ($record_name = $StyleUtils.toLowerUnderScore($schema.getName())) -#set ($is_destructor_needed = $TypeConverter.isRecordNeedDeallocator($schema)) -#if ($is_destructor_needed) -static void ${prefix}_${record_name}_destroy(void *data) -{ - if (data) { - ${prefix}_${record_name}_t *record = (${prefix}_${record_name}_t *)data; - -#foreach ($field in $schema.getFields()) -#set ($field_name = $StyleUtils.toLowerUnderScore($field.name())) -#set ($field_schema = $field.schema()) -#if ($TypeConverter.isAvroRecord($field_schema) || $TypeConverter.isAvroUnion($field_schema)) - if (record->${field_name} && record->${field_name}->destroy) { - record->${field_name}->destroy(record->${field_name}); - } -#elseif ($TypeConverter.isAvroBytes($field_schema)) - kaa_bytes_destroy(record->${field_name}); -#elseif ($TypeConverter.isAvroFixed($field_schema)) - kaa_fixed_destroy(record->${field_name}); -#elseif ($TypeConverter.isAvroString($field_schema)) - kaa_string_destroy(record->${field_name}); -#elseif ($TypeConverter.isAvroArray($field_schema)) -#set ($array_element_schema = $field_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - #if ($TypeConverter.isRecordNeedDeallocator($array_element_schema)) - #set ($array_record_name = $StyleUtils.toLowerUnderScore($array_element_schema.getName())) - kaa_list_destroy(record->${field_name}, ${prefix}_${array_record_name}_destroy); - #else - kaa_list_destroy(record->${field_name}, kaa_data_destroy); - #end - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - #set ($array_union_name = $TypeConverter.generateUnionName($PREFIX, $array_element_schema).toLowerCase()) - kaa_list_destroy(record->${field_name}, ${array_union_name}_destroy); - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - kaa_list_destroy(record->${field_name}, kaa_bytes_destroy); - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - kaa_list_destroy(record->${field_name}, kaa_fixed_destroy); - #elseif ($TypeConverter.isAvroString($array_element_schema)) - kaa_list_destroy(record->${field_name}, kaa_string_destroy); - #elseif ($TypeConverter.isAvroPrimitive($array_element_schema)) - kaa_list_destroy(record->${field_name}, kaa_data_destroy); - #end -#end -#end - kaa_data_destroy(record); - } -} -#end - -#if ($TypeConverter.isTypeOut($schema)) -#if ($schema.getFields().size() > 0) -static void ${prefix}_${record_name}_serialize(avro_writer_t writer, void *data) -{ - if (data) { - ${prefix}_${record_name}_t *record = (${prefix}_${record_name}_t *)data; - -#foreach ($field in $schema.getFields()) -#set ($field_name = $StyleUtils.toLowerUnderScore($field.name())) -#set ($field_schema = $field.schema()) -#if ($TypeConverter.isAvroRecord($field_schema) && $field_schema.getFields().size() > 0) - record->${field_name}->serialize(writer, record->${field_name}); -#elseif ($TypeConverter.isAvroUnion($field_schema)) - record->${field_name}->serialize(writer, record->${field_name}); -#elseif ($TypeConverter.isAvroBytes($field_schema)) - kaa_bytes_serialize(writer, record->${field_name}); -#elseif ($TypeConverter.isAvroFixed($field_schema)) - kaa_fixed_serialize(writer, record->${field_name}); -#elseif ($TypeConverter.isAvroString($field_schema)) - kaa_string_serialize(writer, record->${field_name}); -#elseif ($TypeConverter.isAvroPrimitive($field_schema)) -#set ($primitive_type = $field_schema.getType().toString().toLowerCase()) - kaa_${primitive_type}_serialize(writer, &record->${field_name}); -#elseif ($TypeConverter.isAvroArray($field_schema)) -#set ($array_element_schema = $field_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - #if ($array_element_schema.getFields().size() > 0) - #set ($record_element_name = $StyleUtils.toLowerUnderScore($array_element_schema.getName())) - kaa_array_serialize(writer, record->${field_name}, ${prefix}_${record_element_name}_serialize); - #else - kaa_array_serialize(writer, record->${field_name}, NULL); - #end - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - #set ($union_element_name = $TypeConverter.generateUnionName($PREFIX, $array_element_schema).toLowerCase()) - kaa_array_serialize(writer, record->${field_name}, ${union_element_name}_serialize); - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - kaa_array_serialize(writer, record->${field_name}, kaa_bytes_serialize); - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - kaa_array_serialize(writer, record->${field_name}, kaa_fixed_serialize); - #elseif ($TypeConverter.isAvroString($array_element_schema)) - kaa_array_serialize(writer, record->${field_name}, kaa_string_serialize); - #elseif ($TypeConverter.isAvroPrimitive($array_element_schema)) - #set ($primitive_type = $array_element_schema.getType().toString().toLowerCase()) - kaa_array_serialize(writer, record->${field_name}, kaa_${primitive_type}_serialize); - #end -#end -#end - } -} - -static size_t ${prefix}_${record_name}_get_size(void *data) -{ - if (data) { - size_t record_size = 0; - ${prefix}_${record_name}_t *record = (${prefix}_${record_name}_t *)data; - -#foreach ($field in $schema.getFields()) -#set ($field_name = $StyleUtils.toLowerUnderScore($field.name())) -#set ($field_schema = $field.schema()) -#if ($TypeConverter.isAvroRecord($field_schema) && $field_schema.getFields().size() > 0) - record_size += record->${field_name}->get_size(record->${field_name}); -#elseif ($TypeConverter.isAvroUnion($field_schema)) - record_size += record->${field_name}->get_size(record->${field_name}); -#elseif ($TypeConverter.isAvroBytes($field_schema)) - record_size += kaa_bytes_get_size(record->${field_name}); -#elseif ($TypeConverter.isAvroFixed($field_schema)) - record_size += kaa_fixed_get_size(record->${field_name}); -#elseif ($TypeConverter.isAvroString($field_schema)) - record_size += kaa_string_get_size(record->${field_name}); -#elseif ($TypeConverter.isAvroFloat($field_schema)) - record_size += AVRO_FLOAT_SIZE; -#elseif ($TypeConverter.isAvroDouble($field_schema)) - record_size += AVRO_DOUBLE_SIZE; -#elseif ($TypeConverter.isAvroPrimitive($field_schema)) -#set ($primitive_type = $field_schema.getType().toString().toLowerCase()) - record_size += kaa_${primitive_type}_get_size(&record->${field_name}); -#elseif ($TypeConverter.isAvroArray($field_schema)) -#set ($array_element_schema = $field_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - #if ($array_element_schema.getFields().size() > 0) - #set ($array_record_name = $StyleUtils.toLowerUnderScore($array_element_schema.getName())) - record_size += kaa_array_get_size(record->${field_name}, ${prefix}_${array_record_name}_get_size); - #else - record_size += kaa_array_get_size(record->${field_name}, kaa_null_get_size); - #end - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - #set ($array_union_name = $TypeConverter.generateUnionName($PREFIX, $array_element_schema).toLowerCase()) - record_size += kaa_array_get_size(record->${field_name}, ${array_union_name}_get_size); - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - record_size += kaa_array_get_size(record->${field_name}, kaa_bytes_get_size); - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - record_size += kaa_array_get_size(record->${field_name}, kaa_fixed_get_size); - #elseif ($TypeConverter.isAvroString($array_element_schema)) - record_size += kaa_array_get_size(record->${field_name}, kaa_string_get_size); - #elseif ($TypeConverter.isAvroPrimitive($array_element_schema)) - #set ($primitive_type = $array_element_schema.getType().toString().toLowerCase()) - record_size += kaa_array_get_size(record->${field_name}, kaa_${primitive_type}_get_size); - #end -#end -#end - - return record_size; - } - - return 0; -} -#end - -${prefix}_${record_name}_t *${prefix}_${record_name}_create(void) -{ - ${prefix}_${record_name}_t *record = - (${prefix}_${record_name}_t *)KAA_CALLOC(1, sizeof(${prefix}_${record_name}_t)); - - if (record) { -#if ($schema.getFields().size() > 0) - record->serialize = ${prefix}_${record_name}_serialize; - record->get_size = ${prefix}_${record_name}_get_size; -#else - record->serialize = kaa_null_serialize; - record->get_size = kaa_null_get_size; -#end -#if ($is_destructor_needed) - record->destroy = ${prefix}_${record_name}_destroy; -#else - record->destroy = kaa_data_destroy; -#end - } - - return record; -} -#end -#if ($TypeConverter.isTypeIn($schema)) - -${prefix}_${record_name}_t *${prefix}_${record_name}_deserialize(avro_reader_t reader) -{ - ${prefix}_${record_name}_t *record = - (${prefix}_${record_name}_t *)KAA_MALLOC(sizeof(${prefix}_${record_name}_t)); - - if (record) { -#if ($TypeConverter.isTypeOut($schema)) -#if ($schema.getFields().size() > 0) - record->serialize = ${prefix}_${record_name}_serialize; - record->get_size = ${prefix}_${record_name}_get_size; -#else - record->serialize = kaa_null_serialize; - record->get_size = kaa_null_get_size; -#end -#end -#if ($is_destructor_needed) - record->destroy = ${prefix}_${record_name}_destroy; -#else - record->destroy = kaa_data_destroy; -#end - -#foreach ($field in $schema.getFields()) -#set ($field_name = $StyleUtils.toLowerUnderScore($field.name())) -#set ($field_schema = $field.schema()) -#if ($TypeConverter.isAvroRecord($field_schema)) -#set ($record_field_name = $StyleUtils.toLowerUnderScore($field_schema.getName())) - record->$field_name = ${prefix}_${record_field_name}_deserialize(reader); -#elseif ($TypeConverter.isAvroUnion($field_schema)) -#set ($union_field_name = $TypeConverter.generateUnionName($PREFIX, $field_schema).toLowerCase()) - record->$field_name = ${union_field_name}_deserialize(reader); -#elseif ($TypeConverter.isAvroBytes($field_schema)) - record->${field_name} = kaa_bytes_deserialize(reader); -#elseif ($TypeConverter.isAvroFixed($field_schema)) - size_t ${field_name}_fixed_size = $field_schema.getFixedSize(); - record->${field_name} = kaa_fixed_deserialize(reader, &${field_name}_fixed_size); -#elseif ($TypeConverter.isAvroString($field_schema)) - record->${field_name} = kaa_string_deserialize(reader); -#elseif ($TypeConverter.isAvroEnum($field_schema)) - int64_t ${field_name}_value; - avro_binary_encoding.read_long(reader, &${field_name}_value); - record->$field_name = ${field_name}_value; -#elseif ($TypeConverter.isAvroPrimitive($field_schema)) -#set ($primitive_type = $field_schema.getType().toString().toLowerCase()) - avro_binary_encoding.read_${primitive_type}(reader, &record->${field_name}); -#elseif ($TypeConverter.isAvroArray($field_schema)) -#set ($array_element_schema = $field_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - #set ($record_element_name = $StyleUtils.toLowerUnderScore($array_element_schema.getName())) - record->${field_name} = kaa_array_deserialize_wo_ctx(reader, (deserialize_wo_ctx_fn)${prefix}_${record_element_name}_deserialize); - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - #set ($union_element_name = $TypeConverter.generateUnionName($PREFIX, $array_element_schema).toLowerCase()) - record->${field_name} = kaa_array_deserialize_wo_ctx(reader, (deserialize_wo_ctx_fn)${union_element_name}_deserialize); - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - record->${field_name} = kaa_array_deserialize_wo_ctx(reader, (deserialize_wo_ctx_fn)kaa_bytes_deserialize); - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - size_t ${field_name}_fixed_size = $array_element_schema.getFixedSize(); - record->${field_name} = kaa_array_deserialize_w_ctx(reader, (deserialize_w_ctx_fn)kaa_fixed_deserialize, &${field_name}_fixed_size); - #elseif ($TypeConverter.isAvroString($array_element_schema)) - record->${field_name} = kaa_array_deserialize_wo_ctx(reader, (deserialize_wo_ctx_fn)kaa_string_deserialize); - #elseif ($TypeConverter.isAvroPrimitive($array_element_schema)) - #set ($primitive_type = $array_element_schema.getType().toString().toLowerCase()) - record->${field_name} = kaa_array_deserialize_wo_ctx(reader, (deserialize_wo_ctx_fn)kaa_${primitive_type}_deserialize); - #end -#end -#end - } - - return record; -} -#end - diff --git a/avrogen/src/main/resources/record.h.vm b/avrogen/src/main/resources/record.h.vm deleted file mode 100644 index fc9e8c97bd..0000000000 --- a/avrogen/src/main/resources/record.h.vm +++ /dev/null @@ -1,39 +0,0 @@ -#* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - *# - -#set ($prefix = $StyleUtils.toLowerUnderScore($namespacePrefix)) -#set ($record_name = $StyleUtils.toLowerUnderScore($schema.getName())) -typedef struct { -#foreach ($field in $schema.getFields()) -#set ($field_type = $TypeConverter.convertToCType($prefix, $field.schema())) -#set ($field_name = $StyleUtils.toLowerUnderScore($field.name())) - ${field_type} ${field_name}; -#end - -#if ($TypeConverter.isTypeOut($schema)) - serialize_fn serialize; - get_size_fn get_size; -#end - destroy_fn destroy; -} ${prefix}_${record_name}_t; - -#if ($TypeConverter.isTypeOut($schema)) -${prefix}_${record_name}_t *${prefix}_${record_name}_create(void); -#end -#if ($TypeConverter.isTypeIn($schema)) -${prefix}_${record_name}_t *${prefix}_${record_name}_deserialize(avro_reader_t reader); -#end - diff --git a/avrogen/src/main/resources/source.tmpl b/avrogen/src/main/resources/source.tmpl deleted file mode 100644 index 5435d978e3..0000000000 --- a/avrogen/src/main/resources/source.tmpl +++ /dev/null @@ -1,28 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -# include -# include -# include "platform/stdio.h" -# include "${headerName}.h" -# include "avro_src/avro/io.h" -# include "avro_src/encoding.h" -# include "utilities/kaa_mem.h" - -/* - * AUTO-GENERATED CODE - */ - diff --git a/avrogen/src/main/resources/union.c.vm b/avrogen/src/main/resources/union.c.vm deleted file mode 100644 index bd3e787f89..0000000000 --- a/avrogen/src/main/resources/union.c.vm +++ /dev/null @@ -1,319 +0,0 @@ -#* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - *# - -#set ($PREFIX = $StyleUtils.toUpperUnderScore($namespacePrefix)) -#set ($prefix = $StyleUtils.toLowerUnderScore($namespacePrefix)) -#set ($UNION_NAME = $TypeConverter.generateUnionName($PREFIX, $schema)) -#set ($union_name = $UNION_NAME.toLowerCase()) -# ifndef ${UNION_NAME}_C_ -# define ${UNION_NAME}_C_ -static void ${union_name}_destroy(void *data) -{ - if (data) { - kaa_union_t *kaa_union = (kaa_union_t *)data; - - switch (kaa_union->type) { -#set ($branch_number = 0) -#foreach ($branch_schema in $schema.getTypes()) -#if (!$TypeConverter.isAvroNull($branch_schema)) - case ${UNION_NAME}_BRANCH_${branch_number}: - { - if (kaa_union->data) { -#if ($TypeConverter.isAvroRecord($branch_schema)) -#set ($sub_record_name = $StyleUtils.toLowerUnderScore($branch_schema.getName())) - ${prefix}_${sub_record_name}_t *record = (${prefix}_${sub_record_name}_t *)kaa_union->data; - record->destroy(record); -#elseif ($TypeConverter.isAvroUnion($branch_schema)) -#set ($sub_union_name = $TypeConverter.generateUnionName($branch_schema).toLowerCase()) - ${prefix}_${sub_union_name}_t *kaa_sub_union = (${prefix}_${sub_union_name}_t *)kaa_union->data; - kaa_sub_union->destroy(kaa_sub_union); -#elseif ($TypeConverter.isAvroBytes($branch_schema)) - kaa_bytes_destroy(kaa_union->data); -#elseif ($TypeConverter.isAvroFixed($branch_schema)) - kaa_fixed_destroy(kaa_union->data); -#elseif ($TypeConverter.isAvroString($branch_schema)) - kaa_string_destroy(kaa_union->data); -#elseif ($TypeConverter.isAvroPrimitive($branch_schema)) - kaa_data_destroy(kaa_union->data); -#elseif ($TypeConverter.isAvroArray($branch_schema)) -#set ($array_element_schema = $branch_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - #if ($TypeConverter.isRecordNeedDeallocator($array_element_schema)) - #set ($array_record_name = $StyleUtils.toLowerUnderScore($array_element_schema.getName())) - kaa_list_destroy(kaa_union->data, ${prefix}_${array_record_name}_destroy); - #else - kaa_list_destroy(kaa_union->data, kaa_data_destroy); - #end - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - #set ($array_union_name = $TypeConverter.generateUnionName($PREFIX, $array_element_schema).toLowerCase()) - kaa_list_destroy(kaa_union->data, ${array_union_name}_destroy); - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - kaa_list_destroy(kaa_union->data, kaa_bytes_destroy); - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - kaa_list_destroy(kaa_union->data, kaa_fixed_destroy); - #elseif ($TypeConverter.isAvroString($array_element_schema)) - kaa_list_destroy(kaa_union->data, kaa_string_destroy); - #elseif ($TypeConverter.isAvroPrimitive($array_element_schema)) - kaa_list_destroy(kaa_union->data, kaa_data_destroy); - #end -#end - } - break; - } -#end -#set ($branch_number = $branch_number + 1) -#end - default: - break; - } - - kaa_data_destroy(kaa_union); - } -} -#if ($generationContext.isTypeOut()) - -static size_t ${union_name}_get_size(void *data) -{ - if (data) { - kaa_union_t *kaa_union = (kaa_union_t *)data; - size_t union_size = avro_long_get_size(kaa_union->type); - - switch (kaa_union->type) { -#set ($branch_number = 0) -#foreach ($branch_schema in $schema.getTypes()) -#if (!$TypeConverter.isAvroNull($branch_schema) && !($TypeConverter.isAvroRecord($branch_schema) && $branch_schema.getFields().size() == 0)) - case ${UNION_NAME}_BRANCH_${branch_number}: - { - if (kaa_union->data) { -#if ($TypeConverter.isAvroRecord($branch_schema)) -#set ($record_type = $TypeConverter.convertToCType($prefix, $branch_schema)) - $record_type record = (${record_type})kaa_union->data; - union_size += record->get_size(record); -#elseif ($TypeConverter.isAvroUnion($branch_schema)) - kaa_union_t *kaa_union = (kaa_union_t *)kaa_union->data; - union_size += kaa_union->get_size(kaa_union); -#elseif ($TypeConverter.isAvroBytes($branch_schema)) - union_size += kaa_bytes_get_size(kaa_union->data); -#elseif ($TypeConverter.isAvroFixed($branch_schema)) - union_size += kaa_fixed_get_size(kaa_union->data); -#elseif ($TypeConverter.isAvroString($branch_schema)) - union_size += kaa_string_get_size(kaa_union->data); -#elseif ($TypeConverter.isAvroFloat($branch_schema)) - union_size += AVRO_FLOAT_SIZE; -#elseif ($TypeConverter.isAvroDouble($branch_schema)) - union_size += AVRO_DOUBLE_SIZE; -#elseif ($TypeConverter.isAvroPrimitive($branch_schema)) -#set ($primitive_type = $branch_schema.getType().toString().toLowerCase()) - union_size += kaa_${primitive_type}_get_size(kaa_union->data); -#elseif ($TypeConverter.isAvroArray($branch_schema)) -#set ($array_element_schema = $branch_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - #if ($array_element_schema.getFields().size() > 0) - #set ($array_record_name = $StyleUtils.toLowerUnderScore($array_element_schema.getName())) - union_size += kaa_array_get_size(kaa_union->data, ${prefix}_${array_record_name}_get_size); - #else - union_size += kaa_array_get_size(kaa_union->data, kaa_null_get_size); - #end - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - #set ($array_union_name = $TypeConverter.generateUnionName($PREFIX, $array_element_schema).toLowerCase()) - union_size += kaa_array_get_size(kaa_union->data, ${array_union_name}_get_size); - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - union_size += kaa_array_get_size(kaa_union->data, kaa_bytes_get_size); - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - union_size += kaa_array_get_size(kaa_union->data, kaa_fixed_get_size); - #elseif ($TypeConverter.isAvroString($array_element_schema)) - union_size += kaa_array_get_size(kaa_union->data, kaa_string_get_size); - #elseif ($TypeConverter.isAvroPrimitive($array_element_schema)) - #set ($primitive_type = $array_element_schema.getType().toString().toLowerCase()) - union_size += kaa_array_get_size(kaa_union->data, kaa_${primitive_type}_get_size); - #end -#end - } - break; - } -#end -#set ($branch_number = $branch_number + 1) -#end - default: - break; - } - - return union_size; - } - - return 0; -} - -static void ${union_name}_serialize(avro_writer_t writer, void *data) -{ - if (data) { - kaa_union_t *kaa_union = (kaa_union_t *)data; - avro_binary_encoding.write_long(writer, kaa_union->type); - - switch (kaa_union->type) { -#set ($branch_number = 0) -#foreach ($branch_schema in $schema.getTypes()) -#if (!$TypeConverter.isAvroNull($branch_schema) && !($TypeConverter.isAvroRecord($branch_schema) && $branch_schema.getFields().size() == 0)) - case ${UNION_NAME}_BRANCH_${branch_number}: - { - if (kaa_union->data) { -#if ($TypeConverter.isAvroRecord($branch_schema)) -#set ($record_type = $TypeConverter.convertToCType($prefix, $branch_schema)) - $record_type record = (${record_type})kaa_union->data; - record->serialize(writer, record); -#elseif ($TypeConverter.isAvroUnion($branch_schema)) - kaa_union_t *kaa_union = (kaa_union_t *)kaa_union->data; - kaa_union->serialize(writer, kaa_union); -#elseif ($TypeConverter.isAvroBytes($branch_schema)) - kaa_bytes_serialize(writer, kaa_union->data); -#elseif ($TypeConverter.isAvroFixed($branch_schema)) - kaa_fixed_serialize(writer, kaa_union->data); -#elseif ($TypeConverter.isAvroString($branch_schema)) - kaa_string_serialize(writer, kaa_union->data); -#elseif ($TypeConverter.isAvroPrimitive($branch_schema)) -#set ($primitive_type = $branch_schema.getType().toString().toLowerCase()) - kaa_${primitive_type}_serialize(writer, kaa_union->data); -#elseif ($TypeConverter.isAvroArray($branch_schema)) -#set ($array_element_schema = $branch_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - #if ($array_element_schema.getFields().size() > 0) - #set ($record_element_name = $StyleUtils.toLowerUnderScore($array_element_schema.getName())) - kaa_array_serialize(writer, kaa_union->data, ${prefix}_${record_element_name}_serialize); - #else - kaa_array_serialize(writer, kaa_union->data, NULL); - #end - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - #set ($union_element_name = $TypeConverter.generateUnionName($PREFIX, $array_element_schema).toLowerCase()) - kaa_array_serialize(writer, kaa_union->data, ${union_element_name}_serialize); - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - kaa_array_serialize(writer, kaa_union->data, kaa_bytes_serialize); - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - kaa_array_serialize(writer, kaa_union->data, kaa_fixed_serialize); - #elseif ($TypeConverter.isAvroString($array_element_schema)) - kaa_array_serialize(writer, kaa_union->data, kaa_string_serialize); - #elseif ($TypeConverter.isAvroPrimitive($array_element_schema)) - #set ($primitive_type = $array_element_schema.getType().toString().toLowerCase()) - kaa_array_serialize(writer, kaa_union->data, kaa_${primitive_type}_serialize); - #end -#end - } - break; - } -#end -#set ($branch_number = $branch_number + 1) -#end - default: - break; - } - } -} -#end -static kaa_union_t *${union_name}_create(void) -{ - kaa_union_t *kaa_union = KAA_CALLOC(1, sizeof(kaa_union_t)); - - if (kaa_union) { -#if ($generationContext.isTypeOut()) - kaa_union->serialize = ${union_name}_serialize; - kaa_union->get_size = ${union_name}_get_size; -#end - kaa_union->destroy = ${union_name}_destroy; - } - - return kaa_union; -} -#if ($generationContext.isTypeOut()) -#set ($branch_number = 0) -#foreach ($branch_schema in $schema.getTypes()) - -kaa_union_t *${union_name}_branch_${branch_number}_create(void) -{ - kaa_union_t *kaa_union = ${union_name}_create(); - if (kaa_union) { - kaa_union->type = ${UNION_NAME}_BRANCH_${branch_number}; - } - return kaa_union; -} -#set ($branch_number = $branch_number + 1) -#end -#end -#if ($generationContext.isTypeIn()) - -kaa_union_t *${union_name}_deserialize(avro_reader_t reader) -{ - kaa_union_t *kaa_union = ${union_name}_create(); - - if (kaa_union) { - int64_t branch; - avro_binary_encoding.read_long(reader, &branch); - kaa_union->type = branch; - - switch (kaa_union->type) { -#set ($branch_number = 0) -#foreach ($branch_schema in $schema.getTypes()) -#if (!$TypeConverter.isAvroNull($branch_schema)) - case ${UNION_NAME}_BRANCH_${branch_number}: { -#if ($TypeConverter.isAvroRecord($branch_schema)) -#set ($sub_record_name = $StyleUtils.toLowerUnderScore($branch_schema.getName())) - kaa_union->data = ${prefix}_${sub_record_name}_deserialize(reader); -#elseif ($TypeConverter.isAvroUnion($branch_schema)) -#set ($sub_union_name = $TypeConverter.generateUnionName($PREFIX, $branch_schema).toLowerCase()) - kaa_union->data = ${sub_union_name}_deserialize(reader); -#elseif ($TypeConverter.isAvroBytes($branch_schema)) - kaa_union->data = kaa_bytes_deserialize(reader); -#elseif ($TypeConverter.isAvroFixed($branch_schema)) - size_t fixed_size = $branch_schema.getFixedSize(); - kaa_union->data = kaa_fixed_deserialize(reader, &fixed_size); -#elseif ($TypeConverter.isAvroString($branch_schema)) - kaa_union->data = kaa_string_deserialize(reader); -#elseif ($TypeConverter.isAvroPrimitive($branch_schema)) -#set ($primitive_type = $branch_schema.getType().toString().toLowerCase()) - kaa_union->data = kaa_${primitive_type}_deserialize(reader); -#elseif ($TypeConverter.isAvroArray($branch_schema)) -#set ($array_element_schema = $branch_schema.getElementType()) - #if ($TypeConverter.isAvroRecord($array_element_schema)) - #set ($record_element_name = $StyleUtils.toLowerUnderScore($array_element_schema.getName())) - kaa_union->data = kaa_array_deserialize_wo_ctx(reader, (deserialize_wo_ctx_fn)${prefix}_${record_element_name}_deserialize); - #elseif ($TypeConverter.isAvroUnion($array_element_schema)) - #set ($union_element_name = $TypeConverter.generateUnionName($PREFIX, $array_element_schema).toLowerCase()) - kaa_union->data = kaa_array_deserialize_wo_ctx(reader, (deserialize_wo_ctx_fn)${union_element_name}_deserialize); - #elseif ($TypeConverter.isAvroBytes($array_element_schema)) - kaa_union->data = kaa_array_deserialize_wo_ctx(reader, (deserialize_wo_ctx_fn)kaa_bytes_deserialize); - #elseif ($TypeConverter.isAvroFixed($array_element_schema)) - size_t fixed_size = $array_element_schema.getFixedSize(); - kaa_union->data = kaa_array_deserialize_wo_ctx_w_ctx(reader, (deserialize_w_ctx_fn)kaa_fixed_deserialize, &fixed_size); - #elseif ($TypeConverter.isAvroString($array_element_schema)) - kaa_union->data = kaa_array_deserialize_wo_ctx(reader, (deserialize_wo_ctx_fn)kaa_string_deserialize); - #elseif ($TypeConverter.isAvroPrimitive($array_element_schema)) - #set ($primitive_type = $array_element_schema.getType().toString().toLowerCase()) - kaa_union->data = kaa_array_deserialize_wo_ctx(reader, (deserialize_wo_ctx_fn)kaa_${primitive_type}_deserialize); - #end -#end - break; - } -#end -#set ($branch_number = $branch_number + 1) -#end - default: - break; - } - } - - return kaa_union; -} -#end -# endif // ${UNION_NAME}_C_ - diff --git a/avrogen/src/main/resources/union.h.vm b/avrogen/src/main/resources/union.h.vm deleted file mode 100644 index b9880376df..0000000000 --- a/avrogen/src/main/resources/union.h.vm +++ /dev/null @@ -1,43 +0,0 @@ -#* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - *# - -#set ($PREFIX = $StyleUtils.toUpperUnderScore($namespacePrefix)) -#set ($prefix = $StyleUtils.toLowerUnderScore($namespacePrefix)) -#set ($UNION_NAME = $TypeConverter.generateUnionName($PREFIX, $schema)) -#set ($union_name = $UNION_NAME.toLowerCase()) -#set ($branch_number = 0) -# ifndef ${UNION_NAME}_H_ -# define ${UNION_NAME}_H_ - -#foreach ($branch_schema in $schema.getTypes()) -# define ${UNION_NAME}_BRANCH_${branch_number} ${branch_number} -#set ($branch_number = $branch_number + 1) -#end - -#set ($branch_number = 0) -#if ($generationContext.isTypeOut()) -#foreach ($branch_schema in $schema.getTypes()) -kaa_union_t *${union_name}_branch_${branch_number}_create(void); -#set ($branch_number = $branch_number + 1) -#end - -#end -#if ($generationContext.isTypeIn()) -kaa_union_t *${union_name}_deserialize(avro_reader_t reader); - -#end -# endif // ${UNION_NAME}_H_ - diff --git a/avrogen/src/test/java/org/kaaproject/kaa/avro/avrogen/StyleUtilsTest.java b/avrogen/src/test/java/org/kaaproject/kaa/avro/avrogen/StyleUtilsTest.java deleted file mode 100644 index 96afbfe56b..0000000000 --- a/avrogen/src/test/java/org/kaaproject/kaa/avro/avrogen/StyleUtilsTest.java +++ /dev/null @@ -1,47 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.kaaproject.kaa.avro.avrogen; - -import org.junit.Assert; -import org.junit.Test; - - -public class StyleUtilsTest { - @Test - public void testToLowerUnderScore() { - String pattern1 = "endpoint_key_hash"; - Assert.assertTrue(StyleUtils.toLowerUnderScore("endpointKeyHash").equals(pattern1)); - - String pattern2 = "event_class_fqn"; - Assert.assertTrue(StyleUtils.toLowerUnderScore("eventClassFQN").equals(pattern2)); - } - - @Test - public void testToUpperUnderScore() { - String pattern1 = "ENDPOINT_KEY_HASH"; - Assert.assertTrue(StyleUtils.toUpperUnderScore("endpointKeyHash").equals(pattern1)); - - String pattern2 = "EVENT_CLASS_FQN"; - Assert.assertTrue(StyleUtils.toUpperUnderScore("eventClassFQN").equals(pattern2)); - } - - @Test - public void testRemovePackageName() { - String longName = "org.kaaproject.kaa.common.endpoint.gen"; - Assert.assertTrue(StyleUtils.removePackageName(longName).equals("gen")); - } -} diff --git a/avrogen/src/test/java/org/kaaproject/kaa/avro/avrogen/TypeConverterTest.java b/avrogen/src/test/java/org/kaaproject/kaa/avro/avrogen/TypeConverterTest.java deleted file mode 100644 index f5fad9ae6c..0000000000 --- a/avrogen/src/test/java/org/kaaproject/kaa/avro/avrogen/TypeConverterTest.java +++ /dev/null @@ -1,97 +0,0 @@ -/* - * Copyright 2014-2016 CyberVision, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.kaaproject.kaa.avro.avrogen; - -import org.apache.avro.Schema; -import org.apache.avro.Schema.Type; -import org.junit.Assert; -import org.junit.Test; - -import java.util.Arrays; - -public class TypeConverterTest { - @Test - public void testTypes() { - Assert.assertTrue(TypeConverter.isAvroBytes(Schema.create(Type.BYTES))); - Assert.assertFalse(TypeConverter.isAvroBytes(Schema.create(Type.STRING))); - - Assert.assertTrue(TypeConverter.isAvroArray(Schema.createArray(Schema.create(Type.BYTES)))); - Assert.assertFalse(TypeConverter.isAvroArray(Schema.create(Type.BYTES))); - - Assert.assertTrue(TypeConverter.isAvroString(Schema.create(Type.STRING))); - Assert.assertFalse(TypeConverter.isAvroString(Schema.create(Type.BOOLEAN))); - - Assert.assertTrue(TypeConverter.isAvroEnum(Schema.createEnum("name", "doc", "namespace", Arrays.asList("node")))); - Assert.assertFalse(TypeConverter.isAvroEnum(Schema.create(Type.BOOLEAN))); - - Assert.assertTrue(TypeConverter.isAvroNull(Schema.create(Type.NULL))); - Assert.assertFalse(TypeConverter.isAvroNull(Schema.create(Type.BOOLEAN))); - - Assert.assertTrue(TypeConverter.isAvroPrimitive(Schema.create(Type.BOOLEAN))); - Assert.assertTrue(TypeConverter.isAvroPrimitive(Schema.create(Type.INT))); - Assert.assertTrue(TypeConverter.isAvroPrimitive(Schema.create(Type.LONG))); - Assert.assertTrue(TypeConverter.isAvroPrimitive(Schema.createEnum("name", "doc", "namespace", Arrays.asList("node")))); - Assert.assertFalse(TypeConverter.isAvroPrimitive(Schema.create(Type.STRING))); - Assert.assertFalse(TypeConverter.isAvroPrimitive(Schema.create(Type.BYTES))); - - Assert.assertTrue(TypeConverter.isAvroUnion(Schema.createUnion( - Arrays.asList(Schema.create(Type.BYTES), Schema.create(Type.STRING))))); - Assert.assertFalse(TypeConverter.isAvroUnion(Schema.create(Type.STRING))); - - Assert.assertTrue(TypeConverter.isAvroRecord(Schema.createRecord("name", "doc", "namespace", false))); - Assert.assertFalse(TypeConverter.isAvroRecord(Schema.create(Type.STRING))); - - Assert.assertTrue(TypeConverter.isAvroUnion(Schema.createUnion( - Arrays.asList(Schema.create(Type.BYTES), Schema.create(Type.STRING))))); - Assert.assertFalse(TypeConverter.isAvroUnion(Schema.create(Type.STRING))); - - Assert.assertTrue(TypeConverter.isAvroString(Schema.create(Type.STRING))); - Assert.assertFalse(TypeConverter.isAvroString(Schema.create(Type.INT))); - } - - @Test - public void testDirection() { - final String DIRECTION_FIELD = "direction"; - - Schema inOutSchema = Schema.createEnum("test1", "doc", "namespace", Arrays.asList("node")); - Assert.assertTrue(TypeConverter.isTypeOut(inOutSchema)); - Assert.assertTrue(TypeConverter.isTypeIn(inOutSchema)); - - Schema outSchema = Schema.createRecord("test2", "doc", "namespace", false); - outSchema.addProp(DIRECTION_FIELD, "out"); - - Assert.assertTrue(TypeConverter.isTypeOut(outSchema)); - Assert.assertFalse(TypeConverter.isTypeIn(outSchema)); - - Schema inSchema = Schema.createRecord("test13", "doc", "namespace", false); - inSchema.addProp(DIRECTION_FIELD, "in"); - - Assert.assertTrue(TypeConverter.isTypeIn(inSchema)); - Assert.assertFalse(TypeConverter.isTypeOut(inSchema)); - - Schema invalidDirectionSchema = Schema.createRecord("test4", "doc", "namespace", false); - invalidDirectionSchema.addProp(DIRECTION_FIELD, "inOut"); - - Assert.assertFalse(TypeConverter.isTypeIn(invalidDirectionSchema)); - Assert.assertFalse(TypeConverter.isTypeOut(invalidDirectionSchema)); - } - - @Test - public void testIsRecordNeedDeallocator() { - Assert.assertFalse(TypeConverter.isRecordNeedDeallocator(Schema.create(Type.INT))); - } -} diff --git a/checkstyle.xml b/checkstyle.xml deleted file mode 100644 index 27d214a0a7..0000000000 --- a/checkstyle.xml +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/client/client-multi/client-c/.gitignore b/client/client-multi/client-c/.gitignore deleted file mode 100644 index 42e6983b63..0000000000 --- a/client/client-multi/client-c/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -Makefile -.zshrc -sonar-project.properties -build-cc3200/ -build-clang/ -build-nologs/ -build-esp8266/ -build-posix/ -build-rpi/ diff --git a/client/client-multi/client-c/CMakeLists.txt b/client/client-multi/client-c/CMakeLists.txt deleted file mode 100644 index 4b136cfdc2..0000000000 --- a/client/client-multi/client-c/CMakeLists.txt +++ /dev/null @@ -1,311 +0,0 @@ -# -# Copyright 2014-2016 CyberVision, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -# List of avaliable configuration parameters: -# -# - `KAA_MAX_LOG_LEVEL` - Maximum log level used by C SDK. The higher value, the more detailed logs. -# -# Values: -# -# - `0` - NONE (no logs) -# - `1` - FATAL -# - `2` - ERROR -# - `3` - WARN -# - `4` - INFO -# - `5` - DEBUG -# - `6` - TRACE -# -# Default: If build type is `Release`, `KAA_MAX_LOG_LEVEL=4`. If `Debug`, `KAA_MAX_LOG_LEVEL=6`. -# -# - `WITH_EXTENSION_[EXTENSION_NAME]` - specifies which extensions should be included to build. -# -# Extensions' names: -# -# - PROFILE -# - CONFIGURATION -# - EVENT -# - LOGGING -# - NOTIFICATION -# - USER -# -# Values: -# -# - `ON` - enable extension -# - `OFF` - disable extension -# -# Default: `ON` - all extensions are included in the build. -# -# - `KAA_PLATFORM` - build SDK for a particular target. -# -# Values: -# -# - `cc32xx` -# - `esp8266` -# - `posix` -# -# Default: `posix` -# -# - `KAA_UNITETESTS_COMPILE` - compile unit tests. -# -# Values: -# -# - `ON` -# - `OFF` -# -# Default: `OFF` -# -# Note: requires [cmocka](https://cmocka.org/) test framework to be installed. - -cmake_minimum_required(VERSION 2.8.12) - -project(Kaa-c C) - -include(ExternalProject) - -option(WITH_EXTENSION_PROFILE "Enable profile extension" ON) -option(WITH_EXTENSION_CONFIGURATION "Enable configuration extension" ON) -option(WITH_EXTENSION_EVENT "Enable event extension" ON) -option(WITH_EXTENSION_LOGGING "Enable logging extension" ON) -option(WITH_EXTENSION_NOTIFICATION "Enable notification extension" ON) -option(WITH_EXTENSION_USER "Enable user extension" ON) -option(WITH_ENCRYPTION "Enable encryption" ON) -option(KAA_RUNTIME_KEY_GENERATION "Enable RSA key generation at runtime" OFF) - -# Expose Kaa SDK directory to all modules -set(KAA_SDK_DIR ${CMAKE_CURRENT_LIST_DIR}) - -# Path to CMake's scripts. -set(CMAKE_MODULE_PATH - ${CMAKE_MODULE_PATH} - ${CMAKE_CURRENT_SOURCE_DIR}/Modules - ) - -# -# Sets common compilation flags. -# -# NOTE: Platform specific compilation flags should be set -# in the corresponding platform CMake script(s). -set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=c99 -Wall -Wextra -pedantic -D_GNU_SOURCE") - -set(CMAKE_C_FLAGS_MINSIZEREL "${CMAKE_C_FLAGS_MINSIZEREL} -Os") - -# Compiler specific flags. -if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang" AND APPLE) - set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -undefined dynamic_lookup") -endif () - -if (CMAKE_COMPILER_IS_GNUCC) - set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -O0 -ggdb") - - if (KAA_COLLECT_COVERAGE) - set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} --coverage") - endif () -endif () - -# Creates variable to specify thirdparty libraries. -set(KAA_THIRDPARTY_LIBRARIES "") - -# Sets the default build platform to POSIX. -if (NOT DEFINED KAA_PLATFORM) - set(KAA_PLATFORM "posix") -endif () - -# -# Sets maximum Kaa SDK log level. -# -# Logging constants: -# NONE - 0 -# FATAL - 1 -# ERROR - 2 -# WARN - 3 -# INFO - 4 -# DEBUG - 5 -# TRACE - 6 -if (NOT DEFINED KAA_MAX_LOG_LEVEL) - if ("${CMAKE_BUILD_TYPE}" STREQUAL "Debug") - set(KAA_MAX_LOG_LEVEL 6) - else () - set(KAA_MAX_LOG_LEVEL 4) - endif () -endif () - -set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DKAA_MAX_LOG_LEVEL=${KAA_MAX_LOG_LEVEL}") - -message("==================================") -# Prints build parameters. -if("${CMAKE_BUILD_TYPE}" STREQUAL "") - message("BUILD_TYPE = (Default)") -else() - message("BUILD_TYPE = ${CMAKE_BUILD_TYPE}") -endif() -message("KAA_PLATFORM = ${KAA_PLATFORM}") -message("KAA_MAX_LOG_LEVEL = ${KAA_MAX_LOG_LEVEL}") -message("==================================") - -# Sets path(s) to header files. -set(KAA_SRC_FOLDER "${CMAKE_CURRENT_LIST_DIR}/src/kaa") - -#include platform-depended CMakeLists.txt -include(${CMAKE_CURRENT_LIST_DIR}/listfiles/platform/${KAA_PLATFORM}/CMakeLists.txt) - -# Sets path(s) to source files. -set(KAA_SOURCE_FILES - ${KAA_SOURCE_FILES} - ${KAA_SRC_FOLDER}/avro_src/io.c - ${KAA_SRC_FOLDER}/avro_src/encoding_binary.c - ${KAA_SRC_FOLDER}/collections/kaa_list.c - ${KAA_SRC_FOLDER}/utilities/kaa_aes_rsa.c - ${KAA_SRC_FOLDER}/utilities/kaa_log.c - ${KAA_SRC_FOLDER}/utilities/kaa_mem.c - ${KAA_SRC_FOLDER}/utilities/kaa_buffer.c - ${KAA_SRC_FOLDER}/kaa_platform_utils.c - ${KAA_SRC_FOLDER}/kaa_platform_protocol.c - ${KAA_SRC_FOLDER}/kaa_channel_manager.c - ${KAA_SRC_FOLDER}/kaa_common_schema.c - ${KAA_SRC_FOLDER}/kaa_status.c - ${KAA_SRC_FOLDER}/kaa.c - ${KAA_SRC_FOLDER}/kaa_extension.c - ${KAA_SRC_FOLDER}/platform-impl/common/kaa_htonll.c -) - -if(WITH_ENCRYPTION) - set(KAA_SOURCE_FILES - ${KAA_SOURCE_FILES} - ${KAA_SRC_FOLDER}/utilities/kaa_aes_rsa.c - ${KAA_SRC_FOLDER}/platform-impl/common/encryption_utils.c) -endif(WITH_ENCRYPTION) - - -# Includes auto-generated Cmake's scripts. -include(${CMAKE_CURRENT_LIST_DIR}/listfiles/CMakeGen.cmake) - -# Kaa include directories -set(KAA_INCLUDE_DIRS - ${KAA_INCLUDE_PATHS} - ${CMAKE_CURRENT_LIST_DIR}/src - ${CMAKE_CURRENT_LIST_DIR}/thirdparty/mbedtls - ${CMAKE_CURRENT_LIST_DIR}/tools/kaa_encryption/rsa_key_gen/include - ${KAA_SRC_FOLDER} - ${KAA_THIRDPARTY_INCLUDE_DIR}) - -# Build unit tests. -include(${CMAKE_CURRENT_LIST_DIR}/listfiles/UnitTest.cmake) - -include_directories(SYSTEM ${KAA_INCLUDE_PATHS}) - -# This already includes mbedtls -add_subdirectory(tools/kaa_encryption/rsa_key_gen) - -# Build Kaa libraries. -add_library(kaac ${KAA_SOURCE_FILES}) -target_include_directories(kaac PUBLIC ${KAA_INCLUDE_DIRS}) -target_link_libraries(kaac PRIVATE ${KAA_THIRDPARTY_LIBRARIES}) - -message("BOOTSTRAP ENABLED") -include(${CMAKE_CURRENT_LIST_DIR}/src/extensions/bootstrap/CMakeLists.txt) -target_link_libraries(kaac PUBLIC extension_bootstrap) - -if(WITH_EXTENSION_PROFILE) - message("PROFILE ENABLED") - - include(${CMAKE_CURRENT_LIST_DIR}/src/extensions/profile/CMakeLists.txt) - target_link_libraries(kaac PUBLIC extension_profile) -else() - add_definitions(-DKAA_DISABLE_FEATURE_PROFILE) -endif() - -if(WITH_EXTENSION_USER) - message("USER EXTENSION ENABLED") - - include(${CMAKE_CURRENT_LIST_DIR}/src/extensions/user/CMakeLists.txt) - target_link_libraries(kaac PUBLIC extension_user) -else() - add_definitions(-DKAA_DISABLE_FEATURE_USER) -endif() - -if(WITH_EXTENSION_CONFIGURATION) - message("CONFIGURATION ENABLED") - - include(${CMAKE_CURRENT_LIST_DIR}/src/extensions/configuration/CMakeLists.txt) - target_link_libraries(kaac PUBLIC extension_configuration) -else() - add_definitions(-DKAA_DISABLE_FEATURE_CONFIGURATION) -endif() - -if(WITH_EXTENSION_EVENT) - message("EVENTS ENABLED") - - include(${CMAKE_CURRENT_LIST_DIR}/src/extensions/event/CMakeLists.txt) - target_link_libraries(kaac PUBLIC extension_event) -else() - add_definitions(-DKAA_DISABLE_FEATURE_EVENTS) -endif() - -if(WITH_EXTENSION_LOGGING) - message("LOGGING ENABLED") - - include(${CMAKE_CURRENT_LIST_DIR}/src/extensions/logging/CMakeLists.txt) - target_link_libraries(kaac PUBLIC extension_logging) -else() - add_definitions(-DKAA_DISABLE_FEATURE_LOGGING) -endif() - -if(WITH_EXTENSION_NOTIFICATION) - message("NOTIFICATION ENABLED") - - include(${CMAKE_CURRENT_LIST_DIR}/src/extensions/notification/CMakeLists.txt) - target_link_libraries(kaac PUBLIC extension_notification) -else() - add_definitions(-DKAA_DISABLE_FEATURE_NOTIFICATION) -endif() - -if(WITH_ENCRYPTION) - message("ENCRYPTION ENABLED") - target_link_libraries(kaac PUBLIC rsa_keygen) - add_definitions(-DKAA_ENCRYPTION) -endif() - -message("KAA WILL BE INSTALLED TO ${CMAKE_INSTALL_PREFIX}") -install(DIRECTORY ${KAA_SRC_FOLDER}/ DESTINATION include/kaa - FILES_MATCHING PATTERN *.h) - -install(TARGETS kaac DESTINATION lib) - -add_subdirectory(Modules/doxygen) - -add_subdirectory(Modules/cppcheck) - -#Set key pair generation parameter for posix platform -#Use application for another platform -if(KAA_RUNTIME_KEY_GENERATION) - if(KAA_PLATFORM STREQUAL "posix") - add_definitions(-DKAA_RUNTIME_KEY_GENERATION) - target_link_libraries(kaac PUBLIC rsa_keygen) - else() - message(FATAL_ERROR "The runtime key generation option may be enabled only for POSIX platform") - endif() - target_link_libraries(kaac PUBLIC rsa_keygen) -else() - add_dependencies(kaac kaa_rsa_keygen) - externalproject_add(kaa_rsa_keygen SOURCE_DIR "${CMAKE_CURRENT_LIST_DIR}/tools/kaa_encryption" - INSTALL_COMMAND "./generate_rsa_keys" COMMENT "Generating RSA headers" - CMAKE_ARGS -DKAA_SDK_DIR=${KAA_SDK_DIR} - BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/kaa_keys) - - externalproject_add_step(kaa_rsa_keygen "Copying generated files" - COMMAND mv -f "${CMAKE_CURRENT_BINARY_DIR}/kaa_keys/kaa_keys_gen.h" - "${KAA_SRC_FOLDER}/gen" DEPENDEES install) -endif() diff --git a/client/client-multi/client-c/Doxyfile b/client/client-multi/client-c/Doxyfile deleted file mode 100644 index e623ee14e8..0000000000 --- a/client/client-multi/client-c/Doxyfile +++ /dev/null @@ -1,2408 +0,0 @@ -# Doxyfile 1.8.11 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = "Kaa client C SDK" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = target/apidocs/doxygen - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = YES - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = - -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = YES - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: -# Fortran. In the later case the parser tries to guess whether the code is fixed -# or free formatted code, this is the default for Fortran type files), VHDL. For -# instance to make doxygen treat .inc files as Fortran files (default is PHP), -# and .f files as C (default is Fortran), use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = NO - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = YES - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO, these declarations will be -# included in the documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = YES - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES, upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = YES - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = YES - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = NO - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. -# The default value is: NO. - -WARN_AS_ERROR = YES - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. - -INPUT = src/ - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, -# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. - -FILE_PATTERNS = *.h \ - *.dox - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = src/kaa/gen/ \ - src/avro_src/ - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = . - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = README - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the master .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /