kotovalexarian-likes-github/jashkenas--coffeescript
1
0
Fork 0
mirror of https://github.com/jashkenas/coffeescript.git synced 2022-11-09 12:23:24 -05:00
Code Releases Activity

finished up the CoffeeScript version of the Scope object

Browse source
This commit is contained in:
Jeremy Ashkenas 2010-02-08 21:10:48 -05:00
parent 69808ba523
commit b8d22bc572
8 changed files with 244 additions and 143 deletions
Download patch file Download diff file Expand all files Collapse all files

64
lib/coffee_script/nodes.js
View file

@ -1,6 +1,7 @@
(function(){ (function(){
var Expressions, LiteralNode, Node, TAB, TRAILING_WHITESPACE, compact, del, dup, flatten, inherit, merge, statement; var Expressions, LiteralNode, Node, TAB, TRAILING_WHITESPACE, compact, del, dup, flatten, inherit, merge, statement;
var __hasProp = Object.prototype.hasOwnProperty; var __hasProp = Object.prototype.hasOwnProperty;
process.mixin(require('./scope'));
// The abstract base class for all CoffeeScript nodes. // The abstract base class for all CoffeeScript nodes.
// All nodes are implement a "compile_node" method, which performs the // All nodes are implement a "compile_node" method, which performs the
// code generation for that node. To compile a node, call the "compile" // code generation for that node. To compile a node, call the "compile"
@ -271,7 +272,7 @@
}; };
// Quickie inheritance convenience wrapper to reduce typing. // Quickie inheritance convenience wrapper to reduce typing.
inherit = function inherit(parent, props) { inherit = function inherit(parent, props) {
var __a, __b, __c, klass, name, prop; var __a, __b, klass, name, prop;
klass = props.constructor; klass = props.constructor;
delete props.constructor; delete props.constructor;
__a = function(){}; __a = function(){};
@ -279,16 +280,13 @@
klass.__superClass__ = parent.prototype; klass.__superClass__ = parent.prototype;
klass.prototype = new __a(); klass.prototype = new __a();
klass.prototype.constructor = klass; klass.prototype.constructor = klass;
klass.prototype[name] = (function() { __b = props;
__b = []; __c = props; for (name in __b) {
for (name in __c) { prop = __b[name];
prop = __c[name]; if (__hasProp.call(__b, name)) {
if (__hasProp.call(__c, name)) { ((klass.prototype[name] = prop));
__b.push(prop);
} }
} }
return __b;
}).call(this);
return klass; return klass;
}; };
// # Provide a quick implementation of a children method. // # Provide a quick implementation of a children method.
@ -378,20 +376,10 @@
}; };
// A collection of nodes, each one representing an expression. // A collection of nodes, each one representing an expression.
Expressions = (exports.Expressions = inherit(Node, { Expressions = (exports.Expressions = inherit(Node, {
constructor: function constructor() { constructor: function constructor(nodes) {
var nodes;
nodes = Array.prototype.slice.call(arguments, 0);
this.expressions = flatten(nodes); this.expressions = flatten(nodes);
return this.children = this.expressions; this.children = this.expressions;
}, return this;
// Wrap up a node as an Expressions, unless it already is.
wrap: function wrap() {
var nodes;
nodes = Array.prototype.slice.call(arguments, 0);
if (nodes.length === 1 && nodes[0] instanceof Expressions) {
return nodes[0];
}
return new Expressions.apply(this, nodes);
}, },
// Tack an expression on to the end of this expression list. // Tack an expression on to the end of this expression list.
push: function push(node) { push: function push(node) {
@ -483,28 +471,40 @@
})); }));
} }
// If it's not part of a constructor, we can just return the value of the expression. // If it's not part of a constructor, we can just return the value of the expression.
if (!((o.scope.function == undefined ? undefined : o.scope.function.is_constructor()))) { if (!((o.scope.method == undefined ? undefined : o.scope.method.is_constructor()))) {
return this.idt() + 'return ' + node.compile(o); return this.idt() + 'return ' + node.compile(o);
} }
// It's the last line of a constructor, add a safety check. // It's the last line of a constructor, add a safety check.
temp = o.scope.free_variable(); temp = o.scope.free_variable();
return this.idt() + temp + ' = ' + node.compile(o) + ";\n" + this.idt() + "return " + o.scope.function.name + ' === this.constructor ? this : ' + temp + ';'; return this.idt() + temp + ' = ' + node.compile(o) + ";\n" + this.idt() + "return " + o.scope.method.name + ' === this.constructor ? this : ' + temp + ';';
} }
})); }));
// Wrap up a node as an Expressions, unless it already is one.
Expressions.wrap = function wrap(nodes) {
if (nodes.length === 1 && nodes[0] instanceof Expressions) {
return nodes[0];
}
return new Expressions(nodes);
};
statement(Expressions); statement(Expressions);
// Literals are static values that can be passed through directly into // Literals are static values that can be passed through directly into
// JavaScript without translation, eg.: strings, numbers, true, false, null... // JavaScript without translation, eg.: strings, numbers, true, false, null...
LiteralNode = (exports.LiteralNode = function LiteralNode(value) { LiteralNode = (exports.LiteralNode = inherit(Node, {
var __a; constructor: function constructor(value) {
this.value = value; this.value = value;
__a = this.children = [value]; return this.children = [value];
return LiteralNode === this.constructor ? this : __a; },
});
// Break and continue must be treated as statements -- they lose their meaning // Break and continue must be treated as statements -- they lose their meaning
// when wrapped in a closure. // when wrapped in a closure.
LiteralNode.prototype.is_statement = function is_statement() { is_statement: function is_statement() {
return this.value === 'break' || this.value === 'continue'; return this.value === 'break' || this.value === 'continue';
}; },
compile_node: function compile_node(o) {
var end, idt;
idt = this.is_statement() ? this.idt() : '';
end = this.is_statement() ? ';' : '';
return idt + this.value + end;
}
}));
LiteralNode.prototype.is_statement_only = LiteralNode.prototype.is_statement; LiteralNode.prototype.is_statement_only = LiteralNode.prototype.is_statement;
LiteralNode.prototype.compile_node = function compile_node(o) { };
})(); })();

