brotorift 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9f356872e186ceca556c1de43b78220131aac244cbe70635eb9c5c5fabcaf05
-  data.tar.gz: 0c01b105e89a854b7ac7a596564fbe1c972e29e8c78f4484335f7a29a6e51e32
+  metadata.gz: 39731491bf8f75fd3020706e30be5bfeb20ce2ac29278a47c16554092d90724f
+  data.tar.gz: eb54a4e1e1b8925458fe1f33943a595e566360b06d2838d404ac903cc798b7a6
 SHA512:
-  metadata.gz: aa37b5ac73dbea9fc4ba5e9ea5a918cce20460903a6b37e4c4b2348adf01a3ccdf2212b9e487c1a5c07d5aa8e468f9eeb62ffa107a5d10d3460f3206601a2c61
-  data.tar.gz: c49c9580fcc4c6a99b75a8ece3f6633f52b99119768342fc995e51025e674fc55766b021634852da7d3a1c094733c98f715816a9566b12032caaa0c1f5246cec
+  metadata.gz: 7dfae3292bf18d45826429a411f930773b0277fb62051880d10d580d61417362cebcb3dbb6d49a5763734879528aef574b8021646955295efa21ee3096c813ea
+  data.tar.gz: fa60f4a94cc8a8cf060a922d4f3b4310e12c5f225a9a68770b896b6b4a6ee6669fca784cd039790f402139f1cd7917eb30df2d69e79fcd4aa8506e98d9895759

data/lib/brotorift.rb

@@ -49,6 +49,7 @@ class Brotorift
 		runtime.directions.each do |direction|
 			generate_code runtime, direction.client, :client
 			generate_code runtime, direction.server, :server
+			generate_bot_code runtime, direction.client
 		end
 	
 		generate_sequence_diagrams runtime if generate_diagram
@@ -83,6 +84,17 @@ class Brotorift
 			@generated_nodes[node.name] = [side]
 		end
 	end
+
+	def generate_bot_code runtime, node
+		generator = find_generator 'bot', :client
+		if generator == nil
+			puts "Generator for bot is not found.".red
+			return
+		end
+	
+		puts "Generating bot code for node '#{node.name}'..."
+		generator.generate node, runtime
+	end
 	
 	def find_generator language, side
 		Generator.generators.find { |g| g.language == language and g.side == side }

data/lib/generators/bot_generator.ex.erb

