TweetFollow Us on Twitter

September 90 - Meta-spaghetti

Meta-spaghetti

Donald E. Carlile

(BILL: I FORGOT TO GET A COMPANY NAME FROM DON. WANT TO GIVE IT A SHOP?)

I'm a fairly conscientious programmer-I like to think I write good clean code; I take the trouble to use modular techniques; I even stood on my head to learn object-oriented techniques. But in spite of all this, I found out I was writing spaghetti.

Spaghetti code! Someone still uses GOTO!?

Well, possibly I exagerrate: I don't mean spaghetti code in the old BASIC GOTO sense-```I mean spaghetti code that is only possible when you are writing in an OOP language. Maybe we'd better call it meta-spaghetti.

I found I was writing meta-spaghetti when I was asked by someone if I would let him use some of my objects. I had known I had only one unit, but I hadn't realized how tangled it was. It was then that I developed the term meta-spaghetti to define the condition of my code.

What I mean by meta-spaghetti is objects which refer to each other recursively. That is, objects which in their definitions include fields of each other's type, as in

TMyDocument = OBJECT(TDocument)
	
	fStar : TStar;
	…

	TStar = OBJECT(TObject)

		fMyDocument : TMyDocument;
	…

This leads to strange loops and to units which cannot easily be decomposed into simpler entities.

As anyone who has read even part of Hofstader's Gödel, Escher, Bach knows, it is impossible to entirely banish strange loops: you made that reference in the object definition for some reason, and it cannot be easily abandoned without some thought and work. That being said, you might still want to introduce some measure of isolation between your objects.

I can tell you from experience that it is difficult to undo the damage once it's done. As I was unraveling my code, however, I developed some guidelines for avoiding and dealing with meta-spaghetti. Perhaps they will prove helpful to you as well, as you design your code from the beginning to avoid this condition.

1. References should only to be to objects down the ownership chain.

