├── .dockerignore ├── .github └── workflows │ └── publish.yaml ├── .gitignore ├── .idea ├── Sourcemod-HandleDumpParser.iml ├── jsLibraryMappings.xml ├── misc.xml ├── modules.xml ├── runConfigurations │ └── web_index_html.xml └── vcs.xml ├── CHANGELOG.md ├── Dockerfile.cli ├── Dockerfile.web ├── LICENSE ├── README.md ├── analysis_options.yaml ├── bin └── main.dart ├── docs ├── .build.manifest ├── index.html ├── main.dart.js ├── manifest.json └── packages │ ├── $sdk │ ├── _internal │ │ └── strong.sum │ └── dev_compiler │ │ ├── kernel │ │ ├── amd │ │ │ ├── dart_sdk.js │ │ │ └── require.js │ │ ├── common │ │ │ ├── dart_sdk.js │ │ │ └── run.js │ │ └── es6 │ │ │ └── dart_sdk.js │ │ └── web │ │ └── dart_stack_trace_mapper.js │ ├── _fe_analyzer_shared │ └── src │ │ └── parser │ │ └── parser.md │ ├── analyzer │ └── src │ │ └── summary │ │ └── format.fbs │ ├── build_runner │ └── src │ │ └── server │ │ ├── README.md │ │ ├── build_updates_client │ │ ├── hot_reload_client.dart.js │ │ └── live_reload_client.js │ │ ├── graph_viz.html │ │ ├── graph_viz.js │ │ └── graph_viz_main.dart.js │ ├── build_web_compilers │ └── src │ │ └── dev_compiler_stack_trace │ │ └── stack_trace_mapper.dart.js │ ├── effective_dart │ ├── analysis_options.1.0.0.yaml │ ├── analysis_options.1.1.0.yaml │ ├── analysis_options.1.2.0.yaml │ └── analysis_options.yaml │ └── pedantic │ ├── analysis_options.1.0.0.yaml │ ├── analysis_options.1.1.0.yaml │ ├── analysis_options.1.2.0.yaml │ ├── analysis_options.1.3.0.yaml │ ├── analysis_options.1.4.0.yaml │ ├── analysis_options.1.5.0.yaml │ ├── analysis_options.1.6.0.yaml │ ├── analysis_options.1.7.0.yaml │ ├── analysis_options.1.8.0.yaml │ ├── analysis_options.1.9.0.yaml │ └── analysis_options.yaml ├── entrypoint.sh ├── lib ├── handle_dump_parser.dart ├── sorting.dart └── web │ ├── dump_entry.dart │ ├── elements.dart │ ├── indexdb.dart │ ├── sorter.dart │ ├── theme_loader.dart │ └── wrapper.dart ├── pubspec.yaml └── web ├── index.html ├── main.dart └── manifest.json /.dockerignore: -------------------------------------------------------------------------------- 1 | .dockerignore 2 | Dockerfile 3 | build/ 4 | .dart_tool/ 5 | .git/ 6 | .github/ 7 | .gitignore 8 | .packages 9 | -------------------------------------------------------------------------------- /.github/workflows/publish.yaml: -------------------------------------------------------------------------------- 1 | name: Publish to GitHub Pages 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | - master 8 | pull_request: 9 | branches: 10 | - '*' 11 | 12 | jobs: 13 | deploy: 14 | runs-on: ubuntu-22.04 15 | permissions: 16 | contents: write 17 | concurrency: 18 | group: ${{ github.workflow }}-${{ github.ref }} 19 | steps: 20 | - uses: actions/checkout@v3 21 | 22 | - uses: dart-lang/setup-dart@v1 23 | with: 24 | sdk: 2.12.0 25 | 26 | - name: Install dependencies and build 27 | run: | 28 | export ENV PUB_CACHE=/tmp/pub-cache 29 | export PATH="${PATH}:/tmp/pub-cache/bin" 30 | dart pub global activate webdev 31 | dart pub get 32 | webdev build 33 | 34 | - name: Deploy 35 | uses: peaceiris/actions-gh-pages@v3 36 | if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master' }} 37 | with: 38 | github_token: ${{ secrets.GITHUB_TOKEN }} 39 | publish_dir: ./build 40 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Files and directories created by pub 2 | .dart_tool/ 3 | .packages 4 | # Remove the following pattern if you wish to check in your lock file 5 | pubspec.lock 6 | 7 | # Conventional directory for build outputs 8 | build/ 9 | 10 | # Directory created by dartdoc 11 | doc/api/ 12 | 13 | # IDEA Files 14 | .idea/workspace.xml 15 | .idea/$CACHE_FILE$ 16 | .idea/libraries 17 | 18 | *.log 19 | -------------------------------------------------------------------------------- /.idea/Sourcemod-HandleDumpParser.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /.idea/jsLibraryMappings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | -------------------------------------------------------------------------------- /.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.idea/runConfigurations/web_index_html.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 6 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 1.0.0 2 | 3 | - Initial version, created by Stagehand 4 | -------------------------------------------------------------------------------- /Dockerfile.cli: -------------------------------------------------------------------------------- 1 | # Specify the Dart SDK base image version using dart: (ex: dart:2.12) 2 | FROM dart:stable AS build 3 | 4 | # Resolve app dependencies. 5 | WORKDIR /app 6 | COPY pubspec.* ./ 7 | RUN dart pub get 8 | 9 | # Copy app source code and AOT compile it. 10 | COPY . . 11 | # Ensure packages are still up-to-date if anything has changed 12 | RUN dart pub get --offline 13 | RUN dart compile exe bin/main.dart -o bin/handledumpparser 14 | 15 | # Build minimal serving image from AOT-compiled `/handledumpparser` and required system 16 | # libraries and configuration files stored in `/runtime/` from the build stage. 17 | FROM scratch 18 | COPY --from=build /runtime/ / 19 | COPY --from=build /app/bin/handledumpparser /app/bin/ 20 | 21 | # Start handledumpparser. 22 | ENTRYPOINT ["/app/bin/handledumpparser"] 23 | -------------------------------------------------------------------------------- /Dockerfile.web: -------------------------------------------------------------------------------- 1 | # Specify the Dart SDK base image version using dart: (ex: dart:2.12) 2 | FROM dart:stable AS build 3 | 4 | RUN mkdir /pub-cache 5 | 6 | ENV PUB_CACHE=/pub-cache \ 7 | PATH="${PATH}:/pub-cache/bin" 8 | 9 | RUN dart pub global activate webdev && \ 10 | dart pub global activate stagehand 11 | 12 | EXPOSE 8080 13 | 14 | ADD entrypoint.sh /entrypoint.sh 15 | 16 | RUN chmod +x /entrypoint.sh 17 | 18 | ENTRYPOINT ["/entrypoint.sh"] 19 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2020 Mattia (Hexah | Hexer10 | Papero) 2 | 3 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 4 | 5 | 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 6 | 7 | 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 8 | 9 | 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 10 | 11 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Sourcemod Handle Dump Parser. 2 | Parses an handle dump file, and provide information such as the most used handle type and the total memory used by a single plugin. 3 | Also keep track of the dumps in a local indexdb. 4 | 5 | Fully built with dart. 6 | 7 | Try it here: https://hexer10.github.io/Sourcemod-HandleDumpParser/ 8 | 9 | To generate a dump file simply type in the console `sm_dump_handles dump.log` and a file named `dump.log` will be created in `gamefolder/` then you copy the content of that file or upload it to the web site to see all the values with ease. 10 | 11 | ![](https://i.imgur.com/gQZZ9Sr.png) 12 | -------------------------------------------------------------------------------- /analysis_options.yaml: -------------------------------------------------------------------------------- 1 | include: package:effective_dart/analysis_options.yaml 2 | 3 | analyzer: 4 | exclude: [build/**] 5 | strong-mode: 6 | implicit-casts: false 7 | 8 | linter: 9 | rules: 10 | - avoid_print 11 | #Unecessary 12 | - unnecessary_statements 13 | - unnecessary_new 14 | - unnecessary_null_aware_assignments 15 | - unnecessary_null_in_if_null_operators 16 | - unnecessary_parenthesis 17 | - unnecessary_const 18 | - unnecessary_this 19 | - unnecessary_overrides 20 | - unnecessary_lambdas 21 | - unnecessary_getters_setters 22 | - unnecessary_brace_in_string_interps 23 | 24 | #Avoid 25 | - empty_statements 26 | - avoid_empty_else 27 | - avoid_init_to_null 28 | - avoid_void_async 29 | - avoid_types_as_parameter_names 30 | - prefer_void_to_null 31 | - prefer_conditional_assignment 32 | - prefer_is_empty 33 | - prefer_is_not_empty 34 | - prefer_single_quotes 35 | - literal_only_boolean_expressions 36 | - no_duplicate_case_values 37 | - throw_in_finally 38 | - recursive_getters 39 | 40 | #Random checks 41 | - invariant_booleans 42 | 43 | - await_only_futures 44 | - unawaited_futures 45 | - library_names 46 | - package_names 47 | - iterable_contains_unrelated_type 48 | - list_remove_unrelated_type 49 | - test_types_in_equals 50 | - unrelated_type_equality_checks 51 | - no_adjacent_strings_in_list 52 | - valid_regexps 53 | 54 | #CodeStyle 55 | - always_put_control_body_on_new_line 56 | - always_declare_return_types 57 | - always_put_required_named_parameters_first 58 | #- always_specify_types 59 | - annotate_overrides 60 | - avoid_bool_literals_in_conditional_expressions 61 | - avoid_catches_without_on_clauses 62 | - avoid_catching_errors 63 | - avoid_classes_with_only_static_members 64 | - avoid_field_initializers_in_const_classes 65 | - avoid_function_literals_in_foreach_calls 66 | - avoid_return_types_on_setters 67 | - avoid_returning_null_for_void 68 | - avoid_returning_this 69 | - void_checks 70 | - use_to_and_as_if_applicable 71 | - use_string_buffers 72 | - use_setters_to_change_properties 73 | - use_rethrow_when_possible 74 | - type_init_formals 75 | # - type_annotate_public_apis 76 | - sort_unnamed_constructors_first 77 | - slash_for_doc_comments 78 | - prefer_interpolation_to_compose_strings 79 | - prefer_int_literals 80 | - prefer_initializing_formals 81 | - prefer_foreach 82 | - prefer_expression_function_bodies 83 | - prefer_equal_for_default_values 84 | - prefer_contains 85 | - prefer_const_declarations 86 | - prefer_collection_literals 87 | - prefer_adjacent_string_concatenation 88 | - parameter_assignments 89 | - package_prefixed_library_names 90 | - package_api_docs 91 | - only_throw_errors 92 | - lines_longer_than_80_chars 93 | - flutter_style_todos 94 | - file_names 95 | - empty_constructor_bodies 96 | - empty_catches 97 | - directives_ordering 98 | - constant_identifier_names 99 | #- cascade_invocations 100 | - camel_case_types 101 | - avoid_unused_constructor_parameters 102 | - avoid_types_on_closure_parameters 103 | - avoid_single_cascade_in_expression_statements 104 | - avoid_setters_without_getters 105 | 106 | #Idk 107 | - comment_references 108 | - control_flow_in_finally 109 | - sort_pub_dependencies 110 | - non_constant_identifier_names 111 | - curly_braces_in_flow_control_structures 112 | - implementation_imports 113 | - avoid_relative_lib_imports 114 | - prefer_iterable_whereType 115 | - prefer_function_declarations_over_variables 116 | - prefer_final_fields 117 | - prefer_typing_uninitialized_variables 118 | - one_member_abstracts 119 | - public_member_api_docs 120 | - prefer_constructors_over_static_methods 121 | - omit_local_variable_types 122 | - prefer_generic_function_type_aliases 123 | - avoid_private_typedef_functions 124 | - avoid_positional_boolean_parameters -------------------------------------------------------------------------------- /bin/main.dart: -------------------------------------------------------------------------------- 1 | import 'dart:io'; 2 | 3 | import 'package:HandleDumpParser/handle_dump_parser.dart'; 4 | import 'package:args/args.dart'; 5 | 6 | void main(List arguments) { 7 | final parser = ArgParser() 8 | ..addOption('path', abbr: 'p', help: 'Path to the dump file') 9 | ..addFlag('help', abbr: 'h', help: 'Display this text', negatable: false); 10 | 11 | final argResults = parser.parse(arguments); 12 | 13 | var path = argResults['path'] as String; 14 | 15 | if (argResults['help'] as bool) { 16 | print(parser.usage); 17 | return; 18 | } else if (path == null) { 19 | handleError('Missing required argument: path'); 20 | } 21 | 22 | if (!FileSystemEntity.isFileSync(path)) { 23 | handleError('$path is not a file!'); 24 | } 25 | 26 | File('$path-parsed.txt').writeAsStringSync( 27 | 'Owner Type Memory\n', 28 | mode: FileMode.write); 29 | 30 | var dumpResults = HandleDumpParser.parse(File(path).readAsStringSync()); 31 | 32 | if (dumpResults != null) 33 | { 34 | var dump = File('dump_parsed.txt').openWrite(mode: FileMode.writeOnlyAppend); 35 | dumpResults.sort().forEach(dump.writeln); 36 | dump.close(); 37 | } else { 38 | print("Invalid input"); 39 | } 40 | } 41 | 42 | void handleError(String msg) { 43 | stderr.writeln(msg); 44 | exitCode = 2; 45 | } 46 | -------------------------------------------------------------------------------- /docs/.build.manifest: -------------------------------------------------------------------------------- 1 | .dart_tool/package_config.json 2 | .packages 3 | index.html 4 | main.dart.js 5 | manifest.json 6 | packages/$sdk/_internal/strong.sum 7 | packages/$sdk/dev_compiler/kernel/amd/dart_sdk.js 8 | packages/$sdk/dev_compiler/kernel/amd/require.js 9 | packages/$sdk/dev_compiler/kernel/common/dart_sdk.js 10 | packages/$sdk/dev_compiler/kernel/common/run.js 11 | packages/$sdk/dev_compiler/kernel/es6/dart_sdk.js 12 | packages/$sdk/dev_compiler/web/dart_stack_trace_mapper.js 13 | packages/_fe_analyzer_shared/src/parser/parser.md 14 | packages/analyzer/src/summary/format.fbs 15 | packages/build_runner/src/server/README.md 16 | packages/build_runner/src/server/build_updates_client/hot_reload_client.dart.js 17 | packages/build_runner/src/server/build_updates_client/live_reload_client.js 18 | packages/build_runner/src/server/graph_viz.html 19 | packages/build_runner/src/server/graph_viz.js 20 | packages/build_runner/src/server/graph_viz_main.dart.js 21 | packages/build_web_compilers/src/dev_compiler_stack_trace/stack_trace_mapper.dart.js 22 | packages/effective_dart/analysis_options.1.0.0.yaml 23 | packages/effective_dart/analysis_options.1.1.0.yaml 24 | packages/effective_dart/analysis_options.1.2.0.yaml 25 | packages/effective_dart/analysis_options.yaml 26 | packages/pedantic/analysis_options.1.0.0.yaml 27 | packages/pedantic/analysis_options.1.1.0.yaml 28 | packages/pedantic/analysis_options.1.2.0.yaml 29 | packages/pedantic/analysis_options.1.3.0.yaml 30 | packages/pedantic/analysis_options.1.4.0.yaml 31 | packages/pedantic/analysis_options.1.5.0.yaml 32 | packages/pedantic/analysis_options.1.6.0.yaml 33 | packages/pedantic/analysis_options.1.7.0.yaml 34 | packages/pedantic/analysis_options.1.8.0.yaml 35 | packages/pedantic/analysis_options.1.9.0.yaml 36 | packages/pedantic/analysis_options.yaml -------------------------------------------------------------------------------- /docs/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Handle Dump parser 7 | 8 | 9 | 10 | 11 | 12 | 13 | 15 | 16 | 17 | 18 | 19 | 32 | 33 | 34 | 35 | 36 |
37 |
38 |
39 |
40 |
    41 |
