msgpack-idl 0.1.0 → 0.1.1

data/ChangeLog

@@ -1,4 +1,8 @@
 
+2011-04-26 version 0.1.1
+
+  * Added RPC support
+
 2011-04-23 version 0.1.0
 
   * Initial release

data/lib/msgpack/idl/ast.rb

@@ -20,7 +20,21 @@ module IDL
 
 
 module AST
+	SUMMARY_LINES = 6
+
 	class Element
+		alias text to_s
+
+		def summary
+			t = text
+			lines = t.split("\n")
+			return t if lines.size <= SUMMARY_LINES
+			if lines.last == "}"
+				(lines[0,SUMMARY_LINES-2] + ["    ...", "}"]).join("\n")
+			else
+				(lines[0,SUMMARY_LINES-1] + ["    ..."]).join("\n")
+			end
+		end
 	end
 
 	class Document < Array
@@ -31,6 +45,10 @@ module AST
 			@path = path
 		end
 		attr_reader :path
+
+		def text
+			"include #{@path}"
+		end
 	end
 
 
@@ -40,6 +58,14 @@ module AST
 			@lang = lang
 		end
 		attr_reader :scopes, :lang
+
+		def text
+			if @lang
+				"namespace #{@lang} #{@scopes.join('.')}"
+			else
+				"namespace #{@scopes.join('.')}"
+			end
+		end
 	end
 
 
@@ -50,6 +76,15 @@ module AST
 			@fields = fields
 		end
 		attr_reader :name, :super_class, :fields
+
+		def text
+			t = "message #{@name}"
+			t << " < #{@super_class.text}" if @super_class
+			t << " {\n"
+			t << @fields.map {|f| "    #{f.text}\n" }.join
+			t << "}"
+			t
+		end
 	end
 
 
@@ -65,6 +100,14 @@ module AST
 			@modifier = modifier
 		end
 		attr_reader :id, :type, :name, :modifier
+
+		def text
+			if @modifier == FIELD_OPTIONAL
+				"#{@id}: optional #{@type.text} #{@name}"
+			else
+				"#{@id}: #{@type.text} #{@name}"
+			end
+		end
 	end
 
 	class ValueAssignedField < Field
@@ -73,6 +116,10 @@ module AST
 			@value = value
 		end
 		attr_reader :value
+
+		def text
+			"#{super} = #{@value.text}"
+		end
 	end
 
 
@@ -82,6 +129,13 @@ module AST
 			@fields = fields
 		end
 		attr_reader :name, :fields
+
+		def text
+			t = "enum #{@name} {\n"
+			t << @fields.map {|f| "    #{f.text}\n" }.join
+			t << "}"
+			t
+		end
 	end
 
 	class EnumField < Element
@@ -90,16 +144,65 @@ module AST
 			@name = name
 		end
 		attr_reader :id, :name
+
+		def text
+			"#{@id}: #{@name}"
+		end
 	end
 
 
 	class Service < Element
-		def initialize(name, version, funcs)
+		def initialize(name, version, functions)
 			@name = name
 			@version = version
-			@funcs = funcs
+			@functions = functions
+		end
+		attr_reader :name, :version, :functions
+
+		def text
+			t = "service #{@name}"
+			t << ":#{@version}" if @version
+			t << " {\n"
+			t << @functions.map {|f| "    #{f.text}\n" }.join
+			t << "}"
+			t
+		end
+	end
+
+	class Inherit < Element
+	end
+
+	class InheritAll < Inherit
+		def text
+			"inherit *"
+		end
+	end
+
+	class InheritName < Inherit
+		def initialize(name)
+			@name = name
+		end
+		attr_reader :name
+
+		def text
+			"inherit #{@name}"
+		end
+	end
+
+	class InheritFunc < Inherit
+		def initialize(name, return_type, args, exceptions)
+			@name = name
+			@return_type = return_type
+			@args = args
+			@exceptions = exceptions
+		end
+		attr_reader :name, :return_type, :args, :exceptions
+
+		def text
+			t = "inherit #{@return_type.text} #{@name}(#{@args.map {|a| a.text }.join(', ') })"
+			t << " throws #{@exceptions.map {|ex| ex.text }.join(', ')}" if @exceptions && !@exceptions.empty?
+			t
 		end
