2007.09.11

Basics of the Unix Philosophy

Even though the title of this entry is Unix Philosophy, every programmer needs to read this if they are not familiar with it already. A while back I read a great book called The Art of UNIX Programming which may be read free online or purchased in paperback form. While the whole book is good and relevant for any programmer, one section really stood out in my mind.

In chapter 1 there is a section called Basics of the Unix Philosophy that lists a few different versions of programming rules by different authors. I feel that each of the lists are valid and should be considered by any software developer.

The first one is from "Doug McIlroy, the inventor of Unix pipes and one of the founders of the Unix tradition": 1

1. Make each program do one thing well. To do a new job, build afresh rather than complicate old programs by adding new features.

2. Expect the output of every program to become the input to another, as yet unknown, program. Don't clutter output with extraneous information. Avoid stringently columnar or binary input formats. Don't insist on interactive input.

3. Design and build software, even operating systems, to be tried early, ideally within weeks. Don't hesitate to throw away the clumsy parts and rebuild them.

4. Use tools in preference to unskilled help to lighten a programming task, even if you have to detour to build the tools and expect to throw some of them out after you've finished using them.

These rules were also summarized as: 2

This is the Unix philosophy: Write programs that do one thing and do it well. Write programs to work together. Write programs to handle text streams, because that is a universal interface.

The next list of rules is from "Rob Pike, who became one of the great masters of C": 3

1. You can't tell where a program is going to spend its time. Bottlenecks occur in surprising places, so don't try to second guess and put in a speed hack until you've proven that's where the bottleneck is.

2. Measure. Don't tune for speed until you've measured, and even then don't unless one part of the code overwhelms the rest.

3. Fancy algorithms are slow when n is small, and n is usually small. Fancy algorithms have big constants. Until you know that n is frequently going to be big, don't get fancy. (Even if n does get big, use Rule 2 first.)

4. Fancy algorithms are buggier than simple ones, and they're much harder to implement. Use simple algorithms as well as simple data structures.

5. Data dominates. If you've chosen the right data structures and organized things well, the algorithms will almost always be self-evident. Data structures, not algorithms, are central to programming.

6. There is no Rule 6.

"Ken Thompson, the man who designed and implemented the first Unix" adds:

When in doubt, use brute force.

Finally, the author, Eric S. Raymond, offers the following rules: 4

1. Rule of Modularity: Write simple parts connected by clean interfaces.

2. Rule of Clarity: Clarity is better than cleverness.

3. Rule of Composition: Design programs to be connected to other programs.

4. Rule of Separation: Separate policy from mechanism; separate interfaces from engines.

5. Rule of Simplicity: Design for simplicity; add complexity only where you must.

6. Rule of Parsimony: Write a big program only when it is clear by demonstration that nothing else will do.

7. Rule of Transparency: Design for visibility to make inspection and debugging easier.

8. Rule of Robustness: Robustness is the child of transparency and simplicity.

9. Rule of Representation: Fold knowledge into data so program logic can be stupid and robust.

10. Rule of Least Surprise: In interface design, always do the least surprising thing.

11. Rule of Silence: When a program has nothing surprising to say, it should say nothing.

12. Rule of Repair: When you must fail, fail noisily and as soon as possible.

13. Rule of Economy: Programmer time is expensive; conserve it in preference to machine time.

14. Rule of Generation: Avoid hand-hacking; write programs to write programs when you can.

15. Rule of Optimization: Prototype before polishing. Get it working before you optimize it.

16. Rule of Diversity: Distrust all claims for "one true way".

17. Rule of Extensibility: Design for the future, because it will be here sooner than you think.

Even though all of the rules are important some of the ones that have helped me a lot when programming are: (1) modularize your code and (2) write clean obvious code, or if you can't, make sure you document it well.

Rules that I see a lot of commercial programs fail to adhere to are: (10) they don't do what you expect them to do (like forget your preferences every time you upgrade) and (11) annoy you with pop-up dialog boxes when everything is fine (Success! Press OK to continue.). These issues often occur in Windows applications, however, I'm now noticing some KDE/GNOME applications that do the same thing.

Unix is very simple, but it takes a genius to understand the simplicity.

— Dennis Ritchie

1. The Bell System Technical Journal. Bell Laboratories. M. D. McIlroy, E. N. Pinson, and B. A. Unix Time-Sharing System. 1978. 57 (6,part2). p.1902.

2. Peter H. Salus. A Quarter-Century of Unix. Addison-Wesley. 1994. ISBN 0-201-54777-5.

3. Rob Pike. Notes on Programming in C.

4. Eric Steven Raymond. The Art of Unix Programming. Addison-Wesley. 2003. ISBN 0-131-42901-9. (ch1s6).

2007.07.24

Project Euler Programming Problems

I've been working on the problems on the Project Euler site off and on for about a year now (as are some of my friends). They are a lot of fun for anyone who likes to program and has an interest in algorithm design and optimization. As their site says...

Project Euler is a series of challenging mathematical/computer programming problems that will require more than just mathematical insights to solve.

I've been working the problems in order and (as I write this) I have completed 68 out of 159, or 43%. I've done each one using Common LISP because when I started I was interested in learning LISP and I thought it would be a great way to help me learn — and it has been.

It is usually not too hard to devise a brute force solution, but the idea is to find a more elegant solution that will run in under one minute. And when you accomplish this task it is very fulfilling.

Mathematicians have tried in vain to this day to discover some order in the sequence of prime numbers, and we have reason to believe that it is a mystery into which the human mind will never penetrate.

— Leonhard Euler

2007.07.21

Embedded Twitter in your Web Site

Twitter is a pretty cool social application that allows friends to say current with what each other is doing on a daily basis. Recently I found out about their badges that allow you to embed Twitter content into your web pages.

Here are two examples and the code that produced them. Simply replace nullman with your Twitter username. 

<div class="twitter">
  <h2 class="twitter-title">Twitter Flash</h2>
  <object type="application/x-shockwave-flash"
          data="http://twitter.com/flash/twitter_badge.swf"
          quality="high"
          width=176
          height=176>
    <param name="movie"
           value="http://twitter.com/flash/twitter_badge.swf" />
    <param name="flashvars"
           value="color1=26112&amp;type=user&amp;id=nullman" />
    <param name="wmode" value="transparent" />
    <param name="allowScriptAccess="always" />
    <param name="pluginspage"
           value="http://www.macromedia.com/go/getflashplayer" />
  </object>
</div>

You'll want to follow the instructions here to pick the color you want. However, I recommend using the above example code that I got from GIO's Blog instead of Twitter's because theirs is not XHTML compliant.