TweetFollow Us on Twitter

September 90 - Aranda: a new case of CASE

Aranda: a new case of CASE

John Pattenden

Introduction

Aranda is a Computer-Aided-Software-Engineering (CASE) tool that does not fit into either of the two general categories of CASE products. Tools in the first category use notational systems to support one or more development methodologies for structured analysis and specification. Notational systems, such as bubble diagrams, are used to represent processes and dataflows. These systems require software engineers to learn a new set of paradigms before they can actually start doing anything useful and may not be well suited to some projects, particularly those that are more evolutionary than engineered.

The other category of tools are code generators, which can be useful for rapid prototyping but which tend to produce code that is difficult to maintain.

Aranda takes an entirely different approach. It's an object-oriented CASE tool designed to aid in the comprehension and reuse of existing code. It may, in fact, be the first CASE tool designed with object programming in mind. This should not be surprising, since Aranda was written using MacApp.

Aranda will generate information about existing source code, making it an immediately useful tool, especially in the case of MacApp with its large library of pre-existing code that needs to be at least partially digested by the working MacApp programmer. Aranda provides the user with several different ways of viewing code, both graphically and as text. All Aranda's views are hypertext-linked to aid navigation through the code jungle.

Aranda is based on a meta-programming model described in a paper, "Software maintenance using metaprogramming systems," which was presented at the 1987 Conference on Software Maintenance in Austin, Texas by Brian W. Terry and Rob Cameron of Simon Fraser University. In this model, Aranda parses all source code into a "project" and then generates and maintains an abstract tree of the code. Unlike a compiler-style parser, Aranda keeps the basic structure of the source code intact, allowing context-sensitive references to the code to be made after parsing.

The down side of this approach is that Aranda cannot handle some code that a compiler can. The case I ran into most often was with compiler directives, particularly the include statement. However, if you follow the conventions used in MacApp for compiler directives and generally maintain good programming form there should be no problems.

This tree structure is stored in a database along with the original source code which, although converted to Aranda's internal format, can still be viewed in its original form. After all the code has been parsed, a project window appears with a series of icons, each of which represents one source file that has been parsed; this represents a window into the database. (If you can't spot the file that you want, you might have to do a "Clean up windows," since Aranda sometimes places its icons outside the viewable area of the window).

From this "top level," folders can be created to help organize files and reports. There are a series of navigation tools provided on a screen palette which make navigating through folder hierarchies and reports quick and intuitive. With a large body of code-inevitable with MacApp-the ability to logically file associated items together in a simple intuitive fashion is a key factor in making the system useful as a whole.

Using Aranda

The first step into the code is to apply the Contents tool to the source file(s) that you wish to investigate. (Incidentally, I used the the IconEdit tutorial program for the source code in all the following diagrams.) The way tools are applied throughout Aranda is to first select an Identifier (see below) and then apply a tool to it.

Contents report

The Contents report provides a graphical view of a source code file, portraying the relationship between Identifiers, which are defined by Soft-Set as Procedures, Functions, Classes, Types, Variables, Parameters, Methods, Constants and Include files. The graphic reports can be reduced or expanded in detail and filters may be used to only show desired identifiers. Different shapes represent different types of identifiers, which quickly become familiar and easily recognizable.

Classes tool

The Classes tool lets you show the entire inheritance tree, all the way back to TObject, and in general provides a quick overview of any particular class hierarchy. All of these reports are context-sensitive, so a graphic object representing any identifier can be clicked on to provide a selection, and then an action appropriate to that identifier can be taken.

Notes

Notes lets you place the contents of other reports into a text format that is useful for archival documentation. These Notes reports are very useful, not only for after-the-fact documentation but also in the design and implementation stages, where a project leader might generate a note on a routine he needs and include references to other pieces of code that are to be used-the programmer who is implementing the new routines can then use Aranda's hypertext capabilities to investigate the other routines involved. PICTs and text can be pasted and positioned in Note forms, along with icons which reference other reports. You can thus create a flowchart and have the source code for the report available for viewing at the press of a button.