-		attr_reader :name, :version, :funcs
 	end
 
 	class Func < Element
@@ -110,6 +213,12 @@ module AST
 			@exceptions = exceptions
 		end
 		attr_reader :name, :return_type, :args, :exceptions
+
+		def text
+			t = "#{@return_type.text} #{@name}(#{@args.map {|a| a.text }.join(', ')})"
+			t << " throws #{@exceptions.map {|ex| ex.text }.join(', ')}" if @exceptions && !@exceptions.empty?
+			t
+		end
 	end
 
 
@@ -121,6 +230,13 @@ module AST
 
 		attr_reader :name
 		attr_reader :scopes
+
+		def text
+			t = "application #{@name} {\n"
+			t << @scopes.map {|sc| "    #{sc.text}\n" }.join
+			t << "}"
+			t
+		end
 	end
 
 	class Scope < Element
@@ -135,6 +251,12 @@ module AST
 		def default?
 			@default
 		end
+
+		def text
+			t = "#{@service}:#{@version} #{@name}"
+			t << " default" if @default
+			t
+		end
 	end
 
 
@@ -148,6 +270,14 @@ module AST
 		def nullable?
 			@nullable
 		end
+
+		def text
+			if @nullable
+				"#{@name}?"
+			else
+				"#{@name}"
+			end
+		end
 	end
 
 	class GenericType < Type
@@ -156,6 +286,10 @@ module AST
 			@type_params = type_params
 		end
 		attr_reader :type_params
+
+		def text
+			"#{super}<#{@type_params.map {|tp| tp.text }.join(',')}>"
+		end
 	end
 
 	FIELD_OPTIONAL = :optional
@@ -170,6 +304,10 @@ module AST
 			@name = name
 		end
 		attr_reader :name
+
+		def text
+			"#{@name}"
+		end
 	end
 
 	class EnumLiteral < Literal
@@ -178,6 +316,10 @@ module AST
 			@field = field
 		end
 		attr_reader :name, :field
+
+		def text
+			"#{@name}.#{@field}"
+		end
 	end
 
 	class IntLiteral < Literal
@@ -185,6 +327,10 @@ module AST
 			@value = value
 		end
 		attr_reader :value
+
+		def text
+			"#{@value}"
+		end
 	end
 
 	class FlaotLiteral < Literal
@@ -192,9 +338,16 @@ module AST
 			@value = value
 		end
 		attr_reader :value
+
+		def text
+			"#{@value}"
+		end
 	end
 
 	class NilLiteral < Literal
+		def text
+			%[nil]
+		end
 	end
 
 	class BoolLiteral < Literal
@@ -202,6 +355,10 @@ module AST
 			@value = value
 		end
 		attr_reader :value
+
+		def text
+			"#{@value}"
+		end
 	end
 
 	class TrueLiteral < BoolLiteral
@@ -220,6 +377,10 @@ module AST
 		def initialize(value)
 			@value = value
 		end
+
+		def text
+			@value.dump
+		end
 	end
 
 	#class ListLiteral < Literal

data/lib/msgpack/idl/command/example.rb

@@ -22,16 +22,16 @@ module Example
 		LIST
 	end
 
-	def self.show(name)
+	def self.get(name)
 		n, summary, code = LIST.find {|n, summary, code|
 			name == n
 		}
 		unless code
 			raise "unknown example name: #{name}"
 		end
-		puts "# #{name} - #{summary} example"
-		puts code
-		nil
+		result = "# #{name} - #{summary} example\n"
+		result << code
+		result
 	end
 
 	def self.add(name, summary, code)
@@ -129,6 +129,66 @@ message LogInLog {
     1: UserInfo user
     2: Sites site
 }
