ccpRegTrigger

ccpRegTrigger(
t_copyPhaseStr
s_triggerFunction
[ g_canEditList ]
)
=> t / nil

Description

Registers the copy trigger that you create. The copy trigger is called in the copy phase that you specify.

If you run copy commands through the Cadence Library Manager, you need to set the following in your .cdsenv file so that copy is done by cdsCopy instead of the Library Manager and the copy triggers that you specify are called:

ddserv.lib                     enableCopyInDFII      boolean      t

cdsLibManager.copyGlobals      mpsRadio              toggle       (t nil)

The cdsLibManager.copyGlobals setting is the default setting for the Remote Copy Service option in the Copy Preferences form.

Arguments

t_copyPhaseStr	One of the following strings, representing the phase of the copy operation in which you want the trigger function to be called: "ccpPostExpandTrigger": Gets called after expanding a list of source objects. "ccpPreTransferTrigger": Gets triggered before copying data or files. "ccpPostTransferTrigger": Gets triggered after copying data or files. "ccpPreUpdateTrigger": Gets triggered before the cross-reference update. "ccpPostCopyTrigger": Gets triggered after all the stages of copy are complete.
s_triggerFunction	Your trigger function, specified as a symbol.
g_canEditList	Allows to edit the copy lists. When set to nil, the trigger cannot edit the copy lists. The performance of the copy operation is better if you specify nil for this argument.

Value Returned

t	The copy trigger was added.
nil	The copy trigger could not be added.

Examples

ccpRegTrigger("ccpPostExpandTrigger" 'copyTriggerPrint t)

Additional Information

A copy trigger function is a function that specifies the action to be triggered in a specific phase of the copy operation.

The copy trigger function must return t for the copy operation to continue; if the function returns nil, the copy operation is canceled.

Use the following format for the copy trigger function:

procedure(copyTrigger(myFunction copyPhaseStr checkOffList supplementList
otherFromSpecs otherToSpecs updateList retHint ctxList reserved "stgggggggx"))
=> t / nil

where

• myFunction is your trigger function’s symbol.
• copyPhaseStr is the current copy trigger phase, specified as a string.
• checkOffList is the list of items to be copied. Each element of the list has the following format:
  

  (boolean fromGdmSpec toGdmSpec)

  If you do not want an item to be copied, set its boolean value to nil.
  The trigger function can only modify the copy lists if the g_canEditList argument of ccpRegTrigger is t.
  Do not skip any non-derived files because you might lose data. Specifically, if a file is skipped when the trigger is called by a rename function, you will lose the data because the original source will be deleted. The ccpTagOperation tag in the ctxList argument tells you which function is calling the trigger; you can modify the behavior of the trigger function accordingly.
• supplementList is a list to which your trigger function can append additional items to be copied. Any items you add must be in the same format as the items in the checkOffList. The supplementList ends with a nil; if you add items, do not remove the nil at the end of the list.
• otherFromSpecs and otherToSpecs are gdmSpecLists of other items to be copied that cannot be modified by the trigger function.
• updateList specifies the items to update. The trigger function can add or remove items from this list. updateList contains two elements:
  • s_updateSet, which is one of the following symbols:
    

    CCP_UPDATE_COPIED_DATA
    CCP_UPDATE_DESTLIB_ONLY
    CCP_UPDATE_FROM_LIBLIST

  • q_updateList, which is a gdmSpecList that contains the list of libraries to update.
• retHint is a list of one element which is either nil or non-nil. If your trigger function modifies any copy list, then it must also set the value of retHint to non-nil.
• ctxList is a list that contains the original arguments from the copy command. Each element of the list has the following format:
  

  (tag value)

  Your trigger function must not modify these values.
  Each tag-value pair is one of the following:
  

  Tag	Value of type
  ccpTagSkipLibs	gdmSpecList
  ccpTagOverwrite	boolean
  ccpTagExpand	expansion symbol
  ccpTagViewTypes	list of strings
  ccpTagViewNames	list of strings
  ccpTagNameSpace	string
  ccpTagNameExprs	string expression
  ccpTagUpdateOpt	update symbol
  ccpTagUpdateLibs	gdmSpecList
  ccpTagOperation	string identifying the copy function that fired the trigger; one of the following: ccpCopy, ccpCopyDesign, ccpCopyExactDesign, ccpCopyConfig, ccpExpand, ccpExpandDesign, ccpExpandExactDesign, ccpExpandConfig, ccpRename, ccpRenameReferenceLib

• reserved is an integer argument that is currently reserved.

The following example creates a copy trigger function that prints some of its arguments:

procedure(copyTriggerPrint(myFunction copyPhaseStr checkOffList supplementList 

                             otherFromSpecs otherToSpecs updateList retHint

                             ctxList reserved "stgggggggx")

    let((retOK)

        retOK = t

        printf("Copy phase is \"%s\"\n" copyPhaseStr)

        printf("Calling options were %L\n", ctxList)

        printf("Pre-copy set is %L\n", checkOffList)

        printf("Post-copy is from %L\n", otherFromSpecs)

        printf("               to %L\n", otherToSpecs)

        retOK

    )

)

Related Topics

Copy Preferences Form

Return to top