tecscde 0.6.0

data/lib/tecscde/tecs_model/tm_join_bar.rb

@@ -0,0 +1,146 @@
+#
+# 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 TmJoinBar < TECSCDE::TmObject
+      # @position::Integer(mm)     # horizontal(x) or vertical(y) position
+      # @owner::TmJoin (Reverse Reference)
+      def initialize(position, owner_join)
+        @position = position
+        @owner = owner_join
+        modified {}
+      end
+
+      #=== TmJoinBar#get_position ***
+      def get_position
+        @position
+      end
+
+      def set_position(position)
+        modified do
+          @position = TECSCDE::TECSModel.round_length_val(position)
+        end
+      end
+
+      def moved(inc)
+        set_position(@position + inc)
+      end
+
+      # def set_join join
+      #  @owner = join
+      # end
+
+      #=== TmJoinBar#get_join ***
+      def get_join
+        @owner
+      end
+
+      #=== TmJoinBar#move ***
+      # actually moving previous next bar
+      # 1st bar and last bar can not be moved (necessary cport, eport move)
+      def move(x_inc, y_inc)
+        modified do
+          bar_prev = nil
+          bars = @owner.bars
+
+          if bars.length >= 1 && bars[bars.length - 1] == self
+            @owner.eport.move(x_inc, y_inc)
+            return # last bar
+          end
+
+          bars.each do |bar|
+            if bar.equal?(self)
+              break
+            end
+            bar_prev = bar
+          end
+
+          if bar_prev # prev_bar is nil if self is 1st bar
+            # p "bar_prev exist"
+            if bar_prev.horizontal?
+              xm = bar_prev.get_position + x_inc
+              bar_prev.set_position(model.clip_x(xm))
+            else
+              ym = bar_prev.get_position + y_inc
+              bar_prev.set_position(model.clip_y(ym))
+            end
+          else
+            # 1st bar
+            @owner.cport.move(x_inc, y_inc)
+          end
+        end
+      end
+
+      #=== TmJoinBar#clone_for_undo
+      def clone_for_undo
+        bu = clone
+        bu.copy_from(self)
+        bu
+      end
+
+      def horizontal?
+        raise NotImplementedError
+      end
+
+      def vertical?
+        raise NotImplementedError
+      end
+
+      def type
+        raise NotImplementedError
+      end
+    end
+  end
+end
+
+require "tecscde/tecs_model/hbar"
+require "tecscde/tecs_model/vbar"

data/lib/tecscde/tecs_model/tm_port.rb

