TweetFollow Us on Twitter

Script Think C
Volume Number:9
Issue Number:8
Column Tag:Scripting

Related Info: Apple Event Mgr

Scripting Think C with Frontier

How to customize THINK C with a scripting language.

By Dave Winer, UserLand Software

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

Introduction

Think C is a wonderful development environment. Lots of commercial and in-house developers use Think C because of its incredibly fast builds, integrated project management and text editing features. It’s a very rationally designed system, it works, and it’s well supported. But it’s always been one major missing feature -- there was no way to automate it. So there was a major penalty for organizing your work as reusable libraries of solved problems -- when you made a change to one of your base libraries, you had to manually rebuild all projects that depend on it.

When we heard that Think C and Symantec C++ 6.0 would support scripting, we got very excited. We wanted to see how using scripts to drive Think Project Manager, or TPM, would impact our development work.

We learned that there are two types of scripts: ones that add features to TPM that everyone can use, and customizations that streamline work for individual programmers and development teams.

For scripts that everyone can use, check out the Scripting Starter Kit for Think C. You can download it from any of UserLand’s on-line services, listed in the last section.

This article is a case study in customization. It takes you thru the development process of a single script, starting with a first proof-of-concept version, all the way to a very useful and complete script that saves us time every day.

Background: The Iowa Plug-Ins folder

At UserLand, we have a set of Think C projects that share a common .h and .c file. They all live in the same folder:

There are two Frontier desktop scripts; one that rebuilds all the projects, producing code resource files, and another that installs the code resources in the System Folder. ioa.c and ioa.h are the common files used in all the projects. When these files change, all the projects must be rebuilt.

Looking inside one of the sub-folders:

Each sub-folder has a common set of files: a project file, a C source file, a Resorcerer resource file and a code resource file produced by building the project.

In the following four sections we develop the script, starting with a basic script, then enhance it to include error checking, and then producing a final version that maintains a log of the compilations it does.

Version 1 - The basic script

Here’s the first version of the buildIOAs script, viewed in a Frontier script editing window:

The script loops over all files contained in the folder it was launched from. system.deskscripts.path contains the full path to the script file. It uses that path to determine which files it’s supposed to operate on.

Two locals are set up: f is the loop parameter of the fileloop, folder contains the full path to the folder that contains the desktop script. Each time thru the loop, f contains the full path to one of the files contained within the folder. Frontier’s fileloop construct takes an optional value determining the number of levels to traverse. We ask it to go infinitely deep, so we get to look at all files contained in all sub-folder levels.

The script displays the name of each file in Frontier's main window. It only operates on files that are Think C project files, whose creator id is 'KAHL' and file type is 'PROJ'.

For each project file the script calculates the name of the output file:

local (outputfile = (f - ".Π") + ".IOA")

The variable outputfile is created locally to the script. f is a string containing the full path to the project file. The .Π extension is subtracted, using string artithmetic, and then .IOA extension is added. If f’s value is “System:Iowa Plug-Ins:Checkbox:checkbox.Π” the value of outputfile would be “System:Iowa Plug-Ins:Checkbox:checkbox.IOA”.

We check to see if the output file exists; if it does, it is deleted. If the build failed due to a syntax error, we won’t be left with an incompatible code file. The script then opens the project, dirties all changed files, recompiles the dirtied files, creates the output file and closes the project. These Frontier verbs work exactly as their interactive counterparts work. But they take variables as parameters, and as we’ll see in the next version of this script, they can return error values.

Version 2 - Add error checking

The first version of the script was useful, but what if one of the projects didn’t compile because of a syntax error, linker error, or if we ran out of disk space? We wouldn’t be totally out of luck, because the script deleted each output file before building it. Even so, we could be left with an inconsistent setup if we weren’t watching the script run. And of course, that’s one of the major benefits of using a script to do the dirty detail work for you. You can read the paper, return a phone call or play with your dog while the script is running.

So, in the second version of the buildIOAs script, we add some rudimentary error checking, so at least the script will stop running and leave an error message explaining why it stopped. In the next version, we’ll make the script even better.

Here’s the second version of the buildIOAs script:

/* 1 */

local (f, folder = file.folderFromPath (system.deskscripts.path))
fileloop (f in folder, infinity)
 msg (file.fileFromPath (f))
 if think.isProjectFile (f)
 local (outputfile = (f - ".Π") + ".IOA")
 if file.exists (outputfile)
 file.delete (outputfile)   
 think.openProject (f)
 if not think.make (think.makeOptions.useDisk)
 scriptError ("think.make failed on " + file.fileFromPath (f))
 if not think.buildProject (outputfile)
 scriptError ("think.buildProject failed on " +                
 file.fileFromPath (f))
 think.closeProject (true) «close and compact

