Celestin Apprentice 4/Apprentice-Release4.iso/Utilities/Programming/PopupFuncs 2.7/PopupFuncs Notes.c

C/C++ Source or Header | 1995-12-21 | 10.5 KB | 307 lines | [TEXT/R*ch]

/*
PopupFuncs 2.7 Notes
---------- --- -----

December 21, 1995

Because PopupFuncs is so simple to use, this text file constitutes the
documentation for installing and using PopupFuncs. It also contains
up-to-date news and information.

The license agreement for PopupFuncs is at the end of this file. Please
read it before installing and using the software.
*/

#pragma mark What is PopupFuncs?

/*
What is PopupFuncs?
---- -- -----------

PopUpFuncs (“PUF”) is a productivity tool for developers. When invoked
by clicking on a control in a source code window’s title bar, it
creates a popup menu of every function contained in a source code file,
allowing you to see instantly the contents of an unfamiliar file. If a
name is selected from the menu, the file is instantly scrolled to the
beginning of that function. PopUpFuncs works with CodeWarrior, MPW,
THINK C/Symantec C++, SADE, BBEdit, and QUED/M, and parses C, C++,
Pascal, Object Pascal, assembler, Rez, and Fortran source files.

PopUpFuncs is extensible through an XCMD-like protocol. This package
includes a language sensitive block-commenting and uncommenting tool
which operates on the current selection. Hold the command key down
while clicking on a control to get the XPOP menu. This package also
includes the source code to this XPOP, as well as everything you need
to build your own XPOPs.

PopUpFuncs is very fast, highly addictive, and VERY useful.

To install PopUpFuncs, launch the Installer and install PopupFuncs in
your copy of BBEdit, CodeWarrior, MPW, THINK C, THINK Project Manager,
Symantec Project Manager, or QUED/M. Do this now, and you’ll be able to
try out PopUpFuncs on this very file!
*/

#pragma mark Installation

/*
Installation
------------

To install PopupFuncs, launch the “PopupFuncs Installer” application.
For each editor you wish to use PopupFuncs in, click the “Install” button
and select the editor. (The editor must not be running at the time.)

After you have installed PopupFuncs in your editor(s), click the “Quit”
button.
*/

#pragma mark Standard File Hacks

/*
Standard File Hacks
-------- ---- -----

There are some third-party extensions which modify the standard “Open” and
“Save” dialogs (known colloquially as “Standard File”). In a couple of
known cases, some of these extensions have a bug which causes correctly
written applications to crash. Specifically:

-    “Click, there it is!”, version 1.0.1. Version 1.0.4 is current, and
    fixes this problem. Registered owners should contact the author for
    more information.

-    Quickeys version 2.1 also appears to have a similar problem.

If either of these extensions is installed, the PopupFuncs installer will
crash when you click the “Choose...” button.
*/

#pragma mark Supported Editors

/*
Supported Editors
--------- -------

The following text editors (including integrated development environments)
work with PopupFuncs. If you are writing an editor and would like to work
with PopupFuncs, please write to us for information on the PopupFuncs API.

PopupFuncs 2.7 works with the following editors:

    BBEdit 2.5 and later (Bare Bones Software)
    BBEdit Lite 2.3 and later (Bare Bones Software)
    THINK C 5.0 and later (Symantec)
    Symantec C++ 6.0 and later (Symantec)
    CodeWarrior 1.0.1 and later (Metrowerks)
    MPW Shell 3.0 and later (Apple Computer)
    QUED/M 2.7 and later (Nisus Software)

If you are using the “native” MPW Shell, be advised that versions
of the native Shell prior to 3.4b6 are incompatible with PopupFuncs.
The first compatible version of the native MPW Shell is 3.4b6,
which was released as part of the ETO 18 distribution.
*/

#pragma mark Changes from Previous Versions

/*
Changes from Previous Versions
------- ---- -------- --------

Version 2.7:

    -    incorporates rewritten Pascal scanner, with much better support
        for Object Pascal, and generally more reliable operation.

    -    C++ scanner adds support for overloaded operators.

Version 2.6.1:

    -    Incorporates support for CodeWarrior 1.3 (CW7 distribution)

Version 2.6:

    -    incorporates support for MPW Shell 3.4b6 and later

*/

#pragma mark A Note About Technicolor

/*
A Note About Technicolor
- ---- ----- -----------

As a convenience, PopupFuncs 2.7 provides a facility for installing
Chris Thomas' "Technicolor" utility. Technicolor is a tool for providing
syntax-directed text coloring in environments that don't otherwise offer
such a capability. In addition to installation from the PopupFuncs
installer, the standard PopupFuncs distribution includes the latest
version (0.9, as of this writing) of Technicolor.

Technicolor is not a product of Bare Bones Software, and we cannot
support it. Please direct questions regarding Technicolor to Chris
Thomas <[e-mail]>.

*/

#pragma mark Using PopupFuncs