@@ -0,0 +1,238 @@
+#
+# 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"
+require "tecscde/tecs_model/hbar"
+require "tecscde/tecs_model/vbar"
+
+module TECSCDE
+  class TECSModel
+    class TmPort < TECSCDE::TmObject
+      # @edge_side::Integer()
+      # @offset::Integer(mm)  # distance from top or left side
+      # @owner::TmCell | TmXPortArray  (Reverse Reference)
+      # @port_def:: ::Port
+      # @subscript::Integer | Nil
+
+      attr_reader :offset
+
+      #=== TmPort#move
+      def move(x_inc, y_inc)
+        modified do
+          # p "move x=#{x_inc} y=#{y_inc}"
+          _x, _y, w, h = owner_cell.get_geometry
+          case @edge_side
+          when EDGE_LEFT, EDGE_RIGHT
+            offs = TECSModel.round_length_val(@offset + y_inc)
+            if offs < 0 || offs > h
+              return
+            end
+            x_inc = 0
+          when EDGE_TOP, EDGE_BOTTOM
+            offs = TECSCDE::TECSModel.round_length_val(@offset + x_inc)
+            # p "offs=#{offs} x=#{x} w=#{w}"
+            if offs < 0 || offs > w
+              return
+            end
+            y_inc = 0
+          end
+          @offset = offs
+          moved_edge(x_inc, x_inc, y_inc, y_inc)
+        end
+      end
+
+      #=== TmPort#moved_edge
+      # moved cell's edge
+      # x_inc_l::Float : left edge moved,   value is incremental
+      # x_inc_r::Float : right edge moved,  value is incremental
+      # y_inc_t::Float : top edge moved,    value is incremental
+      # y_inc_b::Float : bottom edge moved, value is incremental
+      def moved_edge(x_inc_l, x_inc_r, y_inc_t, y_inc_b)
+        case @edge_side
+        when EDGE_TOP, EDGE_LEFT
+          moved(x_inc_l, y_inc_t)
+        when EDGE_BOTTOM
+          moved(x_inc_l, y_inc_b)
+        when EDGE_RIGHT
+          moved(x_inc_r, y_inc_t)
+        end
+      end
+
+      #=== tmport#get_normal_bar_of_edge
+      # (1)  (6) bar from call port. this indicate A position.
+      # join::TmJoin
+      def get_normal_bar_of_edge(join)
+        pos = get_cell.get_edge_position_in_normal_dir(@edge_side) + CPGAP * TECSModel.get_sign_of_normal(@edge_side)
+        if TECSCDE::TECSModel.vertical?(@edge_side)
+          TECSCDE::TECSModel::HBar.new(pos, join)
+        else
+          TECSCDE::TECSModel::VBar.new(pos, join)
+        end
+      end
+
+      #=== TmPort#get_position_in_tangential_dir
+      def get_position_in_tangential_dir
+        x, y, _width, _height = get_cell.get_geometry
+        TECSCDE::TECSModel.vertical?(@edge_side) ? y + @offset : x + @offset
+      end
+
+      def get_position_in_normal_dir
+        get_cell.get_edge_position_in_normal_dir(@edge_side)
+      end
+
+      def get_sign_of_normal
+        TECSCDE::TECSModel.get_sign_of_normal(@edge_side)
+      end
+
+      def get_edge_side
+        @edge_side
+      end
+
+      def get_edge_side_name
+        case @edge_side
+        when EDGE_TOP
+          :EDGE_TOP
+        when EDGE_BOTTOM
+          :EDGE_BOTTOM
+        when EDGE_LEFT
+          :EDGE_LEFT
+        when EDGE_RIGHT
+          :EDGE_RIGHT
+        end
+      end
+
+      def get_cell
+        if @owner.is_a?(TECSCDE::TECSModel::TmCell)
+          @owner
+        else
+          @owner.owner
+        end
+      end
+
+      def get_position
+        x, y, w, h = get_cell.get_geometry
+        case @edge_side
+        when EDGE_TOP
+          [x + @offset, y]
+        when EDGE_BOTTOM
+          [x + @offset, y + h]
+        when EDGE_LEFT
+          [x, y + @offset]
+        when EDGE_RIGHT
+          [x + w, y + @offset]
+        end
+      end
+
+      def get_name
+        @port_def.get_name
+      end
+
+      #=== TmPort# get_signature
+      # RETURN::Signature
+      def get_signature
+        @port_def.get_signature
+      end
+
+      def get_subscript
+        @subscript
+      end
+
+      def set_subscript(subscript)
+        modified do
+          @subscript = subscript
+        end
+      end
+
+      #=== TmPort#array?
+      def array?
+        false
+      end
+
+      #=== TmPort#set_position
+      def set_position(edge_side, offset)
+        modified do
+          @edge_side = edge_side
+          @offset = TECSCDE::TECSModel.round_length_val(offset)
+        end
+      end
+
+      #=== TmPort#delete_highlighted
+      # delete_highlighted if this port is a member of unsubscripted array.
+      def delete_highlighted
+        return unless @owner.editable?
+        return unless @owner.is_a?(TECSCDE::TECSModel::TmPortArray)
+        @owner.delete_highlighted(self)
+      end
+
+      #=== TmPort#insert
+      # before_after::Symbol: :before, :after
+      # insert if this port is a member of unsubscripted array.
+      def insert(before_after)
+        return unless @owner.is_a?(TECSCDE::TECSModel::TmPortArray)
+        @owner.insert(self, before_after)
+      end
+
+      #=== TmPort#editable?
+      def editable?
+        @owner.editable?
+      end
+
+      #=== TmPort#owner_cell
+      def owner_cell
+        if @owner.is_a?(TECSCDE::TECSModel::TmCell)
+          @owner
+        elsif @owner.is_a?(TECSCDE::TECSModel::TmPortArray)
+          @owner.owner
+        else
+          raise "unknown cell"
+        end
+      end
+    end
+  end
+end

data/lib/tecscde/tecs_model/tm_port_array.rb

