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

iFFmpeg 6.4.0 - Convert multimedia files...
iFFmpeg is a comprehensive media tool to convert movie, audio and media files between formats. The FFmpeg command line instructions can be very hard to master/understand, so iFFmpeg does all the hard... Read more
Thunderbird 52.2.0 - Email client from M...
As of July 2012, Thunderbird has transitioned to a new governance model, with new features being developed by the broader free software and open source community, and security fixes and improvements... Read more
Airfoil 5.6.1 - Send audio from any app...
Airfoil allows you to send any audio to AirPort Express units, Apple TVs, and even other Macs and PCs, all in sync! It's your audio - everywhere. With Airfoil you can take audio from any... Read more
Apple Remote Desktop Client 3.9.3 - Clie...
Apple Remote Desktop Client is the best way to manage the Mac computers on your network. Distribute software, provide real-time online help to end users, create detailed software and hardware reports... Read more
jAlbum Pro 14.0 - Organize your digital...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. You can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly... Read more
jAlbum 14.0 - Create custom photo galler...
With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly, with pro results - Simply drag and drop photos into groups, choose a design... Read more
Vitamin-R 2.48 - Personal productivity t...
Vitamin-R creates the optimal conditions for your brain to work at its best by structuring your work into short bursts of distraction-free, highly focused activity alternating with opportunities for... Read more
Beamer 3.3 - Stream any movie file from...
Beamer streams to your Apple TV.... Plays any movie file - Just like the popular desktop movie players, Beamer accepts all common formats, codecs and resolutions. AVI, MKV, MOV, MP4, WMV, FLV. To... Read more
Shredo 1.2.2 - $9.99
Shredo is a beautiful, functional file-shredding and privacy scan utility. It permanently shreds files, folders, and external volumes' contents to keep information secure and impossible for anyone to... Read more
Final Draft 10.0.3 - Industry-leading sc...
Final Draft allows you to use your creative energy to focus on the content; let Final Draft take care of the style. Final Draft is the number-one selling application specifically designed for writing... Read more

Latest Forum Discussions

See All

The House of da Vinci (Games)
The House of da Vinci 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: Enter The House of Da Vinci, a new must-try 3D puzzle adventure game. Solve mechanical puzzles, discover hidden... | Read more »
Solve the disappearance of history’s gre...
Blue Brain Games invites you to indulge in an immersive hands-on 3D puzzle adventure in similar vein to The Room series, with its debut release The House of Da Vinci. Set during the historic period of the Italian Renaissance (when Leonardo himself... | Read more »
Age of Rivals (Games)
Age of Rivals 3.3 Device: iOS Universal Category: Games Price: $.99, Version: 3.3 (iTunes) Description: Deep civilization-building strategy in a fast-paced card game! | Read more »
Panthera Frontier (Games)
Panthera Frontier 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: | Read more »
Angry Birds Evolution beginner's gu...
Angry Birds changes things up a fair bit in its latest iteration, Angry Birds Evolution. The familiar sling-shot physics mechanics are still there, but the game now features team-based gameplay, RPG elements, and a new top-down view. With all of... | Read more »
Sega Forever is for the retro game fans
Sega is launching a new retro games service titled Sega Forever, in a move that's sure to delight games enthusiasts with a bit of nostalgia. Sega's releasing five classic games for free. The titles include Sonic the Hedgehog, Phantasy Star II,... | Read more »
The Little Acre (Games)
The Little Acre 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Lovely adventure game 'The Little A...
The Little Acre makes its way from PC to iOS today and it's a real charmer. It's a lovely little adventure game set in 1950's Ireland, gorgeously animated in a style slightly reminiscent of old Disney films. The game won a lot of praise for its... | Read more »
Futurama: Worlds of Tomorrow officially...
Futurama: Worlds of Tomorrow arrives next Thursday, and it features . . . Stephen Hawking? Turns out a few of your favorite science super stars, including Bill Nye, Neil DeGrasse Tyson, and George Takei will be making an appearance alongside the... | Read more »
MU Origin’s new update offers exciting c...
MU Origin is kicking off the summer with style. Its latest update is a real doozy, offering up plenty of fresh content. New challenges, some extra help for newcomers, and new costumes are just a few of the things you will find in the new patch. | Read more »

Price Scanner via MacPrices.net

Clearance 2016 MacBook Pros available for up...
B&H Photo has clearance 2016 13″ and 15″ MacBook Pros in stock today and on sale for up to $400 off original MSRP. Shipping is free, and B&H charges NY & NJ sales tax only: - 15″ 2.7GHz... Read more
Apple Ranks 9th In comScore Top 50 U.S. Digit...
comScore, Inc. has released its monthly ranking of U.S. online activity at the top digital media properties for May 2017 based on data from comScore Media Metrix Multi-Platform. * Entity has... Read more
10.5-inch iPad Pros available for up to $20 o...
B&H Photo has the new 2017 10.5″ iPad Pros available for up to $20 off MSRP including free shipping plus NY & NJ sales tax only: - 64GB iPad Pro WiFi: $649 - 256GB iPad Pro WiFi: $749 - 512GB... Read more
Three Off-The-Beaten-Track iOS Apps That Dese...
One of the great things about using iPads and iPhones is the vast selection of apps available for most anything you want or need to do. The three outlined in this article have been in my core app... Read more
Apple No. 1 Spot In Gartner Top 100 Vendors i...
Gartner, Inc. has unveiled the top global 100 vendors in IT in 2016 based on their revenue across IT (excluding communication services) and component market segments. In the Gartner Global Top 100:... Read more
Clearance iMacs available for up to $300 off...
B&H Photo has clearance 21″ and 27″ Apple iMacs available starting at $949, each including free shipping plus NY & NJ sales tax only: - 27″ 3.3GHz iMac 5K: $1999 $300 off original MSRP - 27″... Read more
1.4GHz Mac mini, refurbished, available for $...
The Apple Store has Apple Certified Refurbished 1.4GHz Mac minis available for $419. Apple’s one-year warranty is included, and shipping is free. Their price is $80 off MSRP, and it’s the lowest... Read more
Free Mixoo iOS Photo Editing App Gets Major U...
Button Software Technology has announced Mixoo 3.0, an important feature update to the company’s photo editor for iOS devices. Mixoo offers amazing ways to edit as well as decorate personal photo... Read more
FNable 2.0 Function Key Enabling Software Get...
Briksoftware has released FNable 2.0 With Touch Bar Support, a major new version of the function key enabling software now compatible with Touch Bar keyboards. FNable’s simplicity that allows users... Read more
Clearance 2016 12-inch Retina MacBooks, Apple...
Apple recently dropped prices on Certified Refurbished 2016 12″ Retina MacBooks, with models now available starting at $1019. Apple will include a standard one-year warranty with each MacBook, and... Read more

Jobs Board

*Apple* Solutions Consultant (Asc) - PT - Cu...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include:* Promoting Apple products and solutions Read more
Product Metrics Manager - *Apple* Media Pro...
- Identify blind spots in existing product metrics- Presenting on how Apple Media Products are used and perceived by our customers- Work with data science and Read more
*Apple* Professional Learning Specialist - A...
…Professional Learning Plans for educators in schools supported by Apple Professional Learning;Coordinate both leadership and teacher professional learning to Read more
Senior Payments Architect - *Apple* Pay - A...
…selected candidate will challenge assumptions and design solutions first and foremost with Apple 's customers in mind despite the complexity that is often behind the Read more
Product Manager, *Apple* News - Apple Inc....
…on new product areas, many of which have great potential impact to Apple .Drives the definition of broad, complex, and high impact products for worldwide markets, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.