wrb 2.0.0

data/lib/wrb/components/menu.rb

@@ -0,0 +1,592 @@
+require 'wrb'
+
+module WR
+  module RC
+    MFT_STRING       = 0x0000
+    #MFT_BITMAP       = 0x0004
+    MFT_MENUBARBREAK = 0x0020
+    MFT_MENUBREAK    = 0x0040
+    MFT_OWNERDRAW    = 0x0100
+    MFT_RADIOCHECK   = 0x0200
+    MFT_SEPARATOR    = 0x0800
+    MFT_RIGHTORDER   = 0x2000
+    MFT_RIGHTJUSTIFY = 0x4000
+    
+    MFS_GRAYED       = 0x0003
+    MFS_DISABLED     = 0x0003
+    MFS_CHECKED      = 0x0008
+    MFS_HILITE       = 0x0080
+    MFS_ENABLED      = 0x0000
+    MFS_UNCHECKED    = 0x0000
+    MFS_UNHILITE     = 0x0000
+    MFS_DEFAULT      = 0x1000
+    
+    MIIM_STATE       = 0x0001
+    MIIM_ID          = 0x0002
+    MIIM_SUBMENU     = 0x0004
+    MIIM_CHECKMARKS  = 0x0008
+#   MIIM_TYPE        = 0x0010 # replaced by MIIM_BITMAP, MIIM_FTYPE, and MIIM_STRING.
+    MIIM_DATA        = 0x0020
+    MIIM_STRING      = 0x0040
+    MIIM_BITMAP      = 0x0080
+    MIIM_FTYPE       = 0x0100
+    
+    HBMMENU_SYSTEM          = 1
+    HBMMENU_MBAR_RESTORE    = 2
+    HBMMENU_MBAR_MINIMIZE   = 3
+    HBMMENU_MBAR_CLOSE      = 5
+    HBMMENU_MBAR_CLOSE_D    = 6
+    HBMMENU_MBAR_MINIMIZE_D = 7
+    HBMMENU_POPUP_CLOSE     = 8
+    HBMMENU_POPUP_RESTORE   = 9
+    HBMMENU_POPUP_MAXIMIZE  = 10
+    HBMMENU_POPUP_MINIMIZE  = 11
+    HBMMENU_CALLBACK        = -1
+  end
+  
+  # A list of items that specify options or groups of options (a submenu) for an application.<br>
+  # If you want to set main-menu, use Menubar.
+  # <br>See also <a href="https://docs.microsoft.com/en-us/windows/desktop/menurc/resources">
+  # Menus and Other Resources section of Microsft Docs</a>
+  class Menu < RWin::Menu
+    
+    include RC
+    include ModAutoloading
+    
+    # The wrapper of idcmd of menu.
+    class Item
+      include RC
+      attr_reader :_menu
+      MENUITEMINFO = API::MENUITEMINFO
+      def initialize(menu, id) 
+        @_menu = menu
+        @_idcmd = id #; dpp self, menu, id
+      end
+      
+#      def inspect()
+#        sprintf "#<%p: 0x%x idcmd=%p, caption=%p>", self.class, self.__id__, @_idcmd, caption
+#      end
+      
+      def idcmd()
+        @_idcmd
+      end
+      
+      def index()
+        @_menu._index(self)
+      end
+      
+      def caption()
+        mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_STRING]
+        @_menu.GetMenuItemInfo(@_idcmd, nil, mii)
+        buff = TCHAR[mii.cch+=1]
+        mii.dwTypeData = buff
+        @_menu.GetMenuItemInfo(@_idcmd, nil, mii)
+        buff.to_s
+      end
+      def caption=(str)
+        mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_STRING]
+        mii.dwTypeData = str.to_s.dup
+        mii.cch = str.size
+        @_menu.SetMenuItemInfo(@_idcmd, nil, mii)
+        str
+      end
+      
+      def bitmap=(bmp)
+        mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_BITMAP]
+        mii.hbmpItem = bmp.is_a?(Integer) ? bmp : bmp._hbitmap
+        @_menu.SetMenuItemInfo(@_idcmd, nil, mii)
+      end
+      
+      def image()
+        mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_BITMAP | MIIM_DATA]
+        @_menu.GetMenuItemInfo(@_idcmd, nil, mii)
+        mii.dwItemData == API.int2uint(-1) ? nil : mii.dwItemData
+      end
+      def image=(idx)
+        mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_BITMAP | MIIM_DATA]
+        if idx.nil?
+          mii.hbmpItem = 0
+          mii.dwItemData = -1
+        else
+          mii.hbmpItem = HBMMENU_CALLBACK
+          mii.dwItemData = idx
+        end
+        @_menu.SetMenuItemInfo(@_idcmd, nil, mii)
+      end
+      
+      def menu() @_menu; end
+      alias parent menu
+      
+      def delete() 
+        @_menu._delete(index);
+      end
+      
+      def grayed() (_get_state() & 0x0001) !=0; end
+      def grayed=(flag) _set_state(0x0001, flag); end
+      
+      def disabled() (_get_state() & 0x0002) != 0; end
+      def disabled=(flag) _set_state(0x0002, flag); end
+      
+      def checked() (_get_state() & 0x0008) != 0; end
+      def checked=(flag) _set_state(0x0008, flag); end
+      
+      def gettype()
+        mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_FTYPE]
+        @_menu.GetMenuItemInfo(@_idcmd, false, mii)
+        mii.fType
+      end
+      def settype(type)
+        mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_FTYPE]
+        mii.fType = type
+        @_menu.SetMenuItemInfo(@_idcmd, false, mii)
+      end
+      
+      private
+      def _get_state()
+        mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_STATE]
+        @_menu.GetMenuItemInfo(@_idcmd, false, mii)
+        mii.fState
+      end
+      def _set_state(state, flag)
+#        old_state = _get_state()
+        mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_STATE]
+        if flag == true
+          mii.fState |= state
+        elsif flag==false || flag.nil?
+          mii.fState &= ~state
+        else
+          raise ArgumentError, "flag must be true, false or nil", caller(2)
+        end
+        @_menu.SetMenuItemInfo(@_idcmd, false, mii)
+      end
+      
+      alias text caption
+      alias text= caption=
+    end # Item
+    
+    ################### Main ##################
+    
+=begin
+following methods are defined in the super class.
+:singleton_methods
+  self.new(name, caption, menu-item_or_sub-menu, ... )
+
+:instance_methods
+  GetMenuItemCount()
+    A low-level API function.
+  GetMenuItemID()
+    A low-level API function.
+  GetMenuItemInfo()
+    A low-level API function.
+  GetSubMenu()
+    A low-level API function.
+  SetMenuItemInfo(index, flag, menuiteminfo)
+    A low-level API function.
+  _hmenu()
+    Retreives a handle of this menu.
+  alive?()
+    Retreives whether this maneu is created or not.
+    
+#  createmenu()
+#  createpopup()
+#  delete()
+  destroy()
+    Destroys this menu and all items and submenu.
+    
+#  insert()
+
+=end
+    
+    MENUITEMINFO = API::MENUITEMINFO
+    include ModAccessor
+    attr_reader :_owner, :_type, :_image
+    attr_accessor :name, :idcmd
+    alias :_name :name
+    alias :_idcmd :idcmd
+    alias _destroy destroy
+    
+    # self.[](name, caption, imagelist=nil, menu-item_or_sub-menu, ... )
+    # Creates a menu but not alive with given arguments.<br>
+    # A <i>menu-item</i> must be a pair of name and caption, and <i>name</i> must be a symbol.
+    def self.[](*args)
+      self.new(*args) 
+    end
+    
+    def initialize(*args)
+      raise TypeError, "1st argument must be Symbol." unless args[0].is_a?(Symbol)
+      super()
+      @name = args.shift
+      @_caption = args.shift if args[0].is_a?(String) #; dpp args
+      @_imagelist = args.shift if args[0].is_a?(Imagelist)
+      n = args.shift if args[0].is_a?(Integer)
+      n > 31 ? @_type = n : @_image = n if n
+      n = args.shift if args[0].is_a?(Integer) # Check twise
+      n > 31 ? @_type = n : @_image = n if n
+      @_menus = []
+      self[0, 0] = *args# ; dpp name, @_menus
+#      @_menus = args
+    end
+    #
+    def inspect() 
+      sprintf "#<%p: 0x%x, %p>", self.class, self.__id__, name
+#      sprintf "#<%p: 0x%x, %p>", self.class, self.__id__ , _caption
+    end
+    
+    # Creates as child or popup menu.
+    def createpopup()
+      super
+      _create_substance
+      self.imagelist = @_imagelist if @_imagelist
+      self
+    end
+    alias _createpopup createpopup
+    
+    # Retreives a text of this menu.
+    def caption()
+      if alive?
+        return @_caption unless parent && parent.is_a?(Menu) && parent.index(self)
+        idx = parent.index(self)
+        mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_STRING]
+        parent.GetMenuItemInfo(idx, true, mii)
+        buff = TCHAR[mii.cch+=1]
+        mii.dwTypeData = buff
+        parent.GetMenuItemInfo(idx, true, mii)
+        buff.to_s
+      else
+        @_caption
+      end
+    end
+    alias _caption caption
+    
+    # Sets the text of this menu.
+    def caption=(s)
+      str = s.dup
+      if alive?
+        return unless parent
+        mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_STRING]
+        mii.dwTypeData = str.to_s
+        mii.cch = str.size
+        parent.SetMenuItemInfo(parent.index(self), true, mii)
+      else
+        @_caption = str.to_s
+      end
+    end
+    
+    def image
+      if alive?
+        return nil unless parent && parent.is_a?(Menu)
+        idx = parent.index(self)
+        mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_BITMAP | MIIM_DATA]
+        parent.GetMenuItemInfo(idx, true, mii)
+        mii.dwItemData == API.int2uint(-1) ? nil : mii.dwItemData
+      else
+        @_image
+      end
+    end
+    def image=(im)
+      if alive?
+        return nil unless parent && parent.is_a?(Menu)
+        idx = parent.index(self)
+        mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_BITMAP | MIIM_DATA]
+        if im.nil?
+          mii.hbmpItem = 0
+          mii.dwItemData = -1
+        else
+          mii.hbmpItem = HBMMENU_CALLBACK
+          mii.dwItemData = im
+        end
+        parent.SetMenuItemInfo(idx, true, mii)
+      else
+        @_image = im
+      end
+    end
+    
+    # Counts number of items of this menu.
+    def count()
+      alive? ? GetMenuItemCount() : (@_menus ? @_menus.size : 0)
+    end
+    alias _count count
+    #
+    def _set_owner(owner)
+      @_owner = owner
+      self
+    end
+    
+    # Inserts an item or a menu into specified index.<br>
+    # Give an array of [name, caption, image=nil, type=nil] as <i>item</i>.
+    def insert(idx, *arg)
+      if arg.size==1
+        arg = arg[0]
+        if arg.is_a?(Menu) #; dpp self, arg, arg.caption, arg.alive?, @_owner, parent
+          name = arg._name
+          capt = arg.caption
+#          type = arg._type
+          arg._set_owner_and_parent(@_owner, self)
+          _add_accessor(arg, name) unless respond_to?(name)
+          if alive?
+            arg.createpopup unless arg.alive? #; dpp idx, true, capt, arg
+            mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_STRING|MIIM_SUBMENU|MIIM_DATA]
+            mii.dwTypeData = capt
+            mii.cch = capt.size
+            mii.hSubMenu = arg._hmenu
+            if arg._type 
+              mii.fMask |= MIIM_FTYPE
+              mii.fType = arg._type
+            end
+            if arg._image
+              mii.fMask |= MIIM_BITMAP
+              mii.dwItemData = arg._image
+              mii.hbmpItem = HBMMENU_CALLBACK
+            else
+              mii.dwItemData = -1
+            end
+            super(idx, true, mii)
+          else #; dpp arg
+            @_menus.insert(idx, arg);
+          end
+        elsif arg.is_a?(Array)
+          if alive? #; dp "@%p, @_owner=%p", self, @_owner
+            image = type = nil
+            name, capt, n1, n2 = *arg # ;  dpp arg; #name, capt, n1, n2, type
+            n1 > 31 ? type = n1 : image = n1 if n1
+            n2 > 31 ? type = n2 : image = n2 if n2
+            idcmd = @_owner.new_control_id #; dpp name, capt, idcmd, type
+            @_owner.set_msgtranslator(WM_COMMAND) if !@_owner.get_msgtranslator(WM_COMMAND)
+            @_owner.register_event(idcmd, WM_COMMAND, 0, "#{name}_clicked", "h")
+            
+            mii = MENUITEMINFO[MENUITEMINFO::Size, MIIM_STRING | MIIM_ID | MIIM_DATA]
+            
+#            buf = TCHAR[capt.size+1]
+#            buf[0,capt.size] = capt.encode(Encoding::UTF_16LE); dpp buf.to_s
+            mii.dwTypeData =  capt.dup
+            mii.cch = capt.size+1; # dpp capt, mii.dwTypeData, mii.cch
+            mii.wID = idcmd
+            if type 
+              mii.fMask |= MIIM_FTYPE
+              mii.fType = type
+            end
+            if image
+              mii.fMask |= MIIM_BITMAP
+              mii.dwItemData = image
+              mii.hbmpItem = HBMMENU_CALLBACK
+            else
+              mii.dwItemData = -1
+            end
+            super(idx, true, mii)
+            if accel=capt.split("\t")[1]
+              @_owner.register_keyaccel(accel, idcmd)
+            end
+            _add_accessor(idcmd, name) unless respond_to?(name)
+          else
+            @_menus.insert(idx, arg);
+          end
+        elsif arg==:sep
+          if alive?
+            idcmd = @_owner.new_control_id
+            super(idx, true, '_sep', idcmd, MFT_SEPARATOR) 
+          else
+            @_menus.insert(idx, arg)
+          end
+        else
+          raise TypeError, "argument must be Menu or Array or :sep"
+        end
+      else
+        alive? ? super(idx, *arg) : @_menus.insert(idx, arg)
+      end
+    end
+    alias _insert insert
+    
+    alias __delete__ delete
+    
+    # Deletes specifired index of this menu, or deletes self when given no argument.
+    def delete(idx=nil)
+      raise ArgumentError, "Argument must be an Integer" if idx && !idx.is_a?(Integer)
+      unless alive?
+        if idx
+          @_menus.delete_at(idx)
+        else
+          @_parent._menus._delete(self)
+        end
+        return
+      end
+      if idx
+        raise ArgumentError, "Too large index: #{idx}" if idx > ModParent::ItemBaseID
+        obj = self[idx] #; dpp idx , obj
+        if obj.is_a?(Menu)
+          obj.count.times{|i| obj.delete(i)}
+        elsif accel=obj.caption.split("\t")[1]
+          @_owner.unregister_keyaccel(accel)
+        end
+        super(idx, true)
+        _delete_accessor_by_obj(obj)
+      else
+        if @_parent.is_a?(Menu)
+          @_parent._delete_accessor_by_obj(self)
+          @_parent._delete(@_parent.index(self))
+        else
+          self.destroy()
+        end
+      end
+    end
+    alias _delete delete
+    
+    # []=(index, length, *arguments)<br>
+    # Inserts and replaces specified index and length of this menu with given arguments.
+    def []=(idx, *args)# dpp self, alive?, @_owner
+      len = args[0].is_a?(Integer) ? args.shift : 1
+      args = args[0] if args[0].is_a?(Array) #;dp "@%p, %p", alive?, args
+      n = 0
+      while i=args.shift
+        if i == :sep
+          _insert(idx + n, i)
+        elsif i.is_a?(Symbol)
+          ar = [i]
+          while args[0] && 
+                !args[0].is_a?(Symbol) && !args[0].is_a?(Menu) && !args[0].is_a?(Array)
+            ar << args.shift
+          end #; dpp ar
+          _insert(idx + n, ar)
+        elsif i.is_a?(Array) || i.is_a?(Menu) #; dpp self, name, alive?, @_owner, i
+          _insert(idx + n, i)
+        else
+          raise TypeError, "Unknown argument: #{i.inspect}"
+        end
+        n += 1
+      end
+    end
+    
+    # Retreives an item or a menu specifiied <i>idx</i> in this menu.<br>
+    # The <i>idx</i> can be an index of items or an ID of menu-item.
+    def [](idx)
+      return @_menus[idx] unless alive?
+      if r=GetSubMenu(idx)
+        return r
+      elsif idx > ModParent::ItemBaseID
+        return Item.new(self, idx)
+      elsif id=GetMenuItemID(idx) #; dpp idx, id
+        return Item.new(self, id)
+      end
+      nil
+    end
+    
+    # Appends the items or menus at last of this menu.
+    def <<(arg)
+      self[_count, 0] = arg
+      self
+    end
+    
+    # Retreives an index of given object in this menu.<br>
+    # If no argument was given, retreives an index of this menu in the parent.
+    def index(obj=nil)
+      return parent._index(self) unless obj
+      if alive?
+        self.count.times{|i|
+          if obj.is_a?(Integer)
+            return i if GetMenuItemID(i) == obj
+          else
+            return i if GetSubMenu(i) == obj || GetMenuItemID(i) == obj.idcmd
+          end
+        }
+        nil
+      else
+        @_menus.index(obj)
+      end
+    end
+    alias _index index
+    
+    # Retreives parent of this menu.
+    def parent()
+      @_parent
+    end
+    alias _parent parent
+    
+    # Sets parent of this menu. Give a Menu as parent.
+    def parent=(prt) #;dpp self, prt, caller[0, 2]
+      _set_owner_and_parent(prt, prt)
+    end
+    
+    # Gets an imagelist assigned to this menu.
+    def imagelist()
+      @_imagelist
+    end
+    alias _imagelist imagelist
+    
+    # Assignes an imagelist to this menu.
+    def imagelist=(imglst)
+      @_imagelist ||= imglst #; dpp self, alive?, @_imagelist
+      if alive?
+        if @_imagelist
+          unless @_owner.respond_to?(:__drawitem__)
+            @_owner.register_event(WM_DRAWITEM, "__drawitem__", 'xs', DRAWITEMSTRUCT)
+            @_owner.instance_eval "
+            def __drawitem__(dis)
+              APP.hrsc2ref(dis.hwndItem).__send__(:__drawitem, dis)
+            end"
+          end
+          each{|i| i.imagelist ||= @_imagelist if i.is_a?(Menu)}
+        else
+          @_owner.unregister_event(WM_DRAWITEM, "__drawitem__")
+        end
+      end
+    end
+    
+    # Creates as child or popup menu.
+    def create()
+      createpopup()
+    end
+    alias _create create
+    
+    # Shows this menu at the specified coordiates on the owner window.
+    def popup(x, y)
+      @_owner.TrackPopupMenu(self, x, y)
+    end
+    alias _popup popup
+    
+    
+    # each(){|item| ... }
+    # Performs the block for each <i>item</i> in this menu as a block parameter.<br>
+    # An <i>item</i> may be a Menu or a Menu::Item.
+    def each()
+      _count.times{|i| yield self[i]}
+    end
+    alias _each each
+    
+    # Clears all items and submenus.
+    def clear()
+      self.count.times{|i| self.delete(0)}
+      self
+    end
+    alias _clear clear
+    
+    protected
+    def _set_owner_and_parent(onr, prt) #; dpp self, onr
+      onr.set_msgtranslator(WM_COMMAND) if onr && !onr.get_msgtranslator(WM_COMMAND)
+      @_owner = onr unless @_owner #; dp "@%p, @_owner=%p", self, onr
+      @_parent = prt
+      @_imagelist ||= prt.imagelist if prt.is_a?(Menu)
+    end
+    
+    private
+    def __drawitem(dis)
+      return unless @_imagelist
+      cv = Canvas.new(dis.hDC)
+      cv.DrawImagelist(@_imagelist, dis.itemData, 1, 1)
+    end
+    
+    def _create_substance() #; dpp name, @_menus
+      self[0, 0] = @_menus
+      @_menus = nil # recycle
+      self
+    end
+    
+    def _define_access_method(name, obj)
+      if obj.is_a?(Integer)
+        instance_eval "def #{name}() Menu::Item.new(self, @_accessors[:#{name}]); end"
+        instance_eval "def _#{name}() Menu::Item.new(self, @_accessors[:#{name}]); end"
+      else
+        instance_eval "def #{name}() @_accessors[:#{name}]; end"
+        instance_eval "def _#{name}() @_accessors[:#{name}]; end"
+      end
+    end
+  end
+end