Notes are ideal for the software engineer who is a little slack in documenting code-a not uncommon occurrence. Aranda has a series of built-in Note reports for various identifiers which can be customized and extended as desired. The really nice thing about this type of report is that it is dynamic-keeping documentation up to date would otherwise be a time-consuming task and more often than not wouldn't be accurate anyway-so that getting a report "from the horse's mouth" in this fashion is a significant step forward in helping to make maintenance easier.

Flowcharts

A flowchart of a method, function or procedure can be generated in seconds by selecting the identifier and applying the Flowchart tool. This ability to graphically represent a routine's execution structure can be extremely helpful in figuring out what a routine does, particularly if you haven't written it. The full expression of any of the statements in the flowchart can be viewed with a Command-click. As with all the reports, the flowcharts are printable; the only thing I would have liked to see is the ability to get the entire expression on the printout. This applies to copying the charts as well.

Other tools

Other tools include an Imports tool which shows all externally defined identifiers that a selected routine imports. "Used By" shows all the identifiers that use a selected identifier, while "Modified By" displays all the routines that modify a selected identifier by direct assignment; this does not include variables whose values are modified as VAR parameters.

The source for any identifier can be quickly found using the Source Code tool. Once the contents of a source file has been established, the code can be analyzed in a number of ways using context-sensitive tools. The source is active in the sense that any identifier in the Source Code report can be selected and a report pertinent to it generated. This is a handy feature if you are tracing code through its calling chain to find bugs or understand logic.

Source-code editing is not available at this time, although code can pasted into other applications. Soft-Set is working towards editable source that can be added to the parse tree on the fly and then displayed graphically to show how it effects the rest of the program.

Each of these reports adds an icon and an explanatory title to the project window or the folder from which it was initiated; double clicking on the icon will regenerate the report. All the reports in Aranda are generated on the fly, guaranteeing that they will always be up to date as long as you have added the latest versions of any source files that have changed. Aranda aids you in this potentially tiresome pursuit by adding a "show newer" checkbox to its standard-file like dialog to add or update files in the database.

To help improve performance Aranda will in fact keep track of the last several reports that were generated (it implements a virtual memory scheme which can suck up a few megs), so switching between reports that you have just viewed is not slowed down at all by regeneration. However , if the report is not cached in memory it does have to be regenerated, which in the case of a "Used By" report can take several minutes and in some cases much longer.

The good news is that most reports take only a few seconds; to graphically generate the entire MacApp class hierarchy takes about a minute. All the reports can be cut and pasted into Notes or other applications, so if you are inclined towards huge wall charts there is plenty of scope here-it's just a matter of pasting it into your favorite CAD package and plotting it out. One problem with this, however, is the limit on Aranda's Scrap: the entire class hierarchy of MacApp needs a bit of disassembly work to get it exported out of Aranda.

If Aranda sounds at this point like a glorified browser, you would be at least partially correct: at its crudest level, Aranda makes an excellent companion to Mouser [Ed: now MacBrows] and is more accurate in tracking identifier usage. Using Aranda as a browser is a lot like using MacApp to do a "hello world" program: it does a fine job but its full potential is nowhere near being tapped.

Aranda comes with an 80-page manual that is well thought out and includes explanations of commands, a reference section, and a tutorial. While the tutorial only touches the surface of Aranda's capabilities, it does give a good first look at how to get into the program. Soft-Set is working on application notes which will demonstrate more in-depth techniques for applying Aranda to source-code documentation techniques.

How I use Aranda

I've been beta testing Aranda for more than six months and am now using the 1.01 release. We've mainly used it with an 80,000-line program written largely by people who are now unavailable [Ed: is that mentally or physically?] The software controls a series of remote hardware devices in real time; the overall system has to have a friendly user interface and control refrigeration, lighting and air conditioning in large buildings such as supermarkets. We also have the simultaneous ability of communicating with the hardware/software via modem to change settings on the fly.

