How to Unregister a custom Menu using deUnRegUserTriggers() 

Referencing an old post by Andrew Beckett, (Andrew if you could please clarify how to do this)

http://www.cadence.com/Community/forums/p/17476/1245483.aspx#1245483

I am trying to build a menu which includes a menu item to re-load the menu.

The purpose is for adding new items and for testing and debugging code, without having to close Cadence and re-start.

Per Andrew's post, the Banner Menu should not be added in a Post Install Trigger (which appears to be the standard method), so I am loading it as (one of) a list of menus to add as a userMenuTrigger passed to RegUserTriggers.

I have not found a way to successfully do this.  Cadence will not reload UserTriggers without deleting them first, and cannot delete selectively, so all get deleted and all have to be re-registered.  What this means is that my "list" of menus has been expanded from the one custom menu, to include others not defined in the Menu.il file.

Another problem is that in order to re-load the modified menu in-session, I have to first delete it.

hiDeleteMenu() requires an argument of "r" type template, a defstruct which I can't locate.  Defining the Menu does not return any value to the CIW, so I do not know what the argument is that needs to be passed to hiDeleteMenu().

I have tried modifying this code many times.  Even when I do not get an Error message, the Menu does not get updated with the current code instructions.

Here is some sample code:

procedure(MyMenu(args)

let((Update)

; define menu item(s)

  Update = hiCreateMenuItem(

  ?name  'Update

  ?itemText  "Update"

  ?callback  "call_Update()"

) ;Update

; define call procedure

procedure( call_Update()

  load("MyMenu.il")

) ; proc

; create pulldown menu

if(boundp('MyMenu) then

hiDeleteMenu('MyMenu)

) ; fi

list(OtherMenu hiCreatePulldownMenu(

  'MyMenu

  "MyMenu"

  list(Update)

 ) ; list

) ; let

) ; proc

; trigger menu

if ( ( deGetAppInfo( "maskLayout" )->userMenuTrigger ) then

; this always returns true because MyMenu is not the only user Trigger Menu!!

; can the test case be more specific for MyMenu??

 deUnRegUserTriggers("maskLayout")

; this removes ALL user Trigger Menus

deRegUserTriggers("maskLayout" nil 'MyMenu)

else

 deRegUserTriggers("maskLayout" nil 'MyMenu)

) ; fi

- James C.

James,

Unregistering and re-registering the trigger won't help you here, because the issue is that you need to have something to re-trigger the event - otherwise it won't call your userMenuTrigger.

If you want to update the menus, I'd suggest having your callback redefine the menus, and then do:

deInstallApp(hiGetCurrentWindow() "Pcell") deInstallApp(hiGetCurrentWindow() "Layout")

This is like switching to the "Pcell" tool then back to Layout - and that will cause it to re-install the menu, using whatever is the latest definition of that menu.

Regards,

Andrew.

Hi Andrew,

I have tested the callback as the following: (I am no longer un-registering and re-registering, only registering User Triggers)

procedure( call_Update()

     load("MyMenu.il")

     deInstallApp(hiGetCurrentWindow() "Pcell")

     deInstallApp(hiGetCurrentWindow() "Layout")

) ; proc

I get the same ERROR msgs about the Layout Menu trigger already being defined -

*ERROR* User menu trigger already registered for viewType maskLayout.

*ERROR* load: error while loading file - "MyMenu.il"

Thank you Andrew,

I got it to work in 2 different ways:

procedure(MyMenu_Prog(_args)

let((.....as before.....
.................................................................

Option (1)

procedure( call_Update()
         isReg_MyMenu = t ; Menu is already registered if calling Update
         load("MyMenu.il")
         deInstallApp(hiGetCurrentWindow() "Pcell")
         deInstallApp(hiGetCurrentWindow() "Layout")
 ) ; proc

list(hiCreatePulldownMenu(.....as before

); list

) ) ; end let, end proc

 if( boundp('isReg_MyMenu)  then
           printf( "Skill Script Menu previously defined and Menu Trigger registered.\n" )
           printf( "Skill Script Menu Trigger does not need to be re-registered.\n" )
    else
           deRegUserTriggers("maskLayout" nil 'MyMenu_Prog)
  ) ; fi

Option (2)

procedure( call_Update()
     isReg_MyMenu = t ; Menu is already registered if calling Update
     load("MyMenu.il")
 ) ; proc

list(hiCreatePulldownMenu(.....as before

); list

) ) ; end let, end proc

if( !boundp( 'isReg_SkillScriptMenu ) then
             deRegUserTriggers("maskLayout" nil 'skill_PulldownMenu_Prog)
             else
                if( isReg_SkillScriptMenu == t  then
                     println("**** WARNING:                                                                         ")
                     println("****         Multiple loading may result in errors that require the user")
                     println("****         to exit the application and re-invoke                              ");
     
                  procedure( SetupSkillScriptMenuTrigger()
                    prog( (prevAppTrigger prevMenuTrigger prevPostInstallTrigger viewtype appinfo )
     
                      if( !boundp('SkillScriptMenuViewType) then
                             SkillScriptMenuViewType = list("maskLayout" "maskLayoutXL" "maskLayoutGXL")
                      ) ; fi
     
                      ; Get any existing trigger(s)
                      foreach( viewtype SkillScriptMenuViewType
     
                          when(appinfo=deGetAppInfo(viewtype)
     
                                     prevAppTrigger          = get( appinfo 'userAppTrigger )
                                     prevMenuTrigger         = get( appinfo 'userMenuTrigger )
                                     prevPostInstallTrigger  = get( appinfo 'userPostInstallTrigger )
     
                                     ; If there are previously defined menu triggers then unregister them.
                                       if( (prevAppTrigger!=nil) || (prevMenuTrigger!=nil) || (prevPostInstallTrigger!=nil) then
                                            deUnRegUserTriggers( viewtype )
                                     ) ; fi
     
                                     ; Register the new trigger which will contain the old trigger, if any.
                                     deRegUserTriggers( viewtype prevAppTrigger prevMenuTrigger prevPostInstallTrigger )
     
                            ) ; when
                      ) ; foreach
                    ) ; prog
                  ) ; proc
                ) ; fi
) ; fi

 Clearly, your suggestion is much simpler than saving the current Triggers, unregistering them, and re-registering them.

For anyone else who looks at this code and is confused about the variable names, I attempted to simplify my code as I typed or copied it in, replacing the program and menu names to read "...MyMenu..." - unfortunately I did not catch all of the needed replacements!

ie isReg_SkillScriptMenu ~= isReg_MyMenu

ie skill_PulldownMenu_Prog ~= MyMenu_Prog

etc.

Andrew,

I have noticed that although the menu will update the source code for items already defined in the menu when the Update function is called, it will not ADD new items to the menu defined prior to the next Update function.  EG, in the shell env, I add an item to MyMenu.il, then use the Update function in the Layout env, but the menu does not contain the addd item.

Any ideas?

Thanks again

Hello,

I am using the folowing code to use a menu item to update the menu contents and functions but it is not working properly.

Using the Update item, I see all the right messages in the CIW, stating that functions have been redefined, but the functions do not really update (operate according to updated source code), and added menu items do not appear in the menu (eg the menu is not really updated).

I have attempted this with and without deUnRegUserMenuTriggers, both attempts with the same results.  In this case, using the deInstallApp() function to reset the menu triggers, the CIW log does not show these functions being called...so I am not confident they are...

; MyMenu.il
       procedure(MyMenu_Prog(_args)
       
       let(( PGtext Update )
       
       ; Define Menu items
       ;****************************
       PGtxt = hiCreateMenuItem(
               ?name   'PGtxt
              ?itemText "PGtext"
              ?callback "hiFocusToCIW( PGtext() )"
              ) ;PGtxt
      
      Update = hiCreateMenuItem(
              ?name           'Update
              ?itemText       "Update this menu"
              ?callback       "call_Update()"
              ) ;Update
      
      ; Define Call Procedures
      ;****************************
      procedure( call_Update()
           isReg_MyMenu = t                                           ;   Menu is already registered if calling Update
           load("MyMenu.il")
           deInstallApp(hiGetCurrentWindow() "Pcell")        ; change app to force update
           deInstallApp(hiGetCurrentWindow() "Layout")      ; reset app to get menu re-loaded
      ) ; proc
      
      ; Create Pulldown Menu
      ;****************************
      list(hiCreatePulldownMenu(
              'MyMenu
              "MyMenu"
              list( PGtxt Update)
              ); hiCreatePulldownMenu
      ); list
      
      ); let
      ); procedure
      
      ; Trigger Menu when opening a Layout
      ;*****************************************
      if( boundp('isReg_MyMenu)  then
              printf( "MyMenu updated - Menu Trigger already registered.\n" )
      else
              deRegUserTriggers("maskLayout" nil 'MyMenu_Prog)
      ) ; fi
      
      ; End MyMenu.il

Selecting Update from the menu gives the following CIW messages:

"call_Update()

function MyMenu_Prog redefined

MyMenu updated - Menu Trigger already registered.

function call_Update redefined

ERROR: ERROR (LM -1): license error (-97) - contact Cadence CRC at 1-877-CDS-4911 (run 'lic_error -1' for more information)

t"

FYI the ERROR message appears whether I load custom SKILL scripts like MyMenu, or not, so it is not generated by this Menu Program.

Any advice greatly welcome.

- James C.

FYI, regarding the deInstallApp() calls...

the initial open of a layout cell view does have several "Loading... .cxt" transcript messages, and

the first call to Update() from the menu, does show "Loading pCellGen.cxt" in the CIW transcript.

Following these initial actions, once the relevant .cxt files have been loaded, they do not need to be reloaded, so nothing is reflected in the CIW transcript.

My own suppositions.

- James

The code works for me. I don't get the license error you do (not sure what that is to do with). 

I'm using IC615 (6.1.5.500.14) - but I doubt that's really anything to do with it.

Andrew.