File: resolve_globals.js

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (142 lines) | stat: -rw-r--r-- 3,300 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/**
* @license Apache-2.0
*
* Copyright (c) 2019 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MAIN //

var walk = require( 'acorn-walk' ).ancestor;
var resolveLocalScopes = require( './resolve_local_scopes.js' );
var contains = require( './contains.js' );
var appendUnique = require( './append_unique.js' );


// FUNCTIONS //

/**
* Tests whether an AST node declares an `arguments` variable.
*
* @private
* @param {Node} node - AST node
* @returns {boolean} boolean indicating whether an AST node declares an `arguments` variable
*/
function declaresArguments( node ) {
	return (
		node.type === 'FunctionExpression' ||
		node.type === 'FunctionDeclaration'
	);
}

/**
* Tests whether an AST node declares a `this` variable.
*
* @private
* @param {Node} node - AST node
* @returns {boolean} boolean indicating whether an AST node declares a `this` variable
*/
function declaresThis( node ) {
	return (
		node.type === 'FunctionExpression' ||
		node.type === 'FunctionDeclaration'
	);
}


// MAIN //

/**
* Resolves global variables within an abstract syntax tree (AST).
*
* @private
* @param {AST} ast - abstract syntax tree (AST)
* @throws {TypeError} must provide a program AST node
* @returns {Array} list of global variables
*/
function resolveGlobals( ast ) {
	var visitors;
	var globals;
	if ( ast.type !== 'Program' ) {
		throw new TypeError( 'invalid argument. Must provide a program AST node.' );
	}
	globals = [];

	// Resolve local scopes:
	ast = resolveLocalScopes( ast );

	// Define callbacks for relevant AST nodes:
	visitors = {
		'VariablePattern': Identifier,
		'Identifier': Identifier,
		'ThisExpression': ThisExpression
	};

	// Walk the AST to resolve globals:
	walk( ast, visitors );

	return globals;

	/**
	* Callback invoked upon encountering an identifier AST node.
	*
	* @private
	* @param {Node} node - AST node
	* @param {Array} parents - array of parent AST nodes
	*/
	function Identifier( node, parents ) {
		var locals;
		var name;
		var i;

		name = node.name;
		if ( name === 'undefined' ) {
			return;
		}
		for ( i = 0; i < parents.length; i++ ) {
			if ( name === 'arguments' && declaresArguments( parents[ i ] ) ) {
				return;
			}
			locals = parents[ i ].locals;
			if ( locals && contains( locals.length, locals, 1, 0, name ) ) {
				return;
			}
		}
		appendUnique( globals, name );
	}

	/**
	* Callback invoked upon encountering a `ThisExpression` AST node.
	*
	* @private
	* @param {Node} node - AST node
	* @param {Array} parents - array of parent AST nodes
	*/
	function ThisExpression( node, parents ) {
		var i;
		for ( i = 0; i < parents.length; i++ ) {
			if ( declaresThis( parents[ i ] ) ) {
				return;
			}
		}
		appendUnique( globals, 'this' );
	}
}


// EXPORTS //

module.exports = resolveGlobals;