Aranda has at times proven invaluable to us in tracking down how or why certain thing are happening in a very complex system which by definition has to avoid modes. We are now moving into the object programming arena, and since Aranda is a tool that can handle either procedural or object code, that versatility is a key feature in allowing us to easily change environments and even programming languages and yet let us keep the same code management tools.

MacApp is still a reasonably large mystery, but in Aranda we now have a tool that can help us find out what goes where and why. My reason for investigating Aranda over a year ago was because of the system I mentioned above; Aranda has done a very good job of retroactive documentation, made necessary by the loss through theft of our original documents. Just having the ability of finding every place a routine is used or a variable is modified has been an enormous help. These, by the way, are the kind of basic operations we found ourselves doing most often, more then generating Notes from various identifiers. The balance of power shifts somewhat with a MacApp-based system, but no matter what kind of programming environment is being used, some of the same questions are going to be asked.

MacApp and Aranda make a powerful combination because although design specifications and documentation are available, the code was still written by someone else whom you can't just call up and ask questions of. Any tool that can speed analysis of code is a powerful friend to have.

Aranda is the kind of tool that will be used differently by different people and different sized teams, and this is indicative of its versatility. It's more of a revolutionary than an evolutionary tool. It allows millions of lines of pre-existing code to be digested, maintained, and even more importantly, reused. In the next few years Aranda and other tools will become as integral a part of the software development environment as compilers are today. I'm only surprised that it's taken so long for software engineers to start making tools for themselves that are as powerful as those they make for almost every other industry.

Enhancements

One feature missing from this release of Aranda is multiple windows. Fortunately there are simple intuitive navigation tools for moving between various reports and up and down folder hierarchies. Soft-Set is planning to release a multiple window version of Aranda in November, which will greatly enhance the usability of the program. We should see a C version early in September and a separate C ++ version about a month later. (The reason for separate versions is because of a difference in reserved words between C and C++.) Other improvements on the horizon are interactive tabular views of reports, automatic updates of an entire project through a single command, improved speed, and new testing tools including a Coverage Analysis Profiler. In the works also is a COBOL version for those unfortunate souls still using it.

Summary

If you have an aversion to painstaking manual documentation of code, need to bring people up to speed on a project, are about to dive into some serious maintenance, or are just plain writing code, Aranda is worth a look. Aranda can be used effectively at most stages of the software life cycle, particularly where reuse of code is a factor. It provides an excellent way of exploring existing code and bringing new members of a project up to speed quickly.

Aranda is currently available for Apple's MPW Pascal and Symantec's THINK Pascal compilers. All of my own testing has been under MPW. Aranda runs under both Finder and MultiFinder; a 68020 or 68030 Macintosh with a minimum of two megabytes of RAM is required.

Aranda is available from:

Soft-Set Technologies, Inc.
1847 W. Broadway, #301
Vancouver, B.C. V6J 1Y6

Phone: (604) 734-1622
Fax: (604) 733-5294
AppleLink: SoftSet

Pricing is $645 and discounts are available for purchases of multiple units. Educational institutions get a hefty discount and a special student version for projects of less than 5,000 lines of source is available for $50. A limited-life demo disk is also available for $19.95.

Soft-Set provides free tech support for 30 days and free updates for 12 months following purchase.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

