rubymacros 0.1.5 → 0.1.6

data/History.txt

@@ -1,4 +1,114 @@
-=== 0.1.5 / 2009-07-04
+=== 0.1.6 / 4apr2012
+* Big things:
+  * allow macros to have receivers
+  * redparse coalescer: coalescer is faster!
+  * nothingness macros:
+    * macros that expand to nil should disappear entirely
+    * except expansion to nothing inside array literal; that makes a nil
+    * NopNode is only deleted in these cases, nilified otherwise:
+      * UndefNode,AssigneeList,ArrayLiteralNode,SequenceNode,ListInNode
+  * 2 new syntaces for form escapes
+* Little things:
+  * allow macros to work in irb!
+  * error msgs from macros now mention original macro source file
+  * importing macro-specific lexer hacks from rubylexer
+  * moving my RedParse extensions into a module
+  * erase linenumbers of nodes interpolated into elsewhere in a parsetree
+  * put correct linenums in nodes inserted in macro expansion
+  * refine detection of unsupported varargs or block
+  * Reg::Formula objs are defanged when quoted
+  * other Reg objects are left untouched when quoted
+  * hacky node class that just wraps a string and unparses to it
+  * fixed warnings
+  * hacky: form escape (troublesome) level of quotitude error check disabled
+* Experimental Changes:
+  * optional, experimental macro_expand of forms inline 
+  * instead of the usual way: deep_copy of a entry from a pre-built table
+* Forms and Form Escapes:
+  * added new keyword op: 'v', like unary caret, but very low precedence
+    * and make sure any inputs with the ident v in them get renamed
+  * added yet another syntax for form escapes, enclosed by <+ and +>
+  * support for the argument of a form escape (^) being a splat expr
+    * (^* is needed so 1 formesc can expand to multiple actual exprs)
+  * added rule for 'doubled parens' 
+    * (where name of called method is in a form esc)
+  * fixed rule for forms to allow nothing between parens
+  * parens around form escapes in lhs is required right now
+* Convenience Apis:
+  * allow 1st arg to Macro.eval to be a Node, was required to be a String
+  * added macro-like things for flow control directives (return, next, etc)
+  * methods for listing and deleting all macros in a module
+  * make array in the lexer parameter slot to constructor work
+  * MacroMixin module can be #extend'd to a parser after it's created
+  * in Macro.expand, input can now be an IO
+  * ListInNode[whatever] now works
+  * filename param to Macro.expand defaults to "(eval)" if not given
+  * renamed classes:
+    * renamed RedParseWithMacros class to RedParse::WithMacros
+    * renamed Macro::Macro_ParserMixin to RedParse::MacroMixin,
+    * always keeping old names as an aliases
+  * rubymacros.rb is an alias for macro.rb
+  * first pass at macroruby cmd-line interpreter 
+    * like ruby but with macros autoenabled
+* Serializing/Copying Objects: marshal unparse pretty_print inspect dup clone
+  * FormNode is now marshalable 
+  * FormNode is now dup/clone-able
+  * make form escape in assign lhs unparse correctly (needs extra parens)
+  * don't panic if no rescues in MacroNode#unparse
+  * shortcut pretty printing of forms and form escapes (and ListInNodes)
+    * when we know it will just be evaled again
+  * pretty up the #inspect output for FormNode
+  * serialization of FormNode via #inspect works better
+* Node Api:
+  * made alias names (#body and #text) for the contents of a form
+  * FormParameterNode renamed to FormEscapeNode
+  * made FormEscapeNode#body alias to #val (contents of form esc)
+  * in FormEscapeNode, prefer #body to #first as the name of the contents
+  * FormEscapeNode#initialize now takes just 1 arg (the expr to escape)
+  * tolerate plain array inside MetaClassNode
+  * FormNode's @parameters should be made into ListInNode
+* Examples:
+  * added a new, more complete unroll implementation
+    * adding 1st pass at handling flow control for some unrolled loops
+    * make deep copies of s-exps duplicated by unroll, 
+      * to ensure the tree doesn't become a dag
+  * improvements to inline
+    * hacky manual rebuild_transform on result of inline macro
+    * walk only part of inline result that contains user's original body
+    * don't stop walking inlined method body early
+    * inlined method params should be parenthesized as well as escaped
+  * improvements to with
+    * reimplemented to take a block instead
+    * an even fancier version uses xform_tree!, 
+      * but that doesnt work yet, so its disabled
+  * improvements to assert
+    * improved wording of assert err msg in non-op case
+    * improved assert's detection of compare operators
+    * new example, simpified version of assert
+  * added another formless_macro implementation
+  * new example, simple forwarding to a method
+    * inspired by roger pack. not working right now 
+  * added a bunch of examples
+* Tests:
+  * define some more mutators of test data
+    * to check for problems with form escs, etc
+  * a test which verifies each example prints its expected output.
+  * delete existing macros before starting various tests
+  * skip form testcases for test data that are not legal ruby
+  * skipping some random selection of slower tests.
+  * add test/ directory to $: for ruby 1.9
+  * warn, not error on diff in just Node#offset after wrapping in a form 
+  * tests of specific features:
+    * first pass at a test for the loop unroller
+    * testing form as receiver of method call seems to work more or less.
+    * test marshaling a particular form that's failing in ruby < 1.9.2
+    * test of escape from inner form
+    * fixed test of second formless macro to actually test the 2nd macro
+    * test macros that expand to nothing 
+    * test form escape on assign lhs
+    * testing assertions work right when disabled as well.
+
+=== 0.1.5 / 4jul2009
 * 4 Major Enhancements:
   * all macros are now immediate, not delayed
   * macro calls can accept blocks
@@ -10,18 +120,18 @@
   * forms can now be catenated together with + in the obvious way
   * HashLiteralNode can be treated somewhat like a real hash, using #get
 
-=== 0.1.4 / 2009-05-21
+=== 0.1.4 / 21may2009
 * 1 Major Enhancement:
   * line numbers are now preserved in preprocessed code; 
   *   backtraces should make more sense.
 * 1 Minor Enhancement:
   * updated to keep in sync with the latest RedParse api (sigh)
 
-=== 0.1.3 / 2009-05-02
+=== 0.1.3 / 2may2009
 * 1 Minor Enhancement:
   * depend on redparse>=0.8.1, since 0.8.0 had a stupid permission problem
 
-=== 0.1.2 / 2009-04-26
+=== 0.1.2 / 26apr2009
 * 7 Minor Enhancements
   * lots of nice comments added, thanks to Paul Brannan and Tatsuji Kawai
   * Paul fixed the weird rdoc failure too!
@@ -31,7 +141,7 @@
   * in test_form.rb, don't test deep_copy on nil forms
   * all files should be world-readable now
 
-=== 0.1.0 / 2008-10-24
+=== 0.1.0 / 24oct2008
 * 1 Major Enhancement
   * Birthday!
 

data/Makefile

@@ -0,0 +1,68 @@
+#    rubymacros - a macro preprocessor for ruby
+#    Copyright (C) 2008, 2016  Caleb Clausen
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Lesser General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Lesser General Public License for more details.
+#
+#    You should have received a copy of the GNU Lesser General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+name=RubyMacros
+lname=rubymacros
+gemname=rubymacros
+
+lib/macro/ReduceWithsFor_RedParse_RedParse__MacroMixin_RedParse__WithMacros_1_8.rb: lib/macro.rb
+	redparse -r=lib/macro.rb --cache=no -o=lib/macro/ -c WithMacros
+
+lib/macro/ReduceWithsFor_RedParse_RedParse__MacroMixin_RedParse__WithMacros_1_9.rb: lib/macro.rb
+	redparse -r=lib/macro.rb --cache=no -o=lib/macro/ -c 'WithMacros 1.9'
+
+parser: lib/macro/ReduceWithsFor_RedParse_RedParse__MacroMixin_RedParse__WithMacros_1_8.rb lib/macro/ReduceWithsFor_RedParse_RedParse__MacroMixin_RedParse__WithMacros_1_9.rb
+.PHONY: parser
+
+#everything after this line is generic
+
+version=$(shell ruby -r ./lib/$(lname)/version.rb -e "puts $(name)::VERSION")
+filelist=$(shell git ls-files)
+
+.PHONY: all test docs gem tar pkg email
+all: test
+
+test:
+	ruby -Ilib test/test_all.rb
+
+docs:
+	rdoc lib/*
+
+pkg: gem tar
+
+gem:
+	gem build $(lname).gemspec
+
+tar:
+	tar cf - $(filelist) | ( mkdir $(gemname)-$(version); cd $(gemname)-$(version); tar xf - )
+	tar czf $(gemname)-$(version).tar.gz $(gemname)-$(version)
+	rm -rf $(gemname)-$(version)
+
+email: README.txt History.txt
+	ruby -e ' \
+  require "rubygems"; \
+  load "./$(lname).gemspec"; \
+  spec= Gem::Specification.list.find{|x| x.name=="$(gemname)"}; \
+  puts "\
+Subject: [ANN] $(name) #{spec.version} Released \
+\n\n$(name) version #{spec.version} has been released! \n\n\
+#{Array(spec.homepage).map{|url| " * #{url}\n" }} \
+ \n\
+#{$(name)::Description} \
+\n\nChanges:\n\n \
+#{$(name)::Latest_changes} \
+"\
+'

data/README.txt

@@ -26,10 +26,6 @@ Although in theory already as powerful as lisp macros, the current
 implementation has a number of problems which added together make it merely 
 a proof of concept or toy at this point:
  * pre-processing is very, very slow (because of RedParse)
- * macro calls must be inside some sort of method;
- * straight out macro calls at the top level won't work
- * macros can't have blocks or receivers
- * some ruby syntax is unsupported in files using macros
  * files using macros must be loaded via Macro.require;
  * Kernel#require will not recognize macros
  * macros cannot be scoped
@@ -77,7 +73,7 @@ result of an escaped expression (which should be a Node) is interpolated
 into the form at that point. The whole effect is much like that of string
 interpolations (#{}) inside string literals.
 
-== How Macros Work
+== How Macros Work:
 Typically, macros return a single form literal, which contains form escape 
 expressions within it which make use of the macro's parameters. However, 
 macro bodies may contain anything at all; more complicated macros will 
@@ -91,6 +87,33 @@ The parsetrees for the arguments to the callsite are passed as arguments to
 the macro. The macro is expected to return a parsetree, which replaces the 
 macro callsite in the parsetree which contained it. 
 
+=== How to use the examples:
+All the example code in the example/ directory is split into 2 parts; the 
+actual example file itself (say, example/foo.rb) and a wrapper around it
+(say, example/foo_wrap.rb) which requires 'macro' and then Macro.requires 
+the example itself. To run the examples, you should run the _wrap file, not 
+the example file itself. For example, to try out assert.rb, you would 
+issue this command line:
+  ruby example/assert_wrap.rb
+The example wrappers all expect to be run from the main rubymacros 
+directory, not the example/ subdirectory.
+
+I wish this 2-level scheme were not necessary, so that you could directly
+execute a file containing macros, with perhaps a -rmacro preceding it on
+the command line. However, it isn't possible to override how the interpreter
+treats it command line arguments. I would hope that files named on the 
+command line (with or without a -r option) would be pulled in via 
+Kernel#require, but this is not the case.
+
+
+== Hacker's guide (well, section)
+If you modify the parse rules (that is, RedParse::MacroMixin#RULES) you will 
+need to recompile them before they will work. To do that, run 'make parser'. 
+This will, unfortunately, take a little while to run. Running 'make parser' 
+will regenerate two files:
+  lib/macro/ReduceWithsFor_RedParse_RedParse__MacroMixin_RedParse__WithMacros_1_8.rb 
+  lib/macro/ReduceWithsFor_RedParse_RedParse__MacroMixin_RedParse__WithMacros_1_9.rb
+which normally come pre-generated with rubymacros.
 
 
 == Known Problems
@@ -102,7 +125,7 @@ macro callsite in the parsetree which contained it.
 
 
 == License:
-Copyright (C) 2008  Caleb Clausen
+Copyright (C) 2008, 2016  Caleb Clausen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by

data/TODO

@@ -3,6 +3,7 @@ macro options
   'protected' vs unprotected macros -- params and result surrounded by ()
   precedence for operator macros
   hygienic vs unhygienic
+  simple vs complete?
 
 need to insert extra parens around form params
   except only if it stands in for an rvalue...

data/bin/macroruby

@@ -0,0 +1,69 @@
+=begin
+    rubymacros - a macro preprocessor for ruby
+    Copyright (C) 2008, 2016  Caleb Clausen
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+#!/usr/bin/env ruby
+
+prelude=['require "macro"']
+
+i=0
+while i<ARGV.size
+
+  #end of interpreter options? 
+  break if /\A(?:[^-]|-?-\z)/===ARGV[i]
+
+  all,er,rest=ARGV[i].match /\A[Sacdhlnpsvwy]*([er])(.*)\z/
+
+  case er
+  when 'r'  #input could come from file named w/ -r on cmd line
+    if !rest.empty?
+      prelude<<"Macro.require "+rest.inspect
+    else
+      ARGV[i]=nil
+      prelude<<"Macro.require "+ARGV[i+=1].inspect
+    end
+    ARGV[i]=nil
+
+  when 'e'  #input could come from -e string on the cmd line
+    if !rest.empty?
+      prelude<<rest
+    else
+      ARGV[i]=nil
+      prelude<<ARGV[i+=1]
+    end
+    ARGV[i]=nil
+    got_e=true
+  end
+
+  i+=1
+end
+
+#input could come from stdin
+if "-"==ARGV[i] or !ARGV[i]
+  ARGV[i]="-"
+else
+  prelude<<"Macro.load "+ARGV[i].inspect
+  ARGV[i]=nil
+end unless got_e
+
+ARGV.compact!
+
+ARGV.push "-e", prelude.join('; ')
+
+p ARGV
+ruby=RbConfig::CONFIG['bindir']+'/'+RbConfig::CONFIG["ruby_install_name"]
+#exec ruby,*ARGV #does not return

data/example/__dir__.rb

@@ -1,3 +1,21 @@
+=begin
+    rubymacros - a macro preprocessor for ruby
+    Copyright (C) 2008, 2016  Caleb Clausen
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
 macro __DIR__
   :(File.dirname(__FILE__))
 end

data/example/__dir___wrap.rb

@@ -1,3 +1,21 @@
+=begin
+    rubymacros - a macro preprocessor for ruby
+    Copyright (C) 2008, 2016  Caleb Clausen
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
 require 'macro'
 Macro.require 'example/__dir__.rb'
 

data/example/andand.rb

@@ -1,3 +1,21 @@
+=begin
+    rubymacros - a macro preprocessor for ruby
+    Copyright (C) 2008, 2016  Caleb Clausen
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
 macro andand(a,b)
   :(^a and ^b)
 end

data/example/andand_wrap.rb

@@ -1,2 +1,20 @@
+=begin
+    rubymacros - a macro preprocessor for ruby
+    Copyright (C) 2008, 2016  Caleb Clausen
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
 require "macro"
 Macro.require "example/andand"

data/example/assert.rb

@@ -1,12 +1,32 @@
+=begin
+    rubymacros - a macro preprocessor for ruby
+    Copyright (C) 2008, 2016  Caleb Clausen
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
 #this file uses macros! won't parse in normal ruby
 macro assert(cond)
     if $Debug
-      if RedParse::OpNode===cond and /\A[=!]=\Z/===cond.op
-        left,op,right=*cond
+      if RedParse::OpNode===cond and 
+              /\A(?:[=!][=~]|[<>]=?|===)\Z/===cond.op
+        #left,op,right=*cond
+        left=cond.left; op=cond.op; right=cond.right
         :(fail 'expected '+^left.unparse+"(==#{^left}) to be "+
                ^op+" "+^right.unparse+"(==#{^right})" unless ^cond)    
       else
-        :(fail "expected #{:(^^cond)}, but was not true" unless ^cond)
+        :(fail "I expected that #{:(^^cond)}" unless ^cond)
       end
     end
 end
@@ -25,14 +45,15 @@ def test_assert
     assert(a==b) #oops, fails. msg="expected a(==1) to be == b(==2)"
   rescue Exception=>e
     assert("expected a(==1) to be == b(==2)"== e.message) #better be ok
-  else puts "exception expected but was not seen"
+  else fail "exception expected but was not seen"
   end
 
   begin
-    assert(nil) #oops, fails. msg="expected nil, but was not true"
+    assert(!a) #oops, fails. msg="expected nil, but was not true"
   rescue Exception=>e
-    assert("expected nil, but was not true"== e.message) #better be ok
-    #ok, that message didn't make a lot of sense...
-  else puts "exception expected but was not seen"
+    assert(/^I expected that ! *a$/=== e.message) #better be ok
+  else fail "exception expected but was not seen"
   end
+  
+  puts "all assertions passed"
 end