Several things have changed in this version. First, we changed:

if (file.type (f) == 'PROJ') and (file.creator (f) == 'KAHL')

to:

if think.isProjectFile (f)

This takes advantage of a standard verb that makes it easier to determine if a file is a project file. Scripts that work with Think C seem to do this a lot, so we made it simpler to do.

We also check the returned value of each of the verbs where errors are important:

/* 2 */

if not think.make (think.makeOptions.useDisk)
 scriptError ("think.make failed on " + file.fileFromPath (f))
if not think.buildProject (outputfile)
scriptError ("think.buildProject failed on " + file.fileFromPath (f))

If there’s a syntax error in checkbox.c, the Error Info window opens in Frontier:

Since the script is terminated by the scriptError call, Think C will be left pointing to the error when you come back from playing with the dog. If you click on the Go To button, the script editor opens the line that called scriptError, with Frontier’s debugger active.

Version 3 - Maintain an audit trail

It would be nice if the script did as much work as possible, reporting any errors in a list window, and then moving on to the next project.

We’ll keep that list in a Frontier outline window. Every time the script runs, it adds a major headline to the outline:

Building all IOA projects on 4/28/93; 12:43:29 PM

And for every build it attempts, the script will report the result:

colorpopup.Π: clean build

When it’s done, not only will we know which projects built and which ones didn’t, but we’ll also accumulate a record of all the builds done. Here’s what the log outline looks like after the first run:

Building all IOA projects on 4/28/93; 12:43:29 PM
 button.Π: clean build
 checkbox.Π: make failed
 colorpopup.Π: clean build
 edittext.Π: clean build
 formula.Π: clean build
 frame.Π: clean build
 icon.Π: clean build
 picture.Π: clean build
 popup.Π: clean build
 radio.Π: clean build
 rect.Π: clean build
 static.Π: clean build

Here’s what version 3 of the script looks like:

/* 3 */

local (log = @think.log)
local (dir = right)
on startLog (headline)
 if not defined (log^) «the outline isn’t there, create it
 new (outlineType, log)
 editmenu.setFont ("geneva")
 editmenu.setFontSize (9)
 edit (log) «open the log in a window
 target.set (log) «all outline verbs apply to this window
 op.firstSummit () «move to the first line in the outline
 op.go (down, infinity) «move to the last top-level line
 op.insert (headline, down)
on addToLog (subhead)
 msg (subhead) «display string in Frontier's main window
 op.insert (subhead, dir) «insert it in the outline
 dir = down
on closeLog ()
 target.clear ()
local (f, folder = file.folderFromPath (system.deskscripts.path))
startLog ("Building all IOA projects on " + clock.now ())
fileloop (f in folder, infinity)
 msg (file.fileFromPath (f))
 if think.isProjectFile (f)
 local (outputfile = (f - ".Π") + ".IOA", result)
 if file.exists (outputfile)
 file.delete (outputfile)   
 think.openProject (f)
 if think.make (think.makeOptions.useDisk)
 if think.buildProject (outputfile)
 result = "clean build"
 else
 result = "build failed"
 else
 result = "make failed"
 addToLog (file.fileFromPath (f) + ": " + result)
 think.closeProject (true) «close and compact
closeLog ()

Several new techniques are being used in this version. It adds two new locals to support the log outline, and defines three local subroutines, startLog, addToLog and closeLog. In Frontier, as in Pascal, scripts can have local subroutines, nested to any level that makes sense to the programmer. startLog creates a new log outline if one doesn’t exist, and opens it in a window. It adds the main headline for this script. addToLog adds a new headline subordinate to the main headline. closeLog does whatever cleaning up is necessary (for this version not much cleaning up is needed).

Calls to startLog, addToLog and closeLog have been added in the main body of the script.

By the way, this script is much easier to read in Frontier's script editor because you can collapse and expand headings to see as much or as little detail as you like.

Version 4 - Factor the script

Here’s the final version of the script:

/* 4 */

local (f, folder = file.folderFromPath (system.deskscripts.path))
think.notebook.start ("Building all IOA projects on " + clock.now ())
fileloop (f in folder, infinity)
 msg (file.fileFromPath (f))
 if think.isProjectFile (f)
 local (outputfile = (f - ".Π") + ".IOA", result)
 if file.exists (outputfile)
 file.delete (outputfile)   
 think.openProject (f)
 if think.make (think.makeOptions.useDisk)
 if think.buildProject (outputfile)
 result = "clean build"
 else
 result = "build failed"
 else
 result = "make failed"
 think.notebook.add (file.fileFromPath (f) + ": " + result)
 think.closeProject (true) «close and compact
