tecscde 0.6.0

data/lib/tecscde/tecs_model/tm_region.rb

@@ -0,0 +1,107 @@
+#
+# TECSCDE - TECS Component Diagram Editor
+#
+# Copyright (C) 2014-2019 by TOPPERS Project
+#
+#  The above copyright holders grant permission gratis to use,
+#  duplicate, modify, or redistribute (hereafter called use) this
+#  software (including the one made by modifying this software),
+#  provided that the following four conditions (1) through (4) are
+#  satisfied.
+#
+#  (1) When this software is used in the form of source code, the above
+#      copyright notice, this use conditions, and the disclaimer shown
+#      below must be retained in the source code without modification.
+#
+#  (2) When this software is redistributed in the forms usable for the
+#      development of other software, such as in library form, the above
+#      copyright notice, this use conditions, and the disclaimer shown
+#      below must be shown without modification in the document provided
+#      with the redistributed software, such as the user manual.
+#
+#  (3) When this software is redistributed in the forms unusable for the
+#      development of other software, such as the case when the software
+#      is embedded in a piece of equipment, either of the following two
+#      conditions must be satisfied:
+#
+#    (a) The above copyright notice, this use conditions, and the
+#        disclaimer shown below must be shown without modification in
+#        the document provided with the redistributed software, such as
+#        the user manual.
+#
+#    (b) How the software is to be redistributed must be reported to the
+#        TOPPERS Project according to the procedure described
+#        separately.
+#
+#  (4) The above copyright holders and the TOPPERS Project are exempt
+#      from responsibility for any type of damage directly or indirectly
+#      caused from the use of this software and are indemnified by any
+#      users or end users of this software from any and all causes of
+#      action whatsoever.
+#
+#  THIS SOFTWARE IS PROVIDED "AS IS." THE ABOVE COPYRIGHT HOLDERS AND
+#  THE TOPPERS PROJECT DISCLAIM ANY EXPRESS OR IMPLIED WARRANTIES,
+#  INCLUDING, BUT NOT LIMITED TO, ITS APPLICABILITY TO A PARTICULAR
+#  PURPOSE. IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS AND THE
+#  TOPPERS PROJECT BE LIABLE FOR ANY TYPE OF DAMAGE DIRECTLY OR
+#  INDIRECTLY CAUSED FROM THE USE OF THIS SOFTWARE.
+#
+
+require "tecscde/tm_object"
+
+module TECSCDE
+  class TECSModel
+    class TmRegion < TECSCDE::TmObject
+      # @sub_region::{name=>TmRegion}
+
+      #=== TmRegion#initialize
+      # namespace_path::NamespacePath
+      # owner::TmRegion (parent) or TECSModel (root region)
+      def initialize(namespace_path, owner)
+        @namespace_path = namespace_path
+        @owner = owner
+
+        # region's property
+        @sub_region = {}
+        @cell_list = {}
+        modified {}
+      end
+
+      def get_namespace_path
+        @namespace_path
+      end
+
+      def get_color
+      end
+
+      def delete_cell(cell)
+        @owner.delete_cell(cell)
+      end
+
+      def rename_cell(cell, name)
+        @owner.rename_cell(cell, name)
+      end
+
+      def get_region(name)
+        if @sub_region[name].nil?
+          modified do
+            parent = self
+            @sub_region[name] = TmRegion.new(@namespace_path.append(name), parent)
+          end
+        end
+        @sub_region[name]
+      end
+
+      #=== TmRegion#clone_for_undo
+      def clone_for_undo
+        bu = clone
+        bu.copy_from(self)
+        bu
+      end
+
+      def setup_clone(sub_region)
+        @sub_region = sub_region.dup
+      end
+    end
+  end
+end

data/lib/tecscde/tecs_model/tm_uneditable.rb