TechTool Pro 9.5.1 - Hard drive and syst...
TechTool Pro has long been one of the foremost utilities for keeping your Mac running smoothly and efficiently. With the release of version 9, it has become more proficient than ever. TechTool... Read more
Jamf Pro 9.99.0 - Powerful sysadmin/ente...
Jamf Pro (formerly Casper Suite) is the EMM tool that delights IT pros and the users they support by delivering on the promise of unified endpoint management for Apple devices. At Jamf, connecting... Read more
VueScan 9.5.78 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
Adobe Lightroom 6.10.1 - Import, develop...
Adobe Lightroom is available as part of Adobe Creative Cloud for as little as $9.99/month bundled with Photoshop CC as part of the photography package. Lightroom 6 is also available for purchase as a... Read more
iPhoto Library Manager 4.2.7 - Manage mu...
iPhoto Library Manager allows you to organize your photos among multiple iPhoto libraries, rather than having to store all of your photos in one giant library. You can browse the photos in all your... Read more
Smultron 9.4 - Easy-to-use, powerful tex...
Smultron 9 is an elegant and powerful text editor that is easy to use. Use it to create or edit any text document. Everything from a web page, a note or a script to any single piece of text or code.... Read more
TextSoap 8.4 - Automate tedious text doc...
TextSoap can automatically remove unwanted characters, fix up messed up carriage returns, and do pretty much anything else that we can think of to text. Save time and effort. Be more productive. Stop... Read more
Merlin Project 4.2.3 - $349.00
Merlin Project is the leading professional project management software for OS X. If you plan complex projects on your Mac, you won’t get far with a simple list of tasks. Good planning raises... Read more
QuarkXPress 13.0.0.0 - Desktop publishin...
QuarkXPress 2017 is the new version that raises the bar for design and productivity. With non-destructive graphics and image editing directly within your layout, you no longer have to choose between... Read more
Path Finder 7.5 - Powerful, award-winnin...
Path Finder makes you a master of file management. Take full control over your file system. Save your time: compare and synchronize folders, view hidden files, use Dual Pane and full keyboard... Read more

Latest Forum Discussions

See All

Mordheim: Warband Skirmish brings tablet...
Legendary Games has just launched Mordheim: Warband Skirmish, a new turn-based action game for iOS and Android. | Read more »
Magikarp Jump splashes onto Android worl...
If you're tired ofPokémon GObut still want something to satisfy your mobilePokémon fix,Magikarp Jumpmay just do the trick. It's out now on Android devices the world over. While it looks like a simple arcade jumper, there's quite a bit more to it... | Read more »
Purrfectly charming open-world RPG Cat Q...
Cat Quest, an expansive open-world RPG from former Koei-Tecmo developers, got a new gameplay trailer today. The video showcases the combat and exploration features of this feline-themed RPG. Cat puns abound as you travel across a large map in a... | Read more »
Jaipur: A Card Game of Duels (Games)
Jaipur: A Card Game of Duels 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: ** WARNING: iPad 2, iPad Mini 1 & iPhone 4S are NOT compatible. ** *** Special Launch Price for a limited... | Read more »
Subdivision Infinity (Games)
Subdivision Infinity 1.03 Device: iOS Universal Category: Games Price: $2.99, Version: 1.03 (iTunes) Description: Launch sale! 40% Off! Subdivision Infinity is an immersive and pulse pounding sci-fi 3D space shooter. https://www.... | Read more »
Clash of Clans' gets a huge new upd...
Clash of Clans just got a massive new update, and that's not hyperbole. The update easily tacks on a whole new game's worth of content to the hit base building game. In the update, that mysterious boat on the edge of the map has been repaired and... | Read more »
Thimbleweed Park officially headed to iO...
Welp, it's official. Thimbleweed Park will be getting a mobile version. After lots of wondering and speculation, the developers confirmed it today. Thimbleweed Park will be available on both iOS and Android sometime in the near future. There's no... | Read more »
Pokémon GO might be getting legendaries...
The long-awaited legendary Pokémon may soon be coming to Pokémon GO at long last. Data miners have already discovered that the legendary birds, Articuno, Moltres, and Zapdos are already in the game, it’s just a matter of time. [Read more] | Read more »
The best deals on the App Store this wee...
If you’ve got the Monday blues we have just the thing to cheer you up. The week is shaping up to be a spectacular one for sales. We’ve got a bunch of well-loved indie games at discounted prices this week along with a few that are a little more... | Read more »
Honor 8 Pro, a great choice for gamers
Honor is making strides to bring its brand to the forefront of mobile gaming with its latest phone, the Honor 8 Pro. The Pro sets itself apart from its predecessor, the Honor 8, with a host of premium updates that boost the device’s graphical and... | Read more »