think.notebook.close ()

We’ve made the script a lot simpler this time by moving most of the code for maintaining the log outline into a sub-table of the Think table, called Think.notebook. Of course this makes the script simpler, but it also makes it possible to use the notebook scripts from other Think C-related scripts.

That’s it! There may be other improvements we could make to the script, but there has to be a time to stop and this is it.

Having invested about an hour in creating thIs script, we reap the benefit every time the header file changes and all the plug-ins need to be rebuilt. In the first week, we recouped much more than the hour we invested. Plus, the cost to make a change is much smaller, so we make more changes. The result is more powerful, more reliable and easier to use software.

Finally, if you have any questions, comments or suggestions, please get in touch through one of UserLand’s on-line services. If you’re an AppleLink user, check out the UserLand Discussion Board under the Third Parties icon. On CompuServe, visit the UserLand Forum in the Computing Support section, or enter GO USERLAND at any ! prompt. On America Online, enter the keyword USERLAND.

 
AAPL
$100.57
Apple Inc.
+0.04
MSFT
$44.95
Microsoft Corpora
-0.38
GOOG
$584.49
Google Inc.
-2.37

MacTech Search:
Community Search:

Software Updates via MacUpdate

Tidy Up 3.0.15.0 - Find duplicate files...
Tidy Up is a complete duplicate finder and disk-tidiness utility. With Tidy Up you can search for duplicate files and packages by the owner application, content, type, creator, extension, time... Read more
Parallels Desktop 10.0 - Run Windows app...
Parallels Desktop is simply the world's bestselling, top-rated, and most trusted solution for running Windows applications on your Mac. With Parallels Desktop for Mac, you can seamlessly run both... Read more
Apple Final Cut Pro X 10.1.3 - Professio...
Apple Final Cut Pro X is a professional video editing solution.Completely redesigned from the ground up, Final Cut Pro adds extraordinary speed, quality, and flexibility to every part of the post-... Read more
Apple Compressor 4.1.3 - Adds power and...
Compressor adds power and flexibility to Final Cut Pro X export. Customize output settings, work faster with distributed encoding, and tap into a comprehensive set of delivery features. Powerful... Read more
Chromium 36.0.1985.143 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. FreeSMUG-Free OpenSource Mac User Group build is... Read more
Macgo Blu-ray Player 2.10.6.1691 - Blu-r...
Macgo Mac Blu-ray Player can bring you the most unforgettable Blu-ray experience on your Mac. Overview Macgo Mac Blu-ray Player can satisfy just about every need you could possibly have in a Blu-ray... Read more
Apple Motion 5.1.2 - Create and customiz...
Apple Motion is designed for video editors, Motion 5 lets you customize Final Cut Pro titles, transitions, and effects. Or create your own dazzling animations in 2D or 3D space, with real-time... Read more
A Better Finder Rename 9.39 - File, phot...
A Better Finder Rename is the most complete renaming solution available on the market today. That's why, since 1996, tens of thousands of hobbyists, professionals and businesses depend on A Better... Read more
PopChar X 6.6 - Floating window shows av...
PopChar X helps you get the most out of your font collection. With its crystal-clear interface, PopChar X provides a frustration-free way to access any font's special characters. Expanded... Read more
MacUpdate Desktop 6.0.2 - Install Mac ap...
MacUpdate Desktop 6 brings seamless 1-click installs and version updates to your Mac. With a free MacUpdate account and MacUpdate Desktop 6, Mac users can now install almost any Mac app on macupdate.... Read more

Latest Forum Discussions

See All