@@ -0,0 +1,102 @@
+<% for n in runtime.get_node_directions node, :client %>
+defmodule <%= node.namespace %>.<%= node.bot_client %> do
+  use GenServer
+
+  import <%= node.namespace %>.Enums
+
+  @version <%= runtime.version %>
+  <% for m in n.in_direction.messages.values %>
+  <%= m.bot_header_name %> <%= m.id %><% end %>
+  <% for m in n.out_direction.messages.values %>
+  <%= m.bot_header_name %> <%= m.id %><% end %>
+
+  def start_link(args) do
+    GenServer.start_link(__MODULE__, args)
+  end
+
+  def connect(client) do
+    GenServer.call(client, :connect, :infinity)
+  end
+
+  <% for m in n.out_direction.messages.values %>
+  @doc """
+  <%= m.doc %>
+
+  ## Parameters
+
+    - `client`: Bot client pid<% for p in m.members %>
+    - `<%= p.bot_name %>`: <%= p.doc %>
+    <% end %>
+  """
+  @spec <%= m.bot_send_name %>(client :: pid()<%= m.bot_params_with_types node %>) :: :ok
+  def <%= m.bot_send_name %>(client<%= m.bot_params %>) do
+    GenServer.cast(client, {:send, {:<%= m.bot_send_name %><%= m.bot_params %>}})
+  end
+  <% end %>
+
+  <% for m in n.in_direction.messages.values %>
+  @doc """
+  <%= m.doc %>
+
+  ## Parameters
+
+    - `client`: Bot client pid
+  """
+  @spec <%= m.bot_receive_name %>(client :: pid()) :: {:ok, {<%= m.bot_return_types node %>}}
+  def <%= m.bot_receive_name %>(client) do
+    GenServer.call(client, {:receive, :<%= m.bot_name %>}, :infinity)
+  end
+  <% end %>
+
+  def init(_args) do
+    {:ok, report} = BrotoriftBot.ReportManager.create_report()
+    {:ok, tcp_client} = BrotoriftBot.TcpClientSupervisor.create_client(report, self())
+    {:ok, {report, tcp_client}}
+  end
+
+  def handle_call(:connect, _from, {report, tcp_client}) do
+    BrotoriftBot.TcpClient.connect(tcp_client, @version)
+    {:reply, :ok, {report, tcp_client}}
+  end
+
+  <% for m in n.in_direction.messages.values %>
+  def handle_call({:receive, :<%= m.bot_name %>}, _from, {report, tcp_client}) do
+    start_time = Time.utc_now()
+    data = try_receive(<%= m.bot_header_name %>, tcp_client)
+    stop_time = Time.utc_now()
+    BrotoriftBot.Report.receive(report, :<%= m.bot_name %>, start_time, stop_time)
+
+    content = parse_packet(:<%= m.bot_name %>, data)
+    {:reply, {:ok, content}, {report, tcp_client}}
+  end
+  <% end %>
+  <% for m in n.out_direction.messages.values %>
+  def handle_cast({:send, {:<%= m.bot_send_name %><%= m.bot_params %>}}, {report, tcp_client}) do
+    data = <<<%= m.bot_header_name %>::32-little>><% for p in m.members %>
+    data = <%= p.type.bot_write node, p.bot_name %><% end %>
+    time = Time.utc_now()
+    :ok = BrotoriftBot.TcpClient.send_packet(tcp_client, data)
+    BrotoriftBot.Report.send(report, :<%= m.bot_name %>, time)
+    {:noreply, {report, tcp_client}}
+  end
+  <% end %>
+
+  defp try_receive(message, tcp_client) do
+    receive do
+      {^message, value} ->
+        value
+      _ ->
+        try_receive(message, tcp_client)
+    end
+  end
+
+  <% for m in n.in_direction.messages.values %>
+  defp parse_packet(:<%= m.bot_name %>, data) do<% for p in m.members %>
+    {data, <%= p.bot_name %>} = <%= p.type.bot_read node %><% end %>
+    <<>> = data
+    {<%= m.bot_returns %>}
+  end
+  <% end %>
+end
+
+<% end %>

data/lib/generators/bot_generator.rb

