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.

 
AAPL
$116.47
Apple Inc.
+0.16
MSFT
$47.98
Microsoft Corpora
-0.72
GOOG
$537.50
Google Inc.
+2.67

MacTech Search:
Community Search:

Software Updates via MacUpdate

Cobook 3.0.7 - Intelligent address book....
Cobook Contacts is an intuitive, engaging address book. Solve the problem of contact management with Cobook Contacts and its simple interface and powerful syncing and integration possibilities.... Read more
StatsBar 1.9 - Monitor system processes...
StatsBar gives you a comprehensive and detailed analysis of the following areas of your Mac: CPU usage Memory usage Disk usage Network and bandwidth usage Battery power and health (MacBooks only)... Read more
Cyberduck 4.6 - FTP and SFTP browser. (F...
Cyberduck is a robust FTP/FTP-TLS/SFTP browser for the Mac whose lack of visual clutter and cleverly intuitive features make it easy to use. Support for external editors and system technologies such... Read more
Maya 2015 - Professional 3D modeling and...
Maya is an award-winning software and powerful, integrated 3D modeling, animation, visual effects, and rendering solution. Because Maya is based on an open architecture, all your work can be scripted... Read more
Evernote 6.0.1 - Create searchable notes...
Evernote allows you to easily capture information in any environment using whatever device or platform you find most convenient, and makes this information accessible and searchable at anytime, from... Read more
calibre 2.11 - Complete e-library manage...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital... Read more
Herald 5.0.1 - Notification plugin for M...
Note: Versions 2.1.3 (for OS X 10.7), 3.0.6 (for OS X 10.8), and 4.0.8 (for OS X 10.9) are no longer supported by the developer. Herald is a notification plugin for Mail.app, Apple's Mac OS X email... Read more
Firetask 3.7 - Innovative task managemen...
Firetask uniquely combines the advantages of classical priority-and-due-date-based task management with GTD. Stay focused and on top of your commitments - Firetask's "Today" view shows all relevant... Read more
TechTool Pro 7.0.6 - Hard drive and syst...
TechTool Pro is now 7, and this is the most advanced version of the acclaimed Macintosh troubleshooting utility created in its 20-year history. Micromat has redeveloped TechTool Pro 7 to be fully 64... Read more
PhotoDesk 3.0.1 - Instagram client for p...
PhotoDesk lets you view, like, comment, and download Instagram pictures/videos! (NO Uploads! / Image Posting! Instagram forbids that! AND you *need* an *existing* Instagram account). But you can do... Read more

Latest Forum Discussions

See All

Ubisoft Gives Everyone Two New Ways to E...
Ubisoft Gives Everyone Two New Ways to Earn In-Game Stuff for Far Cry 4 Posted by Jessica Fisher on November 21st, 2014 [ permalink ] | Read more »
Golfinity – Tips, Tricks, Strategies, an...
Dig this: Would you like to know what we thought of being an infinite golfer? Check out our Golfinity review! Golfinity offers unlimited ways to test your skills at golf. Here are a few ways to make sure your score doesn’t get too high and your... | Read more »
Dark Hearts, The Sequel to Haunting Meli...
Dark Hearts, The Sequel to Haunting Melissa, is Available Now Posted by Jessica Fisher on November 21st, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Meowza! Toyze Brings Talking Tom to Life...
Meowza! | Read more »
Square Enix Announces New Tactical RPG f...
Square Enix Announces New Tactical RPG for Mobile, Heavenstrike Rivals. Posted by Jessica Fisher on November 21st, 2014 [ permalink ] With their epic stories and gorgeous graphics, | Read more »
Quest for Revenge (Games)
Quest for Revenge 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: The great Kingdom of the west has fallen. The gods ignore the prayers of the desperate. A dark warlord has extinguished... | Read more »
Threadz is a New Writing Adventure for Y...
Threadz is a New Writing Adventure for You and Your Friends Posted by Jessica Fisher on November 21st, 2014 [ permalink ] In the tradition of round-robin storytelling, | Read more »
SteelSeries Stratus XL Hardware Review
Made by: SteelSeries Price: $59.99 Hardware/iOS Integration Rating: 4 out of 5 stars Usability Rating: 4.5 out of 5 stars Reuse Value Rating: 4.25 out of 5 stars Build Quality Rating: 4.5 out of 5 stars Overall Rating: 4.31 out of 5 stars | Read more »
ACDSee (Photography)
ACDSee 1.0.0 Device: iOS iPhone Category: Photography Price: $1.99, Version: 1.0.0 (iTunes) Description: Capture, perfect, and share your photos with ACDSee. The ACDSee iPhone app combines an innovative camera, a powerful photo... | Read more »
ProTube for YouTube (Entertainment)
ProTube for YouTube 2.0.2 Device: iOS Universal Category: Entertainment Price: $1.99, Version: 2.0.2 (iTunes) Description: ProTube is the ultimate, fully featured YouTube app. With it's highly polished design, ProTube offers ad-free... | Read more »

Price Scanner via MacPrices.net

Save up to $400 with Apple refurbished 2014 1...
The Apple Store has restocked Apple Certified Refurbished 2014 15″ Retina MacBook Pros for up to $400 off the cost of new models. An Apple one-year warranty is included with each model, and shipping... Read more
New 13-inch 1.4GHz MacBook Air on sale for $8...
 Adorama has the 2014 13″ 1.4GHz/128GB MacBook Air on sale for $899.99 including free shipping plus NY & NJ tax only. Their price is $100 off MSRP. B&H Photo has the 13″ 1.4GHz/128GB MacBook... Read more
Apple Expected to Reverse Nine-Month Tablet S...
Apple and Samsung combined accounted for 62 percent of the nearly 36 million branded tablets shipped in 3Q 2014, according to early vendor shipment share estimates from market intelligence firm ABI... Read more
Stratos: 30 Percent of US Smartphone Owners t...
Stratos, Inc., creator of the Bluetooth Connected Card Platform, has announced results from its 2014 Holiday Mobile Payments Survey. The consumer survey found that nearly one out of three (30 percent... Read more
2014 1.4GHz Mac mini on sale for $449, save $...
 B&H Photo has lowered their price on the new 1.4GHz Mac mini to $449.99 including free shipping plus NY tax only. Their price is $50 off MSRP, and it’s the lowest price available for this new... Read more
Check Apple prices on any device with the iTr...
MacPrices is proud to offer readers a free iOS app (iPhones, iPads, & iPod touch) and Android app (Google Play and Amazon App Store) called iTracx, which allows you to glance at today’s lowest... Read more
64GB iPod touch on sale for $249, save $50
Best Buy has the 64GB iPod touch on sale for $249 on their online store for a limited time. Their price is $50 off MSRP. Choose free shipping or free local store pickup (if available). Sale price for... Read more
15″ 2.2GHz Retina MacBook Pro on sale for $17...
 B&H Photo has the 2014 15″ 2.2GHz Retina MacBook Pro on sale for $1799.99 for a limited time. Shipping is free, and B&H charges NY sales tax only. B&H will also include free copies of... Read more
New Logitech AnyAngle Case/Stand Brings Flexi...
Logitec has announced the newest addition to its suite of tablet products — the Logitech AnyAngle. A protective case with an any-angle stand for iPad Air 2 and all iPad mini models, AnyAngle is the... Read more
Notebook PC Shipments Rise Year-Over-Year as...
According to preliminary results from the upcoming DisplaySearch Quarterly Mobile PC Shipment and Forecast Report, the global notebook PC market grew 10 percent year-over-year in Q3’14 to 49.4... Read more

Jobs Board

*Apple* Solutions Consultant (ASC)- Retail S...
**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
Project Manager, *Apple* Financial Services...
**Job Summary** Apple Financial Services (AFS) offers consumers, businesses and educational institutions ways to finance Apple purchases. We work with national and Read more
*Apple* Store Leader Program - College Gradu...
Job Description: Job Summary As an Apple Store Leader Program agent, you can continue your education as you major in the art of leadership at the Apple Store. You'll Read more
*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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.