Skip to content

Commit c9323fc

Browse files
arBmindarBmind
committed
first public release of SourceMap-Qt
0 parents  commit c9323fc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+3298
-0
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
bin/
2+
include/

‎CHANGES

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
Changes for 1.0.0 (released 2014-11-19):
3+
* Initial Open Source release
4+
* Extendable Design
5+
* Extensions Interpolation and Caller
6+
* Tests

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎NOTICE

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
SourceMap-Qt
2+
(C) Copyright 2014 HicknHack Software GmbH
3+
4+
The original code can be found at:
5+
https://github.com/hicknhack-software/SourceMap-Qt
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.

‎README.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
2+
# SourceMap-Qt
3+
4+
**C++11 implementation of SourceMaps for Qt versions 5.3.2 or later**
5+
6+
Source Maps became popular for Javascript and Stylesheets generator languages like CoffeeScript, LESS and SCSS/SASS.
7+
This implementations conforms to the proposal of Mozilla and Google.
8+
https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k/edit?pli=1#heading=h.1ce2c87bpj24
9+
10+
And the reference implementation of mozilla:
11+
https://github.com/mozilla/source-map/blob/master/test/source-map/test-base64.js
12+
13+
## Features
14+
15+
* fully C++ typed
16+
* loading & saving the common JSON format
17+
* searchable index to find mappings of generated source locations
18+
* extendable template component design
19+
* Interpolation extension (see below)
20+
* Caller extension (see below)
21+
22+
## Interpolation extension
23+
24+
Normal source maps can only reference source blocks.
25+
Sometimes the original and generated string are the same. For example embedded strings or code.
26+
The interpolation extensions marks these mappings as interpolatable.
27+
This allows for character accurate mapping where possible.
28+
29+
The main usecase is tool support. The user requests the origin of a position.
30+
With this extensiosn, we send him to the original file and the exact position.
31+
32+
The implementation of Interpolation is fully transparent.
33+
If you never define a mapping with interpolation, nothing is stored in the JSON output.
34+
35+
## Caller extension
36+
37+
Minifications have a one-to-one mapping from source to target.
38+
Meaning every "feature" of the source is represented by exactly one position in the target.
39+
When you source-map more templates like systems, you may include a position twice or call a function from anywhere.
40+
That's where the Caller Extension becomes useful.
41+
42+
Each Source Map entry may be annotated with a Caller and each Caller may have a caller as well, given a CallerStack.
43+
For each Caller a source location is stored.
44+
45+
The implementation of Caller is fully transparent.
46+
If you never define a mapping with a caller, nothing is stored in the JSON output.
47+
48+
## Requirements
49+
50+
* C++11 compiler
51+
** Tested with GCC 4.8.2 on MinGW
52+
** Tested with Visual Studio 2013 November CTP Compiler
53+
* Qt 5.3
54+
** Tested with the binary distributions of Qt 5.3.2 on Windows
55+
56+
## How to use?
57+
58+
@Entry@ is the structure defining a SourceMap-entry.
59+
If you create a SourceMap, you create a list of these.
60+
61+
The @Mapping@ class implements the indexing from file location (line, column) in the generated file to source file and location.
62+
63+
Finally @RevisionThree@ extends Qt's QJsonObject with tools to create and read JSON encoded source maps.
64+
65+
## Roadmap
66+
67+
* Implement the mapping from a source location to generated file location.
68+
* Implement the nested source map version
69+
70+
## License
71+
72+
Apache License Version 2.0
73+
See LICENSE file for more details
74+
75+
## Contribute
76+
77+
If you like this project give it a star.
78+
If you don't like it or found a bug, please write an issue.

‎SourceMap.pro

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# SourceMap-Qt
2+
# (C) Copyright 2014 HicknHack Software GmbH
3+
#
4+
# The original code can be found at:
5+
# https://github.com/hicknhack-software/SourceMap-Qt
6+
#
7+
# Licensed under the Apache License, Version 2.0 (the "License");
8+
# you may not use this file except in compliance with the License.
9+
# You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing, software
14+
# distributed under the License is distributed on an "AS IS" BASIS,
15+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
# See the License for the specific language governing permissions and
17+
# limitations under the License.
18+
19+
#
20+
# This is the main SourceMap-Qt project file for QMake & QtCreator
21+
#
22+
TEMPLATE = subdirs
23+
24+
SUBDIRS += src
25+
26+
!contains(CONFIG, NoTest) {
27+
text.depends = src
28+
SUBDIRS += test
29+
}
30+
31+
OTHER_FILES += \
32+
CHANGES \
33+
LICENSE \
34+
NOTICE \
35+
README.md

‎build/qmake/_app.pri

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# SourceMap-Qt
2+
# (C) Copyright 2014 HicknHack Software GmbH
3+
#
4+
# The original code can be found at:
5+
# https://github.com/hicknhack-software/SourceMap-Qt
6+
#
7+
# Licensed under the Apache License, Version 2.0 (the "License");
8+
# you may not use this file except in compliance with the License.
9+
# You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing, software
14+
# distributed under the License is distributed on an "AS IS" BASIS,
15+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
# See the License for the specific language governing permissions and
17+
# limitations under the License.
18+
TEMPLATE = app
19+
CONFIG += console
20+
21+
include(_common.pri)
22+
23+
# SourceMap {
24+
LIBS += -L$$LIB_PATH -lSourceMap
25+
DEPENDPATH += $$DESTDIR
26+
27+
win32:!win32-g++:CONFIG(release, debug|release): PRE_TARGETDEPS += $$LIB_PATH/SourceMap.lib
28+
else: PRE_TARGETDEPS += $$LIB_PATH/libSourceMap.a
29+
# }

0 commit comments

Comments
 (0)