+EOF
+
+	add 'service', 'simple rpc', <<EOF
+exception DiskError {
+    1: string message
+}
+
+service PropertyStoreService {
+    raw? get(1: raw key)
+    void set(1: raw key, 2: raw value) throws DiskError
+}
+EOF
+
+	add 'version', 'versioned rpc', <<EOF
+exception DiskError {
+    1: string message
+}
+
+service PropertyStoreService:0 {
+    void set(1: raw key, 2: raw value)
+    raw? get(1: raw key)
+}
+
+service PropertyStoreService:1 {
+    void set(1: raw key, 2: raw value) throws DiskError
+
+    # inherit former version's function
+    inherit get
+}
+
+service PropertyStoreService:2 {
+    void set(1: raw key, 2: raw value, 3: int flags) throws DiskError
+
+    # type-checked inheritance
+    inherit raw? get(1: raw key)
+
+    int? getFlags(1: raw key)
+}
+
+service PropertyStoreService:3 {
+    # inherit all functions
+    inherit *
+}
+EOF
+
+	add 'application', 'multi-namespace rpc', <<EOF
+service KeyValueService:0 {
+    void set(1: raw key, 2: raw value)
+    raw? get(1: raw key)
+}
+
+service CacheService:0 {
+    void set(1: raw key, 2: raw value, 3: long expire)
+    raw? get(1: raw key)
+}
+
+application MyApp {
+    KeyValueService:0 kv default
+    CacheService:0 cache
+}
 EOF
 
 end

data/lib/msgpack/idl/command/idl.rb

@@ -29,6 +29,8 @@ Usage: #{prog} [options] -g LANG files...
 options:
 EOF
 
+op.summary_indent = "  "
+
 comment = <<EOF
 examples:
   - generate java code from test.msgspec file:
@@ -36,19 +38,19 @@ examples:
       $ ls gen-java  # generated codes are here
 
   - generate java code from test.msgspec file to ./out directory:
-      $ #{prog} -g java -o out test.msgspec
+      $ #{prog} -g java -o ./out test.msgspec
 
   - install or update language module
-      $ msgpack-idl --update java
+      $ #{prog} --update java
 
   - show examples
-      $ msgpack-idl --example # show list of examples
-      $ msgpack-idl --example "types"
+      $ #{prog} --example # show list of examples
+      $ #{prog} --example "types"
 
   - generate sample code
-      $ msgpack-idl --update java
-      $ msgpack-idl --example sample > sample.msgspec
-      $ msgpack-idl -g java sample.msgspec
+      $ #{prog} --install java
+      $ #{prog} --example sample > sample.msgspec
+      $ #{prog} -g java sample.msgspec
 EOF
 
 (class<<self;self;end).module_eval do
@@ -82,15 +84,15 @@ op.on('--update', 'install or update a language module') {
 	cmd = :update
 }
 