Price Scanner via MacPrices.net

Huawei Unveils New ‘Business-Styled’ MateBook...
Huawei has introduced a trio of new MateBook laptops, expanding its mobile portfolio and building on its success in delivering attractive and powerful high-end devices. The company claims the HUAWEI... Read more
Deal! Gold 12-inch 1.2GHz Retina MacBook for...
Amazon has the 2016 Gold 12″ 1.2GHz Retina MacBook (MLHF2LL/A) on sale for $350 off MSRP for a limited time. Shipping is free: - 12″ 1.2GHz Gold Retina MacBook: $1249.99 $350 off MSRP We expect this... Read more
13-inch 2.0GHz MacBook Pros on sale for $100...
B&H has the non-Touch Bar 13″ 2.0GHz MacBook Pros in stock today and on sale for $100 off MSRP. Shipping is free, and B&H charges NY & NJ sales tax only: - 13″ 2.0GHz MacBook Pro Space... Read more
15-inch 2.2GHz Retina MacBook Pro, Apple refu...
Apple has Certified Refurbished 2015 15″ 2.2GHz Retina MacBook Pros available for $1699. That’s $300 off MSRP, and it’s the lowest price available for a 15″ MacBook Pro. An Apple one-year warranty is... Read more
Apple refurbished 9-inch and 12-inch iPad Pro...
Apple has Certified Refurbished 9″ and 12″ Apple iPad Pros available for up to $160 off the cost of new iPads. An Apple one-year warranty is included with each model, and shipping is free: - 32GB 9″... Read more
Apple Certified Refurbished iMacs available f...
Apple has Certified Refurbished 2015 21″ & 27″ iMacs available for up to $350 off MSRP. Apple’s one-year warranty is standard, and shipping is free. The following models are available: - 21″ 3.... Read more
Sale! 15-inch 2.6GHz Silver Touch Bar MacBook...
DataVision has the 15″ 2.6GHz Silver Touch Bar MacBook Pro (MLW72LL/A) on sale for $2199 including free shipping. Their price is $200 off MSRP, and it’s the lowest price available for this model (... Read more
A Kaby Lake Processor Upgrade For The MacBook...
Now they tell me! Well, actually Apple hasn’t said anything official on the subject, but last week Bloomberg News’s Mark Gurman and Alex Webb cited unnamed “people familiar with the matter”... Read more
Kodak’s Camera-First Smartphone EKTRA Launche...
The Eastman Kodak Company and Bullitt Group have announced the availability of a U.S. GSM version of the KODAK EKTRA Smartphone. The U.S. launch coincides with a software update addressing requests... Read more
Apple Launches App Development Curriculum for...
Apple today launched a new app development curriculum designed for students who want to pursue careers in the fast-growing app economy. The curriculum is available as a free download today from Apple... Read more

Jobs Board

Data Engineer - *Apple* Media Products - Ap...
Changing the world is all in a day's work at Apple . If you love innovation, here's your chance to make a career of it. You'll work hard. But the job comes with more Read more
*Apple* Store Leader Program - Apple, Inc (U...
…Summary Learn and grow as you explore the art of leadership at the Apple Store. You'll master our retail business inside and out through training, hands-on Read more
*Apple* Integration Specialist - A3 Solution...
Apple Integration Specialist Contract-To-HireWe are searching for dedicated, well-experienced and energetic individuals for an information technology corporation Read more
Sr. Software Engineer, *Apple* Online Store...
Changing the world is all in a day's work at Apple . If you love innovation, here's your chance to make a career of it. You'll work hard. But the job comes with more Read more
Senior Engineering Project Manager, *Apple*...
Changing the world is all in a day's work at Apple . If you love innovation, here's your chance to make a career of it. You'll work hard. But the job comes with more Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.