Shareware Supreme Volume 6 #1/swsii.zip/swsii/461/CS_724.ZIP/CS.DOC

Text File | 1993-01-09 | 8.0 KB | 248 lines

CodeSmith and its documentation are copyright 1990 - 1993 by:

Don Allred
P.O. Box 56885
Sherman Oaks, CA 91413

All rights are reserved.

see end of file readme.cs for ordering information.


The purchaser of CodeSmith is granted a license to use it, to make
copies of the original distribution disk for backups, and to install
it on one or more systems as long as there is no possibility that it
will be used on more than one of those systems at a time. This does
not constitute a site license; it is intended to allow a single
programmer to install CodeSmith on all of the machines that he uses,
but only to allow him to use it on one of those machines at once. In
essence, CodeSmith is licensed to a single user, who is the only
person permitted to use it.

This license applies to the development of software using CodeSmith,
not to the redistribution of that software. Software in executable
form that includes code produced by CodeSmith may be sold, given
away, or otherwise redistributed with no additional fees to, and no
special license required from, Don Allred. You may not, however,
redistribute CodeSmith in part or in whole.

Clipper is a registered trademark of the Nantucket Corporation.




     SYSTEM REQUIREMENTS

To develop applications using CodeSmith, you must have a computer
running MS-DOS, and capable of compiling and linking Clipper 5.01
programs. You must have a copy of Clipper 5.01 and a linker
compatible with Microsoft object modules and libraries.  We have
tested CodeSmith with these linkers:

     BLINK, Inc. BLINKER version 1.5, 1.51 & 2.0
     Hyperkinetix Warplink version 2.0
     Pocket Soft .RTLink version 3.13 & 5.00

Programs created with CodeSmith must run on an IBM PC or compatible
computer.


     INTRODUCTION

CodeSmith is a Clipper 5.01 application generator, a program which
writes programs. It's goal is to provide you the developer with near
instant complete single database, multiple screen, network/single
user applications without writing a line of code.

This is done by designing a data screen with CodeSmith's internal
screen painter. You can define fields, text, lines, boxes, colors,
pictures, valids, whens, index keys and even insert your own custom
code!

Your design can be based on all or part of an existing database, one
or more previous designs or you can begin from scratch. In any case
CodeSmith will write the programs to manage your new/old database.

CodeSmith generates the full and complete source code for your
application design with no hidden libraries. The only system
requirements are those needed by Clipper itself.

In addition to generating a complete application, you can also
generate a "basic application" which is almost identical to the full
application except there is no main menu. In this way you may create
applications which can be called from within your main application by
inserting a function call with a user defined field.

Code fragments consisting of your screens and procedures to create
your DBF structure in Summer '87 and 5.01 can also be generated. A
real useful tool when changing an existing application or when you
just need a screen.


So that you can get an idea of what to expect from CodeSmith, let's
quickly generate a sample application using a design provided. Later
we will go over each command in CodeSmith and create an application
from scratch.



     GENERATING THE SAMPLE APPLICATION

From the DOS prompt type CS <Enter>.

Using the arrows keys, highlight SAMPLE.CS1 and press <Enter>.

Now you should have an on screen representation of the sample
application.  Press <M> (that's just the letter M) for the Main Menu.

Using the arrow keys, move down to and highlight Generate Full
Application then  press <Enter>.

Application Name? The name SAMPLE is already typed in so just press
<Enter>.

Database Name? Again the name SAMPLE is provided so press <Enter>.

Alias Name? Same thing, just press <Enter>.

Multi-User? Select YES

Create Generic Files Too?  Select YES.

"Your custom PRG to link in". Press <Enter> to skip.

"Quik TBrowse PRG to link in". Press <Enter> to skip.

"Quik TBrowse function name". Press <Enter> to skip.

Accept, Re-Try, Cancel?   Select Accept

CodeSmith will now generate about 5,000 lines of 5.01 program code. A
listing of the file names being generated is shown so that you can
monitor its progress.

When finished you see a prompt about compiling and linking the
application.

Press <ESC> four times, then press YES to Exit to DOS.


Here is what we just created:

SAMPLE.PRG      Main Menu

SAMPLADD.PRG    Add Records

SAMPLGET.PRG    View/Search/Edit Record

SAMPLHLP.PRG    Help File

SAMPLE.MAK      Rmake Make file

SAMPLE.LNK      Blinker Link File

SAMPLE.RTL      RTlink Link File

SAMPLE.WL       WarpLink Link File

GO.BAT          Generic, used to compile
                and link application.

CS.CH           Generic Header File.
                Contains system colors.
CSGENRL.PRG     Generic Functions and
                Procedures

CSLABEL.PRG     Generic Label Maker

CSVIEW.PRG      Generic Browser

CSREPORT.PRG    Generic Report Writer

CSQBE.PRG       Generic Query by Example
                Complex Filter Builder

CSLOCKS.PRG     Networking Functions


To compile and link our sample application, at the DOS prompt type GO
SAMPLE.

GO.BAT will tell Rmake to process SAMPLE.MAK which will compile all
programs into object files. Next it will tell SAMPLE.RTL to link the
application using RTlink.

If you have a problem compiling or linking make sure that your
Clipper, libraries, include files and linker are in the path.

If prefer to use Blinker or WarpLink, just go into GO.BAT and move
the REM statement.



               OWN YOUR OWN

CodeSmith and it's applications support 25, 43 and 50 line displays.
The default for both is the current display mode. If for example you
are currently in 25 line mode and you want to generate an application
for 50 line VGA displays, use the <L> setmode()/ Lines option. This
will give you twice the screen area to work with. The finished
application defaults to the current mode so begin application by
typing SAMPLE 50.


At first glance it may appear that CodeSmith has a lot of options to
deal with, but not really. With the exception of entering INDEX KEYS,
(you can't search without an index) the others can be ignored. With a
little practice you can create a full working application in a few
minutes while your customer watches. Now your customer can begin data
entry, impressed at how efficient you are, while you return to your
office and . . .

CodeSmith is intended to relieve you of the mundane aspects of
programming. I use it for all my simple applications and as a
starting point for complex applications.

CodeSmith is being actively developed with changes on a daily basis.
Future versions will include relations and developer defined pop-up
validation functions. Let me know what you need.


Speaking of relations, with our new product Quik TBrowse, you can
have CodeSmith applications with    one to many relations. Just design
your parent/child/ grand child realtions using Quik TBrowse and tell
CodeSmith to link in the generated application. Quik TBrowse is
available for the low price of $49.00

The current (January 1993) upgrade policy is 50% of whatever you paid for
your first version.

Beta testers get free upgrades.

CodeSmith may be purchased from Programmer's Warehouse [phone]
or you can order directly from me or Max Bressel in Europe.

If you have any problems, please give me a call, I want you to be
productive.

I welcome your comments and suggestions.

Don Allred
P.O. Box 56885
Sherman Oaks, CA 91413
[phone] Voice
[phone] FAX

Europians may want to contact Max Bressel at:

SOFTSOL                    Tel.:[phone]
Salzburger Haeuser 4       Fax :[phone]
2100 Hamburg 90            BBS :[phone]/8
Germany                    CIS :100112,3401


Happy Programming!

January 2, 1993