42 | 43 | 51 | 52 | 56 | 57 | 66 |
67 |
68 |
69 |
70 | 72 | 73 |
74 |
75 | 76 | 77 | 78 |
79 | 80 | 81 | 82 |
83 |
84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 |
Owner Handle count Most used handle type Memory
96 |
97 |
98 |
99 |
100 |
101 | 104 | 107 | 110 | 111 | 116 | 117 | -------------------------------------------------------------------------------- /docs/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Handle Dump Parser", 3 | "short_name": "Handle Dump Parser", 4 | "description": "Parser for sourcemod handle dumps.", 5 | "lang": "en-US", 6 | "start_url": "/", 7 | "scope": "/", 8 | "display": "standalone", 9 | "orientation": "any", 10 | "theme_color": "#ffffff", 11 | "background_color": "#ffffff" 12 | } 13 | -------------------------------------------------------------------------------- /docs/packages/$sdk/_internal/strong.sum: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Hexer10/Sourcemod-HandleDumpParser/0ebbd25434d9d98950ebc30fdac40e3509a2c235/docs/packages/$sdk/_internal/strong.sum -------------------------------------------------------------------------------- /docs/packages/$sdk/dev_compiler/kernel/amd/require.js: -------------------------------------------------------------------------------- 1 | /** vim: et:ts=4:sw=4:sts=4 2 | * @license RequireJS 2.3.3 Copyright jQuery Foundation and other contributors. 3 | * Released under MIT license, https://github.com/requirejs/requirejs/blob/master/LICENSE 4 | */ 5 | //Not using strict: uneven strict support in browsers, #392, and causes 6 | //problems with requirejs.exec()/transpiler plugins that may not be strict. 7 | /*jslint regexp: true, nomen: true, sloppy: true */ 8 | /*global window, navigator, document, importScripts, setTimeout, opera */ 9 | 10 | var requirejs, require, define; 11 | (function (global, setTimeout) { 12 | var req, s, head, baseElement, dataMain, src, 13 | interactiveScript, currentlyAddingScript, mainScript, subPath, 14 | version = '2.3.3', 15 | commentRegExp = /\/\*[\s\S]*?\*\/|([^:"'=]|^)\/\/.*$/mg, 16 | cjsRequireRegExp = /[^.]\s*require\s*\(\s*["']([^'"\s]+)["']\s*\)/g, 17 | jsSuffixRegExp = /\.js$/, 18 | currDirRegExp = /^\.\//, 19 | op = Object.prototype, 20 | ostring = op.toString, 21 | hasOwn = op.hasOwnProperty, 22 | isBrowser = !!(typeof window !== 'undefined' && typeof navigator !== 'undefined' && window.document), 23 | isWebWorker = !isBrowser && typeof importScripts !== 'undefined', 24 | //PS3 indicates loaded and complete, but need to wait for complete 25 | //specifically. Sequence is 'loading', 'loaded', execution, 26 | // then 'complete'. The UA check is unfortunate, but not sure how 27 | //to feature test w/o causing perf issues. 28 | readyRegExp = isBrowser && navigator.platform === 'PLAYSTATION 3' ? 29 | /^complete$/ : /^(complete|loaded)$/, 30 | defContextName = '_', 31 | //Oh the tragedy, detecting opera. See the usage of isOpera for reason. 32 | isOpera = typeof opera !== 'undefined' && opera.toString() === '[object Opera]', 33 | contexts = {}, 34 | cfg = {}, 35 | globalDefQueue = [], 36 | useInteractive = false; 37 | 38 | //Could match something like ')//comment', do not lose the prefix to comment. 39 | function commentReplace(match, singlePrefix) { 40 | return singlePrefix || ''; 41 | } 42 | 43 | function isFunction(it) { 44 | return ostring.call(it) === '[object Function]'; 45 | } 46 | 47 | function isArray(it) { 48 | return ostring.call(it) === '[object Array]'; 49 | } 50 | 51 | /** 52 | * Helper function for iterating over an array. If the func returns 53 | * a true value, it will break out of the loop. 54 | */ 55 | function each(ary, func) { 56 | if (ary) { 57 | var i; 58 | for (i = 0; i < ary.length; i += 1) { 59 | if (ary[i] && func(ary[i], i, ary)) { 60 | break; 61 | } 62 | } 63 | } 64 | } 65 | 66 | /** 67 | * Helper function for iterating over an array backwards. If the func 68 | * returns a true value, it will break out of the loop. 69 | */ 70 | function eachReverse(ary, func) { 71 | if (ary) { 72 | var i; 73 | for (i = ary.length - 1; i > -1; i -= 1) { 74 | if (ary[i] && func(ary[i], i, ary)) { 75 | break; 76 | } 77 | } 78 | } 79 | } 80 | 81 | function hasProp(obj, prop) { 82 | return hasOwn.call(obj, prop); 83 | } 84 | 85 | function getOwn(obj, prop) { 86 | return hasProp(obj, prop) && obj[prop]; 87 | } 88 | 89 | /** 90 | * Cycles over properties in an object and calls a function for each 91 | * property value. If the function returns a truthy value, then the 92 | * iteration is stopped. 93 | */ 94 | function eachProp(obj, func) { 95 | var prop; 96 | for (prop in obj) { 97 | if (hasProp(obj, prop)) { 98 | if (func(obj[prop], prop)) { 99 | break; 100 | } 101 | } 102 | } 103 | } 104 | 105 | /** 106 | * Simple function to mix in properties from source into target, 107 | * but only if target does not already have a property of the same name. 108 | */ 109 | function mixin(target, source, force, deepStringMixin) { 110 | if (source) { 111 | eachProp(source, function (value, prop) { 112 | if (force || !hasProp(target, prop)) { 113 | if (deepStringMixin && typeof value === 'object' && value && 114 | !isArray(value) && !isFunction(value) && 115 | !(value instanceof RegExp)) { 116 | 117 | if (!target[prop]) { 118 | target[prop] = {}; 119 | } 120 | mixin(target[prop], value, force, deepStringMixin); 121 | } else { 122 | target[prop] = value; 123 | } 124 | } 125 | }); 126 | } 127 | return target; 128 | } 129 | 130 | //Similar to Function.prototype.bind, but the 'this' object is specified 131 | //first, since it is easier to read/figure out what 'this' will be. 132 | function bind(obj, fn) { 133 | return function () { 134 | return fn.apply(obj, arguments); 135 | }; 136 | } 137 | 138 | function scripts() { 139 | return document.getElementsByTagName('script'); 140 | } 141 | 142 | function defaultOnError(err) { 143 | throw err; 144 | } 145 | 146 | //Allow getting a global that is expressed in 147 | //dot notation, like 'a.b.c'. 148 | function getGlobal(value) { 149 | if (!value) { 150 | return value; 151 | } 152 | var g = global; 153 | each(value.split('.'), function (part) { 154 | g = g[part]; 155 | }); 156 | return g; 157 | } 158 | 159 | /** 160 | * Constructs an error with a pointer to an URL with more information. 161 | * @param {String} id the error ID that maps to an ID on a web page. 162 | * @param {String} message human readable error. 163 | * @param {Error} [err] the original error, if there is one. 164 | * 165 | * @returns {Error} 166 | */ 167 | function makeError(id, msg, err, requireModules) { 168 | var e = new Error(msg + '\nhttp://requirejs.org/docs/errors.html#' + id); 169 | e.requireType = id; 170 | e.requireModules = requireModules; 171 | if (err) { 172 | e.originalError = err; 173 | } 174 | return e; 175 | } 176 | 177 | if (typeof define !== 'undefined') { 178 | //If a define is already in play via another AMD loader, 179 | //do not overwrite. 180 | return; 181 | } 182 | 183 | if (typeof requirejs !== 'undefined') { 184 | if (isFunction(requirejs)) { 185 | //Do not overwrite an existing requirejs instance. 186 | return; 187 | } 188 | cfg = requirejs; 189 | requirejs = undefined; 190 | } 191 | 192 | //Allow for a require config object 193 | if (typeof require !== 'undefined' && !isFunction(require)) { 194 | //assume it is a config object. 195 | cfg = require; 196 | require = undefined; 197 | } 198 | 199 | function newContext(contextName) { 200 | var inCheckLoaded, Module, context, handlers, 201 | checkLoadedTimeoutId, 202 | config = { 203 | //Defaults. Do not set a default for map 204 | //config to speed up normalize(), which 205 | //will run faster if there is no default. 206 | waitSeconds: 7, 207 | baseUrl: './', 208 | paths: {}, 209 | bundles: {}, 210 | pkgs: {}, 211 | shim: {}, 212 | config: {} 213 | }, 214 | registry = {}, 215 | //registry of just enabled modules, to speed 216 | //cycle breaking code when lots of modules 217 | //are registered, but not activated. 218 | enabledRegistry = {}, 219 | undefEvents = {}, 220 | defQueue = [], 221 | defined = {}, 222 | urlFetched = {}, 223 | bundlesMap = {}, 224 | requireCounter = 1, 225 | unnormalizedCounter = 1; 226 | 227 | /** 228 | * Trims the . and .. from an array of path segments. 229 | * It will keep a leading path segment if a .. will become 230 | * the first path segment, to help with module name lookups, 231 | * which act like paths, but can be remapped. But the end result, 232 | * all paths that use this function should look normalized. 233 | * NOTE: this method MODIFIES the input array. 234 | * @param {Array} ary the array of path segments. 235 | */ 236 | function trimDots(ary) { 237 | var i, part; 238 | for (i = 0; i < ary.length; i++) { 239 | part = ary[i]; 240 | if (part === '.') { 241 | ary.splice(i, 1); 242 | i -= 1; 243 | } else if (part === '..') { 244 | // If at the start, or previous value is still .., 245 | // keep them so that when converted to a path it may 246 | // still work when converted to a path, even though 247 | // as an ID it is less than ideal. In larger point 248 | // releases, may be better to just kick out an error. 249 | if (i === 0 || (i === 1 && ary[2] === '..') || ary[i - 1] === '..') { 250 | continue; 251 | } else if (i > 0) { 252 | ary.splice(i - 1, 2); 253 | i -= 2; 254 | } 255 | } 256 | } 257 | } 258 | 259 | /** 260 | * Given a relative module name, like ./something, normalize it to 261 | * a real name that can be mapped to a path. 262 | * @param {String} name the relative name 263 | * @param {String} baseName a real name that the name arg is relative 264 | * to. 265 | * @param {Boolean} applyMap apply the map config to the value. Should 266 | * only be done if this normalization is for a dependency ID. 267 | * @returns {String} normalized name 268 | */ 269 | function normalize(name, baseName, applyMap) { 270 | var pkgMain, mapValue, nameParts, i, j, nameSegment, lastIndex, 271 | foundMap, foundI, foundStarMap, starI, normalizedBaseParts, 272 | baseParts = (baseName && baseName.split('/')), 273 | map = config.map, 274 | starMap = map && map['*']; 275 | 276 | //Adjust any relative paths. 277 | if (name) { 278 | name = name.split('/'); 279 | lastIndex = name.length - 1; 280 | 281 | // If wanting node ID compatibility, strip .js from end 282 | // of IDs. Have to do this here, and not in nameToUrl 283 | // because node allows either .js or non .js to map 284 | // to same file. 285 | if (config.nodeIdCompat && jsSuffixRegExp.test(name[lastIndex])) { 286 | name[lastIndex] = name[lastIndex].replace(jsSuffixRegExp, ''); 287 | } 288 | 289 | // Starts with a '.' so need the baseName 290 | if (name[0].charAt(0) === '.' && baseParts) { 291 | //Convert baseName to array, and lop off the last part, 292 | //so that . matches that 'directory' and not name of the baseName's 293 | //module. For instance, baseName of 'one/two/three', maps to 294 | //'one/two/three.js', but we want the directory, 'one/two' for 295 | //this normalization. 296 | normalizedBaseParts = baseParts.slice(0, baseParts.length - 1); 297 | name = normalizedBaseParts.concat(name); 298 | } 299 | 300 | trimDots(name); 301 | name = name.join('/'); 302 | } 303 | 304 | //Apply map config if available. 305 | if (applyMap && map && (baseParts || starMap)) { 306 | nameParts = name.split('/'); 307 | 308 | outerLoop: for (i = nameParts.length; i > 0; i -= 1) { 309 | nameSegment = nameParts.slice(0, i).join('/'); 310 | 311 | if (baseParts) { 312 | //Find the longest baseName segment match in the config. 313 | //So, do joins on the biggest to smallest lengths of baseParts. 314 | for (j = baseParts.length; j > 0; j -= 1) { 315 | mapValue = getOwn(map, baseParts.slice(0, j).join('/')); 316 | 317 | //baseName segment has config, find if it has one for 318 | //this name. 319 | if (mapValue) { 320 | mapValue = getOwn(mapValue, nameSegment); 321 | if (mapValue) { 322 | //Match, update name to the new value. 323 | foundMap = mapValue; 324 | foundI = i; 325 | break outerLoop; 326 | } 327 | } 328 | } 329 | } 330 | 331 | //Check for a star map match, but just hold on to it, 332 | //if there is a shorter segment match later in a matching 333 | //config, then favor over this star map. 334 | if (!foundStarMap && starMap && getOwn(starMap, nameSegment)) { 335 | foundStarMap = getOwn(starMap, nameSegment); 336 | starI = i; 337 | } 338 | } 339 | 340 | if (!foundMap && foundStarMap) { 341 | foundMap = foundStarMap; 342 | foundI = starI; 343 | } 344 | 345 | if (foundMap) { 346 | nameParts.splice(0, foundI, foundMap); 347 | name = nameParts.join('/'); 348 | } 349 | } 350 | 351 | // If the name points to a package's name, use 352 | // the package main instead. 353 | pkgMain = getOwn(config.pkgs, name); 354 | 355 | return pkgMain ? pkgMain : name; 356 | } 357 | 358 | function removeScript(name) { 359 | if (isBrowser) { 360 | each(scripts(), function (scriptNode) { 361 | if (scriptNode.getAttribute('data-requiremodule') === name && 362 | scriptNode.getAttribute('data-requirecontext') === context.contextName) { 363 | scriptNode.parentNode.removeChild(scriptNode); 364 | return true; 365 | } 366 | }); 367 | } 368 | } 369 | 370 | function hasPathFallback(id) { 371 | var pathConfig = getOwn(config.paths, id); 372 | if (pathConfig && isArray(pathConfig) && pathConfig.length > 1) { 373 | //Pop off the first array value, since it failed, and 374 | //retry 375 | pathConfig.shift(); 376 | context.require.undef(id); 377 | 378 | //Custom require that does not do map translation, since 379 | //ID is "absolute", already mapped/resolved. 380 | context.makeRequire(null, { 381 | skipMap: true 382 | })([id]); 383 | 384 | return true; 385 | } 386 | } 387 | 388 | //Turns a plugin!resource to [plugin, resource] 389 | //with the plugin being undefined if the name 390 | //did not have a plugin prefix. 391 | function splitPrefix(name) { 392 | var prefix, 393 | index = name ? name.indexOf('!') : -1; 394 | if (index > -1) { 395 | prefix = name.substring(0, index); 396 | name = name.substring(index + 1, name.length); 397 | } 398 | return [prefix, name]; 399 | } 400 | 401 | /** 402 | * Creates a module mapping that includes plugin prefix, module 403 | * name, and path. If parentModuleMap is provided it will 404 | * also normalize the name via require.normalize() 405 | * 406 | * @param {String} name the module name 407 | * @param {String} [parentModuleMap] parent module map 408 | * for the module name, used to resolve relative names. 409 | * @param {Boolean} isNormalized: is the ID already normalized. 410 | * This is true if this call is done for a define() module ID. 411 | * @param {Boolean} applyMap: apply the map config to the ID. 412 | * Should only be true if this map is for a dependency. 413 | * 414 | * @returns {Object} 415 | */ 416 | function makeModuleMap(name, parentModuleMap, isNormalized, applyMap) { 417 | var url, pluginModule, suffix, nameParts, 418 | prefix = null, 419 | parentName = parentModuleMap ? parentModuleMap.name : null, 420 | originalName = name, 421 | isDefine = true, 422 | normalizedName = ''; 423 | 424 | //If no name, then it means it is a require call, generate an 425 | //internal name. 426 | if (!name) { 427 | isDefine = false; 428 | name = '_@r' + (requireCounter += 1); 429 | } 430 | 431 | nameParts = splitPrefix(name); 432 | prefix = nameParts[0]; 433 | name = nameParts[1]; 434 | 435 | if (prefix) { 436 | prefix = normalize(prefix, parentName, applyMap); 437 | pluginModule = getOwn(defined, prefix); 438 | } 439 | 440 | //Account for relative paths if there is a base name. 441 | if (name) { 442 | if (prefix) { 443 | if (isNormalized) { 444 | normalizedName = name; 445 | } else if (pluginModule && pluginModule.normalize) { 446 | //Plugin is loaded, use its normalize method. 447 | normalizedName = pluginModule.normalize(name, function (name) { 448 | return normalize(name, parentName, applyMap); 449 | }); 450 | } else { 451 | // If nested plugin references, then do not try to 452 | // normalize, as it will not normalize correctly. This 453 | // places a restriction on resourceIds, and the longer 454 | // term solution is not to normalize until plugins are 455 | // loaded and all normalizations to allow for async 456 | // loading of a loader plugin. But for now, fixes the 457 | // common uses. Details in #1131 458 | normalizedName = name.indexOf('!') === -1 ? 459 | normalize(name, parentName, applyMap) : 460 | name; 461 | } 462 | } else { 463 | //A regular module. 464 | normalizedName = normalize(name, parentName, applyMap); 465 | 466 | //Normalized name may be a plugin ID due to map config 467 | //application in normalize. The map config values must 468 | //already be normalized, so do not need to redo that part. 469 | nameParts = splitPrefix(normalizedName); 470 | prefix = nameParts[0]; 471 | normalizedName = nameParts[1]; 472 | isNormalized = true; 473 | 474 | url = context.nameToUrl(normalizedName); 475 | } 476 | } 477 | 478 | //If the id is a plugin id that cannot be determined if it needs 479 | //normalization, stamp it with a unique ID so two matching relative 480 | //ids that may conflict can be separate. 481 | suffix = prefix && !pluginModule && !isNormalized ? 482 | '_unnormalized' + (unnormalizedCounter += 1) : 483 | ''; 484 | 485 | return { 486 | prefix: prefix, 487 | name: normalizedName, 488 | parentMap: parentModuleMap, 489 | unnormalized: !!suffix, 490 | url: url, 491 | originalName: originalName, 492 | isDefine: isDefine, 493 | id: (prefix ? 494 | prefix + '!' + normalizedName : 495 | normalizedName) + suffix 496 | }; 497 | } 498 | 499 | function getModule(depMap) { 500 | var id = depMap.id, 501 | mod = getOwn(registry, id); 502 | 503 | if (!mod) { 504 | mod = registry[id] = new context.Module(depMap); 505 | } 506 | 507 | return mod; 508 | } 509 | 510 | function on(depMap, name, fn) { 511 | var id = depMap.id, 512 | mod = getOwn(registry, id); 513 | 514 | if (hasProp(defined, id) && 515 | (!mod || mod.defineEmitComplete)) { 516 | if (name === 'defined') { 517 | fn(defined[id]); 518 | } 519 | } else { 520 | mod = getModule(depMap); 521 | if (mod.error && name === 'error') { 522 | fn(mod.error); 523 | } else { 524 | mod.on(name, fn); 525 | } 526 | } 527 | } 528 | 529 | function onError(err, errback) { 530 | var ids = err.requireModules, 531 | notified = false; 532 | 533 | if (errback) { 534 | errback(err); 535 | } else { 536 | each(ids, function (id) { 537 | var mod = getOwn(registry, id); 538 | if (mod) { 539 | //Set error on module, so it skips timeout checks. 540 | mod.error = err; 541 | if (mod.events.error) { 542 | notified = true; 543 | mod.emit('error', err); 544 | } 545 | } 546 | }); 547 | 548 | if (!notified) { 549 | req.onError(err); 550 | } 551 | } 552 | } 553 | 554 | /** 555 | * Internal method to transfer globalQueue items to this context's 556 | * defQueue. 557 | */ 558 | function takeGlobalQueue() { 559 | //Push all the globalDefQueue items into the context's defQueue 560 | if (globalDefQueue.length) { 561 | each(globalDefQueue, function(queueItem) { 562 | var id = queueItem[0]; 563 | if (typeof id === 'string') { 564 | context.defQueueMap[id] = true; 565 | } 566 | defQueue.push(queueItem); 567 | }); 568 | globalDefQueue = []; 569 | } 570 | } 571 | 572 | handlers = { 573 | 'require': function (mod) { 574 | if (mod.require) { 575 | return mod.require; 576 | } else { 577 | return (mod.require = context.makeRequire(mod.map)); 578 | } 579 | }, 580 | 'exports': function (mod) { 581 | mod.usingExports = true; 582 | if (mod.map.isDefine) { 583 | if (mod.exports) { 584 | return (defined[mod.map.id] = mod.exports); 585 | } else { 586 | return (mod.exports = defined[mod.map.id] = {}); 587 | } 588 | } 589 | }, 590 | 'module': function (mod) { 591 | if (mod.module) { 592 | return mod.module; 593 | } else { 594 | return (mod.module = { 595 | id: mod.map.id, 596 | uri: mod.map.url, 597 | config: function () { 598 | return getOwn(config.config, mod.map.id) || {}; 599 | }, 600 | exports: mod.exports || (mod.exports = {}) 601 | }); 602 | } 603 | } 604 | }; 605 | 606 | function cleanRegistry(id) { 607 | //Clean up machinery used for waiting modules. 608 | delete registry[id]; 609 | delete enabledRegistry[id]; 610 | } 611 | 612 | function breakCycle(mod, traced, processed) { 613 | var id = mod.map.id; 614 | 615 | if (mod.error) { 616 | mod.emit('error', mod.error); 617 | } else { 618 | traced[id] = true; 619 | each(mod.depMaps, function (depMap, i) { 620 | var depId = depMap.id, 621 | dep = getOwn(registry, depId); 622 | 623 | //Only force things that have not completed 624 | //being defined, so still in the registry, 625 | //and only if it has not been matched up 626 | //in the module already. 627 | if (dep && !mod.depMatched[i] && !processed[depId]) { 628 | if (getOwn(traced, depId)) { 629 | mod.defineDep(i, defined[depId]); 630 | mod.check(); //pass false? 631 | } else { 632 | breakCycle(dep, traced, processed); 633 | } 634 | } 635 | }); 636 | processed[id] = true; 637 | } 638 | } 639 | 640 | function checkLoaded() { 641 | var err, usingPathFallback, 642 | waitInterval = config.waitSeconds * 1000, 643 | //It is possible to disable the wait interval by using waitSeconds of 0. 644 | expired = waitInterval && (context.startTime + waitInterval) < new Date().getTime(), 645 | noLoads = [], 646 | reqCalls = [], 647 | stillLoading = false, 648 | needCycleCheck = true; 649 | 650 | //Do not bother if this call was a result of a cycle break. 651 | if (inCheckLoaded) { 652 | return; 653 | } 654 | 655 | inCheckLoaded = true; 656 | 657 | //Figure out the state of all the modules. 658 | eachProp(enabledRegistry, function (mod) { 659 | var map = mod.map, 660 | modId = map.id; 661 | 662 | //Skip things that are not enabled or in error state. 663 | if (!mod.enabled) { 664 | return; 665 | } 666 | 667 | if (!map.isDefine) { 668 | reqCalls.push(mod); 669 | } 670 | 671 | if (!mod.error) { 672 | //If the module should be executed, and it has not 673 | //been inited and time is up, remember it. 674 | if (!mod.inited && expired) { 675 | if (hasPathFallback(modId)) { 676 | usingPathFallback = true; 677 | stillLoading = true; 678 | } else { 679 | noLoads.push(modId); 680 | removeScript(modId); 681 | } 682 | } else if (!mod.inited && mod.fetched && map.isDefine) { 683 | stillLoading = true; 684 | if (!map.prefix) { 685 | //No reason to keep looking for unfinished 686 | //loading. If the only stillLoading is a 687 | //plugin resource though, keep going, 688 | //because it may be that a plugin resource 689 | //is waiting on a non-plugin cycle. 690 | return (needCycleCheck = false); 691 | } 692 | } 693 | } 694 | }); 695 | 696 | if (expired && noLoads.length) { 697 | //If wait time expired, throw error of unloaded modules. 698 | err = makeError('timeout', 'Load timeout for modules: ' + noLoads, null, noLoads); 699 | err.contextName = context.contextName; 700 | return onError(err); 701 | } 702 | 703 | //Not expired, check for a cycle. 704 | if (needCycleCheck) { 705 | each(reqCalls, function (mod) { 706 | breakCycle(mod, {}, {}); 707 | }); 708 | } 709 | 710 | //If still waiting on loads, and the waiting load is something 711 | //other than a plugin resource, or there are still outstanding 712 | //scripts, then just try back later. 713 | if ((!expired || usingPathFallback) && stillLoading) { 714 | //Something is still waiting to load. Wait for it, but only 715 | //if a timeout is not already in effect. 716 | if ((isBrowser || isWebWorker) && !checkLoadedTimeoutId) { 717 | checkLoadedTimeoutId = setTimeout(function () { 718 | checkLoadedTimeoutId = 0; 719 | checkLoaded(); 720 | }, 50); 721 | } 722 | } 723 | 724 | inCheckLoaded = false; 725 | } 726 | 727 | Module = function (map) { 728 | this.events = getOwn(undefEvents, map.id) || {}; 729 | this.map = map; 730 | this.shim = getOwn(config.shim, map.id); 731 | this.depExports = []; 732 | this.depMaps = []; 733 | this.depMatched = []; 734 | this.pluginMaps = {}; 735 | this.depCount = 0; 736 | 737 | /* this.exports this.factory 738 | this.depMaps = [], 739 | this.enabled, this.fetched 740 | */ 741 | }; 742 | 743 | Module.prototype = { 744 | init: function (depMaps, factory, errback, options) { 745 | options = options || {}; 746 | 747 | //Do not do more inits if already done. Can happen if there 748 | //are multiple define calls for the same module. That is not 749 | //a normal, common case, but it is also not unexpected. 750 | if (this.inited) { 751 | return; 752 | } 753 | 754 | this.factory = factory; 755 | 756 | if (errback) { 757 | //Register for errors on this module. 758 | this.on('error', errback); 759 | } else if (this.events.error) { 760 | //If no errback already, but there are error listeners 761 | //on this module, set up an errback to pass to the deps. 762 | errback = bind(this, function (err) { 763 | this.emit('error', err); 764 | }); 765 | } 766 | 767 | //Do a copy of the dependency array, so that 768 | //source inputs are not modified. For example 769 | //"shim" deps are passed in here directly, and 770 | //doing a direct modification of the depMaps array 771 | //would affect that config. 772 | this.depMaps = depMaps && depMaps.slice(0); 773 | 774 | this.errback = errback; 775 | 776 | //Indicate this module has be initialized 777 | this.inited = true; 778 | 779 | this.ignore = options.ignore; 780 | 781 | //Could have option to init this module in enabled mode, 782 | //or could have been previously marked as enabled. However, 783 | //the dependencies are not known until init is called. So 784 | //if enabled previously, now trigger dependencies as enabled. 785 | if (options.enabled || this.enabled) { 786 | //Enable this module and dependencies. 787 | //Will call this.check() 788 | this.enable(); 789 | } else { 790 | this.check(); 791 | } 792 | }, 793 | 794 | defineDep: function (i, depExports) { 795 | //Because of cycles, defined callback for a given 796 | //export can be called more than once. 797 | if (!this.depMatched[i]) { 798 | this.depMatched[i] = true; 799 | this.depCount -= 1; 800 | this.depExports[i] = depExports; 801 | } 802 | }, 803 | 804 | fetch: function () { 805 | if (this.fetched) { 806 | return; 807 | } 808 | this.fetched = true; 809 | 810 | context.startTime = (new Date()).getTime(); 811 | 812 | var map = this.map; 813 | 814 | //If the manager is for a plugin managed resource, 815 | //ask the plugin to load it now. 816 | if (this.shim) { 817 | context.makeRequire(this.map, { 818 | enableBuildCallback: true 819 | })(this.shim.deps || [], bind(this, function () { 820 | return map.prefix ? this.callPlugin() : this.load(); 821 | })); 822 | } else { 823 | //Regular dependency. 824 | return map.prefix ? this.callPlugin() : this.load(); 825 | } 826 | }, 827 | 828 | load: function () { 829 | var url = this.map.url; 830 | 831 | //Regular dependency. 832 | if (!urlFetched[url]) { 833 | urlFetched[url] = true; 834 | context.load(this.map.id, url); 835 | } 836 | }, 837 | 838 | /** 839 | * Checks if the module is ready to define itself, and if so, 840 | * define it. 841 | */ 842 | check: function () { 843 | if (!this.enabled || this.enabling) { 844 | return; 845 | } 846 | 847 | var err, cjsModule, 848 | id = this.map.id, 849 | depExports = this.depExports, 850 | exports = this.exports, 851 | factory = this.factory; 852 | 853 | if (!this.inited) { 854 | // Only fetch if not already in the defQueue. 855 | if (!hasProp(context.defQueueMap, id)) { 856 | this.fetch(); 857 | } 858 | } else if (this.error) { 859 | this.emit('error', this.error); 860 | } else if (!this.defining) { 861 | //The factory could trigger another require call 862 | //that would result in checking this module to 863 | //define itself again. If already in the process 864 | //of doing that, skip this work. 865 | this.defining = true; 866 | 867 | if (this.depCount < 1 && !this.defined) { 868 | if (isFunction(factory)) { 869 | //If there is an error listener, favor passing 870 | //to that instead of throwing an error. However, 871 | //only do it for define()'d modules. require 872 | //errbacks should not be called for failures in 873 | //their callbacks (#699). However if a global 874 | //onError is set, use that. 875 | if ((this.events.error && this.map.isDefine) || 876 | req.onError !== defaultOnError) { 877 | try { 878 | exports = context.execCb(id, factory, depExports, exports); 879 | } catch (e) { 880 | err = e; 881 | } 882 | } else { 883 | exports = context.execCb(id, factory, depExports, exports); 884 | } 885 | 886 | // Favor return value over exports. If node/cjs in play, 887 | // then will not have a return value anyway. Favor 888 | // module.exports assignment over exports object. 889 | if (this.map.isDefine && exports === undefined) { 890 | cjsModule = this.module; 891 | if (cjsModule) { 892 | exports = cjsModule.exports; 893 | } else if (this.usingExports) { 894 | //exports already set the defined value. 895 | exports = this.exports; 896 | } 897 | } 898 | 899 | if (err) { 900 | err.requireMap = this.map; 901 | err.requireModules = this.map.isDefine ? [this.map.id] : null; 902 | err.requireType = this.map.isDefine ? 'define' : 'require'; 903 | return onError((this.error = err)); 904 | } 905 | 906 | } else { 907 | //Just a literal value 908 | exports = factory; 909 | } 910 | 911 | this.exports = exports; 912 | 913 | if (this.map.isDefine && !this.ignore) { 914 | defined[id] = exports; 915 | 916 | if (req.onResourceLoad) { 917 | var resLoadMaps = []; 918 | each(this.depMaps, function (depMap) { 919 | resLoadMaps.push(depMap.normalizedMap || depMap); 920 | }); 921 | req.onResourceLoad(context, this.map, resLoadMaps); 922 | } 923 | } 924 | 925 | //Clean up 926 | cleanRegistry(id); 927 | 928 | this.defined = true; 929 | } 930 | 931 | //Finished the define stage. Allow calling check again 932 | //to allow define notifications below in the case of a 933 | //cycle. 934 | this.defining = false; 935 | 936 | if (this.defined && !this.defineEmitted) { 937 | this.defineEmitted = true; 938 | this.emit('defined', this.exports); 939 | this.defineEmitComplete = true; 940 | } 941 | 942 | } 943 | }, 944 | 945 | callPlugin: function () { 946 | var map = this.map, 947 | id = map.id, 948 | //Map already normalized the prefix. 949 | pluginMap = makeModuleMap(map.prefix); 950 | 951 | //Mark this as a dependency for this plugin, so it 952 | //can be traced for cycles. 953 | this.depMaps.push(pluginMap); 954 | 955 | on(pluginMap, 'defined', bind(this, function (plugin) { 956 | var load, normalizedMap, normalizedMod, 957 | bundleId = getOwn(bundlesMap, this.map.id), 958 | name = this.map.name, 959 | parentName = this.map.parentMap ? this.map.parentMap.name : null, 960 | localRequire = context.makeRequire(map.parentMap, { 961 | enableBuildCallback: true 962 | }); 963 | 964 | //If current map is not normalized, wait for that 965 | //normalized name to load instead of continuing. 966 | if (this.map.unnormalized) { 967 | //Normalize the ID if the plugin allows it. 968 | if (plugin.normalize) { 969 | name = plugin.normalize(name, function (name) { 970 | return normalize(name, parentName, true); 971 | }) || ''; 972 | } 973 | 974 | //prefix and name should already be normalized, no need 975 | //for applying map config again either. 976 | normalizedMap = makeModuleMap(map.prefix + '!' + name, 977 | this.map.parentMap, 978 | true); 979 | on(normalizedMap, 980 | 'defined', bind(this, function (value) { 981 | this.map.normalizedMap = normalizedMap; 982 | this.init([], function () { return value; }, null, { 983 | enabled: true, 984 | ignore: true 985 | }); 986 | })); 987 | 988 | normalizedMod = getOwn(registry, normalizedMap.id); 989 | if (normalizedMod) { 990 | //Mark this as a dependency for this plugin, so it 991 | //can be traced for cycles. 992 | this.depMaps.push(normalizedMap); 993 | 994 | if (this.events.error) { 995 | normalizedMod.on('error', bind(this, function (err) { 996 | this.emit('error', err); 997 | })); 998 | } 999 | normalizedMod.enable(); 1000 | } 1001 | 1002 | return; 1003 | } 1004 | 1005 | //If a paths config, then just load that file instead to 1006 | //resolve the plugin, as it is built into that paths layer. 1007 | if (bundleId) { 1008 | this.map.url = context.nameToUrl(bundleId); 1009 | this.load(); 1010 | return; 1011 | } 1012 | 1013 | load = bind(this, function (value) { 1014 | this.init([], function () { return value; }, null, { 1015 | enabled: true 1016 | }); 1017 | }); 1018 | 1019 | load.error = bind(this, function (err) { 1020 | this.inited = true; 1021 | this.error = err; 1022 | err.requireModules = [id]; 1023 | 1024 | //Remove temp unnormalized modules for this module, 1025 | //since they will never be resolved otherwise now. 1026 | eachProp(registry, function (mod) { 1027 | if (mod.map.id.indexOf(id + '_unnormalized') === 0) { 1028 | cleanRegistry(mod.map.id); 1029 | } 1030 | }); 1031 | 1032 | onError(err); 1033 | }); 1034 | 1035 | //Allow plugins to load other code without having to know the 1036 | //context or how to 'complete' the load. 1037 | load.fromText = bind(this, function (text, textAlt) { 1038 | /*jslint evil: true */ 1039 | var moduleName = map.name, 1040 | moduleMap = makeModuleMap(moduleName), 1041 | hasInteractive = useInteractive; 1042 | 1043 | //As of 2.1.0, support just passing the text, to reinforce 1044 | //fromText only being called once per resource. Still 1045 | //support old style of passing moduleName but discard 1046 | //that moduleName in favor of the internal ref. 1047 | if (textAlt) { 1048 | text = textAlt; 1049 | } 1050 | 1051 | //Turn off interactive script matching for IE for any define 1052 | //calls in the text, then turn it back on at the end. 1053 | if (hasInteractive) { 1054 | useInteractive = false; 1055 | } 1056 | 1057 | //Prime the system by creating a module instance for 1058 | //it. 1059 | getModule(moduleMap); 1060 | 1061 | //Transfer any config to this other module. 1062 | if (hasProp(config.config, id)) { 1063 | config.config[moduleName] = config.config[id]; 1064 | } 1065 | 1066 | try { 1067 | req.exec(text); 1068 | } catch (e) { 1069 | return onError(makeError('fromtexteval', 1070 | 'fromText eval for ' + id + 1071 | ' failed: ' + e, 1072 | e, 1073 | [id])); 1074 | } 1075 | 1076 | if (hasInteractive) { 1077 | useInteractive = true; 1078 | } 1079 | 1080 | //Mark this as a dependency for the plugin 1081 | //resource 1082 | this.depMaps.push(moduleMap); 1083 | 1084 | //Support anonymous modules. 1085 | context.completeLoad(moduleName); 1086 | 1087 | //Bind the value of that module to the value for this 1088 | //resource ID. 1089 | localRequire([moduleName], load); 1090 | }); 1091 | 1092 | //Use parentName here since the plugin's name is not reliable, 1093 | //could be some weird string with no path that actually wants to 1094 | //reference the parentName's path. 1095 | plugin.load(map.name, localRequire, load, config); 1096 | })); 1097 | 1098 | context.enable(pluginMap, this); 1099 | this.pluginMaps[pluginMap.id] = pluginMap; 1100 | }, 1101 | 1102 | enable: function () { 1103 | enabledRegistry[this.map.id] = this; 1104 | this.enabled = true; 1105 | 1106 | //Set flag mentioning that the module is enabling, 1107 | //so that immediate calls to the defined callbacks 1108 | //for dependencies do not trigger inadvertent load 1109 | //with the depCount still being zero. 1110 | this.enabling = true; 1111 | 1112 | //Enable each dependency 1113 | each(this.depMaps, bind(this, function (depMap, i) { 1114 | var id, mod, handler; 1115 | 1116 | if (typeof depMap === 'string') { 1117 | //Dependency needs to be converted to a depMap 1118 | //and wired up to this module. 1119 | depMap = makeModuleMap(depMap, 1120 | (this.map.isDefine ? this.map : this.map.parentMap), 1121 | false, 1122 | !this.skipMap); 1123 | this.depMaps[i] = depMap; 1124 | 1125 | handler = getOwn(handlers, depMap.id); 1126 | 1127 | if (handler) { 1128 | this.depExports[i] = handler(this); 1129 | return; 1130 | } 1131 | 1132 | this.depCount += 1; 1133 | 1134 | on(depMap, 'defined', bind(this, function (depExports) { 1135 | if (this.undefed) { 1136 | return; 1137 | } 1138 | this.defineDep(i, depExports); 1139 | this.check(); 1140 | })); 1141 | 1142 | if (this.errback) { 1143 | on(depMap, 'error', bind(this, this.errback)); 1144 | } else if (this.events.error) { 1145 | // No direct errback on this module, but something 1146 | // else is listening for errors, so be sure to 1147 | // propagate the error correctly. 1148 | on(depMap, 'error', bind(this, function(err) { 1149 | this.emit('error', err); 1150 | })); 1151 | } 1152 | } 1153 | 1154 | id = depMap.id; 1155 | mod = registry[id]; 1156 | 1157 | //Skip special modules like 'require', 'exports', 'module' 1158 | //Also, don't call enable if it is already enabled, 1159 | //important in circular dependency cases. 1160 | if (!hasProp(handlers, id) && mod && !mod.enabled) { 1161 | context.enable(depMap, this); 1162 | } 1163 | })); 1164 | 1165 | //Enable each plugin that is used in 1166 | //a dependency 1167 | eachProp(this.pluginMaps, bind(this, function (pluginMap) { 1168 | var mod = getOwn(registry, pluginMap.id); 1169 | if (mod && !mod.enabled) { 1170 | context.enable(pluginMap, this); 1171 | } 1172 | })); 1173 | 1174 | this.enabling = false; 1175 | 1176 | this.check(); 1177 | }, 1178 | 1179 | on: function (name, cb) { 1180 | var cbs = this.events[name]; 1181 | if (!cbs) { 1182 | cbs = this.events[name] = []; 1183 | } 1184 | cbs.push(cb); 1185 | }, 1186 | 1187 | emit: function (name, evt) { 1188 | each(this.events[name], function (cb) { 1189 | cb(evt); 1190 | }); 1191 | if (name === 'error') { 1192 | //Now that the error handler was triggered, remove 1193 | //the listeners, since this broken Module instance 1194 | //can stay around for a while in the registry. 1195 | delete this.events[name]; 1196 | } 1197 | } 1198 | }; 1199 | 1200 | function callGetModule(args) { 1201 | //Skip modules already defined. 1202 | if (!hasProp(defined, args[0])) { 1203 | getModule(makeModuleMap(args[0], null, true)).init(args[1], args[2]); 1204 | } 1205 | } 1206 | 1207 | function removeListener(node, func, name, ieName) { 1208 | //Favor detachEvent because of IE9 1209 | //issue, see attachEvent/addEventListener comment elsewhere 1210 | //in this file. 1211 | if (node.detachEvent && !isOpera) { 1212 | //Probably IE. If not it will throw an error, which will be 1213 | //useful to know. 1214 | if (ieName) { 1215 | node.detachEvent(ieName, func); 1216 | } 1217 | } else { 1218 | node.removeEventListener(name, func, false); 1219 | } 1220 | } 1221 | 1222 | /** 1223 | * Given an event from a script node, get the requirejs info from it, 1224 | * and then removes the event listeners on the node. 1225 | * @param {Event} evt 1226 | * @returns {Object} 1227 | */ 1228 | function getScriptData(evt) { 1229 | //Using currentTarget instead of target for Firefox 2.0's sake. Not 1230 | //all old browsers will be supported, but this one was easy enough 1231 | //to support and still makes sense. 1232 | var node = evt.currentTarget || evt.srcElement; 1233 | 1234 | //Remove the listeners once here. 1235 | removeListener(node, context.onScriptLoad, 'load', 'onreadystatechange'); 1236 | removeListener(node, context.onScriptError, 'error'); 1237 | 1238 | return { 1239 | node: node, 1240 | id: node && node.getAttribute('data-requiremodule') 1241 | }; 1242 | } 1243 | 1244 | function intakeDefines() { 1245 | var args; 1246 | 1247 | //Any defined modules in the global queue, intake them now. 1248 | takeGlobalQueue(); 1249 | 1250 | //Make sure any remaining defQueue items get properly processed. 1251 | while (defQueue.length) { 1252 | args = defQueue.shift(); 1253 | if (args[0] === null) { 1254 | return onError(makeError('mismatch', 'Mismatched anonymous define() module: ' + 1255 | args[args.length - 1])); 1256 | } else { 1257 | //args are id, deps, factory. Should be normalized by the 1258 | //define() function. 1259 | callGetModule(args); 1260 | } 1261 | } 1262 | context.defQueueMap = {}; 1263 | } 1264 | 1265 | context = { 1266 | config: config, 1267 | contextName: contextName, 1268 | registry: registry, 1269 | defined: defined, 1270 | urlFetched: urlFetched, 1271 | defQueue: defQueue, 1272 | defQueueMap: {}, 1273 | Module: Module, 1274 | makeModuleMap: makeModuleMap, 1275 | nextTick: req.nextTick, 1276 | onError: onError, 1277 | 1278 | /** 1279 | * Set a configuration for the context. 1280 | * @param {Object} cfg config object to integrate. 1281 | */ 1282 | configure: function (cfg) { 1283 | //Make sure the baseUrl ends in a slash. 1284 | if (cfg.baseUrl) { 1285 | if (cfg.baseUrl.charAt(cfg.baseUrl.length - 1) !== '/') { 1286 | cfg.baseUrl += '/'; 1287 | } 1288 | } 1289 | 1290 | // Convert old style urlArgs string to a function. 1291 | if (typeof cfg.urlArgs === 'string') { 1292 | var urlArgs = cfg.urlArgs; 1293 | cfg.urlArgs = function(id, url) { 1294 | return (url.indexOf('?') === -1 ? '?' : '&') + urlArgs; 1295 | }; 1296 | } 1297 | 1298 | //Save off the paths since they require special processing, 1299 | //they are additive. 1300 | var shim = config.shim, 1301 | objs = { 1302 | paths: true, 1303 | bundles: true, 1304 | config: true, 1305 | map: true 1306 | }; 1307 | 1308 | eachProp(cfg, function (value, prop) { 1309 | if (objs[prop]) { 1310 | if (!config[prop]) { 1311 | config[prop] = {}; 1312 | } 1313 | mixin(config[prop], value, true, true); 1314 | } else { 1315 | config[prop] = value; 1316 | } 1317 | }); 1318 | 1319 | //Reverse map the bundles 1320 | if (cfg.bundles) { 1321 | eachProp(cfg.bundles, function (value, prop) { 1322 | each(value, function (v) { 1323 | if (v !== prop) { 1324 | bundlesMap[v] = prop; 1325 | } 1326 | }); 1327 | }); 1328 | } 1329 | 1330 | //Merge shim 1331 | if (cfg.shim) { 1332 | eachProp(cfg.shim, function (value, id) { 1333 | //Normalize the structure 1334 | if (isArray(value)) { 1335 | value = { 1336 | deps: value 1337 | }; 1338 | } 1339 | if ((value.exports || value.init) && !value.exportsFn) { 1340 | value.exportsFn = context.makeShimExports(value); 1341 | } 1342 | shim[id] = value; 1343 | }); 1344 | config.shim = shim; 1345 | } 1346 | 1347 | //Adjust packages if necessary. 1348 | if (cfg.packages) { 1349 | each(cfg.packages, function (pkgObj) { 1350 | var location, name; 1351 | 1352 | pkgObj = typeof pkgObj === 'string' ? {name: pkgObj} : pkgObj; 1353 | 1354 | name = pkgObj.name; 1355 | location = pkgObj.location; 1356 | if (location) { 1357 | config.paths[name] = pkgObj.location; 1358 | } 1359 | 1360 | //Save pointer to main module ID for pkg name. 1361 | //Remove leading dot in main, so main paths are normalized, 1362 | //and remove any trailing .js, since different package 1363 | //envs have different conventions: some use a module name, 1364 | //some use a file name. 1365 | config.pkgs[name] = pkgObj.name + '/' + (pkgObj.main || 'main') 1366 | .replace(currDirRegExp, '') 1367 | .replace(jsSuffixRegExp, ''); 1368 | }); 1369 | } 1370 | 1371 | //If there are any "waiting to execute" modules in the registry, 1372 | //update the maps for them, since their info, like URLs to load, 1373 | //may have changed. 1374 | eachProp(registry, function (mod, id) { 1375 | //If module already has init called, since it is too 1376 | //late to modify them, and ignore unnormalized ones 1377 | //since they are transient. 1378 | if (!mod.inited && !mod.map.unnormalized) { 1379 | mod.map = makeModuleMap(id, null, true); 1380 | } 1381 | }); 1382 | 1383 | //If a deps array or a config callback is specified, then call 1384 | //require with those args. This is useful when require is defined as a 1385 | //config object before require.js is loaded. 1386 | if (cfg.deps || cfg.callback) { 1387 | context.require(cfg.deps || [], cfg.callback); 1388 | } 1389 | }, 1390 | 1391 | makeShimExports: function (value) { 1392 | function fn() { 1393 | var ret; 1394 | if (value.init) { 1395 | ret = value.init.apply(global, arguments); 1396 | } 1397 | return ret || (value.exports && getGlobal(value.exports)); 1398 | } 1399 | return fn; 1400 | }, 1401 | 1402 | makeRequire: function (relMap, options) { 1403 | options = options || {}; 1404 | 1405 | function localRequire(deps, callback, errback) { 1406 | var id, map, requireMod; 1407 | 1408 | if (options.enableBuildCallback && callback && isFunction(callback)) { 1409 | callback.__requireJsBuild = true; 1410 | } 1411 | 1412 | if (typeof deps === 'string') { 1413 | if (isFunction(callback)) { 1414 | //Invalid call 1415 | return onError(makeError('requireargs', 'Invalid require call'), errback); 1416 | } 1417 | 1418 | //If require|exports|module are requested, get the 1419 | //value for them from the special handlers. Caveat: 1420 | //this only works while module is being defined. 1421 | if (relMap && hasProp(handlers, deps)) { 1422 | return handlers[deps](registry[relMap.id]); 1423 | } 1424 | 1425 | //Synchronous access to one module. If require.get is 1426 | //available (as in the Node adapter), prefer that. 1427 | if (req.get) { 1428 | return req.get(context, deps, relMap, localRequire); 1429 | } 1430 | 1431 | //Normalize module name, if it contains . or .. 1432 | map = makeModuleMap(deps, relMap, false, true); 1433 | id = map.id; 1434 | 1435 | if (!hasProp(defined, id)) { 1436 | return onError(makeError('notloaded', 'Module name "' + 1437 | id + 1438 | '" has not been loaded yet for context: ' + 1439 | contextName + 1440 | (relMap ? '' : '. Use require([])'))); 1441 | } 1442 | return defined[id]; 1443 | } 1444 | 1445 | //Grab defines waiting in the global queue. 1446 | intakeDefines(); 1447 | 1448 | //Mark all the dependencies as needing to be loaded. 1449 | context.nextTick(function () { 1450 | //Some defines could have been added since the 1451 | //require call, collect them. 1452 | intakeDefines(); 1453 | 1454 | requireMod = getModule(makeModuleMap(null, relMap)); 1455 | 1456 | //Store if map config should be applied to this require 1457 | //call for dependencies. 1458 | requireMod.skipMap = options.skipMap; 1459 | 1460 | requireMod.init(deps, callback, errback, { 1461 | enabled: true 1462 | }); 1463 | 1464 | checkLoaded(); 1465 | }); 1466 | 1467 | return localRequire; 1468 | } 1469 | 1470 | mixin(localRequire, { 1471 | isBrowser: isBrowser, 1472 | 1473 | /** 1474 | * Converts a module name + .extension into an URL path. 1475 | * *Requires* the use of a module name. It does not support using 1476 | * plain URLs like nameToUrl. 1477 | */ 1478 | toUrl: function (moduleNamePlusExt) { 1479 | var ext, 1480 | index = moduleNamePlusExt.lastIndexOf('.'), 1481 | segment = moduleNamePlusExt.split('/')[0], 1482 | isRelative = segment === '.' || segment === '..'; 1483 | 1484 | //Have a file extension alias, and it is not the 1485 | //dots from a relative path. 1486 | if (index !== -1 && (!isRelative || index > 1)) { 1487 | ext = moduleNamePlusExt.substring(index, moduleNamePlusExt.length); 1488 | moduleNamePlusExt = moduleNamePlusExt.substring(0, index); 1489 | } 1490 | 1491 | return context.nameToUrl(normalize(moduleNamePlusExt, 1492 | relMap && relMap.id, true), ext, true); 1493 | }, 1494 | 1495 | defined: function (id) { 1496 | return hasProp(defined, makeModuleMap(id, relMap, false, true).id); 1497 | }, 1498 | 1499 | specified: function (id) { 1500 | id = makeModuleMap(id, relMap, false, true).id; 1501 | return hasProp(defined, id) || hasProp(registry, id); 1502 | } 1503 | }); 1504 | 1505 | //Only allow undef on top level require calls 1506 | if (!relMap) { 1507 | localRequire.undef = function (id) { 1508 | //Bind any waiting define() calls to this context, 1509 | //fix for #408 1510 | takeGlobalQueue(); 1511 | 1512 | var map = makeModuleMap(id, relMap, true), 1513 | mod = getOwn(registry, id); 1514 | 1515 | mod.undefed = true; 1516 | removeScript(id); 1517 | 1518 | delete defined[id]; 1519 | delete urlFetched[map.url]; 1520 | delete undefEvents[id]; 1521 | 1522 | //Clean queued defines too. Go backwards 1523 | //in array so that the splices do not 1524 | //mess up the iteration. 1525 | eachReverse(defQueue, function(args, i) { 1526 | if (args[0] === id) { 1527 | defQueue.splice(i, 1); 1528 | } 1529 | }); 1530 | delete context.defQueueMap[id]; 1531 | 1532 | if (mod) { 1533 | //Hold on to listeners in case the 1534 | //module will be attempted to be reloaded 1535 | //using a different config. 1536 | if (mod.events.defined) { 1537 | undefEvents[id] = mod.events; 1538 | } 1539 | 1540 | cleanRegistry(id); 1541 | } 1542 | }; 1543 | } 1544 | 1545 | return localRequire; 1546 | }, 1547 | 1548 | /** 1549 | * Called to enable a module if it is still in the registry 1550 | * awaiting enablement. A second arg, parent, the parent module, 1551 | * is passed in for context, when this method is overridden by 1552 | * the optimizer. Not shown here to keep code compact. 1553 | */ 1554 | enable: function (depMap) { 1555 | var mod = getOwn(registry, depMap.id); 1556 | if (mod) { 1557 | getModule(depMap).enable(); 1558 | } 1559 | }, 1560 | 1561 | /** 1562 | * Internal method used by environment adapters to complete a load event. 1563 | * A load event could be a script load or just a load pass from a synchronous 1564 | * load call. 1565 | * @param {String} moduleName the name of the module to potentially complete. 1566 | */ 1567 | completeLoad: function (moduleName) { 1568 | var found, args, mod, 1569 | shim = getOwn(config.shim, moduleName) || {}, 1570 | shExports = shim.exports; 1571 | 1572 | takeGlobalQueue(); 1573 | 1574 | while (defQueue.length) { 1575 | args = defQueue.shift(); 1576 | if (args[0] === null) { 1577 | args[0] = moduleName; 1578 | //If already found an anonymous module and bound it 1579 | //to this name, then this is some other anon module 1580 | //waiting for its completeLoad to fire. 1581 | if (found) { 1582 | break; 1583 | } 1584 | found = true; 1585 | } else if (args[0] === moduleName) { 1586 | //Found matching define call for this script! 1587 | found = true; 1588 | } 1589 | 1590 | callGetModule(args); 1591 | } 1592 | context.defQueueMap = {}; 1593 | 1594 | //Do this after the cycle of callGetModule in case the result 1595 | //of those calls/init calls changes the registry. 1596 | mod = getOwn(registry, moduleName); 1597 | 1598 | if (!found && !hasProp(defined, moduleName) && mod && !mod.inited) { 1599 | if (config.enforceDefine && (!shExports || !getGlobal(shExports))) { 1600 | if (hasPathFallback(moduleName)) { 1601 | return; 1602 | } else { 1603 | return onError(makeError('nodefine', 1604 | 'No define call for ' + moduleName, 1605 | null, 1606 | [moduleName])); 1607 | } 1608 | } else { 1609 | //A script that does not call define(), so just simulate 1610 | //the call for it. 1611 | callGetModule([moduleName, (shim.deps || []), shim.exportsFn]); 1612 | } 1613 | } 1614 | 1615 | checkLoaded(); 1616 | }, 1617 | 1618 | /** 1619 | * Converts a module name to a file path. Supports cases where 1620 | * moduleName may actually be just an URL. 1621 | * Note that it **does not** call normalize on the moduleName, 1622 | * it is assumed to have already been normalized. This is an 1623 | * internal API, not a public one. Use toUrl for the public API. 1624 | */ 1625 | nameToUrl: function (moduleName, ext, skipExt) { 1626 | var paths, syms, i, parentModule, url, 1627 | parentPath, bundleId, 1628 | pkgMain = getOwn(config.pkgs, moduleName); 1629 | 1630 | if (pkgMain) { 1631 | moduleName = pkgMain; 1632 | } 1633 | 1634 | bundleId = getOwn(bundlesMap, moduleName); 1635 | 1636 | if (bundleId) { 1637 | return context.nameToUrl(bundleId, ext, skipExt); 1638 | } 1639 | 1640 | //If a colon is in the URL, it indicates a protocol is used and it is just 1641 | //an URL to a file, or if it starts with a slash, contains a query arg (i.e. ?) 1642 | //or ends with .js, then assume the user meant to use an url and not a module id. 1643 | //The slash is important for protocol-less URLs as well as full paths. 1644 | if (req.jsExtRegExp.test(moduleName)) { 1645 | //Just a plain path, not module name lookup, so just return it. 1646 | //Add extension if it is included. This is a bit wonky, only non-.js things pass 1647 | //an extension, this method probably needs to be reworked. 1648 | url = moduleName + (ext || ''); 1649 | } else { 1650 | //A module that needs to be converted to a path. 1651 | paths = config.paths; 1652 | 1653 | syms = moduleName.split('/'); 1654 | //For each module name segment, see if there is a path 1655 | //registered for it. Start with most specific name 1656 | //and work up from it. 1657 | for (i = syms.length; i > 0; i -= 1) { 1658 | parentModule = syms.slice(0, i).join('/'); 1659 | 1660 | parentPath = getOwn(paths, parentModule); 1661 | if (parentPath) { 1662 | //If an array, it means there are a few choices, 1663 | //Choose the one that is desired 1664 | if (isArray(parentPath)) { 1665 | parentPath = parentPath[0]; 1666 | } 1667 | syms.splice(0, i, parentPath); 1668 | break; 1669 | } 1670 | } 1671 | 1672 | //Join the path parts together, then figure out if baseUrl is needed. 1673 | url = syms.join('/'); 1674 | url += (ext || (/^data\:|^blob\:|\?/.test(url) || skipExt ? '' : '.js')); 1675 | url = (url.charAt(0) === '/' || url.match(/^[\w\+\.\-]+:/) ? '' : config.baseUrl) + url; 1676 | } 1677 | 1678 | return config.urlArgs && !/^blob\:/.test(url) ? 1679 | url + config.urlArgs(moduleName, url) : url; 1680 | }, 1681 | 1682 | //Delegates to req.load. Broken out as a separate function to 1683 | //allow overriding in the optimizer. 1684 | load: function (id, url) { 1685 | req.load(context, id, url); 1686 | }, 1687 | 1688 | /** 1689 | * Executes a module callback function. Broken out as a separate function 1690 | * solely to allow the build system to sequence the files in the built 1691 | * layer in the right sequence. 1692 | * 1693 | * @private 1694 | */ 1695 | execCb: function (name, callback, args, exports) { 1696 | return callback.apply(exports, args); 1697 | }, 1698 | 1699 | /** 1700 | * callback for script loads, used to check status of loading. 1701 | * 1702 | * @param {Event} evt the event from the browser for the script 1703 | * that was loaded. 1704 | */ 1705 | onScriptLoad: function (evt) { 1706 | //Using currentTarget instead of target for Firefox 2.0's sake. Not 1707 | //all old browsers will be supported, but this one was easy enough 1708 | //to support and still makes sense. 1709 | if (evt.type === 'load' || 1710 | (readyRegExp.test((evt.currentTarget || evt.srcElement).readyState))) { 1711 | //Reset interactive script so a script node is not held onto for 1712 | //to long. 1713 | interactiveScript = null; 1714 | 1715 | //Pull out the name of the module and the context. 1716 | var data = getScriptData(evt); 1717 | context.completeLoad(data.id); 1718 | } 1719 | }, 1720 | 1721 | /** 1722 | * Callback for script errors. 1723 | */ 1724 | onScriptError: function (evt) { 1725 | var data = getScriptData(evt); 1726 | if (!hasPathFallback(data.id)) { 1727 | var parents = []; 1728 | eachProp(registry, function(value, key) { 1729 | if (key.indexOf('_@r') !== 0) { 1730 | each(value.depMaps, function(depMap) { 1731 | if (depMap.id === data.id) { 1732 | parents.push(key); 1733 | return true; 1734 | } 1735 | }); 1736 | } 1737 | }); 1738 | return onError(makeError('scripterror', 'Script error for "' + data.id + 1739 | (parents.length ? 1740 | '", needed by: ' + parents.join(', ') : 1741 | '"'), evt, [data.id])); 1742 | } 1743 | } 1744 | }; 1745 | 1746 | context.require = context.makeRequire(); 1747 | return context; 1748 | } 1749 | 1750 | /** 1751 | * Main entry point. 1752 | * 1753 | * If the only argument to require is a string, then the module that 1754 | * is represented by that string is fetched for the appropriate context. 1755 | * 1756 | * If the first argument is an array, then it will be treated as an array 1757 | * of dependency string names to fetch. An optional function callback can 1758 | * be specified to execute when all of those dependencies are available. 1759 | * 1760 | * Make a local req variable to help Caja compliance (it assumes things 1761 | * on a require that are not standardized), and to give a short 1762 | * name for minification/local scope use. 1763 | */ 1764 | req = requirejs = function (deps, callback, errback, optional) { 1765 | 1766 | //Find the right context, use default 1767 | var context, config, 1768 | contextName = defContextName; 1769 | 1770 | // Determine if have config object in the call. 1771 | if (!isArray(deps) && typeof deps !== 'string') { 1772 | // deps is a config object 1773 | config = deps; 1774 | if (isArray(callback)) { 1775 | // Adjust args if there are dependencies 1776 | deps = callback; 1777 | callback = errback; 1778 | errback = optional; 1779 | } else { 1780 | deps = []; 1781 | } 1782 | } 1783 | 1784 | if (config && config.context) { 1785 | contextName = config.context; 1786 | } 1787 | 1788 | context = getOwn(contexts, contextName); 1789 | if (!context) { 1790 | context = contexts[contextName] = req.s.newContext(contextName); 1791 | } 1792 | 1793 | if (config) { 1794 | context.configure(config); 1795 | } 1796 | 1797 | return context.require(deps, callback, errback); 1798 | }; 1799 | 1800 | /** 1801 | * Support require.config() to make it easier to cooperate with other 1802 | * AMD loaders on globally agreed names. 1803 | */ 1804 | req.config = function (config) { 1805 | return req(config); 1806 | }; 1807 | 1808 | /** 1809 | * Execute something after the current tick 1810 | * of the event loop. Override for other envs 1811 | * that have a better solution than setTimeout. 1812 | * @param {Function} fn function to execute later. 1813 | */ 1814 | req.nextTick = typeof setTimeout !== 'undefined' ? function (fn) { 1815 | setTimeout(fn, 4); 1816 | } : function (fn) { fn(); }; 1817 | 1818 | /** 1819 | * Export require as a global, but only if it does not already exist. 1820 | */ 1821 | if (!require) { 1822 | require = req; 1823 | } 1824 | 1825 | req.version = version; 1826 | 1827 | //Used to filter out dependencies that are already paths. 1828 | req.jsExtRegExp = /^\/|:|\?|\.js$/; 1829 | req.isBrowser = isBrowser; 1830 | s = req.s = { 1831 | contexts: contexts, 1832 | newContext: newContext 1833 | }; 1834 | 1835 | //Create default context. 1836 | req({}); 1837 | 1838 | //Exports some context-sensitive methods on global require. 1839 | each([ 1840 | 'toUrl', 1841 | 'undef', 1842 | 'defined', 1843 | 'specified' 1844 | ], function (prop) { 1845 | //Reference from contexts instead of early binding to default context, 1846 | //so that during builds, the latest instance of the default context 1847 | //with its config gets used. 1848 | req[prop] = function () { 1849 | var ctx = contexts[defContextName]; 1850 | return ctx.require[prop].apply(ctx, arguments); 1851 | }; 1852 | }); 1853 | 1854 | if (isBrowser) { 1855 | head = s.head = document.getElementsByTagName('head')[0]; 1856 | //If BASE tag is in play, using appendChild is a problem for IE6. 1857 | //When that browser dies, this can be removed. Details in this jQuery bug: 1858 | //http://dev.jquery.com/ticket/2709 1859 | baseElement = document.getElementsByTagName('base')[0]; 1860 | if (baseElement) { 1861 | head = s.head = baseElement.parentNode; 1862 | } 1863 | } 1864 | 1865 | /** 1866 | * Any errors that require explicitly generates will be passed to this 1867 | * function. Intercept/override it if you want custom error handling. 1868 | * @param {Error} err the error object. 1869 | */ 1870 | req.onError = defaultOnError; 1871 | 1872 | /** 1873 | * Creates the node for the load command. Only used in browser envs. 1874 | */ 1875 | req.createNode = function (config, moduleName, url) { 1876 | var node = config.xhtml ? 1877 | document.createElementNS('http://www.w3.org/1999/xhtml', 'html:script') : 1878 | document.createElement('script'); 1879 | node.type = config.scriptType || 'text/javascript'; 1880 | node.charset = 'utf-8'; 1881 | node.async = true; 1882 | return node; 1883 | }; 1884 | 1885 | /** 1886 | * Does the request to load a module for the browser case. 1887 | * Make this a separate function to allow other environments 1888 | * to override it. 1889 | * 1890 | * @param {Object} context the require context to find state. 1891 | * @param {String} moduleName the name of the module. 1892 | * @param {Object} url the URL to the module. 1893 | */ 1894 | req.load = function (context, moduleName, url) { 1895 | var config = (context && context.config) || {}, 1896 | node; 1897 | if (isBrowser) { 1898 | //In the browser so use a script tag 1899 | node = req.createNode(config, moduleName, url); 1900 | 1901 | node.setAttribute('data-requirecontext', context.contextName); 1902 | node.setAttribute('data-requiremodule', moduleName); 1903 | 1904 | //Set up load listener. Test attachEvent first because IE9 has 1905 | //a subtle issue in its addEventListener and script onload firings 1906 | //that do not match the behavior of all other browsers with 1907 | //addEventListener support, which fire the onload event for a 1908 | //script right after the script execution. See: 1909 | //https://connect.microsoft.com/IE/feedback/details/648057/script-onload-event-is-not-fired-immediately-after-script-execution 1910 | //UNFORTUNATELY Opera implements attachEvent but does not follow the script 1911 | //script execution mode. 1912 | if (node.attachEvent && 1913 | //Check if node.attachEvent is artificially added by custom script or 1914 | //natively supported by browser 1915 | //read https://github.com/requirejs/requirejs/issues/187 1916 | //if we can NOT find [native code] then it must NOT natively supported. 1917 | //in IE8, node.attachEvent does not have toString() 1918 | //Note the test for "[native code" with no closing brace, see: 1919 | //https://github.com/requirejs/requirejs/issues/273 1920 | !(node.attachEvent.toString && node.attachEvent.toString().indexOf('[native code') < 0) && 1921 | !isOpera) { 1922 | //Probably IE. IE (at least 6-8) do not fire 1923 | //script onload right after executing the script, so 1924 | //we cannot tie the anonymous define call to a name. 1925 | //However, IE reports the script as being in 'interactive' 1926 | //readyState at the time of the define call. 1927 | useInteractive = true; 1928 | 1929 | node.attachEvent('onreadystatechange', context.onScriptLoad); 1930 | //It would be great to add an error handler here to catch 1931 | //404s in IE9+. However, onreadystatechange will fire before 1932 | //the error handler, so that does not help. If addEventListener 1933 | //is used, then IE will fire error before load, but we cannot 1934 | //use that pathway given the connect.microsoft.com issue 1935 | //mentioned above about not doing the 'script execute, 1936 | //then fire the script load event listener before execute 1937 | //next script' that other browsers do. 1938 | //Best hope: IE10 fixes the issues, 1939 | //and then destroys all installs of IE 6-9. 1940 | //node.attachEvent('onerror', context.onScriptError); 1941 | } else { 1942 | node.addEventListener('load', context.onScriptLoad, false); 1943 | node.addEventListener('error', context.onScriptError, false); 1944 | } 1945 | node.src = url; 1946 | 1947 | //Calling onNodeCreated after all properties on the node have been 1948 | //set, but before it is placed in the DOM. 1949 | if (config.onNodeCreated) { 1950 | config.onNodeCreated(node, config, moduleName, url); 1951 | } 1952 | 1953 | //For some cache cases in IE 6-8, the script executes before the end 1954 | //of the appendChild execution, so to tie an anonymous define 1955 | //call to the module name (which is stored on the node), hold on 1956 | //to a reference to this node, but clear after the DOM insertion. 1957 | currentlyAddingScript = node; 1958 | if (baseElement) { 1959 | head.insertBefore(node, baseElement); 1960 | } else { 1961 | head.appendChild(node); 1962 | } 1963 | currentlyAddingScript = null; 1964 | 1965 | return node; 1966 | } else if (isWebWorker) { 1967 | try { 1968 | //In a web worker, use importScripts. This is not a very 1969 | //efficient use of importScripts, importScripts will block until 1970 | //its script is downloaded and evaluated. However, if web workers 1971 | //are in play, the expectation is that a build has been done so 1972 | //that only one script needs to be loaded anyway. This may need 1973 | //to be reevaluated if other use cases become common. 1974 | 1975 | // Post a task to the event loop to work around a bug in WebKit 1976 | // where the worker gets garbage-collected after calling 1977 | // importScripts(): https://webkit.org/b/153317 1978 | setTimeout(function() {}, 0); 1979 | importScripts(url); 1980 | 1981 | //Account for anonymous modules 1982 | context.completeLoad(moduleName); 1983 | } catch (e) { 1984 | context.onError(makeError('importscripts', 1985 | 'importScripts failed for ' + 1986 | moduleName + ' at ' + url, 1987 | e, 1988 | [moduleName])); 1989 | } 1990 | } 1991 | }; 1992 | 1993 | function getInteractiveScript() { 1994 | if (interactiveScript && interactiveScript.readyState === 'interactive') { 1995 | return interactiveScript; 1996 | } 1997 | 1998 | eachReverse(scripts(), function (script) { 1999 | if (script.readyState === 'interactive') { 2000 | return (interactiveScript = script); 2001 | } 2002 | }); 2003 | return interactiveScript; 2004 | } 2005 | 2006 | //Look for a data-main script attribute, which could also adjust the baseUrl. 2007 | if (isBrowser && !cfg.skipDataMain) { 2008 | //Figure out baseUrl. Get it from the script tag with require.js in it. 2009 | eachReverse(scripts(), function (script) { 2010 | //Set the 'head' where we can append children by 2011 | //using the script's parent. 2012 | if (!head) { 2013 | head = script.parentNode; 2014 | } 2015 | 2016 | //Look for a data-main attribute to set main script for the page 2017 | //to load. If it is there, the path to data main becomes the 2018 | //baseUrl, if it is not already set. 2019 | dataMain = script.getAttribute('data-main'); 2020 | if (dataMain) { 2021 | //Preserve dataMain in case it is a path (i.e. contains '?') 2022 | mainScript = dataMain; 2023 | 2024 | //Set final baseUrl if there is not already an explicit one, 2025 | //but only do so if the data-main value is not a loader plugin 2026 | //module ID. 2027 | if (!cfg.baseUrl && mainScript.indexOf('!') === -1) { 2028 | //Pull off the directory of data-main for use as the 2029 | //baseUrl. 2030 | src = mainScript.split('/'); 2031 | mainScript = src.pop(); 2032 | subPath = src.length ? src.join('/') + '/' : './'; 2033 | 2034 | cfg.baseUrl = subPath; 2035 | } 2036 | 2037 | //Strip off any trailing .js since mainScript is now 2038 | //like a module name. 2039 | mainScript = mainScript.replace(jsSuffixRegExp, ''); 2040 | 2041 | //If mainScript is still a path, fall back to dataMain 2042 | if (req.jsExtRegExp.test(mainScript)) { 2043 | mainScript = dataMain; 2044 | } 2045 | 2046 | //Put the data-main script in the files to load. 2047 | cfg.deps = cfg.deps ? cfg.deps.concat(mainScript) : [mainScript]; 2048 | 2049 | return true; 2050 | } 2051 | }); 2052 | } 2053 | 2054 | /** 2055 | * The function that handles definitions of modules. Differs from 2056 | * require() in that a string for the module should be the first argument, 2057 | * and the function to execute after dependencies are loaded should 2058 | * return a value to define the module corresponding to the first argument's 2059 | * name. 2060 | */ 2061 | define = function (name, deps, callback) { 2062 | var node, context; 2063 | 2064 | //Allow for anonymous modules 2065 | if (typeof name !== 'string') { 2066 | //Adjust args appropriately 2067 | callback = deps; 2068 | deps = name; 2069 | name = null; 2070 | } 2071 | 2072 | //This module may not have dependencies 2073 | if (!isArray(deps)) { 2074 | callback = deps; 2075 | deps = null; 2076 | } 2077 | 2078 | //If no name, and callback is a function, then figure out if it a 2079 | //CommonJS thing with dependencies. 2080 | if (!deps && isFunction(callback)) { 2081 | deps = []; 2082 | //Remove comments from the callback string, 2083 | //look for require calls, and pull them into the dependencies, 2084 | //but only if there are function args. 2085 | if (callback.length) { 2086 | callback 2087 | .toString() 2088 | .replace(commentRegExp, commentReplace) 2089 | .replace(cjsRequireRegExp, function (match, dep) { 2090 | deps.push(dep); 2091 | }); 2092 | 2093 | //May be a CommonJS thing even without require calls, but still 2094 | //could use exports, and module. Avoid doing exports and module 2095 | //work though if it just needs require. 2096 | //REQUIRES the function to expect the CommonJS variables in the 2097 | //order listed below. 2098 | deps = (callback.length === 1 ? ['require'] : ['require', 'exports', 'module']).concat(deps); 2099 | } 2100 | } 2101 | 2102 | //If in IE 6-8 and hit an anonymous define() call, do the interactive 2103 | //work. 2104 | if (useInteractive) { 2105 | node = currentlyAddingScript || getInteractiveScript(); 2106 | if (node) { 2107 | if (!name) { 2108 | name = node.getAttribute('data-requiremodule'); 2109 | } 2110 | context = contexts[node.getAttribute('data-requirecontext')]; 2111 | } 2112 | } 2113 | 2114 | //Always save off evaluating the def call until the script onload handler. 2115 | //This allows multiple modules to be in a file without prematurely 2116 | //tracing dependencies, and allows for anonymous module support, 2117 | //where the module name is not known until the script onload event 2118 | //occurs. If no context, use the global queue, and get it processed 2119 | //in the onscript load callback. 2120 | if (context) { 2121 | context.defQueue.push([name, deps, callback]); 2122 | context.defQueueMap[name] = true; 2123 | } else { 2124 | globalDefQueue.push([name, deps, callback]); 2125 | } 2126 | }; 2127 | 2128 | define.amd = { 2129 | jQuery: true 2130 | }; 2131 | 2132 | /** 2133 | * Executes the text. Normally just uses eval, but can be modified 2134 | * to use a better, environment-specific call. Only used for transpiling 2135 | * loader plugins, not for plain JS modules. 2136 | * @param {String} text the text to execute/evaluate. 2137 | */ 2138 | req.exec = function (text) { 2139 | /*jslint evil: true */ 2140 | return eval(text); 2141 | }; 2142 | 2143 | //Set up with config info. 2144 | req(cfg); 2145 | }(this, (typeof setTimeout === 'undefined' ? undefined : setTimeout))); 2146 | -------------------------------------------------------------------------------- /docs/packages/$sdk/dev_compiler/kernel/common/run.js: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file 2 | // for details. All rights reserved. Use of this source code is governed by a 3 | // BSD-style license that can be found in the LICENSE file. 4 | 5 | var fs = require('fs'); 6 | var vm = require('vm'); 7 | 8 | function __load(path) { 9 | var data = fs.readFileSync(path); 10 | var script = vm.createScript(data.toString(), path); 11 | script.runInThisContext(); 12 | } 13 | 14 | var args = process.argv.slice(2); 15 | var argc = args.length; 16 | 17 | for (var i = 0; i < argc-1; ++i) { 18 | __load(args[i]); 19 | } 20 | 21 | var main = vm.createScript(args[argc-1] + '.main()', 'main'); 22 | main.runInThisContext(); 23 | -------------------------------------------------------------------------------- /docs/packages/_fe_analyzer_shared/src/parser/parser.md: -------------------------------------------------------------------------------- 1 | 6 | 7 | # Uses of peek in the parser 8 | 9 | * In parseType, the parser uses peekAfterIfType to tell the difference 10 | between `id` and `id id`. 11 | 12 | * In parseSwitchCase, the parser uses peekPastLabels to select between case 13 | labels and statement labels. 14 | 15 | * The parser uses isGeneralizedFunctionType in parseType. 16 | 17 | * The parser uses isValidMethodTypeArguments in parseSend. 18 | -------------------------------------------------------------------------------- /docs/packages/analyzer/src/summary/format.fbs: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file 2 | // for details. All rights reserved. Use of this source code is governed by a 3 | // BSD-style license that can be found in the LICENSE file. 4 | // 5 | // This file has been automatically generated. Please do not edit it manually. 6 | // To regenerate the file, use the SDK script 7 | // "pkg/analyzer/tool/summary/generate.dart $IDL_FILE_PATH", 8 | // or "pkg/analyzer/tool/generate_files" for the analyzer package IDL/sources. 9 | 10 | 11 | /// Enum of declaration kinds in available files. 12 | enum AvailableDeclarationKind : byte { 13 | CLASS, 14 | 15 | CLASS_TYPE_ALIAS, 16 | 17 | CONSTRUCTOR, 18 | 19 | ENUM, 20 | 21 | ENUM_CONSTANT, 22 | 23 | EXTENSION, 24 | 25 | FIELD, 26 | 27 | FUNCTION, 28 | 29 | FUNCTION_TYPE_ALIAS, 30 | 31 | GETTER, 32 | 33 | METHOD, 34 | 35 | MIXIN, 36 | 37 | SETTER, 38 | 39 | VARIABLE 40 | } 41 | 42 | /// Enum representing nullability suffixes in summaries. 43 | /// 44 | /// This enum is similar to [NullabilitySuffix], but the order is different so 45 | /// that [EntityRefNullabilitySuffix.starOrIrrelevant] can be the default. 46 | enum EntityRefNullabilitySuffix : byte { 47 | /// An indication that the canonical representation of the type under 48 | /// consideration ends with `*`. Types having this nullability suffix are 49 | /// called "legacy types"; it has not yet been determined whether they should 50 | /// be unioned with the Null type. 51 | /// 52 | /// Also used in circumstances where no nullability suffix information is 53 | /// needed. 54 | starOrIrrelevant, 55 | 56 | /// An indication that the canonical representation of the type under 57 | /// consideration ends with `?`. Types having this nullability suffix should 58 | /// be interpreted as being unioned with the Null type. 59 | question, 60 | 61 | /// An indication that the canonical representation of the type under 62 | /// consideration does not end with either `?` or `*`. 63 | none 64 | } 65 | 66 | /// Enum used to indicate the kind of an index relation. 67 | enum IndexRelationKind : byte { 68 | /// Left: class. 69 | /// Is ancestor of (is extended or implemented, directly or indirectly). 70 | /// Right: other class declaration. 71 | IS_ANCESTOR_OF, 72 | 73 | /// Left: class. 74 | /// Is extended by. 75 | /// Right: other class declaration. 76 | IS_EXTENDED_BY, 77 | 78 | /// Left: class. 79 | /// Is implemented by. 80 | /// Right: other class declaration. 81 | IS_IMPLEMENTED_BY, 82 | 83 | /// Left: class. 84 | /// Is mixed into. 85 | /// Right: other class declaration. 86 | IS_MIXED_IN_BY, 87 | 88 | /// Left: method, property accessor, function, variable. 89 | /// Is invoked at. 90 | /// Right: location. 91 | IS_INVOKED_BY, 92 | 93 | /// Left: any element. 94 | /// Is referenced (and not invoked, read/written) at. 95 | /// Right: location. 96 | IS_REFERENCED_BY, 97 | 98 | /// Left: unresolved member name. 99 | /// Is read at. 100 | /// Right: location. 101 | IS_READ_BY, 102 | 103 | /// Left: unresolved member name. 104 | /// Is both read and written at. 105 | /// Right: location. 106 | IS_READ_WRITTEN_BY, 107 | 108 | /// Left: unresolved member name. 109 | /// Is written at. 110 | /// Right: location. 111 | IS_WRITTEN_BY 112 | } 113 | 114 | /// When we need to reference a synthetic element in [PackageIndex] we use a 115 | /// value of this enum to specify which kind of the synthetic element we 116 | /// actually reference. 117 | enum IndexSyntheticElementKind : byte { 118 | /// Not a synthetic element. 119 | notSynthetic, 120 | 121 | /// The unnamed synthetic constructor a class element. 122 | constructor, 123 | 124 | /// The synthetic field element. 125 | field, 126 | 127 | /// The synthetic getter of a property introducing element. 128 | getter, 129 | 130 | /// The synthetic setter of a property introducing element. 131 | setter, 132 | 133 | /// The synthetic top-level variable element. 134 | topLevelVariable, 135 | 136 | /// The synthetic `loadLibrary` element. 137 | loadLibrary, 138 | 139 | /// The synthetic `index` getter of an enum. 140 | enumIndex, 141 | 142 | /// The synthetic `values` getter of an enum. 143 | enumValues, 144 | 145 | /// The synthetic `toString` method of an enum. 146 | enumToString, 147 | 148 | /// The containing unit itself. 149 | unit 150 | } 151 | 152 | /// Types of comments. 153 | enum LinkedNodeCommentType : byte { 154 | block, 155 | 156 | documentation, 157 | 158 | endOfLine 159 | } 160 | 161 | /// Kinds of formal parameters. 162 | enum LinkedNodeFormalParameterKind : byte { 163 | requiredPositional, 164 | 165 | optionalPositional, 166 | 167 | optionalNamed, 168 | 169 | requiredNamed 170 | } 171 | 172 | /// Kinds of [LinkedNode]. 173 | enum LinkedNodeKind : byte { 174 | adjacentStrings, 175 | 176 | annotation, 177 | 178 | argumentList, 179 | 180 | asExpression, 181 | 182 | assertInitializer, 183 | 184 | assertStatement, 185 | 186 | assignmentExpression, 187 | 188 | awaitExpression, 189 | 190 | binaryExpression, 191 | 192 | block, 193 | 194 | blockFunctionBody, 195 | 196 | booleanLiteral, 197 | 198 | breakStatement, 199 | 200 | cascadeExpression, 201 | 202 | catchClause, 203 | 204 | classDeclaration, 205 | 206 | classTypeAlias, 207 | 208 | comment, 209 | 210 | commentReference, 211 | 212 | compilationUnit, 213 | 214 | conditionalExpression, 215 | 216 | configuration, 217 | 218 | constructorDeclaration, 219 | 220 | constructorFieldInitializer, 221 | 222 | constructorName, 223 | 224 | continueStatement, 225 | 226 | declaredIdentifier, 227 | 228 | defaultFormalParameter, 229 | 230 | doubleLiteral, 231 | 232 | doStatement, 233 | 234 | dottedName, 235 | 236 | emptyFunctionBody, 237 | 238 | emptyStatement, 239 | 240 | enumConstantDeclaration, 241 | 242 | enumDeclaration, 243 | 244 | exportDirective, 245 | 246 | expressionFunctionBody, 247 | 248 | expressionStatement, 249 | 250 | extendsClause, 251 | 252 | extensionDeclaration, 253 | 254 | fieldDeclaration, 255 | 256 | fieldFormalParameter, 257 | 258 | formalParameterList, 259 | 260 | forEachPartsWithDeclaration, 261 | 262 | forEachPartsWithIdentifier, 263 | 264 | forElement, 265 | 266 | forPartsWithDeclarations, 267 | 268 | forPartsWithExpression, 269 | 270 | forStatement, 271 | 272 | functionDeclaration, 273 | 274 | functionDeclarationStatement, 275 | 276 | functionExpression, 277 | 278 | functionExpressionInvocation, 279 | 280 | functionTypeAlias, 281 | 282 | functionTypedFormalParameter, 283 | 284 | genericFunctionType, 285 | 286 | genericTypeAlias, 287 | 288 | hideCombinator, 289 | 290 | ifElement, 291 | 292 | ifStatement, 293 | 294 | implementsClause, 295 | 296 | importDirective, 297 | 298 | instanceCreationExpression, 299 | 300 | indexExpression, 301 | 302 | integerLiteral, 303 | 304 | interpolationExpression, 305 | 306 | interpolationString, 307 | 308 | isExpression, 309 | 310 | label, 311 | 312 | labeledStatement, 313 | 314 | libraryDirective, 315 | 316 | libraryIdentifier, 317 | 318 | listLiteral, 319 | 320 | mapLiteralEntry, 321 | 322 | methodDeclaration, 323 | 324 | methodInvocation, 325 | 326 | mixinDeclaration, 327 | 328 | namedExpression, 329 | 330 | nativeClause, 331 | 332 | nativeFunctionBody, 333 | 334 | nullLiteral, 335 | 336 | onClause, 337 | 338 | parenthesizedExpression, 339 | 340 | partDirective, 341 | 342 | partOfDirective, 343 | 344 | postfixExpression, 345 | 346 | prefixExpression, 347 | 348 | prefixedIdentifier, 349 | 350 | propertyAccess, 351 | 352 | redirectingConstructorInvocation, 353 | 354 | rethrowExpression, 355 | 356 | returnStatement, 357 | 358 | setOrMapLiteral, 359 | 360 | showCombinator, 361 | 362 | simpleFormalParameter, 363 | 364 | simpleIdentifier, 365 | 366 | simpleStringLiteral, 367 | 368 | spreadElement, 369 | 370 | stringInterpolation, 371 | 372 | superConstructorInvocation, 373 | 374 | superExpression, 375 | 376 | switchCase, 377 | 378 | switchDefault, 379 | 380 | switchStatement, 381 | 382 | symbolLiteral, 383 | 384 | thisExpression, 385 | 386 | throwExpression, 387 | 388 | topLevelVariableDeclaration, 389 | 390 | tryStatement, 391 | 392 | typeArgumentList, 393 | 394 | typeName, 395 | 396 | typeParameter, 397 | 398 | typeParameterList, 399 | 400 | variableDeclaration, 401 | 402 | variableDeclarationList, 403 | 404 | variableDeclarationStatement, 405 | 406 | whileStatement, 407 | 408 | withClause, 409 | 410 | yieldStatement, 411 | 412 | extensionOverride 413 | } 414 | 415 | /// Kinds of [LinkedNodeType]s. 416 | enum LinkedNodeTypeKind : byte { 417 | bottom, 418 | 419 | dynamic_, 420 | 421 | function, 422 | 423 | interface, 424 | 425 | typeParameter, 426 | 427 | void_ 428 | } 429 | 430 | /// Enum used to indicate the kind of the error during top-level inference. 431 | enum TopLevelInferenceErrorKind : byte { 432 | assignment, 433 | 434 | instanceGetter, 435 | 436 | dependencyCycle, 437 | 438 | overrideConflictFieldType, 439 | 440 | overrideConflictReturnType, 441 | 442 | overrideConflictParameterType 443 | } 444 | 445 | /// Enum of token types, corresponding to AST token types. 446 | enum UnlinkedTokenType : byte { 447 | NOTHING, 448 | 449 | ABSTRACT, 450 | 451 | AMPERSAND, 452 | 453 | AMPERSAND_AMPERSAND, 454 | 455 | AMPERSAND_EQ, 456 | 457 | AS, 458 | 459 | ASSERT, 460 | 461 | ASYNC, 462 | 463 | AT, 464 | 465 | AWAIT, 466 | 467 | BACKPING, 468 | 469 | BACKSLASH, 470 | 471 | BANG, 472 | 473 | BANG_EQ, 474 | 475 | BANG_EQ_EQ, 476 | 477 | BAR, 478 | 479 | BAR_BAR, 480 | 481 | BAR_EQ, 482 | 483 | BREAK, 484 | 485 | CARET, 486 | 487 | CARET_EQ, 488 | 489 | CASE, 490 | 491 | CATCH, 492 | 493 | CLASS, 494 | 495 | CLOSE_CURLY_BRACKET, 496 | 497 | CLOSE_PAREN, 498 | 499 | CLOSE_SQUARE_BRACKET, 500 | 501 | COLON, 502 | 503 | COMMA, 504 | 505 | CONST, 506 | 507 | CONTINUE, 508 | 509 | COVARIANT, 510 | 511 | DEFAULT, 512 | 513 | DEFERRED, 514 | 515 | DO, 516 | 517 | DOUBLE, 518 | 519 | DYNAMIC, 520 | 521 | ELSE, 522 | 523 | ENUM, 524 | 525 | EOF, 526 | 527 | EQ, 528 | 529 | EQ_EQ, 530 | 531 | EQ_EQ_EQ, 532 | 533 | EXPORT, 534 | 535 | EXTENDS, 536 | 537 | EXTERNAL, 538 | 539 | FACTORY, 540 | 541 | FALSE, 542 | 543 | FINAL, 544 | 545 | FINALLY, 546 | 547 | FOR, 548 | 549 | FUNCTION, 550 | 551 | FUNCTION_KEYWORD, 552 | 553 | GET, 554 | 555 | GT, 556 | 557 | GT_EQ, 558 | 559 | GT_GT, 560 | 561 | GT_GT_EQ, 562 | 563 | GT_GT_GT, 564 | 565 | GT_GT_GT_EQ, 566 | 567 | HASH, 568 | 569 | HEXADECIMAL, 570 | 571 | HIDE, 572 | 573 | IDENTIFIER, 574 | 575 | IF, 576 | 577 | IMPLEMENTS, 578 | 579 | IMPORT, 580 | 581 | IN, 582 | 583 | INDEX, 584 | 585 | INDEX_EQ, 586 | 587 | INT, 588 | 589 | INTERFACE, 590 | 591 | IS, 592 | 593 | LATE, 594 | 595 | LIBRARY, 596 | 597 | LT, 598 | 599 | LT_EQ, 600 | 601 | LT_LT, 602 | 603 | LT_LT_EQ, 604 | 605 | MINUS, 606 | 607 | MINUS_EQ, 608 | 609 | MINUS_MINUS, 610 | 611 | MIXIN, 612 | 613 | MULTI_LINE_COMMENT, 614 | 615 | NATIVE, 616 | 617 | NEW, 618 | 619 | NULL, 620 | 621 | OF, 622 | 623 | ON, 624 | 625 | OPEN_CURLY_BRACKET, 626 | 627 | OPEN_PAREN, 628 | 629 | OPEN_SQUARE_BRACKET, 630 | 631 | OPERATOR, 632 | 633 | PART, 634 | 635 | PATCH, 636 | 637 | PERCENT, 638 | 639 | PERCENT_EQ, 640 | 641 | PERIOD, 642 | 643 | PERIOD_PERIOD, 644 | 645 | PERIOD_PERIOD_PERIOD, 646 | 647 | PERIOD_PERIOD_PERIOD_QUESTION, 648 | 649 | PLUS, 650 | 651 | PLUS_EQ, 652 | 653 | PLUS_PLUS, 654 | 655 | QUESTION, 656 | 657 | QUESTION_PERIOD, 658 | 659 | QUESTION_QUESTION, 660 | 661 | QUESTION_QUESTION_EQ, 662 | 663 | REQUIRED, 664 | 665 | RETHROW, 666 | 667 | RETURN, 668 | 669 | SCRIPT_TAG, 670 | 671 | SEMICOLON, 672 | 673 | SET, 674 | 675 | SHOW, 676 | 677 | SINGLE_LINE_COMMENT, 678 | 679 | SLASH, 680 | 681 | SLASH_EQ, 682 | 683 | SOURCE, 684 | 685 | STAR, 686 | 687 | STAR_EQ, 688 | 689 | STATIC, 690 | 691 | STRING, 692 | 693 | STRING_INTERPOLATION_EXPRESSION, 694 | 695 | STRING_INTERPOLATION_IDENTIFIER, 696 | 697 | SUPER, 698 | 699 | SWITCH, 700 | 701 | SYNC, 702 | 703 | THIS, 704 | 705 | THROW, 706 | 707 | TILDE, 708 | 709 | TILDE_SLASH, 710 | 711 | TILDE_SLASH_EQ, 712 | 713 | TRUE, 714 | 715 | TRY, 716 | 717 | TYPEDEF, 718 | 719 | VAR, 720 | 721 | VOID, 722 | 723 | WHILE, 724 | 725 | WITH, 726 | 727 | YIELD, 728 | 729 | INOUT, 730 | 731 | OUT 732 | } 733 | 734 | /// Information about the context of an exception in analysis driver. 735 | table AnalysisDriverExceptionContext { 736 | /// The exception string. 737 | exception:string (id: 1); 738 | 739 | /// The state of files when the exception happened. 740 | files:[AnalysisDriverExceptionFile] (id: 3); 741 | 742 | /// The path of the file being analyzed when the exception happened. 743 | path:string (id: 0); 744 | 745 | /// The exception stack trace string. 746 | stackTrace:string (id: 2); 747 | } 748 | 749 | /// Information about a single file in [AnalysisDriverExceptionContext]. 750 | table AnalysisDriverExceptionFile { 751 | /// The content of the file. 752 | content:string (id: 1); 753 | 754 | /// The path of the file. 755 | path:string (id: 0); 756 | } 757 | 758 | /// Information about a resolved unit. 759 | table AnalysisDriverResolvedUnit { 760 | /// The full list of analysis errors, both syntactic and semantic. 761 | errors:[AnalysisDriverUnitError] (id: 0); 762 | 763 | /// The index of the unit. 764 | index:AnalysisDriverUnitIndex (id: 1); 765 | } 766 | 767 | /// Information about a subtype of one or more classes. 768 | table AnalysisDriverSubtype { 769 | /// The names of defined instance members. 770 | /// They are indexes into [AnalysisDriverUnitError.strings] list. 771 | /// The list is sorted in ascending order. 772 | members:[uint] (id: 1); 773 | 774 | /// The name of the class. 775 | /// It is an index into [AnalysisDriverUnitError.strings] list. 776 | name:uint (id: 0); 777 | } 778 | 779 | /// Information about an error in a resolved unit. 780 | table AnalysisDriverUnitError { 781 | /// The context messages associated with the error. 782 | contextMessages:[DiagnosticMessage] (id: 5); 783 | 784 | /// The optional correction hint for the error. 785 | correction:string (id: 4); 786 | 787 | /// The length of the error in the file. 788 | length:uint (id: 1); 789 | 790 | /// The message of the error. 791 | message:string (id: 3); 792 | 793 | /// The offset from the beginning of the file. 794 | offset:uint (id: 0); 795 | 796 | /// The unique name of the error code. 797 | uniqueName:string (id: 2); 798 | } 799 | 800 | /// Information about a resolved unit. 801 | table AnalysisDriverUnitIndex { 802 | /// Each item of this list corresponds to a unique referenced element. It is 803 | /// the kind of the synthetic element. 804 | elementKinds:[IndexSyntheticElementKind] (id: 4); 805 | 806 | /// Each item of this list corresponds to a unique referenced element. It is 807 | /// the identifier of the class member element name, or `null` if the element 808 | /// is a top-level element. The list is sorted in ascending order, so that 809 | /// the client can quickly check whether an element is referenced in this 810 | /// index. 811 | elementNameClassMemberIds:[uint] (id: 7); 812 | 813 | /// Each item of this list corresponds to a unique referenced element. It is 814 | /// the identifier of the named parameter name, or `null` if the element is 815 | /// not a named parameter. The list is sorted in ascending order, so that the 816 | /// client can quickly check whether an element is referenced in this index. 817 | elementNameParameterIds:[uint] (id: 8); 818 | 819 | /// Each item of this list corresponds to a unique referenced element. It is 820 | /// the identifier of the top-level element name, or `null` if the element is 821 | /// the unit. The list is sorted in ascending order, so that the client can 822 | /// quickly check whether an element is referenced in this index. 823 | elementNameUnitMemberIds:[uint] (id: 6); 824 | 825 | /// Each item of this list corresponds to a unique referenced element. It is 826 | /// the index into [unitLibraryUris] and [unitUnitUris] for the library 827 | /// specific unit where the element is declared. 828 | elementUnits:[uint] (id: 5); 829 | 830 | /// Identifier of the null string in [strings]. 831 | nullStringId:uint (id: 1); 832 | 833 | /// List of unique element strings used in this index. The list is sorted in 834 | /// ascending order, so that the client can quickly check the presence of a 835 | /// string in this index. 836 | strings:[string] (id: 0); 837 | 838 | /// The list of classes declared in the unit. 839 | subtypes:[AnalysisDriverSubtype] (id: 19); 840 | 841 | /// The identifiers of supertypes of elements at corresponding indexes 842 | /// in [subtypes]. They are indexes into [strings] list. The list is sorted 843 | /// in ascending order. There might be more than one element with the same 844 | /// value if there is more than one subtype of this supertype. 845 | supertypes:[uint] (id: 18); 846 | 847 | /// Each item of this list corresponds to the library URI of a unique library 848 | /// specific unit referenced in the index. It is an index into [strings] 849 | /// list. 850 | unitLibraryUris:[uint] (id: 2); 851 | 852 | /// Each item of this list corresponds to the unit URI of a unique library 853 | /// specific unit referenced in the index. It is an index into [strings] 854 | /// list. 855 | unitUnitUris:[uint] (id: 3); 856 | 857 | /// Each item of this list is the `true` if the corresponding element usage 858 | /// is qualified with some prefix. 859 | usedElementIsQualifiedFlags:[ubyte] (id: 13); 860 | 861 | /// Each item of this list is the kind of the element usage. 862 | usedElementKinds:[IndexRelationKind] (id: 10); 863 | 864 | /// Each item of this list is the length of the element usage. 865 | usedElementLengths:[uint] (id: 12); 866 | 867 | /// Each item of this list is the offset of the element usage relative to the 868 | /// beginning of the file. 869 | usedElementOffsets:[uint] (id: 11); 870 | 871 | /// Each item of this list is the index into [elementUnits], 872 | /// [elementNameUnitMemberIds], [elementNameClassMemberIds] and 873 | /// [elementNameParameterIds]. The list is sorted in ascending order, so 874 | /// that the client can quickly find element references in this index. 875 | usedElements:[uint] (id: 9); 876 | 877 | /// Each item of this list is the `true` if the corresponding name usage 878 | /// is qualified with some prefix. 879 | usedNameIsQualifiedFlags:[ubyte] (id: 17); 880 | 881 | /// Each item of this list is the kind of the name usage. 882 | usedNameKinds:[IndexRelationKind] (id: 15); 883 | 884 | /// Each item of this list is the offset of the name usage relative to the 885 | /// beginning of the file. 886 | usedNameOffsets:[uint] (id: 16); 887 | 888 | /// Each item of this list is the index into [strings] for a used name. The 889 | /// list is sorted in ascending order, so that the client can quickly find 890 | /// whether a name is used in this index. 891 | usedNames:[uint] (id: 14); 892 | } 893 | 894 | /// Information about an unlinked unit. 895 | table AnalysisDriverUnlinkedUnit { 896 | /// List of class member names defined by the unit. 897 | definedClassMemberNames:[string] (id: 2); 898 | 899 | /// List of top-level names defined by the unit. 900 | definedTopLevelNames:[string] (id: 1); 901 | 902 | /// List of external names referenced by the unit. 903 | referencedNames:[string] (id: 0); 904 | 905 | /// List of names which are used in `extends`, `with` or `implements` clauses 906 | /// in the file. Import prefixes and type arguments are not included. 907 | subtypedNames:[string] (id: 3); 908 | 909 | /// Unlinked information for the unit. 910 | unit2:UnlinkedUnit2 (id: 4); 911 | } 912 | 913 | /// Information about a single declaration. 914 | table AvailableDeclaration { 915 | children:[AvailableDeclaration] (id: 0); 916 | 917 | codeLength:uint (id: 1); 918 | 919 | codeOffset:uint (id: 2); 920 | 921 | defaultArgumentListString:string (id: 3); 922 | 923 | defaultArgumentListTextRanges:[uint] (id: 4); 924 | 925 | docComplete:string (id: 5); 926 | 927 | docSummary:string (id: 6); 928 | 929 | fieldMask:uint (id: 7); 930 | 931 | isAbstract:bool (id: 8); 932 | 933 | isConst:bool (id: 9); 934 | 935 | isDeprecated:bool (id: 10); 936 | 937 | isFinal:bool (id: 11); 938 | 939 | isStatic:bool (id: 12); 940 | 941 | /// The kind of the declaration. 942 | kind:AvailableDeclarationKind (id: 13); 943 | 944 | locationOffset:uint (id: 14); 945 | 946 | locationStartColumn:uint (id: 15); 947 | 948 | locationStartLine:uint (id: 16); 949 | 950 | /// The first part of the declaration name, usually the only one, for example 951 | /// the name of a class like `MyClass`, or a function like `myFunction`. 952 | name:string (id: 17); 953 | 954 | parameterNames:[string] (id: 18); 955 | 956 | parameters:string (id: 19); 957 | 958 | parameterTypes:[string] (id: 20); 959 | 960 | /// The partial list of relevance tags. Not every declaration has one (for 961 | /// example, function do not currently), and not every declaration has to 962 | /// store one (for classes it can be computed when we know the library that 963 | /// includes this file). 964 | relevanceTags:[string] (id: 21); 965 | 966 | requiredParameterCount:uint (id: 22); 967 | 968 | returnType:string (id: 23); 969 | 970 | typeParameters:string (id: 24); 971 | } 972 | 973 | /// Information about an available, even if not yet imported file. 974 | table AvailableFile { 975 | /// Declarations of the file. 976 | declarations:[AvailableDeclaration] (id: 0); 977 | 978 | /// The Dartdoc directives in the file. 979 | directiveInfo:DirectiveInfo (id: 1); 980 | 981 | /// Exports directives of the file. 982 | exports:[AvailableFileExport] (id: 2); 983 | 984 | /// Is `true` if this file is a library. 985 | isLibrary:bool (id: 3); 986 | 987 | /// Is `true` if this file is a library, and it is deprecated. 988 | isLibraryDeprecated:bool (id: 4); 989 | 990 | /// Offsets of the first character of each line in the source code. 991 | lineStarts:[uint] (id: 5); 992 | 993 | /// URIs of `part` directives. 994 | parts:[string] (id: 6); 995 | } 996 | 997 | /// Information about an export directive. 998 | table AvailableFileExport { 999 | /// Combinators contained in this export directive. 1000 | combinators:[AvailableFileExportCombinator] (id: 1); 1001 | 1002 | /// URI of the exported library. 1003 | uri:string (id: 0); 1004 | } 1005 | 1006 | /// Information about a `show` or `hide` combinator in an export directive. 1007 | table AvailableFileExportCombinator { 1008 | /// List of names which are hidden. Empty if this is a `show` combinator. 1009 | hides:[string] (id: 1); 1010 | 1011 | /// List of names which are shown. Empty if this is a `hide` combinator. 1012 | shows:[string] (id: 0); 1013 | } 1014 | 1015 | /// Information about linked libraries, a group of libraries that form 1016 | /// a library cycle. 1017 | table CiderLinkedLibraryCycle { 1018 | bundle:LinkedNodeBundle (id: 1); 1019 | 1020 | /// The hash signature for this linked cycle. It depends of API signatures 1021 | /// of all files in the cycle, and on the signatures of the transitive 1022 | /// closure of the cycle dependencies. 1023 | signature:[uint] (id: 0); 1024 | } 1025 | 1026 | /// Errors for a single unit. 1027 | table CiderUnitErrors { 1028 | errors:[AnalysisDriverUnitError] (id: 1); 1029 | 1030 | /// The hash signature of this data. 1031 | signature:[uint] (id: 0); 1032 | } 1033 | 1034 | /// Information about a compilation unit, contains the content hash 1035 | /// and unlinked summary. 1036 | table CiderUnlinkedUnit { 1037 | /// The hash signature of the contents of the file. 1038 | contentDigest:[uint] (id: 0); 1039 | 1040 | /// Unlinked summary of the compilation unit. 1041 | unlinkedUnit:UnlinkedUnit2 (id: 1); 1042 | } 1043 | 1044 | table DiagnosticMessage { 1045 | /// The absolute and normalized path of the file associated with this message. 1046 | filePath:string (id: 0); 1047 | 1048 | /// The length of the source range associated with this message. 1049 | length:uint (id: 1); 1050 | 1051 | /// The text of the message. 1052 | message:string (id: 2); 1053 | 1054 | /// The zero-based offset from the start of the file to the beginning of the 1055 | /// source range associated with this message. 1056 | offset:uint (id: 3); 1057 | } 1058 | 1059 | /// Information about the Dartdoc directives in an [AvailableFile]. 1060 | table DirectiveInfo { 1061 | /// The names of the defined templates. 1062 | templateNames:[string] (id: 0); 1063 | 1064 | /// The values of the defined templates. 1065 | templateValues:[string] (id: 1); 1066 | } 1067 | 1068 | /// Information about a linked AST node. 1069 | table LinkedNode { 1070 | /// The explicit or inferred return type of a function typed node. 1071 | variantField_24:LinkedNodeType (id: 24); 1072 | 1073 | variantField_2:[LinkedNode] (id: 2); 1074 | 1075 | variantField_4:[LinkedNode] (id: 4); 1076 | 1077 | variantField_6:LinkedNode (id: 6); 1078 | 1079 | variantField_7:LinkedNode (id: 7); 1080 | 1081 | variantField_17:uint (id: 17); 1082 | 1083 | variantField_8:LinkedNode (id: 8); 1084 | 1085 | variantField_38:LinkedNodeTypeSubstitution (id: 38); 1086 | 1087 | variantField_15:uint (id: 15); 1088 | 1089 | variantField_28:UnlinkedTokenType (id: 28); 1090 | 1091 | variantField_27:bool (id: 27); 1092 | 1093 | variantField_9:LinkedNode (id: 9); 1094 | 1095 | variantField_12:LinkedNode (id: 12); 1096 | 1097 | variantField_5:[LinkedNode] (id: 5); 1098 | 1099 | variantField_13:LinkedNode (id: 13); 1100 | 1101 | variantField_33:[string] (id: 33); 1102 | 1103 | variantField_29:LinkedNodeCommentType (id: 29); 1104 | 1105 | variantField_3:[LinkedNode] (id: 3); 1106 | 1107 | /// The minor component of the actual language version (not just override). 1108 | variantField_16:uint (id: 16); 1109 | 1110 | variantField_10:LinkedNode (id: 10); 1111 | 1112 | variantField_26:LinkedNodeFormalParameterKind (id: 26); 1113 | 1114 | variantField_21:double (id: 21); 1115 | 1116 | variantField_25:LinkedNodeType (id: 25); 1117 | 1118 | variantField_20:string (id: 20); 1119 | 1120 | variantField_39:[LinkedNodeType] (id: 39); 1121 | 1122 | flags:uint (id: 18); 1123 | 1124 | variantField_1:string (id: 1); 1125 | 1126 | variantField_36:uint (id: 36); 1127 | 1128 | variantField_30:string (id: 30); 1129 | 1130 | variantField_14:LinkedNode (id: 14); 1131 | 1132 | kind:LinkedNodeKind (id: 0); 1133 | 1134 | variantField_31:bool (id: 31); 1135 | 1136 | variantField_34:[string] (id: 34); 1137 | 1138 | name:string (id: 37); 1139 | 1140 | variantField_35:UnlinkedTokenType (id: 35); 1141 | 1142 | variantField_32:TopLevelInferenceError (id: 32); 1143 | 1144 | variantField_23:LinkedNodeType (id: 23); 1145 | 1146 | variantField_11:LinkedNode (id: 11); 1147 | 1148 | variantField_22:string (id: 22); 1149 | 1150 | variantField_19:uint (id: 19); 1151 | } 1152 | 1153 | /// Information about a group of libraries linked together, for example because 1154 | /// they form a single cycle, or because they represent a single build artifact. 1155 | table LinkedNodeBundle { 1156 | libraries:[LinkedNodeLibrary] (id: 1); 1157 | 1158 | /// The shared list of references used in the [libraries]. 1159 | references:LinkedNodeReferences (id: 0); 1160 | } 1161 | 1162 | /// Information about a single library in a [LinkedNodeBundle]. 1163 | table LinkedNodeLibrary { 1164 | exports:[uint] (id: 2); 1165 | 1166 | name:string (id: 3); 1167 | 1168 | nameLength:uint (id: 5); 1169 | 1170 | nameOffset:uint (id: 4); 1171 | 1172 | units:[LinkedNodeUnit] (id: 1); 1173 | 1174 | uriStr:string (id: 0); 1175 | } 1176 | 1177 | /// Flattened tree of declarations referenced from [LinkedNode]s. 1178 | table LinkedNodeReferences { 1179 | name:[string] (id: 1); 1180 | 1181 | parent:[uint] (id: 0); 1182 | } 1183 | 1184 | /// Information about a Dart type. 1185 | table LinkedNodeType { 1186 | functionFormalParameters:[LinkedNodeTypeFormalParameter] (id: 0); 1187 | 1188 | functionReturnType:LinkedNodeType (id: 1); 1189 | 1190 | /// The typedef this function type is created for. 1191 | functionTypedef:uint (id: 9); 1192 | 1193 | functionTypedefTypeArguments:[LinkedNodeType] (id: 10); 1194 | 1195 | functionTypeParameters:[LinkedNodeTypeTypeParameter] (id: 2); 1196 | 1197 | /// Reference to a [LinkedNodeReferences]. 1198 | interfaceClass:uint (id: 3); 1199 | 1200 | interfaceTypeArguments:[LinkedNodeType] (id: 4); 1201 | 1202 | kind:LinkedNodeTypeKind (id: 5); 1203 | 1204 | nullabilitySuffix:EntityRefNullabilitySuffix (id: 8); 1205 | 1206 | typeParameterElement:uint (id: 6); 1207 | 1208 | typeParameterId:uint (id: 7); 1209 | } 1210 | 1211 | /// Information about a formal parameter in a function type. 1212 | table LinkedNodeTypeFormalParameter { 1213 | kind:LinkedNodeFormalParameterKind (id: 0); 1214 | 1215 | name:string (id: 1); 1216 | 1217 | type:LinkedNodeType (id: 2); 1218 | } 1219 | 1220 | /// Information about a type substitution. 1221 | table LinkedNodeTypeSubstitution { 1222 | isLegacy:bool (id: 2); 1223 | 1224 | typeArguments:[LinkedNodeType] (id: 1); 1225 | 1226 | typeParameters:[uint] (id: 0); 1227 | } 1228 | 1229 | /// Information about a type parameter in a function type. 1230 | table LinkedNodeTypeTypeParameter { 1231 | bound:LinkedNodeType (id: 1); 1232 | 1233 | name:string (id: 0); 1234 | } 1235 | 1236 | /// Information about a single library in a [LinkedNodeLibrary]. 1237 | table LinkedNodeUnit { 1238 | isNNBD:bool (id: 3); 1239 | 1240 | isSynthetic:bool (id: 2); 1241 | 1242 | node:LinkedNode (id: 1); 1243 | 1244 | /// If the unit is a part, the URI specified in the `part` directive. 1245 | /// Otherwise empty. 1246 | partUriStr:string (id: 4); 1247 | 1248 | /// The absolute URI. 1249 | uriStr:string (id: 0); 1250 | } 1251 | 1252 | /// Summary information about a package. 1253 | table PackageBundle { 1254 | /// The version 2 of the summary. 1255 | bundle2:LinkedNodeBundle (id: 0); 1256 | } 1257 | 1258 | /// Summary information about a top-level type inference error. 1259 | table TopLevelInferenceError { 1260 | /// The [kind] specific arguments. 1261 | arguments:[string] (id: 2); 1262 | 1263 | /// The kind of the error. 1264 | kind:TopLevelInferenceErrorKind (id: 1); 1265 | 1266 | /// The slot id (which is unique within the compilation unit) identifying the 1267 | /// target of type inference with which this [TopLevelInferenceError] is 1268 | /// associated. 1269 | slot:uint (id: 0); 1270 | } 1271 | 1272 | table UnlinkedInformativeData { 1273 | variantField_2:uint (id: 2); 1274 | 1275 | variantField_3:uint (id: 3); 1276 | 1277 | variantField_9:uint (id: 9); 1278 | 1279 | variantField_8:uint (id: 8); 1280 | 1281 | /// Offsets of the first character of each line in the source code. 1282 | variantField_7:[uint] (id: 7); 1283 | 1284 | variantField_6:uint (id: 6); 1285 | 1286 | variantField_5:uint (id: 5); 1287 | 1288 | /// If the parameter has a default value, the source text of the constant 1289 | /// expression in the default value. Otherwise the empty string. 1290 | variantField_10:string (id: 10); 1291 | 1292 | variantField_1:uint (id: 1); 1293 | 1294 | variantField_4:[string] (id: 4); 1295 | 1296 | /// The kind of the node. 1297 | kind:LinkedNodeKind (id: 0); 1298 | } 1299 | 1300 | /// Unlinked summary information about a namespace directive. 1301 | table UnlinkedNamespaceDirective { 1302 | /// The configurations that control which library will actually be used. 1303 | configurations:[UnlinkedNamespaceDirectiveConfiguration] (id: 0); 1304 | 1305 | /// The URI referenced by this directive, nad used by default when none 1306 | /// of the [configurations] matches. 1307 | uri:string (id: 1); 1308 | } 1309 | 1310 | /// Unlinked summary information about a namespace directive configuration. 1311 | table UnlinkedNamespaceDirectiveConfiguration { 1312 | /// The name of the declared variable used in the condition. 1313 | name:string (id: 0); 1314 | 1315 | /// The URI to be used if the condition is true. 1316 | uri:string (id: 2); 1317 | 1318 | /// The value to which the value of the declared variable will be compared, 1319 | /// or the empty string if the condition does not include an equality test. 1320 | value:string (id: 1); 1321 | } 1322 | 1323 | /// Unlinked summary information about a compilation unit. 1324 | table UnlinkedUnit2 { 1325 | /// The MD5 hash signature of the API portion of this unit. It depends on all 1326 | /// tokens that might affect APIs of declarations in the unit. 1327 | apiSignature:[uint] (id: 0); 1328 | 1329 | /// URIs of `export` directives. 1330 | exports:[UnlinkedNamespaceDirective] (id: 1); 1331 | 1332 | /// Is `true` if the unit contains a `library` directive. 1333 | hasLibraryDirective:bool (id: 6); 1334 | 1335 | /// Is `true` if the unit contains a `part of` directive. 1336 | hasPartOfDirective:bool (id: 3); 1337 | 1338 | /// URIs of `import` directives. 1339 | imports:[UnlinkedNamespaceDirective] (id: 2); 1340 | 1341 | informativeData:[UnlinkedInformativeData] (id: 7); 1342 | 1343 | /// Offsets of the first character of each line in the source code. 1344 | lineStarts:[uint] (id: 5); 1345 | 1346 | /// URIs of `part` directives. 1347 | parts:[string] (id: 4); 1348 | } 1349 | 1350 | root_type PackageBundle; 1351 | 1352 | file_identifier "PBdl"; 1353 | -------------------------------------------------------------------------------- /docs/packages/build_runner/src/server/README.md: -------------------------------------------------------------------------------- 1 | ## Regenerating the graph_vis_main.dart.js{.map} files 2 | 3 | To regenerate these files, you should use the custom build script at 4 | `tool/build.dart`. This supports all the normal build_runner commands. 5 | -------------------------------------------------------------------------------- /docs/packages/build_runner/src/server/build_updates_client/live_reload_client.js: -------------------------------------------------------------------------------- 1 | (function () { 2 | var _buildUpdatesProtocol = '$buildUpdates'; 3 | 4 | var ws = new WebSocket('ws://' + location.host, [_buildUpdatesProtocol]); 5 | ws.onmessage = function (event) { 6 | location.reload(); 7 | }; 8 | })(); -------------------------------------------------------------------------------- /docs/packages/build_runner/src/server/graph_viz.html: -------------------------------------------------------------------------------- 1 | 6 | 7 | 8 | 9 | 10 | Asset Graph visualization 11 | 12 | 14 | 47 | 48 | 49 | 50 |
51 |
52 |
53 | 56 | 59 | 60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 | 68 |
69 |
70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | -------------------------------------------------------------------------------- /docs/packages/build_runner/src/server/graph_viz.js: -------------------------------------------------------------------------------- 1 | window.$build = {} 2 | window.$build.initializeGraph = function (scope) { 3 | scope.options = { 4 | layout: { 5 | hierarchical: { enabled: true } 6 | }, 7 | physics: { enabled: true }, 8 | configure: { 9 | showButton: false 10 | }, 11 | edges: { 12 | arrows: { 13 | to: { 14 | enabled: true 15 | } 16 | } 17 | } 18 | }; 19 | scope.graphContainer = document.getElementById('graph'); 20 | scope.network = new vis.Network( 21 | scope.graphContainer, { nodes: [], edges: [] }, scope.options); 22 | scope.network.on('doubleClick', function (event) { 23 | if (event.nodes.length >= 1) { 24 | var nodeId = event.nodes[0]; 25 | scope.onFocus(nodeId); 26 | return null; 27 | } 28 | }); 29 | 30 | return function (onFocus) { 31 | scope.onFocus = onFocus; 32 | }; 33 | }(window.$build); 34 | window.$build.setData = function (scope) { 35 | return function (data) { 36 | scope.network.setData(data); 37 | } 38 | }(window.$build); 39 | -------------------------------------------------------------------------------- /docs/packages/effective_dart/analysis_options.1.0.0.yaml: -------------------------------------------------------------------------------- 1 | linter: 2 | rules: 3 | # STYLE 4 | - camel_case_types 5 | - library_names 6 | - file_names 7 | - library_prefixes 8 | - non_constant_identifier_names 9 | - constant_identifier_names # prefer 10 | - directives_ordering 11 | #- lines_longer_than_80_chars # avoid 12 | - curly_braces_in_flow_control_structures 13 | 14 | # DOCUMENTATION 15 | - slash_for_doc_comments 16 | - package_api_docs # prefer # ? 17 | - public_member_api_docs # prefer # ? 18 | - comment_references 19 | 20 | # USAGE 21 | - avoid_relative_lib_imports # prefer 22 | - prefer_adjacent_string_concatenation 23 | - prefer_interpolation_to_compose_strings # prefer 24 | - unnecessary_brace_in_string_interps # avoid 25 | - prefer_collection_literals 26 | - avoid_function_literals_in_foreach_calls # avoid 27 | - prefer_iterable_whereType 28 | - prefer_function_declarations_over_variables 29 | - unnecessary_lambdas 30 | - prefer_equal_for_default_values 31 | - avoid_init_to_null 32 | - unnecessary_getters_setters 33 | #- unnecessary_getters # prefer # Disabled pending fix: https://github.com/dart-lang/linter/issues/23 34 | #- prefer_expression_function_bodies # consider 35 | - unnecessary_this 36 | - prefer_initializing_formals 37 | - type_init_formals 38 | - empty_constructor_bodies 39 | - unnecessary_new 40 | - unnecessary_const 41 | - avoid_catches_without_on_clauses # avoid 42 | - use_rethrow_when_possible 43 | 44 | # DESIGN 45 | - use_to_and_as_if_applicable # prefer 46 | - one_member_abstracts # avoid 47 | - avoid_classes_with_only_static_members # avoid 48 | - prefer_final_fields # prefer 49 | - use_setters_to_change_properties 50 | - avoid_setters_without_getters 51 | - avoid_returning_null # avoid 52 | - avoid_returning_this # avoid 53 | - type_annotate_public_apis # prefer 54 | #- prefer_typing_uninitialized_variables # consider 55 | - omit_local_variable_types # avoid 56 | - avoid_return_types_on_setters 57 | - prefer_generic_function_type_aliases 58 | - avoid_private_typedef_functions # prefer 59 | #- use_function_type_syntax_for_parameters # consider 60 | - avoid_positional_boolean_parameters # avoid 61 | - hash_and_equals 62 | - avoid_null_checks_in_equality_operators 63 | -------------------------------------------------------------------------------- /docs/packages/effective_dart/analysis_options.1.1.0.yaml: -------------------------------------------------------------------------------- 1 | linter: 2 | rules: 3 | # STYLE 4 | - camel_case_types 5 | - library_names 6 | - file_names 7 | - library_prefixes 8 | - non_constant_identifier_names 9 | - constant_identifier_names # prefer 10 | - directives_ordering 11 | #- lines_longer_than_80_chars # avoid 12 | - curly_braces_in_flow_control_structures 13 | 14 | # DOCUMENTATION 15 | - slash_for_doc_comments 16 | - package_api_docs # prefer # ? 17 | - public_member_api_docs # prefer # ? 18 | #- comment_references # Unused because https://github.com/dart-lang/sdk/issues/36974 19 | 20 | # USAGE 21 | - avoid_relative_lib_imports # prefer 22 | - prefer_adjacent_string_concatenation 23 | - prefer_interpolation_to_compose_strings # prefer 24 | - unnecessary_brace_in_string_interps # avoid 25 | - prefer_collection_literals 26 | - avoid_function_literals_in_foreach_calls # avoid 27 | - prefer_iterable_whereType 28 | - prefer_function_declarations_over_variables 29 | - unnecessary_lambdas 30 | - prefer_equal_for_default_values 31 | - avoid_init_to_null 32 | - unnecessary_getters_setters 33 | #- unnecessary_getters # prefer # Disabled pending fix: https://github.com/dart-lang/linter/issues/23 34 | #- prefer_expression_function_bodies # consider 35 | - unnecessary_this 36 | - prefer_initializing_formals 37 | - type_init_formals 38 | - empty_constructor_bodies 39 | - unnecessary_new 40 | - unnecessary_const 41 | - avoid_catches_without_on_clauses # avoid 42 | - use_rethrow_when_possible 43 | 44 | # DESIGN 45 | - use_to_and_as_if_applicable # prefer 46 | - one_member_abstracts # avoid 47 | - avoid_classes_with_only_static_members # avoid 48 | - prefer_final_fields # prefer 49 | - use_setters_to_change_properties 50 | - avoid_setters_without_getters 51 | - avoid_returning_null # avoid 52 | - avoid_returning_this # avoid 53 | - type_annotate_public_apis # prefer 54 | #- prefer_typing_uninitialized_variables # consider 55 | - omit_local_variable_types # avoid 56 | - avoid_return_types_on_setters 57 | - prefer_generic_function_type_aliases 58 | - avoid_private_typedef_functions # prefer 59 | #- use_function_type_syntax_for_parameters # consider 60 | - avoid_positional_boolean_parameters # avoid 61 | - hash_and_equals 62 | - avoid_null_checks_in_equality_operators 63 | -------------------------------------------------------------------------------- /docs/packages/effective_dart/analysis_options.1.2.0.yaml: -------------------------------------------------------------------------------- 1 | linter: 2 | rules: 3 | # STYLE 4 | - camel_case_types 5 | - camel_case_extensions 6 | - library_names 7 | - file_names 8 | - library_prefixes 9 | - non_constant_identifier_names 10 | - constant_identifier_names # prefer 11 | - directives_ordering 12 | - lines_longer_than_80_chars # avoid 13 | - curly_braces_in_flow_control_structures 14 | 15 | # DOCUMENTATION 16 | - slash_for_doc_comments 17 | - package_api_docs # prefer 18 | - public_member_api_docs # prefer 19 | #- comment_references # Unused because https://github.com/dart-lang/sdk/issues/36974 20 | 21 | # USAGE 22 | - implementation_imports 23 | - avoid_relative_lib_imports # prefer 24 | - prefer_relative_imports # prefer 25 | - prefer_adjacent_string_concatenation 26 | - prefer_interpolation_to_compose_strings # prefer 27 | - unnecessary_brace_in_string_interps # avoid 28 | - prefer_collection_literals 29 | - avoid_function_literals_in_foreach_calls # avoid 30 | - prefer_iterable_whereType 31 | - prefer_function_declarations_over_variables 32 | - unnecessary_lambdas 33 | - prefer_equal_for_default_values 34 | - avoid_init_to_null 35 | - unnecessary_getters_setters 36 | #- unnecessary_getters # prefer # Disabled pending fix: https://github.com/dart-lang/linter/issues/23 37 | #- prefer_expression_function_bodies # consider 38 | - unnecessary_this 39 | - prefer_initializing_formals 40 | - type_init_formals 41 | - empty_constructor_bodies 42 | - unnecessary_new 43 | - unnecessary_const 44 | - avoid_catches_without_on_clauses # avoid 45 | - avoid_catching_errors 46 | - use_rethrow_when_possible 47 | 48 | # DESIGN 49 | - use_to_and_as_if_applicable # prefer 50 | - one_member_abstracts # avoid 51 | - avoid_classes_with_only_static_members # avoid 52 | - prefer_mixin 53 | - prefer_final_fields # prefer 54 | - use_setters_to_change_properties 55 | - avoid_setters_without_getters 56 | - avoid_returning_null # avoid 57 | - avoid_returning_this # avoid 58 | - type_annotate_public_apis # prefer 59 | #- prefer_typing_uninitialized_variables # consider 60 | - omit_local_variable_types # avoid 61 | - avoid_types_on_closure_parameters # avoid 62 | - avoid_return_types_on_setters # avoid 63 | - prefer_generic_function_type_aliases 64 | - avoid_private_typedef_functions # prefer 65 | #- use_function_type_syntax_for_parameters # consider 66 | - avoid_positional_boolean_parameters # avoid 67 | - hash_and_equals 68 | - avoid_equals_and_hash_code_on_mutable_classes # avoid 69 | - avoid_null_checks_in_equality_operators 70 | -------------------------------------------------------------------------------- /docs/packages/effective_dart/analysis_options.yaml: -------------------------------------------------------------------------------- 1 | include: package:effective_dart/analysis_options.1.2.0.yaml 2 | -------------------------------------------------------------------------------- /docs/packages/pedantic/analysis_options.1.0.0.yaml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file 2 | # for details. All rights reserved. Use of this source code is governed by a 3 | # BSD-style license that can be found in the LICENSE file. 4 | # 5 | # Google internally enforced rules. See README.md for more information, 6 | # including a list of lints that are intentionally _not_ enforced. 7 | 8 | linter: 9 | rules: 10 | - avoid_empty_else 11 | - avoid_relative_lib_imports 12 | - avoid_return_types_on_setters 13 | - avoid_types_as_parameter_names 14 | - control_flow_in_finally 15 | - no_duplicate_case_values 16 | - prefer_contains 17 | - prefer_equal_for_default_values 18 | - prefer_is_not_empty 19 | - recursive_getters 20 | - throw_in_finally 21 | - unrelated_type_equality_checks 22 | - use_rethrow_when_possible 23 | - valid_regexps 24 | -------------------------------------------------------------------------------- /docs/packages/pedantic/analysis_options.1.1.0.yaml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file 2 | # for details. All rights reserved. Use of this source code is governed by a 3 | # BSD-style license that can be found in the LICENSE file. 4 | # 5 | # Google internally enforced rules. See README.md for more information, 6 | # including a list of lints that are intentionally _not_ enforced. 7 | 8 | linter: 9 | rules: 10 | - avoid_empty_else 11 | - avoid_relative_lib_imports 12 | - avoid_return_types_on_setters 13 | - avoid_types_as_parameter_names 14 | - control_flow_in_finally 15 | - no_duplicate_case_values 16 | - prefer_contains 17 | - prefer_equal_for_default_values 18 | - prefer_is_not_empty 19 | - recursive_getters 20 | - throw_in_finally 21 | - unrelated_type_equality_checks 22 | - use_rethrow_when_possible 23 | - valid_regexps 24 | -------------------------------------------------------------------------------- /docs/packages/pedantic/analysis_options.1.2.0.yaml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file 2 | # for details. All rights reserved. Use of this source code is governed by a 3 | # BSD-style license that can be found in the LICENSE file. 4 | # 5 | # Google internally enforced rules. See README.md for more information, 6 | # including a list of lints that are intentionally _not_ enforced. 7 | 8 | linter: 9 | rules: 10 | - avoid_empty_else 11 | - avoid_relative_lib_imports 12 | - avoid_return_types_on_setters 13 | - avoid_types_as_parameter_names 14 | - no_duplicate_case_values 15 | - prefer_contains 16 | - prefer_equal_for_default_values 17 | - prefer_is_not_empty 18 | - recursive_getters 19 | - unrelated_type_equality_checks 20 | - use_rethrow_when_possible 21 | - unawaited_futures 22 | - valid_regexps 23 | -------------------------------------------------------------------------------- /docs/packages/pedantic/analysis_options.1.3.0.yaml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file 2 | # for details. All rights reserved. Use of this source code is governed by a 3 | # BSD-style license that can be found in the LICENSE file. 4 | # 5 | # Google internally enforced rules. See README.md for more information, 6 | # including a list of lints that are intentionally _not_ enforced. 7 | 8 | linter: 9 | rules: 10 | - avoid_empty_else 11 | - avoid_relative_lib_imports 12 | - avoid_return_types_on_setters 13 | - avoid_types_as_parameter_names 14 | - no_duplicate_case_values 15 | - prefer_contains 16 | - prefer_equal_for_default_values 17 | - prefer_is_empty 18 | - prefer_is_not_empty 19 | - recursive_getters 20 | - unrelated_type_equality_checks 21 | - use_rethrow_when_possible 22 | - unawaited_futures 23 | - valid_regexps 24 | -------------------------------------------------------------------------------- /docs/packages/pedantic/analysis_options.1.4.0.yaml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file 2 | # for details. All rights reserved. Use of this source code is governed by a 3 | # BSD-style license that can be found in the LICENSE file. 4 | # 5 | # Google internally enforced rules. See README.md for more information, 6 | # including a list of lints that are intentionally _not_ enforced. 7 | 8 | linter: 9 | rules: 10 | - avoid_empty_else 11 | - avoid_init_to_null 12 | - avoid_relative_lib_imports 13 | - avoid_return_types_on_setters 14 | - avoid_types_as_parameter_names 15 | - no_duplicate_case_values 16 | - null_closures 17 | - prefer_contains 18 | - prefer_equal_for_default_values 19 | - prefer_is_empty 20 | - prefer_is_not_empty 21 | - recursive_getters 22 | - unrelated_type_equality_checks 23 | - use_rethrow_when_possible 24 | - unawaited_futures 25 | - valid_regexps 26 | -------------------------------------------------------------------------------- /docs/packages/pedantic/analysis_options.1.5.0.yaml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file 2 | # for details. All rights reserved. Use of this source code is governed by a 3 | # BSD-style license that can be found in the LICENSE file. 4 | # 5 | # Google internally enforced rules. See README.md for more information, 6 | # including a list of lints that are intentionally _not_ enforced. 7 | 8 | linter: 9 | rules: 10 | - avoid_empty_else 11 | - avoid_init_to_null 12 | - avoid_relative_lib_imports 13 | - avoid_return_types_on_setters 14 | - avoid_shadowing_type_parameters 15 | - avoid_types_as_parameter_names 16 | - empty_constructor_bodies 17 | - no_duplicate_case_values 18 | - null_closures 19 | - prefer_contains 20 | - prefer_equal_for_default_values 21 | - prefer_is_empty 22 | - prefer_is_not_empty 23 | - recursive_getters 24 | - slash_for_doc_comments 25 | - unawaited_futures 26 | - unrelated_type_equality_checks 27 | - use_rethrow_when_possible 28 | - valid_regexps 29 | -------------------------------------------------------------------------------- /docs/packages/pedantic/analysis_options.1.6.0.yaml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file 2 | # for details. All rights reserved. Use of this source code is governed by a 3 | # BSD-style license that can be found in the LICENSE file. 4 | # 5 | # Google internally enforced rules. See README.md for more information, 6 | # including a list of lints that are intentionally _not_ enforced. 7 | 8 | linter: 9 | rules: 10 | - avoid_empty_else 11 | - avoid_init_to_null 12 | - avoid_relative_lib_imports 13 | - avoid_return_types_on_setters 14 | - avoid_shadowing_type_parameters 15 | - avoid_types_as_parameter_names 16 | - curly_braces_in_flow_control_structures 17 | - empty_catches 18 | - empty_constructor_bodies 19 | - library_names 20 | - library_prefixes 21 | - no_duplicate_case_values 22 | - null_closures 23 | - prefer_contains 24 | - prefer_equal_for_default_values 25 | - prefer_is_empty 26 | - prefer_is_not_empty 27 | - recursive_getters 28 | - slash_for_doc_comments 29 | - type_init_formals 30 | - unawaited_futures 31 | - unnecessary_null_in_if_null_operators 32 | - unrelated_type_equality_checks 33 | - use_rethrow_when_possible 34 | - valid_regexps 35 | -------------------------------------------------------------------------------- /docs/packages/pedantic/analysis_options.1.7.0.yaml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file 2 | # for details. All rights reserved. Use of this source code is governed by a 3 | # BSD-style license that can be found in the LICENSE file. 4 | # 5 | # Google internally enforced rules. See README.md for more information, 6 | # including a list of lints that are intentionally _not_ enforced. 7 | 8 | linter: 9 | rules: 10 | - avoid_empty_else 11 | - avoid_init_to_null 12 | - avoid_relative_lib_imports 13 | - avoid_return_types_on_setters 14 | - avoid_shadowing_type_parameters 15 | - avoid_types_as_parameter_names 16 | - curly_braces_in_flow_control_structures 17 | - empty_catches 18 | - empty_constructor_bodies 19 | - library_names 20 | - library_prefixes 21 | - no_duplicate_case_values 22 | - null_closures 23 | - prefer_contains 24 | - prefer_equal_for_default_values 25 | - prefer_is_empty 26 | - prefer_is_not_empty 27 | - recursive_getters 28 | - slash_for_doc_comments 29 | - type_init_formals 30 | - unawaited_futures 31 | - unnecessary_null_in_if_null_operators 32 | - unrelated_type_equality_checks 33 | - use_rethrow_when_possible 34 | - valid_regexps 35 | -------------------------------------------------------------------------------- /docs/packages/pedantic/analysis_options.1.8.0.yaml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file 2 | # for details. All rights reserved. Use of this source code is governed by a 3 | # BSD-style license that can be found in the LICENSE file. 4 | # 5 | # Google internally enforced rules. See README.md for more information, 6 | # including a list of lints that are intentionally _not_ enforced. 7 | 8 | linter: 9 | rules: 10 | - avoid_empty_else 11 | - avoid_init_to_null 12 | - avoid_relative_lib_imports 13 | - avoid_return_types_on_setters 14 | - avoid_shadowing_type_parameters 15 | - avoid_types_as_parameter_names 16 | - curly_braces_in_flow_control_structures 17 | - empty_catches 18 | - empty_constructor_bodies 19 | - library_names 20 | - library_prefixes 21 | - no_duplicate_case_values 22 | - null_closures 23 | - prefer_contains 24 | - prefer_equal_for_default_values 25 | - prefer_is_empty 26 | - prefer_is_not_empty 27 | - prefer_iterable_whereType 28 | - recursive_getters 29 | - slash_for_doc_comments 30 | - type_init_formals 31 | - unawaited_futures 32 | - unnecessary_const 33 | - unnecessary_new 34 | - unnecessary_null_in_if_null_operators 35 | - unrelated_type_equality_checks 36 | - use_rethrow_when_possible 37 | - valid_regexps 38 | -------------------------------------------------------------------------------- /docs/packages/pedantic/analysis_options.1.9.0.yaml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file 2 | # for details. All rights reserved. Use of this source code is governed by a 3 | # BSD-style license that can be found in the LICENSE file. 4 | # 5 | # Google internally enforced rules. See README.md for more information, 6 | # including a list of lints that are intentionally _not_ enforced. 7 | 8 | linter: 9 | rules: 10 | - always_declare_return_types 11 | - always_require_non_null_named_parameters 12 | - annotate_overrides 13 | - avoid_empty_else 14 | - avoid_init_to_null 15 | - avoid_null_checks_in_equality_operators 16 | - avoid_relative_lib_imports 17 | - avoid_return_types_on_setters 18 | - avoid_shadowing_type_parameters 19 | - avoid_types_as_parameter_names 20 | - camel_case_extensions 21 | - curly_braces_in_flow_control_structures 22 | - empty_catches 23 | - empty_constructor_bodies 24 | - library_names 25 | - library_prefixes 26 | - no_duplicate_case_values 27 | - null_closures 28 | - omit_local_variable_types 29 | - prefer_adjacent_string_concatenation 30 | - prefer_collection_literals 31 | - prefer_conditional_assignment 32 | - prefer_contains 33 | - prefer_equal_for_default_values 34 | - prefer_final_fields 35 | - prefer_for_elements_to_map_fromIterable 36 | - prefer_generic_function_type_aliases 37 | - prefer_if_null_operators 38 | - prefer_is_empty 39 | - prefer_is_not_empty 40 | - prefer_iterable_whereType 41 | - prefer_single_quotes 42 | - prefer_spread_collections 43 | - recursive_getters 44 | - slash_for_doc_comments 45 | - type_init_formals 46 | - unawaited_futures 47 | - unnecessary_const 48 | - unnecessary_new 49 | - unnecessary_null_in_if_null_operators 50 | - unnecessary_this 51 | - unrelated_type_equality_checks 52 | - use_function_type_syntax_for_parameters 53 | - use_rethrow_when_possible 54 | - valid_regexps 55 | -------------------------------------------------------------------------------- /docs/packages/pedantic/analysis_options.yaml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2018, the Dart project authors. Please see the AUTHORS file 2 | # for details. All rights reserved. Use of this source code is governed by a 3 | # BSD-style license that can be found in the LICENSE file. 4 | # 5 | # Google internally enforced rules. See README.md for more information, 6 | # including a list of lints that are intentionally _not_ enforced. 7 | # 8 | # Include this file if you want to always use the latest version. If your 9 | # continuous build and/or presubmit check lints then they will likely fail 10 | # whenever a new version of `package:pedantic` is released. To avoid this, 11 | # specify a specific version of `analysis_options.yaml` instead. 12 | 13 | include: package:pedantic/analysis_options.1.9.0.yaml 14 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | dart pub get 4 | 5 | webdev serve --hostname 0.0.0.0 --live-reload 6 | -------------------------------------------------------------------------------- /lib/handle_dump_parser.dart: -------------------------------------------------------------------------------- 1 | import 'package:collection/collection.dart'; 2 | import 'package:csv/csv.dart'; 3 | import 'package:quiver/core.dart'; 4 | 5 | import 'sorting.dart'; 6 | 7 | const _csvHead = ['Owner', 'HandleCount', 'MostUsedHandle', 'Memory']; 8 | 9 | const _listEquality = ListEquality(); 10 | const _mapEquality = MapEquality(); 11 | 12 | /// Handle Dump Parser. 13 | class HandleDumpParser { 14 | HandleDumpParser._(); 15 | 16 | /// Parse a Handle Dump. 17 | static DumpResults parse(String file) { 18 | var count = 0; 19 | var owners = {}; 20 | var totalMemory = 0; 21 | var handleCount = 0; 22 | 23 | var lines = file.trim().split('\n'); 24 | for (var line in lines) { 25 | if (line.length < 53) { 26 | return _tryCSV(file); 27 | } 28 | 29 | if (++count < 2 || line.startsWith('-')) { 30 | continue; 31 | } 32 | 33 | final ownerName = line.substring(11, 32).trim(); 34 | 35 | final type = line.substring(32, 53).trim(); 36 | 37 | var memory = int.tryParse(line.substring(53).trim()); 38 | if (memory == null) { 39 | // SM 1.11+ compat 40 | memory = int.tryParse(line.substring(53, 64).trim()); 41 | } 42 | if (memory == null) { 43 | return null; 44 | } 45 | if (memory <= 0) { 46 | memory = 0; 47 | } 48 | handleCount++; 49 | 50 | totalMemory += memory; 51 | 52 | var owner = Owner(ownerName, type, memory); 53 | if (owners[ownerName] == null) { 54 | owners[ownerName] = owner; 55 | } else { 56 | owners[ownerName] 57 | ..memory += memory 58 | ..count += 1; 59 | 60 | owners[ownerName] 61 | .types 62 | .update(type, (value) => value + 1, ifAbsent: () => 1); 63 | 64 | owners[ownerName] 65 | .ownerMemory 66 | .update(type, (value) => value + memory, ifAbsent: () => memory); 67 | } 68 | } 69 | return DumpResults._(owners, totalMemory, handleCount, file); 70 | } 71 | 72 | static DumpResults _tryCSV(String file) { 73 | var list = CsvToListConverter(eol: '\n').convert(file); 74 | var head = list.first; 75 | if (!_listEquality.equals(_csvHead, head)) { 76 | return null; 77 | } 78 | var totalMemory = 0; 79 | var totalHandles = 0; 80 | var owners = []; 81 | for (var row in list.skip(1)) { 82 | var count = row[1]; 83 | var memory = row[3]; 84 | if (count is int && memory is int) { 85 | totalMemory += memory; 86 | totalHandles += count; 87 | owners.add( 88 | Owner(row[0] as String, row[2] as String, memory)..count = count); 89 | } 90 | return null; 91 | } 92 | return DumpResults._( 93 | Map.fromIterable(owners, 94 | key: (k) => k.owner as String, value: (v) => v as Owner), 95 | totalMemory, 96 | totalHandles, 97 | file); 98 | } 99 | } 100 | 101 | /// Dump results 102 | class DumpResults { 103 | final Map _owners; 104 | 105 | /// Total memory used. 106 | final int totalMemory; 107 | 108 | /// Total handle count. 109 | final int handleCount; 110 | 111 | /// Raw unparsed dump. 112 | final String raw; 113 | 114 | /// A Map containing all the owners names linked to the [Owner] objects. 115 | Map get owners => _owners; 116 | 117 | const DumpResults._( 118 | this._owners, this.totalMemory, this.handleCount, this.raw); 119 | 120 | /// Sort the handles by [Sorter]. 121 | List sort([Sorter sorter]) { 122 | sorter ??= Sorter(); 123 | var values = _owners.values.toList(); 124 | if (sorter.order == SortOrder.ascending) { 125 | switch (sorter.key) { 126 | case SortKey.owner: 127 | return values 128 | ..sort((a, b) => 129 | a.owner.toLowerCase().compareTo(b.owner.toLowerCase())); 130 | case SortKey.handles: 131 | return values..sort((a, b) => b.count.compareTo(a.count)); 132 | case SortKey.type: 133 | return values 134 | ..sort((a, b) => a 135 | .getMostUsedType() 136 | .toLowerCase() 137 | .compareTo(b.getMostUsedType().toLowerCase())); 138 | case SortKey.memory: 139 | return values..sort((a, b) => b.memory.compareTo(a.memory)); 140 | default: 141 | return null; 142 | } 143 | } else { 144 | switch (sorter.key) { 145 | case SortKey.owner: 146 | return values 147 | ..sort((a, b) => 148 | b.owner.toLowerCase().compareTo(a.owner.toLowerCase())); 149 | case SortKey.handles: 150 | return values..sort((a, b) => a.count.compareTo(b.count)); 151 | case SortKey.type: 152 | return values 153 | ..sort((a, b) => b 154 | .getMostUsedType() 155 | .toLowerCase() 156 | .compareTo(a.getMostUsedType().toLowerCase())); 157 | case SortKey.memory: 158 | return values..sort((a, b) => a.memory.compareTo(b.memory)); 159 | default: 160 | return null; 161 | } 162 | } 163 | } 164 | 165 | /// Compare two DumpResults 166 | DumpResults.compare(DumpResults dump1, DumpResults dump2) 167 | : _owners = dump1.owners, 168 | totalMemory = dump1.totalMemory, 169 | handleCount = dump1.handleCount, 170 | raw = dump1.raw { 171 | var owners1 = dump1.owners; 172 | var owners2 = dump2.owners; 173 | owners1.forEach((name, owner) { 174 | if (owners2[name] == null) { 175 | owner._added = true; 176 | return; 177 | } 178 | owner._changed = owners2[name] != owner; 179 | if (owner._changed) { 180 | owner._otherOwner = owners2[name]; 181 | assert(owner._otherOwner != null, 'Other Owner must be not null'); 182 | return; 183 | } 184 | }); 185 | owners2.forEach((name, owner) { 186 | if (owners1[name] == null) { 187 | owner._removed = true; 188 | owners1[name] = owner; 189 | } 190 | }); 191 | } 192 | 193 | /// Convert this object to a csv format string. 194 | String toCsv() { 195 | var csv = >[_csvHead]; 196 | 197 | owners.forEach((k, v) { 198 | csv.add([v.owner, v.count, v.getMostUsedType(), v.memory]); 199 | }); 200 | return ListToCsvConverter().convert(csv); 201 | } 202 | } 203 | 204 | /// Owner 205 | class Owner { 206 | /// Owner's name, 207 | final String owner; 208 | 209 | /// Map containing all the handles names and their count. 210 | Map types = {}; 211 | 212 | /// Map containing all the handles names the memory used. 213 | /// The keys have the same order and have the same names as [types]. 214 | Map ownerMemory = {}; 215 | 216 | /// The total handle count. 217 | int count = 1; 218 | 219 | /// Total memory used. 220 | int memory; 221 | 222 | bool _changed = false; 223 | 224 | bool _added = false; 225 | 226 | bool _removed = false; 227 | 228 | Owner _otherOwner; 229 | 230 | /// True if the results are changed. 231 | /// See [DumpResults.compare] 232 | bool get changed => _changed; 233 | 234 | /// True if this item was added in the current result. 235 | /// See [DumpResults.compare] 236 | bool get added => _added; 237 | 238 | /// True if this item was removed in the current result. 239 | /// See [DumpResults.compare] 240 | bool get removed => _removed; 241 | 242 | /// Returns the owner this was compared to. 243 | /// Throws if [changed] is false 244 | Owner get otherOwner => changed 245 | ? _otherOwner 246 | : throw UnsupportedError('This Owner did not change!'); 247 | 248 | /// Initialize Owner. 249 | Owner(this.owner, String type, this.memory) { 250 | types[type] = 1; 251 | ownerMemory[type] = memory; 252 | } 253 | 254 | @override 255 | // ignore: type_annotate_public_apis, avoid_equals_and_hash_code_on_mutable_classes 256 | bool operator ==(Object other) => 257 | other is Owner && 258 | _mapEquality.equals(types, other.types) && 259 | count == other.count && 260 | memory == other.memory; 261 | 262 | @override 263 | // ignore: avoid_equals_and_hash_code_on_mutable_classes 264 | int get hashCode => hash3(types, count, memory); 265 | 266 | /// Returns the most appearing handle type. 267 | String getMostUsedType() { 268 | var sortedKeys = types.keys.toList(growable: false) 269 | ..sort((k1, k2) => types[k2].compareTo(types[k1])); 270 | var sortedMap = Map.fromIterable(sortedKeys, 271 | key: (k) => k as String, value: (k) => types[k]); 272 | return sortedMap.keys.first; 273 | } 274 | 275 | @override 276 | String toString() { 277 | var sortedKeys = types.keys.toList(growable: false) 278 | ..sort((k1, k2) => types[k1].compareTo(types[k2])); 279 | var sortedMap = Map.fromIterable(sortedKeys, 280 | key: (k) => k as String, value: (k) => types[k]); 281 | var type = sortedMap.keys.first; 282 | 283 | var ownerBuffer = StringBuffer(owner); 284 | for (var i = owner.length; i < 28; i++) { 285 | ownerBuffer.write(' '); 286 | } 287 | var typeBuffer = StringBuffer(type); 288 | for (var i = type.length; i < 32; i++) { 289 | typeBuffer.write(' '); 290 | } 291 | 292 | return ownerBuffer.toString() + typeBuffer.toString() + memory.toString(); 293 | } 294 | } 295 | -------------------------------------------------------------------------------- /lib/sorting.dart: -------------------------------------------------------------------------------- 1 | /// Sorting order. 2 | enum SortOrder { 3 | /// Ascending, Highest to lowest. 4 | ascending, 5 | 6 | /// Descending, Lowest to Highest. 7 | descending, 8 | } 9 | 10 | /// Sorting key. 11 | enum SortKey { 12 | /// Owner name. 13 | owner, 14 | 15 | /// Handle total count. 16 | handles, 17 | 18 | /// Handle type name. 19 | type, 20 | 21 | /// Memory used. 22 | memory, 23 | } 24 | 25 | /// Sorter. 26 | class Sorter { 27 | /// Sorting order 28 | final SortOrder order; 29 | 30 | /// Sorting key 31 | final SortKey key; 32 | 33 | /// Initialize sorter. 34 | const Sorter({this.order = SortOrder.ascending, this.key = SortKey.memory}); 35 | } 36 | -------------------------------------------------------------------------------- /lib/web/dump_entry.dart: -------------------------------------------------------------------------------- 1 | /// 2 | class HistoryEntry { 3 | /// 4 | final int index; 5 | 6 | /// 7 | final int memory; 8 | 9 | /// 10 | final int handles; 11 | 12 | /// 13 | final String data; 14 | 15 | /// 16 | const HistoryEntry(this.index, this.memory, this.handles, this.data) 17 | : assert(index != null), 18 | assert(memory != null), 19 | assert(handles != null), 20 | assert(data != null); 21 | } 22 | -------------------------------------------------------------------------------- /lib/web/elements.dart: -------------------------------------------------------------------------------- 1 | import 'dart:html'; 2 | 3 | import '../handle_dump_parser.dart'; 4 | 5 | /// Textarea input 6 | final TextAreaElement textArea = querySelector('textarea') as TextAreaElement; 7 | 8 | /// File label 9 | final LabelElement fileslabel = querySelector('#filesLabel') as LabelElement; 10 | 11 | /// The theme link element 12 | final LinkElement themeElement = querySelector('#style') as LinkElement; 13 | 14 | /// Dump table element. 15 | final TableElement _dumpTable = querySelector('#dumpTable') as TableElement; 16 | 17 | /// Table body(tr) element. 18 | final TableSectionElement tableBody = _dumpTable.tBodies.first; 19 | 20 | /// The input form element. 21 | final FormElement dumpForm = querySelector('#dumpForm') as FormElement; 22 | 23 | /// The input file element. 24 | final InputElement fileInput = querySelector('#files') as InputElement; 25 | 26 | /// History list element. 27 | final UListElement historyListElement = 28 | querySelector('#history') as UListElement; 29 | 30 | /// Convert to CSV button element. 31 | final ButtonElement csvButton = querySelector('#csvButton') as ButtonElement; 32 | 33 | /// Compare button element. 34 | final ButtonElement compareButton = 35 | querySelector('#compareButton') as ButtonElement; 36 | 37 | /// Clear history button element. 38 | final ButtonElement clearButton = 39 | querySelector('#clearButton') as ButtonElement; 40 | 41 | /// Button to go the the previous history page. 42 | final ButtonElement leftArrow = 43 | querySelector('#leftArrowButton') as ButtonElement; 44 | 45 | /// Button to go the the next history page. 46 | final ButtonElement rightArrow = 47 | querySelector('#rightArrowButton') as ButtonElement; 48 | 49 | /// Owner body column. 50 | final TableCellElement ownerCol = 51 | querySelector('#ownerCol') as TableCellElement; 52 | 53 | /// Handle count column. 54 | final TableCellElement handleCol = 55 | querySelector('#handleCol') as TableCellElement; 56 | 57 | /// Most used handle type column. 58 | final TableCellElement typeCol = querySelector('#typeCol') as TableCellElement; 59 | 60 | /// Memory used column. 61 | final TableCellElement memoryCol = 62 | querySelector('#memoryCol') as TableCellElement; 63 | 64 | /// Sorting indicators. 65 | final List spanSort = 66 | querySelectorAll('[id\$=\'Sort\']').toList().cast(); 67 | 68 | /// The latest displayed result. 69 | DumpResults currentResult; 70 | 71 | /// Result displayed before [currentResult]. 72 | DumpResults oldResult; 73 | 74 | /// The latest displayed result id. 75 | int currentResultId; 76 | 77 | /// Result id set before [currentResultId]. 78 | int oldResultId; 79 | -------------------------------------------------------------------------------- /lib/web/indexdb.dart: -------------------------------------------------------------------------------- 1 | import 'dart:html'; 2 | import 'dart:indexed_db'; 3 | 4 | import '../handle_dump_parser.dart'; 5 | import '../sorting.dart'; 6 | import 'dump_entry.dart'; 7 | import 'elements.dart'; 8 | import 'sorter.dart'; 9 | import 'wrapper.dart'; 10 | 11 | Database _database; 12 | 13 | final _htmlValidator = NodeValidatorBuilder.common() 14 | ..allowElement('span', attributes: [ 15 | 'data-toggle', 16 | 'data-html', 17 | 'data-placement', 18 | 'data-container' 19 | ]); 20 | 21 | final _historyList = []; 22 | 23 | /// Initialize db. 24 | Future initDB() async { 25 | if (!IdbFactory.supported) { 26 | throw UnsupportedError('Indexed DB is not supported in this browser!'); 27 | } 28 | var idb = window.indexedDB; 29 | 30 | // Open database 31 | _database = await idb.open('dumps', 32 | version: 1, 33 | onUpgradeNeeded: (event) => 34 | _createObjectStore(event.target.result as Database)); 35 | 36 | // Get the dumps in the history. 37 | var transaction = _database.transaction('dumps', 'readonly'); 38 | var store = transaction.objectStore('dumps'); 39 | var request = store.getAll(null); 40 | 41 | request.onSuccess.listen((event) { 42 | _historyList.addAll((request.result as List).toHistoryList()); 43 | createHistory(); 44 | updateTable(); 45 | window.onHashChange.listen(updateTable); 46 | }); 47 | 48 | request.onError.listen((event) { 49 | window.console.error('Failed to retrieve history\n$event'); 50 | }); 51 | } 52 | 53 | /// Create the object store and its indexes. 54 | void _createObjectStore(Database database) { 55 | var store = database.createObjectStore('dumps', autoIncrement: true); 56 | store.createIndex('data', 'data', unique: false); 57 | store.createIndex('time', 'time', unique: false); 58 | store.createIndex('memory', 'memory', unique: false); 59 | store.createIndex('handles', 'handles', unique: false); 60 | } 61 | 62 | final _compareRegex = RegExp(r'^(\d*)-(\d*)$'); 63 | 64 | /// Update the table 65 | Future updateTable([_]) async { 66 | // Validate the hash. 67 | var hash = window.location.hash; 68 | if (hash.trim().isEmpty) { 69 | return; 70 | } 71 | hash = window.location.hash.substring(1); 72 | var id = int.tryParse(hash); 73 | 74 | // Try match compare 75 | int compareId; 76 | if (id == null) { 77 | var match = _compareRegex.firstMatch(hash); 78 | if (match == null) { 79 | window.location.hash = '#'; 80 | return; 81 | } 82 | id = int.tryParse(match.group(1)); 83 | compareId = int.tryParse(match.group(2)); 84 | if (id == null || 85 | compareId == null || 86 | compareId <= 0 || 87 | compareId > _historyList.length) { 88 | window.location.hash = '#'; 89 | return; 90 | } 91 | if (id == compareId) { 92 | window.location.hash = '#$id'; 93 | return; 94 | } 95 | } 96 | 97 | if (id <= 0 || id > _historyList.length) { 98 | window.location.hash = '#'; 99 | return; 100 | } 101 | 102 | var result = _historyList[id - 1]; 103 | 104 | assert(result != null, 'Null result with id: $id'); 105 | var dumpResults = HandleDumpParser.parse(result.data); 106 | 107 | if (dumpResults == null) { 108 | Snackbar.show(SnackbarParams( 109 | text: 'Invalid string!', pos: 'top-right', backgroundColor: '#cc3300')); 110 | return; 111 | } 112 | 113 | if (compareId != null) { 114 | result = _historyList[compareId - 1]; 115 | 116 | assert(result != null, 'Null result with id: $id (compare)'); 117 | var dumpResults2 = HandleDumpParser.parse(result.data); 118 | 119 | if (dumpResults2 == null) { 120 | Snackbar.show(SnackbarParams( 121 | text: 'Invalid string!', 122 | pos: 'top-right', 123 | backgroundColor: '#cc3300')); 124 | return; 125 | } 126 | 127 | dumpResults = DumpResults.compare(dumpResults, dumpResults2); 128 | } 129 | 130 | oldResult = currentResult; 131 | currentResult = dumpResults; 132 | 133 | oldResultId = currentResultId; 134 | currentResultId = id; 135 | 136 | csvButton.disabled = false; 137 | compareButton.disabled = oldResult == null; 138 | 139 | var results = dumpResults.sort(); 140 | resetSort(); 141 | tableBody.innerHtml = ''; 142 | results.forEach(appendRows); 143 | (jQuery('[data-toggle="tooltip"]') as TooltipElement).tooltip(); 144 | } 145 | 146 | /// Append the rows to the datatable 147 | void appendRows(Owner result) { 148 | if (result.changed) { 149 | tableBody.appendHtml( 150 | '' 151 | '${result.owner}${result.count} (${result.otherOwner.count})' 152 | '' 153 | '${result.getMostUsedType()}' 154 | ' (${result.otherOwner.getMostUsedType()})' 155 | '' 156 | '${result.memory} (${result.otherOwner.memory}) bytes' 157 | '', 158 | validator: _htmlValidator); 159 | } else if (result.added) { 160 | tableBody.appendHtml( 161 | '${result.owner}${result.count}${result.getMostUsedType()}${result.memory} bytes', 162 | validator: _htmlValidator); 163 | } else if (result.removed) { 164 | tableBody.appendHtml( 165 | '${result.owner}${result.count}${result.getMostUsedType()}${result.memory} bytes', 166 | validator: _htmlValidator); 167 | } else { 168 | tableBody.appendHtml( 169 | '${result.owner}${result.count}${result.getMostUsedType()}${result.memory} bytes', 170 | validator: _htmlValidator); 171 | } 172 | } 173 | 174 | /// Sort a table from a previous dumpResult. 175 | void sortTable(Sorter sorter) { 176 | var results = currentResult.sort(sorter); 177 | tableBody.innerHtml = ''; 178 | results.forEach(appendRows); 179 | 180 | (jQuery('[data-toggle="tooltip"]') as TooltipElement).tooltip(); 181 | } 182 | 183 | var _currentPage = 1; 184 | 185 | /// Creates the history list. 186 | void createHistory() { 187 | clearButton.disabled = _historyList.isEmpty; 188 | for (var e in _historyList 189 | .sublist((_historyList.length - 10).clamp(0, double.maxFinite).toInt())) { 190 | historyListElement.prependHtml( 191 | '
  • Dump #${e.index + 1}
    Memory: ${e.memory}
    Handles: ${e.handles}
  • '); 192 | } 193 | rightArrow.disabled = _historyList.length < 10; 194 | } 195 | 196 | /// Updates the history list, if [previous] is true it goes back otherwise to 197 | /// the next page. If [page] is not null the current page is set to that. 198 | void updateHistoryPage({final bool previous = false, final int page}) { 199 | historyListElement.text = ''; 200 | _currentPage += previous ? -1 : 1; 201 | if (page != null) { 202 | _currentPage = page; 203 | } 204 | for (var e in _historyList 205 | .sublist((_historyList.length - (10 * _currentPage)) 206 | .clamp(0, double.maxFinite) 207 | .toInt()) 208 | .take(10)) { 209 | historyListElement.prependHtml( 210 | '
  • Dump #${e.index + 1}
    Memory: ${e.memory}
    Handles: ${e.handles}
  • '); 211 | } 212 | leftArrow.disabled = _currentPage == 1; 213 | rightArrow.disabled = _historyList.length < (10 * _currentPage); 214 | } 215 | 216 | /// Add a new dump into the database. 217 | Future addData(DumpResults dump) async { 218 | var transaction = _database.transaction('dumps', 'readwrite'); 219 | await transaction.objectStore('dumps').add({ 220 | 'data': dump.raw, 221 | 'time': DateTime.now().millisecondsSinceEpoch.toString(), 222 | 'memory': dump.totalMemory, 223 | 'handles': dump.handleCount 224 | }); 225 | updateHistoryPage(page: 1); 226 | _historyList.add(HistoryEntry( 227 | _historyList.length, dump.totalMemory, dump.handleCount, dump.raw)); 228 | clearButton.disabled = false; 229 | var children = historyListElement.children; 230 | if (children.length >= 10) { 231 | children.removeLast(); 232 | } 233 | historyListElement.prependHtml( 234 | '
  • Dump #${_historyList.length}
    Memory: ${dump.totalMemory}
    Handles: ${dump.handleCount}
  • '); 235 | window.location.hash = '#${_historyList.length}'; 236 | } 237 | 238 | /// Clears all the history data. 239 | Future clearHistory() async { 240 | var transaction = _database.transaction('dumps', 'readwrite'); 241 | await transaction.objectStore('dumps').clear(); 242 | historyListElement.children.clear(); 243 | tableBody.innerHtml = ''; 244 | window.location.hash = '#'; 245 | _historyList.clear(); 246 | } 247 | 248 | /// Returns the owners' tooltip string. 249 | String _getTooltip(Owner owner) { 250 | var buffer = StringBuffer(''); 251 | var types = owner.types; 252 | var sortedKeys = types.keys.toList(growable: false) 253 | ..sort((k1, k2) => types[k2].compareTo(types[k1])); 254 | var sortedMap = Map.fromIterable(sortedKeys, 255 | key: (k) => k as String, value: (k) => types[k]); 256 | 257 | sortedMap.forEach((k, v) { 258 | buffer.write('$k - $v (${owner.ownerMemory[k]} bytes)
    '); 259 | }); 260 | buffer.write('
    '); 261 | return buffer.toString(); 262 | } 263 | 264 | extension on Element { 265 | void prependHtml(String text, 266 | {NodeValidator validator, NodeTreeSanitizer treeSanitizer}) { 267 | insertAdjacentHtml('afterbegin', text, 268 | validator: validator, treeSanitizer: treeSanitizer); 269 | } 270 | } 271 | 272 | extension on List { 273 | List toHistoryList() { 274 | var index = 0; 275 | return [ 276 | for (var e in this) 277 | HistoryEntry(index++, e['memory'] as int, e['handles'] as int, 278 | e['data'] as String) 279 | ]; 280 | } 281 | } 282 | -------------------------------------------------------------------------------- /lib/web/sorter.dart: -------------------------------------------------------------------------------- 1 | import 'dart:html'; 2 | 3 | import '../sorting.dart'; 4 | import 'elements.dart'; 5 | import 'indexdb.dart'; 6 | 7 | SortOrder _order = SortOrder.ascending; 8 | SortKey _key = SortKey.memory; 9 | 10 | /// Initialize sorting. 11 | void initSort() { 12 | ownerCol.onClick.listen(_handleEvent); 13 | handleCol.onClick.listen(_handleEvent); 14 | typeCol.onClick.listen(_handleEvent); 15 | memoryCol.onClick.listen(_handleEvent); 16 | } 17 | 18 | /// Reset the sorting settings. 19 | void resetSort() { 20 | _order = SortOrder.ascending; 21 | _key = SortKey.memory; 22 | for (var e in spanSort) { 23 | e.innerText = ''; 24 | } 25 | spanSort[3].innerText = '▼'; 26 | } 27 | 28 | void _handleEvent(MouseEvent event) { 29 | if (currentResult == null) { 30 | return; 31 | } 32 | 33 | var target = event.currentTarget as TableCellElement; 34 | var newKey = _stringToKey(target.id); 35 | assert(newKey != null); 36 | 37 | var span = target.children.first as SpanElement; 38 | if (newKey == _key) { 39 | if (_order == SortOrder.ascending) { 40 | _order = SortOrder.descending; 41 | span.innerText = '▲'; 42 | } else { 43 | _order = SortOrder.ascending; 44 | span.innerText = '▼'; 45 | } 46 | } else { 47 | for (var e in spanSort) { 48 | e.innerText = ''; 49 | } 50 | _order = SortOrder.ascending; 51 | _key = newKey; 52 | span.innerText = '▼'; 53 | } 54 | sortTable(Sorter(order: _order, key: _key)); 55 | } 56 | 57 | SortKey _stringToKey(String key) { 58 | switch (key) { 59 | case 'ownerCol': 60 | return SortKey.owner; 61 | case 'handleCol': 62 | return SortKey.handles; 63 | case 'typeCol': 64 | return SortKey.type; 65 | case 'memoryCol': 66 | return SortKey.memory; 67 | default: 68 | return null; 69 | } 70 | } 71 | /* 72 | /// Owner body column. 73 | TableRowElement get ownerCol => _ownerCol; 74 | 75 | /// Handle count column. 76 | TableRowElement get handleCol => _handleCol; 77 | 78 | /// Most used handle type column. 79 | TableRowElement get typeCol => _typeCol; 80 | 81 | /// Memory used column. 82 | TableRowElement get memoryCol => _memoryCol; 83 | */ 84 | -------------------------------------------------------------------------------- /lib/web/theme_loader.dart: -------------------------------------------------------------------------------- 1 | import 'dart:html'; 2 | 3 | import 'elements.dart'; 4 | 5 | /// Themes list. 6 | const themes = { 7 | 'light': 8 | 'https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/css/bootstrap.min.css', 9 | 'dark': 10 | 'https://stackpath.bootstrapcdn.com/bootswatch/4.5.0/darkly/bootstrap.min.css' 11 | }; 12 | 13 | /// CSS to add to elements which theme is not applied automatically. 14 | const themesCSS = { 15 | 'light': '', 16 | 'dark': 'border: 1px solid #006737;color: #fff;background-color: #222;' 17 | }; 18 | 19 | /// Local storage. 20 | final Storage localStorage = window.localStorage; 21 | 22 | /// Returns the current theme. 23 | String get currentTheme => localStorage['theme']; 24 | 25 | /// Load the selected css theme. 26 | void loadTheme(String themeString) { 27 | var theme = themes[themeString]; 28 | assert(theme != null, 'Theme $themeString is not valid!'); 29 | localStorage['theme'] = themeString; 30 | 31 | themeElement.href = theme; 32 | fileslabel.setAttribute('style', themesCSS[themeString]); 33 | textArea.setAttribute('style', themesCSS[themeString]); 34 | /* 35 | const textarea = document.querySelector('textarea'); 36 | textarea.onfocus = () => { 37 | textarea.style = themesCSS[theme]; 38 | }; 39 | textarea.style = themesCSS[theme]; 40 | document.querySelector('#filesLabel').style = themesCSS[theme]; 41 | */ 42 | } 43 | -------------------------------------------------------------------------------- /lib/web/wrapper.dart: -------------------------------------------------------------------------------- 1 | /// Snackbar wrapper library. 2 | @JS() 3 | library snackbar; 4 | 5 | import 'package:js/js.dart'; 6 | 7 | /// jQuery wrapper. 8 | @JS('\$') 9 | external dynamic jQuery(Object selector); 10 | 11 | /// Tooltip wrapper. 12 | @JS() 13 | @anonymous 14 | class TooltipElement { 15 | /// Initialize the tooltip from [jQuery] element. 16 | external Object tooltip(); 17 | } 18 | 19 | /// SnackbarParams wrapper. 20 | @anonymous 21 | @JS() 22 | class SnackbarParams { 23 | /// Initialize the params. 24 | external factory SnackbarParams( 25 | {String text, String pos, String backgroundColor}); 26 | 27 | /// Snackbar's text. 28 | external String get text; 29 | 30 | /// Snackbar's position. 31 | external String get pos; 32 | 33 | /// Snackbar's background color. 34 | external String get backgroundColor; 35 | } 36 | 37 | /// Snackbar wrapper. 38 | @JS('Snackbar') 39 | class Snackbar { 40 | /// Show the Snackbar. 41 | external static void show(SnackbarParams obj); 42 | } 43 | -------------------------------------------------------------------------------- /pubspec.yaml: -------------------------------------------------------------------------------- 1 | name: HandleDumpParser 2 | description: Tool to parse sourcemod handle dumps 3 | homepage: https://hexer10.github.io/Sourcemod-HandleDumpParser/ 4 | author: Mattia 5 | 6 | environment: 7 | sdk: '>=2.7.0 <3.0.0' 8 | 9 | dependencies: 10 | args: ^1.5.2 11 | pwa: ^0.2.0 12 | collection: ^1.14.12 13 | quiver: ^2.1.2+1 14 | csv: ^4.0.3 15 | # path: ^1.4.1 16 | 17 | dev_dependencies: 18 | build_runner: ^1.7.3 19 | build_web_compilers: ^2.9.0 20 | effective_dart: ^1.1.0 -------------------------------------------------------------------------------- /web/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 30 | 31 | 32 | Handle Dump parser 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 64 | 65 | 66 | 67 | 68 |
    69 |
    70 |
    71 |
    72 |
      73 |
    74 | 75 | 83 | 84 | 88 | 89 | 98 |
    99 |
    100 |
    101 |
    102 | 104 | 105 |
    106 |
    107 | 108 | 109 | 110 |
    111 | 112 | 113 | 114 |
    115 |
    116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 |
    Owner Handle count Most used handle type Memory
    128 |
    129 |
    130 |
    131 |
    132 |
    133 | 136 | 139 | 142 | 143 | 148 | 149 | -------------------------------------------------------------------------------- /web/main.dart: -------------------------------------------------------------------------------- 1 | import 'dart:html'; 2 | import 'dart:js'; 3 | import 'dart:js_util'; 4 | 5 | import 'package:HandleDumpParser/handle_dump_parser.dart'; 6 | import 'package:HandleDumpParser/web/elements.dart'; 7 | import 'package:HandleDumpParser/web/indexdb.dart'; 8 | import 'package:HandleDumpParser/web/sorter.dart'; 9 | import 'package:HandleDumpParser/web/theme_loader.dart'; 10 | import 'package:HandleDumpParser/web/wrapper.dart'; 11 | 12 | Future main() async { 13 | // loadTheme(); 14 | await initDB(); 15 | initSort(); 16 | dumpForm.onSubmit.listen(onFormSubmit); 17 | fileInput.onChange.listen(onFileSubmit); 18 | csvButton.onClick.listen((event) { 19 | if (currentResult == null) { 20 | Snackbar.show(SnackbarParams( 21 | text: 'No dump is selected.', 22 | pos: 'top-right', 23 | backgroundColor: '#cc3300')); 24 | return; 25 | } 26 | var csv = currentResult.toCsv(); 27 | var result = copyToClipboard(csv); 28 | if (result) { 29 | Snackbar.show(SnackbarParams( 30 | text: 'Text copied to the clipboard.', 31 | pos: 'top-right', 32 | backgroundColor: '#5cb85c')); 33 | } else { 34 | window.console.log(csv); 35 | Snackbar.show(SnackbarParams( 36 | text: 37 | 'Failed to copy the text, check the dev console for the output.', 38 | pos: 'top-right', 39 | backgroundColor: '#cc3300')); 40 | } 41 | }); 42 | compareButton.onClick.listen((event) { 43 | if (currentResult == null || oldResult == null) { 44 | Snackbar.show(SnackbarParams( 45 | text: 'Compare failed', 46 | pos: 'top-right', 47 | backgroundColor: '#cc3300')); 48 | return; 49 | } 50 | window.location.hash = '#$currentResultId-$oldResultId'; 51 | }); 52 | textArea.onFocus.listen((event) { 53 | textArea.setAttribute('style', themesCSS[currentTheme]); 54 | }); 55 | clearButton.onClick.listen((event) => clearHistory()); 56 | leftArrow.onClick.listen((event) => updateHistoryPage(previous: true)); 57 | rightArrow.onClick.listen((event) => updateHistoryPage()); 58 | setProperty(window, 'loadTheme', allowInterop(loadTheme)); 59 | 60 | } 61 | 62 | void onFormSubmit(Event event) { 63 | event.preventDefault(); 64 | var dumpArea = querySelector('#dumpArea') as TextAreaElement; 65 | var dump = dumpArea.value; 66 | 67 | var dumpResults = HandleDumpParser.parse(dump); 68 | 69 | if (dumpResults == null) { 70 | Snackbar.show(SnackbarParams( 71 | text: 'Invalid string!', pos: 'top-right', backgroundColor: '#cc3300')); 72 | return; 73 | } 74 | addData(dumpResults); 75 | dumpArea.value = ''; 76 | } 77 | 78 | void onFileSubmit(_) { 79 | var fileInput = (querySelector('#files') as InputElement).files; 80 | 81 | if (fileInput.isEmpty) { 82 | return; 83 | } 84 | 85 | var reader = FileReader(); 86 | 87 | reader.onLoad.listen((fileEvent) { 88 | var dump = reader.result as String; 89 | var dumpResults = HandleDumpParser.parse(dump); 90 | 91 | if (dumpResults == null) { 92 | Snackbar.show(SnackbarParams( 93 | text: 'Invalid string!', 94 | pos: 'top-right', 95 | backgroundColor: '#cc3300')); 96 | return; 97 | } 98 | addData(dumpResults); 99 | }); 100 | 101 | reader.readAsText(fileInput[0], 'UTF-8'); 102 | } 103 | 104 | /* 105 | const copyToClipboard = str => { 106 | const el = document.createElement('textarea'); 107 | el.value = str; 108 | el.setAttribute('readonly', ''); 109 | el.style.position = 'absolute'; 110 | el.style.left = '-9999px'; 111 | document.body.appendChild(el); 112 | el.select(); 113 | document.execCommand('copy'); 114 | document.body.removeChild(el); 115 | }; 116 | */ 117 | bool copyToClipboard(String text) { 118 | final textArea = TextAreaElement(); 119 | textArea.value = text; 120 | textArea.setAttribute('readonly', ''); 121 | textArea.style.position = 'absolute'; 122 | textArea.style.left = '-9999px'; 123 | document.body.append(textArea); 124 | textArea.select(); 125 | var r = document.execCommand('copy'); 126 | document.body.children.last.remove(); 127 | return r; 128 | } 129 | -------------------------------------------------------------------------------- /web/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Handle Dump Parser", 3 | "short_name": "Handle Dump Parser", 4 | "description": "Parser for sourcemod handle dumps.", 5 | "lang": "en-US", 6 | "start_url": "/", 7 | "scope": "/", 8 | "display": "standalone", 9 | "orientation": "any", 10 | "theme_color": "#ffffff", 11 | "background_color": "#ffffff" 12 | } 13 | --------------------------------------------------------------------------------