Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
@arobenko
arobenko committed Nov 15, 2018
1 parent 5d4e8b8 commit 512fbed
Show file tree
Hide file tree
Showing 4 changed files with 354 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ option (COMMSDSL_VALGRIND_TESTS "Enable testing with valgrind" OFF)

# Additional variables to be used if needed
# ---------------------------
# COMMSDSL_QT_DIR - Path to Qt5 installation directory.
# COMMSDSL_QT_DIR - Path to Qt5 installation directory, needed to build generated testing projects.
# COMMS_INSTALL_DIR - Path to externally built and installed CommsChampion project
# COMMSDSL_TESTS_CXX_STANDARD - C++ standard to use in unittests

Expand Down
203 changes: 203 additions & 0 deletions LICENSE.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@

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.

150 changes: 149 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,150 @@
This is personal research project, not for general use.
# Overview
This project is a member of [CommsChampion](https://github.com/arobenko/comms_champion)
ecosystem. It provides a code generator that produces C++11 code of a binary communication protocol,
defined using [CommsDSL](https://github.com/arobenko/CommsDSL-Specification)
schema files.

# What's Inside
- **commsdsl2comms** - A code generator, that produces C++11 code for binary
protocol definition out of [CommsDSL](https://github.com/arobenko/CommsDSL-Specification)
schema files. The generated outcome is actually a CMake project that defines
a protocol using [COMMS library](https://github.com/arobenko/comms_champion#comms-library)
and C++11 programming language, as well as implements a protocol plugin for
the [CommsChampion Tools](https://github.com/arobenko/comms_champion#commschampion-tools).
For details on how to use the tool, please read the
[commsdsl2comms Manual](https://github.com/arobenko/commsdsl/wiki/commsdsl2comms-Manual) wiki page.
- **libcommsdsl** - A C++11 library for parsing of
[CommsDSL](https://github.com/arobenko/CommsDSL-Specification) schema files.
It can be used to implement independent code generators, which can produce
protocol definition code in other programming languages, bindings to the C++
classes generated by the **commsdsl2comms**, fuzzing testing, etc...
NOTE, that at this moment, the library is not documented. Please
[get in touch](#contact-information) in case you need it. I'll let you know
when it's going to be ready.

# License
Code generated by **commsdsl2comms** has no license, the vendor is free to
pick one. <span style="color:red">**HOWEVER**</span>, the generated code
uses [COMMS library](https://github.com/arobenko/comms_champion#comms-library),
which is provided under **GPLv3 / Commercial** dual licensing scheme. Unless
commercial closed source license is obtained for the
[COMMS library](https://github.com/arobenko/comms_champion#comms-library), the
generated code must remain open source and the picked license be compatible
with **GPLv3**.

The code of this project (libraries and tools it contains)
is licensed under [Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0) license.

# Examples
There are multiple available examples of protocol definitions that use
[CommsDSL](https://github.com/arobenko/CommsDSL-Specification) schema files
and **commsdsl2comms** code generator to generate relevant code.

#### Synthetic Demo Protocols
- [cc.demo1.commsdsl](https://github.com/arobenko/cc.demo1.commsdsl) - Demo
protocol to demonstrate definition of various fields as well as simple protocol framing.
- [cc.demo2.commsdsl](https://github.com/arobenko/cc.demo2.commsdsl) - Demo
protocol to demonstrate protocol versioning, where every message reports protocol
version in its transport frame.
- [cc.demo3.commsdsl](https://github.com/arobenko/cc.demo3.commsdsl) - Demo
protocol to demonstrate protocol versioning, where one "connect" message reports protocol
version for all the subsequent messages.

#### Real Life Open Protocols
- [cc.mqtt311.commsdsl](https://github.com/arobenko/cc.mqtt311.commsdsl) -
Defines MQTT v3.1.1 protocol, where message ID shares
the same byte with extra flags, that may define existence of the fields in
message payload as well as influence how message needs to be processed. The protocol
definition also contains snippets of custom code that are injected by the
**commsdsl2comms** into the generated one.
- [cc.mqtt5.commsdsl](https://github.com/arobenko/cc.mqtt5.commsdsl) -
Defines MQTT v5 protocol. Similar to v3.1.1, but also adds a heterogeneous lists of
various properties.
- [cc.mqttsn.commsdsl](https://github.com/arobenko/cc.mqttsn.commsdsl) -
Defines MQTT-SN protocol, where field of remaining length of the message can
have either 1 or 3 bytes length, depending on the value it contains.
- [cc.ublox.commsdsl](https://github.com/arobenko/cc.ublox.commsdsl) -
Defines **UBX** protocol used by various
[u-blox GPS receivers](https://www.u-blox.com/en/position-time). The protocol
itself is quite complex with hundreds of messages.

# How to Use Generated Code
The **commsdsl2comms** generates CMake project, which contains
headers-only protocol definition library as well as code of protocol plugin
for [CommsChampion Tools](https://github.com/arobenko/comms_champion#commschampion-tools).
Please open root CMakeLists.txt file and see available build options.
The generated project also defines `doc_<protocol_name>` target which can be
used to build doxygen documentation of the protocol definition. The
`<protocol_name` portion of the build target is name of the protocol specified
in schema definition file(s).
```
$> make doc_demo1
```
**NOTE**, that the generated protocol code is mostly declarative statements
of classes and types definitions. It is self explanatory and easy to read.
In many cases it is easier to read and understand the generated code, than the
doxygen generated documentation. Please spend some time on browsing around
and looking at the generated code in addition to reading the generated documentation.

The generated code adheres to the implementation guidelines from the
[COMMS library](https://github.com/arobenko/comms_champion#comms-library)'s
documentation. Please read **"How to Use Defined Custom Protocol"** page from
it for detailed explanation on how to use and/or compile-time configure the
generated classes.

In case the generated code is incorrect or incomplete, please also read through
the **"How to Define New Custom Protocol"** page of
[COMMS library](https://github.com/arobenko/comms_champion#comms-library)'s
documentation to understand how to implement missing portions. Also follow
the guidelines from [commsdsl2comms Manual](https://github.com/arobenko/commsdsl/wiki/commsdsl2comms-Manual)
on how to inject such custom code into the generated one.

# Versioning
This project will use [Semantic Versioning](https://semver.org/), where
**MAJOR** number will be equal to the latest **DSL** version
(The first number of [CommsDSL](https://github.com/arobenko/CommsDSL-Specification)
version) it supports. The **MINOR** number will indicate various improvements
in the code of this repository, and **PATCH** number will indicate various bug fixes.

# How to Build
This project uses CMake as its build system. Please open main
[CMakeLists.txt](CMakeLists.txt) file and review available options as well as
mentioned available parameters, which can be used in addition to standard
ones provided by CMake itself, to modify the default build.

**NOTE**, that **libcommsdsl** uses [libxml2](http://xmlsoft.org)
to parse XML schema files, and **commsdsl2comms** uses [Boost](https://www.boost.org)
to parse its command line parameters (_Boost::program_options_),
perform filesystem operations (_Boost::filesystem_), and various string manipulation
algorithms. In case Boost libraries are not installed in expected default location
(mostly happens on Windows systems), use variables described in
[CMake documentation](https://cmake.org/cmake/help/v3.8/module/FindBoost.html)
to help the latter find required libraries and headers.
It is recommended to use `-DBoost_USE_STATIC_LIBS=ON` parameter to force
linkage with static Boost libraries.
Also on Windows systems there is no need to build [libxml2](http://xmlsoft.org)
separately. The build process will check it out automatically and build static
library itself. For example:

### Linux Build
```
$> cd /source/of/this/project
$> mkdir build && cd build
$> cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=$PWD/install -DCOMMSDSL_NO_TESTS=ON ..
$> make install
```
### Windows Build
```
$> cd C:\source\of\this\project
$> mkdir build && cd build
$> cmake -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=%cd%/install -DCOMMSDSL_NO_TESTS=ON \
-DBOOST_ROOT="C:\Libraries\boost_1_65_1" -DBoost_USE_STATIC_LIBS=ON ..
$> nmake install
```

# Contact Information
For bug reports, feature requests, or any other question you may open an issue
here in **github** or e-mail me directly to: **[email protected]**. I usually
respond within 24 hours.

Loading

0 comments on commit 512fbed

Please sign in to comment.