@@ -0,0 +1,246 @@
+#
+# 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_port_array"
+
+module TECSCDE
+  class TECSModel
+    class TmPortArray < TECSCDE::TmObject
+      # @ports::[TmPort]
+      # @port_def::Port
+      # @actual_size::Integer
+      # @subscript1::subscript value of 1st element. to check consistency of subscript
+
+      attr_reader :actual_size, :ports
+
+      # TmPortArray#get_port_for_new_join
+      # this method is for load
+      def get_port_for_new_join(subscript)
+        if @subscript1.nil?
+          # 1st element of this entry array
+          @subscript1 = subscript
+        elsif (@subscript1 >= 0 && subscript < 0) || (@subscript1 < 0 && subscript >= 0)
+          TECSCDE.logger.error("TM9999 array subscript inconsistent (similar error to S1128)")
+          return nil
+        end
+
+        modified do
+          # p "new_join: for name:#{@port_def.get_name}[ #{subscript} ] owner:#{@owner.get_name}, len=#{@ports.length}"
+          if subscript >= 0
+            if subscript >= @actual_size
+              unless @port_def.get_array_size == "[]"
+                TECSCDE.logger.error("#{@owner.get_name}.#{@port_def.get_name}[#{subscript}]: subscript=#{subscript} out of range(0..(#{@actual_size - 1})")
+                return nil
+              end
+              # in case of unsized array, extend array
+              # extend array size
+              (0..subscript).each do |subsc|
+                next if @ports[subsc]
+                port = new_port(subsc)
+                @ports[subsc] = port
+              end
+              @actual_size = @ports.length
+              # p "new_join: 1 for name:#{@port_def.get_name}[ #{subscript} ] owner:#{@owner.get_name}, len=#{@ports.length}"
+              return @ports[subscript]
+            else
+              port = @ports[subscript]
+              # p "new_join: 2 for name:#{@port_def.get_name}[ #{subscript} ] owner:#{@owner.get_name}, len=#{@ports.length}"
+              return port unless instance_of?(TECSCDE::TECSModel::TmCPortArray) # CPort cannot have multiple join
+              if port.get_join
+                TECSCDE.logger.error("#{@owner.get_name}.#{@port_def.get_name}[#{subscript}]: duplicate join")
+                return nil
+              end
+            end
+          else # no index
+            found_port = @ports.find do |pt|
+              pt.get_join.nil?
+            end
+            return found_port if found_port
+
+            # in case of unsized array, extend array
+            if @port_def.get_array_size == "[]"
+              port = new_port(@ports.length)
+              @ports << port
+              @actual_size = @ports.length
+              return port
+            end
+          end
+          return nil
+        end
+      end
+
+      #=== TmPortArray#get_near_port
+      def get_near_port(x, y)
+        @ports.each do |port|
+          xp, yp = port.get_position
+          # p "get_near_port x=#{x} y=#{y} xp=#{xp} yp=#{yp}"
+          if ((xp - x).abs < NEAR_DIST) && ((yp - y).abs < NEAR_DIST)
+            # p "near port: found"
+            return port
+          end
+        end
+        nil
+      end
+
+      #=== TmPortArray#array?
+      def array?
+        true
+      end
+
+      def moved_edge(x_inc_l, x_inc_r, y_inc_t, y_inc_b)
+        @ports.each do |port|
+          port.moved_edge(x_inc_l, x_inc_r, y_inc_t, y_inc_b)
+        end
+      end
+
+      def moved(x_inc, y_inc)
+        @ports.each do |port|
+          port.moved(x_inc, y_inc)
+        end
+      end
+
+      def get_member(subscript)
+        if subscript < 0 || subscript >= @actual_size
+          nil
+        else
+          @ports[subscript]
+        end
+      end
+
+      #=== TmPortArray#delete
+      # this method is called from TmCell
+      def delete
+        @ports.each(&:delete)
+      end
+
+      #=== TmPortArray#delete_highlighted
+      # this method is called from Control
+      def delete_highlighted(port)
+        if @port_def.get_array_size != "[]"
+          TECSCDE.message_box(<<~MESSAGE, :OK)
+            Array size is fixed (#{@port_def.get_array_size}).
+            Cannot delete array member.
+          MESSAGE
+          return
+        end
+        index = @ports.index(port)
+        if index != 0
+          modified do
+            TECSCDE.logger.info("delete #### subscript=#{port.get_subscript}")
+            port.delete
+            if @ports.delete(port).nil?
+              TECSCDE.logger.info("delete: not found")
+            end
+            index = 0
+            @ports.each do |pt|
+              pt.set_subscript(index)
+              index += 1
+            end
+          end
+        else
+          TECSCDE.message_box(<<~MESSAGE, :OK)
+            cannot delete array member with subscript==0
+          MESSAGE
+        end
+      end
+
+      #=== TmPortArray#insert
+      # this method is called from Control
+      def insert(port, before_after)
+        if @port_def.get_array_size != "[]"
+          TECSCDE.message_box(<<~MESSAGE, :OK)
+            Array size is fixed (#{@port_def.get_array_size}).
+            Cannot insert array member.
+          MESSAGE
+          return
+        end
+        modified do
+          @owner.adjust_port_position_to_insert(port)
+          subsc = port.get_subscript
+          i = @ports.length - 1
+          while i > subsc
+            @ports[i].set_subscript(@ports[i].get_subscript + 1)
+            @ports[i + 1] = @ports[i]
+            i -= 1
+          end
+          new_port = new_port(subsc + 1)
+          new_port.set_position(port.get_edge_side, port.offset + DIST_PORT)
+          @ports[subsc + 1] = new_port
+
+          TECSCDE.logger.info("insert ####")
+        end
+      end
+
+      def complete?
+        @ports.all?(&:complete?)
+      end
+
+      #=== TmPortArray#editable?
+      def editable?
+        @owner.editable?
+      end
+
+      #=== TmPortArray#unsubscripted_array?
+      def unsubscripted_array?
+        @port_def.get_array_size == "[]"
+      end
+
+      #=== TmPortArray#clone_for_undo
+      def clone_for_undo
+        bu = clone
+        bu.copy_from(self)
+        bu
+      end
+
+      def setup_clone(ports)
+        @ports = ports.dup
+      end
+    end
+  end
+end