Misplaced Pages

Revision as of 16:24, 3 February 2008

A metasyntactic variable (Template:PronEng) is a placeholder name or an alias term commonly used to denote the subject matter under discussion or an arbitrary member of a class of things under discussion. The term originates from computer programming and other technical contexts, and is commonly used in examples by hackers and programmers. The use of a metasyntactic variable is helpful in freeing a programmer from creating a logically named variable, although the invented term may also become sufficiently popular and enter the language as a neologism. The word foo is the canonical example.

Any word can be used as a metasyntactic variable however "nonsense words" are commonly used to denote that they are being used as such. The same concept is employed in other fields where it is expressed by terms such as schematic variable (see logical form).

Explanation of the concept

By dissection the word

• 'Meta' means information about, more comprehensive, or transcending.
• 'Syntax' means the grammatical arrangement of words or The grammatical rules of a programming language.
• 'Variable' means something that can assume a value, or something likely to vary.

So we have a word that transcends grammar and can assume a value.

Or one that is more comprehensive than grammatical arrangement and is likely to vary.

By mathematical analogy

A metasyntactic variable is as a word that is a variable for other words, just as in algebra letters are used as variables for numbers.

Words commonly used as metasyntactic variables

A "standard list of metasyntactic variables used in syntax examples" is: foo, bar, baz, qux, quux, corge, grault, garply, waldo, fred, plugh, xyzzy, thud. The word foo occurs in over 330 RFCs and bar occurs in over 290.

Foo is used in one section of a tutorial on the C programming language by Brian W. Kernighan. Here, he illustrates the use of the extern declaration:

Second, at the beginning of any file
that contains functions needing a variable whose definition is in some other file,
put in an extern declaration, outside of any function:
       extern  int     foo;
       f1( ) { ... }
          etc.

Spam, ham, and eggs are the canonical metasyntactic variables used in the Python programming language. This is a reference to the famous comedy sketch, Spam, by Monty Python, the namesake of the language. In this extract from the Python tutorial showing the use of comments, STRING is a metasyntactic variable.

Some examples:
# this is the first comment
SPAM = 1                 # and this is the second comment
                         # ... and now a third!
STRING = "# This is not a comment."

Arfle, barfle, and gloop, which are commonly used by those with a BBC Micro or ZX Spectrum background, originated as the response of the parser of a Level 9 BBC Micro adventure game to input it didn't understand. An example of these can be seen in this GCC bug report, along with other interesting metasyntactic variables. The author of this bug report has written an example program for the sole purpose of demonstrating the bug. He provides "a source file which lays out some vtables" using names that are arbitrary, but syntactically required:

...
struct Side
{
  virtual ~Side ();
  virtual void Arfle ();
  virtual void Barfle ();
  virtual void Gloop ();
  virtual void Glorp ();
  virtual void Glump ();
  virtual void Bogus  ();  
};
...

See also

• Placeholder name
• Free variables and bound variables
• gadget
• widget
• Hello World
• Lorem Ipsum
• Fnord
• Alice and Bob
• John Doe

References

1. ^ http://www.faqs.org/rfcs/rfc3092.html Cite error: The named reference "RFC3092" was defined multiple times with different content (see the help page).
2. Brian W. Kernighan: Programming in C: A Tutorial
3. Python Tutorial
4. General Python FAQ
5. 3. An Informal Introduction to Python
6. arfle barfle gloop?@Everything2.com
7. [C++ bug] Recent vtable regression

External links

• Definition of metasyntactic variable, with examples.
• Examples of metasyntactic variables used in Commonwealth Hackish, such as wombat.
• Variable "foo" and Other Programming Oddities

• Placeholder names