home *** CD-ROM | disk | FTP | other *** search
/ Boston 2 / boston-2.iso / DOS / PROGRAM / CLIPPER / SLSW / SUPER.DOC < prev    next >
Text File  |  1993-12-01  |  13KB  |  286 lines
  1.                                  SUPER.LIB
  2.                             Super.Lib Standard
  3.                         for Clipper Summer 87, 5.0
  4.                           Version 1.51 (June 1990)
  5.  
  6.                       G E N E R A L    R E F E R E N C E
  7.  
  8.  
  9.            * see SUPER.FUN, SUPER_C.FUN for function list and usage
  10.            * see ORDER.DOC for ordering information
  11.            * see TODATE.DOC for chronological list of changes
  12.  
  13.       Super.Lib Library copyright (C) 1989,1990 by Garry Prefontaine.
  14.       All rights reserved.
  15.  
  16.       Specifications subject to change without notice.
  17.  
  18.       ------------------------ Introduction -----------------------------
  19.  
  20.       Super.Lib Library is a collection of Clipper Functions specifically
  21.       for handling data. They were designed with the following (optimistic)
  22.       guidelines:
  23.  
  24.         1. Ease of use. Keep parameters to a minimum, and optional.
  25.         2. Data independance. Work with any datafile, anywhere, anytime.
  26.         3. Clean, attractive menu driven interface to the job at hand.
  27.         4. Drop-in to existing applications, requiring little or no setup.
  28.         5. Require no change in programming style by the user.
  29.         6. Leave things as found (colors, screens, etc)
  30.         7. Variable declared PRIVATE unless PUBLIC
  31.         8. Memory variables prefaced with 'm->' to avoid field conflicts
  32.  
  33.       They don't necessarily succeed in all of these things, but nobody's
  34.       perfect.
  35.  
  36.       The library was built from the top down, starting with the major
  37.       functions and adding building block functions commonly shared by
  38.       the major functions. It has a particular scope and theme into which
  39.       most of the functions fall, and functions have not just been included
  40.       to boost a function count.
  41.  
  42.       The library does not even attempt to be all things to all people.
  43.       The most I could hope for is that it provides 'some solutions for
  44.       some people', or at least 'some partial solutions for some people'.
  45.  
  46.       The best way to get to know the library, is to compile, link and
  47.       study the file SF.PRG.  SF is an all-purpose datafile handler that
  48.       will do everything from Create/Modify structure to Browsing a file
  49.       to Querying and Printing a file. SF.PRG makes use of most of the
  50.       metafunctions, and should give a pretty good idea of their scope.
  51.  
  52.  
  53.       ------------------------ License ----------------------------------------
  54.  
  55.       You are granted the right to use this program on a trial basis for
  56.       as long as you like.
  57.  
  58.       Registration is required prior to use of Super.Lib Library in
  59.       distributed executable programs.
  60.  
  61.       Super.Lib Library may not be incorporated into other Libraries.
  62.  
  63.       I encourage you to upload the shareware version of the library to
  64.       bulletin boards you frequent, as long as the full shareware version
  65.       and all shareware files are uploaded.
  66.  
  67.  
  68.       ------------------------ Registration -----------------------------------
  69.  
  70.       See ORDER.DOC for ordering details.
  71.  
  72.       Registration entitles you to a full Clipper/C/ASM source code for
  73.       Norton Guide datafile, 24 hour Super.Lib Support BBS access ,
  74.       notification of additional Super.Lib products when available,
  75.       and use of the library in distributed executable applications royalty
  76.       free.
  77.  
  78.       Registration does not entitle you to distribute, sell or even give
  79.       away the library itself ,the source code, portions of the
  80.       library or source code, or modified copies of the library or
  81.       source code. You may not use the library to create another
  82.       library which you then distribute, for profit or not.
  83.       In short, any portion of the library going FROM you TO anyone else
  84.       must be in compiled executable format (.EXE), and may not be in
  85.       source code or object format.
  86.  
  87.       --------------------Super.Lib Professional-----------------------------
  88.  
  89.       Super.lib Professional, a new product from Functional Software
  90.       is now available. This is a commercial product, and is not
  91.       available as shareware.
  92.  
  93.       Most of the Metafunctions  have been enhanced considerably, and
  94.       numerous NEW functions have been added, both small and large.
  95.  
  96.       Some of my favorite enhancements:
  97.  
  98.       BUILDEX point and shoot expression builder. Build expressions
  99.       like left(FNAME+LNAME,30)+','+MI.  With hooks into QUERY, BLDNDX
  100.       (index builder) and Super Report Writer.
  101.  
  102.       VIEWPORT data entry engine. Pass arrays for fields, field
  103.       descriptions, pictures, valids, lookups, display/edit. Multiple
  104.       movement,search,view and editing options. Goes far beyond the
  105.       DOITALL function in Superfunction Standard. End users love it!
  106.  
  107.       QUERY now handles: memo fields, complex expressions (BUILDEX),
  108.       spaces as comparison values, wildcard matching, startswith,
  109.       endswith and does not contain operators.
  110.  
  111.       PRNPORT allows user to select printer port. Hooked into the
  112.       form letters, labels, listing and other Superfunction routines
  113.       that output to the printer.
  114.  
  115.       TODOLIST, scroll a subset of a DBF with SMALLS, SEARCHME mini
  116.       query, BLDNDX complex index builder, FREQANAL frequency
  117.       analysis, TIMEPER time-sensitive DBF analysis, APPENDIT intelligent
  118.       APPEND FROM replacement ,POPUP CALCULATOR and CALENDER, delete and
  119.       pack system DBFs (queries, forms) with PURGEM, many new DATE and
  120.       STRING functions, no calls to Clipper internals, Blinker-able,
  121.       Clipper 5.0 compatible.
  122.  
  123.       Attention has also been paid to date sensitive operations, and
  124.       all date formats (ANSI-GERMAN-FRENCH-BRITISH-ITALIAN-AMERICAN)
  125.       are supported.
  126.  
  127.       REPORTER. The Super Report Writer is a column based, 100% Clipper
  128.       code, linkable Report Writer intended as a CREATE REPORT replacement
  129.       and superset.
  130.  
  131.         - saves report definitions to a DBF file.
  132.         - up to 34 columns as field names or complex expressions.
  133.         - user definable column widths, column titles, column separator
  134.           characters, line separator characters, totals underline
  135.           characters , picture, page dimensions and others
  136.         - Major and Minor groups, subtotals, totals and grand totals
  137.         - full or summary report
  138.         - print against QUERY or TAGGED records
  139.         - free form headers and footers 1-9 lines
  140.         - print to printer or file, pause during printing, restart
  141.           from page #
  142.  
  143.       and finally, the library comes with...
  144.       100+ page printed manual, upgrade guide for 1.50 users, Norton
  145.       Guide database, 1 year support, 24 hour BBS access, and ... FULL
  146.       SOURCE CODE!!
  147.  
  148.       See ORDER.DOC for ordering details.
  149.  
  150.  
  151.       ------------------------ Disclaimer -------------------------------------
  152.      
  153.       Functional Software distributes these functions solely on an "as is"
  154.       basis and offers no warranties at all.
  155.  
  156.       Functional Software shall not bear any liability or responsibility to
  157.       any user or entity with respect to any liability, loss or
  158.       damage caused, or alleged to be caused directly, or indirectly
  159.       by the functions contained in this product, including but not
  160.       limited to interruption of services, loss of business or
  161.       anticipatory profits or consequential damages resulting from
  162.       the use or operation of any of the functions contained in this
  163.       product.
  164.  
  165.       Functional Software makes no warranties, either expressed or implied
  166.       regarding this software product, it's merchantibility and/or
  167.       it's fitness for a particular purpose. The user agrees that
  168.       Functional Software shall not be held liable for any consequential
  169.       damages, even if Functional Software has been advised of the possibility
  170.       of such damages.
  171.  
  172.       By using any of the functions contained in this library, you
  173.       acknowledge your agreement with all of the above conditions.
  174.  
  175.       ------------------- Linking Super.Lib Library ---------------------
  176.  
  177.       Where <program> refers to your OBJ file(s) ,<other libs>
  178.       refers to other Libraries you may wish to use, and
  179.  
  180.       Turbo Link (Tlink) :
  181.       TLINK <program>,,,clipper + extend + <other libs> +  super
  182.  
  183.       Microsoft Link    :
  184.       LINK <program>,,,clipper,extend,<other libs>,super /NOE /SE:512
  185.  
  186.       Plink86           :
  187.       PLINK86 fi <program> lib clipper,<other libs>,super,extend
  188.  
  189.       BLINKER           :
  190.       BLINKER fi %1 lib super,clipper,extend
  191.  
  192.       Only those functions actually called by your prg - and any they call -
  193.       will be included in your EXE. The metafunctions will  be big - usually
  194.       5-10K.
  195.  
  196.      --------------Video Compatibility -----------------------------------
  197.  
  198.      Super.Lib Library uses a few direct video routines,
  199.      for fast screen writing. As such, it will only work with IBM (tm)
  200.      PC compatible computers. It has been tested on Mono, CGA and
  201.      EGA adaptors, although some CGA adaptors will display 'snow'.
  202.  
  203.      -------------------- Colors scheme for this library -------------------
  204.  
  205.       This is not the perfect color scheme. It is the one this library runs
  206.       on. Several global color variables are used by the functions. These are:
  207.  
  208.                 c_normcol       -       For normal input/output
  209.                 c_normmenu      -       For normal 'menu to' operations
  210.                 c_popcol        -       For popup box colors
  211.                 c_popmenu       -       For popup box menus
  212.                 c_frame         -       Frame string ("┌─┐│┘─└│ ")
  213.                 c_shadatt       -       Shadow color attribute (numeric)
  214.                 c_shadpos       -       Shadow position (0,1,3,7,9)
  215.                 c_xplode        -       Logical - explode windows?
  216.  
  217.       All are of the format "f/b,f/b,,,f/b"  (f-foreground b-background)
  218.  
  219.       The function INITCOL() will set these colors, and is called if they
  220.       have not already been set.The function INITSUP() is used to initialize
  221.       everything needed by the Library. Initsup() calls initcol() if needed.
  222.  
  223.       The function SETCOLORS() allows interactive setting of these colors.
  224.       The variables are stored in COLORS.MEM - which is created if needed.
  225.       If COLORS.MEM is not present, default colors are used.
  226.  
  227.        ------- Calling Super.Lib with related files -------------
  228.  
  229.        Many of the Super.Lib functions will work with a many-to-one relation.
  230.        When passing the array of field names, place the child fields in
  231.        the array as "alias->field"
  232.  
  233.        i.e.
  234.                declare customer[10]
  235.                customer[1]="LNAME"
  236.                customer[2]="FNAME"
  237.                ....
  238.                ....
  239.                customer[9]="AGENT->AGENTNAME"
  240.                customer[10]="AGENT->ADDRESS"
  241.  
  242.        query(), lister(), doitall(),lookfld(),formletr(),smalls() are some
  243.        of the functions which allow this.
  244.  
  245.        One-to-many relations are not supported.
  246.  
  247.       ------------------- Multiuser ---------------------------------------
  248.  
  249.       The library has NOT been tested under a multiuser environment, and no
  250.       attention has been paid to this aspect. I do not expect to have such an
  251.       environment set up any time real soon, and so do not expect this library
  252.       to be multiuser any time real soon.
  253.  
  254.       ------------------- CLIPPER 5.0--------------------------------------
  255.  
  256.       Super.Lib is now compatible with Clipper 5.0 (pre-release 06-29-1990)
  257.       As of this writing, there are a few incompatibilities between
  258.       Clipper S87 and Clipper 5.0. I've worked around these known
  259.       incompatibilities. The .PRGs will compile and link with 5.0 and
  260.       RTLINK. The .EXEs will run. My intention at present is to keep
  261.       the library compatible with both Summer 87 and 5.0 versions of
  262.       Clipper.
  263.  
  264.       Note: It is necessary to re-compile the source code with Clipper 5.0
  265.       in order for the library to work with Clipper 5.0.
  266.  
  267.       --------------------- Trademarks --------------------------------------
  268.      
  269.       PLINK86 & PLINK86plus are Trademarks of Phoenix Technologies, Ltd.
  270.       Turbo Link is a Trademark of Borland International.
  271.       Clipper is a Trademark of Nantucket.
  272.       Microsoft Overlay Linker is a Trademark of Microsoft Corp.
  273.  
  274.       All references in this documentation to trademarks, copyrights,
  275.       registered names or the like are intended only as a reference and do not
  276.       contain any inference.
  277.  
  278.  
  279.  
  280.       Functional Software
  281.       920 N Washington
  282.       Edmond  OK  73034
  283.       (405) 340-1940  (orders only)
  284.       (405) 341-1893  (FAX)
  285.       (405) 340-4714  (BBS support)
  286.