@@ -0,0 +1,457 @@
+require 'erb'
+require_relative '../case_helper'
+
+class EnumTypeDef
+    def bot_name
+        @name.underscore
+    end
+
+    def bot_read_name
+        "read_#{self.bot_name}"
+    end
+
+    def bot_write_name
+        "write_#{self.bot_name}"
+    end
+
+    def bot_read
+        "#{self.bot_read_name}(data)"
+    end
+
+    def bot_write member_name
+        "#{self.bot_write_name}(data, #{member_name})"
+    end
+
+    def bot_reader
+        "#{self.bot_read_name}/1"
+    end
+
+    def bot_writer
+        "#{self.bot_write_name}/2"
+    end
+
+    def bot_type
+        @elements.values.map { |e| e.bot_name } .join ' | '
+    end
+end
+
+
+class EnumElementDef
+    def bot_name
+        ':' + @name.underscore
+    end
+end
+
+
+class BuiltinTypeDef
+    def bot_type
+        case @name
+        when 'Bool'
+            return 'boolean()'
+        when 'Byte'
+            return 'byte()'
+        when 'Short'
+            return 'integer()'
+        when 'Int'
+            return 'integer()'
+        when 'Long'
+            return 'integer()'
+        when 'UShort'
+            return 'non_neg_integer()'
+        when 'UInt'
+            return 'non_neg_integer()'
+        when 'ULong'
+            return 'non_neg_integer()'
+        when 'Float'
+            return 'float()'
+        when 'Double'
+            return 'float()'
+        when 'String'
+            return 'String.t()'
+        when 'DateTime'
+            return 'DateTime.t()'
+        when 'ByteBuffer'
+            return 'binary()'
+        when 'Vector2'
+            return '{float(), float()}'
+        when 'Vector3'
+            return '{float(), float(), float()}'
+        when 'Color'
+            return '{float(), float(), float(), float()}'
+        else
+            return @name
+        end
+    end
+
+    def bot_read
+        case @name
+        when 'Bool'
+            return "Brotorift.Binary.read_bool(data)"
+        when 'Byte'
+            return "Brotorift.Binary.read_byte(data)"
+        when 'Short'
+            return "Brotorift.Binary.read_short(data)"
+        when 'Int'
+            return "Brotorift.Binary.read_int(data)"
+        when 'Long'
+            return "Brotorift.Binary.read_long(data)"
+        when 'UShort'
+            return "Brotorift.Binary.read_ushort(data)"
+        when 'UInt'
+            return "Brotorift.Binary.read_uint(data)"
+        when 'ULong'
+            return "Brotorift.Binary.read_ulong(data)"
+        when 'Float'
+            return "Brotorift.Binary.read_float(data)"
+        when 'Double'
+            return "Brotorift.Binary.read_double(data)"
+        when 'String'
+            return "Brotorift.Binary.read_string(data)"
+        when 'ByteBuffer'
+            return "Brotorift.Binary.read_byte_buffer(data)"
+        when 'Vector2'
+            return "Brotorift.Binary.read_vector2(data)"
+        when 'Vector3'
+            return "Brotorift.Binary.read_vector3(data)"
+        when 'Color'
+            return "Brotorift.Binary.read_color(data)"
+        else
+            throw 'Invalid operation'
+        end
+    end
+
+    def bot_write member_name
+        case @name
+        when 'Bool'
+            return "Brotorift.Binary.write_bool(data, #{member_name})"
+        when 'Byte'
+            return "Brotorift.Binary.write_byte(data, #{member_name})"
+        when 'Short'
+            return "Brotorift.Binary.write_short(data, #{member_name})"
+        when 'Int'
+            return "Brotorift.Binary.write_int(data, #{member_name})"
+        when 'Long'
+            return "Brotorift.Binary.write_long(data, #{member_name})"
+        when 'UShort'
+            return "Brotorift.Binary.write_ushort(data, #{member_name})"
+        when 'UInt'
+            return "Brotorift.Binary.write_uint(data, #{member_name})"
+        when 'ULong'
+            return "Brotorift.Binary.write_ulong(data, #{member_name})"
+        when 'Float'
+            return "Brotorift.Binary.write_float(data, #{member_name})"
+        when 'Double'
+            return "Brotorift.Binary.write_double(data, #{member_name})"
+        when 'String'
+            return "Brotorift.Binary.write_string(data, #{member_name})"
+        when 'ByteBuffer'
+            return "Brotorift.Binary.write_byte_buffer(data, #{member_name})"
+        when 'Vector2'
+            return "Brotorift.Binary.write_vector2(data, #{member_name})"
+        when 'Vector3'
+            return "Brotorift.Binary.write_vector3(data, #{member_name})"
+        when 'Color'
+            return "Brotorift.Binary.write_color(data, #{member_name})"
+        else
+            throw 'Invalid operation'
+        end
+    end
+
+    def bot_reader
+        case @name
+        when 'Bool'
+            return "&Brotorift.Binary.read_bool/1"
+        when 'Byte'
+            return "&Brotorift.Binary.read_byte/1"
+        when 'Short'
+            return "&Brotorift.Binary.read_short/1"
+        when 'Int'
+            return "&Brotorift.Binary.read_int/1"
+        when 'Long'
+            return "&Brotorift.Binary.read_long/1"
+        when 'UShort'
+            return "&Brotorift.Binary.read_ushort/1"
+        when 'UInt'
+            return "&Brotorift.Binary.read_uint/1"
+        when 'ULong'
+            return "&Brotorift.Binary.read_ulong/1"
+        when 'Float'
+            return "&Brotorift.Binary.read_float/1"
+        when 'Double'
+            return "&Brotorift.Binary.read_double/1"
+        when 'String'
+            return "&Brotorift.Binary.read_string/1"
+        when 'ByteBuffer'
+            return "&Brotorift.Binary.read_byte_buffer/1"
+        when 'Vector2'
+            return "&Brotorift.Binary.read_vector2/1"
+        when 'Vector3'
+            return "&Brotorift.Binary.read_vector3/1"
+        when 'Color'
+            return "&Brotorift.Binary.read_color/1"
+        else
+            throw 'Invalid operation'
+        end
+    end
+
+    def bot_writer
+        case @name
+        when 'Bool'
+            return "&Brotorift.Binary.write_bool/2"
+        when 'Byte'
+            return "&Brotorift.Binary.write_byte/2"
+        when 'Short'
+            return "&Brotorift.Binary.write_short/2"
+        when 'Int'
+            return "&Brotorift.Binary.write_int/2"
+        when 'Long'
+            return "&Brotorift.Binary.write_long/2"
+        when 'UShort'
+            return "&Brotorift.Binary.write_ushort/2"
+        when 'UInt'
+            return "&Brotorift.Binary.write_uint/2"
+        when 'ULong'
+            return "&Brotorift.Binary.write_ulong/2"
+        when 'Float'
+            return "&Brotorift.Binary.write_float/2"
+        when 'Double'
+            return "&Brotorift.Binary.write_double/2"
+        when 'String'
+            return "&Brotorift.Binary.write_string/2"
+        when 'ByteBuffer'
+            return "&Brotorift.Binary.write_byte_buffer/2"
+        when 'Vector2'
+            return "&Brotorift.Binary.write_vector2/2"
+        when 'Vector3'
+            return "&Brotorift.Binary.write_vector3/2"
+        when 'Color'
+            return "&Brotorift.Binary.write_color/2"
+        else
+            throw 'Invalid operation'
+        end
+    end
+end
+
+
+class StructTypeDef
+    def bot_members
+        @members.map { |m| ":" + m.bot_name } .join ', '
+    end
+
+    def bot_members_with_types node
+        @members.map { |m| m.bot_name + ": " + m.type.bot_type(node) } .join ', '
+    end
+
+    def bot_members_with_values
+        @members.map { |m| m.bot_name + ": " + m.bot_name } .join ', '
+    end
+
+    def bot_type node
+        "#{node.namespace}.#{@name}.t"
+    end
+
+    def bot_read node
+        "#{node.namespace}.#{@name}.read(data)"
+    end
+
+    def bot_write node, member_name
+        "#{node.namespace}.#{@name}.write(data, #{member_name})"
+    end
+
+    def bot_reader node
+        "&#{node.namespace}.#{@name}.read/1"
+    end
+
+    def bot_writer node
+        "&#{node.namespace}.#{@name}.write/2"
+    end
+end
+
+
+class TypeInstanceDef
+    def bot_type node
+        return self.bot_list node if @type.name == 'List'
+        return self.bot_set node if @type.name == 'Set'
+        return self.bot_map node if @type.name == 'Map'
+        return @type.bot_type if @type.is_a? BuiltinTypeDef or @type.is_a? EnumTypeDef
+        return @type.bot_type node if @type.is_a? StructTypeDef
+    end
+
+    def bot_read node
+        return self.bot_list_read node if @type.name == 'List'
+        return self.bot_set_read node if @type.name == 'Set'
+        return self.bot_map_read node if @type.name == 'Map'
+        return @type.bot_read if @type.is_a? BuiltinTypeDef or @type.is_a? EnumTypeDef
+        return @type.bot_read node if @type.is_a? StructTypeDef
+    end
+
+    def bot_write node, member_name
+        return self.bot_list_write node, member_name if @type.name == 'List'
+        return self.bot_set_write node, member_name if @type.name == 'Set'
+        return self.bot_map_write node, member_name if @type.name == 'Map'
+        return @type.bot_write member_name if @type.is_a? BuiltinTypeDef or @type.is_a? EnumTypeDef
+        return @type.bot_write node, member_name if @type.is_a? StructTypeDef
+    end
+
+    def bot_reader node
+        return self.bot_list_reader node if @type.name == 'List'
+        return self.bot_set_reader node if @type.name == 'Set'
+        return self.bot_map_reader node if @type.name == 'Map'
+        return @type.bot_reader if @type.is_a? BuiltinTypeDef or @type.is_a? EnumTypeDef
+        return @type.bot_reader node if @type.is_a? StructTypeDef
+    end
+
+    def bot_writer node
+        return self.bot_list_writer node if @type.name == 'List'
+        return self.bot_set_writer node if @type.name == 'Set'
+        return self.bot_map_writer node if @type.name == 'Map'
+        return @type.bot_writer if @type.is_a? BuiltinTypeDef or @type.is_a? EnumTypeDef
+        return @type.bot_writer node if @type.is_a? StructTypeDef
+    end
+
+    def bot_list node
+        'list(' + @params[0].bot_type(node)  + ')'
+    end
+
+    def bot_list_read node
+        'Brotorift.Binary.read_list(data, ' + @params[0].bot_reader(node) + ')'
+    end
+    
+    def bot_list_write node, member_name
+        'Brotorift.Binary.write_list(data, ' + member_name + ', ' + @params[0].bot_writer(node) + ')'
+    end
+
+    def bot_list_reader node
+        '&Brotorift.Binary.read_list(&1, ' + @params[0].bot_reader(node) + ')'
+    end
+
+    def bot_list_writer node
+        '&Brotorift.Binary.write_list(&1, &2, ' + @params[0].bot_writer(node) + ')'
+    end
+
+    def bot_set node
+        'MapSet.t(' + @params[0].bot_type(node)  + ')'
+    end
+
+    def bot_set_read node
+        'Brotorift.Binary.read_set(data, ' + @params[0].bot_reader(node) + ')'
+    end
+    
+    def bot_set_write node, member_name
+        'Brotorift.Binary.write_set(data, ' + member_name + ', ' + @params[0].bot_writer(node) + ')'
+    end
+
+    def bot_set_reader node
+        '&Brotorift.Binary.read_set(&1, ' + @params[0].bot_reader(node) + ')'
+    end
+
+    def bot_set_writer node
+        '&Brotorift.Binary.write_set(&1, &2, ' + @params[0].bot_writer(node) + ')'
+    end
+
+    def bot_map node
+        '%{' + @params[0].bot_type(node) + ' => ' + @params[1].bot_type(node) + '}'
+    end
+
+    def bot_map_read node
+        'Brotorift.Binary.read_map(data, ' + @params[0].bot_reader(node) + ', ' + @params[1].bot_reader(node) + ')'
+    end
+    
+    def bot_map_write node, member_name
+        'Brotorift.Binary.write_map(data, ' + member_name + ', ' + @params[0].bot_writer(node) + ', ' + @params[1].bot_writer(node) + ')'
+    end
+
+    def bot_map_reader node
+        '&Brotorift.Binary.read_map(&1, ' + @params[0].bot_reader(node) + ', ' + @params[1].bot_reader(node) + ')'
+    end
+
+    def bot_map_writer node
+        '&Brotorift.Binary.write_map(&1, &2, ' + @params[0].bot_writer(node) + ', ' + @params[1].bot_writer(node) + ')'
+    end
+end
+
+
+class MemberDef
+    def bot_name
+        @name.underscore
+    end
+end
+
+
+class MessageDef
+    def bot_header_name
+        "@header_#{self.bot_name}"
+    end
+
+    def bot_name
+        @name.underscore
+    end
+
+    def bot_send_name
+        "send_#{self.bot_name}"
+    end
+
+    def bot_receive_name
+        "receive_#{self.bot_name}"
+    end
+
+    def bot_params
+        return '' if members.empty?
+        params = members.map { |m| m.bot_name } .join ', '
+        ', ' + params
+    end
+
+    def bot_returns
+        return '' if members.empty?
+        members.map { |m| m.bot_name } .join ', '
+    end
+
+    def bot_params_with_types node
+        return '' if members.empty?
+        params = members.map { |m| m.bot_name + ' :: ' + m.type.bot_type(node) } .join ', '
+        ', ' + params
+    end
+
+    def bot_return_types node
+        return '' if members.empty?
+        members.map { |m| m.type.bot_type(node) }.join ', '
+    end
+end
+
+
+class NodeDef
+    def bot_name
+        @name.underscore
+    end
+
+    def bot_client
+        @name + 'BotClient'
+    end
+end
+
+
+class BotGenerator < Generator
+    def initialize
+        super 'bot', :client
+    end
+
+    def generate node, runtime
+        self.generate_file node, runtime, 'bot_types_generator', "#{node.bot_name}_types"
+        self.generate_file node, runtime, 'bot_generator', node.bot_name
+    end
+
+    def generate_file node, runtime, template_file, generated_file
+        folder = File.expand_path File.dirname __FILE__
+        erb_file = folder + "/#{template_file}.ex.erb"
+        template = File.read erb_file
+        erb = ERB.new template
+        content = erb.result binding
+
+        output_dir = File.dirname runtime.filename
+        output_path = File.join output_dir, "#{generated_file}_bot.ex"
+        File.write output_path, content
+    end
+end
+
+
+Generator.add BotGenerator.new

