home *** CD-ROM | disk | FTP | other *** search
/ Windows News 2005 November / WNnov2005.iso / Windows / Equipement / Blender / blender-2.37a-windows.exe / $_5_ / .blender / scripts / doc_browser.py < prev    next >
Text File  |  2005-04-17  |  12KB  |  457 lines
  1. #!BPY
  2.  
  3. """
  4. Name: 'BPy Doc Browser'
  5. Blender: 232
  6. Group: 'System'
  7. Tip: 'Browse BPython (scripting API) modules doc strings.'
  8. """
  9.  
  10. __author__ = "Daniel Dunbar"
  11. __url__ = ("blender", "elysiun")
  12. __version__ = "1.0"
  13. __bpydoc__ = """\
  14. The "Doc Browser" lets users navigate the documentation strings of part of
  15. the Blender Python API.
  16.  
  17. It doesn't give access yet to object method functions and variables, only to
  18. module functions, but still it is a handy reference.
  19.  
  20. Hotkeys:<br>
  21.     Page Up / Page Down: scroll 5 lines at a time;<br>
  22.     Up / Down arrow keys or mouse wheel: scroll one line at a time.
  23.  
  24. Notes:<br>
  25.     Everyone interested in the bpython api is also invited to read "The Blender
  26. Python API Reference" doc, available online ("Python Scripting Reference"
  27. entry in Blender's Help menu).
  28. """
  29.  
  30.  
  31. # $Id: doc_browser.py,v 1.3 2005/04/16 05:25:41 ianwill Exp $
  32. #
  33. # --------------------------------------------------------------------------
  34. # ***** BEGIN GPL LICENSE BLOCK *****
  35. #
  36. # Copyright (C) 2004:  Daniel Dunbar, ddunbar _at_ diads.com
  37. #
  38. # This program is free software; you can redistribute it and/or
  39. # modify it under the terms of the GNU General Public License
  40. # as published by the Free Software Foundation; either version 2
  41. # of the License, or (at your option) any later version.
  42. #
  43. # This program is distributed in the hope that it will be useful,
  44. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  45. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  46. # GNU General Public License for more details.
  47. #
  48. # You should have received a copy of the GNU General Public License
  49. # along with this program; if not, write to the Free Software Foundation,
  50. # Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  51. #
  52. # ***** END GPL LICENCE BLOCK *****
  53. # --------------------------------------------------------------------------
  54.  
  55. #####
  56. # Blender help browser
  57. # By Daniel Dunbar, 
  58. #
  59. # This should function as a self-explanatory (interface, not code)
  60. # (mostly) help browser. The code is wacky and nasty and or fun,
  61. # but mainly bad, just cause it works doesn't mean its readable! 
  62. # 
  63. # TEEHEE!
  64. #
  65. # The row_draw function could easily be made into a more generic
  66. # and usefull table drawing function... 
  67. #
  68.  
  69. import Blender
  70. from types import ListType, IntType, FloatType, StringType, ModuleType
  71. from Blender.Draw import *
  72. from Blender.BGL import *
  73.  
  74. # Simple version check, since I use the
  75. # buffer calls... DONT use this code,
  76. # assume everyone has 1.73+, and force
  77. # them to upgrade if they dont
  78. try:
  79.     a= BufList
  80.     version= 172
  81. except:
  82.     version= 173
  83.     
  84. # I could have used the split from the string module,
  85. # but some people might not have it
  86. def split(str, on):
  87.     out= [""]
  88.     for s in str:
  89.         if s in on: out.append("")
  90.         else: out[-1]= out[-1]+s
  91.  
  92.     if out[-1]=="": del(out[-1])
  93.  
  94.     return out
  95.  
  96. last_sort= 1; direction= 1
  97. def sort_browselist(type):
  98.     global browselist
  99.     global last_sort, direction
  100.  
  101.     if (type==last_sort): direction= -direction
  102.     else: direction= 1
  103.  
  104.     last_sort= type
  105.  
  106.     if (direction==1):
  107.         def byname(x, y): return cmp(x[0],y[0]);
  108.         def bytype(x, y): return cmp(x[1],y[1])
  109.         def bydata(x, y): return cmp(x[2],y[2])
  110.     else:
  111.         def byname(x, y): return cmp(y[0],x[0]);
  112.         def bytype(x, y): return cmp(y[1],x[1])
  113.         def bydata(x, y): return cmp(y[2],x[2])
  114.  
  115.     if (type==1): browselist.sort(byname)
  116.     elif (type==2): browselist.sort(bytype)
  117.     elif (type==3): browselist.sort(bydata)
  118.  
  119. selected= -1
  120. def view_doc(num):
  121.     global selected, selected_page
  122.  
  123.     if (selected==num): selected= -1
  124.     else: selected= num
  125.  
  126.     selected_page= 0
  127.  
  128. function_filter= 0
  129. def toggle_function_filter():
  130.     global function_filter
  131.  
  132.     function_filter= not function_filter
  133.     make_browselist()
  134.  
  135. def view_page(dir):
  136.     global selected_page
  137.  
  138.     selected_page= selected_page + dir
  139.  
  140. browse_scrollstart= 0
  141. def browse_module(num):
  142.     global browsing, selected, browse_scrollstart
  143.     
  144.     if (num>=0): newstr= browsing.val + "." + browselist[num][0]
  145.     else:
  146.         modules= split(browsing.val, ".")
  147.         newstr= ""
  148.         for m in modules[:-1]:
  149.             newstr= newstr+m
  150.     try:
  151.         browsing= Create(newstr)
  152.         make_browselist()
  153.     except:
  154.         browsing= Create('Blender')
  155.         make_browselist()
  156.         
  157.     browse_scrollstart= 0
  158.     scrolling= 0
  159.     selected= -1
  160.  
  161. def make_browselist():
  162.     global browselist
  163.  
  164.     browselist= []
  165.  
  166.     module= eval(browsing.val)
  167.     items= dir(module)
  168.  
  169.     for item_name in items:
  170.         if (item_name[:2]=='__'): continue
  171.  
  172.         data= [item_name, 'None', '', '']
  173.         item= eval(item_name,module.__dict__)
  174.         t= type(item)
  175.  
  176.         if (t==IntType): data[1]= 'Int'; data[2]= `item`
  177.         elif (t==FloatType): data[1]= 'Float'; data[2]= `item`
  178.         elif (t==StringType): data[1]= 'String'
  179.         elif (t==ModuleType): data[1]= 'Module'
  180.         elif (callable(item)):
  181.             data[1]= 'Function'
  182.             doc= item.__doc__
  183.             if (doc): data[3]= doc
  184.  
  185.         if (function_filter and data[1]!='Function'): continue
  186.  
  187.         browselist.append(data)
  188.  
  189. browsing= Create('Blender')
  190. make_browselist()
  191.  
  192. BROWSE_EVT= 1
  193.  
  194. SORT_BYNAME= 2
  195. SORT_BYTYPE= 3
  196. SORT_BYDATA= 4
  197.  
  198. DOC_PAGE_UP= 5
  199. DOC_PAGE_DOWN= 6
  200.  
  201. BACK_MODULE= 7
  202. CLOSE_VIEW= 8
  203. FILTER_DISPLAY= 9
  204.  
  205. #SCROLLBAR= 10
  206.  
  207. VIEW_DOC= 100
  208. BROWSE_MODULE= 20000
  209.  
  210. scr= Create(0)
  211. browse_scrollstart= 0
  212.  
  213. winrect= [0.0, 0.0, 0.0, 0.0]
  214. def draw():
  215.     global browsing, winrect, scr, browse_scrollstart
  216.  
  217.     # Blender doesn't give us direct access to
  218.     # the window size yet, but it does set the
  219.     # GL scissor box for it, so we can get the 
  220.     # size from that.
  221.  
  222.     if (version<173):
  223.         size= Buffer(GL_FLOAT, None, 4)
  224.         glGetFloat(GL_SCISSOR_BOX, size)
  225.         size= BufList(size)
  226.     else:
  227.         size= Buffer(GL_FLOAT, 4)
  228.         glGetFloatv(GL_SCISSOR_BOX, size)
  229.         size= size.list
  230.  
  231.     winrect= size[:]
  232.  
  233.     size[0]= size[1]= 0.0
  234.     
  235.     # Shrink the size to make a nice frame
  236.     # (also a good technique so you can be sure you are clipping things properly)
  237.     size[0], size[1]= int(size[0]+10), int(size[1]+10)
  238.     size[2], size[3]= int(size[2]-12), int(size[3]-10)
  239.  
  240.     glClearColor(0.6, 0.5, 0.3, 0.0)
  241.     glClear(GL_COLOR_BUFFER_BIT)
  242.  
  243.     # The frame
  244.     glColor3f(0.4, 0.5, 0.2)
  245.     glRectf(size[0], size[1], size[2], size[3])
  246.  
  247.     # Window header    
  248.     glColor3f(0.2, 0.2, 0.4)
  249.     glRectf(size[0], size[3]-25, size[2], size[3])
  250.  
  251.     glColor3f(0.6, 0.6, 0.6)
  252.     glRasterPos2f(size[0]+15, size[3]-17)
  253.     Text("Zr's Help Browser")
  254.  
  255.     Button("Filter", FILTER_DISPLAY, size[2]-400, size[3]-22, 45, 18)
  256.     Button("Back", BACK_MODULE, size[2]-300, size[3]-22, 45, 18)
  257.     browsing= String("Browse: ", BROWSE_EVT, size[2]-250, size[3]-22, 245, 18, browsing.val, 30)
  258.  
  259.     # The real table
  260.     def row_draw(rect, data, cols, cell_colors, text_colors):
  261.         if (len(data)!=len(cols)):
  262.             print "Must have same length data and columns"
  263.             return
  264.  
  265.         if (type(cell_colors)!=ListType): cell_colors= [cell_colors]
  266.         if (type(text_colors)!=ListType): text_colors= [text_colors]
  267.  
  268.         sx= rect[0]
  269.         for i in range(len(data)):
  270.             d= data[i]
  271.             c= cols[i]
  272.     
  273.             c, align= c[0], c[1]
  274.  
  275.             if (type(c)==FloatType): c= c*(rect[2]-rect[0])
  276.             ex= sx + c
  277.  
  278.             color= cell_colors[i%len(cell_colors)]
  279.             apply(glColor3f, color)
  280.             glRectf(sx, rect[1], ex, rect[3])
  281.  
  282.             color= text_colors[i%len(text_colors)]
  283.             apply(glColor3f, color)
  284.  
  285.             if (type(d)==StringType):
  286.                 str_width= len(d)*8
  287.                 if (align=='left'): glRasterPos2f(sx+3, rect[1]+5)
  288.                 elif (align=='center'): glRasterPos2f((sx+ex)/2 - str_width/2 +3, rect[1]+5)
  289.                 elif (align=='right'): glRasterPos2f(ex - str_width -3, rect[1]+5)
  290.  
  291.                 Text(d)
  292.             else:
  293.                 d(map(int,[sx, rect[1], ex, rect[3]]))
  294.  
  295.             sx= ex
  296.     # Some colors
  297.     black= (0.0, 0.0, 0.0)
  298.     white= (1.0, 1.0, 1.0)
  299.     red= (0.8, 0.1, 0.1)
  300.  
  301.     gray0= (0.17, 0.17, 0.17)
  302.     gray1= (0.25, 0.25, 0.25)
  303.     gray2= (0.33, 0.33, 0.33)
  304.     gray3= (0.41, 0.41, 0.41)
  305.     gray4= (0.49, 0.49, 0.49)
  306.     gray5= (0.57, 0.57, 0.57)
  307.     gray6= (0.65, 0.65, 0.65)
  308.  
  309.     cols= [[.3, 'left'], [.2, 'left'], [.4, 'right'], [.1, 'center']]
  310.  
  311.     header= [size[0]+20, size[3]-60, size[2]-40, size[3]-40]
  312.  
  313.     def sort_byname(co): Button("Name",SORT_BYNAME, co[0]+3, co[1], co[2]-co[0]-4, 19)
  314.     def sort_bytype(co): Button("Type",SORT_BYTYPE, co[0]+3, co[1], co[2]-co[0]-4, 19)
  315.     def sort_bydata(co): Button("Data",SORT_BYDATA, co[0]+3, co[1], co[2]-co[0]-4, 19)
  316.  
  317.     row_draw(header, [sort_byname, sort_bytype, sort_bydata,'Link'], cols, [gray0, gray1], gray6)
  318.  
  319.     if (selected!=-1):
  320.         table= [size[0]+20, size[1]+220, size[2]-40, size[3]-60]
  321.     else:
  322.         table= [size[0]+20, size[1]+20, size[2]-40, size[3]-60]
  323.  
  324.     row_height= 25
  325.     items= (table[3]-table[1])/row_height
  326.  
  327.     items= 10
  328.     if (items>len(browselist)): items= len(browselist)
  329.  
  330.     end= len(browselist)-items
  331.     #if (end>0):
  332.     #    scr= Scrollbar(SCROLLBAR, table[2]+5, table[1], 20, table[3]-table[1], scr.val, 0.0, end, 0, "Page Up/Down scrolls list.")
  333.  
  334.     row= table
  335.     row[1]= row[3]-row_height
  336.     start= browse_scrollstart
  337.     if (start+items>len(browselist)): items= len(browselist)-start
  338.     for i in range(items):
  339.         i= start+i
  340.         data= browselist[i][:]
  341.  
  342.         if (i%2): colors= [gray1, gray2]
  343.         else: colors= [gray2, gray3]
  344.  
  345.         # Strange pythonic code
  346.         def view_doc(co,num=i):
  347.             Button("Doc",VIEW_DOC+num, co[0]+3, co[1]+2, co[2]-co[0]-4, 19)
  348.  
  349.         def browse_module(co,num=i):
  350.             Button("Browse",BROWSE_MODULE+num, co[0]+3, co[1]+2, co[2]-co[0]-4, 19)
  351.  
  352.         if (data[1]=='Function'):
  353.             if data[3]:
  354.                 data[3]= view_doc
  355.                 tcolor= black
  356.             else:
  357.                 tcolor= red
  358.                 data[2]= 'NO DOC STRING'
  359.                 data[3]= ''
  360.         else:
  361.             if (data[1]=='Module'): data[3]= browse_module
  362.             else: data[3]= ''
  363.  
  364.             tcolor= black
  365.  
  366.         row_draw(row, data, cols, colors, tcolor)
  367.  
  368.         row[1]= row[1]-row_height
  369.         row[3]= row[3]-row_height
  370.  
  371.     if (selected!=-1):
  372.         table= [size[0]+20, size[1]+20, size[2]-40, size[1]+180]
  373.  
  374.         apply(glColor3f, gray5)
  375.         glRectf(table[0], table[3], table[2], table[3]+20)
  376.         apply(glColor3f, gray2)
  377.         glRectf(table[0], table[1], table[2], table[3])
  378.  
  379.         apply(glColor3f, black)
  380.         glRasterPos2f(table[0]+3, table[3]+5)
  381.         Text("Function: " + browsing.val + "." + browselist[selected][0])
  382.  
  383.         Button("Close", CLOSE_VIEW, table[2]-50, table[3], 45, 18)
  384.  
  385.         row_height= 20
  386.         view_lines= int((table[3]-table[1])/row_height)-1
  387.  
  388.         lines= split(browselist[selected][3], "\n")
  389.         doc_lines= len(lines)
  390.  
  391.         sindex= view_lines*selected_page
  392.         eindex= view_lines*(selected_page+1)
  393.         if (sindex>0):
  394.             sindex= sindex-1
  395.             eindex= eindex-1
  396.  
  397.         lines= lines[sindex:eindex]
  398.  
  399.         y= table[3]-20
  400.         for line in lines:
  401.             glRasterPos2f(table[0]+3, y)
  402.             Text(line)
  403.  
  404.             y= y-20
  405.  
  406.         if (sindex): Button("Page up", DOC_PAGE_UP, table[2]-100, table[3]-20, 90, 18)
  407.         if (eindex<doc_lines): Button("Page down", DOC_PAGE_DOWN, table[2]-100, table[1]+5, 90, 18)
  408.  
  409. lmouse= [0, 0]
  410.  
  411. def fit_scroll():
  412.     global browse_scrollstart, browselist
  413.     if (browse_scrollstart<0): browse_scrollstart= 0
  414.     elif (browse_scrollstart>=len(browselist)): browse_scrollstart= len(browselist)-1
  415.  
  416. def event(evt, val):
  417.     global browse_scrollstart
  418.  
  419.     if (evt==QKEY or evt==ESCKEY): Exit()
  420.     elif val:
  421.         if (evt in [PAGEUPKEY, PAGEDOWNKEY]):
  422.             if (evt==PAGEUPKEY): browse_scrollstart= browse_scrollstart-5
  423.             else: browse_scrollstart= browse_scrollstart+5
  424.         elif (evt in [UPARROWKEY, WHEELUPMOUSE]):
  425.             browse_scrollstart -= 1
  426.         elif (evt in [DOWNARROWKEY, WHEELDOWNMOUSE]):
  427.             browse_scrollstart += 1
  428.         else: return
  429.  
  430.         fit_scroll()
  431.         Redraw()
  432.  
  433. def bevent(evt):
  434.     if (evt==BROWSE_EVT): make_browselist()
  435.  
  436.     elif (evt==SORT_BYNAME): sort_browselist(1)
  437.     elif (evt==SORT_BYTYPE): sort_browselist(2)
  438.     elif (evt==SORT_BYDATA): sort_browselist(3)
  439.     
  440.     elif (evt==DOC_PAGE_UP): view_page(-1)
  441.     elif (evt==DOC_PAGE_DOWN): view_page(1)
  442.  
  443.     elif (evt==BACK_MODULE): browse_module(-1)
  444.     elif (evt==CLOSE_VIEW): view_doc(-1)
  445.     elif (evt==FILTER_DISPLAY): toggle_function_filter()
  446.  
  447.     #elif (evt==SCROLLBAR):
  448.     #    global browse_scrollstart
  449.     #    browse_scrollstart= int(scr.val)
  450.  
  451.     elif (evt>=BROWSE_MODULE): browse_module(evt-BROWSE_MODULE)
  452.     elif (evt>=VIEW_DOC): view_doc(evt-VIEW_DOC)    
  453.  
  454.     Redraw()
  455.  
  456. Register(draw, event, bevent)
  457.