docs: cleanup: Rephrase and correct typos
[barectf.git] / barectf / __init__.py
1 # The MIT License (MIT)
2 #
3 # Copyright (c) 2014-2020 Philippe Proulx <pproulx@efficios.com>
4 #
5 # Permission is hereby granted, free of charge, to any person obtaining
6 # a copy of this software and associated documentation files (the
7 # "Software"), to deal in the Software without restriction, including
8 # without limitation the rights to use, copy, modify, merge, publish,
9 # distribute, sublicense, and/or sell copies of the Software, and to
10 # permit persons to whom the Software is furnished to do so, subject to
11 # the following conditions:
12 #
13 # The above copyright notice and this permission notice shall be
14 # included in all copies or substantial portions of the Software.
15 #
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20 # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23
24 import barectf.config_parse_common as barectf_config_parse_common
25 import barectf.version as barectf_version
26 import barectf.config as barectf_config
27 import barectf.config_file as barectf_config_file
28 import barectf.codegen as barectf_codegen
29 import barectf.typing as barectf_typing
30
31
32 # version API
33 __major_version__ = barectf_version.__major_version__
34 __minor_version__ = barectf_version.__minor_version__
35 __patch_version__ = barectf_version.__patch_version__
36 __pre_version__ = barectf_version.__pre_version__
37 __version__ = barectf_version.__version__
38
39
40 # common typing API
41 Index = barectf_typing.Index
42 Count = barectf_typing.Count
43 Id = barectf_typing.Id
44 Alignment = barectf_typing.Alignment
45 VersionNumber = barectf_typing.VersionNumber
46
47
48 # configuration API
49 _ArrayFieldType = barectf_config._ArrayFieldType
50 _BitArrayFieldType = barectf_config._BitArrayFieldType
51 _ConfigurationParseError = barectf_config_parse_common._ConfigurationParseError
52 _EnumerationFieldType = barectf_config._EnumerationFieldType
53 _FieldType = barectf_config._FieldType
54 _IntegerFieldType = barectf_config._IntegerFieldType
55 ByteOrder = barectf_config.ByteOrder
56 ClockType = barectf_config.ClockType
57 ClockTypeCTypes = barectf_config.ClockTypeCTypes
58 ClockTypeOffset = barectf_config.ClockTypeOffset
59 Configuration = barectf_config.Configuration
60 ConfigurationCodeGenerationHeaderOptions = barectf_config.ConfigurationCodeGenerationHeaderOptions
61 ConfigurationCodeGenerationOptions = barectf_config.ConfigurationCodeGenerationOptions
62 ConfigurationOptions = barectf_config.ConfigurationOptions
63 DEFAULT_FIELD_TYPE = barectf_config.DEFAULT_FIELD_TYPE
64 DisplayBase = barectf_config.DisplayBase
65 DynamicArrayFieldType = barectf_config.DynamicArrayFieldType
66 EnumerationFieldTypeMapping = barectf_config.EnumerationFieldTypeMapping
67 EnumerationFieldTypeMappingRange = barectf_config.EnumerationFieldTypeMappingRange
68 EnumerationFieldTypeMappings = barectf_config.EnumerationFieldTypeMappings
69 EventRecordType = barectf_config.EventRecordType
70 LogLevel = barectf_config.LogLevel
71 RealFieldType = barectf_config.RealFieldType
72 SignedEnumerationFieldType = barectf_config.SignedEnumerationFieldType
73 SignedIntegerFieldType = barectf_config.SignedIntegerFieldType
74 StaticArrayFieldType = barectf_config.StaticArrayFieldType
75 DataStreamType = barectf_config.DataStreamType
76 DataStreamTypeEventRecordFeatures = barectf_config.DataStreamTypeEventRecordFeatures
77 DataStreamTypeFeatures = barectf_config.DataStreamTypeFeatures
78 DataStreamTypePacketFeatures = barectf_config.DataStreamTypePacketFeatures
79 StringFieldType = barectf_config.StringFieldType
80 StructureFieldType = barectf_config.StructureFieldType
81 StructureFieldTypeMember = barectf_config.StructureFieldTypeMember
82 StructureFieldTypeMembers = barectf_config.StructureFieldTypeMembers
83 Trace = barectf_config.Trace
84 TraceEnvironment = barectf_config.TraceEnvironment
85 TraceType = barectf_config.TraceType
86 TraceTypeWithUnknownNativeByteOrder = barectf_config.TraceTypeWithUnknownNativeByteOrder
87 TraceTypeFeatures = barectf_config.TraceTypeFeatures
88 UnsignedEnumerationFieldType = barectf_config.UnsignedEnumerationFieldType
89 UnsignedIntegerFieldType = barectf_config.UnsignedIntegerFieldType
90
91
92 # configuration file API
93 configuration_file_major_version = barectf_config_file.configuration_file_major_version
94 configuration_from_file = barectf_config_file.configuration_from_file
95 effective_configuration_file = barectf_config_file.effective_configuration_file
96
97
98 # code generation API
99 CodeGenerator = barectf_codegen.CodeGenerator
100
101
102 # remove local names
103 del barectf_config_parse_common
104 del barectf_version
105 del barectf_config
106 del barectf_config_file
107 del barectf_codegen
108 del barectf_typing
This page took 0.033195 seconds and 4 git commands to generate.