Cubic Castles Review
Cubic Castles Review By Rob Thomas on August 20th, 2014 Our Rating: :: CASTLE CRAFTINGiPad Only App - Designed for the iPad Some ridiculously frustrating camera issues aside, Cubic Castles is a pretty neat, voxel-based crafting... | Read more »
Space Colors – Tips, Tricks, Strategies,...
Hello Cadets: Want to know what we thought about this hectic space combat/roguelike? Check out our Space Colors review! Space Colors is a cool shooter/roguelike from Team Chaos. You travel from planet to planet across a huge galaxy and complete a... | Read more »
Tap Sports Baseball – Tips, Tricks, and...
Tap Sports Baseball is a pretty simple game to learn, but that doesn’t mean it’s an easy game to master, by any means. To start your batting career off well, we thought we’d give you the heads up on some handy tips and tricks. Hey Batter-Batter:... | Read more »
Tap Sports Baseball Review
Tap Sports Baseball Review By Jennifer Allen on August 20th, 2014 Our Rating: :: LET'S PLAY BALLUniversal App - Designed for iPhone and iPad Tap Sports Baseball is briefly fun but lacks some important features.   | Read more »
Earn to Die 2 Set to Drive in to the App...
Earn to Die 2 Set to Drive in to the App Store Later This Year Posted by Ellis Spice on August 20th, 2014 [ permalink ] Not Doppler has announced that Earn to Die 2, a sequel to their successful game | Read more »
Frontier Heroes Review
Frontier Heroes Review By Andrew Fisher on August 20th, 2014 Our Rating: :: BLAZES NO TRAILSUniversal App - Designed for iPhone and iPad Despite awesome visuals and great music, Frontier Heroes just doesn’t quite deliver enough fun... | Read more »
Echo Prime is Now on Sale for $0.99
Echo Prime is Now on Sale for $0.99 Posted by Jessica Fisher on August 20th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Star Realms Review
Star Realms Review By Andrew Fisher on August 20th, 2014 Our Rating: :: A STAR IS BORNUniversal App - Designed for iPhone and iPad Star Realms is an excellent adaptation of an outstanding deck-builder. With great visuals and an... | Read more »
This. Is. SPRINGFIELD! War comes to The...
This. Is. SPRINGFIELD! | Read more »
One Tap RPG Review
One Tap RPG Review By Campbell Bird on August 20th, 2014 Our Rating: :: DUNGEON SLIDERUniversal App - Designed for iPhone and iPad This casual arcade game introduces some very light rpg elements into its fantasy-themed pachinko... | Read more »

Price Scanner via MacPrices.net

Apple now offering certified refurbished 2014...
 The Apple Store is now offering Apple Certified Refurbished 2014 MacBook Airs for up to $180 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... Read more
Best Buy’s College Student Deals: $100 off Ma...
Take an additional $100 off all MacBooks and iMacs, $50 off iPad Airs and iPad minis, at Best Buy Online with their College Students Deals Savings, valid through September 6th. Anyone with a valid .... Read more
MacBook Airs on sale for $100 off MSRP, free...
B&H Photo has three 2014 MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only. They also include free copies of Parallels Desktop and LoJack for Laptops... Read more
Razer Taipan Mouse For Gamers And Non-Gamers...
If you’re a serious gamer on either Mac or Windows PCs, a serious gaming mouse is a necessity for first-tier performance. However, even if like me you’re not much of a gamer, there’s still a strong... Read more
15-inch 2.2GHz MacBook Pro on sale for $1899,...
Adorama has the new 15″ 2.2GHz Retina MacBook Pro on sale for $1899 including free shipping plus NY & NJ sales tax only. Their price is $100 off MSRP, and it’s the lowest price available for this... Read more
Mid-Size Tablet Shootout Posted: iPad mini wi...
I ‘m curious about how many iPads Apple is actually selling these days. It’s been widely rumored and anticipated that new models with A8 SoCs, 2 GB of RAM, 8 megapixel cameras, and fingerprint... Read more
The 15 Biggest iPad Air Problems And How To A...
What’s this? Fifteen “biggest” problems with the iPad Air? Does that mean there are a lot of smaller problems as well? Say it isn’t so! My old iPad 2 has manifested no hardware problems in three... Read more
TYLT Syncable-Duo, 2-in-1 USB Cable With Appl...
TYLT has introduced the Syncable-Duo, a universal cable solution for charging and syncing data to smartphones and tablets. The Syncable-Duo eliminates the need for multiple cables by incorporating... Read more
Save up to $140 off MSRP with Apple refurbish...
Apple is offering Certified Refurbished iPad Airs for up to $140 off MSRP. Apple’s one-year warranty is included with each model, and shipping is free. Stock tends to come and go with some of these... Read more
2.5GHz Mac mini on sale for $549, save $50
B&H Photo has the 2.5GHz Mac mini on sale for $549.99 including free shipping. That’s $50 off MSRP, and B&H will also include a free copy of Parallels Desktop software. NY sales tax only. Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
*Apple* Solutions Consultant - Apple (United...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** Being a Business Manager at an Apple Store means you're the catalyst for businesses to discover and leverage the power, ease, and flexibility of Apple Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** At the Apple Store, you connect business professionals and entrepreneurs with the tools they need in order to put Apple solutions to work in their Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.