4
lib/coffee_script/nodes.rb
View file

@ -180,8 +180,8 @@ module CoffeeScript
end end
# Literals are static values that have a Ruby representation, eg.: a string, a number, # Literals are static values that can be passed through directly into
# true, false, nil, etc. # JavaScript without translation, eg.: strings, numbers, true, false, null...
class LiteralNode < Node class LiteralNode < Node
children :value children :value

6
lib/coffee_script/parser.js
View file

@ -362,7 +362,7 @@
}), o("WHILE Expression", function() { }), o("WHILE Expression", function() {
return new WhileNode($2, null); return new WhileNode($2, null);
}), o("Expression WHILE Expression", function() { }), o("Expression WHILE Expression", function() {
return new WhileNode($3, Expressions.wrap($1)); return new WhileNode($3, Expressions.wrap([$1]));
}) })
], ],
// Array comprehensions, including guard and current index. // Array comprehensions, including guard and current index.
@ -460,11 +460,11 @@
If: [o("IfBlock IfEnd", function() { If: [o("IfBlock IfEnd", function() {
return $1.add_else($2); return $1.add_else($2);
}), o("Expression IF Expression", function() { }), o("Expression IF Expression", function() {
return new IfNode($3, Expressions.wrap($1), null, { return new IfNode($3, Expressions.wrap([$1]), null, {
statement: true statement: true
}); });
}), o("Expression UNLESS Expression", function() { }), o("Expression UNLESS Expression", function() {
return new IfNode($3, Expressions.wrap($1), null, { return new IfNode($3, Expressions.wrap([$1]), null, {
statement: true, statement: true,
invert: true invert: true
}); });

138
lib/coffee_script/scope.js
View file

@ -1,50 +1,27 @@
(function(){ (function(){
var dup; var Scope, succ;
var __hasProp = Object.prototype.hasOwnProperty; var __hasProp = Object.prototype.hasOwnProperty;
dup = function dup(input) { // Scope objects form a tree corresponding to the shape of the function
var __a, __b, __c, key, output, val;
output = null;
if (input instanceof Array) {
output = [];
__a = input;
for (__b = 0; __b < __a.length; __b++) {
val = __a[__b];
output.push(val);
}
} else {
output = {
};
__c = input;
for (key in __c) {
val = __c[key];
if (__hasProp.call(__c, key)) {
output.key = val;
}
}
output;
}
return output;
};
// scope objects form a tree corresponding to the shape of the function
// definitions present in the script. They provide lexical scope, to determine // definitions present in the script. They provide lexical scope, to determine
// whether a variable has been seen before or if it needs to be declared. // whether a variable has been seen before or if it needs to be declared.
exports.Scope = function Scope(parent, expressions, func) { //
var __a;
// Initialize a scope with its parent, for lookups up the chain, // Initialize a scope with its parent, for lookups up the chain,
// as well as the Expressions body where it should declare its variables, // as well as the Expressions body where it should declare its variables,
// and the function that it wraps. // and the function that it wraps.
Scope = (exports.Scope = function Scope(parent, expressions, method) {
var __a;
this.parent = parent; this.parent = parent;
this.expressions = expressions; this.expressions = expressions;
this.function = func; this.method = method;
this.variables = { this.variables = {
}; };
__a = this.temp_variable = this.parent ? dup(this.parent.temp_variable) : '__a'; this.temp_variable = this.parent ? this.parent.temp_variable : '__a';
__a = this;
return Scope === this.constructor ? this : __a; return Scope === this.constructor ? this : __a;
}; });
// Look up a variable in lexical scope, or declare it if not found. // Look up a variable in lexical scope, or declare it if not found.
exports.Scope.prototype.find = function find(name, rem) { Scope.prototype.find = function find(name, remote) {
var found, remote; var found;
remote = (typeof rem !== "undefined" && rem !== null) ? rem : false;
found = this.check(name); found = this.check(name);
if (found || remote) { if (found || remote) {
return found; return found;
@ -54,20 +31,99 @@
}; };
// Define a local variable as originating from a parameter in current scope // Define a local variable as originating from a parameter in current scope
// -- no var required. // -- no var required.
exports.Scope.prototype.parameter = function parameter(name) { Scope.prototype.parameter = function parameter(name) {
return this.variables[name] = 'param'; return this.variables[name] = 'param';
}; };
// Just check to see if a variable has already been declared. // Just check to see if a variable has already been declared.
exports.Scope.prototype.check = function check(name) { Scope.prototype.check = function check(name) {
if ((typeof this.variables[name] !== "undefined" && this.variables[name] !== null)) { if (this.variables[name]) {
return true; return true;
} }
// TODO: what does that ruby !! mean..? need to follow up
// .. this next line is prolly wrong ..
return !!(this.parent && this.parent.check(name)); return !!(this.parent && this.parent.check(name));
}; };
// You can reset a found variable on the immediate scope. // You can reset a found variable on the immediate scope.
exports.Scope.prototype.reset = function reset(name) { Scope.prototype.reset = function reset(name) {
return this.variables[name] = undefined; return delete this.variables[name];
};
// Find an available, short, name for a compiler-generated variable.
Scope.prototype.free_variable = function free_variable() {
while (check(this.temp_variable)) {
((this.temp_variable = succ(this.temp_variable)));
}
this.variables[this.temp_variable] = 'var';
return this.temp_variable;
};
// Ensure that an assignment is made at the top of scope (or top-level
// scope, if requested).
Scope.prototype.assign = function assign(name, value, top_level) {
if (top_level && this.parent) {
return this.parent.assign(name, value, top_level);
}
return this.variables[name] = {
value: value,
assigned: true
};
};
// Does this scope reference any variables that need to be declared in the
// given function body?
Scope.prototype.has_declarations = function has_declarations(body) {
return body === this.expressions && this.declared_variables().length;
};
// Does this scope reference any assignments that need to be declared at the
// top of the given function body?
Scope.prototype.has_assignments = function has_assignments(body) {
return body === this.expressions && this.assigned_variables().length;
};
// Return the list of variables first declared in current scope.
Scope.prototype.declared_variables = function declared_variables() {
var __a, __b, key, val;
return ((function() {
__a = []; __b = this.variables;
for (key in __b) {
val = __b[key];
if (__hasProp.call(__b, key)) {
if (val === 'var') {
__a.push(key);
}
}
}
return __a;
}).call(this)).sort();
};
// Return the list of variables that are supposed to be assigned at the top
// of scope.
Scope.prototype.assigned_variables = function assigned_variables() {
var __a, __b, key, val;
return ((function() {
__a = []; __b = this.variables;
for (key in __b) {
val = __b[key];
if (__hasProp.call(__b, key)) {
if (val.assigned) {
__a.push([key, val.value]);
}
}
}
return __a;
}).call(this)).sort();
};
Scope.prototype.compiled_declarations = function compiled_declarations() {
return this.declared_variables().join(', ');
};
Scope.prototype.compiled_assignments = function compiled_assignments() {
var __a, __b, __c, t;
return ((function() {
__a = []; __b = this.assigned_variables();
for (__c = 0; __c < __b.length; __c++) {
t = __b[__c];
__a.push(t[0] + ' = ' + t[1]);
}
return __a;
}).call(this)).join(', ');
};
// Helper functions:
// The next character alphabetically, to produce the following string.
succ = function succ(str) {
return str.slice(0, str.length - 1) + String.fromCharCode(str.charCodeAt(str.length - 1) + 1);
}; };
})(); })();

4
lib/coffee_script/scope.rb
View file

@ -55,10 +55,14 @@ module CoffeeScript
@variables[name.to_sym] = Value.new(value) @variables[name.to_sym] = Value.new(value)
end end
# Does this scope reference any variables that need to be declared in the
# given function body?
def declarations?(body) def declarations?(body)
!declared_variables.empty? && body == @expressions !declared_variables.empty? && body == @expressions
end end
# Does this scope reference any assignments that need to be declared at the
# top of the given function body?
def assignments?(body) def assignments?(body)
!assigned_variables.empty? && body == @expressions !assigned_variables.empty? && body == @expressions
end end

36
src/nodes.coffee
View file

@ -1,3 +1,5 @@
process.mixin require './scope'
# The abstract base class for all CoffeeScript nodes. # The abstract base class for all CoffeeScript nodes.
# All nodes are implement a "compile_node" method, which performs the # All nodes are implement a "compile_node" method, which performs the
# code generation for that node. To compile a node, call the "compile" # code generation for that node. To compile a node, call the "compile"
@ -79,7 +81,7 @@ inherit: (parent, props) ->
klass: props.constructor klass: props.constructor
delete props.constructor delete props.constructor
klass extends parent klass extends parent
klass.prototype[name]: prop for name, prop of props (klass.prototype[name]: prop) for name, prop of props
klass klass
# # Provide a quick implementation of a children method. # # Provide a quick implementation of a children method.
@ -147,14 +149,10 @@ Node::top_sensitive: -> false
# A collection of nodes, each one representing an expression. # A collection of nodes, each one representing an expression.
Expressions: exports.Expressions: inherit Node, { Expressions: exports.Expressions: inherit Node, {
constructor: (nodes...) -> constructor: (nodes) ->
@expressions: flatten nodes @expressions: flatten nodes
@children: @expressions @children: @expressions
this
# Wrap up a node as an Expressions, unless it already is.
wrap: (nodes...) ->
return nodes[0] if nodes.length is 1 and nodes[0] instanceof Expressions
new Expressions(nodes...)
# Tack an expression on to the end of this expression list. # Tack an expression on to the end of this expression list.
push: (node) -> push: (node) ->
@ -218,30 +216,42 @@ Expressions: exports.Expressions: inherit Node, {
# If it's a statement, the node knows how to return itself. # If it's a statement, the node knows how to return itself.
return node.compile(merge(o, {returns: true})) if node.is_statement() return node.compile(merge(o, {returns: true})) if node.is_statement()
# If it's not part of a constructor, we can just return the value of the expression. # If it's not part of a constructor, we can just return the value of the expression.
return @idt() + 'return ' + node.compile(o) unless o.scope.function?.is_constructor() return @idt() + 'return ' + node.compile(o) unless o.scope.method?.is_constructor()
# It's the last line of a constructor, add a safety check. # It's the last line of a constructor, add a safety check.
temp: o.scope.free_variable() temp: o.scope.free_variable()
@idt() + temp + ' = ' + node.compile(o) + ";\n" + @idt() + "return " + o.scope.function.name + ' === this.constructor ? this : ' + temp + ';' @idt() + temp + ' = ' + node.compile(o) + ";\n" + @idt() + "return " + o.scope.method.name + ' === this.constructor ? this : ' + temp + ';'
} }
# Wrap up a node as an Expressions, unless it already is one.
Expressions.wrap: (nodes) ->
return nodes[0] if nodes.length is 1 and nodes[0] instanceof Expressions
new Expressions(nodes)
statement Expressions statement Expressions
# Literals are static values that can be passed through directly into # Literals are static values that can be passed through directly into
# JavaScript without translation, eg.: strings, numbers, true, false, null... # JavaScript without translation, eg.: strings, numbers, true, false, null...
LiteralNode: exports.LiteralNode: (value) -> LiteralNode: exports.LiteralNode: inherit Node, {
constructor: (value) ->
@value: value @value: value
@children: [value] @children: [value]
# Break and continue must be treated as statements -- they lose their meaning # Break and continue must be treated as statements -- they lose their meaning
# when wrapped in a closure. # when wrapped in a closure.
LiteralNode::is_statement: -> is_statement: ->
@value is 'break' or @value is 'continue' @value is 'break' or @value is 'continue'
compile_node: (o) ->
idt: if @is_statement() then @idt() else ''
end: if @is_statement() then ';' else ''
idt + @value + end
}
LiteralNode::is_statement_only: LiteralNode::is_statement LiteralNode::is_statement_only: LiteralNode::is_statement
LiteralNode::compile_node: (o) ->

6
src/parser.coffee
View file

@ -353,7 +353,7 @@ grammar: {
While: [ While: [
o "WHILE Expression Block", -> new WhileNode($2, $3) o "WHILE Expression Block", -> new WhileNode($2, $3)
o "WHILE Expression", -> new WhileNode($2, null) o "WHILE Expression", -> new WhileNode($2, null)
o "Expression WHILE Expression", -> new WhileNode($3, Expressions.wrap($1)) o "Expression WHILE Expression", -> new WhileNode($3, Expressions.wrap([$1]))
] ]
# Array comprehensions, including guard and current index. # Array comprehensions, including guard and current index.
@ -427,8 +427,8 @@ grammar: {
# The full complement of if blocks, including postfix one-liner ifs and unlesses. # The full complement of if blocks, including postfix one-liner ifs and unlesses.
If: [ If: [
o "IfBlock IfEnd", -> $1.add_else($2) o "IfBlock IfEnd", -> $1.add_else($2)
o "Expression IF Expression", -> new IfNode($3, Expressions.wrap($1), null, {statement: true}) o "Expression IF Expression", -> new IfNode($3, Expressions.wrap([$1]), null, {statement: true})
o "Expression UNLESS Expression", -> new IfNode($3, Expressions.wrap($1), null, {statement: true, invert: true}) o "Expression UNLESS Expression", -> new IfNode($3, Expressions.wrap([$1]), null, {statement: true, invert: true})
] ]
} }

99
src/scope.coffee
View file

@ -1,49 +1,80 @@
dup: (input) -> # Scope objects form a tree corresponding to the shape of the function
output: null
if input instanceof Array
output: []
for val in input
output.push(val)
else
output: {}
for key, val of input
output.key: val
output
output
# scope objects form a tree corresponding to the shape of the function
# definitions present in the script. They provide lexical scope, to determine # definitions present in the script. They provide lexical scope, to determine
# whether a variable has been seen before or if it needs to be declared. # whether a variable has been seen before or if it needs to be declared.
exports.Scope: (parent, expressions, func) -> #
# Initialize a scope with its parent, for lookups up the chain, # Initialize a scope with its parent, for lookups up the chain,
# as well as the Expressions body where it should declare its variables, # as well as the Expressions body where it should declare its variables,
# and the function that it wraps. # and the function that it wraps.
this.parent: parent Scope: exports.Scope: (parent, expressions, method) ->
this.expressions: expressions @parent: parent
this.function: func @expressions: expressions
this.variables: {} @method: method
this.temp_variable: if this.parent then dup(this.parent.temp_variable) else '__a' @variables: {}
@temp_variable: if @parent then @parent.temp_variable else '__a'
this
# Look up a variable in lexical scope, or declare it if not found. # Look up a variable in lexical scope, or declare it if not found.
exports.Scope::find: (name, rem) -> Scope::find: (name, remote) ->
remote: if rem? then rem else false found: @check name
found: this.check(name) return found if found or remote
return found if found || remote @variables[name]: 'var'
this.variables[name]: 'var'
found found
# Define a local variable as originating from a parameter in current scope # Define a local variable as originating from a parameter in current scope
# -- no var required. # -- no var required.
exports.Scope::parameter: (name) -> Scope::parameter: (name) ->
this.variables[name]: 'param' @variables[name]: 'param'
# Just check to see if a variable has already been declared. # Just check to see if a variable has already been declared.
exports.Scope::check: (name) -> Scope::check: (name) ->
return true if this.variables[name]? return true if @variables[name]
# TODO: what does that ruby !! mean..? need to follow up !!(@parent and @parent.check(name))
# .. this next line is prolly wrong ..
not not (this.parent and this.parent.check(name))
# You can reset a found variable on the immediate scope. # You can reset a found variable on the immediate scope.
exports.Scope::reset: (name) -> Scope::reset: (name) ->
this.variables[name]: undefined delete @variables[name]
# Find an available, short, name for a compiler-generated variable.
Scope::free_variable: ->
(@temp_variable: succ(@temp_variable)) while check @temp_variable
@variables[@temp_variable]: 'var'
@temp_variable
# Ensure that an assignment is made at the top of scope (or top-level
# scope, if requested).
Scope::assign: (name, value, top_level) ->
return @parent.assign(name, value, top_level) if top_level and @parent
@variables[name]: {value: value, assigned: true}
# Does this scope reference any variables that need to be declared in the
# given function body?
Scope::has_declarations: (body) ->
body is @expressions and @declared_variables().length
# Does this scope reference any assignments that need to be declared at the
# top of the given function body?
Scope::has_assignments: (body) ->
body is @expressions and @assigned_variables().length
# Return the list of variables first declared in current scope.
Scope::declared_variables: ->
(key for key, val of @variables when val is 'var').sort()
# Return the list of variables that are supposed to be assigned at the top
# of scope.
Scope::assigned_variables: ->
([key, val.value] for key, val of @variables when val.assigned).sort()
Scope::compiled_declarations: ->
@declared_variables().join(', ')
Scope::compiled_assignments: ->
(t[0] + ' = ' + t[1] for t in @assigned_variables()).join(', ')
# Helper functions:
# The next character alphabetically, to produce the following string.
succ: (str) ->
str.slice(0, str.length - 1) +
String.fromCharCode(str.charCodeAt(str.length - 1) + 1)