@@ -0,0 +1,68 @@
+#
+# TECSCDE - TECS Component Diagram Editor
+#
+# Copyright (C) 2014-2019 by TOPPERS Project
+#
+#  The above copyright holders grant permission gratis to use,
+#  duplicate, modify, or redistribute (hereafter called use) this
+#  software (including the one made by modifying this software),
+#  provided that the following four conditions (1) through (4) are
+#  satisfied.
+#
+#  (1) When this software is used in the form of source code, the above
+#      copyright notice, this use conditions, and the disclaimer shown
+#      below must be retained in the source code without modification.
+#
+#  (2) When this software is redistributed in the forms usable for the
+#      development of other software, such as in library form, the above
+#      copyright notice, this use conditions, and the disclaimer shown
+#      below must be shown without modification in the document provided
+#      with the redistributed software, such as the user manual.
+#
+#  (3) When this software is redistributed in the forms unusable for the
+#      development of other software, such as the case when the software
+#      is embedded in a piece of equipment, either of the following two
+#      conditions must be satisfied:
+#
+#    (a) The above copyright notice, this use conditions, and the
+#        disclaimer shown below must be shown without modification in
+#        the document provided with the redistributed software, such as
+#        the user manual.
+#
+#    (b) How the software is to be redistributed must be reported to the
+#        TOPPERS Project according to the procedure described
+#        separately.
+#
+#  (4) The above copyright holders and the TOPPERS Project are exempt
+#      from responsibility for any type of damage directly or indirectly
+#      caused from the use of this software and are indemnified by any
+#      users or end users of this software from any and all causes of
+#      action whatsoever.
+#
+#  THIS SOFTWARE IS PROVIDED "AS IS." THE ABOVE COPYRIGHT HOLDERS AND
+#  THE TOPPERS PROJECT DISCLAIM ANY EXPRESS OR IMPLIED WARRANTIES,
+#  INCLUDING, BUT NOT LIMITED TO, ITS APPLICABILITY TO A PARTICULAR
+#  PURPOSE. IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS AND THE
+#  TOPPERS PROJECT BE LIABLE FOR ANY TYPE OF DAMAGE DIRECTLY OR
+#  INDIRECTLY CAUSED FROM THE USE OF THIS SOFTWARE.
+#
+
+module TECSCDE
+  class TECSModel
+    # class must be descendant of Node
+    module TmUneditable
+      # @editable::Bool | Nil:  objects from .cdl cannot be editable  (used by TmJoin, TmCell)
+
+      #=== TmObject#set_editable
+      # locale:: see Node in syntaxobj.rb
+      def set_editable(locale)
+        @editable = locale[0] == model.file_editing
+      end
+
+      #=== TmObject#editable?  ***
+      def editable?
+        @editable
+      end
+    end
+  end
+end

data/lib/tecscde/tecs_model/vbar.rb