-op.on('--list', 'show list of available language modules') {
+op.on('--list', 'show list of installed language modules') {
 	cmd = :list
 }
 
-op.on_tail('--help', 'show this message') {
+op.on('--help', 'show this message') {
 	usage nil
 }
 
-op.on_tail('--version', 'show version') {
+op.on('--version', 'show version') {
 	require 'msgpack/idl/version'
 	puts MessagePack::IDL::VERSION
 	exit 0
@@ -124,11 +126,22 @@ when :example
 
 	def show_available_examples
 		puts "available examples:"
+		name_max = Example.list.max {|name,_,_| name.length }[0].length
 		Example.list.each {|name,summary,code|
-			puts "  #{name}#{" "*(10-name.length)}: #{summary}"
+			puts "  #{name}#{" "*(name_max+2-name.length)}: #{summary}"
 		}
 	end
 
+	def try_color_print(code)
+		require 'msgpack/idl/command/vimcolor'
+		syntax = File.join(
+				File.expand_path(File.dirname(__FILE__)), 'vimcolor', 'msgspec.vim')
+		vc = VimColor.new('vim', nil, nil, [":filetype off", ":source #{syntax}"])
+		puts vc.run(code, 'msgspec', :ansi)
+	rescue
+		puts code
+	end
+
 	if ARGV.length == 0
 		show_available_examples
 		exit 1
@@ -139,7 +152,7 @@ when :example
 
 	name = ARGV[0]
 	begin
-		Example.show(name)
+		code = Example.get(name)
 	rescue
 		show_available_examples
 		puts ""
@@ -147,6 +160,12 @@ when :example
 		exit 1
 	end
 
+	if STDOUT.tty?
+		try_color_print(code)
+	else
+		puts code
+	end
+
 when :update
 	require 'rubygems'
 	require 'rubygems/gem_runner'
@@ -178,13 +197,14 @@ when :update
 
 when :list
 	list = []
-	dirs = Gem.all_load_paths.grep("msgpack-idl")
-	dirs.each {|dir|
-		path = File.join(dir, "msgpack/idl/lang")
-		if File.directory?(path)
-			list.concat Dir.entries(path)
-		end
+	langdir = File.join('lib', 'msgpack', 'idl', 'lang')
+	Gem.path.each {|gemdir|
+		pattern = File.join(gemdir, 'gems', 'msgpack-idl-*', 'lib', 'msgpack', 'idl', 'lang', '*.rb')
+		Dir.glob(pattern).each {|path|
+			list << File.basename(path, '.rb')
+		}
 	}
+	list = list.sort.uniq
 
 	puts "available language modules:"
 	list.each {|lang|
@@ -221,6 +241,7 @@ when :generate
 	rescue LoadError
 		available = false
 	end
+
 	if !available || !MessagePack::IDL::Generator.available?(lang)
 		puts "Language module #{lang.dump} is not available."
 		puts "Try to install it as follows:"
@@ -228,35 +249,47 @@ when :generate
 		exit 1
 	end
 
-	parser = MessagePack::IDL::Parser.new
-	files.each {|path|
-		if path == "-"
-			text = STDIN.read
-			parser.parse(text, '(stdin)', '.')
-		else
-			parser.parse_file(path)
+	begin
+		parser = MessagePack::IDL::Parser.new
+		files.each {|path|
+			if path == "-"
+				text = STDIN.read
+				parser.parse(text, '(stdin)', '.')
+			else
+				parser.parse_file(path)
+			end
+		}
+		ast = parser.ast
+
+		if conf[:show_ast]
+			require 'pp'
+			$stderr.puts "AST:"
+			$stderr.puts ast.pretty_inspect
 		end
-	}
-	ast = parser.ast
 
-	if conf[:show_ast]
-		require 'pp'
-		$stderr.puts "AST:"
-		$stderr.puts ast.pretty_inspect
-	end
+		ev = MessagePack::IDL::Evaluator.new
+		ev.evaluate(ast)
+		ev.evaluate_inheritance
+		ir = ev.evaluate_spec(lang)
+
+		if conf[:show_ir]
+			require 'pp'
+			$stderr.puts "IR:"
+			$stderr.puts ir.pretty_inspect
+		end
 
-	ev = MessagePack::IDL::Evaluator.new
-	ev.evaluate(ast)
-	ev.evaluate_inheritance
-	ir = ev.evaluate_spec(lang)
+		gen = MessagePack::IDL::Generator.new
+		gen.generate(lang, ir, out)
 
-	if conf[:show_ir]
-		require 'pp'
-		$stderr.puts "IR:"
-		$stderr.puts ir.pretty_inspect
+	rescue MessagePack::IDL::SyntaxError => error
+		puts error.to_s
+		puts ""
+		exit 1
+	rescue MessagePack::IDL::SemanticsError => error
+		puts error.to_s
+		puts ""
+		exit 1
 	end
 
-	gen = MessagePack::IDL::Generator.new
-	gen.generate(lang, ir, out)
 end