├── .babelrc
├── .codeclimate.yml
├── .editorconfig
├── .eslintrc
├── .gitignore
├── .npmignore
├── .travis.yml
├── CHANGELOG.md
├── Gruntfile.js
├── LICENSE
├── README.md
├── build
├── helper
│ ├── _grunt
│ │ ├── clean.js
│ │ ├── comments.js
│ │ ├── copy.js
│ │ ├── eslint.js
│ │ ├── jsdoc.js
│ │ ├── strip_code.js
│ │ ├── uglify.js
│ │ ├── usebanner.js
│ │ └── webpack.js
│ ├── config.js
│ └── jsdoc.json
├── karma.es6.config.js
├── karma.jquery.config.js
├── webpack.config.dev.js
├── webpack.config.js
└── webpack.config.prod.js
├── dist
├── device.selector.class.js
├── jquery.device.selector.js
├── jquery.device.selector.min.js
├── js.device.selector.min.js
└── js.device.selector.min.js.map
├── docs
├── index.html
├── jsdoc
│ ├── DeviceSelector.html
│ ├── device.selector.class.js.html
│ ├── external-_jQuery.fn.deviceSelector_.html
│ ├── external-_jQuery.fn_.html
│ ├── fonts
│ │ ├── OpenSans-Bold-webfont.eot
│ │ ├── OpenSans-Bold-webfont.svg
│ │ ├── OpenSans-Bold-webfont.woff
│ │ ├── OpenSans-BoldItalic-webfont.eot
│ │ ├── OpenSans-BoldItalic-webfont.svg
│ │ ├── OpenSans-BoldItalic-webfont.woff
│ │ ├── OpenSans-Italic-webfont.eot
│ │ ├── OpenSans-Italic-webfont.svg
│ │ ├── OpenSans-Italic-webfont.woff
│ │ ├── OpenSans-Light-webfont.eot
│ │ ├── OpenSans-Light-webfont.svg
│ │ ├── OpenSans-Light-webfont.woff
│ │ ├── OpenSans-LightItalic-webfont.eot
│ │ ├── OpenSans-LightItalic-webfont.svg
│ │ ├── OpenSans-LightItalic-webfont.woff
│ │ ├── OpenSans-Regular-webfont.eot
│ │ ├── OpenSans-Regular-webfont.svg
│ │ └── OpenSans-Regular-webfont.woff
│ ├── index.html
│ ├── jquery.device.selector.js.html
│ ├── scripts
│ │ ├── linenumber.js
│ │ └── prettify
│ │ │ ├── Apache-License-2.0.txt
│ │ │ ├── lang-css.js
│ │ │ └── prettify.js
│ └── styles
│ │ ├── jsdoc-default.css
│ │ ├── prettify-jsdoc.css
│ │ └── prettify-tomorrow.css
└── static
│ ├── css
│ └── style.css
│ ├── img
│ └── .placeholder
│ └── js
│ ├── jquery
│ └── dist
│ │ └── jquery.min.js
│ └── js.device.selector
│ └── jquery.device.selector.min.js
├── example
├── server.js
├── static
│ ├── css
│ │ └── style.css
│ └── img
│ │ └── .placeholder
└── views
│ ├── index.html
│ └── layout.html
├── package-lock.json
├── package.json
├── src
├── index.html
├── index.jquery.html
├── index.jquery.min.test.html
├── index.jquery.test.html
├── index.js
├── index.test.html
└── js
│ ├── device.selector.class.js
│ ├── device.selector.class.test.js
│ ├── jquery.device.selector.js
│ └── jquery.device.selector.test.js
└── tests
├── casper
├── casper.helper.js
└── init.js
└── screenshots
├── desktop.png
├── largedesktop.png
├── mobile.png
└── tablet.png
/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "presets": [
3 | ["env", {
4 | "modules": false,
5 | "targets": {
6 | "browsers": ["> 1%", "last 2 versions", "not ie <= 8"]
7 | }
8 | }],
9 | "stage-2"
10 | ],
11 | "env": {
12 | "test": {
13 | "presets": ["env", "stage-2"],
14 | }
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/.codeclimate.yml:
--------------------------------------------------------------------------------
1 | exclude_patterns:
2 | - "tests/"
3 | - "build/"
4 | - "coverage/"
5 | - "dist/"
6 | - "docs/"
7 | - "tests/"
8 | - "example/"
9 | - "node_modules/"
10 | - "."
11 | - "Gruntfile.js"
12 | - "jsdoc.json"
13 | - "*.md"
14 | - "karma.*"
15 | - "LICENSE"
16 | - "package*"
17 | - "webpack.*"
18 | eslint:
19 | enabled: true
20 | config:
21 | config: .eslintrc
22 |
--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | root = true
2 |
3 | [*]
4 | indent_style = space
5 | indent_size = 2
6 | end_of_line = lf
7 | charset = utf-8
8 | trim_trailing_whitespace = true
9 | insert_final_newline = true
10 |
11 | [*.{json,yml}]
12 | indent_size = 2
13 |
14 | [*.md]
15 | trim_trailing_whitespace = false
16 |
--------------------------------------------------------------------------------
/.eslintrc:
--------------------------------------------------------------------------------
1 | {
2 | "extends": ["eslint:recommended", "google"],
3 | "env": {
4 | "es6": true,
5 | "jasmine": true,
6 | "jquery": true,
7 | "qunit": true,
8 | "node": true,
9 | "browser": true
10 | },
11 | "parserOptions": {
12 | "sourceType": "module",
13 | }
14 | }
15 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .idea
2 | .sass-cache/
3 | node_modules/
4 | bower_components/
5 | coverage/
6 | !docs/coverage/**
7 | TODO.md
8 | Thumbs.db
9 | .DS_Store
10 | *.psd
11 | *.sketch
12 | *.lock
13 | *.iml
14 |
15 | # directories
16 | Source/
17 |
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | build/
2 | example/
3 | node_modules/
4 | static/
5 | target/
6 | tests/
7 | coverage/
8 | .git
9 | .babelrc
10 | .editorconfig
11 | .eslintrc
12 | .gitignore
13 | .travis.yml
14 | .codeclimate.yml
15 | .npmrc
16 | .npmignore
17 | Gruntfile.js
18 | package-lock.json
19 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | env:
2 | global:
3 | - CC_TEST_REPORTER_ID=c6b6d69b3dd1760344f6072d2a115027c284a49d706f2e5195818094ea6895ad
4 | language: node_js
5 | node_js:
6 | - "10"
7 | - "12"
8 | - "14"
9 | before_script:
10 | - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
11 | - chmod +x ./cc-test-reporter
12 | - ./cc-test-reporter before-build
13 | script:
14 | - npm test
15 | after_script:
16 | - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
17 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Change Log
2 |
3 | ## 1.0.1
4 | * refactor es6 module
5 | * refactor build, tests and coverage
6 |
7 | ## 1.0.0
8 | ### Feature
9 | * jQuery Device Selector Plugin
10 | * get current device type (breakpoint)
11 | * get current display type (retina e.g.)
12 | * defaults and custom settings
13 | * es6 Device Selector Class
14 | * get current device type (breakpoint)
15 | * get current display type (retina e.g.)
16 | * defaults and custom settings
17 |
--------------------------------------------------------------------------------
/Gruntfile.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Gruntfile.js
3 | */
4 |
5 | 'use strict';
6 | let config = require('./build/helper/config');
7 | config.options.pkg = require('./package.json');
8 |
9 | module.exports = function(grunt) {
10 | // load only used tasks and add fallbacks for those which cannot be find
11 | require('jit-grunt')(grunt, {
12 | 'replace': 'grunt-text-replace',
13 | 'usebanner': 'grunt-banner',
14 | 'comments': 'grunt-stripcomments',
15 | 'strip_code': 'grunt-strip-code',
16 | });
17 | // measures the time each task takes
18 | require('time-grunt')(grunt);
19 |
20 | // Load grunt configurations automatically
21 | let configs = require('load-grunt-configs')(grunt, config.options);
22 |
23 | // Define the configuration for all the tasks
24 | grunt.initConfig(configs);
25 |
26 | /*
27 | * TASKS
28 | */
29 |
30 | grunt.registerTask('coverage', [
31 | 'copy:coverageEs6',
32 | 'copy:icovEs6',
33 | 'copy:coverageJquery',
34 | 'copy:icovJquery',
35 | ]);
36 |
37 | grunt.registerTask('build', [
38 | 'eslint',
39 | 'webpack',
40 | 'uglify',
41 | ]);
42 |
43 | grunt.registerTask('dist', [
44 | 'clean',
45 | 'build',
46 | 'copy:dist',
47 | 'strip_code',
48 | 'comments',
49 | 'usebanner',
50 | 'jsdoc',
51 | 'copy:static',
52 | ]);
53 |
54 | grunt.registerTask('default', ['dist']);
55 | };
56 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2018 Simon Gattner
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [![tests][tests]][tests-url]
2 | [![coverage][coverage]][coverage-url]
3 | [![maintainability][maintainability]][maintainability-url]
4 |
5 | # js.device.selector
6 | ES6 class and jQuery Plugin which get the current Device Type and Display Type of a Browser while making CSS Breakpoints available in JavaScript.
7 |
8 | This solution make it possible to define your breakpoints only once (in CSS) and pass them automatically into JavaScript.
9 |
10 | ## npm
11 | [![npm][npm]][npm-url]
12 | ```
13 | npm install --save js.device.selector
14 | ```
15 |
16 | ## Example
17 |
18 | ### jQuery plugin
19 |
20 | Style for hidden Markup that make CSS Breakpoints available in JavaScript via Media-Queries and visibility.
21 |
22 | ```html
23 |
64 | ```
65 |
66 | Markup which make the visibility of Breakpoints available in JavaScript. The Markup should be added right before the closing body tag.
67 |
68 | ```html
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 | ```
77 |
78 | Initialise the jQuery Plugin and sample usage.
79 | ```html
80 |
81 |
82 |
88 | ```
89 |
90 | ### jQuery Plugin Custom
91 |
92 | Use your own flavored Markup and pass your own settings to the Device Selector.
93 |
94 | ```html
95 |
136 |
137 |
138 |
139 |
140 |
141 |
142 |
143 |
144 |
145 |
171 | ```
172 |
173 | ### ES6 class
174 |
175 | Style for hidden Markup that make CSS Breakpoints available in JavaScript via Media-Queries and visibility.
176 |
177 | ```html
178 |
219 | ```
220 |
221 | Markup which make the visibility of Breakpoints available in JavaScript. The Markup should be added right before the closing body tag.
222 |
223 | ```html
224 |
225 |
226 |
227 |
228 |
229 |
230 |
231 | ```
232 |
233 | Import the ES6 Class and sample usage.
234 |
235 | ```js
236 | import DeviceSelector from './js/device.selector.class';
237 | const deviceSelector = new DeviceSelector();
238 |
239 | console.log($.fn.deviceSelector.getDeviceType()); // return m || t || md || lg
240 | document.querySelector('#deviceType').innerHTML = deviceSelector.deviceType();
241 | document.querySelector('#displayType').innerHTML = deviceSelector.displayType();
242 |
243 | ```
244 |
245 | ### ES6 Class Custom
246 |
247 | ```html
248 |
289 |
/**
30 | * @fileOverview device selector
31 | Get the current Display and Device Type of a Browser
32 | * @author Simon Gattner <npm@0x38.de>
33 | * @license MIT
34 | * @version 1.0.1
35 | */
36 |
37 | /**
38 | * @external "jQuery.fn"
39 | * @see {@link http://docs.jquery.com/Plugins/Authoring The jQuery Plugin Guide}
40 | */
41 |
42 | (function($) {
43 | 'use strict';
44 | /* eslint-disable max-len */
45 | /**
46 | * jQuery Methods to get the current Display and Device Type of a Browser
47 | * @function external:"jQuery.fn".deviceSelector
48 | * @external "jQuery.fn"
49 | * @external "jQuery.fn.deviceSelector"
50 | * @param {object} options The DeviceSelector options.
51 | * @param {string} options.selector The DeviceSelector selector options.
52 | * @param {string} options.selector.name The DeviceSelector selector name for initialisation.
53 | * @param {string} options.selector.items The DeviceSelector selector items for initialisation.
54 | * @param {string} options.selector.items.name The DeviceSelector selector items name for initialisation.
55 | * @param {string} options.selector.parent The DeviceSelector selector parent for initialisation.
56 | * @param {string} options.selector.parent.name The DeviceSelector selector parent name for initialisation.
57 | * @param {string} options.device The DeviceSelector device type options.
58 | * @param {string} options.device.selector The DeviceSelector device type selector for initialisation.
59 | * @param {string} options.device.selector.name The DeviceSelector device type selector name for initialisation.
60 | * @param {string} options.display The DeviceSelector display type options.
61 | * @param {string} options.display.selector The DeviceSelector display type selector for initialisation.
62 | * @param {string} options.display.selector.name The DeviceSelector display type selector name for initialisation.
63 | */
64 | /* eslint-enable max-len */
65 | $.fn.deviceSelector = function(options) {
66 | $.fn.deviceSelector._deviceType = undefined;
67 | $.fn.deviceSelector._displayType = undefined;
68 |
69 | var _settings = // eslint-disable-line no-var
70 | $.extend(true, $.fn.deviceSelector.defaults, options);
71 |
72 | var _parent = // eslint-disable-line no-var
73 | (this.length > 0) ? this :
74 | $(_settings.selector.parent.name);
75 |
76 | // console.log(parent.find(_settings.selector.item.name))
77 |
78 | $.each(_parent, function() {
79 | var _this = $(this); // eslint-disable-line no-var, no-invalid-this
80 | var selector = // eslint-disable-line no-var
81 | _this.find(_settings.selector.name);
82 | var visibleSelectorItems = // eslint-disable-line no-var
83 | selector.find(_settings.selector.items.name + ':visible');
84 |
85 | $.each(visibleSelectorItems, function() {
86 | var _this = $(this); // eslint-disable-line no-var, no-invalid-this
87 | if (_this.attr(_settings.device.selector.name)) {
88 | $.fn.deviceSelector._deviceType = '' +
89 | _this.attr(_settings.device.selector.name);
90 | }
91 | if (_this.attr(_settings.display.selector.name)) {
92 | $.fn.deviceSelector._displayType = ''
93 | + _this.attr(_settings.display.selector.name);
94 | }
95 | });
96 | });
97 | };
98 |
99 | /**
100 | * Method to get current Device Type.
101 | * @function external:"jQuery.fn.deviceSelector".getDeviceType
102 | * @return {string} The current Device Type.
103 | */
104 |
105 | $.fn.deviceSelector.getDeviceType = function() {
106 | return $.fn.deviceSelector._deviceType;
107 | };
108 |
109 | /**
110 | * Method to get current Display Type.
111 | * @function external:"jQuery.fn.deviceSelector".getDisplayType
112 | * @return {string} The current Display Type.
113 | */
114 |
115 | $.fn.deviceSelector.getDisplayType = function() {
116 | return $.fn.deviceSelector._displayType;
117 | };
118 |
119 | $.fn.deviceSelector.defaults = {}; // eslint-disable-line no-var
120 | $.extend(
121 | $.fn.deviceSelector.defaults,
122 | {
123 | 'selector': {
124 | 'name': '[data-device-selector]',
125 | 'parent': {
126 | 'name': 'body',
127 | },
128 | 'items': {
129 | 'name': '[data-device-selector-item]',
130 | },
131 | },
132 | 'device': {
133 | 'selector': {
134 | 'name': 'data-device-selector-devicetype',
135 | },
136 | },
137 | 'display': {
138 | 'selector': {
139 | 'name': 'data-device-selector-displaytype',
140 | },
141 | },
142 | }
143 | );
144 | }(jQuery));
145 |
146 |
147 |
148 |
149 |
150 |
151 |
152 |
153 |
154 |
157 |
158 |
159 |
160 |
163 |
164 |
165 |
166 |
167 |
168 |
--------------------------------------------------------------------------------
/docs/jsdoc/scripts/linenumber.js:
--------------------------------------------------------------------------------
1 | /*global document */
2 | (() => {
3 | const source = document.getElementsByClassName('prettyprint source linenums');
4 | let i = 0;
5 | let lineNumber = 0;
6 | let lineId;
7 | let lines;
8 | let totalLines;
9 | let anchorHash;
10 |
11 | if (source && source[0]) {
12 | anchorHash = document.location.hash.substring(1);
13 | lines = source[0].getElementsByTagName('li');
14 | totalLines = lines.length;
15 |
16 | for (; i < totalLines; i++) {
17 | lineNumber++;
18 | lineId = `line${lineNumber}`;
19 | lines[i].id = lineId;
20 | if (lineId === anchorHash) {
21 | lines[i].className += ' selected';
22 | }
23 | }
24 | }
25 | })();
26 |
--------------------------------------------------------------------------------
/docs/jsdoc/scripts/prettify/Apache-License-2.0.txt:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
178 |
179 | APPENDIX: How to apply the Apache License to your work.
180 |
181 | To apply the Apache License to your work, attach the following
182 | boilerplate notice, with the fields enclosed by brackets "[]"
183 | replaced with your own identifying information. (Don't include
184 | the brackets!) The text should be enclosed in the appropriate
185 | comment syntax for the file format. We also recommend that a
186 | file or class name and description of purpose be included on the
187 | same "printed page" as the copyright notice for easier
188 | identification within third-party archives.
189 |
190 | Copyright [yyyy] [name of copyright owner]
191 |
192 | Licensed under the Apache License, Version 2.0 (the "License");
193 | you may not use this file except in compliance with the License.
194 | You may obtain a copy of the License at
195 |
196 | http://www.apache.org/licenses/LICENSE-2.0
197 |
198 | Unless required by applicable law or agreed to in writing, software
199 | distributed under the License is distributed on an "AS IS" BASIS,
200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 | See the License for the specific language governing permissions and
202 | limitations under the License.
203 |
--------------------------------------------------------------------------------
/docs/jsdoc/scripts/prettify/lang-css.js:
--------------------------------------------------------------------------------
1 | PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n"]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com",
2 | /^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]);
3 |
--------------------------------------------------------------------------------
/docs/jsdoc/scripts/prettify/prettify.js:
--------------------------------------------------------------------------------
1 | var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
2 | (function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
3 | [],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
9 | l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
10 | q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
11 | q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
12 | "");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
13 | a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
14 | for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
18 | "catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
19 | H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
20 | J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
21 | I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]+/],["dec",/^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^
112 |
113 | ' | escape }}
120 |
121 |
122 |
123 |
124 |
125 |