/*
Using PopupFuncs
----- ----------

PopupFuncs will place a pair of red dots in the title bar of any window that
it believes contains a source file. To pop up a menu of functions in your
source file, click either of the red dots. To sort the menu items by name,
hold down the Shift key when clicking. To show the available PopupFuncs
extensions, hold down the Command key when clicking.

In Rez source files, PopupFuncs will list defined resources. In C and C++
source files, PopupFuncs will show types in addition to functions.
*/

#pragma mark Customizing PopupFuncs

/*
Customizing PopupFuncs
----------- ----------

PopupFuncs includes a number of special-purpose resources, which can be
edited to customize the behavior of PopupFuncs. These resources, along
with a ‘TMPL’ resource, are included in the PopupFuncs installer. If
you change these resources in the PopupFuncs installer, the changes
will be carried along with subsequent installations of PopupFuncs.

The resources have a type of ‘puf!’, and the standard ones are as follows:

‘puf!’ 128 is a list of language-to-suffix mappings. The language code
is zero-based, and progresses as follows:

    none = 0;
    C = 1;
    C++ = 2;
    Pascal = 3;
    Object Pascal = 4;
    Rez = 5;
    68K assembler = 6;
    Fortran = 7;

You can edit the suffix mappings to add your own custom suffixes.

‘puf!’ 129 is used to configure the 68K assembly-language parser. Each
entry in this resource is a pair of label/operand pairs:

    0   - mark the label , major. (e.g. PROC,FUNC)
    1   - mark the label, minor
    2   - mark the parameter, major. Useful for macros whose first parameter
            is the real function name.
    3    - mark the label, local, with a † next to it (e.g. RECORD)
*/

#pragma mark Problems?

/*
Problems?
---------

If you find that PopUpFuncs has difficulty with a particular source file,
please send us a copy of your file. If the source file contains sensitive
content, use the “Source Masher” utility to generate a copy of the source
file without the sensitive information.
*/

#pragma mark Thanks!

/*
Thanks!
-------

Thank you for using PopupFuncs; we appreciate your support. If you
have questions or problems, we encourage you to write, call, or send
e-mail. (E-mail is the recommended way to contact us; we can reply very
quickly, and it conserves paper.)

Bare Bones Software, Inc.
P.O. Box 108
Bedford, MA 01730
[phone] phone
[phone] fax
[e-mail] [internet]
http://www.tiac.net/biz/bbsw/ [World Wide Web]
*/

#pragma mark Legalese

/*
License Agreement
------- ---------

You, the Licensee, assume responsibility for the selection of the
program PopupFuncs to achieve your intended results, and for the
installation, use, and results obtained from the program.  installing
and using the program constitutes your acceptance of these terms and
conditions.  If you do not accept these terms and conditions, then do
not install or use the software.

License
-------

You may use the program on a single machine and copy the program into
any machine-readable or printed form for backup or support of your use
of the program on the single machine, provided that no more than one
copy of the program may be used on a single machine by more than one
user at a time. You may distribute copies of the program to other
individuals for non-commercial purposes, but may not sell, license, or
include the program as part of a commercial distribution or compilation
without express written permission of Bare Bones Software, Inc.

Limited warranty and limitation of remedies
------- -------- --- ---------- -- --------

The program and any support from Bare Bones Software, Inc., are provided
“as is” and without warranty , express and implied, including but not
limited to any implied warranties of merchantability and fitness for a
particular purpose.  In no event will Bare Bones Software, Inc. be
liable for any damages, including lost profits, lost savings, or other
incidental or consequential damages, even if Bare Bones Software, Inc.
is advised of the possibility of such damages, or for any claim by you
or any third party.

General Terms
------- -----

This Agreement can only be modified by a written agreement signed by you
and Bare Bones Software, Inc., and changes from the terms and conditions
of this Agreement made in any other manner will be of no effect.  If any
portion of this Agreement shall be held invalid, illegal, or
unenforceable, the validity, legality, and enforceability of the
remainder of the Agreement shall not in any way be affected or impaired
thereby.  This Agreement shall be governed by the laws of The
Commonwealth of Massachusetts, without giving effect to conflict of laws
provisions thereof.  As required by United States export regulations,
you shall not permit export of the program or any direct products
thereof to any country to which export is then controlled by the United
States Office of Export Administration, unless you have that agency’s
prior written approval.

Use, duplication and disclosure by the United States Government of the
program or any part thereof is subject to restrictions as set forth in
subdivision (g)(3) of Rights in Data - General Clause in Federal
Acquisition Regulations (“FAR”) 52.227.14, the Commercial Computer
Software - Restricted Rights Clause in FAR 52.227.19. and/or subdivision
c(1)(ii) of Rights in Technical Data and Computer Software Clause in
Department of Defense FAR 252.227.7013.

Acknowledgment
--------------

You acknowledge that you have read this agreement, understand it, and
agree to be bound by its terms and conditions.  You further agree that
it is the complete and exclusive statement of the agreement between you
and Bare Bones Software, Inc. which supersedes all proposals or prior
agreements, oral or written, and all other communications between you
and Bare Bones Software, Inc. relating to the subject matter of this
agreement.
*/