data/lib/generators/bot_types_generator.ex.erb

@@ -0,0 +1,40 @@
+defmodule <%= node.namespace %>.Enums do<% for e in runtime.enums.values %>
+  def <%= e.bot_read_name %>(data) do
+    <<value::32-little, data::binary>> = data
+    case value do<% for v in e.elements.values %>
+      <%= v.value %> -> {data, <%= v.bot_name %>}<% end %>
+      _ -> :error
+    end
+  end
+
+  def <%= e.bot_write_name %>(data, value) do
+    case value do<% for v in e.elements.values %>
+      <%= v.bot_name %> -> <<data::binary, <%= v.value %>::32-little>><% end %>
+      _ -> :error
+    end
+  end
+<% end %>end
+
+<% for s in runtime.structs.values %>
+defmodule <%= node.namespace %>.<%= s.name %> do
+  defstruct [<%= s.bot_members %>]
+
+  import <%= node.namespace %>.Enums
+
+  @typedoc """
+  <%= s.doc %><% for m in s.members %>
+  `:<%= m.bot_name %>`: <%= m.doc %><% end %>
+  """
+  @type t :: %<%= node.namespace %>.<%= s.name %>{<%= s.bot_members_with_types node %>}
+
+  def read(data) do<% for m in s.members %>
+    {data, <%= m.bot_name %>} = <%= m.type.bot_read node %><% end %>
+    {data, %<%= node.namespace %>.<%= s.name %>{<%= s.bot_members_with_values %>}}
+  end
+
+  def write(data, value) do<% for m in s.members %>
+    data = <%= m.type.bot_write node, 'value.' + m.bot_name %><% end %>
+    data
+  end
+end
+<% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brotorift
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Peter Ren
@@ -65,6 +65,9 @@ files:
 - lib/case_helper.rb
 - lib/compiler.rb
 - lib/compiler_error.rb
+- lib/generators/bot_generator.ex.erb
+- lib/generators/bot_generator.rb
+- lib/generators/bot_types_generator.ex.erb
 - lib/generators/elixir_server_generator.ex.erb
 - lib/generators/elixir_server_generator.rb
 - lib/generators/elixir_server_types_generator.ex.erb