home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 February: Tool Chest / Dev.CD Feb 99 TC.toast / Tool Chest / Developer Utilities / PopupFuncs 2.6.1 / PopupFuncs Notes.c < prev    next >
Encoding:
C/C++ Source or Header  |  1995-09-29  |  10.2 KB  |  286 lines  |  [TEXT/R*ch]
  1. /*
  2. PopupFuncs 2.6 Notes
  3. ---------- --- -----
  4.  
  5. September 27, 1995
  6.  
  7. Because PopupFuncs is so simple to use, this text file constitutes the
  8. documentation for installing and using PopupFuncs. It also contains
  9. up-to-date news and information.
  10. */
  11.  
  12. #pragma mark PopupFuncs 2.6 is Freeware!!
  13.  
  14. /*
  15. As of version 2.6, PopupFuncs is now freeware! There is no registration
  16. process, no fee requested or required, no obligation on your part, and
  17. no guilt.
  18.  
  19. However, PopupFuncs remains a copyrighted product of Bare Bones
  20. Software, Inc., with all rights reserved. Redistribution for any
  21. commercial purpose without the express written permission of Bare Bones
  22. Software, Inc. is prohibited. Please read the PopupFuncs license
  23. agreement, which is included at the end of this file, before installing
  24. and using the software. Questions regarding the license terms should be
  25. directed only to Bare Bones Software, Inc. 
  26. */
  27.  
  28. #pragma mark What is PopupFuncs?
  29.  
  30. /*
  31. What is PopupFuncs?
  32. ---- -- -----------
  33.  
  34. PopUpFuncs ("PUF") is a productivity tool for developers. When invoked
  35. by clicking on a control in a source code window's title bar, it
  36. creates a popup menu of every function contained in a source code file,
  37. allowing you to see instantly the contents of an unfamiliar file. If a
  38. name is selected from the menu, the file is instantly scrolled to the
  39. beginning of that function. PopUpFuncs works with CodeWarrior, MPW,
  40. THINK C/Symantec C++, SADE, BBEdit, and QUED/M, and parses C, C++,
  41. Pascal, Object Pascal, assembler, Rez, and Fortran source files.
  42.  
  43. PopUpFuncs is extensible through an XCMD-like protocol. This package
  44. includes a language sensitive block-commenting and uncommenting tool
  45. which operates on the current selection. Hold the command key down
  46. while clicking on a control to get the XPOP menu. This package also
  47. includes the source code to this XPOP, as well as everything you need
  48. to build your own XPOPs.
  49.  
  50. PopUpFuncs is very fast, highly addictive, and VERY useful.
  51.  
  52. To install PopUpFuncs, launch the Installer and install PopupFuncs in
  53. your copy of BBEdit, CodeWarrior, MPW, THINK C, THINK Project Manager,
  54. Symantec Project Manager, or QUED/M. Do this now, and you'll be able to
  55. try out PopUpFuncs on this very file!
  56. */
  57.  
  58. #pragma mark Installation
  59.  
  60. /*
  61. Installation
  62. ------------
  63.  
  64. To install PopupFuncs, launch the "PopupFuncs Installer" application.
  65. For each editor you wish to use PopupFuncs in, click the "Install" button
  66. and select the editor. (The editor must not be running at the time.)
  67.  
  68. After you have installed PopupFuncs in your editor(s), click the "Quit"
  69. button.
  70. */
  71.  
  72. #pragma mark Standard File Hacks
  73.  
  74. /*
  75. Standard File Hacks
  76. -------- ---- -----
  77.  
  78. There are some third-party extensions which modify the standard "Open" and
  79. "Save" dialogs (known colloquially as "Standard File"). In a couple of
  80. known cases, some of these extensions have a bug which causes correctly
  81. written applications to crash. Specifically:
  82.  
  83. -    "Click, there it is!", version 1.0.1. Version 1.0.4 is current, and
  84.     fixes this problem. Registered owners should contact the author for
  85.     more information.
  86.     
  87. -    Quickeys version 2.1 also appears to have a similar problem.
  88.  
  89. If either of these extensions is installed, the PopupFuncs installer will
  90. crash when you click the "Choose..." button.
  91. */
  92.  
  93. #pragma mark Supported Editors
  94.  
  95. /*
  96. Supported Editors
  97. --------- -------
  98.  
  99. The following text editors (including integrated development environments)
  100. work with PopupFuncs. If you are writing an editor and would like to work
  101. with PopupFuncs, please write to us for information on the PopupFuncs API.
  102.  
  103. PopupFuncs 2.6 works with the following editors:
  104.  
  105.     BBEdit 2.5 and later (Bare Bones Software)
  106.     BBEdit Lite 2.3 and later (Bare Bones Software)
  107.     THINK C 5.0 and later (Symantec)
  108.     Symantec C++ 6.0 and later (Symantec)
  109.     CodeWarrior 1.0.1 and later (Metrowerks)
  110.     MPW Shell 3.0 and later (Apple Computer)
  111.     QUED/M 2.7 and later (Nisus Software)
  112.  
  113. If you are using the "native" MPW Shell, be advised that versions
  114. of the native Shell prior to 3.4b6 are incompatible with PopupFuncs.
  115. The first compatible version of the native MPW Shell is 3.4b6,
  116. which was released as part of the ETO 18 distribution.
  117. */
  118.  
  119. #pragma mark Using PopupFuncs
  120.  
  121. /*
  122. Using PopupFuncs
  123. ----- ----------
  124.  
  125. PopupFuncs will place a pair of red dots in the title bar of any window that
  126. it believes contains a source file. To pop up a menu of functions in your
  127. source file, click either of the red dots. To sort the menu items by name,
  128. hold down the Shift key when clicking. To show the available PopupFuncs
  129. extensions, hold down the Command key when clicking.
  130.  
  131. In Rez source files, PopupFuncs will list defined resources. In C and C++
  132. source files, PopupFuncs will show types in addition to functions.
  133. */
  134.  
  135. #pragma mark Customizing PopupFuncs
  136.  
  137. /*
  138. Customizing PopupFuncs
  139. ----------- ----------
  140.  
  141. PopupFuncs includes a number of special-purpose resources, which can be
  142. edited to customize the behavior of PopupFuncs. These resources, along 
  143. with a 'TMPL' resource, are included in the PopupFuncs installer. If
  144. you change these resources in the PopupFuncs installer, the changes
  145. will be carried along with subsequent installations of PopupFuncs.
  146.  
  147. The resources have a type of 'puf!', and the standard ones are as follows:
  148.  
  149. 'puf!' 128 is a list of language-to-suffix mappings. The language code
  150. is zero-based, and progresses as follows:
  151.  
  152.     none = 0;
  153.     C = 1;
  154.     C++ = 2;
  155.     Pascal = 3;
  156.     Object Pascal = 4;
  157.     Rez = 5;
  158.     68K assembler = 6;
  159.     Fortran = 7;
  160.     
  161. You can edit the suffix mappings to add your own custom suffixes.
  162.  
  163. 'puf!' 129 is used to configure the 68K assembly-language parser. Each
  164. entry in this resource is a pair of label/operand pairs:
  165.  
  166.     0   - mark the label , major. (e.g. PROC,FUNC)
  167.     1   - mark the label, minor 
  168.     2   - mark the parameter, major. Useful for macros whose first parameter 
  169.             is the real function name.
  170.     3    - mark the label, local, with a * next to it (e.g. RECORD)
  171. */
  172.  
  173. #pragma mark Problems?
  174.  
  175. /*
  176. Problems?
  177. ---------
  178.  
  179. If you find that PopUpFuncs has difficulty with a particular source file,
  180. please send us a copy of your file. If the source file contains sensitive
  181. content, use the "Source Masher" utility to generate a copy of the source
  182. file without the sensitive information.
  183. */
  184.  
  185. #pragma mark Thanks!
  186.  
  187. /*
  188. Thanks!
  189. -------
  190.  
  191. Thank you for using PopupFuncs; we appreciate your support. If you have
  192. any questions regarding PUF or any of our other programs, we encourage
  193. to you contact us. Please note that we can only address technical
  194. support questions on PUF which are submitted via electronic mail. We
  195. also strongly recommend that you use email for any and all other
  196. questions. Not only does it save paper and time, but you will ordinarily
  197. receive a response within hours of receipt of your message. You can
  198. contact us as follows:
  199.  
  200. Postal:        Bare Bones Software, Inc.
  201.             P.O. Box 108
  202.             Bedford, MA  01730-0108
  203.  
  204. Phone:      +1 508 651 3561
  205. Fax:        +1 508 651 7584
  206.  
  207. WWW:          http://www.tiac.net/biz/bbsw/
  208. Internet:      bbsw@netcom.com
  209. CIS:        73051,3255
  210. eWorld:        BareBones
  211. */
  212.  
  213. #pragma mark Legalese
  214.  
  215. /*
  216. License Agreement                                                        
  217. ------- ---------
  218.  
  219. You, the Licensee, assume responsibility for the selection of the
  220. program PopupFuncs to achieve your intended results, and for the
  221. installation, use, and results obtained from the program.  installing
  222. and using the program constitutes your acceptance of these terms and
  223. conditions.  If you do not accept these terms and conditions, then do
  224. not install or use the software.
  225.  
  226. License
  227. -------
  228.  
  229. You may use the program on a single machine and copy the program into
  230. any machine-readable or printed form for backup or support of your use
  231. of the program on the single machine, provided that no more than one
  232. copy of the program may be used on a single machine by more than one
  233. user at a time. You may distribute copies of the program to other
  234. individuals for non-commercial purposes, but may not sell, license, or
  235. include the program as part of a commercial distribution or compilation
  236. without express written permission of Bare Bones Software, Inc.
  237.  
  238. Limited warranty and limitation of remedies
  239. ------- -------- --- ---------- -- --------
  240.  
  241. The program and any support from Bare Bones Software, Inc., are provided
  242. "as is" and without warranty , express and implied, including but not
  243. limited to any implied warranties of merchantability and fitness for a
  244. particular purpose.  In no event will Bare Bones Software, Inc. be
  245. liable for any damages, including lost profits, lost savings, or other
  246. incidental or consequential damages, even if Bare Bones Software, Inc.
  247. is advised of the possibility of such damages, or for any claim by you
  248. or any third party.  
  249.  
  250. General Terms
  251. ------- -----
  252.  
  253. This Agreement can only be modified by a written agreement signed by you
  254. and Bare Bones Software, Inc., and changes from the terms and conditions
  255. of this Agreement made in any other manner will be of no effect.  If any
  256. portion of this Agreement shall be held invalid, illegal, or
  257. unenforceable, the validity, legality, and enforceability of the
  258. remainder of the Agreement shall not in any way be affected or impaired
  259. thereby.  This Agreement shall be governed by the laws of The
  260. Commonwealth of Massachusetts, without giving effect to conflict of laws
  261. provisions thereof.  As required by United States export regulations,
  262. you shall not permit export of the program or any direct products
  263. thereof to any country to which export is then controlled by the United
  264. States Office of Export Administration, unless you have that agency's
  265. prior written approval.
  266.  
  267. Use, duplication and disclosure by the United States Government of the
  268. program or any part thereof is subject to restrictions as set forth in
  269. subdivision (g)(3) of Rights in Data - General Clause in Federal
  270. Acquisition Regulations ("FAR") 52.227.14, the Commercial Computer
  271. Software - Restricted Rights Clause in FAR 52.227.19. and/or subdivision
  272. c(1)(ii) of Rights in Technical Data and Computer Software Clause in
  273. Department of Defense FAR 252.227.7013.
  274.  
  275. Acknowledgment
  276. --------------
  277.  
  278. You acknowledge that you have read this agreement, understand it, and
  279. agree to be bound by its terms and conditions.  You further agree that
  280. it is the complete and exclusive statement of the agreement between you
  281. and Bare Bones Software, Inc. which supersedes all proposals or prior
  282. agreements, oral or written, and all other communications between you
  283. and Bare Bones Software, Inc. relating to the subject matter of this
  284. agreement.
  285. */
  286.