; ##########################################################################

;                       Find Components from List

;   This routine will open a form which displays all currently placed 
;   components. When the user selects a ref des from the list the component
;   is highlighted. The "Filter" in the form allows the user to select only
;   components beginning with the specified character. The "Refresh List"
;   button updates the list with the current data taking any filter settings
;   into account. The "Show Element" button displays the component properties
;   and the "Jump to Element" button zooms in to the selected comonent.

;   To run the routine within Allegro type "find component".

;   Written by David J. Scheuring
;   Sr. Applications Eng. Cadence Design Systems
;   May 31, 1995

;   Rev A
;   March, 19,2000
;   Adjusted behavior of Refresh List button and Ref Des Filter

;   Rev B
;   June 23,2004
;   Adjusted behavior of Refresh List button and Ref Des Filter for use in 15.x release
;   Changes
;   June 24,2004 - Included changes from Charlie Davies (Harris GCSD) 
;		 - modified window parameters to work with any DB units.

;   Rev C
;   Written and tested with PCB Editor v16.2 ISR 008
;   Evan Shultz
;   QSC Audio Products, LLC
;   evan_shultz@qscaudio.com
;   Apr 17, 2009
;   -Added 'Show Element' button to display component properties
;   -Added 'Jump to Element' button to zoom to component
;   -Used axlWindowBoxSet for zooming (old method wasn't working in 16.2)
;   -Added Zoom Fit on exit
;   -Made buttons on form use 'Abc' capitalization instead of 'ABC'

; ##########################################################################

axlCmdRegister( "find component" `Find_Component_Routine ?cmdType "interactive")

; ########################
; Set the global variables
; ########################
Ref_Des_Filter = "*"
Comp_List = nil
Placed_List = nil

(defun Find_Component_Routine ()
 axlDBRefreshId(axlDBGetDesign())
 axlClearSelSet()

 ; #################
 ; Declare variables
 ; #################
 (let (Find_Component_Form Command)

  ; ###############
  ; Clear variables
  ; ###############
  Find_Component_Form = nil
  Command = nil

  ; ####################################
  ; Build the placed component list form
  ; ####################################
  Find_Component_Form = outfile("Find_Component_Form.form" "w")
  fprintf(Find_Component_Form "FILE_TYPE=FORM_DEFN VERSION=2\n")
  fprintf(Find_Component_Form "FORM\n")
  fprintf(Find_Component_Form "FIXED\n")
  fprintf(Find_Component_Form "PORT 25 20\n")
  fprintf(Find_Component_Form "HEADER \"Find Component\"\n")
  fprintf(Find_Component_Form "TILE\n")
  fprintf(Find_Component_Form "TEXT \"COMPONENTS LIST\"\n")
  fprintf(Find_Component_Form "TLOC 4 0\n")
  fprintf(Find_Component_Form "ENDTEXT\n")
  fprintf(Find_Component_Form "FIELD Placed_List\n")
  fprintf(Find_Component_Form "FLOC 2 2\n")
  fprintf(Find_Component_Form "LIST \"\" 21 10\n")
  fprintf(Find_Component_Form "ENDFIELD\n")
  fprintf(Find_Component_Form "TEXT \"Current Ref Des\"\n")
  fprintf(Find_Component_Form "TLOC 2 22\n")
  fprintf(Find_Component_Form "ENDTEXT\n")
  fprintf(Find_Component_Form "FIELD Current_Ref_Des\n")
  fprintf(Find_Component_Form "FLOC 2 24\n")
  fprintf(Find_Component_Form "STRFILLIN 16 10\n")
  fprintf(Find_Component_Form "ENDFIELD\n")
  fprintf(Find_Component_Form "FIELD Show_Element\n")
  fprintf(Find_Component_Form "FLOC 2 27\n")
  fprintf(Find_Component_Form "MENUBUTTON \"Show Element\" 15 3\n")
  fprintf(Find_Component_Form "ENDFIELD\n")
  fprintf(Find_Component_Form "FIELD Jump_to_Element\n")
  fprintf(Find_Component_Form "FLOC 2 30\n")
  fprintf(Find_Component_Form "MENUBUTTON \"Jump to Element\" 15 3\n")
  fprintf(Find_Component_Form "ENDFIELD\n")
  fprintf(Find_Component_Form "TEXT \"Filter:\"\n")
  fprintf(Find_Component_Form "TLOC 2 33\n")
  fprintf(Find_Component_Form "ENDTEXT\n")
  fprintf(Find_Component_Form "FIELD Ref_Des_Filter\n")
  fprintf(Find_Component_Form "FLOC 10 33\n")
  fprintf(Find_Component_Form "STRFILLIN 5 10\n")
  fprintf(Find_Component_Form "ENDFIELD\n")
  fprintf(Find_Component_Form "FIELD Refresh_List\n")
  fprintf(Find_Component_Form "FLOC 2 36\n")
  fprintf(Find_Component_Form "MENUBUTTON \"Refresh List\" 15 3\n")
  fprintf(Find_Component_Form "ENDFIELD\n")
  fprintf(Find_Component_Form "FIELD done\n")
  fprintf(Find_Component_Form "FLOC 2 39\n")
  fprintf(Find_Component_Form "MENUBUTTON \"Done\" 6 3\n")
  fprintf(Find_Component_Form "ENDFIELD\n")
  fprintf(Find_Component_Form "ENDTILE\n")
  fprintf(Find_Component_Form "ENDFORM\n")
  close(Find_Component_Form)

  ; ##################################
  ; Generate list of placed components
  ; ##################################
  axlSetFindFilter(?enabled list("noall" "components") ?onButtons list("noall" "components"))
  Comp_List = axlGetSelSet(axlAddSelectAll())
  (foreach Item Comp_List
   (if Item->symbol != nil then
    Placed_List = cons(Item->name Placed_List)
   );if Item->symbol != nil
  );end foreach Item Comp_List

  ; #################################
  ; Define the place list form action
  ; #################################
  (defun Find_Component_Form_Action_Routine (Find_Component_Form)
   (case Find_Component_Form->curField
    ("Refresh_List"
    Placed_List = nil
    axlDBRefreshId(axlDBGetDesign())
    axlClearSelSet()
    axlSetFindFilter(?enabled list("noall" "components") ?onButtons list("noall" "components"))
    Comp_List = nil
    Comp_List_Unfiltered = nil
    (if Ref_Des_Filter == "*" then
     Comp_List = axlGetSelSet(axlAddSelectAll()) else
     Comp_List_Unfiltered = axlGetSelSet(axlAddSelectAll())
     (foreach Item Comp_List_Unfiltered
      (if getchar(Item->name 1) == getchar(Ref_Des_Filter 1) then
       Comp_List = cons(Item Comp_List)
      );end if
     );end foreach
    );end if
    (foreach Item Comp_List
     (if Item->symbol != nil then
      Placed_List = cons(Item->name Placed_List)
     );end if Item->symbol != nil
    );end foreach Item Comp_List
    (if Placed_List == nil then
     axlFormListDeleteAll(Find_Component_Form "Placed_List")
     axlFormSetField(Find_Component_Form "Placed_List" "No Match")
     axlFormSetField(Find_Component_Form "Ref_Des_Filter" Ref_Des_Filter)
     axlFormDisplay(Find_Component_Form)
     axlUIWPrint(Find_Component_Form "No Match")
     else
     axlFormListDeleteAll(Find_Component_Form "Placed_List")
     Placed_List = sort(Placed_List nil)
     axlFormSetField(Find_Component_Form "Placed_List" Placed_List)
     axlFormSetField(Find_Component_Form "Ref_Des_Filter" Ref_Des_Filter)
     axlFormDisplay(Find_Component_Form)
     axlUIWPrint(Find_Component_Form "Select Component")
    );end if Placed_List == nil
   );end Refresh_List
    ("Show_Element"
     axlShowObject(Component)
    );end "Show_Element"
	("Jump_to_Element"
	 ;axlZoomToDbid(Component t)
	 ; ***axlZoomDbid should/might work to replace the zooming code below***
	 window_buffer = axlMKSConvert(500 "MILS")
	 Lower_X = xCoord(car(car(Component)->symbol->bBox)) - window_buffer
	 Lower_Y = yCoord(car(car(Component)->symbol->bBox)) - window_buffer
	 Upper_X = xCoord(cadr(car(Component)->symbol->bBox)) + window_buffer
	 Upper_Y = yCoord(cadr(car(Component)->symbol->bBox)) + window_buffer
	 zoom_box = list(list(Lower_X Lower_Y) list(Upper_X Upper_Y))
	 axlWindowBoxSet(zoom_box)
    );end "Jump_to_Element"
    ("Ref_Des_Filter"
     (if Find_Component_Form->curValue == "" then
      Ref_Des_Filter = "*" else
      Ref_Des_Filter = upperCase(Find_Component_Form->curValue)
      t
     );end if
    );end "Ref_Des_Filter"
    ("done"
     Placed_List = nil
     axlFormClose(Find_Component_Form)
     axlCancelEnterFun()
     axlClearSelSet()
     axlFlushDisplay()
     axlShell("zoom fit; redisplay")
    );end "done"
    ("Placed_List"
     axlSetFindFilter(?enabled list("components") ?onButtons list("components"))
     Component = axlGetSelSet(axlSingleSelectName("COMPONENT" strcat(Find_Component_Form->curValue)))
     axlHighlightObject(Component)
     axlFormSetField(Find_Component_Form "Current_Ref_Des" Find_Component_Form->curValue)
     t
    );end "Placed_List"
   );end case
  );end defun Find_Component_Form_Action_Routine

  ; #####################
  ; Display the form/list
  ; #####################
   Find_Component_Form = axlFormCreate( (gensym) "Find_Component_Form.form" '(e outer) 'Find_Component_Form_Action_Routine t)
   (if Placed_List == nil then
    axlFormSetField(Find_Component_Form "Placed_List" "No Placed Comps")
    axlFormSetField(Find_Component_Form "Ref_Des_Filter" Ref_Des_Filter)
    axlFormDisplay(Find_Component_Form)
    axlUIWPrint(Find_Component_Form "No Placed Comps")
    else
    Find_Component_Form = axlFormCreate( (gensym) "Find_Component_Form.form" '(e outer) 'Find_Component_Form_Action_Routine t)
    Placed_List = sort(Placed_List nil)
    (foreach Ref_Des Placed_List
     axlFormSetField(Find_Component_Form "Placed_List" Ref_Des)
     axlFormSetField(Find_Component_Form "Ref_Des_Filter" Ref_Des_Filter)
     axlFormDisplay(Find_Component_Form)
     axlUIWPrint(Find_Component_Form "Select Component")
    );end foreach Ref_Des Placed_List
   );end if Placed_List == nil
 );end let
);end defun Find_Component_Routine