@@ -0,0 +1,68 @@
+#
+# TECSCDE - TECS Component Diagram Editor
+#
+# Copyright (C) 2014-2019 by TOPPERS Project
+#
+#  The above copyright holders grant permission gratis to use,
+#  duplicate, modify, or redistribute (hereafter called use) this
+#  software (including the one made by modifying this software),
+#  provided that the following four conditions (1) through (4) are
+#  satisfied.
+#
+#  (1) When this software is used in the form of source code, the above
+#      copyright notice, this use conditions, and the disclaimer shown
+#      below must be retained in the source code without modification.
+#
+#  (2) When this software is redistributed in the forms usable for the
+#      development of other software, such as in library form, the above
+#      copyright notice, this use conditions, and the disclaimer shown
+#      below must be shown without modification in the document provided
+#      with the redistributed software, such as the user manual.
+#
+#  (3) When this software is redistributed in the forms unusable for the
+#      development of other software, such as the case when the software
+#      is embedded in a piece of equipment, either of the following two
+#      conditions must be satisfied:
+#
+#    (a) The above copyright notice, this use conditions, and the
+#        disclaimer shown below must be shown without modification in
+#        the document provided with the redistributed software, such as
+#        the user manual.
+#
+#    (b) How the software is to be redistributed must be reported to the
+#        TOPPERS Project according to the procedure described
+#        separately.
+#
+#  (4) The above copyright holders and the TOPPERS Project are exempt
+#      from responsibility for any type of damage directly or indirectly
+#      caused from the use of this software and are indemnified by any
+#      users or end users of this software from any and all causes of
+#      action whatsoever.
+#
+#  THIS SOFTWARE IS PROVIDED "AS IS." THE ABOVE COPYRIGHT HOLDERS AND
+#  THE TOPPERS PROJECT DISCLAIM ANY EXPRESS OR IMPLIED WARRANTIES,
+#  INCLUDING, BUT NOT LIMITED TO, ITS APPLICABILITY TO A PARTICULAR
+#  PURPOSE. IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS AND THE
+#  TOPPERS PROJECT BE LIABLE FOR ANY TYPE OF DAMAGE DIRECTLY OR
+#  INDIRECTLY CAUSED FROM THE USE OF THIS SOFTWARE.
+#
+
+require "tecscde/tecs_model/tm_join_bar"
+
+module TECSCDE
+  class TECSModel
+    class VBar < TECSCDE::TECSModel::TmJoinBar
+      def horizontal?
+        false
+      end
+
+      def vertical?
+        true
+      end
+
+      def type
+        "VBar"
+      end
+    end
+  end
+end

data/lib/tecscde/templates/_cell_info.cde.erb

@@ -0,0 +1,15 @@
+<%-
+x, y, width, height = cell.get_geometry
+ports = cell.cports.values + cell.eports.values
+port_locations_lines = JSON.pretty_generate(port_location(ports), indent: "    ").lines
+port_locations_json = port_locations_lines.first + port_locations_lines[1..-1].map do |line|
+  "    " + line
+end.join
+-%>
+{       /** cell_list[ <%= index %> ] **/
+    "type"     : "cell_location",
+    "name"     : "<%= cell.get_name %>",
+    "location" : [ <%= x %>, <%= y %>, <%= width %>, <%= height %> ],
+    "region"   : "<%= cell.get_region.get_namespace_path %>",
+    "port_location" : <%= port_locations_json %>
+}

data/lib/tecscde/templates/_join_info.cde.erb

@@ -0,0 +1,28 @@
+<%-
+cport = join.cport
+eport = join.eport
+bar_list = join.bars.map do |bar|
+  {
+    type: bar.type,
+    position: bar.get_position
+  }
+end
+bar_list_lines = JSON.pretty_generate(bar_list, indent: "    ").lines
+bar_list_json = bar_list_lines.first + bar_list_lines[1..-1].map do |line|
+  "    " + line
+end.join
+-%>
+{       /** join_list[ <%= index %> ] **/
+    "type"        : "join_location",
+    "call_cell"   : "<%= cport.get_cell.get_name %>",
+    "call_region" : "<%= cport.get_cell.get_region.get_namespace_path %>",
+    "call_port"   : "<%= cport.get_name %>",
+<%- if cport.get_subscript -%>
+    "call_port_subscript": "<%= cport.get_subscript %>",
+<%- end -%>
+    "entry_cell"  : "<%= eport.get_cell.get_name %>",
+    "entry_region": "<%= eport.get_cell.get_region.get_namespace_path %>",
+    "entry_port"  : "<%= eport.get_name %>",
+    "entry_port_subscript": "<%= eport.get_subscript %>",
+    "bar_list": <%= bar_list_json %>
+}

data/lib/tecscde/templates/main.cde.erb

