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

Eye Candy 7.2.0.50 - 30 professional Pho...
Eye Candy renders realistic effects that are difficult or impossible to achieve in Photoshop alone, such as Fire, Chrome, and the new Lightning. Effects like Animal Fur, Smoke, and Reptile Skin are... Read more
Microsoft Office 2016 15.31 - Popular pr...
Microsoft Office 2016 - Unmistakably Office, designed for Mac. The new versions of Word, Excel, PowerPoint, Outlook and OneNote provide the best of both worlds for Mac users - the familiar Office... Read more
Spotify 1.0.49.125. - Stream music, crea...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue puts... Read more
QuickBooks 16.1.12.1564 R13 - Financial...
QuickBooks helps you manage your business easily and efficiently. Organize your finances all in one place, track money going in and out of your business, and spot areas where you can save. Built for... Read more
Dash 4.0.1 - Instant search and offline...
Dash is an API documentation browser and code snippet manager. Dash helps you store snippets of code, as well as instantly search and browse documentation for almost any API you might use (for a full... Read more
Tinderbox 7.0.0 - Store and organize you...
Tinderbox is a personal content management assistant. It stores your notes, ideas, and plans. It can help you organize and understand them. And Tinderbox helps you share ideas through Web journals... Read more
Apple Remote Desktop Client 3.9 - Client...
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
Sparkle 2.1.1 - $79.99
Sparkle will change your mind if you thought building websites wasn't for you. Sparkle is the intuitive site builder that lets you create sites for your online portfolio, team or band pages, or... Read more
1Password 6.5.5 - Powerful password mana...
1Password is a password manager that uniquely brings you both security and convenience. It is the only program that provides anti-phishing protection and goes beyond password management by adding Web... Read more
WhatRoute 2.0.15 - Geographically trace...
WhatRoute is designed to find the names of all the routers an IP packet passes through on its way from your Mac to a destination host. It also measures the round-trip time from your Mac to the router... Read more

Slay your way to glory in idle RPG Endle...
It’s a golden age for idle games on the mobile market, and those addictive little clickers have a new best friend. South Korean developer Ekkorr released Endless Frontier last year, and players have been idling away the hours in the company of its... | Read more »
Tiny Striker: World Football Guide - How...
| Read more »
Good news everyone! Futurama: Worlds of...
Futurama is finding a new home on mobile in TinyCo and Fox Interactive's new game, Futurama: Worlds of Tomorrow. They're really doing it up, bringing on board Futurama creator Matt Groening along with the original cast and writers. TinyCo wants... | Read more »
MUL.MASH.TAB.BA.GAL.GAL (Games)
MUL.MASH.TAB.BA.GAL.GAL 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: ENDLESS UPGRADES. CONSTANT DANGER. ANCIENT WISDOM. BOUNCY BALLS. Launch Sale, 40% OFF for a very limited time!!! MUL.... | Read more »
Dungeon Rushers (Games)
Dungeon Rushers 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Dungeon Rushers is a 2D tactical RPG combining dungeon crawler’s gameplay and turn based fights. Manage your team, loot dusty... | Read more »
Blasty Bubs is a colorful Pinball and Br...
QuickByte Games has another arcade treat in the works -- this time it's a mishmash of brick breaking and Pinball mechanics. It's called Blasty Bubs, and it's a top down brickbreaker that has you slinging balls around a board. [Read more] | Read more »
Corsola and Heracross are the new region...
Generation 2 finally launched in Pokémon GO, unleashing a brand new batch of Pokémon into the wild. Even before the update went live people were speculating on how to catch elusive Pokémon like the legendary "dogs", Unknown, and whether or not... | Read more »
The Warlock of Firetop Mountain (Games)
The Warlock of Firetop Mountain 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: An epic adventure through a mysterious mountain filled with monsters, magic and mayhem! “...it looks downright... | Read more »
Fantasy MMORPG MU Origin’s receives a hu...
Developer Webzen are looking to take their highly popular fantasy battler MU Origin to the next level this month, with its most ambitious overhaul yet. The latest update introduces the long sought after Server Arena, new treasure dungeons, and much... | Read more »
RPG Djinn Caster (Games)
RPG Djinn Caster 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: SPECIAL PRICE 38% OFF(USD 7.99 -> USD 4.99)!!!A Fantasy Action RPG of far foreign lands! Summon the Djinns and rise to... | Read more »

Price Scanner via MacPrices.net

Apple restocks refurbished 11-inch MacBook Ai...
Apple has Certified Refurbished 11″ MacBook Airs (the latest models recently discontinued by Apple), available for up to $170 off original MSRP. An Apple one-year warranty is included with each... Read more
Apple Park Opens to Employees in April With T...
Apple has announced that Apple Park, the company’s new 175-acre campus, will be ready for employees to begin occupying in April. The process of moving more than 12,000 people will take over six... Read more
Manhattan Neighbors for Safer Telecommunicati...
A new education and advocacy group focused on cell phone and wireless risks, Manhattan Neighbors for Safer Telecommunications, launched today at http://www.ManhattanNeighbors.org. Manhattan... Read more
Portable Dual DisplayPort Monitor Dock Enable...
IOGEAR has announced the launch of its USB-C Dual DisplayPort Monitor Portable Dock (GUC3CMST). The dock enables users to easily connect two DisplayPort monitors to a USB-C or Thunderbolt 3 laptop to... Read more
13-inch 2.7GHz Retina MacBook Pro on sale for...
Amazon.com has restocked the 13″ 2.7GHz/128GB Retina MacBook Pro (MF839LL/A) for $200 off MSRP including free shipping: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1099 $200 off MSRP This model tends to... Read more
Apple’s New iPad Ads Don’t Address Pro Users’...
Apple launched a new tranche of iPad Pro TV ads last week addressing actual queries and challenges from the Twitterverse, albeit using actors for the visuals. That’s great. As an iPad fan and heavy... Read more
Free Verbum Catholic Bible Study App For iOS
The Verbum mobile app runs on Logos’ powerful Bible software and is an advanced resource for mobile Catholic study. The Verbum app surrounds the Bible with the Tradition. Verbum comes with 15 free... Read more
27-inch Apple iMacs on sale for up to $200 of...
B&H Photo has 27″ Apple iMacs on sale for up to $200 off MSRP, each including free shipping plus NY sales tax only: - 27″ 3.3GHz iMac 5K: $2099.99 $200 off MSRP - 27″ 3.2GHz/1TB Fusion iMac 5K: $... Read more
15-inch 2.2GHz Retina MacBook Pro on sale for...
Amazon has 2015 15″ 2.2GHz Retina MacBook Pros (MJLQ2LL/A) available for $1849.99 including free shipping. Apple charges $1999 for this model, so Amazon’s price is represents a $150 savings. Read more
Apple refurbished iPad Air 2s available start...
Apple has Certified Refurbished iPad Air 2 WiFis available for starting at $319 including free shipping. A standard Apple one-year warranty is included: - 16GB iPad Air 2 WiFi: $319 $60 off original... Read more

Jobs Board

*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Manager *Apple* Systems Administration - Pu...
Req ID 3315BR Position Title Manager, Apple Systems Administration Job Description The Manager of Apple Systems Administration oversees the administration and Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Manager *Apple* Systems Administration - Pu...
Req ID 3315BR Position Title Manager, Apple Systems Administration Job Description The Manager of Apple Systems Administration oversees the administration and Read more
*Apple* Technician - nfrastructure (United S...
Let’s Work Together Apple Technician This position is based in Portland, ME Life at nfrastructure At nfrastructure, we understand that our success results from our Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.