As I was defining my set of rules, this is the first one that became apparent: when defining an object, references can be made to the internals of the objects it owns. This is what I mean by references down the ownership chain. (For a more complete discussion of the ownership chain, see the author's Chains Required, Whips Optional, an unpublished, and indeed unwritten, article.)

As an example, in my Trek-style game I had a method to add text to a textedit window. This method belonged to my document object. In order for my ship objects to add text about their status to the window, they had to have a reference to my document object. This caused a problem when I wanted my ship objects in a separate unit so that others could use them.

I solved this problem by changing the way I added text to the window. Instead of calling the document method, I added a text handle field to the ship object. I then changed my document DoIdle to check the texthandle of each ship object. In this way I followed the rule of having only references down the ownership chain.

If this rule is followed, the separation of objects into units becomes very clear and simple. There is no confusing interdependence of objects, and it is clear what the unit dependencies should be.

There is only one problem with this rule: it's not always possible or desirable to follow it. Some objects need to be interrelated; when this is the case, they probably should not be separated. This brings us to the next rule:

2. When it is impossible to remove references between objects, include them in the same unit.

The universe of my game is defined by two object types, TGalaxy and TQuadrant. These two object types refer to each other quite a lot, and it makes a great deal of sense for them to both be in the same unit. It is also unlikely that they would need to be separated to be reused. Therefore, I have put them into their own unit.

3. When it is impossible to untangle references and they must be in separate units, define a new object to make the references and push it down the ownership chain.

Don't be afraid to revise your structure. Although it will save you work to think out your structure ahead of time, sometimes this proves impossible. When you find you have painted yourself into a corner, cut a new doorway.

In my original design, my TMyDocument object owned all the lists of quadrants and other data containers. Thus, all my data objects referred back to it in order to refer to each other. When I wanted to separate out my ships, stars and quadrants into other units to make them usable elsewhere and to decrease compile time, I found the task impossible.

I then defined a new object, a TGalaxy, to contain all the objectionable fields and methods (no pun intended) and made a new field in the revised TMyDocument object to refer to an instantiation of TGalaxy. This made it possible to cleanly make the separation.

Make vanilla references when Rule 1 is impossible.

Another strategy for avoiding meta-spaghetti is to make references to the parent type rather than the type that is giving you trouble. This is not always possible, but sometimes the method or field you need to reference is contained in the object's parent or ancestor.

In my game, I call the draw method of my TQuadView object type from one of the methods of TQuadrant. I do this to avoid the flicker introduced when I use the invalid rectangle methods of MacApp. Originally TQuadrant included a field fMyDocument of type TMyDocument. TMyDocument, of course, had a reference to an fQuadView, of type TQuadView. TQuadView was a specialized descendant of TView. When I needed to do a drawing, I called fMyDocument.fQuadView.Draw. In this way, TQuadrant absolutely needed to be in the same unit as TQuadView. It was also specifically geared to my application only.

To untangle this particular mess, I added a field fQuadView, of type TView, to my TGalaxy object. Since variables of an ancestor type can contain any descendent, this field can contain an object of the specialized type TQuadView. The only limitation is that specialized fields and methods may not be called using this reference.

At the time an object of type TQuadView is made, it is passed to fGalaxy of the TMyDocument. Then I can call Draw, since Draw is one of the methods of the ancestor TView class.

5. Define proto-objects for objects up the chain when Rule 1 is impossible.

Sometimes all the above rules fail: you still want to break up objects into different units but they can't come completely apart. When this happens, it is important to remember that it is permissible to define objects or abstract classes which have no instantiation. You can define these "proto-objects" to contain those fields and methods which are necessary for the objects lower down the ownership chain and can include these classes in the same unit with those objects. Then USE that unit in the unit which defines the real objects and make them descendants.

As I mentioned earlier, TGalaxy and TQuadrant define the universe of my game. I found it impossible to completely divorce these objects from the objects I refer to, i.e., my ships, stars, bases,and torpedoes. I reasoned further that any structure which made use of my entities would also need some kind of quadrant and galaxy. I then defined a TProtoGalaxy and TProtoQuadrant, which had references for the fields and methods necessary for my entity unit, while not burdening the unit with the heavy details and the bulk of the fields and methods. I then defined TGalaxy as a descendant of TProtoGalaxy and TQuadrant as a descendant of TProtoQuadrant.

This one might be just a bit tricky to follow. Let me try and restate it thusly: the Galaxy and Quadrant objects have several fields and methods which ships and things need to reference. Two examples of such fields are the galaxy array and the list of other entities in the quad. An example of a referenced method is the one which detects when collisions occur. I therefore defined objects, which I call proto-objects, which contain references to these things. I don't define the methods-e.g., the collision procedure in the protoQuad consists of a Begin and an End, as do the rest of the methods in my proto-objects. In a different unit I then create descendants of the proto-objects with all the fields and fleshed-out methods fully defined.

I don't claim that these rules are the simple once-and-for-all solution to the problem of meta-spaghetti, but they are a start. You can probably come up with a few rules and methods of your own. Good luck!

Rules for avoiding meta-spaghetti:

  1. References should only to be to objects down the ownership chain.
  2. When it is impossible to remove references between objects, include them in the same unit.
  3. When it is impossible to untangle references, and they must be in separate units, feel free to define a new object.
  4. Make vanilla references when Rule 1 is impossible.
  5. Define proto-objects for objects up the chain when Rule 1 is impossible.

If you have any questions or comments for Don, he can be reached on AppleLink at N0231.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Cocktail 8.4 - General maintenance and o...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
PDFKey Pro 4.3 - Edit and print password...
PDFKey Pro can unlock PDF documents protected for printing and copying when you've forgotten your password. It can now also protect your PDF files with a password to prevent unauthorized access and/... Read more
Kodi 15.0.beta1 - Powerful media center...
Kodi (was XBMC) is an award-winning free and open-source (GPL) software media player and entertainment hub that can be installed on Linux, OS X, Windows, iOS, and Android, featuring a 10-foot user... Read more
DiskCatalogMaker 6.4.12 - Catalog your d...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast. Finder-like intuitive look and feel. Super-fast search algorithm. Can compress catalog data... Read more
Macs Fan Control 1.3.0.0 - Monitor and c...
Macs Fan Control allows you to monitor and control almost any aspect of your computer's fans, with support for controlling fan speed, temperature sensors pane, menu-bar icon, and autostart with... Read more
Lyn 1.5.11 - Lightweight image browser a...
Lyn is a lightweight and fast image browser and viewer designed for photographers, graphic artists and Web designers. Featuring an extremely versatile and aesthetically pleasing interface, it... Read more
NeoOffice 2014.11 - Mac-tailored, OpenOf...
NeoOffice is a complete office suite for OS X. With NeoOffice, users can view, edit, and save OpenOffice documents, PDF files, and most Microsoft Word, Excel, and PowerPoint documents. NeoOffice 3.x... Read more
LaunchBar 6.4 - Powerful file/URL/email...
LaunchBar is an award-winning productivity utility that offers an amazingly intuitive and efficient way to search and access any kind of information stored on your computer or on the Web. It provides... Read more
Remotix 3.1.4 - Access all your computer...
Remotix is a fast and powerful application to easily access multiple Macs (and PCs) from your own Mac. Features Complete Apple Screen Sharing support - including Mac OS X login, clipboard... Read more
DesktopLyrics 2.6.6 - Displays current i...
DesktopLyrics is an application that displays the lyrics of the song currently playing in "iTunes" right on your desktop. The lyrics for the song have to be set in iTunes; DesktopLyrics does nothing... Read more

What the Apple Watch Gets Right, and Wha...
| Read more »
Celebrate PAC-MAN's 35th Birthday W...
BANDAI NAMCO Entertainment America is celebrating PAC-MAN's 35th anniversary by releasing updates for PAC-MAN and PAC-MAN Lite for iOS. [Read more] | Read more »
Strike Wing Episode 2 has Landed on the...
Strike Wing: Raptor Rising is an exciting space combat simulator by Crescent Moon Games, which was recently updated to continue the story with Episode 2. [Read more] | Read more »
This Week at 148Apps: May 18-22, 2015
May Days at 148Apps How do you know what apps are worth your time and money? Just look to the review team at 148Apps. We sort through the chaos and find the apps you're looking for. The ones we love become Editor’s Choice, standing out above the... | Read more »
Biz Builder Delux (Games)
Biz Builder Delux 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: Ah, there's nothing like the rhythmic bustle of a burgeoning business burg... especially when you're the one building it... | Read more »
Auroch Digital is Bringing Back Games Wo...
| Read more »
Blades of Brim is a New Endless Runner f...
SYBO Games, the minds behind the ever-popular Subway Surfers, have announced their latest project: Blades of Brim. [Read more] | Read more »
Carbo - Handwriting in the Digital Age...
Carbo - Handwriting in the Digital Age 1.0 Device: iOS Universal Category: Productivity Price: $3.99, Version: 1.0 (iTunes) Description: | Read more »
Draggy Dead (Games)
Draggy Dead 1.1 Device: iOS Universal Category: Games Price: $.99, Version: 1.1 (iTunes) Description: Ditch your dead end job and take up a rewarding career in Grave Robbing today!Guide the recently deceased to a fun filled life of... | Read more »
Bad Dinos (Games)
Bad Dinos 1.0.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.0 (iTunes) Description: | Read more »

Price Scanner via MacPrices.net

New 13-inch 2.9GHz Retina MacBook Pro on sale...
B&H Photo has the 13″ 2.9GHz/512GB Retina MacBook Pro on sale for $1699.99 including free shipping plus NY tax only. Their price is $100 off MSRP, and it’s the lowest price for this model from... Read more
12-inch MacBook stock status for Monday, May...
The new 12″ Retina MacBooks are still on backorder at The Apple Store with a 3-5 week waiting period. However, a few models are in stock today at Apple resellers. Stock is limited, so act now if you’... Read more
New 27-inch 3.3GHz 5K iMac in stock with free...
Adorama has the new 27″ 3.3GHz 5K iMac in stock today for $1999 including free shipping plus NY & NJ sales tax only. Adorama will include a free copy of Apple’s 3-year AppleCare Protection Plan. Read more
Memorial Day Weekend Sale: New 27-inch 3.3GHz...
Best Buy has the new 27″ 3.3GHz 5K iMac on sale for $1899.99 this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders only, in-store prices may vary... Read more
OtterBox Maximizes Portability, Productivity...
From the kitchen recipe book to the boarsroom presentation, the OtterBox Agility Tablet System turns tablets into one of the most versatile pieces of handheld technology available. Available now, the... Read more
Launch of New Car App Gallery and Open Develo...
Automatic, a company on a mission to bring the power of the Internet into every car, has announced the launch of the Automatic App Gallery, an app store for nearly every car or truck on the road... Read more
Memorial Day Weekend Sale: 13-inch 1.6GHz Mac...
Best Buy has the new 13″ 1.6GHz/128GB MacBook Air on sale for $849 on their online store this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders... Read more
Memorial Day Weekend Sale: 27-inch 3.5GHz 5K...
Best Buy has the 27″ 3.5GHz 5K iMac on sale for $2099.99 this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders only, in-store prices may vary.... Read more
Sale! 16GB iPad mini 3 for $349, save $50
B&H Photo has the 16GB iPad mini 3 WiFi on sale for $349 including free shipping plus NY sales tax only. Their price is $50 off MSRP, and it’s the lowest price available for this model. Read more
Price drop on 2014 15-inch Retina MacBook Pro...
B&H Photo has dropped prices on 2014 15″ Retina MacBook Pros by $200. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799.99 save $200 - 15″ 2.5GHz... Read more

Jobs Board

Architect / Senior Software Engineer, *Apple...
Changing the world is all in a day039s work at Apple . If you love innovation, here039s your chance to make a career of it. You039ll work hard. But the job comes with Read more
*Apple* Pay Support Readiness Project Manage...
Changing the world is all in a day039s work at Apple . If you love innovation, here039s your chance to make a career of it. You039ll work hard. But the job comes with Read more
Hardware Design Validation Engineer - *Apple...
**Job Summary** The Apple Watch team is looking for a Hardware Design Validation Engineer. This person will be part of the Apple Watch hardware team with Read more
Sr. Payment Program Manager, *Apple* Pay -...
**Job Summary** Apple Pay is an exciting environment and a…devices in a simple, private and secure way. The Apple Pay Team is looking for an experienced Senior Read more
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.