@@ -0,0 +1,49 @@
+__tool_info__ ("tecsgen") <%= JSON.pretty_generate(tecsgen, indent: "    ") %>
+
+<%- @cell_list.select(&:editable?).each do |cell| -%>
+cell <%= cell.get_celltype.get_namespace_path %> <%= cell.get_name %> {
+    <%- cports = cell.cports -%>
+    <%- unless cports.empty? -%>
+    /*** call ports ***/
+    <%-   generate_cports_lines(cports).each do |line| -%>
+    <%=     line %>
+    <%-   end -%>
+    <%- end -%>
+    <%- attributes = cell.get_attr_list -%>
+    <%- unless attributes.empty? -%>
+    /*** attributes ***/
+    <%-   attributes.keys.sort.each do |key| -%>
+    <%=     key %> = <%= attributes[key] %>
+    <%-   end -%>
+    <%- end -%>
+};
+<%- end -%>
+
+/*************************************************
+ *         TOOL INFORMATION FOR TECSCDE          *
+ *     This  information is used by tecscde      *
+ *  please don't touch if you are not familiar   *
+ ************************************************/
+__tool_info__ ("tecscde") {
+    "paper" : {
+        "type" : "paper",
+        "size" :  "<%= @paper[:size] %>",
+        "orientation" :  "<%= @paper[:orientation] %>"
+    },
+    "cell_list" : [
+    <%- unless @cell_list.empty? -%>
+      <%- @cell_list[0..-2].each_with_index do |cell, index| -%>
+        <%= render_partial("_cell_info.cde.erb", index: index, cell: cell).chomp %>,
+      <%- end -%>
+        <%= render_partial("_cell_info.cde.erb", index: @cell_list.size, cell: @cell_list.last).chomp %>
+    <%- end -%>
+    ],
+    "join_list" : [
+    <%- unless @join_list.empty? -%>
+      <%- @join_list[0..-2].each do |join| -%>
+        <%= render_partial("_join_info.cde.erb", join: join).chomp %>,
+      <%- end -%>
+        <%= render_partial("_join_info.cde.erb", join: @join_list.last).chomp %>
+    <%- end -%>
+    ]
+}

data/lib/tecscde/tm_object.rb

@@ -0,0 +1,91 @@
+#
+# TECSCDE - TECS Component Diagram Editor
+#
+# Copyright (C) 2014-2019 by TOPPERS Project
+#
+#  The above copyright holders grant permission gratis to use,
+#  duplicate, modify, or redistribute (hereafter called use) this
+#  software (including the one made by modifying this software),
+#  provided that the following four conditions (1) through (4) are
+#  satisfied.
+#
+#  (1) When this software is used in the form of source code, the above
+#      copyright notice, this use conditions, and the disclaimer shown
+#      below must be retained in the source code without modification.
+#
+#  (2) When this software is redistributed in the forms usable for the
+#      development of other software, such as in library form, the above
+#      copyright notice, this use conditions, and the disclaimer shown
+#      below must be shown without modification in the document provided
+#      with the redistributed software, such as the user manual.
+#
+#  (3) When this software is redistributed in the forms unusable for the
+#      development of other software, such as the case when the software
+#      is embedded in a piece of equipment, either of the following two
+#      conditions must be satisfied:
+#
+#    (a) The above copyright notice, this use conditions, and the
+#        disclaimer shown below must be shown without modification in
+#        the document provided with the redistributed software, such as
+#        the user manual.
+#
+#    (b) How the software is to be redistributed must be reported to the
+#        TOPPERS Project according to the procedure described
+#        separately.
+#
+#  (4) The above copyright holders and the TOPPERS Project are exempt
+#      from responsibility for any type of damage directly or indirectly
+#      caused from the use of this software and are indemnified by any
+#      users or end users of this software from any and all causes of
+#      action whatsoever.
+#
+#  THIS SOFTWARE IS PROVIDED "AS IS." THE ABOVE COPYRIGHT HOLDERS AND
+#  THE TOPPERS PROJECT DISCLAIM ANY EXPRESS OR IMPLIED WARRANTIES,
+#  INCLUDING, BUT NOT LIMITED TO, ITS APPLICABILITY TO A PARTICULAR
+#  PURPOSE. IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS AND THE
+#  TOPPERS PROJECT BE LIABLE FOR ANY TYPE OF DAMAGE DIRECTLY OR
+#  INDIRECTLY CAUSED FROM THE USE OF THIS SOFTWARE.
+#
+
+module TECSCDE
+  #== TmObject: base class for TECSModel & its children
+  #
+  class TmObject
+    # @owner::
+    #  TmRegion  => TmRegion, TECSModel(for root region)
+    #  TmCell    => TmRegion
+    #  TmPort    => TmCell | TmCPortArray | TmEPortArray
+    #  TmJoin    => TECSModel
+    #  TmJoinBar => TmJoin
+    #  TECSModel => Nil
+
+    attr_accessor :owner
+
+    def model
+      if @owner
+        @owner.model
+      else
+        if is_a?(TECSModel)
+          raise "model: self is not TECSModel: #{self.class}"
+        end
+        self
+      end
+    end
+
+    def modified
+      model.add_change_set(self)
+      yield
+    end
+
+    def copy_from(tm_object)
+      tm_object.instance_variables.each do |iv|
+        val = tm_object.instance_variable_get(iv)
+        if val.is_a?(Array) || val.is_a?(Hash)
+          instance_variable_set(iv, val.dup)
+        else
+          instance_variable_set(iv, val)
+        end
+      end
+    end
+  end
+end

