Sample Data Here are a few segments from an ascii document that was generated from the source code for the tk part of tcl/tk (see the following copyright notice). Examples of file, function, variable, and type entries have been included. ------------------------------------------------------------- tkBitmap.c category: c_file path: /files4/src/tcl/3.6/tk3.6/tkBitmap.c size: 557 lines owner: john mod date: Wed Jan 17 12:29:51 PST 1996 Comments /* * tkBitmap.c -- * * This file maintains a database of read-only bitmaps for the Tk * toolkit. This allows bitmaps to be shared between widgets and * also avoids interactions with the X server. * * Copyright (c) 1990-1993 The Regents of the University of California. * All rights reserved. * * Permission is hereby granted, without written agreement and without * license or royalty fees, to use, copy, modify, and distribute this * software and its documentation for any purpose, provided that the * above copyright notice and the following two paragraphs appear in * all copies of this software. * * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF * CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS * ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. */ Usage Dependencies Includes error gray25 gray50 hourglass info questhead question tk.h tkConfig.h warning Program Elements Functions BitmapInit defined static 37 lines Tk_DefineBitmap defined global 29 lines Tk_FreeBitmap defined global 28 lines Tk_GetBitmap defined global 95 lines Tk_GetBitmapFromData defined global 36 lines Tk_NameOfBitmap defined global 23 lines Tk_SizeOfBitmap defined global 26 lines Variables autoNumber defined static bitmap defined TkBitmap (public) dataTable defined static display defined IdKey (public) display defined NameKey (public) display defined TkBitmap (public) hashPtr defined TkBitmap (public) height defined DataKey (public) height defined PredefBitmap (public) height defined TkBitmap (public) idTable defined static initialized defined static name defined NameKey (public) nameTable defined static pixmap defined IdKey (public) predefTable defined static refCount defined TkBitmap (public) source defined DataKey (public) source defined PredefBitmap (public) width defined DataKey (public) width defined PredefBitmap (public) width defined TkBitmap (public) Types DataKey defined IdKey defined NameKey defined PredefBitmap defined TkBitmap defined ------------------------------------------------------------- Tk_GetBitmap category: function scope: global kind: with-body Location file: /files4/src/tcl/3.6/tk3.6/tkBitmap.c line: 155 - 249 (95 lines) owner: john mod date: Wed Jan 17 12:29:51 PST 1996 Declaration Pixmap Tk_GetBitmap(interp, tkwin, string) Tcl_Interp *interp; /* Interpreter to use for error reporting. */ Tk_Window tkwin; /* Window in which bitmap will be used. */ Tk_Uid string; /* Description of bitmap. See manual entry * for details on legal syntax. */ Comments /* *---------------------------------------------------------------------- * * Tk_GetBitmap -- * * Given a string describing a bitmap, locate (or create if necessary) * a bitmap that fits the description. * * Results: * The return value is the X identifer for the desired bitmap * (i.e. a Pixmap with a single plane), unless string couldn't be * parsed correctly. In this case, None is returned and an error * message is left in interp->result. The caller should never * modify the bitmap that is returned, and should eventually call * Tk_FreeBitmap when the bitmap is no longer needed. * * Side effects: * The bitmap is added to an internal database with a reference count. * For each call to this procedure, there should eventually be a call * to Tk_FreeBitmap, so that the database can be cleaned up when bitmaps * aren't needed anymore. * *---------------------------------------------------------------------- */ Usage CalledBy ConfigureButton tkButton.c 799 : butPtr->gray = Tk_GetBitmap(interp, butPtr->tkwin, ConfigureMenu tkMenu.c 1096 : menuPtr->gray = Tk_GetBitmap(interp, menuPtr->tkwin, ConfigureMenuButton tkMenubutton.c 580 : mbPtr->gray = Tk_GetBitmap(interp, mbPtr->tkwin, DoConfig tkConfig.c 442 : new = Tk_GetBitmap(interp, tkwin, uid); Tk_Get3DBorder tk3d.c 245 : borderPtr->shadow = Tk_GetBitmap(interp, tkwin, Tk_GetBitmapFromData tkBitmap.c 501 : return Tk_GetBitmap(interp, tkwin, name); Tk_WmCmd tkWm.c 997 : pixmap = Tk_GetBitmap(interp, tkwin, Tk_GetUid(argv[3])); 1062 : pixmap = Tk_GetBitmap(interp, tkwin, Tk_GetUid(argv[3])); Dependencies Calls BitmapInit tkBitmap.c (line 521) Tcl_AppendResult Tcl_CreateHashEntry tcl.h (line 448) Tcl_DStringFree Tcl_DeleteHashEntry Tcl_FindHashEntry tcl.h (line 446) Tcl_GetHashValue tcl.h (line 435) Tcl_SetHashValue tcl.h (line 436) Tcl_TildeSubst Tk_Display tk.h (line 305) Tk_Screen tk.h (line 307) Tk_ScreenNumber tk.h (line 306) XCreateBitmapFromData XReadBitmapFile ckalloc tcl.h (line 315) malloc panic HasType ClientData tcl.h (line 95) IdKey tkBitmap.c (line 87) NameKey tkBitmap.c (line 76) PredefBitmap* Tcl_DString tcl.h (line 215) Tcl_HashEntry* Tcl_Interp* TkBitmap tkBitmap.c (line 64) TkBitmap* Tk_FakeWin* Tk_Uid tk.h (line 61) Tk_Window tk.h (line 53) char* int unsigned-int Sets bitmap tkBitmap.c (line 56) clientData tcl.h (line 361) display tkBitmap.c (line 75) display tkBitmap.c (line 60) display tkBitmap.c (line 85) hashPtr tkBitmap.c (line 62) height tkBitmap.c (line 59) name tkBitmap.c (line 74) pixmap tkBitmap.c (line 86) refCount tkBitmap.c (line 61) width tkBitmap.c (line 59) Reads bitmap tkBitmap.c (line 56) clientData tcl.h (line 361) display tk.h (line 345) display tkBitmap.c (line 75) height tkBitmap.c (line 96) initialized tkBitmap.c (line 120) refCount tkBitmap.c (line 61) screenNum tk.h (line 347) source tkBitmap.c (line 95) width tkBitmap.c (line 96) ------------------------------------------------------------- bitmap category: variable scope: TkBitmap (public) Location file: /files4/src/tcl/3.6/tk3.6/tkBitmap.c line: 56 owner: john mod date: Wed Jan 17 12:29:51 PST 1996 Declaration Pixmap bitmap; /* X identifier for bitmap. None means this Usage SetBy Tk_GetBitmap tkBitmap.c 229 : bitmapPtr->bitmap = bitmap; ReadBy Tk_FreeBitmap tkBitmap.c 432 : XFreePixmap(bitmapPtr->display, bitmapPtr->bitmap); Tk_GetBitmap tkBitmap.c 181 : return bitmapPtr->bitmap; 244 : return bitmapPtr->bitmap; ContainedIn TkBitmap tkBitmap.c (line 64) ------------------------------------------------------------- TkBitmap category: struct Location file: /files4/src/tcl/3.6/tk3.6/tkBitmap.c line: 64 owner: john mod date: Wed Jan 17 12:29:51 PST 1996 Declaration } TkBitmap; Usage UsedBy TkBitmap* Tk_GetBitmap tkBitmap.c (line 155) Dependencies Contains bitmap tkBitmap.c (line 56) display tkBitmap.c (line 60) hashPtr tkBitmap.c (line 62) height tkBitmap.c (line 59) refCount tkBitmap.c (line 61) width tkBitmap.c (line 59)