data/lib/tecscde/version.rb

@@ -0,0 +1,4 @@
+module TECSCDE
+  VERSION = "0.6.0"
+  FORMAT_VERSION = "0.5.0"
+end

data/lib/tecscde/view.rb

@@ -0,0 +1,58 @@
+#
+# TECSCDE - TECS Component Diagram Editor
+#
+# Copyright (C) 2014-2019 by TOPPERS Project
+#
+#  The above copyright holders grant permission gratis to use,
+#  duplicate, modify, or redistribute (hereafter called use) this
+#  software (including the one made by modifying this software),
+#  provided that the following four conditions (1) through (4) are
+#  satisfied.
+#
+#  (1) When this software is used in the form of source code, the above
+#      copyright notice, this use conditions, and the disclaimer shown
+#      below must be retained in the source code without modification.
+#
+#  (2) When this software is redistributed in the forms usable for the
+#      development of other software, such as in library form, the above
+#      copyright notice, this use conditions, and the disclaimer shown
+#      below must be shown without modification in the document provided
+#      with the redistributed software, such as the user manual.
+#
+#  (3) When this software is redistributed in the forms unusable for the
+#      development of other software, such as the case when the software
+#      is embedded in a piece of equipment, either of the following two
+#      conditions must be satisfied:
+#
+#    (a) The above copyright notice, this use conditions, and the
+#        disclaimer shown below must be shown without modification in
+#        the document provided with the redistributed software, such as
+#        the user manual.
+#
+#    (b) How the software is to be redistributed must be reported to the
+#        TOPPERS Project according to the procedure described
+#        separately.
+#
+#  (4) The above copyright holders and the TOPPERS Project are exempt
+#      from responsibility for any type of damage directly or indirectly
+#      caused from the use of this software and are indemnified by any
+#      users or end users of this software from any and all causes of
+#      action whatsoever.
+#
+#  THIS SOFTWARE IS PROVIDED "AS IS." THE ABOVE COPYRIGHT HOLDERS AND
+#  THE TOPPERS PROJECT DISCLAIM ANY EXPRESS OR IMPLIED WARRANTIES,
+#  INCLUDING, BUT NOT LIMITED TO, ITS APPLICABILITY TO A PARTICULAR
+#  PURPOSE. IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS AND THE
+#  TOPPERS PROJECT BE LIABLE FOR ANY TYPE OF DAMAGE DIRECTLY OR
+#  INDIRECTLY CAUSED FROM THE USE OF THIS SOFTWARE.
+#
+
+module TECSCDE
+  module View
+  end
+end
+
+require "tecscde/view/cairo_matrix"
+require "tecscde/view/canvas"
+require "tecscde/view/constants"
+require "tecscde/view/main_view"